docs: update all docs for container, cprofile, and config split
This commit is contained in:
@@ -5,8 +5,9 @@
|
||||
- Python >= 3.11
|
||||
- pip
|
||||
- Tor (optional, for Tor-based chains)
|
||||
- podman + podman-compose (optional, for container deployment)
|
||||
|
||||
## Install
|
||||
## Local Install
|
||||
|
||||
```bash
|
||||
cd ~/git/s5p
|
||||
@@ -22,6 +23,24 @@ s5p --version
|
||||
which s5p
|
||||
```
|
||||
|
||||
## Symlink (alternative)
|
||||
|
||||
```bash
|
||||
ln -sf ~/git/s5p/.venv/bin/s5p ~/.local/bin/s5p
|
||||
```
|
||||
|
||||
## Container Install
|
||||
|
||||
```bash
|
||||
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)
|
||||
|
||||
```bash
|
||||
@@ -31,9 +50,3 @@ sudo systemctl enable --now tor
|
||||
# Verify Tor SOCKS5 port
|
||||
ss -tlnp | grep 9050
|
||||
```
|
||||
|
||||
## Symlink (alternative)
|
||||
|
||||
```bash
|
||||
ln -sf ~/git/s5p/.venv/bin/s5p ~/.local/bin/s5p
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user