AutoKuma 🐻

AutoKuma 是一个工具，可以根据 Docker 容器标签自动创建 Uptime Kuma 监视器。使用 AutoKuma，您可以在 Uptime Kuma UI 中消除手动创建监视器的需求。

如何安装 📦

支持的平台

为 windows、linux 和 mac 提供了二进制文件，可在 GitHub 发布 中找到，此外 AutoKuma 还可在 GitHub 容器注册表（GHCR） 上作为 Docker 容器使用。要安装，只需使用以下命令拉取容器：

最新发布版

docker pull ghcr.io/bigboot/autokuma:latest

开发版本

docker pull ghcr.io/bigboot/autokuma:master

❗ 开发版本可能存在破坏或不警告的破坏性更改，不建议在生产系统上使用。

示例 Docker Compose 🚀

以下是一个 docker-compose.yml 示例

version: '3'

services:
  autokuma:
    image: ghcr.io/bigboot/autokuma:latest
    restart: unless-stopped
    environment:
      AUTOKUMA__KUMA__URL: http://localhost:3001
      # AUTOKUMA__KUMA__USERNAME: <username> 
      # AUTOKUMA__KUMA__PASSWORD: <password>
      # AUTOKUMA__KUMA__MFA_TOKEN: <token>
      # AUTOKUMA__KUMA__HEADERS: "<header1_key>=<header1_value>,<header2_key>=<header2_value>,..."
      # AUTOKUMA__KUMA__CALL_TIMEOUT: 5
      # AUTOKUMA__KUMA__CONNECT_TIMEOUT: 5
      # AUTOKUMA__TAG_NAME: AutoKuma
      # AUTOKUMA__TAG_COLOR: "#42C0FB"
      # AUTOKUMA__DEFAULT_SETTINGS: |- 
      #    docker.docker_container: {{container_name}}
      #    http.max_redirects: 10
      #    *.max_retries: 3
      # AUTOKUMA__SNIPPETS__WEB: |- 
      #    {{container_name}}_http.http.name: {{container_name}} HTTP
      #    {{container_name}}_http.http.url: https://{{@0}}:{{@1}}
      #    {{container_name}}_docker.docker.name: {{container_name}} Docker
      #    {{container_name}}_docker.docker.docker_container: {{container_name}}
      # AUTOKUMA__DOCKER__HOSTS: unix:///var/run/docker.sock
      # AUTOKUMA__DOCKER__LABEL_PREFIX: kuma
      
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock

配置 🔧

AutoKuma 可以使用以下环境变量/配置键进行配置

AutoKuma 将从当前目录以及以下位置读取配置文件，文件名为 autokuma.{toml,yaml,json}

以下是一个示例 .toml 配置

[kuma]
url = "http://localhost:3001/"
username = "<username>"
password = "<password>"

用法 💡

AutoKuma 以以下格式解释 Docker 容器标签

<prefix>.<id>.<type>.<setting>: <value>

• <prefix>: 默认为 kuma，除非使用 DOCKER__LABEL_PREFIX 环境变量更改。
• <id>: 监视器的唯一标识符（确保在所有监视器之间唯一）。
• <type>：在 Uptime Kuma 中配置的监控器的类型。
• <setting>：要设置的值的键。
• <value>：选项的值。

标签根据 <id> 分组到一个监控器中。例如，要创建一个简单的 HTTP 监控器，请使用以下标签

kuma.example.http.name: "Example"
kuma.example.http.url: "https://example.com"

查看所有可用的监控器类型及其相应的设置：所有可用的监控器类型

AutoKuma 还提供创建和分配组的功能

kuma.mygroup.group.name: "This is a Group"
kuma.mymonitor.http.name: "This is a Monitor assigned to a Group"
kuma.mymonitor.http.parent_name: "mygroup"
kuma.mymonitor.http.url: "https://example.com"

AutoKuma 允许在标签和 片段 中使用 Tera 模板，以下变量可用

片段 📝

警告：片段目前是实验性的，将来可能会更改。

AutoKuma 提供了定义可重用片段的功能。片段需要在配置中定义，例如，使用环境变量

AUTOKUMA__SNIPPETS__WEB: |-
    {{ container_name }}_http.http.name: {{ container_name }} HTTP
    {{ container_name }}_http.http.url: https://{{ args[0] }}:{{ args[1] }}
    {{ container_name }}_docker.docker.name: {{ container_name }} Docker
    {{ container_name }}_docker.docker.docker_container: {{ container_name }}

或在等效的 TOML 配置文件中

[snippets]
web = '''
    {{ container_name }}_http.http.name: {{ container_name }}
    {{ container_name }}_http.http.url: https://{{ args[0] }}:{{ args[1] }}
    {{ container_name }}_docker.docker.name: {{ container_name }}_docker
    {{ container_name }}_docker.docker.docker_name: {{ container_name }}
'''

这些定义了一个名为 web 的片段。

片段可以有可变数量的参数，这些参数可以通过 {{ args[0] }}、{{ args[1] }}、{{ args[2] }} 等方式使用，如上所示。

要在容器上使用片段，请以以下格式分配标签

<prefix>.__<snippet>: <arguments>

例如，可以使用以下标签包含上述片段

kuma.__web: '"example.com", 443'

片段也使用 Tera，这允许使用一些相当高级的模板，以下是上述示例的扩展版本

{# Assign the first snippet arg to args to make access easier #}
{% set args = args[0] %}

{# Generate an autokuma id by slugifying the "name" arg #}
{% set id = args.name | slugify %}

{# if we have a "keyword" generate a "keyword" monitor, otherwise generate a "http" monitor #}
{% if args.keyword %}
    {% set type = "keyword" %}
{% else %}
    {% set type = "http" %}
{% endif %}


{# below are the actual lines which end up defining the monitor #}
{{ id }}-group.group.name: {{ args.name }}
{{ id }}-http.{{ type }}.name: {{ args.name }} (HTTP)
{{ id }}-http.{{ type }}.parent_name: {{ id }}-group
{{ id }}-http.{{ type }}.url: {{ args.url }}
{% if args.keyword %}
    {{ id }}-http.{{ type }}.keyword: {{ args.keyword }}
{% endif %}
{% if args.status_code %}
    {{ id }}-http.{{ type }}.status_code: {{ args.status_code }}
{% endif %}
{{ id }}-http-container.docker.name: {{ args.name }} (Container)
{{ id }}-http-container.docker.parent_name: {{ id }}-group

其用法如下：只是一个基本的 http 监控器

kuma.__web: '{ "name": "Example HTTP", "url": "https://example.com" }'

关键字监控器，具有自定义状态码

kuma.__web: '{ "name": "Example HTTP", "url": "https://example.com", "keyword": "Example Domain", "status_codes": ["200"] }'

静态监控器 📊

除了从 Docker 标签中读取监控器外，AutoKuma 还可以从文件中创建监控器。如果您希望 AutoKuma 管理与容器不直接相关的监控器，这可能很有用。

要创建静态监控器，只需在由 AUTOKUMA__STATIC_MONITORS 指定的目录中添加一个 .json 或 .toml 文件，请参考 此处示例。

静态监控器的默认目录为

在静态监控器的情况下，id 由文件名（不含扩展名）确定。