You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
dev-sidecar/README.md

202 lines
7.6 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# dev-sidecar
开发者边车命名取自service-mesh的service-sidecar意为为开发者打辅助的边车工具
通过本地代理的方式将http请求代理到一些国内的加速通道上
不用` qiang`也能解决一些网站和库无法访问或访问速度慢的问题
<a href='https://gitee.com/docmirror/dev-sidecar'><img src='https://gitee.com/docmirror/dev-sidecar/badge/star.svg?theme=dark' alt='star'/></a>
<a href='https://github.com/docmirror/dev-sidecar'><img alt="GitHub stars" src="https://img.shields.io/github/stars/docmirror/dev-sidecar?logo=github"></a>
## 特性
### 1、 dns优选
根据网络状况智能解析最佳域名ip地址获取最佳网络速度
建议遇到打开比较慢的国外网站可以优先尝试将该域名添加到dns设置中注意被GFW封杀的无效
### 2、 请求拦截
拦截打不开的网站,代理到加速镜像站点上去。
可配置多个镜像站作为备份
具备测速机制,当访问失败或超时之后,自动切换到备用站点。
使得目标服务高可用
### 3、 github加速
* release、source、zip下载加速
* clone 加速
* 头像加速
* 解决readme中图片引用无法加载的问题
* gist.github.com 加速
* 解决git push 偶尔失败需要输入账号密码的问题fatal: TaskCanceledException encountered / fatal: HttpRequestException encountered
* raw/blame加速
### 4、 Stack Overflow 加速
* 将ajax.google.com代理到加速CDN上
* recaptcha 图片验证码加速
### 5、 npm加速
* 支持开启npm代理
* 官方与淘宝npm registry一键切换,
* 某些npm install的时候并且使用cnpm也无法安装时可以尝试开启npm代理再试
### 6、 增强功能
* 众所周知的原因,不能在这里展示太多,自己下载来安装看看吧
## 快速开始
支持windows、Mac
### DevSidecar桌面应用
#### 1 下载安装包
下载安装包:
阿里云直接下载
[windows版](http://dev-sidecar.docmirror.cn/update/DevSidecar-1.3.2.exe)
[Mac版](http://dev-sidecar.docmirror.cn/update/DevSidecar-1.4.0.dmg)
注意mac版安装需要在“系统偏好设置->安全性与隐私->通用”中解锁并允许应用安装
从Release下载
[Gitee Release](https://gitee.com/docmirror/dev-sidecar/releases)
[Github Release](https://github.com/docmirror/dev-sidecar/releases)
安装后打开
![](./doc/index.png)
#### 2 安装根证书
第一次打开会提示安装证书,根据提示操作即可
>根证书是本地随机生成的,所以不用担心根证书的安全问题
>你也可以在加速服务设置中自定义根证书PEM格式的证书与私钥
#### 3 开始加速吧
去试试打开github
---------
>第一次访问会去国外的dns服务器上获取ip会比较慢一点后面就快了
---------
### 开启前 vs 开启后
| | 开启前 | 开启后 |
| ---- | ---- | ---- |
|头像| ![](./doc/avatar2.png) |![](./doc/avatar1.png) |
|clone |![](./doc/clone-before.png) |![](./doc/clone.png) |
|zip 下载 |![](./doc/download-before.png) |![](./doc/download.png)秒下的,实在截不到速度的图 |
## 最佳实践
把dev-sidecar一直开着就行了
建议遇到打开比较慢的国外网站可以优先尝试将该域名添加到dns设置中注意被GFW封杀的无效
如果还访问不了就需要寻找镜像cdn进行拦截代理
### 其他加速
1. git clone 加速
方式1快捷复制
> 开启脚本支持然后在复制clone链接下方即可复制到加速链接
方式2
> 使用方式用实际的名称替换{}的内容即可加速clone
> https://hub.fastgit.org/{username}/{reponame}.git
> clone 出来的 remote "origin" 为fastgit的地址需要手动改回来
> 你也可以直接使用他们的clone加速工具 [fgit-go](https://github.com/FastGitORG/fgit-go)
2. github.com的镜像网站(注意:不能登录)
>1. [hub.fastgit.org](https://hub.fastgit.org/)
>2. [github.com.cnpmjs.org](https://github.com.cnpmjs.org/) 这个很容易超限
## api
### 拦截配置
没有配置域名的不会拦截,其他根据配置进行拦截处理
```js
const intercepts = {
// 要拦截的域名
'github.com': {
//需要拦截url的正则表达式
'/.*/.*/releases/download/': {
//拦截类型
// redirect:url, 临时重定向(url会变一些下载资源可以通过此方式配置)
// proxy:url, 代理url不会变没有跨域问题
// abort:true, 取消请求适用于被GFW封锁的资源找不到替代直接取消请求快速失败节省时间
// success:true, 直接返回成功请求(某些请求不想发出去,可以伪装成功返回)
redirect: 'download.fastgit.org'
},
},
'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 //取消请求被GFW封锁的资源找不到替代直接取消请求快速失败节省时间
}
}
}
```
### DNS优选配置
某些域名解析出来的ip会无法访问比如api.github.com会被解析到新加坡的ip上新加坡的服务器在上午挺好到了晚上就卡死基本不可用
通过从dns上获取ip列表切换不同的ip进行尝试最终会挑选到一个最快的ip
```js
dns: {
mapping: {
//
'api.github.com': 'usa', // "解决push的时候需要输入密码的问题",
'gist.github.com': 'usa' // 解决gist无法访问的问题
"*.githubusercontent.com": "usa" // 解决github头像经常下载不到的问题
}
},
```
注意暂时只支持IPv4的解析
## 问题排查
如果没有加速效果,请根据以下步骤进行排查
#### 1. 请确认windows的代理设置处于勾选状态
如何打开查看windows代理设置
* win10: 开始->设置->网络和Internet->最下方代理
* win7: 开始->控制面板->网络和Internet->网络和共享中心->左下角Internet选项->连接选项卡->局域网设置
![](./doc/proxy.png)
#### 2. 尝试将代理设置关闭再重新打开
按上图中先关闭代理,保存,再打开代理,再保存
#### 3. 如果还是不行,请在下方加作者好友,将服务日志发送给作者进行分析
日志打开方式:加速服务->右边日志按钮->打开日志文件夹
![](./doc/log.png)
## 联系作者
欢迎bug反馈需求建议技术交流等请备注dev-sidecar或简称DS
![](./doc/contact.png)
## 感谢
本项目使用lerna包管理工具
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
本项目参考如下开源项目
* [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)
本项目加速资源由如下组织提供
* [fastgit](https://fastgit.org/)