sudojunior/bookstack

BookStack Docker容器

镜像概述

本Docker镜像是用于运行BookStack文档管理系统的容器化解决方案，基于lscr.io分叉版本构建。BookStack是一款开源的文档管理平台，旨在提供直观的界面用于创建、组织和管理结构化文档，支持团队协作和知识共享。

核心功能与特性

• 文档层级管理：支持创建书籍、章节和页面三级结构，实现文档的有序组织
• 用户权限控制：提供多角色权限管理，可配置不同用户对文档的查看、编辑和管理权限
• 富文本编辑：集成富文本编辑器，支持格式化文本、图片插入、表格、代码块等内容编辑功能
• 全文搜索：内置全文搜索功能，快速定位所需文档内容
• 版本控制：自动记录文档修改历史，支持版本回溯
• Docker化部署：简化部署流程，支持跨平台运行，便于维护和升级

使用场景

• 团队知识库：用于团队内部技术文档、流程规范、项目文档的集中管理与协作
• 个人笔记系统：个人知识整理、学习笔记的结构化存储
• 企业文档库：企业内部培训材料、政策文件、操作手册的统一管理
• 开源项目文档：开源项目的API文档、使用指南、开发手册等的维护

使用方法

前提条件

• 已安装Docker Engine (20.10.0+ 推荐)
• 已安装Docker Compose (可选，用于多容器部署)
• 具备数据库服务（可使用Docker容器化的MySQL/MariaDB或外部数据库）

基本部署 (docker run)

bash
docker run -d \
  --name=bookstack \
  -p 80:80 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e DB_HOST=your-db-host \
  -e DB_USER=bookstack \
  -e DB_PASS=your-db-password \
  -e DB_NAME=bookstackapp \
  -v /path/to/local/data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/bookstack:latest

Docker Compose部署 (推荐)

创建docker-compose.yml文件：

yaml
version: "3"

services:
  bookstack:
    image: lscr.io/linuxserver/bookstack:latest
    container_name: bookstack
    environment:
      - PUID=1000
      - PGID=1000
      - DB_HOST=bookstack_db
      - DB_USER=bookstack
      - DB_PASS=secure-db-password
      - DB_NAME=bookstackapp
      - TZ=Asia/Shanghai
    volumes:
      - ./bookstack_data:/config
    ports:
      - "80:80"
    restart: unless-stopped
    depends_on:
      - bookstack_db

  bookstack_db:
    image: lscr.io/linuxserver/mariadb:latest
    container_name: bookstack_db
    environment:
      - PUID=1000
      - PGID=1000
      - MYSQL_ROOT_PASSWORD=root-password
      - TZ=Asia/Shanghai
      - MYSQL_DATABASE=bookstackapp
      - MYSQL_USER=bookstack
      - MYSQL_PASSWORD=secure-db-password
    volumes:
      - ./bookstack_db:/config
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

环境变量配置说明

初始访问与配置

1. 部署完成后，通过浏览器访问 http://服务器IP:80
2. 使用默认管理员账号登录：
   • 用户名：admin@admin.com
   • 密码：password
3. 登录后建议立即修改管理员密码（通过右上角用户菜单进入"个人资料"设置）
4. 根据需求创建书籍、章节和页面，配置用户权限等

数据持久化

• 容器数据通过 -v /path/to/local/data:/config 挂载到本地目录，确保数据持久化
• 数据库数据通过单独的卷挂载（在Docker Compose配置中），避免数据丢失

注意事项

• 生产环境建议配置HTTPS，可通过反向代理（如Nginx）实现
• 定期备份挂载的本地数据目录和数据库
• 根据实际需求调整容器资源限制（如内存、CPU）
• 升级镜像时，建议先备份数据，再执行docker-compose pull和docker-compose up -d