docs(gremlin): create gatus

2026-04-21 19:35:02 -05:00 · 2026-04-21 19:35:02 -05:00 · 372b3f0c50
commit 372b3f0c50
parent ca3382ad6b
1 changed files with 119 additions and 0 deletions
--- a/Netgrimoire/Services/gatus/gatus.md
+++ b/Netgrimoire/Services/gatus/gatus.md
@ -0,0 +1,119 @@
+---
+title: gatus Stack
+description: Gatus is a monitoring service for NetGrimoire.
+published: true
+date: 2026-04-22T00:34:00.735Z
+tags: docker,swarm,gatus,netgrimoire
+editor: markdown
+dateCreated: 2026-04-22T00:34:00.735Z
+---
+
+# gatus
+
+## Overview
+Gatus is a monitoring service for NetGrimoire, providing real-time insights into the performance and availability of the platform's services.
+
+---
+
+## Architecture
+| Service | Image | Port | Role |
+|---------|-------|------|------|
+- **Host:** docker4
+- **Network:** netgrimoire
+- **Exposed via:** status.netgrimoire.com, gatus:8080
+- **Homepage group:** NetGrimoire
+
+---
+
+## Build & Configuration
+
+### Prerequisites
+This service requires the `docker` and `caddy` software to be installed on the `znas` node.
+
+### Volume Setup
+```bash
+mkdir -p /DockerVol/gatus/config
+mkdir -p /DockerVol/gatus/data
+chown -R gatus:gatus /DockerVol/gatus/
+```
+
+### Environment Variables
+```bash
+# generate: openssl rand -hex 32
+PUID=1964
+PGID=1964
+TZ=America/Chicago
+GATUS_CONFIG_PATH=/config/config.yaml
+```
+
+### Deploy
+```bash
+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 the initial deployment, ensure that the `caddy` reverse proxy is configured correctly to forward requests to the `gatus` service.
+
+---
+
+## User Guide
+
+### Accessing gatus
+| Service | URL | Purpose |
+- **Gatus** | https://status.netgrimoire.com | Service Monitor |
+
+### Primary Use Cases
+To use Gatus effectively, configure your services to report their performance and availability metrics to the `gatus` service.
+
+### NetGrimoire Integrations
+Gatus integrates with other NetGrimoire services through environment variables and labels. Refer to the documentation for specific integration details.
+
+---
+
+## Operations
+
+### Monitoring
+```bash
+docker stack services gatus
+docker service logs -f gatus | grep kuma
+```
+
+### Backups
+Critical data is stored in `/DockerVol/gatus/data`. Regular backups are recommended to ensure data integrity.
+
+### Restore
+```bash
+cd services/swarm/stack/gatus
+./deploy.sh
+```
+
+---
+
+## Common Failures
+| Symptom | Cause | Fix |
+|---------|-------|-----|
+| Service not responding | Insufficient network bandwidth | Increase network bandwidth |
+| Configuration errors | Misconfigured environment variables or labels | Review and correct configuration files |
+
+---
+
+## Changelog
+
+| Date | Commit | Summary |
+|------|--------|---------|
+| 2026-04-21 | 3d8a5197 | Initial documentation and migration to swarm configuration |
+
+<Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.>
+Gatus has undergone significant changes in its recent version, including a migration to swarm configuration. The latest documentation reflects these changes and provides a comprehensive overview of the service's architecture, build, and configuration processes.
+
+---
+
+## Notes
+- Generated by Gremlin on 2026-04-22T00:34:00.735Z
+- Source: swarm/gatus.yaml
+- Review User Guide and Changelog sections