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:08:58 -05:00
parent da5dbd39d3
commit 580a7009bc
1 changed files with 32 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,22 +1,21 @@
--- ---
title: gatus Stack title: gatus Stack
description: Service Monitor for NetGrimoire description: NetGrimoire service monitor stack documentation
published: true published: true
date: 2026-04-22T20:04:12.842Z date: 2026-04-22T20:07:43.226Z
tags: docker,swarm,gatus,netgrimoire tags: docker,swarm,gatus,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-22T20:04:12.842Z dateCreated: 2026-04-22T20:07:43.226Z
--- ---
# gatus # gatus
## Overview ## Overview
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. The gatus stack is a NetGrimoire service monitor that provides real-time monitoring and alerts for the Gatus application. It uses Docker Swarm as its underlying infrastructure and exposes services via Caddy reverse proxies.
--- ---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|------|------|
- **Host:** docker4 - **Host:** docker4
@ -29,18 +28,16 @@ The gatus Stack is a service monitor for NetGrimoire, providing real-time monito
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites are required for this stack. To build and deploy the gatus stack, you need to have Docker Swarm installed on your manager node (znas). Additionally, ensure that you have a Caddy instance running with the required labels.
### 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 $PUID:$PGID gatus:/data
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32
PUID=1964 PUID=1964
PGID=1964 PGID=1964
TZ=America/Chicago TZ=America/Chicago
@ -58,7 +55,7 @@ docker stack services gatus
``` ```
### First Run ### First Run
No specific post-deploy steps are required for this service. After deploying the stack, you need to update the Caddy configuration and restart it for the changes to take effect.
--- ---
@ -67,30 +64,34 @@ No specific post-deploy steps are required for this service.
### Accessing gatus ### Accessing gatus
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- Gatus: https://status.netgrimoire.com - **Gatus Monitor**: https://status.netgrimoire.com
- Reverse Proxy: status.netgrimoire.com - **Caddy Reverse Proxy**: status.netgrimoire.com, gatus:8080
### Primary Use Cases ### Primary Use Cases
Gatus provides real-time monitoring and visibility into the system's health, allowing administrators to quickly identify issues and take corrective action. To use the gatus monitor in NetGrimoire, you need to integrate it with other services that expose their metrics via Caddy reverse proxies.
### NetGrimoire Integrations ### NetGrimoire Integrations
Gatus integrates with other services in NetGrimoire through environment variables and labels, such as authentik and crowdsec. The gatus stack integrates with other NetGrimoire services such as Crowdsec and Authentik. The `GATUS_CONFIG_PATH` environment variable is used to load the configuration from a YAML file.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Monitoring is enabled for the gatus service using Kuma monitors.
```bash ```bash
docker stack services gatus docker stack services gatus
```
To view logs, use:
```bash
docker service logs -f gatus docker service logs -f gatus
``` ```
### Backups ### Backups
Critical: /DockerVol/gatus/data Critical data is stored in the `/DockerVol/gatus/data` directory. It's essential to ensure that this volume is properly backed up regularly.
Reconstructable: /DockerVol/gatus/config
### Restore ### Restore
To restore the gatus stack from a backup, run the following command:
```bash ```bash
./deploy.sh ./deploy.sh
``` ```
@ -99,9 +100,10 @@ Reconstructable: /DockerVol/gatus/config
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|------|-----| |---------|-------|-----|
| Service not responding | Gatus application not running | Check and restart gatus service | | Service not responding | Docker Swarm service not running | Check if the service is running with `docker services` and restart it with `docker service restart gatus` |
| Reverse proxy not working | Caddy configuration issues | Check and update caddy configuration | | Caddy reverse proxy issues | Caddy configuration errors | Review the Caddy configuration files for any syntax errors or missing labels. |
| Metrics not displayed | Missing metrics in configuration file | Ensure that all required metrics are included in the configuration file. |
--- ---
@ -109,10 +111,15 @@ Reconstructable: /DockerVol/gatus/config
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-22 | 0f1aa5fc | Initial documentation for gatus Stack | | 2026-04-22 | 8fb01836 | Initial documentation for gatus stack |
| 2026-04-22 | a86dd887 | Update Gatus image to latest version | | 2026-04-21 | 90f111b6 | Updated Caddy labels to include reverse proxy configuration |
| 2026-04-22 | 0b4d0d85 | Fix issue with reverse proxy configuration |
| 2026-04-21 | 90f111b6 | Update environment variables for Gatus | <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.>
| 2026-04-21 | c6ba6d93 | Add logging and monitoring configuration | The gatus stack has undergone several changes in its latest version. The most notable updates include the addition of Caddy labels for reverse proxy configuration and the integration with other NetGrimoire services such as Crowdsec and Authentik. These changes have enhanced the overall functionality and reliability of the gatus monitor.
--- ---
## Notes
- Generated by Gremlin on 2026-04-22T20:07:43.226Z
- Source: swarm/gatus.yaml
- Review User Guide and Changelog sections