Skip to content

Latest commit

 

History

History
124 lines (101 loc) · 10.6 KB

File metadata and controls

124 lines (101 loc) · 10.6 KB

evenfire Documentation

evenfire is a self-hostable platform for LLM agents that take real actions: multi-channel messaging, MCP tools, human-in-the-loop approvals, and default-deny networking — declared as Kubernetes CRDs.

Code and API group still use the historical name clerum (clerum.io, CLERUM_*). Same project — code names.

Start at the root README.md for the product pitch and license. Use this index for long-form docs.


Get started

Doc Description
Quickstart Full platform on minikube in minutes
Registry quickstart Connect, install, and publish as a self-hoster
Learning path Choose a path by role and goal
FAQ Common questions and troubleshooting

Concepts

Doc Description
Why evenfire Problem, audience, design intent
When to use evenfire Fit vs personal assistants / in-process frameworks (categories only)
Open core: self-host vs hosted What's in this repo vs the managed evenfire hosted service
Code names evenfire vs clerum
Architecture overview Services, CRDs, message lifecycle, NetworkPolicy model
Platform topology Namespaces, controller split, deny-all baseline
Non-MCP services Namespace splitting and L0–L3 policy layers
Diagrams Excalidraw sources

Surfaces (the UIs)

Doc Description
Surfaces index Which UI is for whom, and what each may reach
Control UI Admin console: usage, budgets, approvals, egress, registry
Desktop App End-user client: chat, live activity, approvals, artifacts; how to ship it
Profile UI Member front door: invitation, password, desktop handoff

How-to guides

Doc Description
Connect Telegram Minikube env or CRD channel path
Connect Slack Slack app scopes, request URL, conversation verification
Connect Microsoft Teams Teams CLI bot registration, endpoint, conversation verify
Configure approvals Human-in-the-loop tool gates
Add an MCP server Dev-mode JSON or CRD allowlist path
LLM providers overview Which providers are supported and how they fit together
Configure LLM providers Credentials, model allowlist, per-session selector
Add an LLM provider Data-only vs driver-based integration paths
Desktop setup & updates Environments, invitation setup, updates
Member invitations on self-hosted Hosted mode zero-config emails vs running your own service
Track usage & set budgets Enable budgets, scope, block vs warn
Connect to the registry Self-hosted registry connect flow
Publish a plugin Publish under your org with an efrk_ key
Shared & global files Team workspaces (SFS) and the brokered drive (GFS)
Minikube full stack Local Kubernetes platform
Production notes Checklist and in-repo deploy assets
WorkflowRecipes operations Recipe ops, RBAC, debugging

Reference

Doc Description
CRD index All 8 clerum.io CRDs
Workflow SDK @clerum/workflow-sdk — build custom workflow coordinator images
llms.txt Machine-readable doc map for coding agents
Service READMEs One-line map per component in the root README components list

Testing

Doc Description
E2E guide Cluster E2E suites, approvals, desktop
Custom coordinator E2E gates Gates for custom coordinator images
Desktop observation smoke test Desktop surface smoke check

For coding agents

Doc Description
WorkflowRecipe guide Authoring recipes, for agents
Shared frontend rules Cross-app rules for the three frontend surfaces
Control UI rules Control UI application-specific guidance
Profile UI rules Profile UI application-specific guidance
Desktop renderer rules Desktop renderer application guidance
WorkflowRecipe naming Generated resource-name rules

Community & trust

Doc Description
Contributing Dev loop, PR rules
Security Private vulnerability reporting
Claims guardrails Never-overclaim rules for public docs
Governance How the project is run
Code of conduct Community standards
License MPL-2.0 (open source)

Finding things

I want to… Start at
Chat with a local agent Quickstart
Understand why this exists Why evenfire
Decide if evenfire fits my use case When to use evenfire
Configure Host / Context / McpServer CRD index
Pick or configure an LLM provider LLM providers overview
Run the full stack locally Minikube
Ship to a real cluster Production notes
Debug E2E E2E guide
Feed docs to an LLM llms.txt
Use the admin console Control UI
Chat with an agent from the desktop Desktop App

Note: Contributor-local working artifacts live under docs/superpowers/ on each checkout. They are git-ignored and intentionally not part of the repo.