代码格式调整:*.md

1.x
王良 2024-11-14 16:48:36 +08:00
parent cb2699d070
commit ab32acf3b8
11 changed files with 116 additions and 119 deletions

View File

@ -11,25 +11,20 @@ labels: Bug
1. 操作系统:? 1. 操作系统:?
2. DS版本号? <!-- 如:`1.8.6-node17` --> 2. DS版本号? <!-- 如:`1.8.6-node17` -->
### Ⅱ. 问题描述: ### Ⅱ. 问题描述:
### Ⅲ. 期望的结果: ### Ⅲ. 期望的结果:
### Ⅳ. 如何复现问题? ### Ⅳ. 如何复现问题?
1. xxx 1. xxx
2. xxx 2. xxx
3. xxx 3. xxx
### . 请提供相关的错误日志,尽可能的详细:(日志文件在 `${user.home}/.dev-sidecar/logs/` 目录下) ### . 请提供相关的错误日志,尽可能的详细:(日志文件在 `${user.home}/.dev-sidecar/logs/` 目录下)
```log ```log
``` ```
### Ⅵ. 有必要时,请提供 `${user.home}/.dev-sidecar/running.json` 文件内容: ### Ⅵ. 有必要时,请提供 `${user.home}/.dev-sidecar/running.json` 文件内容:
<!-- 请将 'running.json' 文件的内容粘贴在这里,方便我们排查问题是否由配置错误导致。 --> <!-- 请将 'running.json' 文件的内容粘贴在这里,方便我们排查问题是否由配置错误导致。 -->
```json ```json

View File

@ -11,9 +11,6 @@ labels: Style Issue
1. 操作系统:? 1. 操作系统:?
2. DS版本号? <!-- 如:`1.8.6-node17` --> 2. DS版本号? <!-- 如:`1.8.6-node17` -->
### Ⅱ. 样式问题描述: ### Ⅱ. 样式问题描述:
### Ⅲ. 样式问题截图: ### Ⅲ. 样式问题截图:

View File

@ -25,10 +25,8 @@ labels: Config Issue
- [ ] pip加速 - [ ] pip加速
- [ ] 梯子 - [ ] 梯子
### Ⅱ. 请详细描述你的问题: ### Ⅱ. 请详细描述你的问题:
### Ⅲ. 有必要时,请提供 `${user.home}/.dev-sidecar/running.json` 文件内容: ### Ⅲ. 有必要时,请提供 `${user.home}/.dev-sidecar/running.json` 文件内容:
<!-- 请将 'running.json' 文件的内容粘贴在这里,方便我们排查问题是否由配置错误导致。 --> <!-- 请将 'running.json' 文件的内容粘贴在这里,方便我们排查问题是否由配置错误导致。 -->
```json ```json

View File

@ -7,11 +7,8 @@ labels: Feature Request
### . 请描述你想要的新功能: ### . 请描述你想要的新功能:
<!-- 请简单描述你希望的新功能,例如:"在某某页面添加一个按钮点击按钮时弹出一个某某对话框用于xxx。" --> <!-- 请简单描述你希望的新功能,例如:"在某某页面添加一个按钮点击按钮时弹出一个某某对话框用于xxx。" -->
### Ⅱ. 请描述你心目中新功能的样子: ### Ⅱ. 请描述你心目中新功能的样子:
<!-- 可以讲讲你对新功能的看法,可以解释更多关于该功能的输入和输出的信息,或贴上你设想的界面设计。 --> <!-- 可以讲讲你对新功能的看法,可以解释更多关于该功能的输入和输出的信息,或贴上你设想的界面设计。 -->
### Ⅲ. 你希望该新功能修复哪个issue ### Ⅲ. 你希望该新功能修复哪个issue
<!-- 请将相关issue的编号填写在下面格式如#123 --> <!-- 请将相关issue的编号填写在下面格式如#123 -->

View File

