AutoKuma

Overview

AutoKuma is a utility that automates the creation of Uptime Kuma monitors based on Docker container labels. With AutoKuma, you can eliminate the need for manual monitor creation in the Uptime Kuma UI.

Requirements

        Requires a separate Uptime Kuma server

        Requires Docker containers to be labeled with the appropriate "Docker label prefix"
        You can add labels to a Docker container using the "Add another Path, Port, Variable, Label or Device" button in the Docker container settings.
        More about required labels here: https://github.com/BigBoot/AutoKuma?tab=readme-ov-file#usage-

Runtime arguments

Network: bridge
Privileged: true

Template configuration

Uptime Kuma URLVariable

URL of the Uptime Kuma instance to add monitors to

Target: AUTOKUMA__KUMA__URL
Default: http://localhost:3001

Uptime Kuma usernameVariable

Uptime Kuma username, required if auth is enabled

Target: AUTOKUMA__KUMA__USERNAME

Uptime Kuma passwordVariable

Uptime Kuma password, required if auth is enabled

Target: AUTOKUMA__KUMA__PASSWORD

Uptime Kuma MFA tokenVariable

Uptime Kuma MFA token, required if MFA is enabled

Target: AUTOKUMA__KUMA__MFA_TOKEN

Uptime Kuma tag nameVariable

The name of the AutoKuma tag, used to track managed containers

Target: AUTOKUMA__TAG_NAME
Default: AutoKuma

Uptime Kuma tag colorVariable

The color of the AutoKuma tag

Target: AUTOKUMA__TAG_COLOR
Default: #42C0FB

Docker label prefixVariable

The prefix for Docker labels that AutoKuma should look for

Target: AUTOKUMA__DOCKER__LABEL_PREFIX
Default: kuma

On deletion actionVariable

The action to take on the Uptime Kuma monitor when a container is deleted

Target: AUTOKUMA__ON_DELETE
Default: delete|keep

Uptime Kuma headersVariable

Comma-separated list of HTTP headers to send when connecting to Uptime Kuma

Target: AUTOKUMA__KUMA__HEADERS

Uptime Kuma connection timeoutVariable

The timeout for the initial connection to Uptime Kuma, in seconds

Target: AUTOKUMA__KUMA__CONNECT_TIMEOUT
Default: 5

Uptime Kuma call timeoutVariable

TThe timeout for executing calls to the Uptime Kuma server, in seconds

Target: AUTOKUMA__KUMA__CALL_TIMEOUT
Default: 5

Static monitor configuration pathsVariable

Path to the directory inside the container containing static monitor configurations

Target: AUTOKUMA__STATIC_MONITORS
Default: /static_monitors

AutoKuma static monitor configurationsPathrw

Path to the directory containing static monitor configurations

Target: /static_monitors
Default: /mnt/user/appdata/autokuma/static_monitors
Value: /mnt/user/appdata/autokuma/static_monitors

Docker socketPathro

Path to the Docker socket

Target: /var/run/docker.sock
Default: /var/run/docker.sock
Value: /var/run/docker.sock

Links

Template Support Registry Project

Details

Repository

ghcr.io/bigboot/autokuma

Registry

https://github.com/BigBoot/AutoKuma/pkgs/container/autokuma

Last Updated2026-06-01

First Seen2024-05-09

Run AutoKuma on Unraid.

AutoKuma is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.

Explore Unraid OS