All reference guides
Find complete installation, operations, API, security, and development documentation on this site.
Start with the installation walkthrough or your first deployment.
Use these reference guides when you need detailed settings, commands, or recovery procedures.
Installation reference
- Deployment configuration — Configure Compose, Podman, databases, HTTPS, and server execution.
- Kubernetes and Helm — Install the Helm chart and configure PostgreSQL, secrets, and ingress.
- Agent operations — Install, pair, route, maintain, and recover remote agents.
- Agent container setup — Configure the standalone agent runtime and container execution.
- Agent versions and images — Identify standalone agent builds and configure container release metadata.
Operations reference
- Backup and restore — Create consistent backups, restore data, and verify recovery.
- OIDC and Authentik — Configure single sign-on, identity linking, role mapping, and recovery.
- Roles and permissions — Understand global roles, project memberships, and token limits.
- Notification settings — Configure delivery channels, SMTP, and notification history.
- Artifact approval — Set up planning, administrator review, and approved artifact execution.
- Template library — Use the curated deployment starters and provide their required settings.
- Versions and compatibility — Identify builds and coordinate server, container, and agent upgrades.
Security reference
- Security and key rotation — Understand execution boundaries, authentication, secrets, and key rotation limits.
- Security verification — Repeat the security checks against an isolated test installation.
API reference
- API operations guide — Authenticate, manage resources, deploy releases, and inspect results through HTTP.
- Agent protocol — Read the pairing, polling, claims, logs, and result protocol contracts.
Development reference
- Build and develop — Build from source, generate assets, and run isolated development stacks.
- Manual testing and demos — Repeat the application scenarios and operate retained demo instances.
- GitLab CI — Configure pipelines, runner resources, credentials, and quality checks.
- Browser testing — Run browser checks and retain evidence from the supported test image.
- Security scanning — Run the repository security gates and inspect their reports.
- Historical SonarCloud review — Read the recorded source fixes and reviewed scanner dispositions from October 2026.
- Application design system — Follow application layout, forms, navigation, permissions, and accessibility conventions.
- Contributor conventions — Follow the repository rules for generated code, migrations, testing, and documentation.
- Application overview — Read the application introduction, quick start, capabilities, and limits.
API endpoints and schemas
Open the API reference for the complete endpoint and schema catalog.