BookStack Docker 镜像文档

镜像概述

BookStack Docker镜像是一个容器化版本的BookStack，BookStack是一款开源的知识库管理系统，旨在提供一个简单、直观的平台用于组织和存储信息。该镜像将BookStack应用程序及其依赖项打包，以便快速、便捷地部署和运行。

项目地址：[***]

当前版本

22.04 (Dockerfile)

变更记录

• 在 0.28.0 版本中，容器HTTP端口从80更改为8080，以允许删除root权限
• 在 0.12.2 版本中，移除了DB_PORT参数。现在可以通过DB_HOST指定端口，例如DB_HOST=mysql:3306

核心功能和特性

• 基于BookStack构建，提供完整的知识库管理功能
• 容器化部署，简化安装和配置过程
• 支持与MySQL数据库集成
• 支持LDAP认证（需特殊配置）
• 可通过环境变量灵活配置应用参数
• 数据持久化支持，通过卷(Volumes)保存用户数据

使用场景和适用范围

• 团队知识库建设和管理
• 个人笔记和文档整理
• 项目文档协作平台
• 企业内部知识共享系统
• 快速搭建内部文档网站

快速入门

使用Docker Compose可以非常简单地快速启动。运行以下命令：

docker-compose up

启动完成后，打开浏览器并访问 http://localhost:8080。使用用户名 *** 和密码 password 登录。

使用方法

使用Docker Compose部署

创建docker-compose.yml文件，内容如下：

version: '3'

services:
  mysql:
    image: mysql:5.7.21
    environment:
      - MYSQL_ROOT_PASSWORD=secret
      - MYSQL_DATABASE=bookstack
      - MYSQL_USER=bookstack
      - MYSQL_PASSWORD=secret
    volumes:
      - mysql_data:/var/lib/mysql

  bookstack:
    image: solidnerd/bookstack:22.04
    depends_on:
      - mysql
    environment:
      - DB_HOST=mysql:3306
      - DB_DATABASE=bookstack
      - DB_USERNAME=bookstack
      - DB_PASSWORD=secret
      - APP_URL=http://localhost:8080
    ports:
      - "8080:8080"
    volumes:
      - bookstack_uploads:/var/www/bookstack/public/uploads
      - bookstack_storage:/var/www/bookstack/storage/uploads

volumes:
  mysql_data:
  bookstack_uploads:
  bookstack_storage:

然后运行：

docker-compose up -d

不使用Docker Compose的部署方法

注意事项

• 如果要使用LDAP，$符号需要转义为\$，例如：-e "LDAP_USER_FILTER"="(&(uid=\${user}))"
• Docker v1.9版本前后网络配置有所不同，需根据您的Docker版本选择相应方法

Docker < v1.9

1. 启动MySQL容器：

docker run -d \
  -p 3306:3306 \
  -e MYSQL_ROOT_PASSWORD=secret \
  -e MYSQL_DATABASE=bookstack \
  -e MYSQL_USER=bookstack \
  -e MYSQL_PASSWORD=secret \
  --name bookstack_db \
  mysql:5.7.21

2. 启动BookStack容器：

docker run -d --link bookstack_db:mysql \
  -p 8080:8080 \
  --name bookstack_22.04 \
  solidnerd/bookstack:22.04

Docker 1.9+

1. 创建共享网络：

docker network create bookstack_nw

2. 启动MySQL容器：

docker run -d --net bookstack_nw  \
  -e MYSQL_ROOT_PASSWORD=secret \
  -e MYSQL_DATABASE=bookstack \
  -e MYSQL_USER=bookstack \
  -e MYSQL_PASSWORD=secret \
  --name="bookstack_db" \
  mysql:5.7.21

3. 启动BookStack容器：

docker run -d --net bookstack_nw \
  -e DB_HOST=bookstack_db:3306 \
  -e DB_DATABASE=bookstack \
  -e DB_USERNAME=bookstack \
  -e DB_PASSWORD=secret \
  -e APP_URL=[***] \
  -p 8080:8080 \
  --name="bookstack_22.04" \
  solidnerd/bookstack:22.04

APP_URL参数说明：应设置为BookStack实例的基础URL，不包含末尾斜杠，例如：APP_URL=[***]

数据持久化（Volumes）

为了在主机系统上访问.env文件和重要的BookStack文件夹，请将以下参数添加到docker run命令中（将<HOST>替换为您的主机目录）：

--mount type=bind,source=<HOST>/.env,target=/var/www/bookstack/.env \
-v <HOST>:/var/www/bookstack/public/uploads \
-v <HOST>:/var/www/bookstack/storage/uploads

Windows主机注意事项：在Windows主机上，.env文件必须预先在主机目录中创建，否则会创建一个名为.env的文件夹。

完成上述步骤后，您可以访问 http://localhost:8080，使用用户名***和密码password登录。

配置参数和环境变量

数据库配置

• DB_HOST: 数据库主机地址，可包含端口，例如mysql:3306
• DB_DATABASE: 数据库名称
• DB_USERNAME: 数据库用户名
• DB_PASSWORD: 数据库密码

应用配置

• APP_URL: 应用程序基础URL，不包含末尾斜杠
• APP_KEY: 应用程序加密密钥，首次启动时会自动生成

LDAP配置（如使用）

• LDAP_USER_FILTER: LDAP用户过滤条件，注意$符号需要转义为\$

问题反馈

如有任何问题，请随时在GitHub上创建issue。

项目灵感

本项目是Kilhog/docker-bookstack的分支。Kilhog完成了初始工作，本项目则朝着不同的方向发展。