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 -hex 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>
    ./mantrae

Option 2: Use Docker​

Run Mantrae in a Docker container:

docker run --name mantrae -e SECRET=<your_secret> -d -p 3000:3000 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. Download the example docker-compose.yml.
  2. Run the following command to start both 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 user admin and the generated password, which will display on the first run.

CLI Options​

  • -version: Print the version.
  • -config: Specify the path where the database should be stored. (Default: ./mantrae.db)
  • -port: Set the port to listen on. (Default: 3000)
  • -update: Update mantrae to the latest version. (Will not work inside docker container!)
  • -reset: Reset the admin password. Will generate a new one and print it to the console.
  • -auth: Enable basic auth for the profile endpoint. (Default: false). This will protect the /api/<profilename> endpoint using BasicAuth. If you enable this you need to set the correct headers in Traefik so it can fetch the data. Example default mantrae user is admin and password is supersecret, use echo -n "admin:supersecret" | base64 to generate the Credentials. After that you can configure the http provider in Traefik: providers.http.headers.Authorization=Basic YWRtaW46c3VwZXJzZWNyZXQ=

Optionally you can set the default profile by providing the flags below:

  • -url: Set the URL of the Traefik instance. (e.g.: http://localhost:8080)
  • -username: Set the username for basic auth, if your Traefik instance uses basic auth. (e.g.: admin)
  • -password: Set the password for basic auth. (e.g.: supersecret)