# kuma Stack

description: Service Monitor for NetGrimoire

---
# kuma

## Overview
The kuma stack provides a service monitoring solution for NetGrimoire, featuring the uptime-kuma service. This stack monitors services' health and performance.

## Architecture
| Service | Image | Port | Role |
|---------|-------|------|-------|
- **Host:** docker4
- **Network:** netgrimoire
- Exposed via: kuma.netgrimoire.com
- Homepage group: Monitoring

---
# Build & Configuration

### Prerequisites
No specific prerequisites for this stack.

### Volume Setup
```bash
mkdir -p /DockerVol/kuma
chown -R 1964:1964 /DockerVol/kuma
```

### Environment Variables
```bash
AUTOKUMA__KUMA__URL=http://kuma:3001
AUTOKUMA__KUMA__USERNAME=traveler
AUTOKUMA__KUMA__PASSWORD=F@lcon12
AUTOKUMA__TAG_NAME=AutoKuma
AUTOKUMA__DOCKER__SOURCE="local"
```

### Deploy
```bash
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
Run the following command to complete any pending setup:
```bash
./deploy.sh
```

---
# User Guide

### Accessing kuma
| Service | URL |
|---------|-----|
- **Service Status**: https://kuma.netgrimoire.com
- **Kuma Admin**: http://caddy.netgrimoire.com

### Primary Use Cases
To access the service status and monitor your services, use the following URLs.

### NetGrimoire Integrations
This stack connects to other services in NetGrimoire through environment variables.

---
# Operations

### Monitoring
```bash
docker stack services kuma
docker logs -f $(docker ps --format 'json' | jq -r '.[]|@base64|base64 --decode')
```

### Backups
Critical data should be stored on a separate volume. If the primary /DockerVol/kuma is critical, consider enabling backups.

### Restore
To restore the kuma stack, run:
```bash
cd services/swarm/stack/kuma
./deploy.sh
```

---
# Common Failures

| Symptom | Cause | Fix |
|---------|-------|-----|
| Kuma Admin not available | Caddy is down | Restart caddy: docker service restart kuma.netgrimoire.com |
| Service Status not updating | Uptime-kuma configuration is incorrect | Check uptime-kuma config and update as necessary |

---
# Changelog

| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-04 | 5b03dbf9 | Initial Documentation |
| 2026-04-04 | 6f0000c4 | Minor configuration updates |
| 2026-03-30 | e58b778a | Introduced diun.enable=true label |
| 2026-03-30 | 6f369592 | Added homepage group and icon labels |
| 2026-03-30 | 34d16798 | Updated deployment script |
| 2026-01-20 | 061ab0c2 | Initial creation of stack |

---
# Notes
Generated by Gremlin on 2026-04-04T19:17:10.183Z
Source: swarm/kuma.yaml
Review User Guide and Changelog sections