dev-sidecar

开发者边车，命名取自 service-mesh 的 service-sidecar，意为为开发者打辅助的边车工具（以下简称 ds）
通过本地代理的方式将 https 请求代理到一些国内的加速通道上

重要提醒

------------------------------ 重要提醒 1 ---------------------------------

注意：由于 electron 无法监听 windows 的关机事件，开着 ds 情况下直接重启电脑，会导致无法上网，你可以手动启动 ds 即可恢复网络，你也可以将 ds 设置为开机自启。

关于此问题的更多讨论请前往：
https://github.com/docmirror/dev-sidecar/issues/109

------------------------------ 重要提醒 2 ---------------------------------

注意：本应用启动会自动修改系统代理，所以会与其他代理软件有冲突，请务必不要一起使用。
本应用主要目的在于直连访问 github，如果你已经有飞机了，那建议还是不要用这个自行车（ds）了

一、特性

1.1、dns 优选（解决 *** 污染问题）

根据网络状况智能解析最佳域名 ip 地址，获取最佳网络速度
解决一些网站和库无法访问或访问速度慢的问题
建议遇到打开比较慢的国外网站，可以优先尝试将该域名添加到 dns 设置中（注意：被 *** 封杀的无效）

1.2、请求拦截

拦截打不开的网站，代理到加速镜像站点上去。
可配置多个镜像站作为备份
具备测速机制，当访问失败或超时之后，自动切换到备用站点，使得目标服务高可用

1.3、github 加速

github 直连加速 (通过修改 sni 实现，感谢 fastGithub 提供的思路)
release、source、zip 下载加速
clone 加速
头像加速
解决 readme 中图片引用无法加载的问题
gist.github.com 加速
解决 git push 偶尔失败需要输入账号密码的问题（fatal: TaskCanceledException encountered / fatal: HttpRequestException encountered）
raw/blame 加速

以上部分功能通过 X.I.U 的油猴脚本实现，以下是仓库和脚本下载链接，大家可以去支持一下。

https://github.com/XIU2/UserScript

https://greasyfork.org/scripts/412245

由于此脚本在 ds 中是打包在本地的，更新会不及时，你可以直接通过浏览器安装油猴插件使用此脚本，从而获得最新更新（ds 本地的可以通过 加速服务 -> 基本设置 -> 启用脚本 进行关闭）。

1.4、Stack Overflow 加速

将 ajax.google.com 代理到加速 CDN 上
recaptcha 图片验证码加速

1.5、npm 加速

支持开启 npm 代理
官方与淘宝 npm registry 一键切换,
某些 npm install 的时候，并且使用 cnpm 也无法安装时，可以尝试开启 npm 代理再试

安全警告：

请勿使用来源不明的服务地址，有隐私和账号泄露风险
本应用及服务端承诺不收集任何信息。介意者请使用安全模式。

二、快速开始

支持 windows、Mac、Linux(Ubuntu)

2.1、DevSidecar 桌面应用

1）下载安装包

release 下载
Github Release

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 安装文档

注意：由于没有买应用证书，所以应用在下载安装时会有“未知发行者”等安全提示，选择保留即可。

2）安装后打开

注意：mac 版安装需要在“系统偏好设置 -> 安全性与隐私 -> 通用”中解锁并允许应用安装

3）安装根证书

第一次打开会提示安装证书，根据提示操作即可

更多有关根证书的说明，请参考为什么要安装根证书?

根证书是本地随机生成的，所以不用担心根证书的安全问题（本应用不收集任何用户信息）
你也可以在加速服务设置中自定义根证书（PEM 格式的证书与私钥）

火狐浏览器需要手动安装证书

4）开始加速吧

去试试打开 github

2.2、开启前 vs 开启后

	开启前	开启后
头像
clone
zip 下载		秒下的，实在截不到速度的图

三、模式说明

3.1、安全模式

