mirror of https://github.com/WJQSERVER-STUDIO/ghproxy.git synced 2026-02-03 00:01:10 +08:00

基于Go的高性能,多功能,可扩展的Github代理加速项目 https://ghproxy.1888866.xyz

Find a file

WJQSERVER df05c6a275 24w07a		2024-10-02 21:25:28 +08:00
.github	Bump Go to v1.23.2	2024-10-02 21:17:00 +08:00
auth	24w06b	2024-09-27 15:45:43 +08:00
caddyfile	24w06b	2024-09-27 15:05:49 +08:00
config	24w06b	2024-09-27 14:30:37 +08:00
docker	fix	2024-09-24 17:41:06 +08:00
logger	24w06b	2024-09-27 14:02:21 +08:00
pages	update	2024-09-24 17:16:21 +08:00
proxy	24w06b	2024-09-27 15:27:53 +08:00
CHANGELOG.md	24w07a	2024-10-02 21:25:28 +08:00
DEV-VERSION	24w07a	2024-10-02 21:25:28 +08:00
go.mod	Bump Go to v1.23.2	2024-10-02 21:17:00 +08:00
go.sum	update	2024-09-24 17:16:21 +08:00
init.sh	fix	2024-09-24 18:23:58 +08:00
LICENSE	update	2024-09-24 17:16:21 +08:00
main.go	24w07a	2024-10-02 21:25:28 +08:00
README.md	Update README.md	2024-09-29 08:46:32 +08:00
SECURITY.MD	24w06b	2024-09-27 15:45:43 +08:00
VERSION	v1.1.0	2024-09-27 15:54:03 +08:00

README.md

GhProxy

使用Go实现的GHProxy,用于加速部分地区Github仓库的拉取,支持速率限制,用户鉴权,支持Docker部署

项目说明

项目特点

基于Go语言实现,使用Gin框架与req库]
支持Git clone,raw,realeases等文件拉取
支持Docker部署
支持速率限制
支持用户鉴权
符合RFC 7234的HTTP Cache
使用Caddy作为Web Server
基于WJQSERVER-STUDIO/golang-temp模板构建,具有标准化的日志记录与构建流程

项目开发过程

本项目是WJQSERVER-STUDIO/ghproxy-go的重构版本,实现了原项目原定功能的同时,进一步优化了性能 本项目源于WJQSERVER-STUDIO/ghproxy-go与WJQSERVER/ghproxy-go-0RTT两个项目,前者带来了实现框架与资源,后者带来了解决Git clone问题的办法,使得本项目从net/http标准库切换至Gin框架,已解决此困扰已久的问题,在此基础上,本项目进一步优化了性能,并添加了用户鉴权功能,使得部署更加安全可靠。关于此项目的详细开发过程,请参看Commit记录与CHANGELOG.md

V1.0.0 迁移至本仓库,并再次重构内容实现
v0.2.0 重构项目实现,Git clone的实现完全自主化

LICENSE

本项目使用WSL LICENSE Version1.2 (WJQSERVER STUDIO LICENSE Version1.2)

在v1.0.0版本之前,本项目继承于WJQSERVER-STUDIO/ghproxy-go的APACHE2.0 LICENSE VERSION

使用示例

https://ghproxy.1888866.xyz/raw.githubusercontent.com/WJQSERVER-STUDIO/tools-stable/main/tools-stable-ghproxy.sh

git clone https://ghproxy.1888866.xyz/github.com/WJQSERVER-STUDIO/ghproxy.git

部署说明

Docker部署

Docker-cli

docker run -p 7210:80 -v ./ghproxy/log/run:/data/ghproxy/log -v ./ghproxy/log/caddy:/data/caddy/log --restart always wjqserver/ghproxy

Docker-Compose

参看docker-compose.yml

外部配置文件

本项目采用config.yaml作为外部配置,默认配置如下使用Docker部署时,慎重修改config.yaml,以免造成不必要的麻烦

port: 8080  # 监听端口
host: "127.0.0.1"  # 监听地址
sizelimit: 131072000 # 125MB
logfilepath: "/data/ghproxy/log/ghproxy.log"  # 日志文件路径
CorsAllowOrigins: true  # 是否允许跨域请求
auth: true  # 是否开启鉴权
authtoken: "test"  # 鉴权token

Caddy反代配置

example.com {
    reverse_proxy {
        to 127.0.0.1:7210
        header_up X-Real-IP {remote_host}	    
        header_up X-Real-IP {http.request.header.CF-Connecting-IP}
        header_up X-Forwarded-For {http.request.header.CF-Connecting-IP}
        header_up X-Forwarded-Proto {http.request.header.CF-Visitor}
    }
    encode zstd gzip    
}