Skip to content

Getting started

Axium ships as two container images plus a PostgreSQL database. This section takes you from nothing to a working installation you can log in to.

  • Requirements

    What you need before you start: Docker, a PostgreSQL 17 database, a Quay token and your Axium license.

    Requirements

  • Install with Docker

    Three docker run commands. The fastest way to evaluate Axium on a laptop or a single VM.

    Docker

  • Install with Docker Compose

    The same deployment as a single, versionable compose.yaml.

    Docker Compose

  • Install on Google Cloud

    One script creates Cloud SQL, copies the images and deploys both services to Cloud Run.

    Google Cloud

The three pieces

Piece Image What it is State
core quay.io/axiumlab/core The API: authentication, provider gateways, observability. Listens on port 3000. Stateless
ui quay.io/axiumlab/ui The web console. A static site served by Node on port 3001. Stateless
PostgreSQL postgres:17-alpine or a managed service Everything Axium persists. The only state

The core and the ui never write to disk. The PostgreSQL volume is the only thing you have to back up.

Image tags

Both images publish the same three tags:

Tag Meaning Use it for
vX.Y.Z (e.g. v0.1.0) A specific, immutable version. Production.
vX-latest (e.g. v1-latest) The latest release of that major. Staging.
latest The latest release published. Evaluation. 
docker login quay.io
docker pull quay.io/axiumlab/core:latest
docker pull quay.io/axiumlab/ui:latest