99 lines
4.5 KiB
Markdown
Executable File
99 lines
4.5 KiB
Markdown
Executable File
# 写在前面
|
||
原作者（不具名）于2019年5月15日删除了并停止开发这个伟大的项目，不管因为什么原因，我们都应该感谢原作者的付出，希望有缘再见！
|
||
|
||
## 使用时注意事项：
|
||
- 本应用内置http_proxy服务，如果您系统中或浏览器中安装有其他代理工具，服务，插件等请暂时停用或关闭服务或卸载后使用本软件。
|
||
- 本应用使用`gsetting`设置系统代理，所以有些Linux系统无法使用该功能，请参考[Ubuntu.md](https://github.com/qingshuisiyuan/electron-ssr-backup/blob/master/Ubuntu.md)手动设置系统代理。
|
||
- 火狐浏览器请注意在浏览器设置中更改代理方式为使用系统代理或手动设置。
|
||
- Chrome浏览器默认使用系统代理
|
||
|
||
## 2019-08-05更新
|
||
更新内容：<br>
|
||
- 增加原作者发布的0.2.5安装包，未在release发布请访问项目文件夹[0.2.5App](https://github.com/qingshuisiyuan/electron-ssr-backup/tree/master/0.2.5App)<br>
|
||
- 更新并收集issues并制成文档[issue.md](https://github.com/qingshuisiyuan/electron-ssr-backup/blob/master/issue.md)<br>
|
||
- 说明issues作用<br>
|
||
|
||
## 下载
|
||
提供0.2.6版本与0.2.5版本，建议优先使用0.2.6版本
|
||
0.2.6下载地址见[Github release](https://github.com/qingshuisiyuan/electron-ssr-backup/releases)，对应的操作系统下载的文件为
|
||
|
||
- Windows `electron-ssr-setup-x.x.x.exe`
|
||
- Mac `electron-ssr-x.x.x.dmg`
|
||
- Linux 优先建议下载`electron-ssr-x.x.x.AppImage`，直接双击运行。如果无法使用或者想直接下载自己系统专用包请看下一条
|
||
- Arch或者基于Arch的系统，下载`electron-ssr-x.x.x.pacman`
|
||
- RedHat系列的系统，下载`electron-ssr-x.x.x.rpm`
|
||
- Debian系列的系统，下载`electron-ssr-x.x.x.deb`
|
||
- 其他Linux系统或者通用Linux系统可下载`electron-ssr-x.x.x.tar.gz`（不会使用.tar.gz的请自行百度）
|
||
|
||
## Debian系列安装与配置[Ubuntu.md](https://github.com/qingshuisiyuan/electron-ssr-backup/blob/master/Ubuntu.md)
|
||
|
||
## 收集已知问题和解决方案[issue.md](https://github.com/qingshuisiyuan/electron-ssr-backup/blob/master/issue.md)
|
||
|
||
## Issus
|
||
|
||
在发issue前请先在issue中搜索是否有同类issue，如果有请跟帖。<br>
|
||
另外发Bug类issue请详细描述你的使用环境，包括但不限于操作系统、软件版本，操作步骤，报错日志等。<br>
|
||
欢迎在issue写出你们的经验，这对这个项目非常重要！包括但不限于如何解决错误，如何在不同的操作系统安装软件、依赖，设置代理，成功的使用软件的经验。对于正确的issue，我会收集到项目代码中。<br>
|
||
|
||
## ShadowsocksR跨平台客户端
|
||
|
||
这是一个跨平台（支持Windows MacOS Linux系统）的`ShadowsocksR`客户端桌面应用，它功能丰富，支持windows版大部分功能，更有更多人性化功能。它是开源的，它来源于开源，回馈以开源。
|
||
|
||
## 功能特色
|
||
|
||
- 支持手动添加配置
|
||
- 支持服务器订阅更新，复制该地址测试
|
||
- 支持二维码扫描(请确保屏幕中只有一个有效的二维码)，扫描该二维码测试
|
||
- 支持从剪贴板复制、从配置文件导入等方式添加配置
|
||
- 支持复制二维码图片、复制SSR链接(右键应用内二维码，点击右键菜单中的复制)
|
||
- 支持通过点击ss/ssr链接添加配置并打开应用(仅Mac和Windows)
|
||
- 支持切换系统代理模式:PAC、全局、不代理
|
||
- 内置http_proxy服务，可在选项中开启或关闭
|
||
- 支持配置项变更
|
||
- 更多功能尽在任务栏菜单中
|
||
|
||
|
||
## 配置文件位置
|
||
|
||
- Windows `C:\Users\{your username}\AppData\Roaming\electron-ssr\gui-config.json`
|
||
- Mac `~/Library/Application Support/electron-ssr/gui-config.json`
|
||
- Linux `~/.config/gui-config.json`
|
||
|
||
## 快捷键
|
||
|
||
加入快捷键本来是为了解决部分Linux发行版无法显示图标导致功能无法使用而加入的，当然其它系统也是可以使用的，同时支持在设置中进行开启/关闭以及更换按键的操作。
|
||
|
||
### 全局快捷键
|
||
|
||
- `CommandOrControl+Shift+W` 切换主窗口显隐
|
||
- `未设置` 切换系统代理
|
||
|
||
### 应用内快捷键
|
||
- `CommandOrControl+Shift+B` 切换是否显示操作菜单，仅Linux可用
|
||
|
||
## 已知Bug
|
||
|
||
- 部分Linux系统无法切换系统代理模式（本应用使用`gsetting`设置系统代理，所以有些Linux系统无法使用该功能），如果你知道如何实现，欢迎发issue告知。
|
||
- Windows系统切换全局代理不生效
|
||
|
||
|
||
## 开发和构建
|
||
|
||
``` bash
|
||
# or npm install
|
||
yarn
|
||
|
||
# 开发时
|
||
npm run dev
|
||
|
||
# 打包构建
|
||
npm run build
|
||
|
||
# 单元测试
|
||
npm run mocha
|
||
|
||
# 代码风格检查
|
||
npm run lint
|
||
|
||
```
|