traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update diun

Browse source
This commit is contained in:
traveler 2026-04-07 12:55:29 -05:00
parent c28e59596c
commit 020c296b42
1 changed files with 48 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

96
Netgrimoire/Services/diun/diun.md
View file

@ -1,47 +1,49 @@
# diun Stack
description: Diun Stack for NetGrimoire
--- ---
title: diun Stack
description: NetGrimoire Diun Service Documentation
published: true
date: 2026-04-07T17:54:14.788Z
tags: docker,swarm,diun,netgrimoire
editor: markdown
dateCreated: 2026-04-07T17:54:14.788Z
---
# diun
## Overview ## Overview
The diun stack is a Docker Swarm service that provides the core functionality of the Diun project. It consists of one container running the crazymax/diun:latest image, with user credentials set to 1964:1964. The diun stack provides a critical service in NetGrimoire, responsible for monitoring and notification functionality. The primary services included in this stack are the diun container, which handles watch workers and providers.
### Services
| Service | Image | Port | Role |
|---------|-------|------|------|
- **diun** | crazymax/diun:latest | - | Manager/Dashboard |
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |- **Host:** | docker4 |
- **Host:** docker4 |- **Network:** | netgrimoire |
- **Network:** netgrimoire |- **Exposed via:** https://diun.netgrimoire.com |
- **Exposed via:** 0.0.0.0:80 (caddy-docker-proxy labels) - **Homepage group:** homepage.netgrimoire
- **Homepage group:** homepage
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
None This stack requires Docker Swarm 2.1.0 or later and Caddy 2.5.0 or later.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/diun mkdir -p /DockerVol/diun
chown -R 1964:1964 /DockerVol/diun chown -R docker:docker /DockerVol/diun
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32 # generate: openssl rand -hex 32
TZ=America/Chicago DIUN_WATCH_WORKERS=20
DIUN_WATCH_WORKERS="20" DIUN_WATCH_SCHEDULE=0 */6 * * *
DIUN_WATCH_SCHEDULE="0 */6 * * *" DIUN_PROVIDERS_DOCKER=true
DIUN_PROVIDERS_DOCKER="true" DIUN_PROVIDERS_DOCKER WATCHBYDEFAULT=true
DIUN_PROVIDERS_DOCKER_WATCHBYDEFAULT="true"
DIUN_NOTIF_NTFY_ENDPOINT=https://ntfy.netgrimoire.com DIUN_NOTIF_NTFY_ENDPOINT=https://ntfy.netgrimoire.com
DIUN_NOTIF_NTFY_TOPIC=netgrimoire-diun DIUN_NOTIF_NTFY_TOPIC=netgrimoire-diun
DIUN_NOTIF_NTFY_PRIORITY=default DIUN_NOTIF_NTFY_PRIORITY=3
TZ=America/Chicago
``` ```
### Deploy ### Deploy
@ -55,65 +57,63 @@ docker stack services diun
``` ```
### First Run ### First Run
```bash Upon initial deployment, ensure that Caddy is running and configured to expose the diun service. The `diun.enable` label must be set to "true" for this service to function.
docker stack services diun
# Ensure Caddy is running and forwarding requests to the Diun service
```
--- ---
## User Guide ## User Guide
### Accessing diun ### Accessing diun
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |- **Host:** docker4 |
- **Diun**: http://diun.netgrimoire.com (caddy-docker-proxy labels) - **Internal only** |
### Primary Use Cases ### Primary Use Cases
This stack is used as part of the NetGrimoire monitoring setup, providing notification and monitoring functionality. Diun provides critical functionality for monitoring and notification within NetGrimoire. To utilize this service, ensure that the `diun` container is running and configured.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to other services in the NetGrimoire environment through various environment variables and labels. This service integrates with other NetGrimoire services, including Uptime Kuma and Caddy.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
<kuma monitors from kuma.* labels> Monitoring kuma.* labels:
```bash ```bash
docker stack services diun docker stack services diun
<docker service logs commands> docker service logs -f diun | grep "kuma"
``` ```
### Backups ### Backups
Critical data is stored on /DockerVol/diun, which should be backed up regularly to prevent loss of data. Critical vs reconstructable `/DockerVol/diun` paths. Ensure that this volume is backed up regularly to prevent data loss.
### Restore ### Restore
Restore the `diun` container by executing the following command:
```bash ```bash
cd services/swarm/stack/diun
./deploy.sh ./deploy.sh
# Redeploys the diun stack with the latest configuration
``` ```
--- ---
## Common Failures ## Common Failures
| Failure Mode | Symptom | Cause | Fix | | Failure Mode | Symptom | Cause | Fix |
|-------------|---------|------|-----| |- **Failed Watch Workers** | No watch workers are running | Incorrect `DIUN_WATCH_WORKERS` environment variable | Update `DIUN_WATCH_WORKERS` to a valid value (e.g., 20) and restart the container. |
| Diun not starting | No response from Diun | Incorrect environment variables | Check and correct .env file | |- **Provider Configuration Issues** | Providers are not configured correctly | Incorrect `DIUN_PROVIDERS_DOCKER` or `DIUN_PROVIDERS_DOCKER_WATCHBYDEFAULT` environment variables | Update `DIUN_PROVIDERS_DOCKER` to "true" and ensure that Caddy is running and configured. |
| Caddy not forwarding requests | Requests failing to forward to Diun | Incorrect caddy-docker-proxy labels | Verify caddy and Docker Swarm services are running correctly |
--- ---
## Changelog ## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |- **2026-04-07** | 27c8306d | Updated Docker Swarm configuration and Caddy labels for diun service. |
| 2026-04-07 | 4376b722 | Initial documentation for diun stack | |- **2026-04-07** | 4376b722 | Initial documentation creation for diun stack. |
| 2026-02-01 | c4605c36 | Minor updates to Diun configuration | |- **2026-02-01** | c4605c36 | Minor changes to `diun` container configuration. |
| 2026-01-10 | 1a374911 | Initial deployment of Diun service | |- **2026-01-10** | 1a374911 | Initial deployment of `diun` service with default environment variables. |
<Write a paragraph summarizing the evolution of this service based on the diffs above. This is the initial documentation for the diun stack, providing an overview of its functionality and configuration.>
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-07T17:41:55.262Z Generated by Gremlin on 2026-04-07T17:54:14.788Z
- Source: swarm/diun.yaml Source: swarm/diun.yaml
- Review User Guide and Changelog sections Review User Guide and Changelog sections