willdockerhub/bookstack

BookStack Docker镜像文档

镜像概述和主要用途

BookStack是一款基于MinDoc，使用Beego框架开发的在线文档管理系统，功能类似于Gitbook和看云，支持文档的创建、编辑、管理和分享。该Docker镜像封装了BookStack应用及其依赖环境，便于快速部署和使用。

官网：[***]
项目地址：https://github.com/TruthHun/BookStack
Dockerfile地址：https://github.com/willzhang/docker-bookstackcn

核心功能和特性

• 文档管理：支持创建项目、编辑文档、保存和发布内容
• PDF导出：支持将文档导出为PDF格式
• 用户管理：提供管理员账号，支持项目权限控制
• Web界面：直观的Web界面，便于操作和管理文档

使用场景和适用范围

• 团队内部技术文档协作管理
• 个人知识库搭建
• 产品手册、教程文档的在线发布和分享

使用方法和配置说明

环境要求

• Docker和Docker Compose（推荐使用Docker Compose部署）
• 至少1GB可用存储空间（镜像大小超过1G）

1. Docker Compose部署

创建docker-compose.yml文件

yaml
version: "3"
  
services:
  bookstack:
    image: "willdockerhub/bookstack:v2.9_node"
    container_name: bookstack
    ports:
      - "8181:8181"
    depends_on:
      - db
    restart: always
    networks:
      - bookstack

  db:
    image: "mysql:8.0.23"
    container_name: bookstack_mysql
    ports:
      - "3306:3306"
    environment:
      MYSQL_ROOT_PASSWORD: "123456"
      MYSQL_DATABASE: "bookstack"
      MYSQL_USER: "bookstack"
      MYSQL_PASSWORD: "bookstack123"
    volumes:
      - "mysql-data:/var/lib/mysql"
    restart: always
    networks:
      - bookstack    

networks:
  bookstack:

volumes:
  mysql-data:

启动服务

shell
docker-compose up -d

查看运行状态

shell
docker-compose ps

预期输出：

     Name                    Command               State                 Ports              
--------------------------------------------------------------------------------------------
bookstack         /entrypoint.sh /bookstack/ ...   Up      0.0.0.0:8181->8181/tcp           
bookstack_mysql   docker-entrypoint.sh mysqld      Up      0.0.0.0:3306->3306/tcp, 33060/tcp

查看日志

BookStack启动需要等待数据库完全就绪，可通过日志确认状态：

shell
docker logs -f bookstack

2. Docker单独部署

步骤1：运行MySQL容器

shell
docker run -d --name mysql \
  --restart always \
  -p 3306:3306 \
  -e MYSQL_ROOT_PASSWORD=123456 \
  -e MYSQL_DATABASE=bookstack \
  -e MYSQL_USER=bookstack \
  -e MYSQL_PASSWORD=bookstack123 \
  -v mysql:/var/lib/mysql \
  mysql:8.0.23

步骤2：获取配置文件（二选一）

方式1：从容器中获取

shell
mkdir -p /data/bookstack/
docker run -d --name bookstack --entrypoint='/bin/sh' willdockerhub/bookstack:v2.9_node
docker cp bookstack:/tmp/conf/ /data/bookstack/
docker rm -f bookstack

方式2：从官网获取

从 https://github.com/TruthHun/BookStack/tree/v2.9/conf 下载对应版本的配置文件（app.conf.example、oauth.conf.example、oss.conf.example），并修改app.conf中的数据库连接信息：

shell
# 示例配置（/data/bookstack/conf/app.conf）
db_adapter=mysql
db_host=172.29.118.192  # 主机IP地址
db_port=3306
db_username=bookstack
db_password=bookstack123
db_database=bookstack

步骤3：运行BookStack容器

挂载配置文件方式

shell
docker run -d --name bookstack \
  --restart always \
  -p 8181:8181 \
  -v /data/bookstack/conf:/bookstack/conf \
  willdockerhub/bookstack:v2.9_node

环境变量方式（不挂载配置文件）

shell
docker run -d --name bookstack \
  --restart always \
  -p 8181:8181 \
  -e DB_HOST=172.29.118.192 \  # 主机IP地址
  -e DB_PORT=3306 \
  -e DB_USERNAME=bookstack \
  -e DB_PASSWORD=bookstack123 \
  -e DB_DATABASE=bookstack \
  -e RUN_MODE=prod \
  willdockerhub/bookstack:v2.9_node

3. 访问与使用

访问Web界面

在浏览器中访问：http://<服务器IP>:8181

默认管理员账号

用户名：admin
密码：admin888

基本操作

1. 登录后，点击右侧「管理员」→「我的项目」→「添加项目」创建文档项目
2. 编辑文档内容并保存发布
3. 文档发布后即可在线阅读

生成和导出PDF

1. 进入「管理后台」→「配置管理」，将「阅读限制」设置为0
2. 在「我的项目」中选择目标书籍，点击导出功能，选择PDF格式即可

4. 数据持久化说明

BookStack应用数据默认存储在容器内的/bookstack目录，未持久化。如需持久化，可挂载该目录（需谨慎操作，建议先了解目录结构）。

清理部署环境

Docker Compose方式（警告：-v参数会删除持久化卷，谨慎操作）：

shell
docker-compose down -v

Docker单独部署方式：

shell
docker stop bookstack && docker rm bookstack
docker stop mysql && docker rm mysql && docker volume rm mysql