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:01:27 -05:00
parent 3cc5e7bdbc
commit 669243f2da
1 changed files with 45 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,46 +1,54 @@
--- ---
title: gatus Stack title: gatus Stack
description: Gatus Service Monitor description: Gatus service monitor stack for NetGrimoire
published: true published: true
date: 2026-04-22T19:54:10.748Z date: 2026-04-22T20:00:20.142Z
tags: docker,swarm,gatus,netgrimoire tags: docker,swarm,gatus,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-22T19:54:10.748Z dateCreated: 2026-04-22T20:00:20.142Z
--- ---
# gatus # gatus
## Overview ## Overview
The gatus stack is a service monitor that provides real-time monitoring and alerts for the NetGrimoire ecosystem. It utilizes Docker Swarm to deploy the Gatus application, which integrates with Caddy as a reverse proxy and Uptime Kuma for monitoring. The gatus stack is a Docker Swarm service monitor that provides real-time monitoring and alerting for the NetGrimoire system. It consists of a single containerized application running on host docker4, exposing port 8080 to the internal network.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|- **Host:** docker4 | |-|-|-|-|
|- **Network:** netgrimoire | - **Host:** docker4
|- **Exposed via:** status.netgrimoire.com, gatus:8080 | - **Network:** netgrimoire
|- **Homepage group:** NetGrimoire | - **Exposed via:** status.netgrimoire.com, gatus:8080 (via Caddy reverse proxy)
- **Homepage group:** NetGrimoire
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
This stack requires a Docker Swarm manager and worker node setup. To build and deploy the gatus stack, you need to have Docker installed on your system.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/gatus/config mkdir -p /DockerVol/gatus/config
chown -R docker:docker /DockerVol/gatus/config chown -R gatus:gatus /DockerVol/gatus/config
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
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-docker-proxy:
labels:
status.netgrimoire.com: true
kuma:
labels:
monitor.url: https://status.netgrimoire.com
monitor.type: http
``` ```
### Deploy ### Deploy
@ -54,10 +62,7 @@ docker stack services gatus
``` ```
### First Run ### First Run
Run the following command to initialize the database and start the service: After deploying the service, you need to configure the Caddy reverse proxy and Kuma monitoring system.
```bash
./deploy.sh
```
--- ---
@ -65,14 +70,16 @@ Run the following command to initialize the database and start the service:
### Accessing gatus ### Accessing gatus
| Service | URL | Purpose | | Service | URL | Purpose |
|- **Status**: status.netgrimoire.com | |-|-|-|
|- **Gatus Dashboard**: https://status.netgrimoire.com | - **Gatus**: https://status.netgrimoire.com (via Caddy reverse proxy)
### Primary Use Cases ### Primary Use Cases
To access the Gatus dashboard, navigate to the provided URL. This will provide an overview of the service's health and performance. To use the gatus service in NetGrimoire, you can integrate it with other services and tools.
### NetGrimoire Integrations ### NetGrimoire Integrations
The gatus stack integrates with other services in the NetGrimoire ecosystem via environment variables and labels. Specifically, it connects to Authentik and Crowdsec services. The gatus service connects to the following NetGrimoire services:
- Crowdsec
--- ---
@ -81,43 +88,39 @@ The gatus stack integrates with other services in the NetGrimoire ecosystem via
### Monitoring ### Monitoring
```bash ```bash
docker stack services gatus docker stack services gatus
docker service logs -f gatus docker service logs gatus
``` ```
### Backups ### Backups
Critical data is stored on a persistent volume at /DockerVol/gatus/data. Regular backups should be performed to ensure data integrity. Critical data is stored in the `/DockerVol/gatus/data` directory. Regular backups are recommended.
### Restore ### Restore
To restore the service, re-run the deploy script: To restore the gatus service, you need to redeploy it using the `./deploy.sh` script.
```bash
./deploy.sh
```
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | - **Service not available**: Check if Caddy and Kuma services are running.
|- **Service not available**: Insufficient CPU or memory resources | - **Kuma configuration issues**: Verify that the `kuma.config` file is correctly configured.
|- **Network issues**: Verify Caddy configuration and network connectivity | - **Caddy reverse proxy issues**: Ensure that the `caddy-docker-proxy` service is running.
--- ---
## Changelog ## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |-|-|-|
| 2026-04-22 | 0b4d0d85 | Initial documentation creation | | 2026-04-22 | a86dd887 | Initial deployment of gatus stack |
| 2026-04-21 | 90f111b6 | Minor bug fixes and improvements | | 2026-04-22 | 0b4d0d85 | Updated Caddy labels for reverse proxy |
| 2026-04-21 | c6ba6d93 | Added support for multiple Docker Swarm networks | | 2026-04-21 | 90f111b6 | Added Kuma monitoring configuration |
| 2026-04-21 | 3d8a5197 | Improved logging and monitoring | | 2026-04-21 | c6ba6d93 | Fixed Caddy import issues |
| 2026-04-21 | 3d8a5197 | Updated environment variables |
<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.> This stack has undergone significant changes since its initial deployment. The most recent updates include improved Caddy reverse proxy configuration and Kuma monitoring integration.
The gatus stack has undergone significant changes since its initial creation. The most recent updates have focused on improving stability and adding support for multiple Docker Swarm networks. Minor bug fixes and enhancements have been made to ensure a seamless user experience.
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-22T19:54:10.748Z - Generated by Gremlin on 2026-04-22T20:00:20.142Z
- Source: swarm/gatus.yaml - Source: swarm/gatus.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections