traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Netgrimoire/Netgrimoire/Services/kuma/kuma.md

3.6 KiB
Raw Blame History

kuma Stack

description: Services Monitor

Overview

The kuma stack is a collection of services that provide monitoring capabilities in NetGrimoire. It includes Uptime Kuma, which displays the status of all services running on the swarm, and AutoKuma, which automates the process of adding new services to the monitoring system.

Architecture

| Service | Image | Port | Role | |- Host: docker4 |

  • Network: netgrimoire |
  • Exposed via: caddy.netgrimoire.com |
  • Homepage group: Monitoring |

| Service | Image | Port | Role | |- Service | Docker image | Host port | Function |

  • Uptime Kuma: louislam/uptime-kuma:1 | 3001 | Internal only | Display services status |
  • AutoKuma: ghcr.io/bigboot/autokuma:latest | - | - | Automate service monitoring |

Build & Configuration

Prerequisites

  • Docker installed on docker4

Volume Setup

mkdir -p /DockerVol/kuma:/app/data

Environment Variables

export AUTOKUMA__KUMA__URL=http://kuma:3001
export AUTOKUMA__KUMA__USERNAME=traveler
export AUTOKUMA__KUMA__PASSWORD=F@lcon12
export AUTOKUMA__TAG_NAME=AutoKuma

Deploy

cd services/swarm/stack/kuma
set -a && source .env && set +a
docker stack config --compose-file kuma-stack.yml > resolved.yml
docker stack deploy --compose-file resolved.yml kuma
rm resolved.yml
docker stack services kuma

First Run

User Guide

Accessing kuma

| Service | URL | Purpose | |- Uptime Kuma: https://kuma.netgrimoire.com | Display services status |

Primary Use Cases

  • View the status of all services running on the swarm.

NetGrimoire Integrations

  • Uptime Kuma is connected to all services in the swarm via Caddy reverse proxy and Uptime Kuma labels (caddy.dig.kuma, kuma.*).

Operations

Monitoring

docker stack services kuma
# Check for any issues with service monitoring

Backups

Critical: Regular backups of /DockerVol/kuma are essential to ensure data integrity.

Restore

./deploy.sh
# Re-deploy the `kuma` stack in case of a failure.

Common Failures

  1. Service not responding: The service is down, or there's an issue with the reverse proxy (Caddy). Symptom: Service status displays "Down". Cause: Service is down or Caddy has issues. Fix: Check if the service is running and if Caddy is configured correctly.

  2. No data available: No data is being sent to Uptime Kuma, or there's an issue with data forwarding. Symptom: Status displays "No data". Cause: No data is being sent to Uptime Kuma or there's an issue with data forwarding. Fix: Check if data forwarding is enabled and that the service is sending data correctly.

  3. AutoKuma not working: AutoKuma is unable to add new services to the monitoring system. Symptom: Services are not appearing in Uptime Kuma. Cause: AutoKuma configuration or service setup issues. Fix: Check AutoKuma configuration and ensure that services are properly set up.

  4. Uptime Kuma metrics: Uptime Kuma is not displaying expected metrics (e.g., load, memory usage). Symptom: Metrics are missing from the status display. Cause: Configuration or data issues. Fix: Check Uptime Kuma configuration and ensure that expected metrics are being collected.

Changelog

| Date | Commit | Summary |

- 2026-04-06 9d8b36be Initial documentation for kuma Stack.

Generated by Gremlin on 2026-04-07T03:21:11.998Z Source: swarm/kuma.yaml Review User Guide and Changelog sections