Как перестать настраивать вики и начать писать документацию

Знакомая история: команде или для личных нужд нужна база знаний. Вы открываете Wiki.js, Outline или, упаси боже, Confluence. Через час обнаруживаете себя в дебрях настройки PostgreSQL, Redis, S3-хранилища и конфигурации Docker Compose на триста строк. В этот момент желание записать пару умных мыслей обычно пропадает.

Недавно наткнулся на leafwiki. Автор проекта, видимо, разделяет эту боль. Это максимально приземлённая self-hosted вики, которая работает по принципу «скачал и запустил». Никаких тяжелых зависимостей, только один бинарный файл на Go и папка с данными.

Что под капотом

LeafWiki не пытается переизобрести велосипед. В основе лежат три понятных вещи: Go для бэкенда, React для интерфейса и SQLite для метаданных. Самое приятное — сам контент страниц хранится в обычных Markdown-файлах на диске.

Это значит, что если сервер вдруг упадет или вы решите переехать на другой инструмент, ваши данные не превратятся в тыкву внутри проприетарной БД. Их можно открыть любым текстовым редактором или тем же Obsidian.

Чем она хороша на практике

Я часто вижу инструменты, которые называют себя «простыми», но на деле требуют полноценного администрирования. LeafWiki в этом плане честнее.

Древовидная структура вместо хаоса

Многие современные заметки уходят в сторону «плоского» списка с тегами. Здесь же классическое дерево. Вы сами определяете иерархию и, что важно, можете вручную сортировать страницы в разделах. Это критично для онбординга или регламентов, где важна последовательность чтения.

Редактор, который не мешает

Внутри встроен Markdown-редактор с живым превью. Он поддерживает таблицы, списки задач, сноски и даже диаграммы Mermaid с математическими формулами KaTeX. Есть автодополнение для внутренних ссылок — начинаете писать название другой страницы, и вики сама подставляет нужный линк.

Умные связи

Система отслеживает бэклинки. На каждой странице видно, кто на неё ссылается. Если вы переименуете или переместите страницу, LeafWiki может автоматически поправить ссылки в других документах (эту фичу нужно включить флагом --enable-link-refactor).

Резервное копирование для параноиков

Помимо того, что можно просто скопировать папку с данными, в последних версиях появилась экспериментальная поддержка Git-бэкапа. Вики сама будет пушить изменения в ваш удаленный репозиторий по расписанию.

Кому это не подойдет

Сразу оговорюсь: это не замена Notion. Здесь нет совместного редактирования в реальном времени, когда вы видите курсоры коллег. Нет и сложных воркфлоу с одобрением публикаций. Если вам нужно, чтобы десять человек одновременно правили один абзац — ищите дальше.

Также LeafWiki пока не умеет в глубокое управление правами доступа на уровне отдельных веток дерева. Роли есть (админ, редактор, читатель), но они действуют на всю вики целиком.

Как запустить

Если у вас установлен Docker, запуск занимает примерно тридцать секунд.

docker run -p 8080:8080 \
    -v ~/leafwiki-data:/app/data \
    ghcr.io/perber/leafwiki:latest \
    --jwt-secret=super-secret-key \
    --admin-password=your-password \
    --allow-insecure=true

Флаг --allow-insecure=true нужен, если вы запускаете проект локально без HTTPS. Если планируете выставлять наружу через Nginx или другой прокси, этот флаг лучше убрать.

Кстати, для любителей минимализма есть готовый установщик для Linux, который прописывает LeafWiki как системный сервис:

sudo /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/perber/leafwiki/main/install.sh)"

Работа с мобильных устройств

Интерфейс отзывчивый. Редактировать тексты с телефона — сомнительное удовольствие, но почитать документацию в дороге или быстро поправить опечатку вполне реально.

LeafWiki подкупает своей предсказуемостью. Это отличный вариант для:

• Личного технического дневника или базы знаний.
• Документации небольшого проекта.
• Внутренних инструкций (runbooks) для админов или DevOps-инженеров.

Если вам надоело бороться с тяжеловесными вики-движками и хочется просто писать Markdown, который будет аккуратно разложен по полочкам — попробуйте этот проект. У него сейчас меньше тысячи звёзд на GitHub, но потенциал стать «тем самым простым инструментом» точно есть.