docs: add configuration and environment variable examples#6
Conversation
![kilo-code-bot[bot]](https://avatars.githubusercontent.com/in/2193792?s=60&v=4){kind=small}
| ```bash | ||
| # Run the MCP server via HTTP streamable transport on port 8000 | ||
| docker run -d --name hexus -p 8000:8000 ghcr.io/codenamekt/hexus:latest | ||
| docker run -d --name hexus -p 8000:8000 -e HEXUS_DSN="dbname=hermes_memory user=postgres host=host.docker.internal" ghcr.io/codenamekt/hexus:latest |
There was a problem hiding this comment.
CRITICAL: Docker run command will fail — missing HEXUS_DB_PASS and DSN password
docker/entrypoint.shline 24 uses${HEXUS_DB_PASS:?hexus database password required}syntax, which causes the script to exit with an error if this variable is unset. The container will fail to start without-e HEXUS_DB_PASS=....- The DSN string omits
password=.... Compare with.env.exampleanddocker/compose.ymlwhich both include the password parameter in their DSN strings.
Reply with @kilocode-bot fix it to have Kilo Code address this issue.
| provider: hexus | ||
| config: | ||
| # The Postgres connection string (required) | ||
| dsn: "dbname=hermes_memory user=postgres password=postgres_secret host=localhost" |
There was a problem hiding this comment.
WARNING: Database name inconsistency — hermes_memory vs hermes_test
The .env.example file (line 10) and docker/compose.yml use database name hermes_test (POSTGRES_DB: hermes_test). However, this README uses hermes_memory here and on lines 86, 92. Pick one name and use it consistently across all files — users will be confused about which database to create.
Reply with @kilocode-bot fix it to have Kilo Code address this issue.
| # you'll need this so it knows how to connect. | ||
| # NOTE: If running via `docker compose --profile mcp up`, the compose file | ||
| # already sets this to host=pg internally, but you can override here. | ||
| HEXUS_DSN="dbname=hermes_test user=postgres password=postgres_secret host=localhost" |
There was a problem hiding this comment.
WARNING: Database name inconsistency — hermes_test vs README's hermes_memory
The README.md (lines 76, 86, 92) uses database name hermes_memory, while this file and docker/compose.yml use hermes_test. Same issue on line 35 (commented yaml section). This inconsistency within the same PR will confuse users. Choose one name and use it consistently.
Reply with @kilocode-bot fix it to have Kilo Code address this issue.
|
|
||
| > **Note:** The Docker MCP server requires a running PostgreSQL database with `pgvector` enabled. You can reference or use our provided `docker/compose.yml` file as a quick example to spin one up! | ||
|
|
||
| **Environment Variables:** |
There was a problem hiding this comment.
SUGGESTION: Incomplete environment variable documentation
The README lists only 3 environment variables, but the application reads at least 7 (per mcp_server/tools.py, cli.py, and compose.yml). Missing from this list: HEXUS_TRANSPORT, HEXUS_WEBHOOK_URL, HEXUS_WEBHOOK_SECRET, and HEXUS_AGENT_IDENTITY. All except HEXUS_AGENT_IDENTITY are shown in .env.example — consider listing them here too for completeness.
Reply with @kilocode-bot fix it to have Kilo Code address this issue.
Code Review SummaryStatus: 4 Issues Found | Recommendation: Address before merge Overview
Issue Details (click to expand)CRITICAL
WARNING
SUGGESTION
Files Reviewed (2 files)
Fix these issues in Kilo Cloud Reviewed by deepseek-v4-pro · Input: 60.6K · Output: 19.6K · Cached: 421.2K |
1 participant
This PR adds a
.env.examplefile and updates theREADME.mdto explicitly mention environment variables and configuration paths for both the Hermes Plugin and Docker setups.