# AutoKuma

AutoKuma is a utility that automates the creation of Uptime Kuma monitors based on Docker container labels. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/2637/autokuma

## Description

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.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

62/100 (Good), based on 4 of 5 factors.
- Maintained: 67 (last commit 156 days ago)
- Popular: 59 (930 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Security check: 84 (no serious findings, 1 minor, CI)

## Links

- Unraid: https://ca.unraid.net/apps/autokuma-0z1cl331au7jz7?q=AutoKuma

## Common questions

### What labels should I add to a Docker container so AutoKuma creates a monitor?

Add labels using the label prefix, a unique monitor identifier, the monitor type, and the property to set. For example, kuma.my-app.http.name and kuma.my-app.http.url create an HTTP monitor in Uptime Kuma.

### What minimum configuration does AutoKuma need to sync with Uptime Kuma?

It needs the Uptime Kuma URL, username, and password. The docs show these as AUTOKUMA__KUMA__URL, AUTOKUMA__KUMA__USERNAME, and AUTOKUMA__KUMA__PASSWORD, or in a TOML settings file.

### Can AutoKuma create monitors from anything other than Docker labels?

It also supports monitors from JSON or TOML files. Docker Swarm and Kubernetes support are available on an as-is basis because the author is not currently running those setups.

### How do I configure a literal value that starts with @/ ?

Use the @@/ prefix so AutoKuma treats the value as a literal string instead of a file path.

---
Source: Our Local Host (https://ourlocalhost.com/app/2637/autokuma), the self-hosted and open-source app directory.
