Reference
The lookup tables — settings, ports, profiles, roles, capabilities, licence tiers, event types, error codes, entity types and API routes.
- Version: 0.4
- Role: admin_user, viewer
- Type: reference
Lookup tables. Most of this guide is generated from the code at build time, so a setting that does not appear here does not exist, and a setting that changed in the code changed here in the same commit.
Note
Generated pages are rebuilt on every documentation build and compared against the committed copy. A difference fails the build, which is what keeps this guide from drifting. Editing a generated page by hand has no effect — change the code or the generator.
Configuration
| Page | What it lists |
|---|---|
| Environment variables | Every variable the stack declares or reads, its default, the containers that receive it, and where it is read |
| Services, ports and profiles | Every container, its published ports, its compose profile, its declared memory limit and its health check |
| Compose profiles and CLI | Which profile starts what, which compose overlay does what, and the make targets an operator runs on a direct install |
| Resource sizing | What the declared limits add up to, what each optional profile adds, and where a GPU changes anything |
Access
| Page | What it lists |
|---|---|
| Roles, capabilities and pages | The five fixed roles, the sixty-capability model, and which dashboard page each role may open |
| Licence tiers and feature keys | Every feature key, the tier that grants it, and the controllers and pages a missing key switches off |
Detection
| Page | What it lists |
|---|---|
| Entity and label types | Every PII entity type, secret category, toxicity label and attack label a detector can report, and where each is declared |
Diagnostics
| Page | What it lists |
|---|---|
| Event types | Every event type written to the event log, its retention category, and which feed reads it |
| Error codes | Every machine-readable error code, its HTTP status and the code that throws it |
| User-visible messages | Every failure message the product can show, by surface, each mapped to a runbook or to a reason it needs none |
API
| Page | What it lists |
|---|---|
| API route inventory | Every routed HTTP handler in the gateway, with the roles and licence key it requires |
Terms
- Glossary — the terms this documentation uses, defined once.
Measurement
| Page | What it lists |
|---|---|
| Performance and accuracy | Whether this release publishes measured detection figures, the decision thresholds it ships, and how to measure your own |
Performance and accuracy figures are conditional: they depend on the length of the text, which detector fired, and how the filter is configured. CID222 publishes no measured figures for this release — the page above says so, and publishes the conditions instead. Treat a bare percentage with no stated conditions as unverified, wherever you find it.
Last updated on