1 Star 0 Fork 1.2K

jinbo / dev-sidecar

forked from docmirror / dev-sidecar 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MPL-2.0

dev-sidecar

开发者边车,命名取自service-mesh的service-sidecar,意为为开发者打辅助的边车工具
通过本地代理的方式将https请求代理到一些国内的加速通道上

star GitHub stars

一、 特性

1、 dns优选(解决***污染问题)

  • 根据网络状况智能解析最佳域名ip地址,获取最佳网络速度
  • 解决一些网站和库无法访问或访问速度慢的问题
  • 建议遇到打开比较慢的国外网站,可以优先尝试将该域名添加到dns设置中(注意:被***封杀的无效)

2、 请求拦截

  • 拦截打不开的网站,代理到加速镜像站点上去。
  • 可配置多个镜像站作为备份
  • 具备测速机制,当访问失败或超时之后,自动切换到备用站点,使得目标服务高可用

3、 github加速

  • github 直连加速 (通过修改sni实现,感谢 fastGithub 提供的思路)
  • release、source、zip下载加速
  • clone 加速
  • 头像加速
  • 解决readme中图片引用无法加载的问题
  • gist.github.com 加速
  • 解决git push 偶尔失败需要输入账号密码的问题(fatal: TaskCanceledException encountered / fatal: HttpRequestException encountered)
  • raw/blame加速

以上部分功能通过X.I.U的油猴脚本实现, 以下是仓库和脚本下载链接,大家可以去支持一下。

由于此脚本在ds中是打包在本地的,更新会不及时,你可以直接通过浏览器安装油猴插件使用此脚本,从而获得最新更新(ds本地的可以通过加速服务->基本设置->启用脚本进行关闭)。

4、 Stack Overflow 加速

  • 将ajax.google.com代理到加速CDN上
  • recaptcha 图片验证码加速

5、 npm加速

  • 支持开启npm代理
  • 官方与淘宝npm registry一键切换,
  • 某些npm install的时候,并且使用cnpm也无法安装时,可以尝试开启npm代理再试

安全警告

  • 请勿使用来源不明的服务地址,有隐私和账号泄露风险
  • 本应用及服务端承诺不收集任何信息。介意者请使用安全模式。

二、快速开始

支持windows、Mac、Linux(Ubuntu)

DevSidecar桌面应用

1 下载安装包

Windows: 请选择DevSidecar-x.x.x.exe
Mac: 请选择DevSidecar-x.x.x.dmg
Ubuntu: 请选择DevSidecar-x.x.x.deb
其他linux: 请选择DevSidecar-x.x.x.AppImage (未做测试,不保证能用)

linux安装说明请参考 linux安装文档

注意:由于没有买应用证书,所以应用在下载安装时会有“未知发行者”等安全提示,选择保留即可。

2 安装后打开

注意:mac版安装需要在“系统偏好设置->安全性与隐私->通用”中解锁并允许应用安装

3 安装根证书

第一次打开会提示安装证书,根据提示操作即可

更多有关根证书的说明,请参考 为什么要安装根证书?

根证书是本地随机生成的,所以不用担心根证书的安全问题(本应用不收集任何用户信息)
你也可以在加速服务设置中自定义根证书(PEM格式的证书与私钥)

火狐浏览器需要手动安装证书

4 开始加速吧

去试试打开github


第一次访问会去国外的dns服务器上获取ip,会比较慢一点,后面就快了


开启前 vs 开启后

开启前 开启后
头像
clone
zip 下载 秒下的,实在截不到速度的图

三、模式说明

安全模式

  • 此模式:关闭拦截、关闭增强、开启dns优选、开启测速
  • 最安全,无需安装证书,可以在浏览器地址栏左侧查看域名证书
  • 功能也最弱,只有特性1,相当于查询github的国外ip,手动改hosts一个意思。
  • github的可访问性不稳定,取决于IP测速,如果有绿色ip存在,就 有可能 可以直连访问。

默认模式

  • 此模式:开启拦截、关闭增强、开启dns优选、开启测速
  • 需要安装证书,通过修改sni直连访问github
  • 功能上包含特性1/2/3/4。

四、 最佳实践

  • 把dev-sidecar一直开着就行了
  • 建议遇到打开比较慢的国外网站,可以尝试将该域名添加到dns设置中(注意:被GFW封杀的无效)

其他加速

  1. git clone 加速

方式1:快捷复制:

开启脚本支持,然后在复制clone链接下方,即可复制到加速链接

方式2:

使用方式用实际的名称替换{}的内容,即可加速clone
https://hub.fastgit.org/{username}/{reponame}.git
clone 出来的 remote "origin" 为fastgit的地址,需要手动改回来
你也可以直接使用他们的clone加速工具 fgit-go

  1. github.com的镜像网站(注意:不能登录)
  1. hub.fastgit.org
  2. github.com.cnpmjs.org 这个很容易超限

五、api

拦截配置

没有配置域名的不会拦截,其他根据配置进行拦截处理

