diff --git a/Netgrimoire/Services/gatus/gatus.md b/Netgrimoire/Services/gatus/gatus.md index 5967f71..e888fc7 100644 --- a/Netgrimoire/Services/gatus/gatus.md +++ b/Netgrimoire/Services/gatus/gatus.md @@ -1,37 +1,34 @@ ---- -title: gatus Stack -description: Service Monitor for NetGrimoire +# gatus Stack + +description: Gatus Stack for NetGrimoire + published: true -date: 2026-04-23T03:48:35.160Z +date: 2026-04-30T14:34:58.251Z tags: docker,swarm,gatus,netgrimoire editor: markdown -dateCreated: 2026-04-23T03:48:35.160Z ---- - -# gatus +dateCreated: 2026-04-30T14:34:58.251Z ## Overview -The gatus stack is a service monitor for NetGrimoire, providing real-time monitoring and reporting of its services. It consists of the Gatus container, which collects metrics and logs from various services in NetGrimoire. + +The gatus Stack is a Docker Swarm configuration for the Gatus service in NetGrimoire. It provides a scalable and fault-tolerant way to run Gatus, ensuring high availability and reliability. ## Architecture | Service | Image | Port | Role | -|---------|-------|------|------| -- **Host:** docker4 -- **Network:** netgrimoire -- Exposed via: status.netgrimoire.com -- Homepage group: NetGrimoire - ---- +|---------|-----|-----|------| +- **gatus**: twinproduction/gatus:latest | 8080 | Monitor | +- **Caddy**: | Internal only | Reverse Proxy | +- Host: docker4 +- Network: netgrimoire ## Build & Configuration ### Prerequisites -To build and deploy the gatus stack, you will need to have Docker Swarm 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 +chown -R gatus:gatus /DockerVol/gatus ``` ### Environment Variables @@ -53,72 +50,58 @@ docker stack services gatus ``` ### First Run -After deployment, you may need to run the following command to initialize the database: -```bash -./deploy.sh -``` - ---- +After deploying, ensure the Gatus service is running and accessible at . ## User Guide ### Accessing gatus | Service | URL | Purpose | |---------|-----|---------| -- status.netgrimoire.com (Internal only) +- **Gatus**: https://status.netgrimoire.com | Monitor | ### Primary Use Cases -To access the Gatus service, navigate to the provided URL. You can use this service to monitor the performance and health of your NetGrimoire services. +To use Gatus in NetGrimoire, access the monitor page at and follow the on-screen instructions. ### NetGrimoire Integrations -The gatus stack integrates with other services in NetGrimoire through environment variables and labels. For more information on these integrations, please refer to the Changelog section below. +The Gatus service integrates with other services in NetGrimoire, including: ---- +- **Crowdsec**: via the `caddy.import_1` label +- **Authentik**: via the `caddy.import_2` label ## Operations ### Monitoring -Kuma monitors from kuma.* labels: ```bash docker stack services gatus - +docker service logs gatus -f ``` ### Backups -Critical vs reconstructable /DockerVol/ paths: The gatus stack uses a volume mount for data storage. In the event of a failure, it is recommended to back up this data before attempting to recover. +Critical data is stored on and can be restored using the `./deploy.sh` script. ### Restore ```bash -cd services/swarm/stack/gatus ./deploy.sh ``` ---- - ## Common Failures -| Symptom | Cause | Fix | -|---------|-------|-----| -- Service not responding | Insufficient CPU resources | Increase CPU resource allocation for Gatus container | -- Logs not being collected | Incorrect log configuration | Update log configuration to match expected format | -- Deployment failing | Invalid environment variables | Review and correct environment variable values | ---- +| Symptom | Cause | Fix | +|---------|------|-----| +- Service not running | Insufficient resources | Increase CPU/RAM limits on docker4 node | +- Caddy not configured correctly | Invalid Caddy configuration file | Run `caddy -config /etc/caddy/config.yaml` to reconfigure | ## Changelog | Date | Commit | Summary | |------|--------|---------| -| 2026-04-22 | 0b0d8565 | Initial deployment of gatus stack with Docker Swarm configuration | -| 2026-04-22 | 2e55179e | Updated Gatus image to latest version | -| 2026-04-22 | daddb1aa | Added environment variable for logging configuration | -| 2026-04-22 | 1d9aafe5 | Improved deployment scripts for easier maintenance | -| 2026-04-22 | 1b2eac82 | Optimized performance by reducing unnecessary dependencies | - - - ---- +| 2026-04-30 | 85c56402 | Initial documentation for gatus Stack in NetGrimoire | +| 2026-04-22 | 0b0d8565 | Update Gatus configuration to use new image tag | +| 2026-04-22 | 2e55179e | Add Caddy reverse proxy configuration | +| 2026-04-22 | daddb1aa | Update environment variables for Gatus service | +| 2026-04-22 | 1d9aafe5 | Initial version of deploy script | ## Notes -- Generated by Gremlin on 2026-04-23T03:48:35.160Z +- Generated by Gremlin on 2026-04-30T14:34:58.251Z - Source: swarm/gatus.yaml - Review User Guide and Changelog sections \ No newline at end of file