diff --git a/website/docs/user-guide/docker.md b/website/docs/user-guide/docker.md index 32b8d69894..bf4b4e9b68 100644 --- a/website/docs/user-guide/docker.md +++ b/website/docs/user-guide/docker.md @@ -41,6 +41,21 @@ docker run -d \ Port 8642 exposes the gateway's [OpenAI-compatible API server](./features/api-server.md) and health endpoint. It's optional if you only use chat platforms (Telegram, Discord, etc.), but required if you want the dashboard or external tools to reach the gateway. +Note: the API server is gated on `API_SERVER_ENABLED=true`. To expose it beyond `127.0.0.1` inside the container, also set `API_SERVER_HOST=0.0.0.0` and an `API_SERVER_KEY` (minimum 8 characters — generate one with `openssl rand -hex 32`). Example: + +```sh +docker run -d \ + --name hermes \ + --restart unless-stopped \ + -v ~/.hermes:/opt/data \ + -p 8642:8642 \ + -e API_SERVER_ENABLED=true \ + -e API_SERVER_HOST=0.0.0.0 \ + -e API_SERVER_KEY=your_api_key_here \ + -e API_SERVER_CORS_ORIGINS='*' \ + nousresearch/hermes-agent gateway run +``` + Opening any port on an internet facing machine is a security risk. You should not do it unless you understand the risks. ## Running the dashboard