---
title: gatus Stack
description: Service Monitor for NetGrimoire
published: true
date: 2026-04-23T03:48:35.160Z
tags: docker,swarm,gatus,netgrimoire
editor: markdown
dateCreated: 2026-04-23T03:48:35.160Z
---

# gatus

## Overview
The gatus stack is a service monitor for NetGrimoire, providing real-time monitoring and reporting of its services. It consists of the Gatus container, which collects metrics and logs from various services in NetGrimoire.

## Architecture
| Service | Image | Port | Role |
|---------|-------|------|------|
- **Host:** docker4
- **Network:** netgrimoire
- Exposed via: status.netgrimoire.com
- Homepage group: NetGrimoire

---

## Build & Configuration

### Prerequisites
To build and deploy the gatus stack, you will need to have Docker Swarm installed on your system.

### Volume Setup
```bash
mkdir -p /DockerVol/gatus/config
chown -R gatus:gatus /DockerVol/gatus/config
```

### Environment Variables
```bash
PUID=1964
PGID=1964
TZ=America/Chicago
GATUS_CONFIG_PATH=/config/config.yaml
```

### Deploy
```bash
cd services/swarm/stack/gatus
set -a && source .env && set +a
docker stack config --compose-file gatus-stack.yml > resolved.yml
docker stack deploy --compose-file resolved.yml gatus
rm resolved.yml
docker stack services gatus
```

### First Run
After deployment, you may need to run the following command to initialize the database:
```bash
./deploy.sh
```

---

## User Guide

### Accessing gatus
| Service | URL | Purpose |
|---------|-----|---------|
- status.netgrimoire.com (Internal only)

### Primary Use Cases
To access the Gatus service, navigate to the provided URL. You can use this service to monitor the performance and health of your NetGrimoire services.

### NetGrimoire Integrations
The gatus stack integrates with other services in NetGrimoire through environment variables and labels. For more information on these integrations, please refer to the Changelog section below.

---

## Operations

### Monitoring
Kuma monitors from kuma.* labels:
```bash
docker stack services gatus
<docker service logs commands>
```

### Backups
Critical vs reconstructable /DockerVol/ paths: The gatus stack uses a volume mount for data storage. In the event of a failure, it is recommended to back up this data before attempting to recover.

### Restore
```bash
cd services/swarm/stack/gatus
./deploy.sh
```

---

## Common Failures
| Symptom | Cause | Fix |
|---------|-------|-----|
- Service not responding | Insufficient CPU resources | Increase CPU resource allocation for Gatus container |
- Logs not being collected | Incorrect log configuration | Update log configuration to match expected format |
- Deployment failing | Invalid environment variables | Review and correct environment variable values |

---

## Changelog

| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-22 | 0b0d8565 | Initial deployment of gatus stack with Docker Swarm configuration |
| 2026-04-22 | 2e55179e | Updated Gatus image to latest version |
| 2026-04-22 | daddb1aa | Added environment variable for logging configuration |
| 2026-04-22 | 1d9aafe5 | Improved deployment scripts for easier maintenance |
| 2026-04-22 | 1b2eac82 | Optimized performance by reducing unnecessary dependencies |

<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
- Generated by Gremlin on 2026-04-23T03:48:35.160Z
- Source: swarm/gatus.yaml
- Review User Guide and Changelog sections