Skip to content

docs: clarify Hermes configuration requires two blocks #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codenamekt merged 2 commits into from
Jul 13, 2026
Merged

docs: clarify Hermes configuration requires two blocks #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4514e5b
docs: clarify Hermes config requires two blocks
Jul 13, 2026
21fae0a
Merge branch 'main' into docs/clarify-hermes-config
codenamekt Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,10 @@ pip install hexus
```
*Note: Once installed, just point Hermes to it! You can also just drop the `hexus` module files straight into your `~/.hermes/plugins/hexus/` directory. Hermes's discovery system will automatically pick it up and initialize it on startup!*

**Configuration (`hermes.yaml`):**
When running as a Hermes plugin, configure it directly in your `hermes.yaml` file (not via environment variables):
#### ⚠️ Hermes Configuration: Two Blocks Required
When configuring Hexus as a Hermes memory plugin, you need **both** of the following configuration blocks in your Hermes config:

**Block 1** — Enables the memory plugin system:
```yaml
plugins:
memory:
Expand All @@ -76,6 +77,14 @@ plugins:
dsn: "dbname=hermes_test user=postgres password=postgres_secret host=localhost"
```

**Block 2** — Tells Hermes to use Hexus as the memory provider:
```yaml
memory:
provider: hexus
```

*Why both?* Block 1 registers and configures the Hexus plugin itself. Block 2 instructs Hermes to actually use Hexus as its memory backend.

### Option 2: Docker & MCP Server (Claude, Cursor, etc.)
The easiest way to run the standalone MCP server is via Docker (GHCR).

Expand Down
Loading