BookStack — Simple Self-Hosted Documentation & Wiki Platform
BookStack is a simple, self-hosted documentation platform organized by Shelves, Books, Chapters, and Pages. WYSIWYG/Markdown editor, LDAP, and powerful search.
这个资产会安全暂存
这个资产会先安全暂存。复制的指令会要求 Agent 读取暂存文件,并在激活脚本、MCP 配置或全局配置前先确认。
npx -y tokrepo@latest install 590e1c8e-34e1-11f1-9bc6-00163e2b0d79 --target codex先暂存文件;激活前需要读取暂存 README 和安装计划。
What it is
BookStack is a self-hosted documentation platform that organizes content using a familiar metaphor: Shelves hold Books, Books contain Chapters, and Chapters contain Pages. It provides both WYSIWYG and Markdown editors, full-text search, LDAP/SAML authentication, and role-based access control.
BookStack targets small to mid-size teams that need internal documentation without paying for Confluence or Notion. It runs on a standard LAMP stack (PHP + MySQL) and can be deployed in minutes.
How it saves time or tokens
BookStack's hierarchical organization eliminates the flat-page problem common in wikis. You do not need tags or complex search queries to find content because the shelf-book-chapter-page structure provides natural navigation.
For AI-assisted documentation workflows, BookStack's REST API lets agents create, update, and organize pages programmatically. An agent can generate documentation and push it directly into the right book and chapter.
How to use
- Deploy BookStack via Docker:
docker run -d -p 6875:80 linuxserver/bookstack - Configure the
.envfile with your MySQL connection and app URL - Log in with the default admin credentials and create your first Shelf
- Add Books, Chapters, and Pages using the WYSIWYG or Markdown editor
Example
# Docker Compose setup
version: '3'
services:
bookstack:
image: linuxserver/bookstack
environment:
- APP_URL=https://docs.example.com
- DB_HOST=db
- DB_DATABASE=bookstack
- DB_USERNAME=bookstack
- DB_PASSWORD=secret
ports:
- '6875:80'
depends_on:
- db
db:
image: mysql:8
environment:
- MYSQL_ROOT_PASSWORD=secret
- MYSQL_DATABASE=bookstack
- MYSQL_USER=bookstack
- MYSQL_PASSWORD=secret
Related on TokRepo
- Documentation tools -- More documentation and knowledge management tools
- Self-hosted tools -- Self-hosted alternatives to SaaS platforms
Common pitfalls
- The default admin password is
password; change it immediately after first login - BookStack stores uploaded images on the local filesystem by default; configure S3 storage for production
- Full-text search uses MySQL FULLTEXT indexes, which do not support CJK characters well without additional configuration
常见问题
BookStack is free, open-source, and self-hosted. Confluence is a paid Atlassian product with more enterprise features like Jira integration and real-time collaboration. BookStack is simpler, faster to set up, and suitable for teams that do not need Atlassian ecosystem integration.
Yes. BookStack supports LDAP and SAML for authentication. You configure the LDAP server, base DN, and attribute mapping in the .env file. Users are automatically created on first login with their LDAP credentials.
Yes. Every page edit creates a revision. You can view the full revision history, compare changes between versions, and restore any previous version with one click.
BookStack supports exporting individual pages or entire books as PDF, HTML, or plain text. The REST API also allows programmatic export for backup or migration purposes.
BookStack requires PHP 8.1+, MySQL 5.7+ or MariaDB 10.2+, and a web server like Apache or Nginx. The Docker image bundles everything. Minimum RAM is 512 MB, but 1 GB is recommended for comfortable performance.
引用来源 (3)
- BookStack GitHub— BookStack is an open-source wiki platform with shelves, books, chapters, and pag…
- BookStack Docs— BookStack supports LDAP, SAML, and role-based access control
- BookStack API Docs— BookStack REST API for programmatic content management
讨论
相关资产
Gotify — Self-Hosted Push Notification Server
Gotify is a simple, self-hosted push notification server with a REST API, real-time WebSocket delivery, and a web UI plus Android app for receiving alerts.
DokuWiki — Simple Wiki That Stores Data in Plain Text Files
Lightweight wiki engine that requires no database. Uses plain text files for storage, making backups trivial and deployments simple. Ideal for documentation, knowledge bases, and internal team wikis.
Seafile — Self-Hosted File Sync & Share Platform
Seafile is a high-performance, self-hosted file synchronization and sharing platform with client-side encryption, versioning, and team collaboration.
Shiori — Simple Self-Hosted Bookmark Manager
Shiori is a lightweight self-hosted bookmark manager written in Go with full-text search, archiving, and a clean web interface for organizing your saved links.