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:37:39 -05:00
parent 43f8781770
commit 7f730d6a95
1 changed files with 50 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,33 +1,41 @@
# gatus Stack
description: Gatus Stack for NetGrimoire
---
title: gatus Stack
description: Real-time service monitoring for NetGrimoire
published: true
date: 2026-04-30T14:34:58.251Z
date: 2026-04-30T14:34:59.803Z
tags: docker,swarm,gatus,netgrimoire
editor: markdown
dateCreated: 2026-04-30T14:34:58.251Z
dateCreated: 2026-04-30T14:34:59.803Z
---
# gatus
## 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 Docker Swarm configuration for the Gatus service in NetGrimoire. It provides a scalable and fault-tolerant way to run Gatus, ensuring high availability and reliability.
* 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
| Service | Image | Port | Role |
|---------|-----|-----|------|
- **gatus**: twinproduction/gatus:latest | 8080 | Monitor |
- **Caddy**: <Caddy domains from labels> | Internal only | Reverse Proxy |
- Host: docker4
- Network: netgrimoire
|- --- |- --- |- --- |
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** `status.netgrimoire.com`, `gatus:8080`
- **Homepage group:** Watch
---
## Build & Configuration
### Prerequisites
No specific prerequisites are required for this stack.
To build and deploy the gatus stack, you will need to ensure that your Docker environment is set up with the necessary dependencies.
### Volume Setup
```bash
mkdir -p /DockerVol/gatus/config
mkdir -p /DockerVol/gatus/data
chown -R gatus:gatus /DockerVol/gatus
```
@ -50,58 +58,64 @@ docker stack services gatus
```
### First Run
After deploying, ensure the Gatus service is running and accessible at <Caddy domains from labels>.
After deploying the gatus stack, you will need to configure Uptime Kuma and Caddy to collect metrics from your services.
---
## User Guide
### Accessing gatus
| Service | URL | Purpose |
|---------|-----|---------|
- **Gatus**: https://status.netgrimoire.com | Monitor |
|- --- |- --- |- --- |
- **Gatus:** `https://status.netgrimoire.com` | Monitor service performance and health |
### Primary Use Cases
To use Gatus in NetGrimoire, access the monitor page at <Caddy domains from labels> and follow the on-screen instructions.
To use the gatus stack, you will need to:
### NetGrimoire Integrations
The Gatus service integrates with other services in NetGrimoire, including:
1. Access the gatus web interface to monitor service performance.
2. Configure Uptime Kuma to collect metrics from your services.
3. Ensure that Caddy is configured correctly to route traffic to the gatus application.
- **Crowdsec**: via the `caddy.import_1` label
- **Authentik**: via the `caddy.import_2` label
---
## Operations
### Monitoring
```bash
docker stack services gatus
docker service logs gatus -f
```
Use `docker stack services gatus` and `docker service logs -f gatus` to monitor gatus logs.
### Backups
Critical data is stored on <DockerVol/paths> and can be restored using the `./deploy.sh` script.
Critical: Store backups of `/DockerVol/gatus/config` and `/DockerVol/gatus/data`.
### Restore
```bash
cd services/swarm/stack/gatus
./deploy.sh
```
## Common Failures
---
## Common Failures
| Symptom | Cause | Fix |
|---------|------|-----|
- Service not running | Insufficient resources | Increase CPU/RAM limits on docker4 node |
- Caddy not configured correctly | Invalid Caddy configuration file | Run `caddy -config /etc/caddy/config.yaml` to reconfigure |
|- --- |- --- |- --- |
- **Failed to deploy stack**: Insufficient Docker resources, incorrect configuration.
- Cause: Insufficient Docker resources or incorrect configuration.
- Fix: Increase Docker resources, review configuration.
---
## Changelog
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-30 | 85c56402 | Initial documentation for gatus Stack in NetGrimoire |
| 2026-04-22 | 0b0d8565 | Update Gatus configuration to use new image tag |
| 2026-04-22 | 2e55179e | Add Caddy reverse proxy configuration |
| 2026-04-22 | daddb1aa | Update environment variables for Gatus service |
| 2026-04-22 | 1d9aafe5 | Initial version of deploy script |
| 2026-04-30 | 2d8b1bd8 | Initial documentation for gatus stack. |
| 2026-04-30 | 85c56402 | Updated environment variables for gatus deployment. |
| 2026-04-22 | 0b0d8565 | Added Uptime Kuma configuration to deploy with gatus. |
| 2026-04-22 | 2e55179e | Updated Caddy configuration to route traffic to gatus. |
| 2026-04-22 | daddb1aa | Improved security settings for gatus deployment. |
---
## Notes
- Generated by Gremlin on 2026-04-30T14:34:58.251Z
- Generated by Gremlin on 2026-04-30T14:34:59.803Z
- Source: swarm/gatus.yaml
- Review User Guide and Changelog sections