infrascielo/bookstack

BookStack

镜像概述和主要用途

BookStack是一个 opinionated 的wiki系统，旨在提供愉悦且简单的开箱即用体验。新用户能够直观地使用平台，只需基本的文字处理技能即可参与内容创建。它既为普通用户提供简洁体验，也为高级用户提供强大功能，同时不影响核心的简单用户体验。主要用于存储、组织和管理各类信息与文档，适用于团队知识库、项目文档、个人笔记等场景。

核心功能和特性

• 直观的内容组织：采用书籍（Books）、章节（Chapters）、页面（Pages）三级结构，清晰组织文档内容
• 多样化编辑器：支持富文本编辑器和Markdown编辑器，满足不同用户的编辑习惯
• 权限管理系统：灵活的角色和权限设置，可细粒度控制用户对内容的访问和操作权限
• 平台REST API：提供API接口，支持核心内容模型（书籍、章节、页面）的自动化和平台扩展
• 多语言支持：通过Crowdin平台进行翻译管理，支持多种语言
• 导出功能：支持将内容导出为PDF等格式
• 搜索功能：快速检索平台内的文档内容

使用场景和适用范围

• 团队知识库：用于团队内部共享和协作编辑技术文档、流程规范等
• 项目文档管理：存储项目需求、设计方案、开发文档、测试报告等
• 个人笔记系统：整理个人学习笔记、研究资料、灵感记录等
• 企业文档中心：集中管理公司政策、培训材料、产品文档等

使用方法和配置说明

Docker快速部署（docker run）

bash
# 首先启动MySQL数据库
docker run -d \
  --name bookstack-db \
  -e MYSQL_ROOT_PASSWORD=secret \
  -e MYSQL_DATABASE=bookstack \
  -e MYSQL_USER=bookstack \
  -e MYSQL_PASSWORD=secret \
  -v bookstack-db-data:/var/lib/mysql \
  mysql:8.0 --default-authentication-plugin=mysql_native_password

# 启动BookStack
docker run -d \
  --name bookstack \
  -p 8080:80 \
  -e DB_HOST=bookstack-db \
  -e DB_DATABASE=bookstack \
  -e DB_USERNAME=bookstack \
  -e DB_PASSWORD=secret \
  -e APP_KEY=$(head -c 32 /dev/urandom | base64) \
  -e APP_URL=http://localhost:8080 \
  --link bookstack-db:bookstack-db \
  bookstackapp/bookstack

Docker Compose配置

创建docker-compose.yml文件：

yaml
version: '3'

services:
  db:
    image: mysql:8.0
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: secret
      MYSQL_DATABASE: bookstack
      MYSQL_USER: bookstack
      MYSQL_PASSWORD: secret
    volumes:
      - bookstack-db-data:/var/lib/mysql
    command: --default-authentication-plugin=mysql_native_password

  app:
    image: bookstackapp/bookstack
    restart: always
    depends_on:
      - db
    ports:
      - "8080:80"
    environment:
      DB_HOST: db
      DB_DATABASE: bookstack
      DB_USERNAME: bookstack
      DB_PASSWORD: secret
      APP_KEY: base64:your_random_32_char_key_here
      APP_URL: http://localhost:8080
    volumes:
      - bookstack-uploads:/app/public/uploads
      - bookstack-storage:/app/storage

volumes:
  bookstack-db-data:
  bookstack-uploads:
  bookstack-storage:

启动服务：

bash
docker-compose up -d

环境变量配置说明

初始化访问

服务启动后，通过http://localhost:8080访问，默认管理员账号：

• ***：admin@example.com
• 密码：password

首次登录后建议立即修改密码以确保安全。

开发与测试

BookStack提供Docker Compose开发环境配置，适合开发者进行二次开发和测试：

1. 克隆仓库：git clone https://github.com/BookStackApp/BookStack.git
2. 复制环境变量示例：cp .env.example .env，修改APP_KEY和APP_ENV=local
3. 启动开发环境：docker-compose up
4. 访问：http://localhost:8080，默认登录账号admin@admin.com，密码password

运行测试：

bash
# 初始化测试数据库
docker-compose run app php artisan migrate --database=mysql_testing
docker-compose run app php artisan db:seed --class=DummyContentSeeder --database=mysql_testing

# 执行测试
docker-compose run app php vendor/bin/phpunit

安全注意事项

• 生产环境中务必修改默认管理员密码
• 使用强密码并定期更新
• 配置HTTPS以保护数据传输
• 定期更新BookStack到最新版本以获取安全补丁
• 可订阅BookStack安全邮件列表获取安全更新通知

许可证

BookStack采用MIT许可证，源代码可自由使用、修改和分发。