# evenfire — documentation index for LLMs

> Curated map of public docs. Prefer these paths over random monorepo files.
> Code/API still use the historical name "clerum" (clerum.io, CLERUM_*).

## Start here

- README: ../README.md — product pitch, security model, CRDs, license
- Quickstart: get-started/quickstart.md — full platform on minikube, one command
- Registry quickstart: get-started/registry-quickstart.md — self-hosted connect → install → publish round trip
- Learning path: get-started/learning-path.md
- FAQ: faq.md

## Concepts

- Why evenfire: concepts/why-evenfire.md
- When to use evenfire (categories): concepts/when-to-use-evenfire.md
- Open core (self-host vs evenfire hosted): concepts/open-core-and-hosted.md
- Claims guardrails: meta/claims-guardrails.md
- Code names (evenfire vs clerum): concepts/code-names.md
- Architecture overview: architecture/overview.md
- Platform topology / NetworkPolicies: architecture/platform-topology.md

## Surfaces (the UIs)

- Surfaces index (who uses what): surfaces/README.md
- Control UI (admin console): surfaces/control-ui.md
- Desktop App (end-user client, distribution): surfaces/desktop-app.md
- Profile UI (invitation, profile): surfaces/profile-ui.md

## How-to

- Connect Telegram: how-to/connect-telegram.md
- Connect Slack (app scopes, request URL, verify flow, approval buttons): how-to/connect-slack.md
- Connect Microsoft Teams (Teams CLI registration, derived endpoint, single-tenant requirement, verify flow): how-to/connect-teams.md
- Configure approvals: how-to/configure-approvals.md
- Add MCP server: how-to/add-mcp-server.md
- LLM providers overview (the 23 providers, including oauth-broker ChatGPT, mental model, support matrix): llm-providers/README.md
- Configure LLM providers (credentials, model allowlist, session selector): deploy/llm-providers.md
- Add an LLM provider (data-only vs driver-based integration): llm-providers/adding-a-provider.md
- Desktop setup & updates (environments, invitation, updates): how-to/desktop-setup-and-updates.md
- Member invitations on self-hosted (hosted mode vs your own service): how-to/member-invitations-self-hosted.md
- Track usage & set token budgets: how-to/token-budgets-and-usage.md
- Connect a self-hosted deployment to the registry: how-to/connect-to-registry.md
- Publish a plugin to the registry (efrk_ org key): how-to/publish-plugin-to-registry.md
- Shared & global files (SFS team workspace + brokered GFS drive): how-to/shared-and-global-files.md
- Minikube full stack: deploy/minikube.md
- Production checklist: deploy/production.md
- WorkflowRecipes ops: deploy/workflow-recipes-guide.md

## Reference

- CRD index: crds/README.md
- Host: crds/host.md
- Context: crds/context.md
- McpServer: crds/mcpserver.md
- CommunicationChannel: crds/communicationchannel.md
- WorkflowRecipe: crds/workflowrecipe.md
- WorkflowRecipePolicy: crds/workflowrecipepolicy.md
- SharedFileSystem: crds/sharedfilesystem.md
- GlobalFileSystem: crds/globalfilesystem.md

## Testing & contributing

- E2E guide: testing/e2e-guide.md
- Contributing: ../CONTRIBUTING.md
- Security: ../SECURITY.md
- License: ../LICENSE

## Service READMEs (implementation detail)

- ../mcp-host/README.md — agent runtime env vars and providers
- ../channel-reader/README.md
- ../host-context-controller/README.md
- ../workflow-recipes/README.md
- ../control-api/README.md
- ../charts/clerum-crds/README.md
- ../control-ui/README.md — admin console routes, config, tests
- ../desktop-app/README.md — Electron client, scopes, endpoint table, E2E
- ../profile-ui/README.md — profile and invitation flows
- ../rpc-proxy/README.md — external JWT-gated gateway for desktop traffic
- ../external-rest-api/README.md — auth, profiles, teams, RPC-token brokerage