此模式：关闭拦截、关闭增强、开启 dns 优选、开启测速
最安全，无需安装证书，可以在浏览器地址栏左侧查看域名证书
功能也最弱，只有特性 1，相当于查询 github 的国外 ip，手动改 hosts 一个意思。
github 的可访问性不稳定，取决于 IP 测速，如果有绿色 ip 存在，就 有可能 可以直连访问。

3.2、默认模式

此模式：开启拦截、关闭增强、开启 dns 优选、开启测速
需要安装证书，通过修改 sni 直连访问 github
功能上包含特性 1 /2/3/4。

四、最佳实践

把 dev-sidecar 一直开着就行了（注意 windows 下开着 ds 重启电脑，会无法上网，重新打开 ds 即可。）
建议遇到打开比较慢的国外网站，可以尝试将该域名添加到 dns 设置中（注意：被 *** 封杀的无效）

其他加速

1）git clone 加速

方式 1：快捷复制：

开启脚本支持，然后在复制 clone 链接下方，即可复制到加速链接

方式 2：

使用方式用实际的名称替换 {} 的内容，即可加速 clone
https://hub.fastgit.org/{username}/{reponame}.git
clone 出来的 remote "origin" 为 fastgit 的地址，需要手动改回来
你也可以直接使用他们的 clone 加速工具 fgit-go

2）github.com 的镜像网站(注意：不能登录)

hub.fastgit.org

github.com.cnpmjs.org 这个很容易超限

五、api

5.1、拦截配置

没有配置域名的不会拦截，其他根据配置进行拦截处理

