docs: update example links

2021-01-08 18:05:32 +08:00 · 2021-01-08 18:05:32 +08:00 · 5959e80efb
commit 5959e80efb
parent 32317a419b
5 changed files with 32 additions and 11 deletions
--- a/README.md
+++ b/README.md
@ -2,6 +2,8 @@

 Github文件下载加速PHP版，基于异步PHP框架 [ReactPHP](https://github.com/reactphp)开发。

+演示站点：<https://gh.2i.gs>，教程文章：<https://tlanyan.me/php-version-ghproxy/>
+
 本项目参考 [gh-proxy](https://github.com/hunshcn/gh-proxy)，其js版可运行在CloudFflare Worker上，并提供了可运行在docker中的Python版。


@ -29,15 +31,18 @@ rm -rf installer

 ### 2. 安装composer依赖

-下载/克隆本项目代码，进入文件夹内执行安装命令：
+下载/克隆本项目代码，安装composer依赖：

 ````bash
+# 如果git未安装，CentOS运行yum install -y git，Ubuntu/Debian系统运行apt install -y git
+git clone https://github.com/tlanyan/ghproxy
+cd ghproxy
 composer install
 # 可选，基本没必要
 composer dump-autoload -o
 ````

-打开 `index.php` 文件，视自己情况可修改如下几个配置(一般保持默认即可)：
+打开 `index.php` 文件，视自己情况修改如下几个配置(一般保持默认即可)：

 - `ADDR`：程序监听的IP，默认是本机。如果前端不需要web服务器，请改成 `0.0.0.0`；
 - `PORT`: 程序监听的端口，默认8080
@ -45,7 +50,7 @@ composer dump-autoload -o
 - `CNPMJS`：是否使用cnpmjs.org加速
 - `SIZE_LIMIT`：最大可下载文件大小，默认2GB

-最后将项目文件夹放置到web目录，例如将文件夹移动到 `/var/www` 目录内。
+最后将index.html放置到web目录，例如移动到 `/var/www/ghproxy` 目录内。如果前端不使用Nginx等软件，无需移动。

 ### 3. 安装Nginx（可选）

@ -62,14 +67,18 @@ systemctl enable nginx
 apt install -y nginx
 ````

-修改项目中的 `ghproxy.conf` 文件，把域名等改成自己的，然后复制到Nginx配置目录内。
+修改项目中的 `ghproxy.conf` 文件(域名、web路径、SSL配置等)，然后复制到Nginx配置目录内。获取证书和配置Nginx可参考 [从Let’s Encrypt获取免费证书](https://tlanyan.me/use-lets-encrypt-certificate/) 或 [从阿里云获取免费SSL证书](https://tlanyan.me/get-free-ssl-certificates-from-aliyun/)

 ### 4. 启动程序

-进入项目文件夹，执行 `nohup php index.php &`，也可以在 tmux/screen 等终端窗口内执行 `php index.php` 启动代理。
+进入项目文件夹，执行 `nohup php index.php &`，也可以在 tmux/screen 等终端窗口内执行 `php index.php` 启动程序。

 部署了Nginx的前端web服务器的，请重启web服务器。

 接下来，浏览器打开网址，输入要加速下载的链接，查看加速效果。

 使用中遇到问题欢迎反馈。
+
+## Tips
+
+保持Github上的fork在最新版请参考：[使用pull app保持Fork代码在最新状态](https://tlanyan.me/use-pull-app-to-keep-your-forks-up-to-date/)
--- a/ghproxy.conf
+++ b/ghproxy.conf
@ -22,6 +22,14 @@ server {
        try_files $uri $uri/  =404;
    }

+    location ~ \.git* {
+        deny all;
+    }
+
+    location /nohup.out {
+        deny all;
+    }
+
    location ^~ /http {
        proxy_pass http://localhost:8080;
    }
--- a/index.html
+++ b/index.html
@ -124,7 +124,7 @@
        return false;
      }
    </script>
-    <title>GitHub 文件加速（自部署PHP版本）</title>
+    <title>GitHub 文件加速（PHP版本）</title>
  </head>
  <body class="flex">
    <a
@ -167,14 +167,14 @@
      <input class="block btn" type="submit" value="下载" />
      
      <div class="example">
-        <p>分支源码：https://github.com/hunshcn/project/archive/master.zip</p>
+        <p>分支源码：https://github.com/tlanyan/ghproxy/archive/main.zip</p>
        <p>
-          release源码：https://github.com/hunshcn/project/archive/v0.1.0.tar.gz
+          release源码：https://github.com/tlanyan/yii2/archive/2.0.4.zip
        </p>
        <p>
-          release文件：https://github.com/hunshcn/project/releases/download/v0.1.0/example.zip
+          release文件：https://github.com/tlanyan/yii2/archive/2.0.4.zip
        </p>
-        <p>分支文件：https://github.com/hunshcn/project/blob/master/filename</p>
+        <p>分支文件：https://github.com/tlanyan/ghproxy/blob/main/index.html</p>
      </div>
      <div class="tips">
        <p>
--- a/index.php
+++ b/index.php
@ -87,6 +87,8 @@ function handler(Psr\Http\Message\ServerRequestInterface $req) {
 }

 function serveStaticFiles(string $url) {
+    if ($url == "") $url = "index.html";
+
    $path = ROOT . "/$url";
    $path = realpath($path);
    if (strpos(ROOT, $path) === 0 && is_file($path)) {
--- a/robots.txt
+++ b/robots.txt
@ -0,0 +1,2 @@
+user-agent: *
+Disallow: /vendor