mirror of https://github.com/isboyjc/GoProxy.git synced 2026-05-06 20:02:54 +08:00

Files

isboyjc a70df0d505 feat: ✨ add environment variable support for proxy authentication and geo-blocking

- Introduced `.env.example` for environment variable configuration.
- Updated `docker-compose.yml` to utilize environment variables for proxy settings.
- Implemented proxy authentication with Basic Auth and geo-blocking based on country codes.
- Added `GEO_FILTER.md` for documentation on geo-filtering configuration.
- Enhanced logging to indicate authentication status and blocked countries during proxy server startup.

2026-03-29 04:11:38 +08:00

3.9 KiB

Raw Blame History

GitHub Actions Docker 镜像自动构建配置

本项目使用 GitHub Actions 自动构建并推送 Docker 镜像到多个镜像仓库。

📦 自动构建触发条件

Push to main 分支：自动构建 latest 标签
推送版本标签（如 v1.0.0）：自动构建版本标签（1.0.0, 1.0, 1, latest）
手动触发：在 GitHub Actions 页面手动运行

🔧 配置 GitHub Secrets

1. Docker Hub 配置（可选）

如果要推送到 Docker Hub，需要配置以下 Secrets：

登录 Docker Hub
在 Account Settings > Security 创建 Access Token
在 GitHub 仓库的 Settings > Secrets and variables > Actions 添加：
- DOCKERHUB_USERNAME: 你的 Docker Hub 用户名
- DOCKERHUB_TOKEN: 刚才创建的 Access Token

2. GitHub Container Registry（默认已配置）

GitHub Container Registry (ghcr.io) 无需额外配置，workflow 使用自动提供的 GITHUB_TOKEN。

镜像地址：ghcr.io/isboyjc/goproxy

🏗️ 构建特性

✅ 多架构支持：linux/amd64、linux/arm64
✅ 多标签发布：latest、版本号（如 1.0.0、1.0、1）
✅ 双仓库推送：Docker Hub + GitHub Container Registry
✅ 构建缓存：使用 GitHub Actions 缓存加速构建

📋 使用镜像

从 Docker Hub 拉取

docker pull isboyjc/goproxy:latest
docker run -d \
  --name proxygo \
  -p 127.0.0.1:7776:7776 \
  -p 127.0.0.1:7777:7777 \
  -p 7778:7778 \
  -e WEBUI_PASSWORD=your_password \
  -v "$(pwd)/data:/app/data" \
  isboyjc/goproxy:latest

从 GitHub Container Registry 拉取

docker pull ghcr.io/isboyjc/goproxy:latest
docker run -d \
  --name proxygo \
  -p 127.0.0.1:7776:7776 \
  -p 127.0.0.1:7777:7777 \
  -p 7778:7778 \
  -e WEBUI_PASSWORD=your_password \
  -v "$(pwd)/data:/app/data" \
  ghcr.io/isboyjc/goproxy:latest

使用特定版本

# 使用特定版本号
docker pull ghcr.io/isboyjc/goproxy:1.0.0

# 使用主版本号（自动获取最新的 1.x.x）
docker pull ghcr.io/isboyjc/goproxy:1

🚀 发布新版本

创建并推送版本标签即可触发自动构建：

# 创建版本标签
git tag -a v1.0.0 -m "Release version 1.0.0"

# 推送标签到 GitHub
git push origin v1.0.0

GitHub Actions 会自动：

构建多架构镜像
推送到 Docker Hub 和 GHCR
创建多个标签（1.0.0, 1.0, 1, latest）

🌐 端口绑定说明

默认示例使用 127.0.0.1:7776 和 127.0.0.1:7777（仅本地访问）：

场景：在部署机器上本地使用代理
安全：最安全，代理服务不对外暴露
限制：其他机器无法使用该代理

如需对外开放代理服务（局域网/VPS 多机共享），修改端口绑定：

docker run -d \
  --name proxygo \
  -p 7776:7776 \      # ⚠️ 改为对外开放（无认证）
  -p 7777:7777 \      # ⚠️ 改为对外开放（无认证）
  -p 7778:7778 \
  -e WEBUI_PASSWORD=strong_password \
  -v "$(pwd)/data:/app/data" \
  ghcr.io/isboyjc/goproxy:latest

⚠️ 安全警告：

代理服务本身无认证机制，对外开放后任何人都可使用
建议配合防火墙白名单或云安全组限制访问 IP
WebUI 有登录认证，可以安全对外开放

更多部署场景说明，请查看 README - 部署场景配置

📝 注意事项

权限配置：首次推送到 GHCR 可能需要在仓库 Settings > Actions > General 中设置 Workflow permissions 为 Read and write permissions
GHCR 可见性：默认镜像为私有，可在 Packages 页面修改为公开
Docker Hub 可选：如果不需要推送到 Docker Hub，可在 workflow 文件中删除相关配置，或不配置 DOCKERHUB_* secrets（workflow 会跳过 Docker Hub 登录失败的步骤）

3.9 KiB Raw Blame History Unescape Escape