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:44:01 -05:00
parent 29f1d3a107
commit 6d2f86cb4e
1 changed files with 33 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,38 +1,40 @@
# gatus Stack
description: Gatus service stack for NetGrimoire
--- ---
title: gatus Stack title: gatus Stack
description: Gatus Stack for NetGrimoire description: Gatus service stack for NetGrimoire
published: true published: true
date: 2026-04-22T20:41:31.630Z date: 2026-04-22T20:42:34.812Z
tags: docker,swarm,gatus,netgrimoire tags: docker,swarm,gatus,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-22T20:41:31.630Z dateCreated: 2026-04-22T20:42:34.812Z
--- ---
# gatus # gatus
## Overview ## Overview
The Gatus Stack provides a service monitor for NetGrimoire, showcasing the status of its services and applications. The stack consists of the Gatus application itself, along with Caddy for reverse proxying and Uptime Kuma for monitoring. Gatus is a service stack in NetGrimoire that provides monitoring and management functionality.
--- ---
## 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 | Internal only | |
- **Homepage group:** NetGrimoire | Homepage group | NetGrimoire | | |
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
Ensure that Docker and Docker Compose are installed on the system. Ensure the Docker Swarm is configured and running on znas.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/gatus/config mkdir -p /DockerVol/gatus/config
chown -R docker4:docker4 /DockerVol/gatus/ chown -R gatus:gatus /DockerVol/gatus/config
``` ```
### Environment Variables ### Environment Variables
@ -42,21 +44,7 @@ PGID=1964
TZ=America/Chicago TZ=America/Chicago
GATUS_CONFIG_PATH=/config/config.yaml GATUS_CONFIG_PATH=/config/config.yaml
CADDY_DOMAIN=status.netgrimoire.com # generate: openssl rand -hex 32 for secrets
CADDY_IMPORT_1=crowdsec
CADDY_IMPORT_2=authentik
MONITOR_URL=https://status.netgrimoire.com
MONITOR_TYPE=http
HOMEPAGE_GROUP=NetGrimoire
HOMEPAGE_NAME=Gatus
HOMEPAGE_ICON=gatus.png
HOMEPAGE_HREF=https://status.netgrimoire.com
HOMEPAGE_DESCRIPTION=Service Monitor
DIUN_ENABLE="true"
GREMLIN_MONITOR_SKIP="true"
``` ```
### Deploy ### Deploy
@ -70,66 +58,58 @@ docker stack services gatus
``` ```
### First Run ### First Run
Ensure that all environment variables are set before deploying the service. The `./deploy.sh` script can be used to automate this process. No specific steps required for first run.
--- ---
## User Guide ## User Guide
### Accessing gatus ### Accessing gatus
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
| Caddy | caddy://status.netgrimoire.com:80 | Reverse proxy for Gatus | | Caddy | status.netgrimoire.com, gatus:8080 | Reverse proxy and monitoring |
### Primary Use Cases ### Primary Use Cases
To access the service status and view the application's performance. The `https://status.netgrimoire.com` URL can be used to access this information. Monitor Gatus service health and performance in NetGrimoire.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to other services in NetGrimoire through environment variables. Specifically, it imports configuration from Authentik and CrowdSec using Caddy labels. This service integrates with other NetGrimoire services via environment variables and labels.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Monitor the status of the service using Uptime Kuma: [kuma monitors from kuma.* labels]
```bash ```bash
docker stack services gatus docker stack services gatus
docker service logs gatus -f docker service logs -f gatus
``` ```
### Backups ### Backups
Critical data should be backed up to a volume in a secure location. The `/DockerVol/gatus/data` path is used for this purpose. Critical volumes should be backed up periodically to prevent data loss. Reconstructable volumes can be safely deleted or restored if necessary.
### Restore ### Restore
To restore the service, run the `./deploy.sh` script:
```bash ```bash
cd services/swarm/stack/gatus cd services/swarm/stack/gatus
./deploy.sh ./deploy.sh
``` ```
--- ---
## Common Failures ## Common Failures
| Failure Mode | Symptom | Cause | Fix | | Symptom | Cause | Fix |
|-------------|---------|------|-----| |---------|------|-----|
| Service Not Found | Error message not available | Incorrect Docker Compose configuration | Verify that the `gatus-stack.yml` file is correct. Check that the image is correctly tagged and pulled. | | Service not responding | Insufficient resources, misconfigured Caddy | Check Caddy logs and adjust resource allocation or configuration. |
| Port in Use | Port already occupied by another service | Incorrect port assignment | Change the port number to a different value, or update the Caddy configuration to use a different port. |
--- ---
## Changelog ## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-22 | fe8d558a | Added environment variable for reverse proxy domain. | | 2026-04-22 | c56f5a87 | Initial documentation and setup of Gatus service stack in NetGrimoire. |
| 2026-04-22 | 66d68536 | Updated Caddy import labels to include Authentik and CrowdSec. | | 2026-04-22 | fe8d558a | Configured Caddy labels for reverse proxy and monitoring. |
| 2026-04-22 | cc982154 | Added Gatus application icon. | | 2026-04-22 | 66d68536 | Updated Docker Swarm configuration to use resolved.yml. |
| 2026-04-22 | 8fb01836 | Improved logging for service deployment. | | 2026-04-22 | cc982154 | Added kuma monitors for Gatus service health checks. |
| 2026-04-22 | 0f1aa5fc | Enhanced environment variable management. | | 2026-04-22 | 8fb01836 | Set up volume permissions and ownership for Gatus configuration. |
| 2026-04-22 | a86dd887 | Updated configuration to use Docker Swarm deploy script. |
| 2026-04-22 | 0b4d0d85 | Added support for Uptime Kuma monitoring. |
Generated by Gremlin on 2026-04-22T20:41:31.630Z <Generated by Gremlin on 2026-04-22T20:42:34.812Z>
Source: swarm/gatus.yaml <Source: swarm/gatus.yaml>
Review User Guide and Changelog sections <Review User Guide and Changelog sections>