const intercepts = {
  // 要拦截的域名
  'github.com': {
     //需要拦截url的正则表达式
     '/.*/.*/releases/download/': {
        //拦截类型
        // redirect:url,  临时重定向(url会变,一些下载资源可以通过此方式配置)
        // proxy:url,     代理(url不会变,没有跨域问题)
        // abort:true,    取消请求(适用于被GFW封锁的资源,找不到替代,直接取消请求,快速失败,节省时间)
        // success:true,  直接返回成功请求(某些请求不想发出去,可以伪装成功返回)
        redirect: 'download.fastgit.org'
      },
      '.*':{
         proxy:'github.com', 
         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 //取消请求,被GFW封锁的资源,找不到替代,直接取消请求,快速失败,节省时间
      }
    }       
}

DNS优选配置

某些域名解析出来的ip会无法访问,(比如api.github.com会被解析到新加坡的ip上,新加坡的服务器在上午挺好,到了晚上就卡死,基本不可用)
通过从dns上获取ip列表,切换不同的ip进行尝试,最终会挑选到一个最快的ip

 dns: {
    mapping: {
      //
      'api.github.com': 'usa', // "解决push的时候需要输入密码的问题",
      'gist.github.com': 'usa' // 解决gist无法访问的问题
      "*.githubusercontent.com": "usa" // 解决github头像经常下载不到的问题
    }
  },

注意:暂时只支持IPv4的解析

六、问题排查

1、dev-sidecar的前两个开关没有处于打开状态

  1. 尝试将开关按钮手动打开
  2. 请尝试右键dev-sidecar图标,点退出。再重新打开
  3. 如果还不行,请将日志发送给作者

如果是mac系统,可能是下面的原因

Mac系统使用时,首页的系统代理开关无法打开

出现这个问题可能是没有开启系统代理命令的执行权限

networksetup -setwebproxy 'WiFi' 127.0.0.1 1181 
#看是否有如下错误提示
** Error: Command requires admin privileges.

如果有上面的错误提示,请尝试如下两种方法:

1、 取消访问偏好设置需要管理员密码 系统偏好设置—>安全性与隐私—> 通用—> 高级—> 访问系统范围的偏好设置需要输入管理员密码(取消勾选)

2、 可能是由于安装了xcode,但未授权导致 请在终端输入如下命令进行授权

sudo xcodebuild -license
# 一直按回车,该agree的时候输入agree即可

然后再次尝试看是否能够打开系统代理开关
如果还不行,请联系作者

2、没有加速效果

本应用仅支持https加速,请务必确认你访问的网站地址是https开头的

  1. 本应用仅支持https加速 请务必确认你访问的地址是https开头的 比如: https://github.com/

  2. 检查浏览器是否装了什么插件,与ds有冲突

  3. 检查是否安装了其他代理软件,与ds有冲突

  4. 请确认浏览器的代理设置为使用IE代理/或者使用系统代理状态

  5. 可以尝试换个浏览器试试

  6. 请确认网络代理设置处于勾选状态
    正常情况下dev-sidecar在“系统代理”开关打开时,会自动设置代理。

3、浏览器打开提示证书不受信任

  • windows: 请确认证书已正确安装在“信任的根证书颁发机构”下

  • mac: 请确认证书已经被安装并已经设置信任。

  • 火狐浏览器:火狐浏览器不走系统的根证书,需要在选项中添加根证书
    1、火狐浏览器->选项->隐私与安全->证书->查看证书
    2、证书颁发机构->导入
    3、选择证书文件C:\Users(用户)\Administrator(你的账号)\.dev-sidecar\dev-sidecar.ca.crt(Mac或linux为~/.dev-sidecar目录)
    4、勾选信任由此证书颁发机构来标识网站,确定即可

4. 打开github显示连接超时

DevSidecar Warning:
Error: www.github.com:443, 代理请求超时

如果是安全模式,则是因为不稳定导致的,等一会再刷新试试
如果是增强模式,则是由于访问人数过多,正常现象

5、查看日志是否有报错

如果还是不行,请在下方加作者好友,将服务日志发送给作者进行分析
日志打开方式:加速服务->右边日志按钮->打开日志文件夹

6、某些原本可以打开的网站打不开了

1、可以尝试关闭pac
2、可以将域名加入白名单

7、应用意外关闭导致没有网络了

应用开启后会自动修改系统代理设置,正常退出会自动关闭系统代理
当应用意外关闭时,可能会因为没有将系统代理恢复,从而导致完全无法上网。

对于此问题有如下几种解决方案可供选择:
1、重新打开应用即可(右键应用托盘图标可完全退出,将会正常关闭系统代理设置)
2、如果应用被卸载了,此时需要手动关闭系统代理设置
3、如果你是因为开着ds的情况下重启电脑导致无法上网,你可以设置ds为开机自启

七、在其他程序使用

八、贡献代码

开发调试模式启动

运行如下命令即可开发模式启动

git clone https://github.com/docmirror/dev-sidecar

cd dev-sidecar 

npm install lerna -g
lerna bootstrap

