update readme
This commit is contained in:
老九
parent
b65eb7dbea
commit
240b8611f1
@ -20,19 +20,22 @@
|
||||
<ProjectReference Include="..\FastGithub.ReverseProxy\FastGithub.ReverseProxy.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Serilog.AspNetCore" Version="4.1.0" />
|
||||
<PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" />
|
||||
<PackageReference Include="Serilog.Settings.Configuration" Version="3.2.0" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Serilog.AspNetCore" Version="4.1.0" />
|
||||
<PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" />
|
||||
<PackageReference Include="Serilog.Settings.Configuration" Version="3.2.0" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<None Include="../README.md" Link="README.md">
|
||||
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
|
||||
</None>
|
||||
<None Include="../LICENSE" Link="LICENSE">
|
||||
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
|
||||
</None>
|
||||
<None Include="../README.pdf" Link="README.pdf">
|
||||
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
|
||||
</None>
|
||||
<None Include="../LICENSE" Link="LICENSE">
|
||||
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
|
||||
</None>
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
|
||||
96
README.md
96
README.md
@ -4,13 +4,56 @@ github加速神器，解决github打不开、用户头像无法加载、releases
|
||||
### 1 程序下载
|
||||
如果不能下载[releases](https://github.com/dotnetcore/FastGithub)里发布的程序，可以到Q群`307306673`里面的群文件下载。
|
||||
|
||||
### 2 加速原理
|
||||
* 修改本机的dns服务指向FastGithub自身
|
||||
* 解析匹配的域名为FastGithub自身的ip
|
||||
* 请求安全dns服务(dnscrypt-proxy)获取域名的ip
|
||||
* 选择最优的ip进行ssh代理或https反向代理
|
||||
### 2 部署方式
|
||||
#### 2.1 windows本机
|
||||
* 双击运行FastGithub.exe程序
|
||||
* `FastGithub.exe start` // 以windows服务安装并启动
|
||||
* `FastGithub.exe stop` // 以windows服务卸载并删除
|
||||
|
||||
### 3 协议列表
|
||||
#### 2.2 linux本机
|
||||
* 执行`sudo ./FastGithub`
|
||||
* 手工添加127.0.0.1做为/etc/resolv.conf的第一条记录
|
||||
* 手工安装CACert/FastGithub.cer到受信任的根证书颁发机构
|
||||
|
||||
#### 2.3 macOS本机
|
||||
* 双击运行FastGithub程序
|
||||
* 手工添加127.0.0.1做为连接网络的DNS的第一条记录
|
||||
* 手工安装CACert/FastGithub.cer并设置信任
|
||||
|
||||
#### 2.4 局域网服务器
|
||||
* 在局域网服务器运行FastGithub程序
|
||||
* 手工将你电脑的主DNS设置为局域网服务器的ip
|
||||
* 手工在你电脑安装FastGithub.cer到受信任的根证书颁发机构
|
||||
|
||||
|
||||
### 3 应用冲突
|
||||
#### 3.1 hosts文件
|
||||
需要从hosts文件移除github相关域名的配置
|
||||
|
||||
#### 3.2 代理(proxy)
|
||||
关闭代理，或将浏览器和系统配置为不代理github相关域名
|
||||
|
||||
#### 3.3 浏览器安全DNS
|
||||
关闭浏览器的安全DNS功能或将安全DNS设置为https://127.0.0.1
|
||||
|
||||
### 4 证书验证
|
||||
#### 4.1 git
|
||||
git操作提示`SSL certificate problem`</br>
|
||||
|
||||
需要关闭git的证书验证：`git config --global http.sslverify false`
|
||||
|
||||
#### 4.2 firefox
|
||||
firefox提示`连接有潜在的安全问题`</br>
|
||||
|
||||
设置->隐私与安全->证书->查看证书->证书颁发机构，导入FastGithub.cer，勾选信任由此证书颁发机构来标识网站
|
||||
|
||||
### 5 加速原理
|
||||
1 修改本机的dns服务指向FastGithub自身；</br>
|
||||
2 解析匹配的域名为FastGithub自身的ip；</br>
|
||||
3 请求安全dns服务(dnscrypt-proxy)获取域名的ip；</br>
|
||||
4 选择最优的ip进行ssh代理或https反向代理；
|
||||
|
||||
### 6 协议列表
|
||||
| 协议 | 资源标识 | 端口要求 | 用途 |
|
||||
| ----- | --------------------- | ---------- | ---------------------------- |
|
||||
| DNS | `udp://0.0.0.0:53` | 要求可用 | 解析配置的域名指向FastGithub |
|
||||
@ -19,47 +62,6 @@ github加速神器，解决github打不开、用户头像无法加载、releases
|
||||
| HTTP | `http://0.0.0.0:80` | 不要求可用 | 反向代理http请求 |
|
||||
| SSH | `ssh://0.0.0.0:22` | 不要求可用 | 代理ssh请求到github |
|
||||
|
||||
### 4 部署方式
|
||||
#### 4.1 windows本机
|
||||
* 双击运行FastGithub.exe程序
|
||||
* `FastGithub.exe start` // 以windows服务安装并启动
|
||||
* `FastGithub.exe stop` // 以windows服务卸载并删除
|
||||
#### 4.2 linux本机
|
||||
* 执行`sudo ./FastGithub`
|
||||
* 手工添加127.0.0.1做为/etc/resolv.conf的第一条记录
|
||||
* 手工安装CACert/FastGithub.cer到受信任的根证书颁发机构
|
||||
|
||||
#### 4.3 macOS本机
|
||||
* 双击运行FastGithub程序
|
||||
* 手工添加127.0.0.1做为连接网络的DNS的第一条记录
|
||||
* 手工安装CACert/FastGithub.cer并设置信任
|
||||
|
||||
#### 4.4 局域网服务器
|
||||
* 在局域网服务器运行FastGithub程序
|
||||
* 手工将你电脑的主DNS设置为局域网服务器的ip
|
||||
* 手工在你电脑安装FastGithub.cer到受信任的根证书颁发机构
|
||||
|
||||
### 5 证书验证
|
||||
#### 5.1 git
|
||||
git操作提示`SSL certificate problem`
|
||||
|
||||
需要关闭git的证书验证：`git config --global http.sslverify false`
|
||||
|
||||
#### 5.2 firefox
|
||||
firefox提示`连接有潜在的安全问题`
|
||||
|
||||
设置->隐私与安全->证书->查看证书->证书颁发机构，导入FastGithub.cer，勾选信任由此证书颁发机构来标识网站
|
||||
|
||||
### 6 应用冲突
|
||||
#### 6.1 hosts文件
|
||||
需要从hosts文件移除github相关域名的配置
|
||||
|
||||
#### 6.2 代理(proxy)
|
||||
关闭代理，或将浏览器和系统配置为不代理github相关域名
|
||||
|
||||
#### 6.3 浏览器安全DNS
|
||||
关闭浏览器的安全DNS功能或将安全DNS设置为https://127.0.0.1
|
||||
|
||||
### 7 安全性说明
|
||||
FastGithub为每台不同的主机生成自颁发CA证书，保存在CACert文件夹下。客户端设备需要安装和无条件信任自颁发的CA证书，请不要将证书私钥泄露给他人，以免造成损失。
|
||||
|
||||
|
||||
BIN
README.pdf
BIN
README.pdf
Binary file not shown.
Loading…
Reference in New Issue
Block a user