Skip to content

Repository files navigation

Hermes LiveKit for Hermes (LiveKit voice plugin)

Hermes LiveKit is a Hermes plugin that adds a live voice channel through LiveKit. You speak to a Mate client, Hermes listens, and the reply is spoken back.

Install

hermes plugins install drascom/hermes-livekit
hermes gateway restart

To update later:

hermes plugins update hermes_livekit
hermes gateway restart

Each installation creates a stable instance id and LiveKit room on first run. The state is stored outside the plugin checkout at ~/.hermes/mate_voice/instance.json, so plugin updates and gateway restarts do not change the room. Pairing and token responses carry the resolved room to clients; clients should not hard-code MATE_LIVEKIT_ROOM.

Uninstall

hermes plugins remove hermes_livekit deletes only the plugin code — the LiveKit server (its own systemd service, binary, config, and data) is separate and keeps running. To remove everything in one step, run:

curl -fsSL https://raw.githubusercontent.com/drascom/hermes-livekit/main/uninstall.sh | bash

It removes the plugin, stops and deletes the livekit-server service and ~/.hermes/mate_voice/livekit, strips the LiveKit/STT/VOX keys from ~/.hermes/.env (backed up first), and optionally deletes the pairing and speaker databases.

Setup

Run the Hermes gateway setup flow:

hermes setup gateway

Choose Hermes LiveKit and enter:

  • Whether Hermes LiveKit should install a new LiveKit server or use an existing one
  • STT_HOST and STT_PORT for Whisper STT
  • VOX_HOST and VOX_PORT for VOX TTS

If you choose a new LiveKit server, Hermes LiveKit installs and configures it on the first gateway start.

If you already have LiveKit, enter the LiveKit URL, API key, and API secret.

Pair a client

After the gateway is running:

hermes hermes_livekit pair-qr

Scan the QR code or open the link in the Mate client. Pairing sends the client everything it needs: LiveKit URL, room, client key, and gateway address.

Change settings

hermes hermes_livekit reconfigure
hermes gateway restart

Useful commands:

hermes hermes_livekit pair-qr       # pair a client
hermes hermes_livekit show-key      # show the client key
hermes hermes_livekit check-update  # check for plugin updates

Firewall

If clients connect from outside the server, open:

  • 7880/tcp for LiveKit signaling
  • 7881/tcp for LiveKit TCP fallback
  • 7882/udp for LiveKit media
  • 8830/tcp for Hermes LiveKit pairing and tokens
  • 8800/tcp for the Hermes gateway

Related components

Hermes LiveKit expects separate STT and TTS services:

  • Whisper STT, configured with STT_HOST and STT_PORT
  • VOX TTS, configured with VOX_HOST and VOX_PORT

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages