diff --git a/.env.example b/.env.example index 78ad16e..bd35d35 100644 --- a/.env.example +++ b/.env.example @@ -3,7 +3,7 @@ BROWSER_POOL_SIZE=5 SESSION_TTL_SECONDS=3600 PROXY_URL= RESIDENTIAL_PROXY_URL= -PORT_API=8191 +PORT=8191 PORT_WEB=3000 PORT_DOCS=3001 diff --git a/README.md b/README.md index aa5efb0..01cb5bb 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ Synology note: many Synology NAS units (DSM 7.x on J4125 / older hardware) ship | `REDIS_URL` | `redis://localhost:6379` | Redis connection string | | `RESIDENTIAL_PROXY_URL` | — | Enables Tier 4 proxy escalation | | `STT_URL` | — | Local Whisper endpoint for reCAPTCHA (optional) | -| `PORT_API` | `8191` | API listen port | +| `PORT` | `8191` | API listen port | ## Stack diff --git a/apps/docs/api-reference/overview.md b/apps/docs/api-reference/overview.md index 04ad31a..fa8998c 100644 --- a/apps/docs/api-reference/overview.md +++ b/apps/docs/api-reference/overview.md @@ -11,7 +11,7 @@ description: Base URL, content types, and response conventions. http://localhost:8191 ``` -Or wherever you've mapped `PORT_API` (default `8191`). +Or wherever you've mapped `PORT` (default `8191`). ## Authentication diff --git a/apps/docs/getting-started/configuration.md b/apps/docs/getting-started/configuration.md index 61555a8..3282051 100644 --- a/apps/docs/getting-started/configuration.md +++ b/apps/docs/getting-started/configuration.md @@ -130,11 +130,18 @@ Note: `proxy` on `/v1` is a TRAWL-specific extension — it is not part of the r ## Ports -### `PORT_API` +### `PORT` **Default:** `8191` -Port the Elysia API server listens on. Defaults to `8191` — the same port FlareSolverr and Byparr use, so you can swap TRAWL in without changing any *arr app settings. +Host port the Docker port mapping forwards to TRAWL's internal listener. Defaults to `8191` — the same port FlareSolverr and Byparr use, so you can swap TRAWL in without changing any *arr app settings. The container itself always listens on `8191` internally; `PORT` only changes the **host-side** port (e.g. `"${PORT:-8191}:8191"` in every compose file). + +To run TRAWL alongside FlareSolverr (or any other service that already binds `8191` on the host), set `PORT` in your shell or `.env` to any free port **before** running `docker compose up`: + +```bash +PORT=9191 docker compose up -d +# TRAWL reachable at http://localhost:9191, while port 8191 stays free for FlareSolverr. +``` ### `PORT_WEB` @@ -162,6 +169,6 @@ PROXY_LIST_FILE= RESIDENTIAL_PROXY_LIST_FILE= # ── Ports ───────────────────────────────────── -PORT_API=8191 +PORT=8191 PORT_WEB=3000 ```