Configs2026年4月10日·1 分钟阅读

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 就绪

这个资产会安全暂存

这个资产会先安全暂存。复制的指令会要求 Agent 读取暂存文件,并在激活脚本、MCP 配置或全局配置前先确认。

Stage only · 27/100策略:需暂存
Agent 入口
任意 MCP/CLI Agent
类型
Knowledge
安装
Stage only
信任
信任等级:Established
入口
step-1.md
安全暂存命令
npx -y tokrepo@latest install 590e1c8e-34e1-11f1-9bc6-00163e2b0d79 --target codex

先暂存文件;激活前需要读取暂存 README 和安装计划。

TL;DR
BookStack organizes docs by Shelves, Books, Chapters, and Pages with WYSIWYG and Markdown editing.
§01

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.

§02

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.

§03

How to use

  1. Deploy BookStack via Docker: docker run -d -p 6875:80 linuxserver/bookstack
  2. Configure the .env file with your MySQL connection and app URL
  3. Log in with the default admin credentials and create your first Shelf
  4. Add Books, Chapters, and Pages using the WYSIWYG or Markdown editor
§04

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
§05

Related on TokRepo

§06

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

常见问题

How does BookStack compare to Confluence?+

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.

Can BookStack handle authentication via LDAP?+

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.

Does BookStack support version history?+

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.

Can I export content from BookStack?+

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.

What are the system requirements for BookStack?+

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

讨论

登录后参与讨论。
还没有评论,来写第一条吧。

相关资产