Skip to main content

Installation

Follow these instructions to install and start using Mantrae with Traefik.

Prerequisites​

  1. Install Traefik: Ensure you have a running instance of Traefik.
  2. Generate a Secret: Create a secure, random secret key to use with Mantrae: 
    openssl rand -base64 32
    Copy the generated secret as you'll need it in the next steps.

Installation Options​

Option 1: Download the Binary​

  1. Visit the releases page to download the latest Mantrae binary for your platform.
  2. Run the binary with: 
    export SECRET=<your_secret>
    export ADMIN_PASSWORD=<your_admin_password>
    ./mantrae

Option 2: Use Docker​

Run Mantrae in a Docker container:

docker run --name mantrae -e SECRET=your_secret -e ADMIN_PASSWORD=your_admin_password -p 3000:3000 -v mantrae-data:/app/data ghcr.io/mizuchilabs/mantrae:latest

Option 3: Docker Compose (Mantrae + Traefik)​

Use the provided docker-compose.yml file to deploy Mantrae and Traefik together.

  1. Checkou out the example docker-compose.yml and modify it to suit your needs.
  2. Run the following command to start the services: 
    docker compose up -d

Access the Web UI​

Once Mantrae is running, open your browser and navigate to:

http://localhost:3000

Log in using the default credentials:

  • Username: admin
  • Password: your_admin_password

CLI Options​

  • -version: Print the version.
  • -update: Update Mantrae to the latest version. (Will not work inside docker container!)