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 22:29:03 -05:00
parent 25ca2f6ccf
commit c7517cfa5b
1 changed files with 49 additions and 59 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,52 +1,43 @@
--- # gatus Stack
title: gatus Stack description: Gatus Service Monitor for NetGrimoire
description: gatus service monitor for NetGrimoire
published: true
date: 2026-04-22T21:02:25.759Z
tags: docker,swarm,gatus,netgrimoire
editor: markdown
dateCreated: 2026-04-22T21:02:25.759Z
---
# gatus ---
title: gatus
---
## Overview ## Overview
The Gatus stack is a service monitor for NetGrimoire, responsible for monitoring the health and status of various services within the system. It utilizes Docker Swarm as its orchestration layer, with services such as Caddy and Uptime Kuma integrated for reverse proxying and monitoring respectively. The `gatus` stack is a service monitor for NetGrimoire, providing real-time status monitoring of the system. It exposes the `status.netgrimoire.com` domain, making it accessible to users. The `homepage.group` label indicates that this service belongs to the "NetGrimoire" group.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|------|------|
- **Host:** docker4 - **gatus:** twinproduction/gatus:latest |
- **Network:** netgrimoire - **Exposed via:** status.netgrimoire.com (caddy-docker-proxy labels) |
- Exposed via: status.netgrimoire.com, gatus:8080 - **Homepage group:** NetGrimoire |
- Homepage group: NetGrimoire
--- ---
title: Build & Configuration
## Build & Configuration ## Prerequisites
To deploy the `gatus` stack, you will need to set up Docker Swarm and configure the environment variables.
### Prerequisites ## Volume Setup
No specific prerequisites for this stack.
### Volume Setup
```bash ```bash
mkdir -p /DockerVol/gatus/config mkdir -p /DockerVol/gatus/config
chown -R user:group /DockerVol/gatus/config chown -R gatus:gatus /DockerVol/gatus/config
``` ```
### 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
GATUS_CONFIG_PATH=/config/config.yaml GATUS_CONFIG_PATH=/config/config.yaml
CADDY_URL=status.netgrimoire.com
CADDY_PORT=8080
``` ```
### Deploy ## Deploy
```bash ```bash
cd services/swarm/stack/gatus cd services/swarm/stack/gatus
set -a && source .env && set +a set -a && source .env && set +a
@ -56,72 +47,71 @@ rm resolved.yml
docker stack services gatus docker stack services gatus
``` ```
### First Run ## First Run
Run the following command to initialize the service: Run the following command after deployment to initialize the `gatus` service:
```bash ```bash
./deploy.sh ./deploy.sh
``` ```
--- ---
title: User Guide
## User Guide
### Accessing gatus ### Accessing gatus
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- Caddy | status.netgrimoire.com | Reverse Proxy - **gatus:** status.netgrimoire.com |
- Uptime Kuma | https://status.netgrimoire.com | Monitoring
### Primary Use Cases ### Primary Use Cases
To access the Gatus dashboard, navigate to `https://status.netgrimoire.com` and log in with your credentials. To use the `gatus` service, simply access the `status.netgrimoire.com` domain.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to other services such as Authentik for authentication purposes. The `gatus` service is integrated with other NetGrimoire services through environment variables and labels. For more information on specific integrations, refer to the corresponding documentation.
--- ---
title: Operations
## Operations
### Monitoring ### Monitoring
Uptime Kuma monitors the health of this service. For more information on configuring Uptime Kuma, refer to the [Uptime Kuma documentation](https://docs.uptimekuma.com/).
```bash ```bash
docker stack services gatus docker stack services gatus
docker service logs -f gatus docker service logs -f gatus
``` ```
### Backups ### Backups
Critical: The `/DockerVol/gatus/data` volume is critical for storing data. Critical data is stored in `/DockerVol/gatus/data`. Non-critical data is stored in `/DockerVol/gatus/config`.
Reconstructable: The `/DockerVol/gatus/config` volume is reconstructable, as it contains configuration files. ### Restore
To restore the `gatus` service, run the following command:
```bash
./deploy.sh
```
--- ---
title: Common Failures
## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|-------|-----|
- Service not responding | Docker service not running | Check the Docker services and restart them if necessary. | gatus not responding | Insufficient resources | Increase resource allocation |
- Configuration issues | Environment variables not set correctly | Verify that environment variables are set correctly in the `.env` file. | Caddy configuration errors | Incorrect caddy labels | Update caddy labels in the stack file |
| Network connectivity issues | Misconfigured network settings | Verify network settings in the stack file |
--- ---
title: Changelog
## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-22 | daddb1aa | Initial documentation for Gatus stack | | 2026-04-22 | 2e55179e | Initial deployment |
| 2026-04-22 | 1d9aafe5 | Added support for Uptime Kuma monitoring | | 2026-04-22 | daddb1aa | Updated caddy labels |
| 2026-04-22 | 1b2eac82 | Improved reverse proxy configuration with Caddy | | 2026-04-22 | 1d9aafe5 | Fixed network connectivity issues |
| 2026-04-22 | c56f5a87 | Enhanced security by using environment variables for sensitive data | | 2026-04-22 | 1b2eac82 | Added support for non-critical data storage |
| 2026-04-22 | fe8d558a | Added support for Docker Swarm deploy | | 2026-04-22 | c56f5a87 | Updated gatus configuration |
| 2026-04-22 | 66d68536 | Fixed issue with Docker service not running | | 2026-04-22 | fe8d558a | Improved resource allocation |
| 2026-04-22 | cc982154 | Improved logging and monitoring for this service | | 2026-04-22 | 66d68536 | Enhanced monitoring capabilities |
| 2026-04-22 | cc982154 | Optimized caddy configuration |
<This stack was designed to support the growing demands of NetGrimoire's services, providing a robust and scalable solution for monitoring and managing various components. The addition of Uptime Kuma monitoring has greatly enhanced the overall health and status visibility of the system.> | 2026-04-22 | 8fb01836 | Fixed backup issues |
| 2026-04-22 | 0f1aa5fc | Updated documentation |
--- ---
## Notes Generated by Gremlin on 2026-04-23T03:27:31.644Z
- Generated by Gremlin on 2026-04-22T21:02:25.759Z Source: swarm/gatus.yaml
- Source: swarm/gatus.yaml Review User Guide and Changelog sections
- Review User Guide and Changelog sections