Skip to content

Latest commit

 

History

History
175 lines (124 loc) · 14.3 KB

README.md

File metadata and controls

175 lines (124 loc) · 14.3 KB

Yet Another Shadow Socket

yass is an efficient forward proxy client supporting http/socks4/socks4a/socks5/socks5h protocol running on PC and mobile devices.

Releases

GitHub release (latest SemVer) Language: C++ GitHub release (latest by SemVer)

Because we are reusing chromium's network stack directly, we are following chromium's release schedule and delivering new versions based on its beta branch.

Prebuilt binaries (Linux)

aur yass-proxy-gtk3 aur yass-proxy-qt5 aur yass-proxy aur yass-proxy-qt6

See Status of Package Store for more.

aur yass-proxy-cli

Prebuilt binaries (Other platforms)

via Flathub: flatpak install --user io.github.chilledheart.yass (recommended, signed and sandboxed) for both of x86_64 and aarch64 machines

Flathub Version Flathub Downloads

See Supporteded Operating System for more.

Contribute your translation (i18n)

Please submit translations via Transifex: https://app.transifex.com/yetanothershadowsocket/yetanothershadowsocket

Steps:

  1. Create a free account on Transifex (https://www.transifex.com/).
  2. Send a request to join the language translation.
  3. After accepted by the project maintainer, then you can translate online.

Build from Source

Take a look at build instructions and packaging instructions.

Highlight Features

Post Quantum Kyber Support

Post Quantum Kyber Support (not enabled by default) is added on all of supported Platforms.

See Protecting Chrome Traffic with Hybrid Kyber KEM for more.

NaïveProxy-Compatible Protocol Support

Cipher http2 and https are NaïveProxy-compatible.

See NaïveProxy's project homepage for support.

Android/iOS/macOS (M1/M2/M3/M4 only) comes with VPN Service support

Mobile users including macOS (M1/M2/M3/M4) machines can use yass as VPN Service more than pure Global Proxy Client.

TBD: Spliting Tunnel Support (#954)

More Usages

Visit wiki's Usages.

Server side support (outside this project)

See Setup forwardproxy caddy service for more.

See Window sizes for large bandwidth for more.

See Use BBR Congestion Control for more.

See ChatGPT capable caddy Server for more.

Extra Features (Command Line only)

Use custom CA certificate file

Pass --certificate_chain_file file to command line. Use custom certificate chain provided by file to verify server's certificate.

Sponsor Me

Please visit the pages site.

Build Status

Compiler Compatibility CircleCI Cirrus CI

MinGW Build Linux Build macOS Build

Android Build iOS Build

OpenWRT Build FreeBSD Build RPM Build DEB Build Flatpak Build

MSVC Build Old MinGW Build Clang Tidy