![\"GitHub](\"https://img.shields.io/github/stars/docmirror/dev-sidecar?logo=github\")
\n\n[](https://www.star-history.com/#docmirror/dev-sidecar&type=date&legend=top-left)\n\n> Gitee上的同步项目已被封禁，请认准本项目唯一官方仓库地址[https://github.com/docmirror/dev-sidecar](https://github.com/docmirror/dev-sidecar) 【狗头保命】\n>\n> 我将继续奋战在开源一线，为社区贡献更多更好的开源项目。\n> \n> 感兴趣的可以关注我的主页 [【github】](https://github.com/greper) [【gitee】](https://gitee.com/greper)\n\n## 打个广告\n\n> [https://github.com/certd/certd](https://github.com/certd/certd)\n> \n> 我的开源证书管理工具项目，全自动申请和部署证书，有需求的可以去试试，帮忙点个star\n\n## 重要提醒\n\n> ------------------------------重要提醒1---------------------------------\n>\n> 注意：由于electron无法监听windows的关机事件，开着ds情况下直接重启电脑，会导致无法上网，你可以手动启动ds即可恢复网络，你也可以将ds设置为开机自启。\n>\n> 关于此问题的更多讨论请前往：[https://github.com/docmirror/dev-sidecar/issues/109](https://github.com/docmirror/dev-sidecar/issues/109)\n>\n> 注：此问题已在 `1.8.9` 版本中得到解决。\n\n> ------------------------------重要提醒2---------------------------------\n>\n> 注意：本应用启动会自动修改系统代理，所以会与其他代理软件有冲突，一起使用时请谨慎使用。\n> \n> 与Watt Toolkit（原Steam++）共用时，请以hosts模式启动Watt Toolkit\n> \n> 与TUN网卡模式运行的游戏加速器可以共用\n> \n> 本应用主要目的在于直连访问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> 以上部分功能通过 `X.I.U` 的油猴脚本实现， 以下是仓库和脚本下载链接，大家可以去支持一下。\n>\n> - [https://github.com/XIU2/UserScript](https://github.com/XIU2/UserScript)\n> \n> - [https://greasyfork.org/scripts/412245](https://greasyfork.org/scripts/412245)\n>\n> 由于此脚本在ds中是打包在本地的，更新会不及时，你可以直接通过浏览器安装油猴插件使用此脚本，从而获得最新更新（ds本地的可以通过 `加速服务->基本设置->启用脚本` 进行关闭）。\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> Windows: 请选择DevSidecar-x.x.x-windows-universal.exe \n> \n> Mac: 请选择DevSidecar-x.x.x-macos-universal.dmg \n> \n> Debian系及其他支持deb安装包的Linux: 请选择DevSidecar-x.x.x-linux-[架构].deb \n> \n> 其他Linux: 请选择DevSidecar-x.x.x-linux-[架构].AppImage (未做测试，不保证能用)\n\n> linux安装说明请参考 [linux安装文档](./doc/linux.md)\n\n> 注意：由于没有买应用证书，所以应用在下载安装时会有“未知发行者”等安全提示，选择保留即可。\n\n#### 2）安装后打开\n\n界面应大致如下图所示：\n> 注意：mac版安装需要在“系统偏好设置->安全性与隐私->通用”中解锁并允许应用安装\n\n\n\n#### 3）安装根证书\n\n第一次打开会提示安装证书，根据提示操作即可\n\n更多有关根证书的说明，请参考 [为什么要安装根证书?](./doc/caroot.md)\n\n> 根证书是本地随机生成的，所以不用担心根证书的安全问题（本应用不收集任何用户信息）\n> \n> 你也可以在加速服务设置中自定义根证书（PEM格式的证书与私钥）\n\n> 火狐浏览器需要[手动安装证书](#3火狐浏览器火狐浏览器不走系统的根证书需要在选项中添加根证书)\n\n#### 4）开始加速吧\n\n去试试打开github、huggingface、docker hub吧\n\n### 2.2、开启前 vs 开启后\n\n| | 开启前 | 开启后 |\n| -------- | ------------------------------ | ----------------------------------------------- |\n| 头像 |  |  |\n| clone |  |  |\n| zip 下载 |  | 秒下的，实在截不到速度的图 |\n\n## 三、模式说明\n\n### 3.1、安全模式\n\n- 此模式：关闭拦截、关闭增强、不使用远程配置、开启dns优选、开启测速\n- 最安全，无需安装证书，可以在浏览器地址栏左侧查看域名证书\n- 功能也最弱，只有特性1，相当于查询github的国外ip，手动改hosts一个意思。\n- github的可访问性不稳定，取决于IP测速，如果有绿色ip存在，就 `有可能` 可以直连访问。\n \n\n### 3.2、默认模式\n\n- 此模式：开启拦截、关闭增强、使用远程配置、开启dns优选、开启测速\n- 需要安装证书，通过修改sni直连访问github\n- 功能上包含特性1/2/3/4。\n\n## 四、 最佳实践\n\n- 把dev-sidecar一直开着就行了\n- 建议遇到打开比较慢的国外网站，可以尝试将该域名添加到dns设置中（注意：被\\*\\*\\*封杀的无效）\n\n### 其他加速\n\n#### 1）git clone 加速\n\n- 方式1：快捷复制：\n\n > 开启脚本支持，然后在复制clone链接下方，即可复制到加速链接\n\n- 方式2：\n\n > 1. 使用方式：用实际的名称替换 `{}` 的内容，即可加速clone [https://hub.fastgit.org/{username}/{reponame}.git](https://hub.fastgit.org/%7Busername%7D/%7Breponame%7D.git)\n > 2. clone 出来的 remote \"origin\" 为fastgit的地址，需要手动改回来\n > 3. 你也可以直接使用他们的clone加速工具 [fgit-go](https://github.com/FastGitORG/fgit-go)\n\n#### 2）`github.com` 的镜像网站（注意：部分镜像网站不能登录）\n\n> 1. [hub.fastgit.org](https://hub.fastgit.org/) （2024/11/18：这个好像失效了？）\n> 2. [github.com.cnpmjs.org](https://github.com.cnpmjs.org/) 这个很容易超限（2024/11/18：这个好像失效了？）\n> 3. [dgithub.xyz](https://dgithub.xyz/)\n\n## 五、api\n\n### 5.1、拦截配置\n\n没有配置域名的不会拦截，其他根据配置进行拦截处理。\n\n在【加速服务-拦截设置】中配置，格式如下：（更多内容参见[wiki](https://github.com/docmirror/dev-sidecar/wiki/%E5%8A%A0%E9%80%9F%E6%9C%8D%E5%8A%A1%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E)）\n\n```jsonc\n{\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\n通过从dns上获取ip列表，切换不同的ip进行尝试，最终会挑选到一个最快的ip（该功能需要事先配置好所用DNS），更多说明参见[wiki](https://github.com/docmirror/dev-sidecar/wiki/%E5%8A%A0%E9%80%9F%E6%9C%8D%E5%8A%A1%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E)\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> 取消访问偏好设置需要管理员密码\n> \n> 系统偏好设置—>安全性与隐私—> 通用—> 高级—> 访问系统范围的偏好设置需要输入管理员密码（取消勾选）\n\n### 6.2、没有加速效果\n\n1. 本应用默认仅开启https加速，一般足够覆盖需求。\n 如果你访问的是仅支持http协议的网站，请手动在【系统代理】中打开【代理HTTP请求】\n2. 检查浏览器是否装了什么插件，与ds有冲突\n3. 检查是否安装了其他代理软件，与ds有冲突\n4. 请确认浏览器的代理设置为使用IE代理/或者使用系统代理状态\n5. 可以尝试换个浏览器试试\n6. 请确认网络代理设置处于勾选状态\n 正常情况下ds在“系统代理”开关打开时，会自动设置系统代理。\n\n### 6.3、浏览器打开提示证书不受信任\n\n\n\n一般是证书安装位置不对，重新安装根证书后，重启浏览器\n\n#### 1）windows: 请确认证书已正确安装在“本地计算机-将所有的证书都放入下列存储：受信任的根证书颁发机构”下\n\n#### 2）mac: 请确认证书已经被安装并已经设置信任\n\n#### 3）火狐浏览器：火狐浏览器不走系统的根证书，需要在选项中添加根证书\n\n1. 火狐浏览器->选项->隐私与安全->证书->查看证书\n\n2. 证书颁发机构->导入\n3. 选择证书文件 `C:\\Users(用户)\\Administrator(你的账号)\\.dev-sidecar\\dev-sidecar.ca.crt`（Mac或linux为 `~/.dev-sidecar` 目录）\n\n4. 勾选信任由此证书颁发机构来标识网站，确定即可\n\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如果还是不行，请在下方加官方QQ群或提issue，附上服务日志（server.log）以便进行分析\n\n日志打开方式：加速服务->右边日志按钮->打开日志文件夹\n\n\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### 6.9、其他问题\n\n请查阅[wiki](https://github.com/docmirror/dev-sidecar/wiki)\n\n也可以查阅[有文档tag的issue](https://github.com/docmirror/dev-sidecar/issues?q=is%3Aissue%20label%3ADocumentation)，它们被开发者认证为相当于文档级别的参考issue。\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> 如果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\n加官方QQ群（请备注dev-sidecar，或简称DS）\n\n- QQ 1群：390691483，人数：499 / 500（满）\n- QQ 2群：667666069，人数：500 / 500（满）\n- QQ 3群：419807815，人数：493 / 500（满）\n- QQ 4群：[438148299](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=i_NCBB5f_Bkm2JsEV1tLs2TkQ79UlCID&authKey=nMsVJbJ6P%2FGNO7Q6vsVUadXRKnULUURwR8zvUZJnP3IgzhHYPhYdcBCHvoOh8vYr&noverify=0&group_code=438148299)，人数：700 / 1000\n- QQ 5群：[767622917](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=nAWi_Rxj7mM4Unp5LMiatmUWhGimtbcB&authKey=aswmlWGjbt3GIWXtvjB2GJqqAKuv7hWjk6UBs3MTb%2Biyvr%2Fsbb1kA9CjF6sK7Hgg&noverify=0&group_code=767622917)，人数：200 / 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[](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"
},
{
"path": "_script/0、updateDependencies.bat",
"content": "node -v\n\n# 安装ncu\n# npm install -g npm-check-updates\n\ncd ../packages/core\nncu -u\n\n# cd ../packages/gui\n# ncu -u\n\n# cd ../packages/mitmproxy\n# ncu -u\n"
},
{
"path": "_script/1、setupEnv.bat",
"content": "node -v\n\ncd ../\nnpm install -g pnpm --registry=https://registry.npmmirror.com\n"
},
{
"path": "_script/2、installProject.bat",
"content": "node -v\n\ncd ../\nchcp 65001\npnpm install\n"
},
{
"path": "_script/3、buildAndRun.bat",
"content": "node -v\n\ncd ../packages/gui\nchcp 65001\nnpm run electron\n"
},
{
"path": "_script/4.1、runTestCore.bat",
"content": "node -v\n\ncd ../packages/core\npnpm run test\n"
},
{
"path": "_script/4.2、runTestMitmproxy.bat",
"content": "node -v\n\ncd ../packages/mitmproxy\npnpm run test\n"
},
{
"path": "_script/5、generateSetupFile.bat",
"content": "node -v\n\ncd ../packages/gui\n\nif not exist \"dist_electron\" mkdir \"dist_electron\"\nstart dist_electron\n\nnpm run electron:build\n"
},
{
"path": "doc/caroot.md",
"content": "# 关于信任根证书的说明\n\n## 一、为什么要信任根证书。\n\n要回答这个问题需要先掌握下面两个知识点\n\n### 知识点1：什么是根证书\n\n[百度百科-什么是根证书](https://baike.baidu.com/item/%E6%A0%B9%E8%AF%81%E4%B9%A6/9874620?fr=aladdin)\n\n当访问目标网站是https协议时，服务器会发送一个由根证书签发的网站ssl证书给浏览器，让浏览器用这个ssl证书给数据加密。\n浏览器需要先验证这个证书的真伪，之后才会使用证书加密。\n证书的真伪是通过验证证书的签发机构的证书是否可信，一直追溯到最初始的签发机构的证书（根证书）。\n浏览器只需信任根证书，间接的就信任了这条证书链下签发的所有证书。\n\nwindows、mac、linux或者浏览器他们都内置了市面上可信的大型证书颁发机构的根证书。\n\n### 知识点2：中间人攻击\n\n本应用的实现原理如下图：\n\n\n\n> 简单来说就是DevSidecar在本地启动了一个代理服务器帮你访问目标网站。\n> 实际上就是 [中间人攻击](https://baike.baidu.com/item/%E4%B8%AD%E9%97%B4%E4%BA%BA%E6%94%BB%E5%87%BB/1739730?fr=aladdin) 的原理，只是本应用没有用它来干坏事，而是帮助开发者加速目标网站的访问。\n\n### 现在可以回答为什么要信任根证书\n\n当目标网站不需要加速拦截时，直接走TCP转发，不需要中间人攻击，没有安全风险，在此不多做讨论。\n\n当目标网站需要拦截时（例如github），就需要通过中间人攻击修改请求或者请求其他替代网站，从而达到加速的目的。\n\n例如加速github就需要修改如下几处\n\n1. 直连访问github需要修改tls握手时的sni域名，规避\\*\\*\\*的sni阻断问题。\n2. asserts.github.com等静态资源拦截替换成fastgit.org的镜像地址\n\nDevSidecar在第一次启动时会在本地随机生成一份根证书，当有用户访问github时，就用这份根证书来签发一份假的叫github.com的证书。\n如果浏览器事先信任了这份根证书，那么就可以正常访问DevSidecar返回的网页内容了。\n\n## 二、信任根证书有安全风险吗\n\n1. 根证书是DevSidecar第一次启动时本地随机生成的，除了你这台电脑没人知道这份根证书的内容。\n2. 代理请求目标网站时会校验目标网站的证书（除非关闭了`代理校验ssl`）。\n\n> 两段链路都是安全的，所以信任根证书没有问题。\n> 但如果应用本身来源不明，或者`拦截配置`里的替代网站作恶，则有安全风险。\n\n> 对于应用来源风险：\n> 请勿从未知网站下载DevSidecar应用，认准官方版本发布地址\n> [Github Release](https://github.com/docmirror/dev-sidecar/releases)\n>\n> 或者从源码自行编译安装\n\n> 对于拦截配置里的替代网站风险：\n>\n> 1. 尽量缩小替代配置的范围\n> 2. 不使用来源不明的镜像地址，尽量使用知名度较高的镜像地址\n> 3. 你甚至可以将其他拦截配置全部删除，只保留github相关配置\n"
},
{
"path": "doc/linux.md",
"content": "# Linux 支持\n\n`Linux`使用说明，目前仅官方支持`Ubuntu x86_64 GNOME桌面版（原版）`，其他`Linux`未测试\n\n> 注意：需要开启 [sudo 免密支持](https://www.jianshu.com/p/5d02428f313d)，否则请自行安装证书\n\n## 一、安装\n\n### 1.1. Ubuntu / Debian或其衍生版（未测试）\n\n- 下载`DevSidecar-x.x.x.deb`\n- 使用 root 执行命令安装 `dpkg -i DevSidecar-x.x.x.deb`\n- 去应用列表里面找到 dev-sidecar 应用，打开即可\n\n### 1.2. 其他基于glibc的Linux系统（未测试）\n\n- 下载 `DevSidecar-x.x.x.AppImage`\n- 设置可执行权限 `chmod +x DevSidecar-x.x.x.AppImage`\n- 双击运行\n\n### 1.3. 特殊的Linux系统（如Alpine和Chimera Linux）\n\n> 此处默认用户有较专业的Linux知识，故不详细描述，请参考并自行试验\n- 创建Debian（最方便且省空间）容器，可使用distrobox（推荐），接下来以此为例说明\n- 下载deb包并在容器内安装\n- 穿透系统设置：\n 在容器内 `/usr/bin/gsettings` 文件写入：\n\n ```bash\n #!/bin/sh\n distrobox-host-exec gsettings \"$@\"\n ```\n 并设置可执行权限\n\n 简化版命令（请在容器内执行）:\n ```\n echo -e '#!/bin/sh\\ndistrobox-host-exec gsettings \"$@\"' >/usr/bin/gsettings\n ```\n- 使用命令启动应用，使用“自动安装证书”功能，回到终端，找到输出里含有 `sudo` 的两句命令，复制到主系统执行，如失败（或使用其他证书系统），请自行安装证书，可参考 [议题 #204](https://github.com/docmirror/dev-sidecar/issues/204)\n\n### 1.4. 版本选择\n\n不同CPU架构，选择对应的版本，如果安装失败，请下载 `universal` 版本\n\n\n## 二、证书安装\n\n默认模式和增强模式需要系统信任CA证书。\n由于Linux上火狐和Chrome都不走系统证书，所以除了安装系统证书之外，还需要给浏览器安装证书\n\n### 2.1. 系统证书安装\n\n根据弹出的提示：\n\n- 点击首页右上角“安装根证书”按钮\n- 点击“点此去安装”\n- 提示安装成功即可\n\n### 2.2. 火狐浏览器安装证书\n\n- 火狐浏览器->选项->隐私与安全->证书->查看证书\n- 证书颁发机构->导入\n- 选择证书文件在 `~/.dev-sidecar` 目录下\n- 勾选信任由此证书颁发机构来标识网站，确定即可\n\n### 2.3. Chrome浏览器安装证书\n\n证书文件目录为 `~/.dev-sidecar`\n\n\n"
},
{
"path": "doc/other.md",
"content": "# 其他程序使用\n\n## Java程序使用\n\n> 由 [Enaium](https://github.com/Enaium) 提供，未做验证，可供参考\n\n1. 先通过keytool安装证书：\n\n ```shell\n keytool -import -alias dev-sidecar -keystore \"jdk路径\\security\\cacerts\" -file 用户目录\\.dev-sidecar\\dev-sidecar.ca.crt\n ```\n 默认密码为 `changeit`\n\n2. 启动时还需要设置参数，例：\n\n ```shell\n java -Dhttp.proxyHost=localhost -Dhttp.proxyPort=31181 -Dhttps.proxyHost=localhost -Dhttps.proxyPort=31181 -jar xxxx.jar\n ```\n\n3. Gradle还需在`用户目录/.gradle/gradle.properties`创建配置文件：\n\n ```properties\n systemProp.http.proxyHost=localhost\n systemProp.http.proxyPort=31181\n systemProp.https.proxyHost=localhost\n systemProp.https.proxyPort=31181\n ```\n"
},
{
"path": "doc/recover.md",
"content": "# 卸载与恢复网络\n\n由于应用启动后会自动设置系统代理，正常退出时会关闭系统代理。\n当应用意外关闭，或者未正常退出后被卸载，此时会因为系统代理没有恢复从而导致完全上不了网。\n目前electron在windows系统上无法监听系统重启事件。更多相关资料 [electron issues](https://github.com/electron/electron/pull/24261)\n\n## 恢复代理设置\n\n### 1、windows 代理关闭\n\n如何打开查看windows代理设置：\n\n- win10: 开始->设置->网络和Internet->最下方代理\n- win7: 开始->控制面板->网络和Internet->网络和共享中心->左下角Internet选项->连接选项卡->局域网设置\n\n\n\n### 2、mac 代理关闭\n\n网络->网卡->代理->去掉http和https的两个勾\n\n\n\n### 3、Linux（Ubuntu）\n\n网络->代理->选择禁用\n"
},
{
"path": "doc/wiki/Home.md",
"content": "> **给作者打个广告：**![](\"/logo/logo-simple.svg\"){kind=logo}
\n ![](\"/logo/logo-fff.svg\"){kind=logo}
\n Git.exe将不代理以下仓库；可以是根地址、组织/机构地址、完整地址\n electron\n 注：请不要看视频，流量挺小的！原理说明，自建二层代理服务端，并在此页下方配置代理服务端。禁用，也可以关闭PAC\n base64编码格式，也可以是未经过编码的\n 禁用时，将不使用梯子\n pip命令改成了其他名字（如pip3），或想设置绿色版pip程序路径，可在此处修改\n pip.ini中的trusted-host配置，即使关闭 ds 也会继续保持\n HTTP和HTTPS请求；不勾选时，只代理HTTPS请求Github网站的用户，建议不勾选。\n HTTPS_PROXY环境变量（不好用，不建议勾选）\n OneNote、MicrosoftStore、Outlook等UWP应用开启代理后无法访问网络的问题\n 不排除，也可以关闭国内域名白名单\n base64编码格式，也可以是未经过编码的\n 不排除时，将被代理\n ![](\"loopback.png\")
\n 0.0.0.0，让其他电脑可以使用此代理服务\n Github油猴脚本也将关闭\n timeout配置keepAliveTimeout配置\n 不代理的域名不会通过代理自动兼容程序会自动根据错误信息进行兼容性调整，并将兼容设置保存在 ~/.dev-sidecar/automaticCompatibleConfig.json 文件中。但并不是所有的兼容设置都是正确的，所以需要通过以下配置来覆盖错误的兼容设置。\n IP预设置功能，优先级高于 DNS设置\n （域名配置可使用通配符或正则）\n F5、F12、Ctrl+F、F3、Shift+F3\n -” 的版本。注：该配置只对当前版本为正式版本时有效。\n 隔天或达到日志文件大小限制时，才会触发清理程序！\n