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

4.1 KiB
Raw Blame History

title description published date tags editor dateCreated
gatus Stack Gatus service documentation for NetGrimoire true 2026-04-22T20:59:00.621Z docker,swarm,gatus,netgrimoire markdown 2026-04-22T20:59:00.621Z

gatus

Overview

The gatus stack is a Docker Swarm-based service that provides a monitoring platform for NetGrimoire. It consists of two primary services: gatus and kuma.

Architecture

Service Image Port Role
  • gatus: twinproduction/gatus:latest | 8080 | Reverse proxy | | | | | |
  • kuma: twinproduction/kuma:latest | 9091 | Monitoring |

Exposed via: status.netgrimoire.com

Homepage group: NetGrimoire

Build & Configuration

Prerequisites

No specific prerequisites are required for this stack.

Volume Setup

mkdir -p /DockerVol/gatus/config
chown -R gatus:gatus /DockerVol/gatus/config

Environment Variables

PUID=1964
PGID=1964
TZ=America/Chicago
GATUS_CONFIG_PATH=/config/config.yaml

CADDY_URLS=status.netgrimoire.com:8080
KUMA_URL=kuma.netgrimoire.com:9091

Deploy

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

First Run

After deployment, verify that the services are running and the Caddy reverse proxy is configured correctly.

User Guide

Accessing gatus

Service URL Purpose

Primary Use Cases

Use the gatus monitoring platform to track service performance and uptime for NetGrimoire.

NetGrimoire Integrations

The gatus stack integrates with other NetGrimoire services through environment variables and labels, including kuma for monitoring.

Operations

Monitoring

docker stack services gatus
docker service logs -f gatus

Backups

Critical data is stored in /DockerVol/gatus/data. Non-critical data can be restored from backup files.

Restore

cd services/swarm/stack/gatus
./deploy.sh

Common Failures

  1. Caddy Configuration Failure: If the Caddy reverse proxy configuration fails, the gatus service may not be accessible.

    • Symptom: "gatus" is not available in kuma monitoring.
    • Cause: Incorrect Caddy URL or configuration file issues.
    • Fix: Verify Caddy configuration and update if necessary.

  2. Kuma Configuration Failure: If the kuma monitoring configuration fails, the gatus service may not be properly tracked.

    • Symptom: "gatus" is missing from kuma monitoring.
    • Cause: Incorrect kuma URL or configuration file issues.
    • Fix: Verify kuma configuration and update if necessary.

  3. Network Failure: If the network connectivity between services fails, the gatus service may not be accessible.

    • Symptom: "gatus" is not available in Caddy reverse proxy.
    • Cause: Network failure or misconfigured Docker Swarm network.
    • Fix: Verify network configuration and update if necessary.

  4. Timeout Issues: If there are timeout issues with the gatus monitoring service, it may not be able to track performance data for NetGrimoire services.

    • Symptom: Long timeouts when checking monitoring status.
    • Cause: Misconfigured Docker Swarm service or kuma configuration file issues.
    • Fix: Verify Docker Swarm service configuration and update if necessary.

Changelog

Date Commit Summary
2026-04-22 1d9aafe5 Initial documentation creation
2026-04-22 1b2eac82 Initial documentation formatting and completion
2026-04-22 c56f5a87 Added more detailed error handling for Docker Swarm service failures
2026-04-22 fe8d558a Improved network configuration instructions to address common issues
2026-04-22 66d68536 Minor documentation cleanup and formatting improvements

Generated by Gremlin on 2026-04-22T20:59:00.621Z Source: swarm/gatus.yaml Review User Guide and Changelog sections