docs: rEADME
This commit is contained in:
tlanyan
parent
9d0d1e3eb7
commit
32317a419b
14
README.md
14
README.md
@ -2,7 +2,7 @@
|
||||
|
||||
Github文件下载加速PHP版，基于异步PHP框架 [ReactPHP](https://github.com/reactphp)开发。
|
||||
|
||||
本项目主要参考 [gh-proxy](https://github.com/hunshcn/gh-proxy)，其js版可运行在CloudFflare Worker上，并提供了可运行在docker中的Python版。
|
||||
本项目参考 [gh-proxy](https://github.com/hunshcn/gh-proxy)，其js版可运行在CloudFflare Worker上，并提供了可运行在docker中的Python版。
|
||||
|
||||
|
||||
## 使用教程
|
||||
@ -19,7 +19,7 @@ apt php-cli php-fpm php-bcmath php-gd php-mbstring \
|
||||
php-mysql php-opcache php-xml php-zip php-json php-imagick
|
||||
````
|
||||
|
||||
接着安装composer：
|
||||
安装composer：
|
||||
|
||||
````bash
|
||||
wget https://getcomposer.org/installer
|
||||
@ -40,7 +40,7 @@ composer dump-autoload -o
|
||||
打开 `index.php` 文件，视自己情况可修改如下几个配置(一般保持默认即可)：
|
||||
|
||||
- `ADDR`：程序监听的IP，默认是本机。如果前端不需要web服务器，请改成 `0.0.0.0`；
|
||||
- `PORT`: 程序监听的端口
|
||||
- `PORT`: 程序监听的端口，默认8080
|
||||
- `JSDELIVR`：是否使用jsdelivr加速
|
||||
- `CNPMJS`：是否使用cnpmjs.org加速
|
||||
- `SIZE_LIMIT`：最大可下载文件大小，默认2GB
|
||||
@ -49,7 +49,7 @@ composer dump-autoload -o
|
||||
|
||||
### 3. 安装Nginx（可选）
|
||||
|
||||
可以选择使用Nginx/Apache httpd/Caddy等中间件在前端接受web请求，也可以让程序直接监听端口处理请求。如果采用https访问，建议使用Nginx的web服务器。
|
||||
可以选择使用Nginx/Apache httpd/Caddy等中间件在前端接受web请求，也可以让程序直接监听端口处理请求。如果采用https访问，建议使用Nginx等web服务器配置SSL。
|
||||
|
||||
安装Nginx:
|
||||
|
||||
@ -62,11 +62,13 @@ systemctl enable nginx
|
||||
apt install -y nginx
|
||||
````
|
||||
|
||||
接着按照实际情况修改项目中的 `ghproxy.conf` 文件，修改完毕后复制到Nginx的配置目录内。
|
||||
修改项目中的 `ghproxy.conf` 文件，把域名等改成自己的，然后复制到Nginx配置目录内。
|
||||
|
||||
### 4. 启动程序
|
||||
|
||||
进入项目文件夹，执行 `nohup php index.php &`，也可以在 tmux/screen 等终端窗口内执行 `php index.php` 启动项目。
|
||||
进入项目文件夹，执行 `nohup php index.php &`，也可以在 tmux/screen 等终端窗口内执行 `php index.php` 启动代理。
|
||||
|
||||
部署了Nginx的前端web服务器的，请重启web服务器。
|
||||
|
||||
接下来，浏览器打开网址，输入要加速下载的链接，查看加速效果。
|
||||
|
||||
|
||||
40
index.html
40
index.html
@ -89,6 +89,13 @@
|
||||
color: #7b7b7b;
|
||||
position: relative;
|
||||
align-self: flex-start;
|
||||
|
||||
}
|
||||
|
||||
.example {
|
||||
margin-left: 10em;
|
||||
}
|
||||
.tips {
|
||||
margin-left: 7.5em;
|
||||
}
|
||||
|
||||
@ -101,7 +108,7 @@
|
||||
|
||||
.example > p:first-child::before {
|
||||
position: absolute;
|
||||
left: -7.5em;
|
||||
left: -8em;
|
||||
content: "合法输入示例：";
|
||||
color: #7b7b7b;
|
||||
}
|
||||
@ -117,13 +124,13 @@
|
||||
return false;
|
||||
}
|
||||
</script>
|
||||
<title>GitHub 文件加速</title>
|
||||
<title>GitHub 文件加速（自部署PHP版本）</title>
|
||||
</head>
|
||||
<body class="flex">
|
||||
<a
|
||||
style="position: absolute; top: 0; right: 0"
|
||||
href="https://github.com/tlanyan/ghproxy"
|
||||
><img
|
||||
target="_blank"><img
|
||||
width="149"
|
||||
height="149"
|
||||
referrerpolicy="no-referrer"
|
||||
@ -131,12 +138,13 @@
|
||||
alt="Fork me on GitHub"
|
||||
data-recalc-dims="1"
|
||||
/></a>
|
||||
<h1 style="margin-bottom: 50px">
|
||||
<h1 style="margin-bottom: 10px">
|
||||
<img
|
||||
src="https://ae01.alicdn.com/kf/H2fc84859291347418b11091fe0e508b8v.png"
|
||||
style="width: 1.5em; margin-right: 0.2em; vertical-align: bottom"
|
||||
/>GitHub 文件加速
|
||||
/>GitHub 文件加速（PHP版本）
|
||||
</h1>
|
||||
<p style="margin-bottom: 40px;">本站仅供演示，如需可靠使用，请自行部署</p>
|
||||
<form
|
||||
action="./"
|
||||
method="get"
|
||||
@ -150,23 +158,14 @@
|
||||
class="block url"
|
||||
name="q"
|
||||
type="text"
|
||||
placeholder="键入Github文件链接"
|
||||
placeholder="请输入Github文件链接"
|
||||
pattern="^((https|http):\/\/)?(github\.com\/.+?\/.+?\/(?:releases|archive|blob)|(raw\.githubusercontent\.com))\/.+$"
|
||||
required
|
||||
/>
|
||||
<div class="bar"></div>
|
||||
</label>
|
||||
<input class="block btn" type="submit" value="下载" />
|
||||
<div class="tips">
|
||||
<p>
|
||||
GitHub文件链接带不带协议头都可以，支持release、archive以及文件，右键复制出来的链接都是符合标准的，更多用法、clone加速请参考<a
|
||||
href="https://hunsh.net/archives/23/"
|
||||
>这篇文章</a
|
||||
>。
|
||||
</p>
|
||||
<p>release、archive使用cf加速，文件会跳转至JsDelivr</p>
|
||||
<p><strong>注意，不支持项目文件夹</strong></p>
|
||||
</div>
|
||||
|
||||
<div class="example">
|
||||
<p>分支源码：https://github.com/hunshcn/project/archive/master.zip</p>
|
||||
<p>
|
||||
@ -177,11 +176,18 @@
|
||||
</p>
|
||||
<p>分支文件：https://github.com/hunshcn/project/blob/master/filename</p>
|
||||
</div>
|
||||
<div class="tips">
|
||||
<p>
|
||||
右键复制出来的链接都是符合标准的。
|
||||
</p>
|
||||
<p>release、archive直接反代加速，文件会跳转至JsDelivr或cnpmjs.org加速下载</p>
|
||||
<p><strong>注意：不支持项目文件夹</strong></p>
|
||||
</div>
|
||||
</form>
|
||||
<p style="position: sticky; top: calc(100% - 2.5em)">
|
||||
本项目为 <a href="https://github.com/hunshcn/gh-proxy" target="_blank">gh-proxy</a> 的PHP版本，基于 <a href="https://github.com/reactphp" target="_blank">ReactPHP</a> 开发，开源于GitHub
|
||||
<a style="color: #3294ea" href="https://github.com/tlanyan/ghproxy"
|
||||
>tlanyan/ghproxy</a
|
||||
target="_blank">tlanyan/ghproxy</a
|
||||
>
|
||||
</p>
|
||||
</body>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user