BigBoot / 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.
MIT License
307 stars 15 forks source link

Kuma CLI #100

Open lordlightman opened 22 hours ago

lordlightman commented 22 hours ago

Hello. Thank you for your awesome work on a project.

I was wondering if you can help me figure out how to use kuma CLI. I am running Autokuma as a Docker container on my RPI 5. Here is my config:

autokuma:
    image: ghcr.io/bigboot/autokuma:0.8.0
    container_name: uptime-kuma-labels
    restart: unless-stopped
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./autokuma:/data
    environment:
      AUTOKUMA__KUMA__URL: https://example.com
      AUTOKUMA__KUMA__USERNAME: <username>
      AUTOKUMA__KUMA__PASSWORD: <password>
      AUTOKUMA__DEFAULT_SETTINGS: |-
        http.expiryNotification: false
        docker.docker_host: 1

Here is what I get when I try to obtain a list of monitors:

docker compose exec autokuma kuma monitor list
OCI runtime exec failed: exec failed: unable to start container process: exec: "kuma": executable file not found in $PATH: unknown
BigBoot commented 7 hours ago

Hi, the kuma CLI is a separate application and is currently not included in the main autokuma docker image.

You can just run it as a separate container (e.g. docker run --rm -it ghcr.io/bigboot/kuma:0.8.0 --url <> --username <> --password <> monitor list)