Releases

Use the Citadel releases page to check which versions and images are available. Read the notes for the version you plan to install. Leaving CITADEL_IMAGE blank in your installation's .env uses ghcr.io/citadel-p/citadel:latest. You can set a complete image address to choose a specific version instead.

Choose an image version

Published images have aliases for the full version, the minor version, and the major version.

For example, 0.1.2, 0.1, and 0 are three aliases of an initial publication. Minor and major aliases can later move. Use an exact patch version or digest when you need a repeatable installation. Core releases also publish latest, the default for new installations. Pulling a newer image does not update a running container until you recreate it with docker compose up -d.

Documentation and API

Use documentation and the public API schema that match your installed version. See API Preview for reference options, including Swagger UI on your own installation.

For installation steps, see install Citadel. Before changing versions, follow upgrade and rollback.