BoockStack это веб-приложение предназначенное для документации проекта. Ну или организации своих записей. Очень кратко о BoockStack.
Содержание
Описание BoockStack
Сайт проекта https://www.bookstackapp.com/
Документация https://www.bookstackapp.com/docs/
Как это выглядит на проде:
Docker Compose
Крутиться у меня это вещь в Docker Compose, если кому-то нужен готовый файл, то вот:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
version: "2" services: bookstack: image: lscr.io/linuxserver/bookstack container_name: bookstack environment: - PUID=1000 - PGID=1000 - APP_URL=https://books.bite-byte.ru - DB_HOST=bookstack_db - DB_PORT=3306 - DB_USER=bookstack - DB_PASS=)#~CW~Qmk2(>jML^ - DB_DATABASE=bookstackapp - APP_LANG=ru volumes: - ./bookstack_app_data:/config ports: - 6875:80 restart: unless-stopped depends_on: - bookstack_db bookstack_db: image: lscr.io/linuxserver/mariadb container_name: bookstack_db environment: - PUID=1000 - PGID=1000 - MYSQL_ROOT_PASSWORD=)#~CW~Qmk2(>jML^ - TZ=Europe/Moscow - MYSQL_DATABASE=bookstackapp - MYSQL_USER=bookstack - MYSQL_PASSWORD=)#~CW~Qmk2(>jML^ volumes: - ./bookstack_db_data:/config restart: unless-stopped |
Архитектура хранения записей
Наверное, самое интересное в этой системе, как складируется информация.
Создается книга -> главы -> страницы. Книги собираются в полки.
Одна книга может быть в разных полках.
Редактор записей
Редактор записей классический WYSIWYG, но можно включить MarkDown, ничего необычного. Все привычно, отзывчиво и удобно.
У каждой записи есть версии, можно посмотреть, что кто добавил, кто что удалил и так далее. В общем, почти git.
Интеграции
А вот с интеграциями все плохо. Готовых решений я так и не нашел. Есть вебхуки, можно что-то свое придумать. Пример описан у разработчика в документации. Ну или посмотреть пример можно тут.
Но это все время и самописный код, тут нужны какие-то знания.
Итоги
Если кратко, то этим вполне можно пользоваться в качестве некой документации для компании / проекта. Прям полноценной альтернативой Confluence не назвать. Но система на это и не претендует.
Основные плюсы
Из основных плюсов хочу отметить:
- Очень быстрый запуск продукта в прод;
- Нативно понятный интерфейс;
- Удобная архитектура знаний;
- Удобный редактор;
- Версии страниц;
- Красивый, понятный и удобный интерфейс;
Основные минусы
Что не понравилось:
- Не очень понятные кастомные роли. Если я хочу разделить документацию с доступом по ролям — придется реально попытать голову. С публичной частью такая же беда;
- Нет готовых плагинов. Мне лично не хватает уведомления о новых комментах, чтобы быстро на них ответить, а прикрутить по примеру — руки не доходят;
- Редактор кода в записи иногда сходит с ума;
- Оглавление делается через список, а не заголовки;
