Skip to main content

Installation

There are multiple ways to install Auditum. Select one that suits your needs.

Binary

You can download a binary for your platform from the releases page.

Docker

The easiest way to run Auditum is to use a Docker image. Images are available on these registries:

Example of running Auditum in a Docker container:

docker run \
-p 8080:8080 \
auditumio/auditum:latest

Or, using a specific version from GitHub Container Registry:

docker run \
-p 8080:8080 \
ghcr.io/auditumio/auditum:0.1.0

Kubernetes

caution

Kubernetes Helm chart is currently in development.

Source

You can build Auditum from source.

Prerequisites

Instruction

  1. Clone the repository:

    git clone https://github.com/auditumio/auditum.git
    cd auditum
  2. Build the binary:

    task build

Next Steps

Follow the Configuration guide to learn how to configure Auditum.