github
/
dev-sidecar
mirror of https://github.com/docmirror/dev-sidecar
1
0
Fork 0
Code Issues Releases Wiki Activity

optimize: README中，添加感谢 [中国域名白名单] 仓库的说明。

Browse Source
pull/375/head
王良 2 months ago
parent 1ae0316339
commit 61ad6cbf87
1 changed files with 93 additions and 93 deletions
Show Stats Download Patch File Download Diff File

186
README.md
Unescape View File

@ -1,7 +1,7 @@
# dev-sidecar
开发者边车，命名取自service-mesh的service-sidecar，意为为开发者打辅助的边车工具（以下简称ds）
开发者边车，命名取自service-mesh的service-sidecar，意为为开发者打辅助的边车工具（以下简称ds）
通过本地代理的方式将https请求代理到一些国内的加速通道上
<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>
@ -9,13 +9,13 @@
>
> Gitee上的同步项目已被封禁，此项目将不再更新与维护 【狗头保命】
>
> 我将继续奋战在开源一线，为社区贡献更多更好的开源项目。
> 我将继续奋战在开源一线，为社区贡献更多更好的开源项目。
> 感兴趣的可以关注我的主页 [【github】](https://github.com/greper) [【gitee】](https://gitee.com/greper)
>
## 打个广告
>
> https://ai.handsfree.work
> 我的ChatGPT，开发者必备，无需fanQ，快速，稳定，价格良心，100问仅需1元，按需扣费，余额永久有效，大家可以试试
>
> https://ai.handsfree.work
> 我的ChatGPT，开发者必备，无需fanQ，快速，稳定，价格良心，100问仅需1元，按需扣费，余额永久有效，大家可以试试
@ -24,28 +24,28 @@
>
> 注意：由于electron无法监听windows的关机事件，开着ds情况下直接重启电脑，会导致无法上网，你可以手动启动ds即可恢复网络，你也可以将ds设置为开机自启。
>
> 关于此问题的更多讨论请前往：
> 关于此问题的更多讨论请前往：
> https://github.com/docmirror/dev-sidecar/issues/109
>
> ------------------------------重要提醒2---------------------------------
>
> 注意：本应用启动会自动修改系统代理，所以会与其他代理软件有冲突，请务必不要一起使用。
> 注意：本应用启动会自动修改系统代理，所以会与其他代理软件有冲突，请务必不要一起使用。
> 本应用主要目的在于直连访问github，如果你已经有飞机了，那建议还是不要用这个自行车（ds）了
>
## 一、 特性
### 1.1、 dns优选（解决***污染问题）
* 根据网络状况智能解析最佳域名ip地址，获取最佳网络速度
* 根据网络状况智能解析最佳域名ip地址，获取最佳网络速度
* 解决一些网站和库无法访问或访问速度慢的问题
* 建议遇到打开比较慢的国外网站，可以优先尝试将该域名添加到dns设置中（注意：被***封杀的无效）
* 建议遇到打开比较慢的国外网站，可以优先尝试将该域名添加到dns设置中（注意：被***封杀的无效）
### 1.2、 请求拦截
* 拦截打不开的网站，代理到加速镜像站点上去。
* 可配置多个镜像站作为备份
* 拦截打不开的网站，代理到加速镜像站点上去。
* 可配置多个镜像站作为备份
* 具备测速机制，当访问失败或超时之后，自动切换到备用站点，使得目标服务高可用
### 1.3、 github加速
@ -60,13 +60,13 @@
> 以上部分功能通过`X.I.U`的油猴脚本实现， 以下是仓库和脚本下载链接，大家可以去支持一下。
> * https://github.com/XIU2/UserScript
> * https://greasyfork.org/scripts/412245
>
> * https://greasyfork.org/scripts/412245
>
> 由于此脚本在ds中是打包在本地的，更新会不及时，你可以直接通过浏览器安装油猴插件使用此脚本，从而获得最新更新（ds本地的可以通过`加速服务->基本设置->启用脚本`进行关闭）。
### 1.4、 Stack Overflow 加速
* 将ajax.google.com代理到加速CDN上
* 将ajax.google.com代理到加速CDN上
* recaptcha 图片验证码加速
### 1.5、 npm加速
@ -86,51 +86,51 @@
支持windows、Mac、Linux(Ubuntu)
### 2.1、DevSidecar桌面应用
#### 1）下载安装包
* release下载
[Github Release](https://github.com/docmirror/dev-sidecar/releases)
> Windows: 请选择DevSidecar-x.x.x.exe
> Mac: 请选择DevSidecar-x.x.x.dmg
> Ubuntu: 请选择DevSidecar-x.x.x.deb
> 其他linux: 请选择DevSidecar-x.x.x.AppImage (未做测试，不保证能用)
#### 1）下载安装包
* release下载
[Github Release](https://github.com/docmirror/dev-sidecar/releases)
> linux安装说明请参考 [linux安装文档](./doc/linux.md)
> Windows: 请选择DevSidecar-x.x.x.exe
> Mac: 请选择DevSidecar-x.x.x.dmg
> Ubuntu: 请选择DevSidecar-x.x.x.deb
> 其他linux: 请选择DevSidecar-x.x.x.AppImage (未做测试，不保证能用)
> linux安装说明请参考 [linux安装文档](./doc/linux.md)
> 注意：由于没有买应用证书，所以应用在下载安装时会有“未知发行者”等安全提示，选择保留即可。
#### 2）安装后打开
#### 2）安装后打开
> 注意：mac版安装需要在“系统偏好设置->安全性与隐私->通用”中解锁并允许应用安装
![](./doc/index.png)
![](./doc/index.png)
#### 3）安装根证书
#### 3）安装根证书
第一次打开会提示安装证书，根据提示操作即可
第一次打开会提示安装证书，根据提示操作即可
更多有关根证书的说明，请参考 [为什么要安装根证书?](./doc/caroot.md)
> 根证书是本地随机生成的，所以不用担心根证书的安全问题（本应用不收集任何用户信息）
> 你也可以在加速服务设置中自定义根证书（PEM格式的证书与私钥）
> 根证书是本地随机生成的，所以不用担心根证书的安全问题（本应用不收集任何用户信息）
> 你也可以在加速服务设置中自定义根证书（PEM格式的证书与私钥）
> 火狐浏览器需要[手动安装证书](#3浏览器打开提示证书不受信任)
> 火狐浏览器需要[手动安装证书](#3浏览器打开提示证书不受信任)
#### 4）开始加速吧
去试试打开github
#### 4）开始加速吧
去试试打开github
### 2.2、开启前 vs 开启后
### 2.2、开启前 vs 开启后
| | 开启前 | 开启后 |
| ---- | ---- | ---- |
|头像| ![](./doc/avatar2.png) |![](./doc/avatar1.png) |
|clone |![](./doc/clone-before.png) |![](./doc/clone.png) |
|zip 下载 |![](./doc/download-before.png) |![](./doc/download.png)秒下的，实在截不到速度的图 |
|clone |![](./doc/clone-before.png) |![](./doc/clone.png) |
|zip 下载 |![](./doc/download-before.png) |![](./doc/download.png)秒下的，实在截不到速度的图 |
## 三、模式说明
@ -154,19 +154,19 @@
### 其他加速
#### 1）git clone 加速
方式1：快捷复制：
> 开启脚本支持，然后在复制clone链接下方，即可复制到加速链接
#### 1）git clone 加速
方式1：快捷复制：
> 开启脚本支持，然后在复制clone链接下方，即可复制到加速链接
方式2：
> 使用方式用实际的名称替换{}的内容，即可加速clone
> https://hub.fastgit.org/{username}/{reponame}.git
> clone 出来的 remote "origin" 为fastgit的地址，需要手动改回来
> 使用方式用实际的名称替换{}的内容，即可加速clone
> https://hub.fastgit.org/{username}/{reponame}.git
> clone 出来的 remote "origin" 为fastgit的地址，需要手动改回来
> 你也可以直接使用他们的clone加速工具 [fgit-go](https://github.com/FastGitORG/fgit-go)
#### 2）github.com的镜像网站(注意：不能登录)
> 1. [hub.fastgit.org](https://hub.fastgit.org/)
#### 2）github.com的镜像网站(注意：不能登录)
> 1. [hub.fastgit.org](https://hub.fastgit.org/)
> 2. [github.com.cnpmjs.org](https://github.com.cnpmjs.org/) 这个很容易超限
@ -191,7 +191,7 @@ const intercepts = {
redirect: 'download.fastgit.org'
},
'.*': {
proxy: 'github.com',
proxy: 'github.com',
sni: 'baidu.com' //修改sni，规避***握手拦截
}
},
@ -207,22 +207,24 @@ const intercepts = {
'.*':{
abort: true //取消请求，被***封锁的资源，找不到替代，直接取消请求，快速失败，节省时间
}
}
}
}
```
### 5.2、DNS优选配置
某些域名解析出来的ip会无法访问，（比如api.github.com会被解析到新加坡的ip上，新加坡的服务器在上午挺好，到了晚上就卡死，基本不可用）
某些域名解析出来的ip会无法访问，（比如api.github.com会被解析到新加坡的ip上，新加坡的服务器在上午挺好，到了晚上就卡死，基本不可用）
通过从dns上获取ip列表，切换不同的ip进行尝试，最终会挑选到一个最快的ip
```js
dns: {
mapping: {
'api.github.com': 'cloudflare', // "解决push的时候需要输入密码的问题",
'gist.github.com': 'cloudflare' // 解决gist无法访问的问题
'*.githubusercontent.com': 'cloudflare' // 解决github头像经常下载不到的问题
```json
{
"dns": {
"mapping": {
"api.github.com": "cloudflare", // "解决push的时候需要输入密码的问题",
"gist.github.com": "cloudflare", // 解决gist无法访问的问题
"*.githubusercontent.com": "cloudflare" // 解决github头像经常下载不到的问题
}
}
}
```
注意：暂时只支持IPv4的解析
@ -233,39 +235,39 @@ const intercepts = {
1. 尝试将开关按钮手动打开
2. 请尝试右键dev-sidecar图标，点退出。再重新打开
3. 如果还不行，请将日志发送给作者
如果是mac系统，可能是下面的原因
#### 1）Mac系统使用时，首页的系统代理开关无法打开
出现这个问题可能是没有开启系统代理命令的执行权限
出现这个问题可能是没有开启系统代理命令的执行权限
```
networksetup -setwebproxy 'WiFi' 127.0.0.1 31181
networksetup -setwebproxy 'WiFi' 127.0.0.1 31181
#看是否有如下错误提示
** Error: Command requires admin privileges.
```
如果有上面的错误提示，请尝试如下方法：
>取消访问偏好设置需要管理员密码
>取消访问偏好设置需要管理员密码
>系统偏好设置—>安全性与隐私—> 通用—> 高级—> 访问系统范围的偏好设置需要输入管理员密码（取消勾选）
### 6.2、没有加速效果
>本应用仅支持https加速，请务必确认你访问的网站地址是https开头的
>本应用仅支持https加速，请务必确认你访问的网站地址是https开头的
1. 本应用仅支持https加速
1. 本应用仅支持https加速
请务必确认你访问的地址是https开头的
比如： https://github.com/
2. 检查浏览器是否装了什么插件，与ds有冲突
3. 检查是否安装了其他代理软件，与ds有冲突
4. 请确认浏览器的代理设置为使用IE代理/或者使用系统代理状态
6. 可以尝试换个浏览器试试
7. 请确认网络代理设置处于勾选状态
7. 请确认网络代理设置处于勾选状态
正常情况下ds在“系统代理”开关打开时，会自动设置系统代理。
@ -274,51 +276,51 @@ networksetup -setwebproxy 'WiFi' 127.0.0.1 31181
![](./doc/crt-error.png)
一般是证书安装位置不对，重新安装证书后，重启浏览器
#### 1）windows: 请确认证书已正确安装在“信任的根证书颁发机构”下
#### 1）windows: 请确认证书已正确安装在“信任的根证书颁发机构”下
#### 2）mac: 请确认证书已经被安装并已经设置信任。
#### 2）mac: 请确认证书已经被安装并已经设置信任。
#### 3）火狐浏览器：火狐浏览器不走系统的根证书，需要在选项中添加根证书
#### 3）火狐浏览器：火狐浏览器不走系统的根证书，需要在选项中添加根证书
> 1、火狐浏览器->选项->隐私与安全->证书->查看证书
> 2、证书颁发机构->导入
> 3、选择证书文件`C:\Users(用户)\Administrator(你的账号)\.dev-sidecar\dev-sidecar.ca.crt`（Mac或linux为`~/.dev-sidecar`目录）
> 4、勾选信任由此证书颁发机构来标识网站，确定即可
> 1、火狐浏览器->选项->隐私与安全->证书->查看证书
> 2、证书颁发机构->导入
> 3、选择证书文件`C:\Users(用户)\Administrator(你的账号)\.dev-sidecar\dev-sidecar.ca.crt`（Mac或linux为`~/.dev-sidecar`目录）
> 4、勾选信任由此证书颁发机构来标识网站，确定即可
### 6.4、打开github显示连接超时
```html
DevSidecar Warning:
Error: www.github.com:443, 代理请求超时
```
1、检查测速界面github.com是否有ip ，如果没有ip，则可能是由于你的网络提供商封锁了dns服务商的ip（试试能否ping通：1.1.1.1 / 9.9.9.9 ）
2、如果是安全模式，则是因为不稳定导致的，等一会再刷新试试
1、检查测速界面github.com是否有ip ，如果没有ip，则可能是由于你的网络提供商封锁了dns服务商的ip（试试能否ping通：1.1.1.1 / 9.9.9.9 ）
2、如果是安全模式，则是因为不稳定导致的，等一会再刷新试试
3、如果是增强模式，则是由于访问人数过多，正常现象
### 6.5、查看日志是否有报错
如果还是不行，请在下方加作者好友，将服务日志发送给作者进行分析
日志打开方式：加速服务->右边日志按钮->打开日志文件夹
如果还是不行，请在下方加作者好友，将服务日志发送给作者进行分析
日志打开方式：加速服务->右边日志按钮->打开日志文件夹
![](./doc/log.png)
![](./doc/log.png)
### 6.6、某些原本可以打开的网站打不开了
1、可以尝试关闭pac
1、可以尝试关闭pac
2、可以将域名加入白名单
### 6.7、应用意外关闭导致没有网络了
应用开启后会自动修改系统代理设置，正常退出会自动关闭系统代理
应用开启后会自动修改系统代理设置，正常退出会自动关闭系统代理
当应用意外关闭时，可能会因为没有将系统代理恢复，从而导致完全无法上网。
对于此问题有如下几种解决方案可供选择：
1、重新打开应用即可（右键应用托盘图标可完全退出，将会正常关闭系统代理设置）
2、如果应用被卸载了，此时需要[手动关闭系统代理设置](./doc/recover.md)
3、如果你是因为开着ds的情况下重启电脑导致无法上网，你可以设置ds为开机自启
对于此问题有如下几种解决方案可供选择：
1、重新打开应用即可（右键应用托盘图标可完全退出，将会正常关闭系统代理设置）
2、如果应用被卸载了，此时需要[手动关闭系统代理设置](./doc/recover.md)
3、如果你是因为开着ds的情况下重启电脑导致无法上网，你可以设置ds为开机自启
### 6.8、卸载应用后上不了网，git请求不了
如果你在卸载应用前，没有正常退出app，就有可能无法上网。请按如下步骤操作恢复您的网络：
1、关闭系统代理设置，参见：[手动关闭系统代理设置](./doc/recover.md)
1、关闭系统代理设置，参见：[手动关闭系统代理设置](./doc/recover.md)
2、执行下面的命令关闭git的代理设置（如果你开启过 `Git.exe代理` 的开关）
```shell
git config --global --unset http.proxy
@ -362,7 +364,7 @@ cnpm install -g lerna@6
# 拉取代码
git clone https://github.com/docmirror/dev-sidecar
cd dev-sidecar
cd dev-sidecar
# 注意不要使用 `npm install` 来安装依赖，因为 `lerna bootstrap` 会自动安装依赖
lerna bootstrap
@ -405,19 +407,17 @@ npm run electron:build
* [trident-sync](https://github.com/handsfree-work/trident-sync) : 二次开发项目同步升级工具
## 十一、感谢
本项目使用lerna包管理工具
本项目使用lerna包管理工具
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
本项目参考如下开源项目
* [node-mitmproxy](https://github.com/wuchangming/node-mitmproxy)
* [node-mitmproxy](https://github.com/wuchangming/node-mitmproxy)
* [ReplaceGoogleCDN](https://github.com/justjavac/ReplaceGoogleCDN)
特别感谢
* [github增强油猴脚本](https://greasyfork.org/zh-CN/scripts/412245-github-%E5%A2%9E%E5%BC%BA-%E9%AB%98%E9%80%9F%E4%B8%8B%E8%BD%BD) 本项目部分加速功能完全复制该脚本。
* [中国域名白名单](https://github.com/pluwen/china-domain-allowlist)，本项目的系统代理排除域名功能中，使用了该白名单。
本项目部分加速资源由如下组织提供
* [FastGit UK](https://fastgit.org/)

Write Preview
Loading…
Cancel
Save