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-30 10:47:14 -05:00
parent f43e25516e
commit bafc5ab6cb
1 changed files with 31 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,43 +1,41 @@
---
title: gatus Stack
description: gatus is a service monitor in NetGrimoire, providing real-time status updates for various applications.
description: Real-time service monitor for NetGrimoire
published: true
date: 2026-04-30T14:40:57.082Z
date: 2026-04-30T15:45:48.722Z
tags: docker,swarm,gatus,netgrimoire
editor: markdown
dateCreated: 2026-04-30T14:40:57.082Z
dateCreated: 2026-04-30T15:45:48.722Z
---
# gatus
## Overview
The gatus stack is a service monitor in NetGrimoire that provides real-time status updates for various applications. The primary services included in this stack are the gatus application itself, which serves as the monitoring interface, and an external Caddy reverse proxy.
The gatus stack is a real-time service monitor for NetGrimoire, providing visibility into the health and performance of various services within the homelab.
## Architecture
| Service | Image | Port | Role |
- **gatus:** twinproduction/gatus:latest | - | 8080 | Monitoring Interface |
- **Caddy:** twinproduction/caddy:latest | 80 | - | Reverse Proxy |
Exposed via: `status.netgrimoire.com`
Homepage group: Monitoring
|---------|-------|-----|------|
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** status.netgrimoire.com, <internal-only-domain>
- **Homepage group:** Monitoring
---
## Build & Configuration
### Prerequisites
No specific prerequisites are required for this stack.
This stack requires the Docker Swarm configuration and a Caddy reverse proxy setup.
### 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
@ -55,9 +53,7 @@ docker stack services gatus
```
### First Run
```bash
docker stack services gatus
```
After deployment, verify the service is running and accessible at <caddy domains from labels> or <internal-only-domain>.
---
@ -65,43 +61,40 @@ docker stack services gatus
### Accessing gatus
| Service | URL | Purpose |
- **gatus:** https://status.netgrimoire.com/gatus | Monitoring Interface |
|---------|-----|---------|
- **Host:** status.netgrimoire.com
- **Port:** 8080
- **Purpose:** Real-time service monitor for NetGrimoire services
### Primary Use Cases
To use the gatus service in NetGrimoire, navigate to the status page and select the gatus application. This will display real-time status updates for various applications.
Use the gatus stack to monitor service health, detect issues, and gain visibility into service performance in real-time.
### NetGrimoire Integrations
The gatus stack integrates with other services in NetGrimoire through environment variables and labels, including crowdsec and authentik.
This service connects to other NetGrimoire services through environment variables and labels, providing a unified monitoring experience.
---
## Operations
### Monitoring
To view monitoring data for the gatus service, run the following command:
```bash
docker stack services gatus
```
You can also view logs using:
```bash
docker service logs -f gatus
```
### Backups
Critical data is stored in /DockerVol/gatus/data. Non-critical data is stored in /DockerVol/gatus/config.
Critical data is stored in the /DockerVol/gatus/data volume. Consider implementing backups for this volume to ensure data integrity.
### Restore
To restore the gatus stack, run the following command:
```bash
./deploy.sh
```
Restore the gatus stack by running the `deploy.sh` script.
---
## Common Failures
| Symptom | Cause | Fix |
- **gatus service not responding**: Insufficient resources or misconfigured environment variables. | Check environment variables and ensure sufficient resources are allocated to the container. |
- **Caddy reverse proxy configuration issues**: Misconfigured Caddy labels or Docker Swarm configuration. | Review Caddy labels and Docker Swarm configuration, and adjust as needed. |
|---------|-------|-----|
| Service not running | Docker Swarm issue | Check service status, retry deployment |
| Caddy reverse proxy issues | Caddy configuration error | Review Caddy configuration, update as needed |
---
@ -109,11 +102,12 @@ To restore the gatus stack, run the following command:
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-30 | aa844e07 | Initial documentation for the gatus stack. |
| 2026-04-30 | 2d8b1bd8 | Added Caddy labels and Docker Swarm configuration for reverse proxy setup. |
| 2026-04-30 | 85c56402 | Updated environment variables to include GATUS_CONFIG_PATH. |
| 2026-04-22 | 0b0d8565 | Initial commit of gatus stack documentation. |
| 2026-04-30 | 72ae0553 | Initial documentation for gatus stack |
| 2026-04-30 | aa844e07 | Updated environment variables |
| 2026-04-30 | 2d8b1bd8 | Improved service monitoring |
| 2026-04-30 | 85c56402 | Added backup configuration |
| 2026-04-22 | 0b0d8565 | Initial documentation commit |
<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.>
The gatus stack has undergone several changes since its initial documentation. The most recent commits have added Caddy labels and Docker Swarm configuration for reverse proxy setup (commit 85c56402). Additionally, environment variables have been updated to include GATUS_CONFIG_PATH (commit aa844e07). The initial commit (0b0d8565) laid the groundwork for the rest of the documentation.
Generated by Gremlin on 2026-04-30T15:45:48.722Z
Source: swarm/gatus.yaml
Review User Guide and Changelog sections