Вы ищете способ создать, управлять и делиться своей собственной документацией, базой знаний или вики? Если да, то вы можете рассмотреть BookStack, бесплатную и открытую платформу, которая предназначена для этой цели. BookStack - это веб-приложение, которое работает на PHP и использует MySQL или MariaDB в качестве базы данных. Оно имеет простой, удобный и адаптивный интерфейс, который позволяет вам легко создавать и организовывать свой контент в книги, главы и страницы. Вы также можете искать, ссылаться, сортировать, исправлять и экспортировать свой контент по мере необходимости. BookStack имеет много функций и опций, которые делают его мощной и гибкой платформой для хранения и представления информации.
Некоторые из основных функций BookStack:
Бесплатный и открытый исходный код: BookStack лицензирован под лицензией MIT, что означает, что вы можете скачать, установить, использовать и изменять его бесплатно. Вы также можете внести свой вклад в развитие BookStack, сообщая об ошибках, предлагая функции или отправляя код на GitHub.
Простой, легкий интерфейс: BookStack имеет четкий и интуитивный интерфейс, который облегчает создание и редактирование контента. Вы можете использовать визуальный редактор или необязательный редактор Markdown для написания своих страниц. Вы также можете использовать встроенный инструмент diagrams.net для создания диаграмм в своей документации. BookStack также имеет темный и светлый режимы, между которыми вы можете переключаться в соответствии с вашими предпочтениями.
Поисковый и связанный: BookStack позволяет вам искать любой контент в ваших книгах, главах или страницах. Вы также можете ссылаться непосредственно на любой абзац или раздел в ваших страницах, что помогает вам поддерживать связность и целостность вашей документации. Вы также можете использовать теги и комментарии, чтобы добавить больше информации и контекста к вашему контенту.
Конфигурируемый: BookStack имеет много опций конфигурации, которые позволяют вам настроить BookStack под ваш случай использования и потребности. Вы можете изменить название, логотип, опции регистрации, настройки электронной почты, настройки кэша, настройки хранения и многое другое. Вы также можете включать или отключать определенные функции, такие как ревизии страниц, управление изображениями, вложения страниц, экспорт страниц и многое другое.
Многоязычный: BookStack поддерживает несколько языков, благодаря участникам сообщества, которые перевели BookStack на разные языки. Вы можете установить свой предпочитаемый язык в настройках своего профиля или в файле конфигурации. Некоторые из языков, которые BookStack поддерживает в настоящее время, это английский, французский, немецкий, испанский, итальянский, японский, голландский, польский, русский и многие другие.
Интегрированная аутентификация: BookStack поддерживает различные методы аутентификации, такие как электронная почта/пароль, социальные провайдеры (такие как GitHub, Google, Slack, AzureAD и многие другие), LDAP, Okta, SAML2 и многие другие. Вы также можете включить двухфакторную аутентификацию (MFA) для повышения безопасности и применять ее на уровне ролей, если это необходимо. Опции MFA включают TOTP (такие как Google/Microsoft Authenticator, Authy и т.д.) и статические резервные коды.
Мощные функции: BookStack имеет много других функций, которые делают его надежной и универсальной платформой для организации и хранения информации. Некоторые из этих функций:
Сортировка по книгам: Вы можете сортировать свои книги по названию, дате создания, дате обновления или произвольному порядку. Вы также можете сортировать свои главы и страницы в каждой книге по тем же критериям.
Ревизии страниц: Вы можете просматривать, сравнивать и восстанавливать предыдущие версии своих страниц. Вы также можете видеть, кто и когда вносил изменения.
Управление изображениями: Вы можете загружать, обрезать, изменять размер и удалять изображения, которые вы используете на своих страницах. Вы также можете видеть, где используется каждое изображение и сколько места оно занимает.
Вложения страниц: Вы можете загружать и прикреплять файлы к своим страницам, такие как PDF, документы, электронные таблицы и т.д. Вы также можете видеть, где используется каждый файл и сколько места он занимает.
Экспорт страниц: Вы можете экспортировать свои страницы в формате HTML, PDF или простого текста. Вы также можете экспортировать всю свою книгу в формате PDF.
Система ролей и разрешений: Вы можете создавать и назначать роли своим пользователям и устанавливать разрешения для каждой роли. Вы можете контролировать, какие действия может выполнять каждая роль и к какому контенту она может получить доступ. Вы также можете устанавливать разрешения на уровне книги, главы или страницы для более тонкого контроля.
Как установить BookStack
BookStack имеет некоторые требования, которые вы должны выполнить перед его установкой. Это:
PHP >= 8.0.2 с необходимыми расширениями
MySQL >= 5.7 или MariaDB >= 10.2
Git
Composer >= v2.0
Веб-сервер, совместимый с PHP
Есть разные варианты установки, в зависимости от вашей конфигурации и предпочтений. Некоторые из вариантов установки, в зависимости от вашей конфигурации и предпочтений. Некоторые из вариантов установки:
Ручная установка: Этот вариант включает в себя клонирование ветки релиза репозитория BookStack на GitHub, запуск composer install, копирование и редактирование файла .env, установку разрешений для папок storage, bootstrap/cache и public/uploads, генерацию уникального ключа приложения, создание некоторых правил перезаписи URL при необходимости, установку корня веб-сайта на указание на папку public и запуск php artisan migrate для обновления базы данных.
Установка с помощью Docker: Этот вариант включает в себя использование официального образа BookStack Docker или образа LinuxServer.io BookStack Docker, которые оба доступны на Docker Hub. Вы можете использовать docker-compose или любой другой инструмент оркестровки для запуска BookStack в качестве контейнера с необходимыми сервисами.
Установка с помощью скрипта Ubuntu: Этот вариант включает в себя использование скрипта, который автоматизирует установку BookStack на Ubuntu 22.04, 20.04 или 18.04. Скрипт установит необходимые пакеты, создаст базу данных MySQL и пользователя, клонирует репозиторий BookStack, настроит веб-сервер и файл .env и выполнит миграции.
Руководства сообщества: Это руководства, написанные участниками сообщества, которые установили BookStack на разных платформах и средах, таких как CentOS, Debian, FreeBSD, Windows, Synology и т.д. Вы можете найти эти руководства на сайте BookStack или на вики BookStack на GitHub.
Как использовать BookStack
После установки BookStack вы можете начать использовать его для создания и организации своего контента. Вы можете войти в систему, используя стандартные учетные данные администратора, которые являются
Чтобы создать новую книгу, вы можете нажать на кнопку + Новая книга в правом верхнем углу домашней страницы. Вы можете дать своей книге название, описание и изображение. Вы также можете установить разрешения для своей книги, такие как кто может просматривать, создавать, редактировать и удалять контент в вашей книге.
Чтобы создать новую главу в своей книге, вы можете нажать на кнопку + Новая глава в правом верхнем углу страницы книги. Вы можете дать своей главе название и описание. Вы также можете установить разрешения для своей главы, такие как кто может просматривать, создавать, редактировать и удалять контент в вашей главе.
Чтобы создать новую страницу в своей главе, вы можете нажать на кнопку + Новая страница в правом верхнем углу страницы главы. Вы можете дать своей странице название и начать писать свой контент. Вы можете использовать визуальный редактор или редактор Markdown для форматирования своего контента. Вы также можете использовать инструмент diagrams.net для создания диаграмм на своей странице. Вы также можете добавлять теги, комментарии, изображения и вложения к своей странице. Вы также можете установить разрешения для своей страницы, такие как кто может просматривать, редактировать и удалять вашу страницу.
Вы также можете сортировать, перемещать, копировать, экспортировать и удалять свои книги, главы и страницы по мере необходимости. Вы также можете искать любой контент в ваших книгах, главах и страницах. Вы также можете ссылаться на любой абзац или раздел в ваших страницах, нажав на значок ссылки рядом с заголовком.
Вы также можете получить доступ к настройкам своего профиля, где вы можете изменить свое имя, электронную почту, пароль, язык, тему, редактор и настройки MFA. Вы также можете получить доступ к настройкам администратора, где вы можете изменить название приложения, логотип, опции регистрации, настройки электронной почты, настройки кэша, настройки хранения, методы аутентификации, настройки ролей и разрешений и многое другое.
Как настроить BookStack
BookStack - это гибкая и настраиваемая платформа, которая позволяет вам изменять ее в соответствии с вашими потребностями и предпочтениями. Вы можете настраивать BookStack разными способами, такими как:
Изменение опций конфигурации: Вы можете изменить опции конфигурации в файле .env или в настройках администратора. Вы можете включать или отключать определенные функции, такие как ревизии страниц, управление изображениями, вложения страниц, экспорт страниц и многое другое. Вы также можете изменить название, логотип, опции регистрации, настройки электронной почты, настройки кэша, настройки хранения и многое другое.
Изменение внешнего вида: Вы можете изменить внешний вид BookStack, используя пользовательский CSS или пользовательские темы. Вы можете добавить пользовательский CSS в настройках администратора или в файле public/css/custom-styles.css. Вы также можете создавать пользовательские темы, копируя и изменяя существующие темы в папке resources/themes. Вы также можете использовать темы, созданные сообществом, которые доступны на сайте BookStack или на вики BookStack на GitHub.
Изменение функциональности: Вы можете изменить функциональность BookStack, используя пользовательский код или пользовательские расширения. Вы можете добавить пользовательский код в файле app/Providers/AppServiceProvider.php или в файле public/js/custom-head-content.js. Вы также можете создавать пользовательские расширения, используя фреймворк Laravel и API BookStack. Вы также можете использовать расширения, созданные сообществом, которые доступны на сайте BookStack или на вики BookStack на GitHub.
Заключение
BookStack - это простая и бесплатная вики-платформа для организации и хранения информации. Она подходит для любого, кто хочет создать, управлять и делиться своей собственной документацией, базой знаний или вики. BookStack прост в использовании, мощный и гибкий. Вы можете скачать, установить, использовать и изменять BookStack бесплатно. Вы также можете внести свой вклад в развитие BookStack, сообщая об ошибках, предлагая функции или отправляя код на GitHub. BookStack поддерживает несколько языков, благодаря участникам сообщества, которые перевели BookStack на разные языки. Вы можете установить свой предпочитаемый язык в настройках своего профиля или в файле конфигурации.
BookStack имеет различные варианты установки, в зависимости от вашей конфигурации и предпочтений. Вы можете установить BookStack вручную, с помощью Docker, с помощью скрипта или следуя руководству сообщества. BookStack имеет некоторые требования, которые вы должны выполнить перед его установкой, такие как PHP, MySQL или MariaDB, Git, Composer и веб-сервер.
BookStack имеет четкий и интуитивный интерфейс, который облегчает создание и редактирование контента. Вы можете использовать визуальный редактор или редактор Markdown для написания своих страниц. Вы также можете использовать инструмент diagrams.net для создания диаграмм в своей документации. BookStack также имеет темный и светлый режимы, между которыми вы можете переключаться в соответствии с вашими предпочтениями. Вы также можете искать, ссылаться, сортировать, исправлять и экспортировать свой контент по мере необходимости.
BookStack имеет много опций конфигурации, которые позволяют вам настроить BookStack под ваш случай использования и потребности. Вы можете изменить название, логотип, опции регистрации, настройки электронной почты, настройки кэша, настройки хранения и многое другое. Вы также можете включать или отключать определенные функции, такие как ревизии страниц, управление изображениями, вложения страниц, экспорт страниц и многое другое.
BookStack имеет много других функций, которые делают его надежной и универсальной платформой для организации и хранения информации. Вы можете сортировать свои книги, главы и страницы по названию, дате создания, дате обновления или произвольному порядку. Вы можете просматривать, сравнивать и восстанавливать предыдущие версии своих страниц. Вы можете загружать, обрезать, изменять размер и удалять изображения и файлы, которые вы используете на своих страницах. Вы можете экспортировать свои страницы или книги в формате HTML, PDF или простого текста. Вы можете создавать и назначать роли своим пользователям и устанавливать разрешения для каждой роли. Вы можете контролировать, какие действия может выполнять каждая роль и к какому контенту она может получить доступ. Вы также можете устанавливать разрешения на уровне книги, главы или страницы для более тонкого контроля.
BookStack поддерживает различные методы аутентификации, такие как электронная почта/пароль, социальные провайдеры, LDAP, Okta, SAML2 и многие другие. Вы также можете включить двухфакторную аутентификацию для повышения безопасности и применять ее на уровне ролей, если это необходимо. Опции MFA включают TOTP и статические резервные коды.
BookStack - это гибкая и настраиваемая платформа, которая позволяет вам изменять ее в соответствии с вашими потребностями и предпочтениями. Вы можете изменить опции конфигурации, внешний вид, функциональность и многое другое. Вы можете использовать пользовательский CSS, пользовательские темы, пользовательский код или пользовательские расширения, чтобы улучшить свой опыт работы с BookStack. Вы также можете использовать темы и расширения, созданные сообществом, которые доступны на сайте BookStack или на вики BookStack на GitHub.
BookStack - это простая и бесплатная вики-платформа для организации и хранения информации. Она подходит для любого, кто хочет создать, управлять и делиться своей собственной документацией, базой знаний или вики. BookStack прост в использовании, мощный и гибкий.