update README.md.
Signed-off-by: Xingyuan55 <dus0963@outlook.com>
This commit is contained in:
Xingyuan55
Gitee
parent
256761deb8
commit
4374e3aaa8
104
README.md
104
README.md
@ -1,39 +1,67 @@
|
|||||||
# FastGithub
|
# 请参见[源地址](https://github.com/dotnetcore/FastGithub)
|
||||||
|
|
||||||
#### 介绍
|
|
||||||
源地址https://github.com/dotnetcore/FastGithub，考虑到Github有时候连不上，所以搬运一份镜像。
|
|
||||||
|
|
||||||
github加速神器，解决github打不开、用户头像无法加载、releases无法上传下载、git-clone、git-pull、git-push失败等问题。
|
|
||||||
|
# FastGithub
|
||||||
#### 软件架构
|
github加速神器，解决github打不开、用户头像无法加载、releases无法上传下载、git-clone、git-pull、git-push失败等问题。
|
||||||
软件架构说明
|
|
||||||
|
### 0 写在前面
|
||||||
|
* **fastgithub不具备“翻墙”功能,也没有相关的计划**
|
||||||
#### 安装教程
|
* **fastgithub不支持Windows7等已被发行方停止支持的操作系统，并且也不会主动提供支持**
|
||||||
|
* **fastgithub不能为您的游戏加速**
|
||||||
1. xxxx
|
* ***fastgithub没有主动在github和fastgithub@qq.com之外的任何渠道发布***
|
||||||
2. xxxx
|
`转载自https://github.com/dotnetcore/FastGithub`
|
||||||
3. xxxx
|
|
||||||
|
### 1 程序下载
|
||||||
#### 使用说明
|
* [github-release下载](https://github.com/dotnetcore/fastgithub/releases)
|
||||||
|
* 发送任意邮件到fastgithub@qq.com
|
||||||
1. xxxx
|
|
||||||
2. xxxx
|
### 2 部署方式
|
||||||
3. xxxx
|
#### 2.1 windows-x64桌面
|
||||||
|
* 双击运行FastGithub.UI.exe
|
||||||
#### 参与贡献
|
|
||||||
|
#### 2.2 windows-x64服务
|
||||||
1. Fork 本仓库
|
* `fastgithub.exe start` // 以windows服务安装并启动
|
||||||
2. 新建 Feat_xxx 分支
|
* `fastgithub.exe stop` // 以windows服务卸载并删除
|
||||||
3. 提交代码
|
|
||||||
4. 新建 Pull Request
|
#### 2.3 linux-x64终端
|
||||||
|
* `sudo ./fastgithub`
|
||||||
|
* 设置系统自动代理为`http://127.0.0.1:38457`，或手动代理http/https为`127.0.0.1:38457`
|
||||||
#### 特技
|
|
||||||
|
#### 2.4 linux-x64服务
|
||||||
1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
|
* `sudo ./fastgithub start` // 以systemd服务安装并启动
|
||||||
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
|
* `sudo ./fastgithub stop` // 以systemd服务卸载并删除
|
||||||
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
|
* 设置系统自动代理为`http://127.0.0.1:38457`，或手动代理http/https为`127.0.0.1:38457`
|
||||||
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
|
|
||||||
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
|
#### 2.5 macOS-x64
|
||||||
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
* 双击运行fastgithub
|
||||||
|
* 安装cacert/fastgithub.cer并设置信任
|
||||||
|
* 设置系统自动代理为`http://127.0.0.1:38457`，或手动代理http/https为`127.0.0.1:38457`
|
||||||
|
* [具体配置详情](https://github.com/dotnetcore/FastGithub/blob/master/MacOSXConfig.md)
|
||||||
|
|
||||||
|
#### 2.6 docker-compose一键部署
|
||||||
|
* 准备好docker 18.09, docker-compose.
|
||||||
|
* 在源码目录下，有一个docker-compose.yaml 文件，专用于在实际项目中，临时使用github.com源码，而做的demo配置。
|
||||||
|
* 根据自己的需要更新docker-compose.yaml中的sample和build镜像即可完成拉github.com源码加速，并基于源码做后续的操作。
|
||||||
|
|
||||||
|
### 3 软件功能
|
||||||
|
* 提供域名的纯净IP解析；
|
||||||
|
* 提供IP测速并选择最快的IP；
|
||||||
|
* 提供域名的tls连接自定义配置；
|
||||||
|
* google的CDN资源替换，解决大量国外网站无法加载js和css的问题；
|
||||||
|
|
||||||
|
### 4 证书验证
|
||||||
|
#### 4.1 git
|
||||||
|
git操作提示`SSL certificate problem`</br>
|
||||||
|
需要关闭git的证书验证：`git config --global http.sslverify false`
|
||||||
|
|
||||||
|
#### 4.2 firefox
|
||||||
|
firefox提示`连接有潜在的安全问题`</br>
|
||||||
|
设置->隐私与安全->证书->查看证书->证书颁发机构，导入cacert/fastgithub.cer，勾选“信任由此证书颁发机构来标识网站”
|
||||||
|
|
||||||
|
|
||||||
|
### 5 安全性说明
|
||||||
|
FastGithub为每台不同的主机生成自颁发CA证书，保存在cacert文件夹下。客户端设备需要安装和无条件信任自颁发的CA证书，请不要将证书私钥泄露给他人，以免造成损失。
|
||||||
|
|
||||||
|
### 6 合法性说明
|
||||||
|
《国际联网暂行规定》第六条规定：“计算机信息网络直接进行国际联网，必须使用邮电部国家公用电信网提供的国际出入口信道。任何单位和个人不得自行建立或者使用其他信道进行国际联网。”
|
||||||
|
FastGithub本地代理使用的都是“公用电信网提供的国际出入口信道”，从国外Github服务器到国内用户电脑上FastGithub程序的流量，使用的是正常流量通道，其间未对流量进行任何额外加密（仅有网页原有的TLS加密，区别于VPN的流量加密），而FastGithub获取到网页数据之后发生的整个代理过程完全在国内，不再适用国际互联网相关之规定。
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user