Documentation Index
Everything Hegemony documents about itself, grouped by who needs it.
Read in this order:
- Demo Environment - run Hegemony on one machine.
- Architecture Overview - how it is put together.
- Production Hardening - what to change before it serves anyone.
Start Here
Using Hegemony
Task-shaped guides to the screens in the application. Read these if you are running flows rather than deploying or extending the platform. They are also what the in-app help drawer shows.
- API Tokens
- Approvals
- Binary Artifacts
- Building Flows
- Configuration Exchange
- Devices
- File Repositories
- Home Dashboard
- Installed Plugins
- Inventory Providers
- Organizations
- Platform Environment Variables
- Provider Inventory
- Running Flows
- Sites
- Variables
Features in Depth
How individual subsystems behave, including the parts you configure once and the semantics you need when a feature surprises you.
- Audit Log
- Connectivity Monitors
- Container Registries
- Extensions
- File Repository Storage and Connections
- Flow Interface Builder
- Flow Run Limits
- Git Integration
- Internal Maintenance Jobs
- Internal OpenBao Lifecycle
- Maintenance Windows
- Managed Terraform and OpenTofu State
- Manual Run Control
- Notifications
- Platform Configuration
- SSH Host Keys
- Schedules
- Secrets Management
- Trusted CAs
- Webhooks
Reference
Generated from the code on every change - environment variables, route permissions, enumerations, step handlers, maintenance jobs, developer commands, and the cryptography inventory. Never edited by hand.
- Audit Events
- Configuration Exchange Format
- Cryptography
- Developer Commands
- Environment Variables
- Legacy SSH Algorithms
- Maintenance Jobs
- Permissions (RBAC)
- Step Handler Catalog
- Vocabulary
Architecture
How the platform is put together, for readers changing it.
- Architecture Overview
- Container Sandbox
- Keycloak OIDC Authentication
- Multi-Tenancy
- Schema Enforcement
- Step Output Streaming
- Threat Model and Risk Assessment
Deployment
Getting a real instance up, and what to change before it serves anyone.
Operations
Runbooks and operational guidance for a running deployment.
Development
Conventions, tooling, and design records for contributors.