@ -4,4 +4,3 @@ about: 如果不是以上问题,请使用此模板。
--- ---
### 请详细描述你的问题、需求或建议: ### 请详细描述你的问题、需求或建议:

View File

@ -1,9 +1,7 @@
### . 描述此PR的作用 ### . 描述此PR的作用
### Ⅱ. 此PR修复了哪个issue吗 ### Ⅱ. 此PR修复了哪个issue吗
<!-- 如果是的话, 请在下一行写上 "fixes #xxx"比如fixes #97 --> <!-- 如果是的话, 请在下一行写上 "fixes #xxx"比如fixes #97 -->
### Ⅲ. 界面变化截屏 ### Ⅲ. 界面变化截屏
<!-- 如果存在界面上的变化,请截屏展示出来 --> <!-- 如果存在界面上的变化,请截屏展示出来 -->

159
README.md
View File

@ -1,6 +1,5 @@
# dev-sidecar # dev-sidecar
开发者边车命名取自service-mesh的service-sidecar意为为开发者打辅助的边车工具以下简称ds 开发者边车命名取自service-mesh的service-sidecar意为为开发者打辅助的边车工具以下简称ds
通过本地代理的方式将https请求代理到一些国内的加速通道上 通过本地代理的方式将https请求代理到一些国内的加速通道上
@ -14,18 +13,17 @@
> >
## 打个广告 ## 打个广告
> >
> https://github.com/certd/certd > <https://github.com/certd/certd>
> 我的开源证书管理工具项目全自动申请和部署证书有需求的可以去试试帮忙点个star > 我的开源证书管理工具项目全自动申请和部署证书有需求的可以去试试帮忙点个star
## 重要提醒 ## 重要提醒
>
> ------------------------------重要提醒1--------------------------------- > ------------------------------重要提醒1---------------------------------
> >
> 注意由于electron无法监听windows的关机事件开着ds情况下直接重启电脑会导致无法上网你可以手动启动ds即可恢复网络你也可以将ds设置为开机自启。 > 注意由于electron无法监听windows的关机事件开着ds情况下直接重启电脑会导致无法上网你可以手动启动ds即可恢复网络你也可以将ds设置为开机自启。
> >
> 关于此问题的更多讨论请前往: > 关于此问题的更多讨论请前往:
> https://github.com/docmirror/dev-sidecar/issues/109 > <https://github.com/docmirror/dev-sidecar/issues/109>
> >
> ------------------------------重要提醒2--------------------------------- > ------------------------------重要提醒2---------------------------------
@ -34,21 +32,22 @@
> 本应用主要目的在于直连访问github如果你已经有飞机了那建议还是不要用这个自行车ds > 本应用主要目的在于直连访问github如果你已经有飞机了那建议还是不要用这个自行车ds
> >
## 一、 特性 ## 一、 特性
### 1.1、 dns优选解决***污染问题) ### 1.1、 dns优选解决***污染问题)
* 根据网络状况智能解析最佳域名ip地址获取最佳网络速度 * 根据网络状况智能解析最佳域名ip地址获取最佳网络速度
* 解决一些网站和库无法访问或访问速度慢的问题 * 解决一些网站和库无法访问或访问速度慢的问题
* 建议遇到打开比较慢的国外网站可以优先尝试将该域名添加到dns设置中注意被***封杀的无效) * 建议遇到打开比较慢的国外网站可以优先尝试将该域名添加到dns设置中注意被***封杀的无效)
### 1.2、 请求拦截 ### 1.2、 请求拦截
* 拦截打不开的网站,代理到加速镜像站点上去。 * 拦截打不开的网站,代理到加速镜像站点上去。
* 可配置多个镜像站作为备份 * 可配置多个镜像站作为备份
* 具备测速机制,当访问失败或超时之后,自动切换到备用站点,使得目标服务高可用 * 具备测速机制,当访问失败或超时之后,自动切换到备用站点,使得目标服务高可用
### 1.3、 github加速 ### 1.3、 github加速
* github 直连加速 (通过修改sni实现感谢 [fastGithub](https://github.com/dotnetcore/FastGithub) 提供的思路) * github 直连加速 (通过修改sni实现感谢 [fastGithub](https://github.com/dotnetcore/FastGithub) 提供的思路)
* release、source、zip下载加速 * release、source、zip下载加速
* clone 加速 * clone 加速
@ -59,35 +58,36 @@
* raw/blame加速 * raw/blame加速
> 以上部分功能通过`X.I.U`的油猴脚本实现, 以下是仓库和脚本下载链接,大家可以去支持一下。 > 以上部分功能通过`X.I.U`的油猴脚本实现, 以下是仓库和脚本下载链接,大家可以去支持一下。
> * https://github.com/XIU2/UserScript >
> * https://greasyfork.org/scripts/412245 > * <https://github.com/XIU2/UserScript>
> * <https://greasyfork.org/scripts/412245>
> >
> 由于此脚本在ds中是打包在本地的更新会不及时你可以直接通过浏览器安装油猴插件使用此脚本从而获得最新更新ds本地的可以通过`加速服务->基本设置->启用脚本`进行关闭)。 > 由于此脚本在ds中是打包在本地的更新会不及时你可以直接通过浏览器安装油猴插件使用此脚本从而获得最新更新ds本地的可以通过`加速服务->基本设置->启用脚本`进行关闭)。
### 1.4、 Stack Overflow 加速 ### 1.4、 Stack Overflow 加速
* 将ajax.google.com代理到加速CDN上 * 将ajax.google.com代理到加速CDN上
* recaptcha 图片验证码加速 * recaptcha 图片验证码加速
### 1.5、 npm加速 ### 1.5、 npm加速
* 支持开启npm代理 * 支持开启npm代理
* 官方与淘宝npm registry一键切换, * 官方与淘宝npm registry一键切换,
* 某些npm install的时候并且使用cnpm也无法安装时可以尝试开启npm代理再试 * 某些npm install的时候并且使用cnpm也无法安装时可以尝试开启npm代理再试
***安全警告*** ***安全警告***
* 请勿使用来源不明的服务地址,有隐私和账号泄露风险 * 请勿使用来源不明的服务地址,有隐私和账号泄露风险
* 本应用及服务端承诺不收集任何信息。介意者请使用安全模式。 * 本应用及服务端承诺不收集任何信息。介意者请使用安全模式。
## 二、快速开始 ## 二、快速开始
支持windows、Mac、Linux(Ubuntu) 支持windows、Mac、Linux(Ubuntu)
### 2.1、DevSidecar桌面应用 ### 2.1、DevSidecar桌面应用
#### 1下载安装包 #### 1下载安装包
* release下载 * release下载
[Github Release](https://github.com/docmirror/dev-sidecar/releases) [Github Release](https://github.com/docmirror/dev-sidecar/releases)
@ -100,7 +100,6 @@
> 注意:由于没有买应用证书,所以应用在下载安装时会有“未知发行者”等安全提示,选择保留即可。 > 注意:由于没有买应用证书,所以应用在下载安装时会有“未知发行者”等安全提示,选择保留即可。
#### 2安装后打开 #### 2安装后打开
> 注意mac版安装需要在“系统偏好设置->安全性与隐私->通用”中解锁并允许应用安装 > 注意mac版安装需要在“系统偏好设置->安全性与隐私->通用”中解锁并允许应用安装
@ -116,14 +115,12 @@
> 根证书是本地随机生成的,所以不用担心根证书的安全问题(本应用不收集任何用户信息) > 根证书是本地随机生成的,所以不用担心根证书的安全问题(本应用不收集任何用户信息)
> 你也可以在加速服务设置中自定义根证书PEM格式的证书与私钥 > 你也可以在加速服务设置中自定义根证书PEM格式的证书与私钥
> 火狐浏览器需要[手动安装证书](#3浏览器打开提示证书不受信任) > 火狐浏览器需要[手动安装证书](#3浏览器打开提示证书不受信任)
#### 4开始加速吧 #### 4开始加速吧
去试试打开github 去试试打开github
### 2.2、开启前 vs 开启后 ### 2.2、开启前 vs 开启后
| | 开启前 | 开启后 | | | 开启前 | 开启后 |
@ -132,10 +129,10 @@
|clone |![](./doc/clone-before.png) |![](./doc/clone.png) | |clone |![](./doc/clone-before.png) |![](./doc/clone.png) |
|zip 下载 |![](./doc/download-before.png) |![](./doc/download.png)秒下的,实在截不到速度的图 | |zip 下载 |![](./doc/download-before.png) |![](./doc/download.png)秒下的,实在截不到速度的图 |
## 三、模式说明 ## 三、模式说明
### 3.1、安全模式 ### 3.1、安全模式
* 此模式关闭拦截、关闭增强、开启dns优选、开启测速 * 此模式关闭拦截、关闭增强、开启dns优选、开启测速
* 最安全,无需安装证书,可以在浏览器地址栏左侧查看域名证书 * 最安全,无需安装证书,可以在浏览器地址栏左侧查看域名证书
* 功能也最弱只有特性1相当于查询github的国外ip手动改hosts一个意思。 * 功能也最弱只有特性1相当于查询github的国外ip手动改hosts一个意思。
@ -143,6 +140,7 @@
![](./doc/speed.png) ![](./doc/speed.png)
### 3.2、默认模式 ### 3.2、默认模式
* 此模式开启拦截、关闭增强、开启dns优选、开启测速 * 此模式开启拦截、关闭增强、开启dns优选、开启测速
* 需要安装证书通过修改sni直连访问github * 需要安装证书通过修改sni直连访问github
* 功能上包含特性1/2/3/4。 * 功能上包含特性1/2/3/4。
@ -161,57 +159,60 @@
方式2 方式2
> 使用方式用实际的名称替换{}的内容即可加速clone > 使用方式用实际的名称替换{}的内容即可加速clone
> https://hub.fastgit.org/{username}/{reponame}.git > <https://hub.fastgit.org/{username}/{reponame}.git>
> clone 出来的 remote "origin" 为fastgit的地址需要手动改回来 > clone 出来的 remote "origin" 为fastgit的地址需要手动改回来
> 你也可以直接使用他们的clone加速工具 [fgit-go](https://github.com/FastGitORG/fgit-go) > 你也可以直接使用他们的clone加速工具 [fgit-go](https://github.com/FastGitORG/fgit-go)
#### 2github.com的镜像网站(注意:不能登录) #### 2github.com的镜像网站(注意:不能登录)
>
> 1. [hub.fastgit.org](https://hub.fastgit.org/) > 1. [hub.fastgit.org](https://hub.fastgit.org/)
> 2. [github.com.cnpmjs.org](https://github.com.cnpmjs.org/) 这个很容易超限 > 2. [github.com.cnpmjs.org](https://github.com.cnpmjs.org/) 这个很容易超限
## 五、api ## 五、api
### 5.1、拦截配置 ### 5.1、拦截配置
没有配置域名的不会拦截,其他根据配置进行拦截处理 没有配置域名的不会拦截,其他根据配置进行拦截处理
```js ```js
const intercepts = { const intercepts = {
// 要拦截的域名 // 要拦截的域名
'github.com': { 'github.com': {
//需要拦截url的正则表达式 // 需要拦截url的正则表达式
'/.*/.*/releases/download/': { '/.*/.*/releases/download/': {
//拦截类型 // 拦截类型
// redirect: url, // 临时重定向url会变一些下载资源可以通过此方式配置 // redirect: url, // 临时重定向url会变一些下载资源可以通过此方式配置
// proxy: url, // 代理url不会变没有跨域问题 // proxy: url, // 代理url不会变没有跨域问题
// abort: true, // 取消请求(适用于被***封锁的资源,找不到替代,直接取消请求,快速失败,节省时间) // abort: true, // 取消请求(适用于被***封锁的资源,找不到替代,直接取消请求,快速失败,节省时间)
// success: true, // 直接返回成功请求(某些请求不想发出去,可以伪装成功返回) // success: true, // 直接返回成功请求(某些请求不想发出去,可以伪装成功返回)
// cacheDays: 1, // GET请求的使用缓存单位常用于一些静态资源 // cacheDays: 1, // GET请求的使用缓存单位常用于一些静态资源
// options: true, // OPTIONS请求直接返回成功请求该功能存在一定风险请谨慎使用 // options: true, // OPTIONS请求直接返回成功请求该功能存在一定风险请谨慎使用
// optionsMaxAge: 2592000, // OPTIONS请求缓存时间默认2592000一个月 // optionsMaxAge: 2592000, // OPTIONS请求缓存时间默认2592000一个月
redirect: 'download.fastgit.org' redirect: 'download.fastgit.org'
}, },
'.*': { '.*': {
proxy: 'github.com', proxy: 'github.com',
sni: 'baidu.com' //修改sni规避***握手拦截 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 //取消请求,被***封锁的资源,找不到替代,直接取消请求,快速失败,节省时间
}
} }
},
'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优选配置 ### 5.2、DNS优选配置
某些域名解析出来的ip会无法访问比如api.github.com会被解析到新加坡的ip上新加坡的服务器在上午挺好到了晚上就卡死基本不可用 某些域名解析出来的ip会无法访问比如api.github.com会被解析到新加坡的ip上新加坡的服务器在上午挺好到了晚上就卡死基本不可用
通过从dns上获取ip列表切换不同的ip进行尝试最终会挑选到一个最快的ip 通过从dns上获取ip列表切换不同的ip进行尝试最终会挑选到一个最快的ip
@ -226,12 +227,13 @@ const intercepts = {
} }
} }
``` ```
注意暂时只支持IPv4的解析
注意暂时只支持IPv4的解析
## 六、问题排查 ## 六、问题排查
### 6.1、dev-sidecar的前两个开关没有处于打开状态 ### 6.1、dev-sidecar的前两个开关没有处于打开状态
1. 尝试将开关按钮手动打开 1. 尝试将开关按钮手动打开
2. 请尝试右键dev-sidecar图标点退出。再重新打开 2. 请尝试右键dev-sidecar图标点退出。再重新打开
3. 如果还不行,请将日志发送给作者 3. 如果还不行,请将日志发送给作者
@ -239,25 +241,27 @@ const intercepts = {
如果是mac系统可能是下面的原因 如果是mac系统可能是下面的原因
#### 1Mac系统使用时首页的系统代理开关无法打开 #### 1Mac系统使用时首页的系统代理开关无法打开
出现这个问题可能是没有开启系统代理命令的执行权限 出现这个问题可能是没有开启系统代理命令的执行权限
``` ```
networksetup -setwebproxy 'WiFi' 127.0.0.1 31181 networksetup -setwebproxy 'WiFi' 127.0.0.1 31181
#看是否有如下错误提示 #看是否有如下错误提示
** Error: Command requires admin privileges. ** Error: Command requires admin privileges.
``` ```
如果有上面的错误提示,请尝试如下方法: 如果有上面的错误提示,请尝试如下方法:
>取消访问偏好设置需要管理员密码 >取消访问偏好设置需要管理员密码
>系统偏好设置—>安全性与隐私—> 通用—> 高级—> 访问系统范围的偏好设置需要输入管理员密码(取消勾选) >系统偏好设置—>安全性与隐私—> 通用—> 高级—> 访问系统范围的偏好设置需要输入管理员密码(取消勾选)
### 6.2、没有加速效果 ### 6.2、没有加速效果
>本应用仅支持https加速请务必确认你访问的网站地址是https开头的 >本应用仅支持https加速请务必确认你访问的网站地址是https开头的
1. 本应用仅支持https加速 1. 本应用仅支持https加速
请务必确认你访问的地址是https开头的 请务必确认你访问的地址是https开头的
比如: https://github.com/ 比如: <https://github.com/>
2. 检查浏览器是否装了什么插件与ds有冲突 2. 检查浏览器是否装了什么插件与ds有冲突
@ -270,7 +274,6 @@ networksetup -setwebproxy 'WiFi' 127.0.0.1 31181
7. 请确认网络代理设置处于勾选状态 7. 请确认网络代理设置处于勾选状态
正常情况下ds在“系统代理”开关打开时会自动设置系统代理。 正常情况下ds在“系统代理”开关打开时会自动设置系统代理。
### 6.3、浏览器打开提示证书不受信任 ### 6.3、浏览器打开提示证书不受信任
![](./doc/crt-error.png) ![](./doc/crt-error.png)
@ -278,36 +281,40 @@ networksetup -setwebproxy 'WiFi' 127.0.0.1 31181
#### 1windows: 请确认证书已正确安装在“信任的根证书颁发机构”下 #### 1windows: 请确认证书已正确安装在“信任的根证书颁发机构”下
#### 2mac: 请确认证书已经被安装并已经设置信任 #### 2mac: 请确认证书已经被安装并已经设置信任
#### 3火狐浏览器火狐浏览器不走系统的根证书需要在选项中添加根证书 #### 3火狐浏览器火狐浏览器不走系统的根证书需要在选项中添加根证书
> 1、火狐浏览器->选项->隐私与安全->证书->查看证书 > 1、火狐浏览器->选项->隐私与安全->证书->查看证书
> 2、证书颁发机构->导入 > 2、证书颁发机构->导入
> 3、选择证书文件`C:\Users(用户)\Administrator(你的账号)\.dev-sidecar\dev-sidecar.ca.crt`Mac或linux为`~/.dev-sidecar`目录) > 3、选择证书文件`C:\Users(用户)\Administrator(你的账号)\.dev-sidecar\dev-sidecar.ca.crt`Mac或linux为`~/.dev-sidecar`目录)
> 4、勾选信任由此证书颁发机构来标识网站确定即可 > 4、勾选信任由此证书颁发机构来标识网站确定即可
### 6.4、打开github显示连接超时 ### 6.4、打开github显示连接超时
```html ```html
DevSidecar Warning: DevSidecar Warning:
Error: www.github.com:443, 代理请求超时 Error: www.github.com:443, 代理请求超时
``` ```
1、检查测速界面github.com是否有ip 如果没有ip则可能是由于你的网络提供商封锁了dns服务商的ip试试能否ping通1.1.1.1 / 9.9.9.9 1、检查测速界面github.com是否有ip 如果没有ip则可能是由于你的网络提供商封锁了dns服务商的ip试试能否ping通1.1.1.1 / 9.9.9.9
2、如果是安全模式则是因为不稳定导致的等一会再刷新试试 2、如果是安全模式则是因为不稳定导致的等一会再刷新试试
3、如果是增强模式则是由于访问人数过多正常现象 3、如果是增强模式则是由于访问人数过多正常现象
### 6.5、查看日志是否有报错 ### 6.5、查看日志是否有报错
如果还是不行,请在下方加作者好友,将服务日志发送给作者进行分析 如果还是不行,请在下方加作者好友,将服务日志发送给作者进行分析
日志打开方式:加速服务->右边日志按钮->打开日志文件夹 日志打开方式:加速服务->右边日志按钮->打开日志文件夹
![](./doc/log.png) ![](./doc/log.png)
### 6.6、某些原本可以打开的网站打不开了 ### 6.6、某些原本可以打开的网站打不开了
1、可以尝试关闭pac 1、可以尝试关闭pac
2、可以将域名加入白名单 2、可以将域名加入白名单
### 6.7、应用意外关闭导致没有网络了 ### 6.7、应用意外关闭导致没有网络了
应用开启后会自动修改系统代理设置,正常退出会自动关闭系统代理 应用开启后会自动修改系统代理设置,正常退出会自动关闭系统代理
当应用意外关闭时,可能会因为没有将系统代理恢复,从而导致完全无法上网。 当应用意外关闭时,可能会因为没有将系统代理恢复,从而导致完全无法上网。
@ -316,27 +323,29 @@ Error: www.github.com:443, 代理请求超时
2、如果应用被卸载了此时需要[手动关闭系统代理设置](./doc/recover.md) 2、如果应用被卸载了此时需要[手动关闭系统代理设置](./doc/recover.md)
3、如果你是因为开着ds的情况下重启电脑导致无法上网你可以设置ds为开机自启 3、如果你是因为开着ds的情况下重启电脑导致无法上网你可以设置ds为开机自启
### 6.8、卸载应用后上不了网git请求不了 ### 6.8、卸载应用后上不了网git请求不了
如果你在卸载应用前没有正常退出app就有可能无法上网。请按如下步骤操作恢复您的网络 如果你在卸载应用前没有正常退出app就有可能无法上网。请按如下步骤操作恢复您的网络
1、关闭系统代理设置参见[手动关闭系统代理设置](./doc/recover.md) 1、关闭系统代理设置参见[手动关闭系统代理设置](./doc/recover.md)
2、执行下面的命令关闭git的代理设置如果你开启过 `Git.exe代理` 的开关) 2、执行下面的命令关闭git的代理设置如果你开启过 `Git.exe代理` 的开关)
```shell ```shell
git config --global --unset http.proxy git config --global --unset http.proxy
git config --global --unset https.proxy git config --global --unset https.proxy
git config --global --unset http.sslVerify git config --global --unset http.sslVerify
``` ```
3、执行下面的命令关闭npm的代理设置如果你开启过npm加速的开关 3、执行下面的命令关闭npm的代理设置如果你开启过npm加速的开关
```shell ```shell
npm config delete proxy npm config delete proxy
npm config delete https-proxy npm config delete https-proxy
``` ```
## 七、在其他程序使用 ## 七、在其他程序使用
* [java程序使用](./doc/other.md#Java程序使用)
* [java程序使用](./doc/other.md#Java程序使用)
## 八、贡献代码 ## 八、贡献代码
@ -350,6 +359,7 @@ npm config delete https-proxy
运行如下命令即可安装所需依赖: 运行如下命令即可安装所需依赖:
> 注lerna指定为6.x版本更高版本会导致打包失败不兼容导致 > 注lerna指定为6.x版本更高版本会导致打包失败不兼容导致
```shell ```shell
npm install -g cnpm --registry=https://registry.npmmirror.com npm install -g cnpm --registry=https://registry.npmmirror.com
@ -360,6 +370,7 @@ cnpm install -g lerna@6
### 8.2、开发调试模式启动 ### 8.2、开发调试模式启动
运行如下命令即可开发模式启动 运行如下命令即可开发模式启动
```shell ```shell
# 拉取代码 # 拉取代码
git clone https://github.com/docmirror/dev-sidecar git clone https://github.com/docmirror/dev-sidecar
@ -377,47 +388,55 @@ cd packages/gui
npm run electron npm run electron
``` ```
> 如果electron依赖包下载不动可以开启ds的npm加速 > 如果electron依赖包下载不动可以开启ds的npm加速
### 8.3、打包成可执行文件 ### 8.3、打包成可执行文件
```shell ```shell
# 先执行上面的步骤,然后运行如下命令打包成可执行文件 # 先执行上面的步骤,然后运行如下命令打包成可执行文件
npm run electron:build npm run electron:build
``` ```
### 8.4、提交pr ### 8.4、提交pr
如果你想将你的修改贡献出来请提交pr 如果你想将你的修改贡献出来请提交pr
## 九、联系作者 ## 九、联系作者
欢迎bug反馈需求建议技术交流等 欢迎bug反馈需求建议技术交流等
1、 加群请备注dev-sidecar或简称DS 1、 加群请备注dev-sidecar或简称DS
- QQ 1群390691483人数500 / 500 * QQ 1群390691483人数500 / 500
- QQ 2群[667666069](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=n4nksr4sji93vZtD5e8YEHRT6qbh6VyQ&authKey=XKBZnzmoiJrAFyOT4V%2BCrgX5c13ds59b84g%2FVRhXAIQd%2FlAiilsuwDRGWJct%2B570&noverify=0&group_code=667666069)人数447 / 500 * QQ 2群[667666069](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=n4nksr4sji93vZtD5e8YEHRT6qbh6VyQ&authKey=XKBZnzmoiJrAFyOT4V%2BCrgX5c13ds59b84g%2FVRhXAIQd%2FlAiilsuwDRGWJct%2B570&noverify=0&group_code=667666069)人数447 / 500
- QQ 3群419807815人数500 / 500 * QQ 3群419807815人数500 / 500
- 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)人数203 / 1000 * 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)人数203 / 1000
- 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)人数016 / 200new * 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)人数016 / 200new
## 十、求star ## 十、求star
我的其他项目求star 我的其他项目求star
* [fast-crud](https://github.com/fast-crud/fast-crud) : 开发crud快如闪电 * [fast-crud](https://github.com/fast-crud/fast-crud) : 开发crud快如闪电
* [certd](https://github.com/certd/certd) : 让你的证书永不过期 * [certd](https://github.com/certd/certd) : 让你的证书永不过期
* [trident-sync](https://github.com/handsfree-work/trident-sync) : 二次开发项目同步升级工具 * [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/) [![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) * [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) 本项目部分加速功能完全复制该脚本。 * [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),本项目的系统代理排除域名功能中,使用了该白名单。 * [中国域名白名单](https://github.com/pluwen/china-domain-allowlist),本项目的系统代理排除域名功能中,使用了该白名单。
本项目部分加速资源由如下组织提供 本项目部分加速资源由如下组织提供
* [FastGit UK](https://fastgit.org/) * [FastGit UK](https://fastgit.org/)

View File

@ -18,7 +18,6 @@ windows、mac、linux或者浏览器他们都内置了市面上可信的大型
![](./flow.jpg) ![](./flow.jpg)
> 简单来说就是DevSidecar在本地启动了一个代理服务器帮你访问目标网站。 > 简单来说就是DevSidecar在本地启动了一个代理服务器帮你访问目标网站。
> 实际上就是 [中间人攻击](https://baike.baidu.com/item/%E4%B8%AD%E9%97%B4%E4%BA%BA%E6%94%BB%E5%87%BB/1739730?fr=aladdin) 的原理,只是本应用没有用它来干坏事,而是帮助开发者加速目标网站的访问。 > 实际上就是 [中间人攻击](https://baike.baidu.com/item/%E4%B8%AD%E9%97%B4%E4%BA%BA%E6%94%BB%E5%87%BB/1739730?fr=aladdin) 的原理,只是本应用没有用它来干坏事,而是帮助开发者加速目标网站的访问。
@ -55,5 +54,3 @@ DevSidecar在第一次启动时会在本地随机生成一份根证书当有
> 2. 不使用来源不明的镜像地址,尽量使用知名度较高的镜像地址 > 2. 不使用来源不明的镜像地址,尽量使用知名度较高的镜像地址
> 3. 你甚至可以将其他拦截配置全部删除只保留github相关配置 > 3. 你甚至可以将其他拦截配置全部删除只保留github相关配置
> >

View File

@ -33,5 +33,3 @@
### 3. chrome浏览器安装证书 ### 3. chrome浏览器安装证书
证书文件目录为`~/.dev-sidecar` 证书文件目录为`~/.dev-sidecar`
![](../packages/gui/public/setup-linux.png) ![](../packages/gui/public/setup-linux.png)

View File

@ -16,6 +16,5 @@
![](./mac-proxy.png) ![](./mac-proxy.png)
### 3、LinuxUbuntu ### 3、LinuxUbuntu
网络->代理->选择禁用 网络->代理->选择禁用