BookStack Docker 镜像使用教程

1. 项目的目录结构及介绍

BookStack 是一个开源的 Wiki 系统，由 LinuxServer.io 维护的 Docker 镜像提供了一个便捷的部署方式。以下是该项目的目录结构及介绍：

docker-bookstack/
├── Dockerfile
├── docker-compose.yml
├── README.md
└── config/
    ├── nginx/
    │   └── default.conf
    └── bookstack/
        ├── .env
        └── custom_html/

• Dockerfile: 用于构建 Docker 镜像的文件。
• docker-compose.yml: 用于定义和运行多容器 Docker 应用程序的文件。
• README.md: 项目说明文档。
• config/: 配置文件目录。
  • nginx/: Nginx 配置文件目录。
    • default.conf: Nginx 默认配置文件。
  • bookstack/: BookStack 配置文件目录。
    • .env: BookStack 环境配置文件。
    • custom_html/: 自定义 HTML 文件目录。

2. 项目的启动文件介绍

BookStack 项目的启动主要依赖于 docker-compose.yml 文件。以下是该文件的主要内容及介绍：

version: '3.8'
services:
  bookstack:
    image: lscr.io/linuxserver/bookstack:latest
    container_name: bookstack
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - APP_URL=http://example.com
      - DB_HOST=bookstack_db
      - DB_PORT=3306
      - DB_USER=bookstack
      - DB_PASS=<yourdbpass>
      - DB_DATABASE=bookstackapp
    volumes:
      - /path/to/bookstack_app_data:/config
    ports:
      - 6875:80
    restart: unless-stopped
    depends_on:
      - bookstack_db

  bookstack_db:
    image: lscr.io/linuxserver/mariadb:latest
    container_name: bookstack_db
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - MYSQL_ROOT_PASSWORD=<yourdbpass>
      - MYSQL_DATABASE=bookstackapp
      - MYSQL_USER=bookstack
      - MYSQL_PASSWORD=<yourdbpass>
    volumes:
      - /path/to/bookstack_db_data:/config
    restart: unless-stopped

• bookstack: BookStack 服务配置。

  • image: 使用的 Docker 镜像。
  • container_name: 容器名称。
  • environment: 环境变量配置。
  • volumes: 数据卷配置。
  • ports: 端口映射配置。
  • restart: 重启策略。
  • depends_on: 依赖服务配置。

• bookstack_db: 数据库服务配置。

  • image: 使用的 Docker 镜像。
  • container_name: 容器名称。
  • environment: 环境变量配置。
  • volumes: 数据卷配置。
  • restart: 重启策略。

3. 项目的配置文件介绍

BookStack 项目的配置文件主要位于 config/ 目录下。以下是主要配置文件的介绍：

config/nginx/default.conf

该文件是 Nginx 的默认配置文件，用于配置 Web 服务器的相关设置。

server {
    listen 80;
    server_name example.com;

    location / {
        proxy_pass http://bookstack:8080;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

config/bookstack/.env

该文件是 BookStack 的环境配置文件，用于设置应用程序的各种环境变量。