l2share/bookstack

linuxserver/bookstack

!Bookstack

镜像概述

https://github.com/BookStackApp/BookStack 是一个免费开源的Wiki工具，旨在创建美观的文档。它具有简单但功能强大的WYSIWYG编辑器，使团队能够轻松创建详细且有用的文档。Bookstack基于SQL数据库，并包含Markdown编辑器，让文档编写从繁琐变为轻松。

LinuxServer.io团队提供的此镜像具有以下特点：

• 定期及时的应用更新
• 简单的用户映射（PGID、PUID）
• 带有s6覆盖层的自定义基础镜像
• 每周基础操作系统更新，整个LinuxServer.io生态系统共享通用层，以最小化空间占用、停机时间和带宽
• 定期安全更新

支持的架构

该镜像支持多种架构，如x86-64、arm64和armhf。我们利用Docker manifest实现多平台识别。直接拉取linuxserver/bookstack即可获取适合您架构的正确镜像，也可通过标签拉取特定架构的镜像。

支持的架构及对应标签：

使用方法

以下是帮助您开始创建容器的示例代码片段。

docker

bash
docker create \
  --name=bookstack \
  -e PUID=1000 \
  -e PGID=1000 \
  -e DB_HOST=<您的数据库主机> \
  -e DB_USER=<您的数据库用户> \
  -e DB_PASS=<您的数据库密码> \
  -e DB_DATABASE=bookstackapp \
  -e APP_URL=http://您的站点地址.xyz `#可选` \
  -p 6875:80 \
  -v /路径/到/数据:/config \
  --restart unless-stopped \
  linuxserver/bookstack

docker-compose

兼容docker-compose v2架构。

yaml
---
version: "2"
services:
  bookstack:
    image: linuxserver/bookstack
    container_name: bookstack
    environment:
      - PUID=1000
      - PGID=1000
      - DB_HOST=bookstack_db
      - DB_USER=bookstack
      - DB_PASS=<您的数据库密码>
      - DB_DATABASE=bookstackapp
    volumes:
      - /路径/到/数据:/config
    ports:
      - 6875:80
    restart: unless-stopped
    depends_on:
      - bookstack_db
  bookstack_db:
    image: linuxserver/mariadb
    container_name: bookstack_db
    environment:
      - PUID=1000
      - PGID=1000
      - MYSQL_ROOT_PASSWORD=<您的数据库密码>
      - TZ=Europe/London
      - MYSQL_DATABASE=bookstackapp
      - MYSQL_USER=bookstack
      - MYSQL_PASSWORD=<您的数据库密码>
    volumes:
      - /路径/到/数据:/config
    restart: unless-stopped

参数

容器镜像通过运行时传递的参数进行配置（如上所示）。这些参数用冒号分隔，表示<外部>:<内部>。例如，-p 8080:80会将容器内的80端口映射到主机IP的8080端口。

来自文件的环境变量（Docker secrets）

您可以通过使用特殊前缀FILE__从文件设置任何环境变量。

例如：

bash
-e FILE__PASSWORD=/run/secrets/mysecretpassword

这将根据/run/secrets/mysecretpassword文件的内容设置环境变量PASSWORD。

用户/组标识符

使用卷（-v标志）时，主机操作系统和容器之间可能会出现权限问题。我们通过允许您指定用户PUID和组PGID来避免此问题。

确保主机上的任何卷目录都由您指定的相同用户拥有，权限问题将迎刃而解。

在此示例中PUID=1000和PGID=1000，要查找您的ID，请使用id user：

bash
$ id username
  uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

应用设置

默认用户名为***，密码为password，通过[***]

此应用依赖MySQL数据库，无论是已有的还是新创建的。如果您还没有数据库，请设置我们的MariaDB容器：https://hub.docker.com/r/linuxserver/mariadb/%E3%80%82

如果打算在子文件夹反向代理（如我们的LetsEncrypt容器或Traefik）后使用此应用，需要确保设置APP_URL环境变量，否则无法正常工作。

BookStack文档可在[***]

高级用户（完全控制.env文件）

如果希望使用BookStack的额外功能（如电子邮件、Memcache、LDAP等），需要根据BookStack文档创建自己的.env文件。

创建容器时，不要为任何SQL设置或APP_URL设置参数。容器会将示例.env文件复制到主机系统的/config/www/.env供您编辑。

PDF渲染

wkhtmltopdf可用作替代PDF渲染生成器，如[***]

此镜像中wkhtmltopdf的路径（需包含在.env文件中）为/usr/bin/wkhtmltopdf。

Docker Mods

https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27bookstack%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml]([***] "查看此容器的可用mods")

我们发布了各种https://github.com/linuxserver/docker-mods%E4%BB%A5%E5%90%AF%E7%94%A8%E5%AE%B9%E5%99%A8%E5%86%85%E7%9A%84%E9%A2%9D%E5%A4%96%E5%8A%9F%E8%83%BD%E3%80%82%E6%AD%A4%E9%95%9C%E5%83%8F%E5%8F%AF%E7%94%A8%E7%9A%84Mods%E5%88%97%E8%A1%A8%EF%BC%88%E5%A6%82%E6%9C%89%EF%BC%89%E5%8F%AF%E9%80%9A%E8%BF%87%E4%B8%8A%E6%96%B9%E5%8A%A8%E6%80%81%E5%BE%BD%E7%AB%A0%E8%AE%BF%E9%97%AE%E3%80%82

支持信息

• 容器运行时的Shell访问：docker exec -it bookstack /bin/bash
• 实时监控容器日志：docker logs -f bookstack
• 容器版本号：docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack
• 镜像版本号：docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/bookstack

更新信息

我们的大多数镜像是静态的、版本化的，需要更新镜像并重新创建容器才能更新内部应用。除某些例外（如nextcloud、plex），我们不建议或支持在容器内更新应用。请参考上方的应用设置部分，查看是否推荐对此镜像进行应用更新。

以下是更新容器的说明：

通过Docker Run/Create

• 更新镜像：docker pull linuxserver/bookstack
• 停止运行中的容器：docker stop bookstack
• 删除容器：docker rm bookstack
• 使用上述相同的docker create参数重新创建新容器（如果正确映射到主机文件夹，您的/config文件夹和设置将被保留）
• 启动新容器：docker start bookstack
• 也可删除旧的悬空镜像：docker image prune

通过Docker Compose

• 更新所有镜像：docker-compose pull
  • 或更新单个镜像：docker-compose pull bookstack
• 让compose根据需要更新所有容器：docker-compose up -d
  • 或更新单个容器：docker-compose up -d bookstack
• 也可删除旧的悬空镜像：docker image prune

通过Watchtower自动更新器（特别适用于忘记原始参数的情况）

• 拉取最新标签镜像并使用相同的环境变量运行：

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

注意： 我们不认可将Watchtower用作现有Docker容器自动更新的解决方案。事实上，我们通常不鼓励自动更新。但是，对于忘记原始参数的容器，这是一个有用的一次性手动更新工具。长期来看，我们强烈建议使用Docker Compose。

• 也可删除旧的悬空镜像：docker image prune

本地构建

如果您想对这些镜像进行本地修改以用于开发目的或自定义逻辑：

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

可以使用multiarch/qemu-user-static在x86_64硬件上构建ARM变体：

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

注册后，您可以使用-f Dockerfile.aarch64指定要使用的dockerfile。

版本历史

• 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： 初始发布。