Skip to content

Commit e70655f

Browse files
committed
docs(environment): clarify Valkey host configuration for local and Docker setups
- Added guidance on using `VALKEY_HOST=localhost` for local bot runs and `VALKEY_HOST=tux-valkey` for Docker Compose environments. - Included troubleshooting tips for resolving "Name or service not known" errors when running the bot locally.
1 parent 09b19bb commit e70655f

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/content/selfhost/config/environment.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,13 @@ Leave `VALKEY_URL` and `VALKEY_HOST` empty to disable Valkey. See the
7474
Use Valkey if you want cache to persist across bot restarts or run multiple Tux
7575
processes. For a single instance that restarts rarely, in-memory cache is sufficient.
7676

77+
!!! tip "VALKEY_HOST: localhost vs tux-valkey"
78+
Use **`VALKEY_HOST=localhost`** (or `VALKEY_URL=valkey://localhost:6379/0`) when
79+
running the bot on your host (e.g. `uv run tux start`). Use **`VALKEY_HOST=tux-valkey`**
80+
when the bot runs inside Docker Compose so it can reach the Valkey container by
81+
service name. If you see "Name or service not known" for `tux-valkey`, you are
82+
running the bot locally—switch to `localhost` or start Valkey and point to it.
83+
7784
### Bot owner and sysadmins (recommended)
7885

7986
Configure in **`config/config.json`**, not in `.env`:

0 commit comments

Comments
 (0)