-
Notifications
You must be signed in to change notification settings - Fork 2
Technical
Claude edited this page Aug 28, 2026
·
1 revision
For whoever installs, configures, secures and operates a Cairn deployment. It stops at the boundary of the code : how to run the platform, not how to change it. Changing it is the SDK.
| Page | Contents |
|---|---|
| Architecture | The stack, the apps, how a request is served, the cross-cutting patterns every module inherits |
| Installation | Docker from source, the published image, pure Python with mise for debugging |
| Configuration | Every environment variable that matters, and the ones you must not leave at their default |
| Security | Authentication, permissions, tenancy, the audit trail, and what an operator still has to do |
| Operations | Scheduled commands, backups, upgrades, logs, health |
| Internationalisation | The bilingual contract and how a translated string travels |
| Testing | Running the suite, how it is organised, what CI enforces |
| Contributing | Branch, commit and pull-request conventions |
| Documentation | How this documentation set is built, checked and published |
| Release process | Tagging a version, the image, the GitHub release, the wiki |
The running version is read at startup from /etc/app-version (written into the
image at build time) or from version.txt, and falls back to dev. It is shown
in the interface footer, so a screenshot of a deployment always says which build
produced it.
Built from docs/ at v0.36.0. Edits made here are overwritten by the next release : open a pull request against the source instead.
- Administration
- Ask Cairn
- Assets and suppliers
- Compliance
- The dashboard
- Finding your way
- Getting started
- Incidents
- How records move
- Organisational context
- Reports and management review
- Risks
- Trust Center
- Architecture
- Configuration
- Contributing
- The documentation system
- Installation
- Internationalisation
- Operations
- Release process
- Security
- Testing
- Adding an assistant provider
- Adding a dashboard widget
- Adding a domain entity
- Declaring a lifecycle
- Adding an MCP tool
- Adding a REST endpoint
- Adding a report
- Interface conventions
- Dashboard widgets
- Lifecycles
- MCP tools
- MCP tool parameters : Assets
- MCP tool parameters : Compliance
- MCP tool parameters : Governance and context
- MCP tool parameters : General
- MCP tool parameters : Incidents
- MCP tool parameters : Reports and management review
- MCP tool parameters : Risks
- MCP tool parameters : System and administration
- MCP tool parameters : Trust Center
- Management commands
- Models
- Permissions
- REST endpoints
- Environment variables
- MCP server
- REST API
- Assistant module (Ask Cairn)
- Module 0: User Management and Access Control
- Module 1: Context and Organization
- Module 2: Asset Management
- Module 3: Compliance
- Module 4: Risk Management
- Module 4 bis - EBIOS Risk Manager
- Module 5 : Trust Center
- Module 6 : Security Incident Management
- Management review : ISO 27001:2022 compliance (clause 9.3)