Skip to content

Commit a596b96

Browse files
committed
更新 README
1 parent 76262db commit a596b96

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
这只是后端服务,前端页面需要自己完成并通过静态文件导入。
66

7+
本项目的目的是帮助你搭建自己的 github 代理,在第三方代理站不可用时可作为备用服务。
8+
9+
*其他代理服务*一起用效果更好。
10+
711
## 使用
812

913
你可以直接在 release 中下载对应的服务器架构的可执行二进制文件,下载后可重命名为`gp`
@@ -26,7 +30,7 @@ Flags:
2630
--port uint 本服务使用的端口 (default 3000)
2731
```
2832

29-
## 编译后端服务
33+
## 编译
3034

3135
如果 release 中没有你正在使用的平台或者你想使用最新的代码可自行编译本项目。
3236

@@ -52,7 +56,7 @@ go build -ldflags="-s -w" -o gp main.go && upx -9 main
5256

5357
下载对应系统的最新 [release](https://github.com/upx/upx/releases/latest) ,放到 PATH 中即可。
5458

55-
### 配置前端页面
59+
## 配置前端页面
5660

5761
如果你不会自己写前端页面可使用我打包的页面,但里面有一张捐赠图片,你可以选择删除或替换。
5862

@@ -62,7 +66,7 @@ https://pan.baidu.com/s/14iEOGT9xSAR1EUXTpoO01g 提取码: xvme
6266

6367
将前端文件解压后放到任意目录(最好叫`static`)中。
6468

65-
### 测试运行
69+
## 测试运行
6670

6771
假如你将前端静态文件(是文件,不是目录)保存到了`~/static`目录中,想使用`localhost:8080`地址运行服务,在可执行文件所在的根目录中执行:
6872

@@ -74,7 +78,7 @@ https://pan.baidu.com/s/14iEOGT9xSAR1EUXTpoO01g 提取码: xvme
7478
7579
访问`http://localhost:8080`即可访问首页,输入某个 github 的文件链接即可测试下载功能。
7680

77-
### 部署
81+
## 部署
7882

7983
上线建议使用 caddy,可以基于 docker 容器,也可以直接安装在物理机中。
8084

0 commit comments

Comments
 (0)