mirror of
https://github.com/stilleshan/dockerfiles.git
synced 2026-04-23 00:27:05 +08:00
Update README.md
This commit is contained in:
Stille
+5
-103
@@ -1,110 +1,12 @@
|
||||
# gh-proxy
|
||||
|
||||
## 简介
|
||||
|
||||
github release、archive以及项目文件的加速项目，支持clone，有Cloudflare Workers无服务器版本以及Python版本
|
||||
|
||||
## 演示
|
||||
|
||||
[https://gh.api.99988866.xyz/](https://gh.api.99988866.xyz/)
|
||||
|
||||
演示站为公共服务，如有大规模使用需求请自行部署，演示站有点不堪重负
|
||||
|
||||
|
||||
|
||||
当然也欢迎[捐赠](#捐赠)以支持作者
|
||||
|
||||
## python版本和cf worker版本差异
|
||||
|
||||
- python版本支持进行文件大小限制，超过设定返回原地址 [issue #8](https://github.com/hunshcn/gh-proxy/issues/8)
|
||||
GitHub [stilleshan/dockerfiles](https://github.com/stilleshan/dockerfiles)
|
||||
Docker [stilleshan/gh-proxy](https://hub.docker.com/r/stilleshan/gh-proxy)
|
||||
> *docker image support for X86 and ARM*
|
||||
|
||||
## 使用
|
||||
|
||||
直接在copy出来的url前加`https://gh.api.99988866.xyz/`即可
|
||||
|
||||
也可以直接访问，在input输入
|
||||
|
||||
***大量使用请自行部署，以上域名仅为演示使用。***
|
||||
|
||||
以下都是合法输入（仅示例，文件不存在）：
|
||||
|
||||
- 分支源码：https://github.com/hunshcn/project/archive/master.zip
|
||||
|
||||
- release源码：https://github.com/hunshcn/project/archive/v0.1.0.tar.gz
|
||||
|
||||
- release文件：https://github.com/hunshcn/project/releases/download/v0.1.0/example.zip
|
||||
|
||||
- 分支文件：https://github.com/hunshcn/project/blob/master/filename
|
||||
|
||||
- commit文件：https://github.com/hunshcn/project/blob/1111111111111111111111111111/filename
|
||||
|
||||
- gist：https://gist.githubusercontent.com/cielpy/351557e6e465c12986419ac5a4dd2568/raw/cmd.py
|
||||
|
||||
## cf worker版本部署
|
||||
|
||||
首页：https://workers.cloudflare.com
|
||||
|
||||
注册，登陆，`Start building`，取一个子域名，`Create a Worker`。
|
||||
|
||||
复制 [index.js](https://cdn.jsdelivr.net/hunshcn/gh-proxy@master/index.js) 到左侧代码框，`Save and deploy`。如果正常，右侧应显示首页。
|
||||
|
||||
`index.js`默认配置下clone走github.com.cnpmjs.org，项目文件会走jsDeliver，如需走worker，修改Config变量即可
|
||||
|
||||
`ASSET_URL`是静态资源的url（实际上就是现在显示出来的那个输入框单页面）
|
||||
|
||||
`PREFIX`是前缀，默认（根路径情况为"/"），如果自定义路由为example.com/gh/*，请将PREFIX改为 '/gh/'，注意，少一个杠都会错！
|
||||
|
||||
## Python版本部署
|
||||
|
||||
### Docker部署
|
||||
|
||||
```
|
||||
docker run -d --name="gh-proxy-py" \
|
||||
-p 0.0.0.0:80:80 \
|
||||
--restart=always \
|
||||
hunsh/gh-proxy-py:latest
|
||||
```
|
||||
|
||||
第一个80是你要暴露出去的端口
|
||||
|
||||
### 直接部署
|
||||
|
||||
安装依赖（请使用python3）
|
||||
|
||||
```pip install flask requests```
|
||||
|
||||
按需求修改`app/main.py`的前几项配置
|
||||
|
||||
### 注意
|
||||
|
||||
python版本的机器如果无法正常访问github.io会启动报错，请自行修改静态文件url
|
||||
|
||||
workers版本默认配置下clone走github.com.cnpmjs.org，项目文件会走jsDeliver，如需走服务器，修改配置即可
|
||||
|
||||
python版本默认走服务器（2021.3.27更新）
|
||||
|
||||
## Cloudflare Workers计费
|
||||
|
||||
到 `overview` 页面可参看使用情况。免费版每天有 10 万次免费请求，并且有每分钟1000次请求的限制。
|
||||
|
||||
如果不够用，可升级到 $5 的高级版本，每月可用 1000 万次请求（超出部分 $0.5/百万次请求）。
|
||||
|
||||
## Changelog
|
||||
|
||||
* 2020.04.10 增加对`raw.githubusercontent.com`文件的支持
|
||||
* 2020.04.09 增加Python版本（使用Flask）
|
||||
* 2020.03.23 新增了clone的支持
|
||||
* 2020.03.22 初始版本
|
||||
|
||||
## 链接
|
||||
|
||||
[我的博客](https://hunsh.net)
|
||||
本仓库参考 [hunshcn/gh-proxy](https://github.com/hunshcn/gh-proxy) 构建 X86 和 ARM 平台 docker 镜像,具体使用教程请参考原作者仓库.
|
||||
|
||||
## 参考
|
||||
[ghproxy.com](https://ghproxy.com)
|
||||
|
||||
[jsproxy](https://github.com/EtherDream/jsproxy/)
|
||||
|
||||
## 捐赠
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user