BigBoot / AutoKuma

[](HEADER) AutoKuma &nbsp&nbsp Kuma CLI &nbsp&nbsp Kuma Client &nbsp&nbsp Playground AutoKuma 🐻 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. Supported sources AutoKuma initially supported sourcing monitor configurations from docker labels, over the time a few other methods were added, here is an overview of the available sources: | Source | Description | Support | |--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| | Docker | Monitors are sourced from container labels | ✅ | | Files | Monitors are sourced from .json/.toml files | ✅ | | Docker Swarm | Monitors can be sourced from service and/or container labels | ⚠️* | | Kubernetes | Monitors are sourced from CR, see the CRDs in . Additionally the and provider might be used depending on your setup | ⚠️* | *These sources are supported on an as-is basis as I'm currently not running any of them (They are basically looking for a maintainer, please get in contact if you'd like to adopt one or add support for another source). How to Install 📦 Supported Platforms | Platform | Architecture | Docker Images | Prebuild Binaries | Notes | |----------|--------------|---------------|-------------------|------------------------| | Windows | x64 | ⛔︎ | ✅ | | | Windows | arm64 | ⛔︎ | ⛔︎ | | | Linux | x64 | ✅ | ✅* | | | Linux | arm64 | ⚠️* | ⛔︎ | Experimental | | Mac | x64 | ⛔︎ | ⛔︎ | | | Mac | arm64 | ⛔︎ | ⚠️* | Experimental | Binaries for windows linux and mac are provided for GitHub Releases, additionally AutoKuma is available as a Docker container on GitHub Container Registry (GHCR). To install, simply pull the container using: Latest Release: Dev Version: ❗ The dev version might break or contain breaking changes without warning, usage on a production system is not adviced. Example Docker Compose 🚀 Here's an example : Configuration 🔧 AutoKuma can be configured using the following environment variables/config keys: | Env Variable | Config Key | Description | |------------------------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------| | | | The path to the folder in which AutoKuma will search for static Monitor definitions | | | | The name of the AutoKuma tag, used to track managed containers | | | | The color of the AutoKuma tag | | | | Default settings applied to all generated Monitors, see the example above for the syntax | | | | Path to a directory where log files will be stored | | | | Specify what should happen to a monitor if the autokuma id is not found anymore, either or | | | | How long to wait in seconds before deleting the entity if the autokuma is not not found anymore | | | | Allow access to all env variables in templates, by default only variables starting with AUTOKUMA__ENV__ can be accessed. | | | | Define a snippet named , see Snippets for details | | | | The URL AutoKuma should use to connect to Uptime Kuma | | | | The username for logging into Uptime Kuma (required unless auth is disabled) | | | | The password for logging into Uptime Kuma (required unless auth is disabled) | | | | The MFA token for logging into Uptime Kuma (required if MFA is enabled) | | | | The MFA secret. Used to generate a tokens for logging into Uptime Kuma (alternative to a single_use mfa_token) | | | | JWT auth token received after a successful login, can be used instead of username/password | | | | List of HTTP headers to send when connecting to Uptime Kuma | | | | The timeout for the initial connection to Uptime Kuma | | | | The timeout for executing calls to the Uptime Kuma server | | | | Whether to verify the TLS certificate for Uptime Kuma connections | | | | Path to a custom PEM certificate for Uptime Kuma connections | | | | Enable/disable Docker source | | | | Docker hosts list; supports semicolon string ( ) and JSON array string with | | | | Prefix used when scanning for container labels | | | | Whether monitors should be created from or labels (or ). | | | | Regex patterns to exclude containers by name (semicolon-separated) | | | | Enable/disable Kubernetes source | | | | Enable/disable Files source | | | | Whether AutoKuma should follow symlinks when looking for "static monitors" (Defaults to false) | AutoKuma will read configuration from a file named in the current directory and in the following locations: | Platform | Value | Example | |----------|----------------------------------------------------------------------|---------------------------------------------------------------| | Linux | /autokuma/config.{toml,yaml,json} | /home/alice/.config/autokuma/config.toml | | macOS | /Library/Application Support/autokuma/config.{toml,yaml,json} | /Users/Alice/Library/Application Support/autokuma/config.toml | | Windows | \autokuma\config.{toml,yaml,json} | C:\Users\Alice\AppData\Local\autokuma\config.toml | An example config could look like the following: For environment variables, supports both formats: Usage 💡 AutoKuma interprets Docker container labels with the following format: • : Default is unless changed using the env variable. • : A unique identifier for the monitor (ensure it's unique between all monitors). • : The type of the monitor as configured in Uptime Kuma. • : The key of the value to be set (also called "property"). • : The value for the option. Labels are grouped by into a single monitor. For example, to create a simple HTTP monitor, use the following labels: Take a look at all available entity types and their corresponding settings. Groups To assign a monitor to a group set it's parent_name property to the autokuma id of the group, e.g. Notifications **_WARNING:_** Defining Notifications is…