armingli/bookstack

BookStack 镜像文档

镜像概述

本镜像基于CentOS 8构建，提供BookStack在线文档管理系统的部署环境。BookStack是一款基于MinDoc框架、采用Beego开发的文档管理工具，功能上与Gitbook、看云等平台类似，适用于个人或团队构建结构化的知识库和文档协作平台。

核心功能与特性

• 文档管理：支持文档的创建、编辑、分类、版本控制和搜索
• 结构化呈现：提供树形目录结构，清晰组织文档层级关系
• 协作功能：支持多用户协作编辑，权限管理灵活
• 界面友好：提供简洁直观的Web界面，操作便捷
• 兼容性：基于CentOS 8稳定环境构建，运行可靠

使用场景

• 个人知识库搭建
• 团队内部技术文档协作
• 产品手册或帮助文档管理
• 项目文档集中存储与共享

使用方法

基本部署（docker run）

bash
docker run -d \
  --name bookstack \
  -p 80:80 \
  -v /path/to/data:/app/data \
  docker.xuanyuan.run/bookstack-image:latest

说明：-p参数指定端口映射（主机端口:容器端口），-v参数挂载数据卷以持久化存储文档数据

环境变量配置

可通过环境变量自定义配置，常用参数包括：

• DB_HOST：数据库主机地址（默认：localhost）
• DB_PORT：数据库端口（默认：3306）
• DB_USER：数据库用户名（默认：root）
• DB_PASSWORD：数据库密码（必填）
• DB_NAME：数据库名称（默认：bookstack）

示例（带环境变量的部署）：

bash
docker run -d \
  --name bookstack \
  -p 80:80 \
  -v /path/to/data:/app/data \
  -e DB_HOST=mysql-host \
  -e DB_USER=bookstack \
  -e DB_PASSWORD=yourpassword \
  -e DB_NAME=bookstack_db \
  docker.xuanyuan.run/bookstack-image:latest

访问方式

部署完成后，通过浏览器访问 http://<主机IP或域名> 即可进入BookStack系统，默认管理员账号通常为 admin/admin（首次登录需修改密码）。

注意事项

• 数据卷挂载需确保主机目录权限正确，避免容器无写入权限
• 生产环境建议配置数据库外部化，使用独立的MySQL容器或数据库服务
• 定期备份挂载的数据卷，防止数据丢失