|
| 1 | +# 🚀 Docker Hub 发布快速开始指南 |
| 2 | + |
| 3 | +本指南将帮助你在 5 分钟内完成 GC-QA-RAG 项目到 Docker Hub 的发布。 |
| 4 | + |
| 5 | +## 📋 前置检查清单 |
| 6 | + |
| 7 | +- [ ] 已注册 Docker Hub 账户 |
| 8 | +- [ ] 已安装 Docker Desktop |
| 9 | +- [ ] 已登录 Docker Hub (`docker login`) |
| 10 | +- [ ] 已获取 GitHub 仓库的写入权限 |
| 11 | + |
| 12 | +## ⚡ 5 分钟快速发布 |
| 13 | + |
| 14 | +### 1. 配置 GitHub Secrets(仅首次需要) |
| 15 | + |
| 16 | +在 GitHub 仓库设置中添加以下 Secrets: |
| 17 | + |
| 18 | +1. 进入 `Settings` → `Secrets and variables` → `Actions` |
| 19 | +2. 添加以下 Secrets: |
| 20 | + - `DOCKERHUB_LOGIN_USERNAME`: 你的 Docker Hub 登录用户名 |
| 21 | + - `DOCKERHUB_USERNAME`: 你的 Docker Hub 用户名 |
| 22 | + - `DOCKERHUB_TOKEN`: 你的 Docker Hub 访问令牌 |
| 23 | + |
| 24 | +### 2. 发布方式选择 |
| 25 | + |
| 26 | +#### 🎯 方式一:GitHub Actions 自动发布(推荐) |
| 27 | + |
| 28 | +```bash |
| 29 | +# 1. 创建版本标签 |
| 30 | +git tag v1.0.0 |
| 31 | + |
| 32 | +# 2. 推送标签到 GitHub |
| 33 | +git push origin v1.0.0 |
| 34 | +``` |
| 35 | + |
| 36 | +推送标签后,GitHub Actions 会自动: |
| 37 | + |
| 38 | +- 构建所有 Docker 镜像 |
| 39 | +- 推送到 Docker Hub |
| 40 | +- 创建 GitHub Release |
| 41 | + |
| 42 | +#### 🎯 方式二:手动发布 |
| 43 | + |
| 44 | +**Windows 用户:** |
| 45 | + |
| 46 | +```powershell |
| 47 | +# 1. 修改脚本中的用户名 |
| 48 | +# 编辑 scripts/publish-dockerhub.ps1,将 your-dockerhub-username 替换为你的用户名 |
| 49 | +
|
| 50 | +# 2. 执行发布脚本 |
| 51 | +.\scripts\publish-dockerhub.ps1 v1.0.0 |
| 52 | +``` |
| 53 | + |
| 54 | +**Linux/Mac 用户:** |
| 55 | + |
| 56 | +```bash |
| 57 | +# 1. 修改脚本中的用户名 |
| 58 | +# 编辑 scripts/publish-dockerhub.sh,将 your-dockerhub-username 替换为你的用户名 |
| 59 | + |
| 60 | +# 2. 添加执行权限 |
| 61 | +chmod +x scripts/publish-dockerhub.sh |
| 62 | + |
| 63 | +# 3. 执行发布脚本 |
| 64 | +./scripts/publish-dockerhub.sh v1.0.0 |
| 65 | +``` |
| 66 | + |
| 67 | +## ✅ 验证发布结果 |
| 68 | + |
| 69 | +### 1. 检查 Docker Hub 仓库 |
| 70 | + |
| 71 | +访问:`https://hub.docker.com/r/你的用户名` |
| 72 | + |
| 73 | +你应该能看到以下镜像: |
| 74 | + |
| 75 | +- `gc-qa-rag-server:latest` |
| 76 | +- `gc-qa-rag-server:v1.0.0` |
| 77 | +- `gc-qa-rag-etl:latest` |
| 78 | +- `gc-qa-rag-etl:v1.0.0` |
| 79 | +- `gc-qa-rag-frontend:latest` |
| 80 | +- `gc-qa-rag-frontend:v1.0.0` |
| 81 | + |
| 82 | +### 2. 测试镜像拉取 |
| 83 | + |
| 84 | +```bash |
| 85 | +docker pull 你的用户名/gc-qa-rag-server:latest |
| 86 | +docker pull 你的用户名/gc-qa-rag-etl:latest |
| 87 | +docker pull 你的用户名/gc-qa-rag-frontend:latest |
| 88 | +``` |
| 89 | + |
| 90 | +## 🔗 使用发布的镜像 |
| 91 | + |
| 92 | +### 1. 更新 docker-compose 文件 |
| 93 | + |
| 94 | +编辑 `sources/gc-qa-rag-server/deploy/docker-compose.dockerhub.yml`: |
| 95 | + |
| 96 | +```yaml |
| 97 | +server: |
| 98 | + image: 你的用户名/gc-qa-rag-server:latest |
| 99 | +frontend: |
| 100 | + image: 你的用户名/gc-qa-rag-frontend:latest |
| 101 | +``` |
| 102 | +
|
| 103 | +编辑 `sources/gc-qa-rag-etl/docker-compose.dockerhub.yml`: |
| 104 | + |
| 105 | +```yaml |
| 106 | +rag-etl: |
| 107 | + image: 你的用户名/gc-qa-rag-etl:latest |
| 108 | +``` |
| 109 | + |
| 110 | +### 2. 一键部署 |
| 111 | + |
| 112 | +```bash |
| 113 | +# 部署主服务 |
| 114 | +cd sources/gc-qa-rag-server/deploy |
| 115 | +docker compose -f docker-compose.dockerhub.yml up -d |
| 116 | +
|
| 117 | +# 部署 ETL 管理后台 |
| 118 | +cd ../../gc-qa-rag-etl |
| 119 | +docker compose -f docker-compose.dockerhub.yml up -d |
| 120 | +``` |
| 121 | + |
| 122 | +## 📝 版本管理最佳实践 |
| 123 | + |
| 124 | +### 1. 语义化版本号 |
| 125 | + |
| 126 | +- `v1.0.0`: 主版本.次版本.修订版本 |
| 127 | +- `v1.1.0`: 新功能发布 |
| 128 | +- `v1.0.1`: Bug 修复 |
| 129 | + |
| 130 | +### 2. 发布流程 |
| 131 | + |
| 132 | +```bash |
| 133 | +# 1. 更新代码并提交 |
| 134 | +git add . |
| 135 | +git commit -m "feat: 新功能" |
| 136 | +git push origin main |
| 137 | +
|
| 138 | +# 2. 创建版本标签 |
| 139 | +git tag v1.1.0 |
| 140 | +git push origin v1.1.0 |
| 141 | +
|
| 142 | +# 3. GitHub Actions 自动发布 |
| 143 | +# 等待几分钟,镜像会自动发布到 Docker Hub |
| 144 | +``` |
| 145 | + |
| 146 | +## 🆘 常见问题 |
| 147 | + |
| 148 | +### Q: 推送失败,提示权限不足 |
| 149 | + |
| 150 | +A: 检查 Docker Hub 登录状态和用户名是否正确 |
| 151 | + |
| 152 | +### Q: GitHub Actions 失败 |
| 153 | + |
| 154 | +A: 检查 GitHub Secrets 是否配置正确 |
| 155 | + |
| 156 | +### Q: 如何删除已发布的镜像 |
| 157 | + |
| 158 | +A: 在 Docker Hub 网页界面删除,或使用 Docker Hub API |
| 159 | + |
| 160 | +### Q: 如何更新 latest 标签 |
| 161 | + |
| 162 | +A: 重新发布相同版本或新版本即可 |
| 163 | + |
| 164 | +## 📚 详细文档 |
| 165 | + |
| 166 | +- [完整发布指南](./docs/zh/4-发布指南/Docker-Hub发布指南.md) |
| 167 | +- [Docker Hub 官方文档](https://docs.docker.com/docker-hub/) |
| 168 | +- [GitHub Actions 文档](https://docs.github.com/en/actions) |
| 169 | + |
| 170 | +## 🎉 恭喜! |
| 171 | + |
| 172 | +你已经成功将 GC-QA-RAG 发布到 Docker Hub!现在其他用户可以通过以下方式快速部署你的项目: |
| 173 | + |
| 174 | +```bash |
| 175 | +# 克隆项目 |
| 176 | +git clone https://github.com/GrapeCity-AI/gc-qa-rag.git |
| 177 | +cd gc-qa-rag |
| 178 | +
|
| 179 | +# 配置 API 密钥 |
| 180 | +# 编辑配置文件... |
| 181 | +
|
| 182 | +# 使用你的镜像部署主服务 |
| 183 | +cd sources/gc-qa-rag-server/deploy |
| 184 | +docker compose -f docker-compose.dockerhub.yml up -d |
| 185 | +
|
| 186 | +# 使用你的镜像部署 ETL 管理后台 |
| 187 | +cd ../../gc-qa-rag-etl |
| 188 | +docker compose -f docker-compose.dockerhub.yml up -d |
| 189 | +``` |
0 commit comments