Browse Source

refactor: doc

pull/67/head
xiaojunnuo 4 years ago
parent
commit
a39e9e5c36
  1. 48
      README.md

48
README.md

@ -1,8 +1,7 @@
# dev-sidecar
开发者边车,命名取自service-mesh的service-sidecar,意为为开发者打辅助的边车工具
通过本地代理的方式将http请求代理到一些国内的加速通道上
不用`fan qiang`也能解决一些网站和库无法访问或访问速度慢的问题
通过本地代理的方式将https请求代理到一些国内的加速通道上
<a href='https://gitee.com/docmirror/dev-sidecar'><img src='https://gitee.com/docmirror/dev-sidecar/badge/star.svg?theme=dark' alt='star'/></a>
<a href='https://github.com/docmirror/dev-sidecar'><img alt="GitHub stars" src="https://img.shields.io/github/stars/docmirror/dev-sidecar?logo=github"></a>
@ -10,16 +9,15 @@
## 特性
### 1、 dns优选
根据网络状况智能解析最佳域名ip地址,获取最佳网络速度
建议遇到打开比较慢的国外网站,可以优先尝试将该域名添加到dns设置中(注意:被GFW封杀的无效)
### 1、 dns优选(解决国内dns污染问题)
* 根据网络状况智能解析最佳域名ip地址,获取最佳网络速度
* 不用`fan qiang`也能解决一些网站和库无法访问或访问速度慢的问题
* 建议遇到打开比较慢的国外网站,可以优先尝试将该域名添加到dns设置中(注意:被GFW封杀的无效)
### 2、 请求拦截
拦截打不开的网站,代理到加速镜像站点上去。
可配置多个镜像站作为备份
具备测速机制,当访问失败或超时之后,自动切换到备用站点。
使得目标服务高可用
* 拦截打不开的网站,代理到加速镜像站点上去。
* 可配置多个镜像站作为备份
* 具备测速机制,当访问失败或超时之后,自动切换到备用站点,使得目标服务高可用
### 3、 github加速
* release、source、zip下载加速
@ -41,8 +39,13 @@
### 6、 增强功能
* 众所周知的原因,不能在这里展示太多,自己下载来安装看看吧
* 反正用了这个之后,上面那些dns优选什么的特性好像都不香了
* 反正开了这个之后,上面那些dns优选什么的特性好像都不香了
* 建议遇到打不开的网站,可以将域名添加到增强功能自定义域名配置中(注意:是不是似曾相识? (●゚ω゚●)没有注意~~)
***安全警告***:
* 请勿使用来源不明的服务地址,有隐私和账号泄露风险
* 本应用内置服务端承诺不收集任何信息。介意者请慎用。
* 建议自建服务端(增强功能页面右上角点击查看自建服务端方法)
## 快速开始
支持windows、Mac
@ -70,10 +73,9 @@
第一次打开会提示安装证书,根据提示操作即可
>根证书是本地随机生成的,所以不用担心根证书的安全问题
>根证书是本地随机生成的,所以不用担心根证书的安全问题(本应用不收集任何用户信息)
>你也可以在加速服务设置中自定义根证书(PEM格式的证书与私钥)
#### 3 开始加速吧
去试试打开github
@ -190,25 +192,29 @@ sudo xcodebuild -license
如果还不行,请联系作者
### 2、没有加速效果
***本应用仅支持https加速,请务必确认你访问的网站地址是https开头的***
1. 本应用仅支持https加速
请务必确认你访问的地址是https开头的
比如: https://github.com/
1. 请确认网络代理设置处于勾选状态
2. 请确认浏览器的代理设置为使用IE代理/或者使用系统代理状态
3. 请确认网络代理设置处于勾选状态
正常情况下dev-sidecar在“系统代理”开关打开时,会自动设置代理。
如何打开查看windows代理设置:
* win10: 开始->设置->网络和Internet->最下方代理
* win7: 开始->控制面板->网络和Internet->网络和共享中心->左下角Internet选项->连接选项卡->局域网设置
windows 代理查看
windows 代理查看
![windows](./doc/proxy.png)
mac 代理查看
mac 代理查看
![](./doc/mac-proxy.png)
2. 尝试将代理设置关闭再重新打开
按上图中手动设置代理ip和端口(ip:127.0.0.1,端口:1811)
关闭代理,保存,再打开代理,再保存。
然后再尝试打开github
### 3、浏览器打开提示证书不受信任

Loading…
Cancel
Save