diff --git a/.github/ISSUE_TEMPLATE/1_BUG_REPORT.md b/.github/ISSUE_TEMPLATE/1_BUG_REPORT.md
index a6531d3..c2f7066 100644
--- a/.github/ISSUE_TEMPLATE/1_BUG_REPORT.md
+++ b/.github/ISSUE_TEMPLATE/1_BUG_REPORT.md
@@ -5,9 +5,11 @@ labels: Bug
---
+
- [ ] 你是否在现有 [Issue列表](/docmirror/dev-sidecar/issues) 中搜索过相同问题,但未找到?
### Ⅰ. 请说明操作系统及DS的版本号:
+
1. 操作系统:?
2. DS版本号:?
@@ -22,10 +24,15 @@ labels: Bug
3. xxx
### Ⅴ. 请提供相关的错误日志,尽可能的详细:(日志文件在 `${user.home}/.dev-sidecar/logs/` 目录下)
+
```log
+
```
### Ⅵ. 有必要时,请提供 `${user.home}/.dev-sidecar/running.json` 文件内容:
+
+
```json
+
```
diff --git a/.github/ISSUE_TEMPLATE/2_STYLE_ISSUE.md b/.github/ISSUE_TEMPLATE/2_STYLE_ISSUE.md
index 566013a..76fc08a 100644
--- a/.github/ISSUE_TEMPLATE/2_STYLE_ISSUE.md
+++ b/.github/ISSUE_TEMPLATE/2_STYLE_ISSUE.md
@@ -5,9 +5,11 @@ labels: Style Issue
---
+
- [ ] 你是否在现有 [Issue列表](/docmirror/dev-sidecar/issues) 中搜索过相同问题,但未找到?
### Ⅰ. 请说明操作系统及DS的版本号:
+
1. 操作系统:?
2. DS版本号:?
diff --git a/.github/ISSUE_TEMPLATE/3_CONFIG_ISSUES.md b/.github/ISSUE_TEMPLATE/3_CONFIG_ISSUES.md
index c38ffc8..cdfaa26 100644
--- a/.github/ISSUE_TEMPLATE/3_CONFIG_ISSUES.md
+++ b/.github/ISSUE_TEMPLATE/3_CONFIG_ISSUES.md
@@ -5,6 +5,7 @@ labels: Config Issue
---
### Ⅰ. 你对哪个功能的配置不了解?
+
- [ ] 拦截设置:
@@ -28,6 +29,9 @@ labels: Config Issue
### Ⅱ. 请详细描述你的问题:
### Ⅲ. 有必要时,请提供 `${user.home}/.dev-sidecar/running.json` 文件内容:
+
+
```json
+
```
diff --git a/.github/ISSUE_TEMPLATE/4_FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/4_FEATURE_REQUEST.md
index 02d91fc..31e9254 100644
--- a/.github/ISSUE_TEMPLATE/4_FEATURE_REQUEST.md
+++ b/.github/ISSUE_TEMPLATE/4_FEATURE_REQUEST.md
@@ -5,10 +5,13 @@ labels: Feature Request
---
### Ⅰ. 请描述你想要的新功能:
+
### Ⅱ. 请描述你心目中新功能的样子:
+
### Ⅲ. 你希望该新功能修复哪个issue?
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 78a409b..c71ffbd 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,7 +1,9 @@
### Ⅰ. 描述此PR的作用:
### Ⅱ. 此PR修复了哪个issue吗?
-
+
+
### Ⅲ. 界面变化截屏
+
diff --git a/.github/workflows/build-and-release.yml b/.github/workflows/build-and-release.yml
index d456f4b..92405f2 100644
--- a/.github/workflows/build-and-release.yml
+++ b/.github/workflows/build-and-release.yml
@@ -1,4 +1,4 @@
-name: 'Build And Release'
+name: Build And Release
on:
push:
@@ -21,7 +21,7 @@ jobs:
node:
- 22
steps:
- - name: 'Checkout'
+ - name: Checkout
uses: actions/checkout@v4.1.7
- name: 'Setup Node.js "${{ matrix.node }}.x" environment'
@@ -30,22 +30,22 @@ jobs:
node-version: ${{ matrix.node }}
registry-url: https://npm.pkg.github.com/
- - name: 'Setup pnpm'
+ - name: Setup pnpm
uses: pnpm/action-setup@v4
- - name: 'Setup Python environment (Mac) Because of electron-builder install-app-deps requires Python setup tools'
+ - name: Setup Python environment (Mac) Because of electron-builder install-app-deps requires Python setup tools
if: matrix.os == 'macos'
uses: actions/setup-python@v5
with:
python-version: '3.10'
- - name: 'Get package info'
+ - name: Get package info
id: package-info
uses: luizfelipelaviola/get-package-info@v1
with:
path: ./packages/mitmproxy
- - name: 'Print'
+ - name: Print
run: |
echo "version = ${{ steps.package-info.outputs.version }}";
echo "github.ref_type = ${{ github.ref_type }}";
@@ -69,7 +69,7 @@ jobs:
echo "--------------------";
python --version;
- - name: 'pnpm install'
+ - name: pnpm install
run: |
echo "======================================================================";
dir || ls -lah;
@@ -139,10 +139,10 @@ jobs:
needs:
- build-and-upload
steps:
- - name: 'Checkout'
+ - name: Checkout
uses: actions/checkout@v4.1.7
- - name: 'Get package info'
+ - name: Get package info
id: package-info
uses: luizfelipelaviola/get-package-info@v1
with:
@@ -177,7 +177,7 @@ jobs:
run: |
ls -lah release;
- - name: 'Create a draft release'
+ - name: Create a draft release
uses: wangliang181230/github-action-ghr@master
env:
GITHUB_TOKEN: ${{ github.token }}
diff --git a/.github/workflows/test-and-upload.yml b/.github/workflows/test-and-upload.yml
index c48449d..a323235 100644
--- a/.github/workflows/test-and-upload.yml
+++ b/.github/workflows/test-and-upload.yml
@@ -1,13 +1,14 @@
-name: 'Test And Upload'
+name: Test And Upload
on:
push:
branches:
- master
- - '1.x'
+ - 1.x
pull_request:
branches:
- master
+ - 1.x
jobs:
test-and-upload:
@@ -22,7 +23,7 @@ jobs:
node:
- 22
steps:
- - name: 'Checkout'
+ - name: Checkout
uses: actions/checkout@v4.1.7
- name: 'Setup Node.js "${{ matrix.node }}.x" environment'
@@ -31,22 +32,22 @@ jobs:
node-version: ${{ matrix.node }}
registry-url: https://npm.pkg.github.com/
- - name: 'Setup pnpm'
+ - name: Setup pnpm
uses: pnpm/action-setup@v4
- - name: 'Setup Python environment (Mac) Because of electron-builder install-app-deps requires Python setup tools'
+ - name: Setup Python environment (Mac) Because of electron-builder install-app-deps requires Python setup tools
if: matrix.os == 'macos'
uses: actions/setup-python@v5
with:
python-version: '3.10'
- - name: 'Get package info'
+ - name: Get package info
id: package-info
uses: luizfelipelaviola/get-package-info@v1
with:
path: ./packages/mitmproxy
- - name: 'Print'
+ - name: Print
run: |
echo "version = ${{ steps.package-info.outputs.version }}";
echo "github.ref_type = ${{ github.ref_type }}";
@@ -70,7 +71,7 @@ jobs:
echo "--------------------";
python --version;
- - name: 'pnpm install'
+ - name: pnpm install
run: |
echo "======================================================================";
dir || ls -lah;
diff --git a/README.md b/README.md
index 94fd263..a98bdfa 100644
--- a/README.md
+++ b/README.md
@@ -5,80 +5,77 @@
->
> Gitee上的同步项目已被封禁,此项目将不再更新与维护 【狗头保命】
>
> 我将继续奋战在开源一线,为社区贡献更多更好的开源项目。
-> 感兴趣的可以关注我的主页 [【github】](https://github.com/greper) [【gitee】](https://gitee.com/greper)
->
+> 感兴趣的可以关注我的主页 [【github】](https://github.com/greper) [【gitee】](https://gitee.com/greper)
+
## 打个广告
->
+
>
> 我的开源证书管理工具项目,全自动申请和部署证书,有需求的可以去试试,帮忙点个star
## 重要提醒
->
+
> ------------------------------重要提醒1---------------------------------
>
> 注意:由于electron无法监听windows的关机事件,开着ds情况下直接重启电脑,会导致无法上网,你可以手动启动ds即可恢复网络,你也可以将ds设置为开机自启。
>
> 关于此问题的更多讨论请前往:
>
->
> ------------------------------重要提醒2---------------------------------
>
> 注意:本应用启动会自动修改系统代理,所以会与其他代理软件有冲突,请务必不要一起使用。
> 本应用主要目的在于直连访问github,如果你已经有飞机了,那建议还是不要用这个自行车(ds)了
->
## 一、 特性
-### 1.1、 dns优选(解决***污染问题)
+### 1.1、 dns优选(解决\*\*\*污染问题)
-* 根据网络状况智能解析最佳域名ip地址,获取最佳网络速度
-* 解决一些网站和库无法访问或访问速度慢的问题
-* 建议遇到打开比较慢的国外网站,可以优先尝试将该域名添加到dns设置中(注意:被***封杀的无效)
+- 根据网络状况智能解析最佳域名ip地址,获取最佳网络速度
+- 解决一些网站和库无法访问或访问速度慢的问题
+- 建议遇到打开比较慢的国外网站,可以优先尝试将该域名添加到dns设置中(注意:被\*\*\*封杀的无效)
### 1.2、 请求拦截
-* 拦截打不开的网站,代理到加速镜像站点上去。
-* 可配置多个镜像站作为备份
-* 具备测速机制,当访问失败或超时之后,自动切换到备用站点,使得目标服务高可用
+- 拦截打不开的网站,代理到加速镜像站点上去。
+- 可配置多个镜像站作为备份
+- 具备测速机制,当访问失败或超时之后,自动切换到备用站点,使得目标服务高可用
### 1.3、 github加速
-* github 直连加速 (通过修改sni实现,感谢 [fastGithub](https://github.com/dotnetcore/FastGithub) 提供的思路)
-* release、source、zip下载加速
-* clone 加速
-* 头像加速
-* 解决readme中图片引用无法加载的问题
-* gist.github.com 加速
-* 解决git push 偶尔失败需要输入账号密码的问题(fatal: TaskCanceledException encountered / fatal: HttpRequestException encountered)
-* raw/blame加速
+- github 直连加速 (通过修改sni实现,感谢 [fastGithub](https://github.com/dotnetcore/FastGithub) 提供的思路)
+- release、source、zip下载加速
+- clone 加速
+- 头像加速
+- 解决readme中图片引用无法加载的问题
+- gist.github.com 加速
+- 解决git push 偶尔失败需要输入账号密码的问题(fatal: TaskCanceledException encountered / fatal: HttpRequestException encountered)
+- raw/blame加速
> 以上部分功能通过`X.I.U`的油猴脚本实现, 以下是仓库和脚本下载链接,大家可以去支持一下。
>
-> *
-> *
+> -
+> -
>
> 由于此脚本在ds中是打包在本地的,更新会不及时,你可以直接通过浏览器安装油猴插件使用此脚本,从而获得最新更新(ds本地的可以通过`加速服务->基本设置->启用脚本`进行关闭)。
### 1.4、 Stack Overflow 加速
-* 将ajax.google.com代理到加速CDN上
-* recaptcha 图片验证码加速
+- 将ajax.google.com代理到加速CDN上
+- recaptcha 图片验证码加速
### 1.5、 npm加速
-* 支持开启npm代理
-* 官方与淘宝npm registry一键切换,
-* 某些npm install的时候,并且使用cnpm也无法安装时,可以尝试开启npm代理再试
+- 支持开启npm代理
+- 官方与淘宝npm registry一键切换
+- 某些npm install的时候,并且使用cnpm也无法安装时,可以尝试开启npm代理再试
-***安全警告***:
+**_安全警告_**:
-* 请勿使用来源不明的服务地址,有隐私和账号泄露风险
-* 本应用及服务端承诺不收集任何信息。介意者请使用安全模式。
+- 请勿使用来源不明的服务地址,有隐私和账号泄露风险
+- 本应用及服务端承诺不收集任何信息。介意者请使用安全模式。
## 二、快速开始
@@ -88,8 +85,8 @@
#### 1)下载安装包
-* release下载
-[Github Release](https://github.com/docmirror/dev-sidecar/releases)
+- release下载
+ [Github Release](https://github.com/docmirror/dev-sidecar/releases)
> Windows: 请选择DevSidecar-x.x.x.exe
> Mac: 请选择DevSidecar-x.x.x.dmg
@@ -123,50 +120,50 @@
### 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)秒下的,实在截不到速度的图 |
+| | 开启前 | 开启后 |
+| -------- | ------------------------------ | ------------------------------------------------- |
+| 头像 | ![](./doc/avatar2.png) | ![](./doc/avatar1.png) |
+| clone | ![](./doc/clone-before.png) | ![](./doc/clone.png) |
+| zip 下载 | ![](./doc/download-before.png) | ![](./doc/download.png)秒下的,实在截不到速度的图 |
## 三、模式说明
### 3.1、安全模式
-* 此模式:关闭拦截、关闭增强、开启dns优选、开启测速
-* 最安全,无需安装证书,可以在浏览器地址栏左侧查看域名证书
-* 功能也最弱,只有特性1,相当于查询github的国外ip,手动改hosts一个意思。
-* github的可访问性不稳定,取决于IP测速,如果有绿色ip存在,就 `有可能` 可以直连访问。
+- 此模式:关闭拦截、关闭增强、开启dns优选、开启测速
+- 最安全,无需安装证书,可以在浏览器地址栏左侧查看域名证书
+- 功能也最弱,只有特性1,相当于查询github的国外ip,手动改hosts一个意思。
+- github的可访问性不稳定,取决于IP测速,如果有绿色ip存在,就 `有可能` 可以直连访问。
![](./doc/speed.png)
### 3.2、默认模式
-* 此模式:开启拦截、关闭增强、开启dns优选、开启测速
-* 需要安装证书,通过修改sni直连访问github
-* 功能上包含特性1/2/3/4。
+- 此模式:开启拦截、关闭增强、开启dns优选、开启测速
+- 需要安装证书,通过修改sni直连访问github
+- 功能上包含特性1/2/3/4。
## 四、 最佳实践
-* 把dev-sidecar一直开着就行了(注意windows下开着ds重启电脑,会无法上网,重新打开ds即可。)
-* 建议遇到打开比较慢的国外网站,可以尝试将该域名添加到dns设置中(注意:被***封杀的无效)
+- 把dev-sidecar一直开着就行了(注意windows下开着ds重启电脑,会无法上网,重新打开ds即可。)
+- 建议遇到打开比较慢的国外网站,可以尝试将该域名添加到dns设置中(注意:被\*\*\*封杀的无效)
### 其他加速
#### 1)git clone 加速
- 方式1:快捷复制:
- > 开启脚本支持,然后在复制clone链接下方,即可复制到加速链接
+- 方式1:快捷复制:
+ > 开启脚本支持,然后在复制clone链接下方,即可复制到加速链接
+
+- 方式2:
+ > 1. 使用方式:用实际的名称替换 `{}` 的内容,即可加速clone
+ > 2. clone 出来的 remote "origin" 为fastgit的地址,需要手动改回来
+ > 3. 你也可以直接使用他们的clone加速工具 [fgit-go](https://github.com/FastGitORG/fgit-go)
- 方式2:
- > 使用方式用实际的名称替换{}的内容,即可加速clone
- >
- > clone 出来的 remote "origin" 为fastgit的地址,需要手动改回来
- > 你也可以直接使用他们的clone加速工具 [fgit-go](https://github.com/FastGitORG/fgit-go)
+#### 2)`github.com` 的镜像网站(注意:部分镜像网站不能登录)
-#### 2)github.com的镜像网站(注意:不能登录)
- >
- > 1. [hub.fastgit.org](https://hub.fastgit.org/)
- > 2. [github.com.cnpmjs.org](https://github.com.cnpmjs.org/) 这个很容易超限
+> 1. [hub.fastgit.org](https://hub.fastgit.org/) (2024/11/18:这个好像失效了?)
+> 2. [github.com.cnpmjs.org](https://github.com.cnpmjs.org/) 这个很容易超限(2024/11/18:这个好像失效了?)
+> 3. [dgithub.xyz](https://dgithub.xyz/)
## 五、api
@@ -252,16 +249,16 @@ networksetup -setwebproxy 'WiFi' 127.0.0.1 31181
如果有上面的错误提示,请尝试如下方法:
->取消访问偏好设置需要管理员密码
->系统偏好设置—>安全性与隐私—> 通用—> 高级—> 访问系统范围的偏好设置需要输入管理员密码(取消勾选)
+> 取消访问偏好设置需要管理员密码
+> 系统偏好设置—>安全性与隐私—> 通用—> 高级—> 访问系统范围的偏好设置需要输入管理员密码(取消勾选)
### 6.2、没有加速效果
->本应用仅支持https加速,请务必确认你访问的网站地址是https开头的
+> 本应用仅支持https加速,请务必确认你访问的网站地址是https开头的
1. 本应用仅支持https加速
-请务必确认你访问的地址是https开头的
-比如:
+ 请务必确认你访问的地址是https开头的
+ 比如:
2. 检查浏览器是否装了什么插件,与ds有冲突
@@ -269,10 +266,10 @@ networksetup -setwebproxy 'WiFi' 127.0.0.1 31181
4. 请确认浏览器的代理设置为使用IE代理/或者使用系统代理状态
-6. 可以尝试换个浏览器试试
+5. 可以尝试换个浏览器试试
-7. 请确认网络代理设置处于勾选状态
-正常情况下ds在“系统代理”开关打开时,会自动设置系统代理。
+6. 请确认网络代理设置处于勾选状态
+ 正常情况下ds在“系统代理”开关打开时,会自动设置系统代理。
### 6.3、浏览器打开提示证书不受信任
@@ -285,43 +282,43 @@ networksetup -setwebproxy 'WiFi' 127.0.0.1 31181
#### 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, 代理请求超时
+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、如果是增强模式,则是由于访问人数过多,正常现象
+1. 检查测速界面github.com是否有ip ,如果没有ip,则可能是由于你的网络提供商封锁了dns服务商的ip(试试能否ping通:1.1.1.1 / 9.9.9.9 )
+2. 如果是安全模式,则是因为不稳定导致的,等一会再刷新试试
+3. 如果是增强模式,则是由于访问人数过多,正常现象
### 6.5、查看日志是否有报错
- 如果还是不行,请在下方加作者好友,将服务日志发送给作者进行分析
- 日志打开方式:加速服务->右边日志按钮->打开日志文件夹
+如果还是不行,请在下方加作者好友,将服务日志发送给作者进行分析
+日志打开方式:加速服务->右边日志按钮->打开日志文件夹
![](./doc/log.png)
### 6.6、某些原本可以打开的网站打不开了
-1、可以尝试关闭pac
-2、可以将域名加入白名单
+1. 可以尝试关闭pac
+2. 可以将域名加入白名单
### 6.7、应用意外关闭导致没有网络了
应用开启后会自动修改系统代理设置,正常退出会自动关闭系统代理
当应用意外关闭时,可能会因为没有将系统代理恢复,从而导致完全无法上网。
- 对于此问题有如下几种解决方案可供选择:
- 1、重新打开应用即可(右键应用托盘图标可完全退出,将会正常关闭系统代理设置)
- 2、如果应用被卸载了,此时需要[手动关闭系统代理设置](./doc/recover.md)
- 3、如果你是因为开着ds的情况下重启电脑导致无法上网,你可以设置ds为开机自启
+对于此问题有如下几种解决方案可供选择:
+
+1. 重新打开应用即可(右键应用托盘图标可完全退出,将会正常关闭系统代理设置)
+2. 如果应用被卸载了,此时需要[手动关闭系统代理设置](./doc/recover.md)
+3. 如果你是因为开着ds的情况下重启电脑导致无法上网,你可以设置ds为开机自启
### 6.8、卸载应用后上不了网,git请求不了
@@ -345,7 +342,7 @@ npm config delete https-proxy
## 七、在其他程序使用
-* [java程序使用](./doc/other.md#Java程序使用)
+- [java程序使用](./doc/other.md#Java程序使用)
## 八、贡献代码
@@ -358,6 +355,7 @@ npm config delete https-proxy
#### 2)安装 `lerna`
运行如下命令即可安装所需依赖:
+
> 注:lerna指定为6.x版本,更高版本会导致打包失败(不兼容导致)
```shell
@@ -407,19 +405,20 @@ npm run electron:build
欢迎bug反馈,需求建议,技术交流等
1、 加群(请备注dev-sidecar,或简称DS)
-* 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 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 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 / 200(new)
+
+- 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 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 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 / 200(new)
## 十、求star
我的其他项目求star
-* [fast-crud](https://github.com/fast-crud/fast-crud) : 开发crud快如闪电
-* [certd](https://github.com/certd/certd) : 让你的证书永不过期
-* [trident-sync](https://github.com/handsfree-work/trident-sync) : 二次开发项目同步升级工具
+- [fast-crud](https://github.com/fast-crud/fast-crud) : 开发crud快如闪电
+- [certd](https://github.com/certd/certd) : 让你的证书永不过期
+- [trident-sync](https://github.com/handsfree-work/trident-sync) : 二次开发项目同步升级工具
## 十一、感谢
@@ -429,14 +428,14 @@ npm run electron:build
本项目参考如下开源项目
-* [node-mitmproxy](https://github.com/wuchangming/node-mitmproxy)
-* [ReplaceGoogleCDN](https://github.com/justjavac/ReplaceGoogleCDN)
+- [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),本项目的系统代理排除域名功能中,使用了该白名单。
+- [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/)
+- [FastGit UK](https://fastgit.org/)
diff --git a/doc/caroot.md b/doc/caroot.md
index 0c75088..e996b96 100644
--- a/doc/caroot.md
+++ b/doc/caroot.md
@@ -3,7 +3,9 @@
## 一、为什么要信任根证书。
要回答这个问题需要先掌握下面两个知识点
+
### 知识点1:什么是根证书
+
[百度百科-什么是根证书](https://baike.baidu.com/item/%E6%A0%B9%E8%AF%81%E4%B9%A6/9874620?fr=aladdin)
当访问目标网站是https协议时,服务器会发送一个由根证书签发的网站ssl证书给浏览器,让浏览器用这个ssl证书给数据加密。
@@ -14,6 +16,7 @@
windows、mac、linux或者浏览器他们都内置了市面上可信的大型证书颁发机构的根证书。
### 知识点2:中间人攻击
+
本应用的实现原理如下图:
![](./flow.jpg)
@@ -29,7 +32,7 @@ windows、mac、linux或者浏览器他们都内置了市面上可信的大型
例如加速github就需要修改如下几处
-1. 直连访问github需要修改tls握手时的sni域名,规避***的sni阻断问题。
+1. 直连访问github需要修改tls握手时的sni域名,规避\*\*\*的sni阻断问题。
2. asserts.github.com等静态资源拦截替换成fastgit.org的镜像地址
DevSidecar在第一次启动时会在本地随机生成一份根证书,当有用户访问github时,就用这份根证书来签发一份假的叫github.com的证书。
@@ -50,7 +53,7 @@ DevSidecar在第一次启动时会在本地随机生成一份根证书,当有
> 或者从源码自行编译安装
> 对于拦截配置里的替代网站风险:
+>
> 1. 尽量缩小替代配置的范围
> 2. 不使用来源不明的镜像地址,尽量使用知名度较高的镜像地址
> 3. 你甚至可以将其他拦截配置全部删除,只保留github相关配置
->
diff --git a/doc/linux.md b/doc/linux.md
index 5a2aae5..5609336 100644
--- a/doc/linux.md
+++ b/doc/linux.md
@@ -1,4 +1,5 @@
# linux 支持
+
`linux`使用说明,目前仅支持`ubuntu_x64(GNOME)`,其他`linux`未测试
> 注意:需要开启[sudo免密支持](https://www.jianshu.com/p/5d02428f313d)
@@ -6,30 +7,38 @@
## 安装
### 1. ubuntu
- * 下载`DevSidecar-x.x.x.deb`
- * 执行命令安装 `dpkg -i DevSidecar-x.x.x.deb`
- * 去应用列表里面找到dev-sidecar应用,打开即可
+
+- 下载`DevSidecar-x.x.x.deb`
+- 执行命令安装 `dpkg -i DevSidecar-x.x.x.deb`
+- 去应用列表里面找到dev-sidecar应用,打开即可
### 2. 其他linux系统(未测试)
-* 下载 `DevSidecar-x.x.x.AppImage`
-* 设置可执行权限 `sudo chmod +X DevSidecar-x.x.x.AppImage`
-* 双击运行
+
+- 下载 `DevSidecar-x.x.x.AppImage`
+- 设置可执行权限 `sudo chmod +X DevSidecar-x.x.x.AppImage`
+- 双击运行
## 证书安装
+
默认模式和增强模式需要系统信任CA证书。
由于linux上火狐和chrome都不走系统证书,所以除了安装系统证书之外,还需要给浏览器安装证书
+
### 1. 系统证书安装
+
根据弹出的提示:
- * 点击首页右上角“安装根证书”按钮
- * 点击“点此去安装”
- * 提示安装成功即可
+
+- 点击首页右上角“安装根证书”按钮
+- 点击“点此去安装”
+- 提示安装成功即可
### 2. 火狐浏览器安装证书
-* 火狐浏览器->选项->隐私与安全->证书->查看证书
-* 证书颁发机构->导入
-* 选择证书文件在`~/.dev-sidecar`目录下
-* 勾选信任由此证书颁发机构来标识网站,确定即可
+
+- 火狐浏览器->选项->隐私与安全->证书->查看证书
+- 证书颁发机构->导入
+- 选择证书文件在`~/.dev-sidecar`目录下
+- 勾选信任由此证书颁发机构来标识网站,确定即可
### 3. chrome浏览器安装证书
+
证书文件目录为`~/.dev-sidecar`
![](../packages/gui/public/setup-linux.png)
diff --git a/doc/other.md b/doc/other.md
index 1779fc6..71f739c 100644
--- a/doc/other.md
+++ b/doc/other.md
@@ -1,13 +1,15 @@
# 其他程序使用
## Java程序使用
- > 由[Enaium](https://github.com/Enaium) 提供,未做验证,可供参考
+
+> 由 [Enaium](https://github.com/Enaium) 提供,未做验证,可供参考
>
-需要先通过keytool安装证书
-`keytool -import -alias dev-sidecar -keystore "jdk路径\security\cacerts" -file 用户目录\.dev-sidecar\dev-sidecar.ca.crt`默认密码为`changeit`
-启动时还需要设置参数
-`-Dhttp.proxyHost=localhost -Dhttp.proxyPort=31181 -Dhttps.proxyHost=localhost -Dhttps.proxyPort=31181`
-Gradle还需在`用户目录/.gradle/gradle.properties`创建配置文件
+> 需要先通过keytool安装证书
+> `keytool -import -alias dev-sidecar -keystore "jdk路径\security\cacerts" -file 用户目录\.dev-sidecar\dev-sidecar.ca.crt`默认密码为`changeit`
+> 启动时还需要设置参数
+> `-Dhttp.proxyHost=localhost -Dhttp.proxyPort=31181 -Dhttps.proxyHost=localhost -Dhttps.proxyPort=31181`
+> Gradle还需在`用户目录/.gradle/gradle.properties`创建配置文件
+
```properties
systemProp.http.proxyHost=localhost
systemProp.http.proxyPort=31181
diff --git a/doc/recover.md b/doc/recover.md
index b99a5cd..7baf4ed 100644
--- a/doc/recover.md
+++ b/doc/recover.md
@@ -1,20 +1,26 @@
# 卸载与恢复网络
+
由于应用启动后会自动设置系统代理,正常退出时会关闭系统代理。
当应用意外关闭,或者未正常退出后被卸载,此时会因为系统代理没有恢复从而导致完全上不了网。
目前electron在windows系统上无法监听系统重启事件。更多相关资料 [electron issues](https://github.com/electron/electron/pull/24261)
## 恢复代理设置
+
### 1、windows 代理关闭
+
如何打开查看windows代理设置:
-* win10: 开始->设置->网络和Internet->最下方代理
-* win7: 开始->控制面板->网络和Internet->网络和共享中心->左下角Internet选项->连接选项卡->局域网设置
+
+- win10: 开始->设置->网络和Internet->最下方代理
+- win7: 开始->控制面板->网络和Internet->网络和共享中心->左下角Internet选项->连接选项卡->局域网设置
![windows](./proxy.png)
### 2、mac 代理关闭
+
网络->网卡->代理->去掉http和https的两个勾
![](./mac-proxy.png)
### 3、Linux(Ubuntu)
+
网络->代理->选择禁用
diff --git a/packages/gui/README.md b/packages/gui/README.md
index 77947a7..09c5c06 100644
--- a/packages/gui/README.md
+++ b/packages/gui/README.md
@@ -1,24 +1,29 @@
# dev-sidecar-gui
## Project setup
+
```
yarn install
```
### Compiles and hot-reloads for development
+
```
yarn serve
```
### Compiles and minifies for production
+
```
yarn build
```
### Lints and fixes files
+
```
yarn lint
```
### Customize configuration
+
See [Configuration Reference](https://cli.vuejs.org/config/).