{"id":13459124,"url":"https://github.com/docmirror/dev-sidecar","last_synced_at":"2025-05-13T15:09:09.008Z","repository":{"id":37313043,"uuid":"299584778","full_name":"docmirror/dev-sidecar","owner":"docmirror","description":"开发者边车，github打不开，github加速，git clone加速，git release下载加速，stackoverflow加速","archived":false,"fork":false,"pushed_at":"2025-04-29T09:20:18.000Z","size":10411,"stargazers_count":17828,"open_issues_count":33,"forks_count":2173,"subscribers_count":120,"default_branch":"master","last_synced_at":"2025-05-06T14:53:26.159Z","etag":null,"topics":["dev-sidecar","dns-ip","electron","fastgit","fastgithub","gfw","internet","lerna","mitmproxy","proxy"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docmirror.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-09-29T10:38:20.000Z","updated_at":"2025-05-06T14:02:04.000Z","dependencies_parsed_at":"2023-02-16T15:31:17.455Z","dependency_job_id":"9229e17a-d429-49ad-94dc-e708ecd8f344","html_url":"https://github.com/docmirror/dev-sidecar","commit_stats":{"total_commits":1071,"total_committers":10,"mean_commits":107.1,"dds":0.5060690943043884,"last_synced_commit":"3b7d0dd280b8096978bc101c1f595c354df98ee6"},"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docmirror%2Fdev-sidecar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docmirror%2Fdev-sidecar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docmirror%2Fdev-sidecar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docmirror%2Fdev-sidecar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docmirror","download_url":"https://codeload.github.com/docmirror/dev-sidecar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253588693,"owners_count":21932308,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dev-sidecar","dns-ip","electron","fastgit","fastgithub","gfw","internet","lerna","mitmproxy","proxy"],"created_at":"2024-07-31T09:01:05.286Z","updated_at":"2025-05-13T15:09:03.983Z","avatar_url":"https://github.com/docmirror.png","language":"JavaScript","readme":"# dev-sidecar\n\n开发者边车，命名取自service-mesh的service-sidecar，意为为开发者打辅助的边车工具（以下简称ds）\n通过本地代理的方式将https请求代理到一些国内的加速通道上\n\n\u003ca href='https://github.com/docmirror/dev-sidecar'\u003e\u003cimg alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/docmirror/dev-sidecar?logo=github\"\u003e\u003c/a\u003e\n\n\u003e Gitee上的同步项目已被封禁，此项目将不再更新与维护 【狗头保命】\n\u003e\n\u003e 我将继续奋战在开源一线，为社区贡献更多更好的开源项目。\n\u003e 感兴趣的可以关注我的主页 [【github】](https://github.com/greper) [【gitee】](https://gitee.com/greper)\n\n## 打个广告\n\n\u003e [https://github.com/certd/certd](https://github.com/certd/certd)\n\u003e 我的开源证书管理工具项目，全自动申请和部署证书，有需求的可以去试试，帮忙点个star\n\n## 重要提醒\n\n\u003e ------------------------------重要提醒1---------------------------------\n\u003e\n\u003e 注意：由于electron无法监听windows的关机事件，开着ds情况下直接重启电脑，会导致无法上网，你可以手动启动ds即可恢复网络，你也可以将ds设置为开机自启。\n\u003e\n\u003e 关于此问题的更多讨论请前往：[https://github.com/docmirror/dev-sidecar/issues/109](https://github.com/docmirror/dev-sidecar/issues/109)\n\u003e\n\u003e 注：此问题已在 `1.8.9` 版本中得到解决。\n\n\u003e ------------------------------重要提醒2---------------------------------\n\u003e\n\u003e 注意：本应用启动会自动修改系统代理，所以会与其他代理软件有冲突，请务必不要一起使用。\n\u003e 本应用主要目的在于直连访问github，如果你已经有飞机了，那建议还是不要用这个自行车（ds）了\n\n## 一、 特性\n\n### 1.1、 dns优选（解决\\*\\*\\*污染问题）\n\n- 根据网络状况智能解析最佳域名ip地址，获取最佳网络速度\n- 解决一些网站和库无法访问或访问速度慢的问题\n- 建议遇到打开比较慢的国外网站，可以优先尝试将该域名添加到dns设置中（注意：被\\*\\*\\*封杀的无效）\n\n### 1.2、 请求拦截\n\n- 拦截打不开的网站，代理到加速镜像站点上去。\n- 可配置多个镜像站作为备份\n- 具备测速机制，当访问失败或超时之后，自动切换到备用站点，使得目标服务高可用\n\n### 1.3、 github加速\n\n- github 直连加速 (通过修改sni实现，感谢 [fastGithub](https://github.com/dotnetcore/FastGithub) 提供的思路)\n- release、source、zip下载加速\n- clone 加速\n- 头像加速\n- 解决readme中图片引用无法加载的问题\n- gist.github.com 加速\n- 解决git push 偶尔失败需要输入账号密码的问题（fatal: TaskCanceledException encountered / fatal: HttpRequestException encountered）\n- raw/blame加速\n\n\u003e 以上部分功能通过 `X.I.U` 的油猴脚本实现， 以下是仓库和脚本下载链接，大家可以去支持一下。\n\u003e\n\u003e - [https://github.com/XIU2/UserScript](https://github.com/XIU2/UserScript)\n\u003e - [https://greasyfork.org/scripts/412245](https://greasyfork.org/scripts/412245)\n\u003e\n\u003e 由于此脚本在ds中是打包在本地的，更新会不及时，你可以直接通过浏览器安装油猴插件使用此脚本，从而获得最新更新（ds本地的可以通过 `加速服务-\u003e基本设置-\u003e启用脚本` 进行关闭）。\n\n### 1.4、 Stack Overflow 加速\n\n- 将ajax.google.com代理到加速CDN上\n- recaptcha 图片验证码加速\n\n### 1.5、 npm加速\n\n- 支持开启npm代理\n- 官方与淘宝npm registry一键切换\n- 某些npm install的时候，并且使用cnpm也无法安装时，可以尝试开启npm代理再试\n\n**_安全警告_**：\n\n- 请勿使用来源不明的服务地址，有隐私和账号泄露风险\n- 本应用及服务端承诺不收集任何信息。介意者请使用安全模式。\n\n## 二、快速开始\n\n支持windows、Mac、Linux(Ubuntu)\n\n### 2.1、DevSidecar桌面应用\n\n#### 1）下载安装包\n\n- release下载\n  [Github Release](https://github.com/docmirror/dev-sidecar/releases)\n\n\u003e Windows: 请选择DevSidecar-x.x.x.exe\n\u003e Mac: 请选择DevSidecar-x.x.x.dmg\n\u003e Ubuntu: 请选择DevSidecar-x.x.x.deb\n\u003e 其他linux: 请选择DevSidecar-x.x.x.AppImage (未做测试，不保证能用)\n\n\u003e linux安装说明请参考 [linux安装文档](./doc/linux.md)\n\n\u003e 注意：由于没有买应用证书，所以应用在下载安装时会有“未知发行者”等安全提示，选择保留即可。\n\n#### 2）安装后打开\n\n\u003e 注意：mac版安装需要在“系统偏好设置-\u003e安全性与隐私-\u003e通用”中解锁并允许应用安装\n\n![](./doc/index.png)\n\n#### 3）安装根证书\n\n第一次打开会提示安装证书，根据提示操作即可\n\n更多有关根证书的说明，请参考 [为什么要安装根证书?](./doc/caroot.md)\n\n\u003e 根证书是本地随机生成的，所以不用担心根证书的安全问题（本应用不收集任何用户信息）\n\u003e 你也可以在加速服务设置中自定义根证书（PEM格式的证书与私钥）\n\n\u003e 火狐浏览器需要[手动安装证书](#3浏览器打开提示证书不受信任)\n\n#### 4）开始加速吧\n\n去试试打开github\n\n### 2.2、开启前 vs 开启后\n\n|          | 开启前                         | 开启后                                            |\n| -------- | ------------------------------ | ------------------------------------------------- |\n| 头像     | ![](./doc/avatar2.png)         | ![](./doc/avatar1.png)                            |\n| clone    | ![](./doc/clone-before.png)    | ![](./doc/clone.png)                              |\n| zip 下载 | ![](./doc/download-before.png) | ![](./doc/download.png)秒下的，实在截不到速度的图 |\n\n## 三、模式说明\n\n### 3.1、安全模式\n\n- 此模式：关闭拦截、关闭增强、开启dns优选、开启测速\n- 最安全，无需安装证书，可以在浏览器地址栏左侧查看域名证书\n- 功能也最弱，只有特性1，相当于查询github的国外ip，手动改hosts一个意思。\n- github的可访问性不稳定，取决于IP测速，如果有绿色ip存在，就 `有可能` 可以直连访问。\n  ![](./doc/speed.png)\n\n### 3.2、默认模式\n\n- 此模式：开启拦截、关闭增强、开启dns优选、开启测速\n- 需要安装证书，通过修改sni直连访问github\n- 功能上包含特性1/2/3/4。\n\n## 四、 最佳实践\n\n- 把dev-sidecar一直开着就行了（注意windows下开着ds重启电脑，会无法上网，重新打开ds即可。）\n- 建议遇到打开比较慢的国外网站，可以尝试将该域名添加到dns设置中（注意：被\\*\\*\\*封杀的无效）\n\n### 其他加速\n\n#### 1）git clone 加速\n\n- 方式1：快捷复制：\n\n  \u003e 开启脚本支持，然后在复制clone链接下方，即可复制到加速链接\n\n- 方式2：\n\n  \u003e 1. 使用方式：用实际的名称替换 `{}` 的内容，即可加速clone [https://hub.fastgit.org/{username}/{reponame}.git](https://hub.fastgit.org/%7Busername%7D/%7Breponame%7D.git)\n  \u003e 2. clone 出来的 remote \"origin\" 为fastgit的地址，需要手动改回来\n  \u003e 3. 你也可以直接使用他们的clone加速工具 [fgit-go](https://github.com/FastGitORG/fgit-go)\n\n#### 2）`github.com` 的镜像网站（注意：部分镜像网站不能登录）\n\n\u003e 1. [hub.fastgit.org](https://hub.fastgit.org/) （2024/11/18：这个好像失效了？）\n\u003e 2. [github.com.cnpmjs.org](https://github.com.cnpmjs.org/) 这个很容易超限（2024/11/18：这个好像失效了？）\n\u003e 3. [dgithub.xyz](https://dgithub.xyz/)\n\n## 五、api\n\n### 5.1、拦截配置\n\n没有配置域名的不会拦截，其他根据配置进行拦截处理\n\n```js\nconst intercepts = {\n  // 要拦截的域名\n  'github.com': {\n    // 需要拦截url的正则表达式\n    '/.*/.*/releases/download/': {\n      // 拦截类型\n      // redirect: url,          // 临时重定向（url会变，一些下载资源可以通过此方式配置）\n      // proxy: url,             // 代理（url不会变，没有跨域问题）\n      // abort: true,            // 取消请求（适用于被***封锁的资源，找不到替代，直接取消请求，快速失败，节省时间）\n      // success: true,          // 直接返回成功请求（某些请求不想发出去，可以伪装成功返回）\n      // cacheDays: 1,           // GET请求的使用缓存，单位：天（常用于一些静态资源）\n      // options: true,          // OPTIONS请求直接返回成功请求（该功能存在一定风险，请谨慎使用）\n      // optionsMaxAge: 2592000, // OPTIONS请求缓存时间，默认：2592000（一个月）\n      redirect: 'download.fastgit.org'\n    },\n    '.*': {\n      proxy: 'github.com',\n      sni: 'baidu.com' // 修改sni，规避***握手拦截\n    }\n  },\n  'ajax.googleapis.com': {\n    '.*': {\n      proxy: 'ajax.loli.net', // 代理请求，url不会变\n      backup: ['ajax.proxy.ustclug.org'], // 备份，当前代理请求失败后，将会切换到备用地址\n      test: 'ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js',\n      replace: '/(.*)/xxx'// 当加速地址的链接和原链接不是完全相同时，可以通过正则表达式replace，此时proxy通过$1$2来重组url， proxy:'ajax.loli.net/xxx/$1'\n    }\n  },\n  'clients*.google.com': {\n    '.*': {\n      abort: true // 取消请求，被***封锁的资源，找不到替代，直接取消请求，快速失败，节省时间\n    }\n  }\n}\n```\n\n### 5.2、DNS优选配置\n\n某些域名解析出来的ip会无法访问，（比如api.github.com会被解析到新加坡的ip上，新加坡的服务器在上午挺好，到了晚上就卡死，基本不可用）\n通过从dns上获取ip列表，切换不同的ip进行尝试，最终会挑选到一个最快的ip\n\n```json\n{\n  \"dns\": {\n    \"mapping\": {\n      \"api.github.com\": \"cloudflare\", // \"解决push的时候需要输入密码的问题\",\n      \"gist.github.com\": \"cloudflare\", // 解决gist无法访问的问题\n      \"*.githubusercontent.com\": \"cloudflare\" // 解决github头像经常下载不到的问题\n    }\n  }\n}\n```\n\n注意：暂时只支持IPv4的解析\n\n## 六、问题排查\n\n### 6.1、dev-sidecar的前两个开关没有处于打开状态\n\n1. 尝试将开关按钮手动打开\n2. 请尝试右键dev-sidecar图标，点退出。再重新打开\n3. 如果还不行，请将日志发送给作者\n\n如果是mac系统，可能是下面的原因\n\n#### 1）Mac系统使用时，首页的系统代理开关无法打开\n\n出现这个问题可能是没有开启系统代理命令的执行权限\n\n```\nnetworksetup -setwebproxy 'WiFi' 127.0.0.1 31181\n#看是否有如下错误提示\n** Error: Command requires admin privileges.\n```\n\n如果有上面的错误提示，请尝试如下方法：\n\n\u003e 取消访问偏好设置需要管理员密码\n\u003e 系统偏好设置—\u003e安全性与隐私—\u003e 通用—\u003e 高级—\u003e 访问系统范围的偏好设置需要输入管理员密码（取消勾选）\n\n### 6.2、没有加速效果\n\n\u003e 本应用仅支持https加速，请务必确认你访问的网站地址是https开头的\n\n1. 本应用仅支持https加速\n   请务必确认你访问的地址是https开头的\n   比如： [https://github.com/](https://github.com/)\n2. 检查浏览器是否装了什么插件，与ds有冲突\n3. 检查是否安装了其他代理软件，与ds有冲突\n4. 请确认浏览器的代理设置为使用IE代理/或者使用系统代理状态\n5. 可以尝试换个浏览器试试\n6. 请确认网络代理设置处于勾选状态\n   正常情况下ds在“系统代理”开关打开时，会自动设置系统代理。\n\n### 6.3、浏览器打开提示证书不受信任\n\n![](./doc/crt-error.png)\n一般是证书安装位置不对，重新安装证书后，重启浏览器\n\n#### 1）windows: 请确认证书已正确安装在“信任的根证书颁发机构”下\n\n#### 2）mac: 请确认证书已经被安装并已经设置信任\n\n#### 3）火狐浏览器：火狐浏览器不走系统的根证书，需要在选项中添加根证书\n\n1. 火狐浏览器-\u003e选项-\u003e隐私与安全-\u003e证书-\u003e查看证书\n2. 证书颁发机构-\u003e导入\n3. 选择证书文件 `C:\\Users(用户)\\Administrator(你的账号)\\.dev-sidecar\\dev-sidecar.ca.crt`（Mac或linux为 `~/.dev-sidecar` 目录）\n4. 勾选信任由此证书颁发机构来标识网站，确定即可\n\n### 6.4、打开github显示连接超时\n\n```html\nDevSidecar Warning: Error: www.github.com:443, 代理请求超时\n```\n\n1. 检查测速界面github.com是否有ip ，如果没有ip，则可能是由于你的网络提供商封锁了dns服务商的ip（试试能否ping通：1.1.1.1 / 9.9.9.9 ）\n2. 如果是安全模式，则是因为不稳定导致的，等一会再刷新试试\n3. 如果是增强模式，则是由于访问人数过多，正常现象\n\n### 6.5、查看日志是否有报错\n\n如果还是不行，请在下方加作者好友，将服务日志发送给作者进行分析\n日志打开方式：加速服务-\u003e右边日志按钮-\u003e打开日志文件夹\n\n![](./doc/log.png)\n\n### 6.6、某些原本可以打开的网站打不开了\n\n1. 可以尝试关闭pac\n2. 可以将域名加入白名单\n\n### 6.7、应用意外关闭导致没有网络了\n\n应用开启后会自动修改系统代理设置，正常退出会自动关闭系统代理\n当应用意外关闭时，可能会因为没有将系统代理恢复，从而导致完全无法上网。\n\n对于此问题有如下几种解决方案可供选择：\n\n1. 重新打开应用即可（右键应用托盘图标可完全退出，将会正常关闭系统代理设置）\n2. 如果应用被卸载了，此时需要[手动关闭系统代理设置](./doc/recover.md)\n3. 如果你是因为开着ds的情况下重启电脑导致无法上网，你可以设置ds为开机自启\n\n### 6.8、卸载应用后上不了网，git请求不了\n\n如果你在卸载应用前，没有正常退出app，就有可能无法上网。请按如下步骤操作恢复您的网络：\n\n1、关闭系统代理设置，参见：[手动关闭系统代理设置](./doc/recover.md)\n2、执行下面的命令关闭git的代理设置（如果你开启过 `Git.exe代理` 的开关）\n\n```shell\ngit config --global --unset http.proxy\ngit config --global --unset https.proxy\ngit config --global --unset http.sslVerify\n```\n\n3、执行下面的命令关闭npm的代理设置（如果你开启过npm加速的开关）\n\n```shell\nnpm config delete proxy\nnpm config delete https-proxy\n```\n\n## 七、在其他程序使用\n\n- [java程序使用](./doc/other.md#Java程序使用)\n\n## 八、贡献代码\n\n### 8.1、准备环境\n\n#### 1）安装 `nodejs`\n\n推荐安装 nodejs `22.x.x` 的版本，其他版本未做测试\n\n#### 2）安装 `pnpm`\n\n运行如下命令即可安装所需依赖：\n\n```shell\nnpm install -g pnpm --registry=https://registry.npmmirror.com\n\n```\n\n### 8.2、开发调试模式启动\n\n运行如下命令即可开发模式启动\n\n```shell\n# 拉取代码\ngit clone https://github.com/docmirror/dev-sidecar\n\ncd dev-sidecar\n\n# 注意不要使用 `npm install` 来安装依赖，因为 `pnpm` 会自动安装依赖\npnpm install\n\n# 运行DevSidecar\ncd packages/gui\nnpm run electron\n\n```\n\n\u003e 如果electron依赖包下载不动，可以开启ds的npm加速\n\n### 8.3、打包成可执行文件\n\n```shell\n# 先执行上面的步骤，然后运行如下命令打包成可执行文件\nnpm run electron:build\n```\n\n### 8.4、提交pr\n\n如果你想将你的修改贡献出来，请提交pr\n\n## 九、联系作者\n\n欢迎bug反馈，需求建议，技术交流等\n\n1、 加群（请备注dev-sidecar，或简称DS）\n\n- QQ 1群：390691483，人数：500 / 500（满）\n- QQ 2群：[667666069](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027\u0026k=n4nksr4sji93vZtD5e8YEHRT6qbh6VyQ\u0026authKey=XKBZnzmoiJrAFyOT4V%2BCrgX5c13ds59b84g%2FVRhXAIQd%2FlAiilsuwDRGWJct%2B570\u0026noverify=0\u0026group_code=667666069)，人数：447 / 500\n- QQ 3群：419807815，人数：500 / 500（满）\n- QQ 4群：[438148299](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027\u0026k=i_NCBB5f_Bkm2JsEV1tLs2TkQ79UlCID\u0026authKey=nMsVJbJ6P%2FGNO7Q6vsVUadXRKnULUURwR8zvUZJnP3IgzhHYPhYdcBCHvoOh8vYr\u0026noverify=0\u0026group_code=438148299)，人数：203 / 1000\n- QQ 5群：[767622917](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027\u0026k=nAWi_Rxj7mM4Unp5LMiatmUWhGimtbcB\u0026authKey=aswmlWGjbt3GIWXtvjB2GJqqAKuv7hWjk6UBs3MTb%2Biyvr%2Fsbb1kA9CjF6sK7Hgg\u0026noverify=0\u0026group_code=767622917)，人数：016 / 200（new）\n\n## 十、求star\n\n我的其他项目求star\n\n- [fast-crud](https://github.com/fast-crud/fast-crud) : 开发crud快如闪电\n- [certd](https://github.com/certd/certd) : 让你的证书永不过期\n- [trident-sync](https://github.com/handsfree-work/trident-sync) : 二次开发项目同步升级工具\n\n## 十一、感谢\n\n本项目使用lerna包管理工具\n\n[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)\n\n本项目参考如下开源项目\n\n- [node-mitmproxy](https://github.com/wuchangming/node-mitmproxy)\n- [ReplaceGoogleCDN](https://github.com/justjavac/ReplaceGoogleCDN)\n\n特别感谢\n\n- [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) 本项目部分加速功能完全复制该脚本。\n- [中国域名白名单](https://github.com/pluwen/china-domain-allowlist)，本项目的系统代理排除域名功能中，使用了该白名单。\n\n本项目部分加速资源由如下组织提供\n\n- [FastGit UK](https://fastgit.org/)\n","funding_links":[],"categories":["JavaScript","其他"],"sub_categories":["网络服务_其他"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocmirror%2Fdev-sidecar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocmirror%2Fdev-sidecar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocmirror%2Fdev-sidecar/lists"}