shadowsocks-libev

(β˜… 16,182)

Bug-fix-only libev port of shadowsocks. Future development moved to shadowsocks-rust

  • .clang-tidy
  • .dockerignore
  • .gitignore
  • .gitmodules
  • .travis.yml
  • .uncrustify.cfg
  • AUTHORS
  • Changes
  • CLAUDE.md
  • CMakeLists.txt
  • COPYING
  • libbloom
  • libcork
  • libipset
  • LICENSE
  • README.md
  • README_pt_BR.md

# Installation Guide

1. Get the code
git clone https://github.com/shadowsocks/shadowsocks-libev

Downloads the entire project code from GitHub to your computer.

cd shadowsocks-libev

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
  • Homebrew A package manager for macOS/Linux.
sudo apt install shadowsocks-libev

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo apt-get install --no-install-recommends build-essential cmake pkg-config \

Installs directly from the APT package repository (Debian/Ubuntu-based).

brew install shadowsocks-libev

Installs the pre-built package via Homebrew β€” no source build required.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull shadowsocks/shadowsocks-libev

Type this command into your terminal and run it.

docker run -e PASSWORD=<password> -p<server-port>:8388 -p<server-port>:8388/udp -d shadowsocks/shadowsocks-libev

Runs the built image as an actual container.

cd shadowsocks-libev/docker/mingw

Moves into the project folder you just downloaded.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

cmake .. -DCMAKE_PREFIX_PATH="/usr/local/opt/mbedtls;/usr/local/opt/libsodium"

Analyzes the source code and generates build configuration files (must be run inside the build folder).

sudo apt-get install --no-install-recommends build-essential cmake pkg-config \

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo yum install gcc cmake make pkg-config pcre2-devel c-ares-devel \

Type this command into your terminal and run it.

sudo pacman -S gcc cmake make pkg-config pcre2 c-ares libev libsodium mbedtls \

Type this command into your terminal and run it.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

make install

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation