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-21 19:37:31 -05:00
parent 372b3f0c50
commit e6d0a9814b
1 changed files with 26 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,40 +1,37 @@
Frontmatter:
--- ---
title: gatus Stack title: gatus Stack
description: Gatus is a monitoring service for NetGrimoire. description: Service Monitor for NetGrimoire
published: true published: true
date: 2026-04-22T00:34:00.735Z date: 2026-04-22T00:36:29.547Z
tags: docker,swarm,gatus,netgrimoire tags: docker,swarm,gatus,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-22T00:34:00.735Z dateCreated: 2026-04-22T00:36:29.547Z
--- ---
# gatus # gatus
## Overview ## Overview
Gatus is a monitoring service for NetGrimoire, providing real-time insights into the performance and availability of the platform's services. The gatus stack is a NetGrimoire service monitor that provides real-time status updates for the Gatus application. It consists of the Gatus service, which runs as a Docker container on docker4, and exposes its status via Caddy's reverse proxy.
---
## 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 - **Exposed via:** `status.netgrimoire.com` (Caddy domain)
- **Homepage group:** NetGrimoire - **Homepage group:** NetGrimoire
---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
This service requires the `docker` and `caddy` software to be installed on the `znas` node. Ensure that the Docker environment is properly set up and configured.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/gatus/config mkdir -p /DockerVol/gatus/config
mkdir -p /DockerVol/gatus/data mkdir -p /DockerVol/gatus/data
chown -R gatus:gatus /DockerVol/gatus/ chown -R gatus:gatus /DockerVol/gatus
``` ```
### Environment Variables ### Environment Variables
@ -57,21 +54,22 @@ docker stack services gatus
``` ```
### First Run ### First Run
After the initial deployment, ensure that the `caddy` reverse proxy is configured correctly to forward requests to the `gatus` service. Perform the following steps after a successful deployment:
1. Verify that Caddy is running and exposing the Gatus service.
--- 2. Update the `kuma.*` labels to reflect the new service status.
## User Guide ## User Guide
### Accessing gatus ### Accessing gatus
| Service | URL | Purpose | | Service | URL | Purpose |
- **Gatus** | https://status.netgrimoire.com | Service Monitor | |---------|-----|---------|
- **Gatus:** https://status.netgrimoire.com (Caddy domain)
### Primary Use Cases ### Primary Use Cases
To use Gatus effectively, configure your services to report their performance and availability metrics to the `gatus` service. Use the Gatus service to monitor the status of the Gatus application in NetGrimoire.
### NetGrimoire Integrations ### NetGrimoire Integrations
Gatus integrates with other NetGrimoire services through environment variables and labels. Refer to the documentation for specific integration details. The gatus stack integrates with other NetGrimoire services, such as CrowdsSec and Authentik, through environment variables and labels.
--- ---
@ -80,11 +78,11 @@ Gatus integrates with other NetGrimoire services through environment variables a
### Monitoring ### Monitoring
```bash ```bash
docker stack services gatus docker stack services gatus
docker service logs -f gatus | grep kuma docker service logs -f gatus
``` ```
### Backups ### Backups
Critical data is stored in `/DockerVol/gatus/data`. Regular backups are recommended to ensure data integrity. Critical: `/DockerVol/gatus/data` is not backed up. Reconstructable: `/DockerVol/gatus/config`.
### Restore ### Restore
```bash ```bash
@ -95,10 +93,12 @@ cd services/swarm/stack/gatus
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|-------|-----|
| Service not responding | Insufficient network bandwidth | Increase network bandwidth | | Service not responding | Caddy not running | Restart Caddy service |
| Configuration errors | Misconfigured environment variables or labels | Review and correct configuration files | | Config issues | Invalid `config.yaml` file | Re-run deploy script |
| Network issues | Docker network not established | Run `docker network create netgrimoire` |
--- ---
@ -106,14 +106,15 @@ cd services/swarm/stack/gatus
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-21 | 3d8a5197 | Initial documentation and migration to swarm configuration | | 2026-04-21 | c6ba6d93 | Initial documentation and configuration |
| 2026-04-21 | 3d8a5197 | Added initial deploy script and first-run instructions |
<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.> <Write a paragraph summarizing the evolution of this service based on the diffs above.>
Gatus has undergone significant changes in its recent version, including a migration to swarm configuration. The latest documentation reflects these changes and provides a comprehensive overview of the service's architecture, build, and configuration processes. The gatus stack has been updated with initial configuration and deployment scripts, as well as first-run instructions for verifying Caddy exposure and updating kuma labels.
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-22T00:34:00.735Z - Generated by Gremlin on 2026-04-22T00:36:29.547Z
- Source: swarm/gatus.yaml - Source: swarm/gatus.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections