shadowsocks-android README

The project's README from github.com/shadowsocks/shadowsocks-android. As one markdown file: README.md.

Shadowsocks for Android

CircleCI API Releases Language: Kotlin Codacy Badge License: GPL-3.0

for Android & Chrome OS (beta)
for Android TV (beta)

PREREQUISITES

BUILD

You can check whether the latest commit builds under UNIX environment by checking Travis status.

CONTRIBUTING

If you are interested in contributing or getting involved with this project, please read the CONTRIBUTING page for more information. The page can be found here.

TRANSLATE

OPEN SOURCE LICENSES

LICENSE

Copyright (C) 2017 by Max Lv <[email protected]>
Copyright (C) 2017 by Mygod Studio <[email protected]>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

shadowsocks-android (shadowsocks/shadowsocks-android)

Searching Database…

What is this?This is the official Shadowsocks client app for Android, Chrome OS, and Android TV, letting you route your device's traffic through a Shadowsocks proxy server.
Is this an app I install on my device, or a server component?It is a client app only (APK) that connects to a Shadowsocks server; it does not run the proxy server itself.
Is a pre-built APK provided, or do I have to compile it myself?The README only documents building from source; it does not mention a ready-made download link or app store listing in this content.
Does this work on Android TV and Chrome OS too, or just phones?Yes, besides regular Android phones it also has beta support for Chrome OS and Android TV.
What underlying components does it rely on for the proxy protocol?It bundles or links against redsocks, libevent, tun2socks, shadowsocks-rust, libsodium, and OpenSSL as its open source dependencies.
Can I help translate the app?Yes, the README has a dedicated TRANSLATE section pointing contributors to help localize the app.
Is the project actively maintained?With over 36,000 GitHub stars and a long history since 2012, it remains one of the most widely used Shadowsocks clients for Android.
Size
52.6 MB
Stars
36.8K
Age
13y
Commits · 90 Days