Installation

Docker is Maintainerr's supported method of installation.

Images for amd64 & arm64 are available under jorenn92/maintainerr and ghcr.io/jorenn92/maintainerr. The containers data location is set as /opt/data. A Docker volume is strongly encouraged to persist your configuration.

Setting the host data directory largely depends on how you are installing Maintainerr. If using Docker, these are the two places where you would set the host data directory, depending on your method.

volumes:
  - type: bind
    source: <your host location>
    target: /opt/data

Run¶

    docker run -d \
    --name maintainerr \
    -e TZ=Europe/Brussels \
    -v <yourhostlocation>:/opt/data \ # (3)!
    -u 1000:1000 \
    -p 6246:6246 \ # (1)!
    --restart unless-stopped \
    ghcr.io/jorenn92/maintainerr:latest # (2)!

1. This is defined as host:container.
2. For this line, you could also use jorenn92/maintainerr instead, to use the DockerHub image.
3. In Docker containers, you are able to bind a host directory to a directory inside the container. This allows for persistent data when a container is restarted or reset.

Updating¶

Stop and remove the existing container:

docker rm -f maintainerr

Pull the latest image:

docker pull ghcr.io/jorenn92/maintainerr:latest

Finally, run the container with the same parameters you originally used to create/start the container.

You may alternatively use a third-party updating mechanism, such as Watchtower, to keep Maintainerr up-to-date automatically.

Enabling Debug Logging¶

To produce some more informational logging output, either the whole time Maintainerr is running or while you are troubleshooting a specific issue, we recommend turning on debug logging.

    docker run -d \
    --name maintainerr \
    -e TZ=Europe/Brussels \
    -e DEBUG=true\
    -v <yourhostlocation>:/opt/data \
    -u 1000:1000 \
    -p 6246:6246 \
    --restart unless-stopped \
    ghcr.io/jorenn92/maintainerr:latest

Compose¶

Define the Maintainerr service in your docker-compose.yml as follows.

services:
    maintainerr:
        image: ghcr.io/jorenn92/maintainerr:latest # (1)!
        user: 1000:1000
        volumes:
          - type: bind
            source: <your host location> # (3)!
            target: /opt/data
        environment:
          - TZ=Europe/Brussels
   #      - DEBUG=true # uncomment (remove the hashtag) to enable debug logs
        ports:
          - 6246:6246 # (2)!
        restart: unless-stopped

1. For this line, you could also use jorenn92/maintainerr instead, to use the DockerHub image. The latest tag at the end is not required, unless you want to specify which tag to use.
2. This is defined as host:container.
3. In Docker containers, you are able to bind a host directory to a directory inside the container. This allows for persistent data when a container is restarted or reset.

Save your docker-compose.yml file. Then, while in the directory where your docker-compose file exists, start all services defined in your Compose file:

docker compose up -d

Updating¶

Pull the latest image:

docker compose pull

Then, restart all services defined in the Compose file:

docker compose up -d

Enabling Debug Logging¶

To produce some more informational logging output, either the whole time Maintainerr is running or while you are troubleshooting a specific issue, we recommend turning on debug logging.

services:
    maintainerr:
        image: ghcr.io/jorenn92/maintainerr:latest
        user: 1000:1000
        volumes:
          - type: bind
            source: <your host location>
            target: /opt/data
        environment:
          - TZ=Europe/Brussels
          - DEBUG=true
        ports:
          - 6246:6246
        restart: unless-stopped

Environment Variables¶

A list of all available environment variables are below. No other env variables are officially supported by Maintainerr. These are added either into the compose file or your docker run command.