How-To Series · Module 5: Everywhere You Are

Hermes · Relay

Front your messaging platforms through a relay connector. No platform tokens on your gateway.

After this videoYour gateway fronts Discord, Telegram, Slack and more without holding a single platform token.

Hermes Relay is a connector system that lets your gateway front one or more real messaging platforms without holding any platform credentials. A separate connector service owns the platform bot tokens and sockets. Your gateway dials out to the connector over a single authenticated WebSocket, receives a capability descriptor at handshake, and exchanges normalized messages and actions. Enroll with hermes gateway enroll using a single-use token and connector URL, which persists the credentials into ~/.hermes/.env. Configure the relay URL in config.yaml or the environment; its presence alone activates the relay platform.

About these resources. This episode explains Hermes Relay. The Sources block names the Hermes docs page that backs every claim.

New words here · Plain English

one sentence each · full glossary
ConnectorA separate service that owns the platform bot tokens and sockets, so your gateway never holds them.
WebSocketA persistent two-way connection between two programs, used here for your gateway to dial out to the connector.
HandshakeThe first exchange when the gateway connects, where the connector advertises what the fronted platform can do.
Enrollment tokenA single-use code you redeem to register your gateway with a connector and receive its relay credentials.

Sources · What this video distills

1 docs page · every command below traces to it
Primary guide
Hermes Relay (Connector)
Read ↗

Commands shown · Copy and paste

each shows the source doc it came from
Enroll the gateway with the connectorfrom source ↗
hermes gateway enroll --token <enrollment-token> --connector-url wss://connector.example.com/relay
Configure the relay URL (activates relay)from source ↗
gateway.relay_url: "wss://connector.example.com/relay"

Going deeper · Related Hermes docs

further reading · not sources of facts shown above

Next in the series · Episodes that build on this