Files
hubproxy/README.md
2026-07-13 06:42:37 +08:00

84 lines
3.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# HubProxy
**Docker 与 GitHub 加速代理服务器**
轻量级、高性能的多功能代理服务,单二进制部署,完全自托管。
## 特性
- 🐳 **Docker 镜像加速** — 兼容 Registry API v2支持 Docker Hub、GHCR、Quay、GCR、registry.k8s.io流式传输Manifest / Token 缓存
- 📦 **离线镜像包** — 无需本地 Docker在线打包单镜像或批量 tar流式下载 + 防抖设计
- 📁 **GitHub 文件加速** — Release、Raw、Git Clone、`api.github.com``.sh` / `.ps1` 脚本内 URL 自动改写
- 🤖 **Hugging Face 加速** — 模型文件与 LFS 大文件下载
- 🔍 **镜像搜索** — Web 界面与 API 搜索 Docker Hub 镜像、浏览标签
- 🛡️ **智能限流** — 按真实客户端 IP 令牌桶限流IPv6 按 `/64`);可配置周期与配额
- 🚫 **仓库访问控制** — IP 黑白名单(限流豁免 / 封禁)+ 镜像 / GitHub 仓库黑白名单,支持通配符
- 🌐 **上游 SOCKS5 代理** — 可选配置出站代理,适配特殊网络环境
- 🖥️ **Web 界面** — 内置 Vue SPA镜像搜索、离线包下载、标签浏览
-**轻量高效** — Go 单二进制,支持 `deb` / `rpm` / `apk` 与 Docker 多架构镜像
- 🔧 **统一配置**`config.toml` + 环境变量覆盖,开箱即用
- 🚀 **多服务统一加速** — 单个程序覆盖 Docker、GitHub、Hugging Face简化部署
- ☁️ **完全自托管** — 不依赖第三方免费 CDN 代理,数据与带宽自主可控
## 快速开始
### Docker 部署(推荐)
```bash
docker run -d \
--name hubproxy \
-p 5000:5000 \
--restart always \
ghcr.io/sky22333/hubproxy
```
验证服务:
```bash
curl http://127.0.0.1:5000/ready
```
### 脚本安装
自动识别 `amd64` / `arm64``apt``dnf``apk` 等包管理器:
```bash
curl -fsSL https://raw.githubusercontent.com/sky22333/hubproxy/main/install.sh | sh
```
安装后配置文件位于 `/etc/hubproxy/config.toml`,服务自动启动。
### 快速上手
```bash
# Docker 镜像加速(将 yourdomain.com 换成你的 HubProxy 地址)
docker pull yourdomain.com/library/nginx:latest
# GitHub Release 加速(完整 URL 前缀)
curl -L -O "https://yourdomain.com/https://github.com/owner/repo/releases/download/v1.0.0/app.tar.gz"
```
> **生产环境建议**:绑定自有域名,通过 Caddy / Nginx 反代并开启 HTTPS不要长期暴露裸 `http://IP:5000`。详见 [文档](https://sky22333.github.io/hubproxy/getting-started/quick-start/)。
## 文档
部署架构、完整配置、K8s / NAS、传输特性与 FAQ 见官方文档站(中英双语):
- [中文文档](https://sky22333.github.io/hubproxy/)
- [English](https://sky22333.github.io/hubproxy/en/)
## 界面预览
![demo](.github/demo/demo.png)
## 免责声明
- 本程序仅供学习交流使用,请勿用于非法用途
- 使用本程序需遵守当地法律法规
- 作者不对使用者的任何行为承担责任
---
**如果这个项目对你有帮助,请给个 Star ⭐**