Skip to content

Latest commit

 

History

History
124 lines (80 loc) · 4.89 KB

README.md

File metadata and controls

124 lines (80 loc) · 4.89 KB
Raw

ShadowsocksR cross-platform client

中文

ShadowsocksR is a cross-platform desktop client with support for Windows, MacOS and Linux. It is feature-rich, supports most of the features of the Windows version and has more user-friendly features. It is open source, is based on open source projects and gives back to the open source community.

Features

  • Support for manual configuration

  • Support for automatic server subscription update. Copy this link to test:

    https://raw.githubusercontent.com/shadowsocksrr/electron-ssr/master/docs/assets/subscribe.txt

  • Support for QR code scanning (Please make sure there is only one valid QR code on the screen). Scan this QR code to test:

  • Support for importing the configuration from the clipboard, configuration file and other methods

  • Support for copying QR codes and copying the ssr link (right click on the QR code and select copy in the context menu)

  • Support for adding configurations and opening the application by clicking the ss/ssr link (Mac and Windows only). Please use the link above to test.

  • Support for switching the system proxy mode: PAC, global proxy, no proxy

  • Built-in http_proxy, can be turned on on or off in the options

  • Support for changing the configuration

  • Additional features in the menu bar

Download

Visit the releases page Github release:

  • Windows electron-ssr-setup-x.x.x.exe
  • Mac electron-ssr-x.x.x.dmg
  • Linux (recommended) electron-ssr-x.x.x.AppImage, double click to run. If you cannot use it or want to download your own system-specific package please use the following options
  • Arch or Arch-based distributions electron-ssr-x.x.x.pacman
  • RedHat derivatives electron-ssr-x.x.x.rpm
  • Debian derivatives electron-ssr-x.x.x.deb
  • Other Linux distributions electron-ssr-x.x.x.tar.gz

Configuration file location

  • 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

Shortcuts

The shortcuts were originally added to solve the problem that some Linux distributions cannot display the icon in the top bar. Therefore its content menu cannot be used. Of course on other systems the shortcut can be turned off in the settings.

Global shortcuts

  • CommandOrControl+Shift+W show/hide main window
  • not assigned switch system proxy mode

In-app shortcuts

  • CommandOrControl+Shift+B show/hide the menu bar, only available on Linux

Known Bugs

  • Some Linux system cannot switch system proxy mode. This application uses gsetting to set the system proxy, so some Linux systems cannot use this feature. If you know how to implement it, please feel free to create an issue.
  • Switching the global system proxy on Windows fails

Application screenshots

FAQ

FAQ

Issues

Before creating an issue please check whether the instructions in the FAQ can solve your problem. Please first check whether there exists a similar issue. If there is please follow up on that issue. Additionally if you find a bug please describe your environment in the issue. This includes operating system, software version, steps to reproduce, error logs etc.

Icon resources

https://www.figma.com/file/ghtehcxfzu0N2lQPoVEQXeU7/electron-ssr

Feel free to propose a new revision.

Donate

Buy Me A Coffee

Build

# or npm install
yarn

# run in development mode
npm run dev

# run in development mode
npm run build

# run the unit tests
npm run mocha

# run the code style check
npm run lint

Changelog

Please check the release notes.

ShadowsocksR reference documents

This project was generated with electron-vue@1c165f7 using vue-cli. Documentation about the original structure can be found here.