Skip to content

README.md

Latest commit

 

History

History
106 lines (78 loc) · 3.56 KB

README.md

File metadata and controls

106 lines (78 loc) · 3.56 KB

Deployment Overview

Deploy TelemetryFlow Hermes in standard (cloud-connected), Docker, or air-gapped (fully offline) configurations.

Deployment Models

graph TD
    CHOICE{"Deployment Model?"}

    STD["Standard Deployment<br/>External LLM providers<br/>Full feature set"]
    DOCKER["Docker Deployment<br/>Multi-platform containers<br/>docker-compose profiles"]
    AIR["Air-Gapped Deployment<br/>Ollama local models<br/>No external network"]

    CHOICE -->|"Internet available"| STD
    CHOICE -->|"Containerized"| DOCKER
    CHOICE -->|"Zero egress required"| AIR

    STD --> STD_STEPS["1. Install Hermes Agent<br/>2. Configure API keys<br/>3. Deploy profiles<br/>4. Start Telegram gateways"]
    DOCKER --> DOCKER_STEPS["1. Build Docker image<br/>2. Configure .env<br/>3. docker compose up<br/>4. Start Telegram gateways"]
    AIR --> AIR_STEPS["1. Install Hermes Agent<br/>2. Install Ollama + models<br/>3. Deploy profiles (ollama config)<br/>4. Start Telegram gateways"]

    style STD fill:#1a3a6b,stroke:#3b82f6,color:#fff
    style DOCKER fill:#1a4a6b,stroke:#00b4d8,color:#fff
    style AIR fill:#1a6b4a,stroke:#00d4aa,color:#fff
Loading

Prerequisites

Common (both models)

Requirement Purpose
Python 3.8+ Plugin tool runtime
TelemetryFlow Platform Running instance with API access
ClickHouse Telemetry data storage
Kubernetes cluster For remediation actions
Telegram bot tokens (4x) Agent communication
kubectl configured K8s API access

Standard Only

Requirement Purpose
Anthropic API key Investigator agent (claude-sonnet-4-5)
Zhipu/OpenCode Go key Triage/Reviewer/Remediator (glm-5.1)

Air-Gapped Only

Requirement Purpose
Ollama installed Local LLM inference
Model weights pulled llama3.3, mistral-nemo, etc.
No external network Full offline operation

Quick Deploy

Standard

# Clone
git clone https://github.com/telemetryflow/telemetryflow-hermes.git
cd telemetryflow-hermes

# Configure
make env
# Edit ~/.hermes/.env with your keys

# Deploy
make init
make verify
make deploy

Docker

# Clone
git clone https://github.com/telemetryflow/telemetryflow-hermes.git
cd telemetryflow-hermes

# Configure
cp .env.example .env
# Edit .env with your keys

# Build and start (core stack)
./run-container.sh -b --up --profile core

# Or full stack
./run-container.sh -b --up --profile all

Docker Compose Profiles

Profile Services
(none) Hermes agent only
core Backend + Frontend + Postgres + ClickHouse + Redis + NATS
monitoring TFO Collector + TFO Agent + Jaeger
tools Portainer
all Everything combined

Next Steps