一、安装前准备

1. 安装 Docker 环境

  • CentOS 系统安装命令：
    yum install docker-ce docker-ce-cli containerd.io 
systemctl start docker && systemctl enable docker
  • 其他系统参考的 Docker 安装教程

2. 配置镜像加速（可选）

  • 国内用户建议使用阿里云镜像：
    docker pull /star7th/showdoc 
docker tag [镜像ID] star7th/showdoc

二、部署 ShowDoc 容器

docker run -d --name showdoc \
  --user=root --privileged=true \
  -p 4999:80 \
  -v /showdoc_data/html:/var/www/html/ \
  star7th/showdoc

参数说明：

  • -p 4999:80：将容器 80 端口映射到宿主机 4999 端口
  • -v /showdoc_data/html：数据持久化存储路径
  • --privileged=true：解决文件权限问题

三、初始化配置

  1. 访问 http://服务器 IP:4999/install
  2. 完成数据库初始化（自动创建 SQLite 数据库）
  3. 初始账号：showdoc/123456，建议首次登录后修改

四、数据管理

1. 重要文件路径：

  • 数据库文件：/showdoc_data/html/Sqlite/showdoc.db.php
  • 附件目录：/showdoc_data/html/Public/Uploads

2. 备份建议：定期备份整个/showdoc_data目录

五、常用操作

1. 容器管理：

docker stop showdoc  # 停止 
docker start showdoc  # 启动 
docker restart showdoc  # 重启

2. 版本升级：

docker pull star7th/showdoc 
docker stop showdoc && docker rm showdoc 
# 重新执行部署命令（数据卷会自动保留）

六、进阶使用

1. 自定义配置：

  • 挂载配置文件：
    -v /path/to/showdoc-config.json:/var/www/html/config/showdoc-config.json
  • 自定义存储路径（如挂载到 /data1）：
    ln -s /data1/showdoc_data /showdoc_data

2. 团队协作功能：

  • 创建私密项目并设置访问密码
  • 通过「团队管理」添加协作成员
  • 使用 Markdown 模板快速创建 API 文档

七、常见问题

1. 访问失败检查：

  • 确认防火墙/安全组开放 4999 端口
  • 查看容器日志：docker logs showdoc

2. 数据恢复：

  • 停止容器后替换/showdoc_data 目录内容
  • 重启容器即可恢复数据

3. 客户端支持：

  • 提供网页版/桌面客户端/手机 APP
  • 客户端下载地址：https://www.showdoc.com.cn/clients