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 09:42:25 -05:00
parent 7f730d6a95
commit ebca8a00c7
1 changed files with 37 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,36 +1,33 @@
--- ---
title: gatus Stack title: gatus Stack
description: Real-time service monitoring for NetGrimoire description: gatus is a service monitor in NetGrimoire, providing real-time status updates for various applications.
published: true published: true
date: 2026-04-30T14:34:59.803Z date: 2026-04-30T14:40:57.082Z
tags: docker,swarm,gatus,netgrimoire tags: docker,swarm,gatus,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T14:34:59.803Z dateCreated: 2026-04-30T14:40:57.082Z
--- ---
# gatus # gatus
## Overview ## Overview
The gatus stack is a real-time service monitoring solution for NetGrimoire, providing visibility into the performance and health of various services. The primary services in this stack are: 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.
* Gatus: a web-based monitoring platform that provides detailed information about service performance, uptime, and latency.
* Caddy: an edge server proxy that handles incoming traffic and routes it to the gatus application.
* Uptime Kuma: a monitoring agent that collects metrics from services and sends them to the gatus application.
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|- --- |- --- |- --- | - **gatus:** twinproduction/gatus:latest | - | 8080 | Monitoring Interface |
- **Host:** docker4 - **Caddy:** twinproduction/caddy:latest | 80 | - | Reverse Proxy |
- **Network:** netgrimoire
- **Exposed via:** `status.netgrimoire.com`, `gatus:8080` Exposed via: `status.netgrimoire.com`
- **Homepage group:** Watch
Homepage group: Monitoring
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
To build and deploy the gatus stack, you will need to ensure that your Docker environment is set up with the necessary dependencies. No specific prerequisites are required for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
@ -58,7 +55,9 @@ docker stack services gatus
``` ```
### First Run ### First Run
After deploying the gatus stack, you will need to configure Uptime Kuma and Caddy to collect metrics from your services. ```bash
docker stack services gatus
```
--- ---
@ -66,29 +65,34 @@ After deploying the gatus stack, you will need to configure Uptime Kuma and Cadd
### Accessing gatus ### Accessing gatus
| Service | URL | Purpose | | Service | URL | Purpose |
|- --- |- --- |- --- | - **gatus:** https://status.netgrimoire.com/gatus | Monitoring Interface |
- **Gatus:** `https://status.netgrimoire.com` | Monitor service performance and health |
### Primary Use Cases ### Primary Use Cases
To use the gatus stack, you will need to: 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.
1. Access the gatus web interface to monitor service performance. ### NetGrimoire Integrations
2. Configure Uptime Kuma to collect metrics from your services. The gatus stack integrates with other services in NetGrimoire through environment variables and labels, including crowdsec and authentik.
3. Ensure that Caddy is configured correctly to route traffic to the gatus application.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Use `docker stack services gatus` and `docker service logs -f gatus` to monitor gatus logs. 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 ### Backups
Critical: Store backups of `/DockerVol/gatus/config` and `/DockerVol/gatus/data`. Critical data is stored in /DockerVol/gatus/data. Non-critical data is stored in /DockerVol/gatus/config.
### Restore ### Restore
To restore the gatus stack, run the following command:
```bash ```bash
cd services/swarm/stack/gatus
./deploy.sh ./deploy.sh
``` ```
@ -96,10 +100,8 @@ cd services/swarm/stack/gatus
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | 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. |
- **Failed to deploy stack**: Insufficient Docker resources, incorrect configuration. - **Caddy reverse proxy configuration issues**: Misconfigured Caddy labels or Docker Swarm configuration. | Review Caddy labels and Docker Swarm configuration, and adjust as needed. |
- Cause: Insufficient Docker resources or incorrect configuration.
- Fix: Increase Docker resources, review configuration.
--- ---
@ -107,15 +109,11 @@ cd services/swarm/stack/gatus
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | 2d8b1bd8 | Initial documentation for gatus stack. | | 2026-04-30 | aa844e07 | Initial documentation for the gatus stack. |
| 2026-04-30 | 85c56402 | Updated environment variables for gatus deployment. | | 2026-04-30 | 2d8b1bd8 | Added Caddy labels and Docker Swarm configuration for reverse proxy setup. |
| 2026-04-22 | 0b0d8565 | Added Uptime Kuma configuration to deploy with gatus. | | 2026-04-30 | 85c56402 | Updated environment variables to include GATUS_CONFIG_PATH. |
| 2026-04-22 | 2e55179e | Updated Caddy configuration to route traffic to gatus. | | 2026-04-22 | 0b0d8565 | Initial commit of gatus stack documentation. |
| 2026-04-22 | daddb1aa | Improved security settings for gatus deployment. |
--- <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.>
## Notes 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-30T14:34:59.803Z
- Source: swarm/gatus.yaml
- Review User Guide and Changelog sections