jieay/bookstack

BookStack 私有笔记服务镜像

镜像概述

本镜像基于开源工具BookStack构建，提供自建私有笔记服务，用于创建、组织和管理个人或团队知识库。BookStack采用直观的"书架-章节-页面"结构，支持富文本编辑、版本控制和权限管理，适用于构建结构化的文档系统。

核心功能与特性

• 结构化文档管理：采用书架、章节、页面三级结构，清晰组织内容
• 富文本编辑：支持格式化文本、图片插入、代码块、表格等编辑功能
• 权限控制：可针对不同用户/角色设置文档访问权限
• 全文搜索：快速检索知识库中的内容
• 数据持久化：通过卷挂载确保数据不会因容器重启丢失
• 简单部署：提供完整的Docker Compose配置，简化部署流程

使用场景

• 个人知识管理系统
• 团队内部文档协作平台
• 项目文档与手册管理
• 技术笔记与教程库
• 企业内部知识库

使用方法

前置要求

• 已安装Docker和Docker Compose
• 具备基本的Docker命令操作能力

部署步骤

1. 创建docker-compose配置文件

创建bookstack.yml文件，内容如下：

yaml
version: '2'
services:
  mysql:
    image: jieay/mysql:8.3
    environment:
    - MYSQL_ROOT_PASSWORD=M!2E3OTViOWFmZGRkYjkxMjEyYWNhMDA5  # MySQL root用户密码
    - MYSQL_DATABASE=bookstack  # 数据库名称
    - MYSQL_USER=bookstack  # 应用数据库用户
    - MYSQL_PASSWORD=M!2E3OTViOWFmZGRkYjkxMjEyYWNhMDA5  # 应用数据库密码
    volumes:
    - /<pwd>/bookstack/mysql:/var/lib/mysql  # 替换<pwd>为实际路径，持久化MySQL数据

  bookstack:
    image: jieay/bookstack:24.2.3-1
    depends_on:
    - mysql  # 依赖MySQL服务
    environment:
    - DB_HOST=mysql:3306  # 数据库连接地址
    - DB_DATABASE=bookstack  # 数据库名称，需与MySQL配置一致
    - DB_USERNAME=bookstack  # 数据库用户名，需与MySQL配置一致
    - DB_PASSWORD=M!2E3OTViOWFmZGRkYjkxMjEyYWNhMDA5  # 数据库密码，需与MySQL配置一致
    - APP_URL=http://127.0.0.1:7866  # 应用访问URL，不含末尾斜杠
    - APP_KEY=SomeRandomStringWith32Characters  # 32位随机字符串，用于加密
    volumes:
    - /<pwd>/bookstack/uploads:/var/www/bookstack/public/uploads  # 上传文件存储路径
    - /<pwd>/bookstack/storage:/var/www/bookstack/storage/uploads  # 应用存储路径
    ports:
    - "7866:8080"  # 端口映射，宿主端口:容器端口

2. 配置说明

环境变量说明：

卷挂载说明：

• /<pwd>/bookstack/mysql：MySQL数据持久化路径，替换<pwd>为实际目录
• /<pwd>/bookstack/uploads：用户上传文件存储路径
• /<pwd>/bookstack/storage：应用存储文件路径

3. 启动服务

在bookstack.yml文件所在目录执行以下命令启动服务：

bash
docker compose -f bookstack.yml up -d

4. 访问服务

服务启动后，通过配置的APP_URL访问BookStack，默认端口为7866（如示例配置）。初始登录账号：

• 用户名：***
• 密码：password

首次登录后建议立即修改密码。

注意事项

• 生产环境中需替换默认密码和APP_KEY，确保安全性
• 调整APP_URL为实际访问地址，如对外提供服务需使用域名或公网IP
• 定期备份挂载的卷目录，防止数据丢失
• 根据实际需求调整端口映射（宿主端口可修改为其他未占用端口）