s5p/docs/INSTALL.md

s5p -- Installation

Prerequisites

• Python >= 3.11
• pip
• Tor (optional, for Tor-based chains)
• podman + podman-compose (optional, for container deployment)

Local Install

cd ~/git/s5p
python -m venv .venv
source .venv/bin/activate
pip install -e .

Verify

s5p --version
which s5p

Symlink (alternative)

ln -sf ~/git/s5p/.venv/bin/s5p ~/.local/bin/s5p

Container Install

cd ~/git/s5p
cp config/example.yaml config/s5p.yaml   # edit with your proxies
make build                                # podman-compose build
make up                                   # podman-compose up -d

The Alpine-based image (~59MB) contains only Python and PyYAML. Application source and config are bind-mounted at runtime.

Install Tor (optional)

sudo apt install tor
sudo systemctl enable --now tor

# Verify Tor SOCKS5 port
ss -tlnp | grep 9050