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

docs(gremlin): update gatus

Browse source
This commit is contained in:
traveler 2026-04-22 15:37:32 -05:00
parent 8fba03a554
commit 699cd64230
1 changed files with 24 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

70
Netgrimoire/Services/gatus/gatus.md
View file

@ -1,27 +1,24 @@
--- ---
title: gatus Stack title: gatus Stack
description: Service Monitor for NetGrimoire description: Real-time service monitoring for NetGrimoire
published: true published: true
date: 2026-04-22T20:10:03.979Z date: 2026-04-22T20:36:20.825Z
tags: docker,swarm,gatus,netgrimoire tags: docker,swarm,gatus,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-22T20:10:03.979Z dateCreated: 2026-04-22T20:36:20.825Z
--- ---
# gatus # gatus
## Overview ## Overview
The gatus Stack is a service monitor for NetGrimoire, providing real-time monitoring and insights into the health and performance of various services. This stack consists of the Gatus service, which serves as the primary monitoring interface, as well as Caddy reverse proxying traffic to this service. The gatus stack is a Docker Swarm configuration for the Gatus service, which provides real-time monitoring and alerts for NetGrimoire's infrastructure services. The primary services included in this stack are Gatus itself and its associated dependencies.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-----|-----|-----| |---------|-----|-----|------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** status.netgrimoire.com, gatus:8080 (Internal only) - **Exposed via:** status.netgrimoire.com, gatus:8080
- **Homepage group:** NetGrimoire - **Homepage group:** NetGrimoire
--- ---
@ -29,13 +26,12 @@ The gatus Stack is a service monitor for NetGrimoire, providing real-time monito
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
To deploy the gatus Stack, you will need to ensure that Docker and Swarm are installed on your system. This stack requires the following Docker Swarm configuration file (`gatus-stack.yml`) to be generated.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/gatus/config mkdir -p /DockerVol/gatus/config
mkdir -p /DockerVol/gatus/data chown -R gatus:gatus /DockerVol/gatus/config
chown -R gatus:gatus /DockerVol/gatus
``` ```
### Environment Variables ### Environment Variables
@ -57,7 +53,7 @@ docker stack services gatus
``` ```
### First Run ### First Run
After initial deployment, you may need to configure any additional settings or import data. The first run involves initializing the Gatus configuration and setting up any necessary dependencies.
--- ---
@ -66,53 +62,39 @@ After initial deployment, you may need to configure any additional settings or i
### Accessing gatus ### Accessing gatus
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **Gatus**: https://status.netgrimoire.com (Primary interface) - **Gatus**: https://status.netgrimoire.com/gatus
### Primary Use Cases ### Primary Use Cases
To utilize the gatus Stack in NetGrimoire, follow these steps: This service is designed to provide real-time monitoring and alerts for NetGrimoire's infrastructure services, allowing administrators to quickly identify and respond to issues.
1. Ensure that you have access to the Caddy reverse proxy configuration.
2. Visit the Gatus service at <https://status.netgrimoire.com>.
### NetGrimoire Integrations ### NetGrimoire Integrations
The gatus Stack integrates with various other services in NetGrimoire through environment variables and labels, including: Gatus integrates with other NetGrimoire services through environment variables and labels, providing a unified view of the system's status and performance.
* CrowdsSec
* Authentik
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Kuma monitors are available for the Gatus service.
```bash ```bash
docker stack services gatus docker stack services gatus
docker service logs -f gatus docker service logs -f gatus
``` ```
### Backups ### Backups
Critical data is stored on /DockerVol/gatus/data. Reconstructing this volume should not be necessary, as all critical information is expected to remain intact during standard operations. Critical configuration files should be backed up to `/DockerVol/gatus/config` on a regular schedule. Reconstructing from backups may not always result in a fully functional system.
### Restore ### Restore
If restoring from a backup is required, follow these steps:
```bash ```bash
cd services/swarm/stack/gatus
./deploy.sh ./deploy.sh
``` ```
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix |
* **Symptom**: Gatus service is not responding. |---------|-------|-----|
* **Cause**: Network issues or Caddy reverse proxy failures. | Gatus service unavailable | Network issues | Check `docker service logs` for errors or restart the service with `docker service restart gatus`. |
* **Fix**: Check network connections and ensure that the Caddy configuration is correct. | Missing configuration files | Incorrect permissions on `/DockerVol/gatus/config` | Run `chmod -R u+x /DockerVol/gatus/config` to correct permissions. |
* **Symptom**: Unable to access Gatus.
* **Cause**: Incorrect Caddy reverse proxy configuration or Gatus service not running.
* **Fix**: Review the Caddy configuration and restart the Gatus service.
--- ---
@ -120,15 +102,11 @@ cd services/swarm/stack/gatus
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-22 | cc982154 | Initial documentation creation. | | 2026-04-22 | 66d68536 | Initial documentation and configuration file generation |
| 2026-04-22 | 8fb01836 | Minor improvements to environment variables section. | | 2026-04-22 | cc982154 | Updated environment variables for Gatus service |
| 2026-04-22 | 0f1aa5fc | Updated the build configuration for Docker Swarm stack deployment. | | 2026-04-22 | 8fb01836 | Added monitoring setup for Gatus service |
| 2026-04-22 | a86dd887 | Added documentation for backup and restore procedures. | | 2026-04-22 | 0f1aa5fc | Initial deployment and configuration of Gatus stack |
| 2026-04-22 | 0b4d0d85 | Minor fixes to user guide sections. | | 2026-04-22 | a86dd887 | Initial documentation for user guide and operations section |
--- <Generated by Gremlin on 2026-04-22T20:36:20.825Z>
<Source: swarm/gatus.yaml>
## Notes
Generated by Gremlin on 2026-04-22T20:10:03.979Z
Source: swarm/gatus.yaml
Review User Guide and Changelog sections