lsiodev/bookstack

linuxserver/bookstack

镜像概述和主要用途

https://github.com/BookStackApp/BookStack 是一款免费开源的Wiki系统，旨在创建美观的文档。它提供简洁而强大的WYSIWYG编辑器，使团队能够轻松创建详细实用的文档。该镜像由LinuxServer.io团队维护，具备定期更新、用户权限映射、自定义基础镜像等特性，确保应用稳定运行与便捷管理。

核心功能和特性

LinuxServer.io镜像特性

• 定期及时的应用更新
• 简单的用户映射（PGID、PUID）
• 基于s6 overlay的自定义基础镜像
• 每周基础操作系统更新，跨生态系统共享公共层以减少空间占用、 downtime和带宽
• 定期安全更新

Bookstack核心功能

• 直观的WYSIWYG编辑器，支持富文本编辑
• Markdown编辑器支持，满足不同用户偏好
• 基于SQL数据库存储，确保数据可靠性
• 文档组织系统（书籍、章节、页面），结构化管理内容
• 权限控制，支持团队协作与内容访问管理

支持的架构

该镜像利用Docker manifest实现多平台支持，拉取lscr.io/linuxserver/bookstack:latest将自动获取适合您架构的镜像，也可通过标签指定特定架构：

应用设置

初始访问

默认用户名为admin@admin.com，密码为password，通过http://dockerhost:6875访问容器。

数据库依赖

应用依赖MySQL数据库（可使用现有数据库或新建），推荐搭配LinuxServer的MariaDB容器：https://hub.docker.com/r/linuxserver/mariadb/%E3%80%82

反向代理配置

若在子文件夹反向代理（如SWAG或Traefik）后使用，需设置APP_URL环境变量为外部域名，否则可能无法正常工作。

BookStack文件与目录路径

容器将BookStack的关键文件/目录持久化到/config卷中，以下为容器路径与标准BookStack安装路径的映射关系：

高级用户配置（.env文件控制）

如需使用邮件、Memcache、LDAP等高级功能，需参考BookStack文档创建自定义.env文件。创建容器时不要设置任何SQL相关环境变量，容器会自动复制示例.env文件到/config/www/.env，供用户编辑。

使用方法

Docker Compose（推荐）

yaml
---
version: "2"
services:
  bookstack:
    image: lscr.io/linuxserver/bookstack
    container_name: bookstack
    environment:
      - PUID=1000
      - PGID=1000
      - APP_URL=https://bookstack.example.com
      - DB_HOST=bookstack_db
      - DB_PORT=3306
      - DB_USER=bookstack
      - DB_PASS=<yourdbpass>
      - DB_DATABASE=bookstackapp
    volumes:
      - ./bookstack_app_data:/config
    ports:
      - 6875:80
    restart: unless-stopped
    depends_on:
      - bookstack_db
  bookstack_db:
    image: lscr.io/linuxserver/mariadb
    container_name: bookstack_db
    environment:
      - PUID=1000
      - PGID=1000
      - MYSQL_ROOT_PASSWORD=<yourdbpass>
      - TZ=Europe/London
      - MYSQL_DATABASE=bookstackapp
      - MYSQL_USER=bookstack
      - MYSQL_PASSWORD=<yourdbpass>
    volumes:
      - ./bookstack_db_data:/config
    restart: unless-stopped

Docker Run命令

bash
docker run -d \
  --name=bookstack \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e APP_URL=yourbaseurl \
  -e DB_HOST=yourdbhost \
  -e DB_PORT=yourdbport \
  -e DB_USER=yourdbuser \
  -e DB_PASS=yourdbpass \
  -e DB_DATABASE=bookstackapp \
  -e QUEUE_CONNECTION= `#可选` \
  -p 6875:80 \
  -v /path/to/data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/bookstack:latest

参数说明

容器运行时通过参数配置，格式为<外部>:<内部>：

环境变量文件（Docker Secrets）

通过FILE__前缀从文件加载环境变量，例如：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

将从/run/secrets/mysecretvariable文件内容设置MYVAR环境变量。

Umask设置

可通过-e UMASK=022覆盖默认umask设置，控制容器内服务的文件权限，详情参考umask说明。

用户/组标识符

使用卷时，通过PUID（用户ID）和PGID（组ID）避免权限问题。确保主机卷目录所有者与指定ID一致。通过id your_user命令获取当前用户的ID：

bash
id your_user

示例输出：

text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

可通过Docker Mods扩展功能，查看可用Mods：bookstack Mods 或 通用Mods。

支持信息

容器内Shell访问

bash
docker exec -it bookstack /bin/bash

实时日志监控

bash
docker logs -f bookstack

容器版本查看

bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack

镜像版本查看

bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/bookstack:latest

更新方法

通过Docker Compose

• 更新镜像：
  • 所有镜像：docker-compose pull
  • 单个镜像：docker-compose pull bookstack
• 更新容器：
  • 所有容器：docker-compose up -d
  • 单个容器：docker-compose up -d bookstack
• 清理旧镜像：docker image prune

通过Docker Run

• 更新镜像：docker pull lscr.io/linuxserver/bookstack:latest
• 停止容器：docker stop bookstack
• 删除容器：docker rm bookstack
• 用原参数重新创建容器（/config卷映射正确则配置保留）
• 清理旧镜像：docker image prune

通过Watchtower自动更新（仅忘记原始参数时使用）

bash
docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once bookstack

清理旧镜像：docker image prune

警告：不推荐使用Watchtower自动更新容器，建议使用Docker Compose管理。

本地构建

bash
git clone https://github.com/linuxserver/docker-bookstack.git
cd docker-bookstack
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/bookstack:latest .

ARM架构构建（需在x86_64硬件上使用multiarch/qemu-user-static）：

bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset

然后使用对应架构Dockerfile：-f Dockerfile.aarch64

版本历史

• 31.10.23: 进一步优化sed替换逻辑
• 07.06.23: 添加mariadb-client以支持bookstack-system-cli
• 25.05.23: 基于Alpine 3.18重建，不再支持armhf架构
• 13.04.23: 将ssl.conf包含到default.conf
• 01.03.23: 添加php iconv
• 19.01.23: 基于Alpine 3.17和php8.1重建
• 16.01.23: .env文件值添加引号包裹
• 05.01.23: 修复数据库密码设置（sed转义&）
• 21.12.22: 环境变量更新时同步更新.env文件中的数据库信息
• 10.10.22: 移除导致部分用户问题的密码转义逻辑
• 20.08.22: 基于Alpine 3.15和php8重建，重构nginx配置
• 14.03.22: 添加主题支持的符号链接
• 11.07.21: 基于Alpine 3.14重建
• 12.01.21: 移除0.31.0版本不再使用的依赖
• 17.12.20: APP_URL变量设为必填（上游变更）
• 17.09.20: 基于Alpine 3.12重建，修复APP_URL设置，默认php上传大小调整为100MB
• 19.12.19: 基于Alpine 3.11重建
• 26.07.19: 使用旧版tidyhtml等待上游修复
• 28.06.19: 基于Alpine 3.10重建
• 14.06.19: 添加wkhtmltopdf用于PDF渲染
• 20.04.19: 基于Alpine 3.9重建，添加MySQL初始化逻辑
• 22.03.19: 切换到新基础镜像，使用arm32v7标签
• 20.01.19: 添加php7-curl
• 04.11.18: 添加php7-ldap
• 15.10.18: 改进高级用户功能
• 08.10.18: 高级模式、符号链接变更、sed修复、文档更新、添加composer文件
• 23.09.28: 更新预发布版本
• 02.07.18: 初始发布