feat: update README and remove Docker setup documentation; reorganize testing guides and add new sections for data directory and GitHub Actions CI/CD

This commit is contained in:
isboyjc
2026-03-29 04:32:35 +08:00
parent 9a4f08a5e7
commit d97ecbc8db
5 changed files with 264 additions and 420 deletions

View File

@@ -64,10 +64,11 @@ GoProxy 从多个公开代理源自动抓取 HTTP/SOCKS5 代理,通过严格
### 📝 扩展文档
- [Docker 镜像发布配置](.github/DOCKER_SETUP.md) - GitHub Actions CI/CD 设置
- [地理过滤配置指南](GEO_FILTER.md) - 国家代码、使用场景、测试方法
- [认证功能测试](test/AUTH_TEST.md) - 代理认证测试和多语言客户端示例
- [基础功能测试](test/TEST_GUIDE.md) - 测试脚本使用指南
- [数据目录说明](DATA_DIRECTORY.md) - 数据库、配置文件、备份恢复
- [代理认证测试](test/AUTH_TEST.md) - 代理认证测试和多语言客户端示例
- [测试脚本使用](test/README.md) - Bash/Go/Python 测试脚本详细说明
- [架构设计文档](POOL_DESIGN.md) - 完整的系统设计和实现细节
## 📦 项目结构
@@ -91,15 +92,17 @@ GoProxy 从多个公开代理源自动抓取 HTTP/SOCKS5 代理,通过严格
│ ├── test_proxy.sh # Bash 测试脚本
│ ├── test_proxy.go # Go 测试脚本
│ ├── test_proxy.py # Python 测试脚本
│ ├── TEST_GUIDE.md # 基础功能测试指南
│ └── AUTH_TEST.md # 🆕 认证功能测试指南
├── .github/ # 🆕 GitHub Actions CI/CD
── workflows/docker-image.yml # 自动构建多架构镜像
│ └── DOCKER_SETUP.md # Docker 镜像发布配置指南
│ ├── README.md # 测试脚本使用说明
│ └── AUTH_TEST.md # 认证功能测试指南
├── .github/workflows/
── docker-image.yml # 🆕 GitHub Actions 自动构建(多平台镜像
├── .env.example # 🆕 环境变量配置模板
├── docker-compose.yml # 🆕 Docker Compose 配置(自动更新镜像)
├── Dockerfile # Docker 构建文件
├── data/ # 🆕 数据目录SQLite 数据库、配置文件)
│ └── .gitkeep # 目录占位符和说明
├── GEO_FILTER.md # 🆕 地理过滤配置指南
├── DATA_DIRECTORY.md # 🆕 数据目录说明文档
├── POOL_DESIGN.md # 完整架构设计文档
└── README.md # 本文件
```
@@ -223,8 +226,25 @@ export https_proxy=http://proxy:your_password@192.168.1.100:7777
## 🐳 Docker 部署
> 💡 **自动构建**GitHub Actions 自动构建多架构镜像(amd64/arm64支持 Docker Hub 和 GHCR 双仓库推送。
> 详细配置说明请查看 [`.github/DOCKER_SETUP.md`](.github/DOCKER_SETUP.md)
> 💡 **自动构建**GitHub Actions 自动构建多架构镜像(linux/amd64、linux/arm64默认推送到 GHCR可选推送到 Docker Hub
> 💾 **数据持久化**:必须挂载 `data/` 目录以保存代理池数据和配置,详见 [`DATA_DIRECTORY.md`](DATA_DIRECTORY.md)
### 🔄 GitHub Actions 自动构建
项目配置了自动化 CI/CD 流程:
**触发条件**
- 推送到 `main` 分支 → 构建 `latest` 标签
- 推送版本标签(如 `v1.0.0`)→ 构建多个版本标签(`1.0.0`, `1.0`, `1`, `latest`
- 手动触发workflow_dispatch
**镜像仓库**
- **GHCR**(默认):`ghcr.io/isboyjc/goproxy` - 零配置,自动推送
- **Docker Hub**(可选):`docker.io/isboyjc/goproxy` - 需配置 secrets
- `DOCKERHUB_USERNAME` - Docker Hub 用户名
- `DOCKERHUB_TOKEN` - Docker Hub Access Token
**工作流程文件**[`.github/workflows/docker-image.yml`](.github/workflows/docker-image.yml)
### 快速启动(推荐)
@@ -951,7 +971,7 @@ curl -x http://127.0.0.1:7777 https://httpbin.org/ip
```
**更多测试指南**
- 基础功能测试:[`test/TEST_GUIDE.md`](./test/TEST_GUIDE.md)
- 基础功能测试:[`test/README.md`](./test/README.md)
- 认证功能测试:[`test/AUTH_TEST.md`](./test/AUTH_TEST.md)
## 🙏 致谢与声明