mirror of https://github.com/NousResearch/hermes-agent.git synced 2026-05-30 06:41:51 +00:00

docs: 30-day overhaul — correctness audit, PR coverage, Nous Portal weave, sidebar reorg (#33782 )

* docs(audit): correctness pass across getting-started, reference, features, messaging, developer-guide, guides, integrations, user-guide

* docs: add PR coverage for last 30d + Nous Portal weave + nav reorg + build fixes

- Add docs for top user-visible PRs that shipped without docs (api-server
  session control, kanban features, telegram pin/edit, provider client tag,
  xAI retired-model migration, cron name lookup, --branch update flag, etc.)
- Apply Nous Portal weave across 23 pages (tasteful one-liners on
  getting-started/learning-path, configuration, overview, vision, x-search,
  credential-pools, provider-routing, cron, codex-runtime, profiles, docker,
  messaging/index, multiple guides, plus FAQ + index promotion)
- Reorganize sidebar: split Messaging into Popular/M365/Chinese/Other,
  Reference into Command/Configuration/Tools-Skills sub-categories, add
  orphan developer-guide pages (web-search-provider-plugin,
  browser-supervisor), move features from Integrations back to Features,
  fold lone spotify into Media & Web.
- Regenerate skill stubs + catalogs (kanban-codex-lane, hermes-s6-container-
  supervision, web-pentest)
- Fix broken anchor links (security/cron, configuration/fallback, telegram
  large-files, adding-platform-adapters step-by-step)

2026-05-28 02:41:36 -07:00

3.4 KiB

Raw Blame History

SimpleX Chat

SimpleX Chat is a private, decentralised messaging platform where users own their contacts and groups. Unlike other platforms, SimpleX assigns no persistent user IDs — every contact is identified by an opaque internal ID generated at connection time, which makes it one of the most private messengers available.

Run hermes gateway setup and pick SimpleX for a guided walk-through.

Prerequisites

The simplex-chat CLI installed and running as a daemon
Python package websockets (pip install websockets)

Install simplex-chat

Download the latest release from the simplex-chat GitHub releases page:

# Linux / macOS binary
curl -L https://github.com/simplex-chat/simplex-chat/releases/latest/download/simplex-chat-ubuntu-22_04-x86-64 -o simplex-chat
chmod +x simplex-chat

The SimpleX Chat project does not publish a prebuilt Docker image for the chat client; to run it under Docker, build from source from the simplex-chat repository.

Start the daemon

simplex-chat -p 5225

The daemon listens on WebSocket at ws://127.0.0.1:5225 by default.

Configure Hermes

Via setup wizard

hermes setup gateway

Select SimpleX Chat and follow the prompts.

Via environment variables

Add these to ~/.hermes/.env:

SIMPLEX_WS_URL=ws://127.0.0.1:5225
SIMPLEX_ALLOWED_USERS=<contact-id-1>,<contact-id-2>
SIMPLEX_HOME_CHANNEL=<contact-id>

Variable	Required	Description
`SIMPLEX_WS_URL`	Yes	WebSocket URL of the simplex-chat daemon
`SIMPLEX_ALLOWED_USERS`	Recommended	Comma-separated contact IDs allowed to use the agent
`SIMPLEX_ALLOW_ALL_USERS`	Optional	Set `true` to allow every contact (use carefully)
`SIMPLEX_HOME_CHANNEL`	Optional	Default contact ID for cron job delivery
`SIMPLEX_HOME_CHANNEL_NAME`	Optional	Human label for the home channel

Find your contact ID

After starting the daemon, open a conversation with your agent contact. The contact ID will appear in session logs or via hermes send_message action=list.

Authorization

By default all contacts are denied. You must either:

Set SIMPLEX_ALLOWED_USERS to a comma-separated list of contact IDs, or
Use DM pairing — send any message to the bot and it will reply with a pairing code. Enter that code via hermes gateway pair.

Using SimpleX with cron jobs

cronjob(
    action="create",
    schedule="every 1h",
    deliver="simplex",          # uses SIMPLEX_HOME_CHANNEL
    prompt="Check for alerts and summarise."
)

Or target a specific contact:

send_message(target="simplex:<contact-id>", message="Done!")

Privacy notes

SimpleX never reveals phone numbers or email addresses — contacts use opaque IDs
The connection between Hermes and the daemon is local WebSocket (ws://127.0.0.1:5225) — no data leaves your machine
Messages are end-to-end encrypted by the SimpleX protocol before reaching the daemon

Troubleshooting

"Cannot reach daemon" — Ensure simplex-chat -p 5225 is running and the port matches SIMPLEX_WS_URL.

"websockets not installed" — Run pip install websockets.

Messages not received — Check that the contact's ID is in SIMPLEX_ALLOWED_USERS or approve them via DM pairing.

3.4 KiB Raw Blame History