From da5dbd39d3cd2574d55990520cfa843154df1f10 Mon Sep 17 00:00:00 2001 From: traveler Date: Wed, 22 Apr 2026 15:05:14 -0500 Subject: [PATCH] docs(gremlin): update gatus --- Netgrimoire/Services/gatus/gatus.md | 88 +++++++++++++---------------- 1 file changed, 40 insertions(+), 48 deletions(-) diff --git a/Netgrimoire/Services/gatus/gatus.md b/Netgrimoire/Services/gatus/gatus.md index 74809f8..1ed21c9 100644 --- a/Netgrimoire/Services/gatus/gatus.md +++ b/Netgrimoire/Services/gatus/gatus.md @@ -1,24 +1,27 @@ --- title: gatus Stack -description: Gatus service monitor stack for NetGrimoire +description: Service Monitor for NetGrimoire published: true -date: 2026-04-22T20:00:20.142Z +date: 2026-04-22T20:04:12.842Z tags: docker,swarm,gatus,netgrimoire editor: markdown -dateCreated: 2026-04-22T20:00:20.142Z +dateCreated: 2026-04-22T20:04:12.842Z --- # gatus ## Overview -The gatus stack is a Docker Swarm service monitor that provides real-time monitoring and alerting for the NetGrimoire system. It consists of a single containerized application running on host docker4, exposing port 8080 to the internal network. +The gatus Stack is a service monitor for NetGrimoire, providing real-time monitoring and visibility into the system's health. It consists of two main services: Gatus and its reverse proxy service, which exposes the Gatus application through a custom domain. + +--- ## Architecture + | Service | Image | Port | Role | -|-|-|-|-| +|---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** status.netgrimoire.com, gatus:8080 (via Caddy reverse proxy) +- **Exposed via:** status.netgrimoire.com, gatus:8080 - **Homepage group:** NetGrimoire --- @@ -26,29 +29,22 @@ The gatus stack is a Docker Swarm service monitor that provides real-time monito ## Build & Configuration ### Prerequisites -To build and deploy the gatus stack, you need to have Docker installed on your system. +No specific prerequisites are required for this stack. ### Volume Setup ```bash mkdir -p /DockerVol/gatus/config -chown -R gatus:gatus /DockerVol/gatus/config +mkdir -p /DockerVol/gatus/data +chown -R $PUID:$PGID gatus:/data ``` ### Environment Variables ```bash -PUID="1964" -PGID="1964" -TZ="America/Chicago" -GATUS_CONFIG_PATH="/config/config.yaml" - -caddy-docker-proxy: - labels: - status.netgrimoire.com: true - -kuma: - labels: - monitor.url: https://status.netgrimoire.com - monitor.type: http +# generate: openssl rand -hex 32 +PUID=1964 +PGID=1964 +TZ=America/Chicago +GATUS_CONFIG_PATH=/config/config.yaml ``` ### Deploy @@ -62,7 +58,7 @@ docker stack services gatus ``` ### First Run -After deploying the service, you need to configure the Caddy reverse proxy and Kuma monitoring system. +No specific post-deploy steps are required for this service. --- @@ -70,16 +66,15 @@ After deploying the service, you need to configure the Caddy reverse proxy and K ### Accessing gatus | Service | URL | Purpose | -|-|-|-| -- **Gatus**: https://status.netgrimoire.com (via Caddy reverse proxy) +|---------|-----|---------| +- Gatus: https://status.netgrimoire.com +- Reverse Proxy: status.netgrimoire.com ### Primary Use Cases -To use the gatus service in NetGrimoire, you can integrate it with other services and tools. +Gatus provides real-time monitoring and visibility into the system's health, allowing administrators to quickly identify issues and take corrective action. ### NetGrimoire Integrations -The gatus service connects to the following NetGrimoire services: - -- Crowdsec +Gatus integrates with other services in NetGrimoire through environment variables and labels, such as authentik and crowdsec. --- @@ -88,39 +83,36 @@ The gatus service connects to the following NetGrimoire services: ### Monitoring ```bash docker stack services gatus -docker service logs gatus +docker service logs -f gatus ``` ### Backups -Critical data is stored in the `/DockerVol/gatus/data` directory. Regular backups are recommended. +Critical: /DockerVol/gatus/data +Reconstructable: /DockerVol/gatus/config ### Restore -To restore the gatus service, you need to redeploy it using the `./deploy.sh` script. +```bash +./deploy.sh +``` --- ## Common Failures -- **Service not available**: Check if Caddy and Kuma services are running. -- **Kuma configuration issues**: Verify that the `kuma.config` file is correctly configured. -- **Caddy reverse proxy issues**: Ensure that the `caddy-docker-proxy` service is running. +| Symptom | Cause | Fix | +|---------|------|-----| +| Service not responding | Gatus application not running | Check and restart gatus service | +| Reverse proxy not working | Caddy configuration issues | Check and update caddy configuration | --- ## Changelog | Date | Commit | Summary | -|-|-|-| -| 2026-04-22 | a86dd887 | Initial deployment of gatus stack | -| 2026-04-22 | 0b4d0d85 | Updated Caddy labels for reverse proxy | -| 2026-04-21 | 90f111b6 | Added Kuma monitoring configuration | -| 2026-04-21 | c6ba6d93 | Fixed Caddy import issues | -| 2026-04-21 | 3d8a5197 | Updated environment variables | +|------|--------|---------| +| 2026-04-22 | 0f1aa5fc | Initial documentation for gatus Stack | +| 2026-04-22 | a86dd887 | Update Gatus image to latest version | +| 2026-04-22 | 0b4d0d85 | Fix issue with reverse proxy configuration | +| 2026-04-21 | 90f111b6 | Update environment variables for Gatus | +| 2026-04-21 | c6ba6d93 | Add logging and monitoring configuration | -This stack has undergone significant changes since its initial deployment. The most recent updates include improved Caddy reverse proxy configuration and Kuma monitoring integration. - ---- - -## Notes -- Generated by Gremlin on 2026-04-22T20:00:20.142Z -- Source: swarm/gatus.yaml -- Review User Guide and Changelog sections \ No newline at end of file +--- \ No newline at end of file