unillett/bookstack

Bookstack Docker镜像文档

镜像概述

本Docker镜像用于部署和运行https://github.com/BookStackApp/BookStack应用，提供了开发环境和生产环境的完整配置方案，支持通过Docker Compose快速构建和运行应用服务。

核心功能与特性

• 支持开发环境和生产环境分离配置
• 集成数据库初始化与数据导入功能
• 包含MailHog邮件测试服务
• 提供自动化构建和版本更新机制
• 支持Helm图表部署（适用于Kubernetes环境）

使用场景

• 个人或团队文档管理系统部署
• 开发环境快速搭建与测试
• 生产环境容器化部署
• 需要邮件通知功能的文档协作平台

详细使用方法

开发环境配置

前置要求

需先安装https://docs.docker.com/engine/install/环境。

配置环境文件

1. 复制环境示例文件并重命名为.env：

   bash
   cp example.env .env
   

   默认值适用于本地开发，如有需要可修改配置值。

2. 复制开发环境的docker-compose覆盖文件：

   bash
   cp docker-compose.override.yml.dev docker-compose.override.yml
   

   默认配置适用于本地开发，可根据需求调整。

配置主机文件

编辑主机文件，将bookstack.lan指向Docker主机IP。

数据库初始化（可选）

如需自动导入Bookstack数据库，可将数据库备份文件放入import文件夹，并命名为import.sql。数据库内容将在mysql-data卷首次创建时自动导入。

构建与运行

构建并启动所有容器：

bash
docker-compose up  # 如需后台运行并静默日志，添加-d参数

访问应用

• 主应用：[***]

  • 默认管理员账号：*** / password

• MailHog邮件测试：[***]

  • JSON格式邮件消息API：[***]

生产环境部署

1. 复制环境文件：

   bash
   cp example.env .env
   

   必须修改默认值，默认配置不适用于生产环境。

2. 复制生产环境的docker-compose覆盖文件：

   bash
   cp docker-compose.override.yml.prod docker-compose.override.yml
   

   默认配置适用于生产环境，如有需要可调整。

3. 构建并后台运行容器：

   bash
   docker-compose up -d
   

4. 配置反向代理，将访问域名映射到容器的8282端口。

应用更新

版本更新机制

通过修改https://github.com/unil-lettres/bookstack/blob/main/VERSION文件中的标签值触发https://github.com/unil-lettres/bookstack/blob/main/.github/workflows/docker.yml，自动构建自定义镜像并推送到https://hub.docker.com/repository/docker/unillett/bookstack/general。

• 当https://github.com/BookStackApp/BookStack/releases发布时，更新VERSION文件中的标签值
• 推送更改后，工作流将自动构建新镜像并推送至Docker Hub

自定义镜像版本

如需触发重建或标记自定义镜像版本，可在VERSION文件的值中添加修订后缀（如-rev1）。该后缀在获取BookStack源代码时会被忽略，但可用于区分工作流中的构建和Docker镜像标签。

Docker镜像标签规则

GitHub Actions工作流根据以下事件生成Docker镜像标签：

• 推送到development分支：stage-latest、stage-<sha>-<timestamp>（不可变）
• 推送到main分支：latest
• 推送git标签：vX.Y.Z（不可变，基于VERSION文件）

定时任务生成的镜像

每周定时任务将创建：

• 更新的测试环境镜像：stage-<sha>-<timestamp>（不可变）
• 更新的生产候选镜像：vX.Y.Z-<sha>-<timestamp>（不可变，基于VERSION文件）

所有不可变标签均会提交至https://github.com/unil-lettres/k8s。

Helm部署

本项目的Helm图表位于https://github.com/unil-lettres/k8s的`wlett`目录下。