Before you install

For a local trialCopy Anchor Link

• A Linux Docker host with Docker running.
• Docker Compose 2.30 or newer; the supplied file uses raw environment-file values.
• curl to download the installation files and a text editor to configure .env.
• Internet access to download the installation files and container images.
• Persistent disk space for PostgreSQL, Citadel settings, and your applications.

Check the tools with docker --version, docker compose version, and curl --version. Follow the quick start when these are available.

Citadel receives administrative access to the local Docker host through its Docker socket. Install it on a host you control and protect administrator access.

For a shared installationCopy Anchor Link

Also prepare an HTTPS hostname, certificates or an HTTPS reverse proxy, a backup destination, and the required network connections. Edge Agents need a reachable HTTP/2 gRPC endpoint as well as the normal browser address. The installation guide explains the choices.

Versions and compatibilityCopy Anchor Link

Use the release notes for the architectures of a build. Citadel is pre-release: run Core, Agents and frontend from the same current build. Use the Agent command generated by that installation.

The installation defaults to the latest Core image tag. You can optionally pin a published image version listed in the release notes.