const intercepts = {
  // 要拦截的域名
  'github.com': {
    // 需要拦截 url 的正则表达式
    '/.*/.*/releases/download/': {
      // 拦截类型
      // redirect: url,          // 临时重定向（url 会变，一些下载资源可以通过此方式配置）// proxy: url,             // 代理（url 不会变，没有跨域问题）// abort: true,            // 取消请求（适用于被 *** 封锁的资源，找不到替代，直接取消请求，快速失败，节省时间）// success: true,          // 直接返回成功请求（某些请求不想发出去，可以伪装成功返回）// cacheDays: 1,           // GET 请求的使用缓存，单位：天（常用于一些静态资源）// options: true,          // OPTIONS 请求直接返回成功请求（该功能存在一定风险，请谨慎使用）// optionsMaxAge: 2592000, // OPTIONS 请求缓存时间，默认：2592000（一个月）redirect: 'download.fastgit.org'
    },
    '.*': {
      proxy: 'github.com',
      sni: 'baidu.com' // 修改 sni，规避 *** 握手拦截
    }
  },
  'ajax.googleapis.com': {
    '.*': {
      proxy: 'ajax.loli.net', // 代理请求，url 不会变
      backup: ['ajax.proxy.ustclug.org'], // 备份，当前代理请求失败后，将会切换到备用地址
      test: 'ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js',
      replace: '/(.*)/xxx'// 当加速地址的链接和原链接不是完全相同时，可以通过正则表达式 replace，此时 proxy 通过 $1$2 来重组 url，proxy:'ajax.loli.net/xxx/$1'
    }
  },
  'clients*.google.com': {
    '.*': {abort: true // 取消请求，被 *** 封锁的资源，找不到替代，直接取消请求，快速失败，节省时间}
  }
}

5.2、DNS 优选配置

某些域名解析出来的 ip 会无法访问，（比如 api.github.com 会被解析到新加坡的 ip 上，新加坡的服务器在上午挺好，到了晚上就卡死，基本不可用）
通过从 dns 上获取 ip 列表，切换不同的 ip 进行尝试，最终会挑选到一个最快的 ip

{
  "dns": {
    "mapping": {
      "api.github.com": "cloudflare", // " 解决 push 的时候需要输入密码的问题 ",
      "gist.github.com": "cloudflare", // 解决 gist 无法访问的问题
      "*.githubusercontent.com": "cloudflare" // 解决 github 头像经常下载不到的问题
    }
  }
}

注意：暂时只支持 IPv4 的解析

六、问题排查

6.1、dev-sidecar 的前两个开关没有处于打开状态

尝试将开关按钮手动打开
请尝试右键 dev-sidecar 图标，点退出。再重新打开
如果还不行，请将日志发送给作者

如果是 mac 系统，可能是下面的原因

1）Mac 系统使用时，首页的系统代理开关无法打开

出现这个问题可能是没有开启系统代理命令的执行权限

networksetup -setwebproxy 'WiFi' 127.0.0.1 31181
#看是否有如下错误提示
** Error: Command requires admin privileges.

如果有上面的错误提示，请尝试如下方法：

取消访问偏好设置需要管理员密码
系统偏好设置—> 安全性与隐私—> 通用—> 高级—> 访问系统范围的偏好设置需要输入管理员密码（取消勾选）

6.2、没有加速效果

本应用仅支持 https 加速，请务必确认你访问的网站地址是 https 开头的

本应用仅支持 https 加速
请务必确认你访问的地址是 https 开头的
比如：https://github.com/
检查浏览器是否装了什么插件，与 ds 有冲突
检查是否安装了其他代理软件，与 ds 有冲突
请确认浏览器的代理设置为使用 IE 代理 / 或者使用系统代理状态
可以尝试换个浏览器试试
请确认网络代理设置处于勾选状态
正常情况下 ds 在“系统代理”开关打开时，会自动设置系统代理。

6.3、浏览器打开提示证书不受信任

一般是证书安装位置不对，重新安装证书后，重启浏览器

1）windows: 请确认证书已正确安装在“信任的根证书颁发机构”下

2）mac: 请确认证书已经被安装并已经设置信任

3）火狐浏览器：火狐浏览器不走系统的根证书，需要在选项中添加根证书

1、火狐浏览器 -> 选项 -> 隐私与安全 -> 证书 -> 查看证书
2、证书颁发机构 -> 导入
3、选择证书文件 C:\Users(用户)\Administrator(你的账号)\.dev-sidecar\dev-sidecar.ca.crt（Mac 或 linux 为~/.dev-sidecar 目录）
4、勾选信任由此证书颁发机构来标识网站，确定即可

6.4、打开 github 显示连接超时

DevSidecar Warning:
Error: www.github.com:443, 代理请求超时

1、检查测速界面 github.com 是否有 ip，如果没有 ip，则可能是由于你的网络提供商封锁了 dns 服务商的 ip（试试能否 ping 通：1.1.1.1 / 9.9.9.9）
2、如果是安全模式，则是因为不稳定导致的，等一会再刷新试试
3、如果是增强模式，则是由于访问人数过多，正常现象

6.5、查看日志是否有报错

如果还是不行，请在下方加作者好友，将服务日志发送给作者进行分析
日志打开方式：加速服务 -> 右边日志按钮 -> 打开日志文件夹

6.6、某些原本可以打开的网站打不开了

1、可以尝试关闭 pac
2、可以将域名加入白名单

6.7、应用意外关闭导致没有网络了

应用开启后会自动修改系统代理设置，正常退出会自动关闭系统代理
当应用意外关闭时，可能会因为没有将系统代理恢复，从而导致完全无法上网。

对于此问题有如下几种解决方案可供选择：
1、重新打开应用即可（右键应用托盘图标可完全退出，将会正常关闭系统代理设置）
2、如果应用被卸载了，此时需要手动关闭系统代理设置
3、如果你是因为开着 ds 的情况下重启电脑导致无法上网，你可以设置 ds 为开机自启

6.8、卸载应用后上不了网，git 请求不了

如果你在卸载应用前，没有正常退出 app，就有可能无法上网。请按如下步骤操作恢复您的网络：

1、关闭系统代理设置，参见：手动关闭系统代理设置
2、执行下面的命令关闭 git 的代理设置（如果你开启过 Git.exe 代理 的开关）

git config --global --unset http.proxy
git config --global --unset https.proxy
git config --global --unset http.sslVerify

3、执行下面的命令关闭 npm 的代理设置（如果你开启过 npm 加速的开关）

npm config delete proxy
npm config delete https-proxy

七、在其他程序使用

java 程序使用

八、贡献代码

8.1、准备环境

1）安装 `nodejs`

推荐安装 nodejs 16.x.x 的版本，其他版本未做测试

2）安装 `lerna`

运行如下命令即可安装所需依赖：

注：lerna 指定为 6.x 版本，更高版本会导致打包失败（不兼容导致）

npm install -g cnpm --registry=https://registry.npmmirror.com

cnpm install -g lerna@6

8.2、开发调试模式启动

运行如下命令即可开发模式启动

# 拉取代码
git clone https://github.com/docmirror/dev-sidecar

cd dev-sidecar

# 注意不要使用 `npm install` 来安装依赖，因为 `lerna bootstrap` 会自动安装依赖
lerna bootstrap
# 如果 `lerna bootstrap` 有报错，可以尝试执行如下两行命令，用 yarn 替换掉 npm：#cnpm install -g yarn
#lerna bootstrap --npm-client=yarn

# 运行 DevSidecar
cd packages/gui
npm run electron

如果 electron 依赖包下载不动，可以开启 ds 的 npm 加速

8.3、打包成可执行文件

# 先执行上面的步骤，然后运行如下命令打包成可执行文件
npm run electron:build

本项目参考如下开源项目

特别感谢

github 增强油猴脚本本项目部分加速功能完全复制该脚本。
中国域名白名单，本项目的系统代理排除域名功能中，使用了该白名单。

本项目部分加速资源由如下组织提供

FastGit UK

下载

文件名称：DevSidecar-1.8.9-node16.zip

文件大小：65.7MB

下载声明：本站部分资源来自于网络收集，若侵犯了你的隐私或版权，请及时联系我们删除有关信息。

下载地址：https://pan.quark.cn/s/038a7286b14

提取码：

此处含有隐藏内容，请提交评论并审核通过刷新后即可查看！

Github加速访问工具：Dev-Sidecar

dev-sidecar

重要提醒

一、特性

1.1、dns 优选（解决 *** 污染问题）

1.2、请求拦截

1.3、github 加速

1.4、Stack Overflow 加速

1.5、npm 加速

二、快速开始

2.1、DevSidecar 桌面应用

1）下载安装包

2）安装后打开

3）安装根证书

4）开始加速吧

2.2、开启前 vs 开启后

三、模式说明

3.1、安全模式

3.2、默认模式

四、最佳实践

其他加速

1）git clone 加速

2）github.com 的镜像网站(注意：不能登录)

五、api

5.1、拦截配置

5.2、DNS 优选配置

六、问题排查

6.1、dev-sidecar 的前两个开关没有处于打开状态

1）Mac 系统使用时，首页的系统代理开关无法打开

6.2、没有加速效果

6.3、浏览器打开提示证书不受信任

1）windows: 请确认证书已正确安装在“信任的根证书颁发机构”下

2）mac: 请确认证书已经被安装并已经设置信任

3）火狐浏览器：火狐浏览器不走系统的根证书，需要在选项中添加根证书

6.4、打开 github 显示连接超时

6.5、查看日志是否有报错

6.6、某些原本可以打开的网站打不开了

6.7、应用意外关闭导致没有网络了

6.8、卸载应用后上不了网，git 请求不了

七、在其他程序使用

八、贡献代码

8.1、准备环境

1）安装 nodejs

2）安装 lerna

8.2、开发调试模式启动

8.3、打包成可执行文件

下载

1）安装 `nodejs`

2）安装 `lerna`