cd packages/gui

npm run electron

如果electron依赖包下载不动,可以开启ds的npm加速

打包成可执行文件

# 先执行上面的步骤,然后运行如下命令打包成可执行文件
npm run electron:build

提交pr

如果你想将你的修改贡献出来,请提交pr

九、联系作者

欢迎bug反馈,需求建议,技术交流等(请备注dev-sidecar,或简称DS)

十、求star

我的其他项目求star

  • fast-crud : 开发crud快如闪电
  • certd : 让你的证书永不过期

十一、广告

十二、感谢

本项目使用lerna包管理工具

lerna

本项目参考如下开源项目

特别感谢

本项目部分加速资源由如下组织提供

Mozilla Public License Version 2.0 ================================== 1. Definitions -------------- 1.1. "Contributor" means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software. 1.2. "Contributor Version" means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor's Contribution. 1.3. "Contribution" means Covered Software of a particular Contributor. 1.4. "Covered Software" means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof. 1.5. "Incompatible With Secondary Licenses" means (a) that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or (b) that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. 1.6. "Executable Form" means any form of the work other than Source Code Form. 1.7. "Larger Work" means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software. 1.8. "License" means this document. 1.9. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License. 1.10. "Modifications" means any of the following: (a) any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or (b) any new file in Source Code Form that contains any Covered Software. 1.11. "Patent Claims" of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version. 1.12. "Secondary License" means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses. 1.13. "Source Code Form" means the form of the work preferred for making modifications. 1.14. "You" (or "Your") means an individual or a legal entity exercising rights under this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity. 2. License Grants and Conditions -------------------------------- 2.1. Grants Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: (a) under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and (b) under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. 2.2. Effective Date The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution. 2.3. Limitations on Grant Scope The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor: (a) for any code that a Contributor has removed from Covered Software; or (b) for infringements caused by: (i) Your and any other third party's modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or (c) under Patent Claims infringed by Covered Software in the absence of its Contributions. This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4). 2.4. Subsequent Licenses No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3). 2.5. Representation Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License. 2.6. Fair Use This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents. 2.7. Conditions Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1. 3. Responsibilities ------------------- 3.1. Distribution of Source Form All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients' rights in the Source Code Form. 3.2. Distribution of Executable Form If You distribute Covered Software in Executable Form then: (a) such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and (b) You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients' rights in the Source Code Form under this License. 3.3. Distribution of a Larger Work You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s). 3.4. Notices You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies. 3.5. Application of Additional Terms You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction. 4. Inability to Comply Due to Statute or Regulation --------------------------------------------------- If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it. 5. Termination -------------- 5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. 5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. ************************************************************************ * * * 6. Disclaimer of Warranty * * ------------------------- * * * * Covered Software is provided under this License on an "as is" * * basis, without warranty of any kind, either expressed, implied, or * * statutory, including, without limitation, warranties that the * * Covered Software is free of defects, merchantable, fit for a * * particular purpose or non-infringing. The entire risk as to the * * quality and performance of the Covered Software is with You. * * Should any Covered Software prove defective in any respect, You * * (not any Contributor) assume the cost of any necessary servicing, * * repair, or correction. This disclaimer of warranty constitutes an * * essential part of this License. No use of any Covered Software is * * authorized under this License except under this disclaimer. * * * ************************************************************************ ************************************************************************ * * * 7. Limitation of Liability * * -------------------------- * * * * Under no circumstances and under no legal theory, whether tort * * (including negligence), contract, or otherwise, shall any * * Contributor, or anyone who distributes Covered Software as * * permitted above, be liable to You for any direct, indirect, * * special, incidental, or consequential damages of any character * * including, without limitation, damages for lost profits, loss of * * goodwill, work stoppage, computer failure or malfunction, or any * * and all other commercial damages or losses, even if such party * * shall have been informed of the possibility of such damages. This * * limitation of liability shall not apply to liability for death or * * personal injury resulting from such party's negligence to the * * extent applicable law prohibits such limitation. Some * * jurisdictions do not allow the exclusion or limitation of * * incidental or consequential damages, so this exclusion and * * limitation may not apply to You. * * * ************************************************************************ 8. Litigation ------------- Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party's ability to bring cross-claims or counter-claims. 9. Miscellaneous ---------------- This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor. 10. Versions of the License --------------------------- 10.1. New Versions Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number. 10.2. Effect of New Versions You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward. 10.3. Modified Versions If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License). 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached. Exhibit A - Source Code Form License Notice ------------------------------------------- This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. You may add additional accurate notices of copyright ownership. Exhibit B - "Incompatible With Secondary Licenses" Notice --------------------------------------------------------- This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.

简介

开发者边车,github打不开,github 加速, git clone加速,google CDN加速,Stack Overflow加速 展开 收起
MPL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/jinbo0820/dev-sidecar.git
git@gitee.com:jinbo0820/dev-sidecar.git
jinbo0820
dev-sidecar
dev-sidecar
master

搜索帮助

14c37bed 8189591 565d56ea 8189591