Shadowsocks-Qt5

中文用户指南

Introduction

Shadowsocks-Qt5 is a fast, reliable and cross-platform GUI fronted for Shadowsocks.

Features

• Shadowsocks-Qt5 is written in C++/Qt5.
• Intuitive and native UI. This is not a clumsy Web App.
• JUST a GUI fronted. Keep your favourite Shadowsocks port as backend.
• Easy-to-use and highly customisable.
• The gui-config.json file is partially compatible with shadowsocks-gui. In order to serve better, some new values have been added.
• gui-config.json is located under ~/.config/shadowsocks on UNIX platforms, or under the main programme's directory in Windows.

Note

• It is not a standalone programme. ss-qt5 needs a shadowsocks backend such as Shadowsocks-libev and [Shadowsocks-Python] ss-python.
• [Shadowsocks-Python] ss-python is highly recommended to serve as backend for better performance and stability.
• Don't be panic if you encounter a bug. Please feel free to open issues. Just remember to run from terminal or cmd and paste the output to the description of issue.

Installation

Windows

1. Download prebuilt binaries from releases.
2. Install/update your favourite shadowsocks backend. (You may want to download prebuilt ss-libev).

For those who want to build from source, follow the instructions below.

Open this project using Qt Creator and build it.

Or type the command in MSYS.

qmake INSTALL_PREFIX=../ss-qt5
make
make install

You will get ss-qt5.exe and gui-config.json in ../ss-qt5 directory.

For 64-bit build, please use mingw-w64 toolchain (there are unofficial Qt builds using mingw-w64) and use the command below instead.

qmake INSTALL_PREFIX=../ss-qt5 DEFINES+="mingw64"
make
make install

Linux

Ubuntu

Make sure you're running at least Ubuntu 14.04.

For instructions, please refer to PPA.

Compile

Dependencies

• Qt >= 5.2
• qrencode (or libqrencode in Debian/Ubuntu)

Debian

By running the command below, you'll get a deb package on upper directory.

dpkg-buildpackage -uc -us -b

Then, install it by sudo dpkg -i shadowsocks-qt5-<VER_ARCH_ETC>.deb.

Generic Linux

The development packages of Qt5 and qrencode-devel (or libqrencode-devel in Debian/Ubuntu) are required.

# Some distros use seperated qmake-qt4, qmake-qt5. Then, just run `qmake-qt5`. You can specify INSTALL_PREFIX=/usr/local if needed. default is /usr
qmake INSTALL_PREFIX=/usr
make
make install

Others

Mac OS X and *BSD are not tested and they're NOT supported officially. Well, I do hope you can help me mantain the compatibility if you have spare time.