Files

teknium1 ada3713e77 feat: add documentation website (Docusaurus)

- 25 documentation pages covering Getting Started, User Guide, Developer Guide, and Reference
- Docusaurus with custom amber/gold theme matching the landing page branding
- GitHub Actions workflow to deploy landing page + docs to GitHub Pages
- Landing page at root, docs at /docs/ on hermes-agent.nousresearch.com
- Content extracted and restructured from existing repo docs (README, AGENTS.md, CONTRIBUTING.md, docs/)
- Auto-deploy on push to main when website/ or landingpage/ changes

2026-03-05 05:24:55 -08:00

2.2 KiB

Raw Blame History

sidebar_position, title, description

sidebar_position	title	description
2	Telegram	Set up Hermes Agent as a Telegram bot

Telegram Setup

Connect Hermes Agent to Telegram so you can chat from your phone, send voice memos, and receive scheduled task results.

Setup Steps

Create a bot: Message @BotFather on Telegram, use /newbot
Get your user ID: Message @userinfobot — it replies with your numeric ID
Configure: Run hermes gateway setup and select Telegram, or add to ~/.hermes/.env manually:

TELEGRAM_BOT_TOKEN=123456:ABC-DEF...
TELEGRAM_ALLOWED_USERS=YOUR_USER_ID    # Comma-separated for multiple users

Start the gateway:

hermes gateway

Optional: Home Channel

Set a home channel for cron job delivery:

TELEGRAM_HOME_CHANNEL=-1001234567890
TELEGRAM_HOME_CHANNEL_NAME="My Notes"

Or use the /sethome command in any Telegram chat to set it dynamically.

Voice Messages

Voice messages sent on Telegram are automatically transcribed using OpenAI's Whisper API and injected as text into the conversation. Requires VOICE_TOOLS_OPENAI_KEY in ~/.hermes/.env.

Voice Bubbles (TTS)

When the agent generates audio via text-to-speech, it's delivered as native Telegram voice bubbles (the round, inline-playable kind).

OpenAI and ElevenLabs produce Opus natively — no extra setup needed
Edge TTS (the default free provider) outputs MP3 and needs ffmpeg to convert to Opus:

# Ubuntu/Debian
sudo apt install ffmpeg

# macOS
brew install ffmpeg

Without ffmpeg, Edge TTS audio is sent as a regular audio file (still playable, but rectangular player instead of voice bubble).

Exec Approval

When the agent tries to run a potentially dangerous command, it asks you for approval in the chat:

⚠️ This command is potentially dangerous (recursive delete). Reply "yes" to approve.

Reply "yes"/"y" to approve or "no"/"n" to deny.

Security

:::warning Always set TELEGRAM_ALLOWED_USERS to restrict who can use the bot. Without it, the gateway denies all users by default. :::

You can also use DM pairing for a more dynamic approach.

2.2 KiB Raw Blame History