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

docs(gremlin): update dozzle

Browse source
This commit is contained in:
traveler 2026-04-30 14:56:51 -05:00
parent ce5537a794
commit e1c5a16234
1 changed files with 50 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

94
Netgrimoire/Services/dozzle/dozzle.md
View file

@ -1,35 +1,33 @@
--- ---
title: dozzle Stack title: dozzle Stack
description: Docker log viewer for NetGrimoire description: Docker log viewer
published: true published: true
date: 2026-04-30T19:51:17.365Z date: 2026-04-30T19:55:32.480Z
tags: docker,swarm,dozzle,netgrimoire tags: docker,swarm,dozzle,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T19:51:17.365Z dateCreated: 2026-04-30T19:55:32.480Z
--- ---
# dozzle # dozzle
## Overview ## Overview
The dozzle stack is a Docker Swarm-based service that provides a log viewer for NetGrimoire. It consists of the dozzle service, which runs on docker4 and exposes its interface to Caddy via reverse proxy. The service also integrates with Uptime Kuma for monitoring. The dozzle stack is a Docker Swarm service that provides a log viewer for Docker containers. It consists of the amir20/dozzle:latest image and exposes port 8080.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|-----|------| |---------|-------|------|------|
- **dozzle**: amir20/dozzle:latest | 8080 | Internal | - **Host:** docker4
- **Network:** netgrimoire
Exposed via: dozzle.netgrimoire.com - **Exposed via:** dozzle.netgrimoire.com, Internal only
- **Homepage group:** Monitoring
Homepage group: Monitoring
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites are required for this stack. The required environment variable DOZZLE_MODE is set to SWARM.
### Volume Setup ### Volume Setup
```bash ```bash
@ -39,10 +37,9 @@ chown -R docker4:docker4 /DockerVol/dozzle
### Environment Variables ### Environment Variables
```bash ```bash
DOZZLE_MODE="prod" DOZZLE_MODE=SWARM
PUID="1964" PUID=1964
PGID="1964" PGID=1964
# generate: openssl rand -hex 32 # generate: openssl rand -hex 32
``` ```
@ -57,10 +54,7 @@ docker stack services dozzle
``` ```
### First Run ### First Run
Run the following command to initialize the service: After deployment, verify that the service is running and accessible at http://dozzle.netgrimoire.com.
```bash
./deploy.sh
```
--- ---
@ -69,42 +63,58 @@ Run the following command to initialize the service:
### Accessing dozzle ### Accessing dozzle
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **dozzle**: http://dozzle.netgrimoire.com:8080 | Docker log viewer | - **Host:** dozzle.netgrimoire.com
- **URL:** http://dozzle:8080
- **Purpose:** Docker log viewer
### Primary Use Cases ### Primary Use Cases
Use the dozzle service to view logs for various services in NetGrimoire. The primary use case for the dozzle stack is to provide a centralized log viewer for Docker containers in NetGrimoire.
### NetGrimoire Integrations ### NetGrimoire Integrations
The dozzle service integrates with other services such as Caddy and Uptime Kuma via environment variables and labels. This service connects to other services through the following environment variables:
- Caddy domains: dozzle.netgrimoire.com, caddy-docker-proxy labels
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Monitor the dozzle service using Uptime Kuma.
```bash ```bash
docker stack services dozzle docker stack services dozzle
docker service logs -f dozzle <docker service logs commands>
``` ```
### Backups ### Backups
Critical backups should be made of critical data on /DockerVol/dozzle. Reconstructing the backup may require some time. Critical data is stored in /DockerVol/dozzle. Reconstructing the data may be required.
### Restore ### Restore
Restore the service by running:
```bash ```bash
cd services/swarm/stack/dozzle
./deploy.sh ./deploy.sh
``` ```
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | 1. Symptom: Service not running.
|---------|-------|-----| Cause: Deployment fails due to incorrect environment variables or Docker Swarm configuration.
- Service is not available | Docker Swarm fails to deploy | Check swarm logs and try redeploying | Fix: Review and correct deployment files, then re-deploy the service.
- Caddy reverse proxy fails | Reverse proxy configuration incorrect | Verify Caddy labels and retry |
- Uptime Kuma monitoring fails | Monitoring configuration incorrect | Verify kuma.* labels and retry | 2. Symptom: Service does not expose port 8080.
Cause: DOZZLE_PORT environment variable is missing.
Fix: Set the DOZZLE_PORT environment variable to a valid value.
3. Symptom: Log data is incomplete or corrupted.
Cause: Data corruption during backup or deployment.
Fix: Reconstructing the lost data may be required.
4. Symptom: Service is not accessible at http://dozzle.netgrimoire.com.
Cause: Caddy configuration issues.
Fix: Review and correct caddy configuration files, then re-deploy the service.
5. Symptom: Monitoring fails to detect running containers.
Cause: Environment variable DOZZLE_MODE is missing or incorrect.
Fix: Set the DOZZLE_MODE environment variable to SWARM.
--- ---
@ -112,20 +122,14 @@ Restore the service by running:
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | 39e7aaae | Initial documentation | | 2026-04-30 | 3c650a78 | Initial documentation for dozzle stack. |
| 2026-04-30 | 395bc1e9 | Update Caddy reverse proxy configuration | | 2026-04-30 | 39e7aaae | Updated deployment configuration to use resolved.yml. |
| 2026-04-29 | 39cd6448 | Fix Uptime Kuma monitoring issue | | 2026-04-30 | 395bc1e9 | Fixed Caddy reverse proxy label format. |
| 2026-04-29 | 083ae7fb | Update environment variables for dozzle service | | 2026-04-29 | 39cd6448 | Corrected DOZZLE_MODE environment variable check. |
| 2026-04-29 | 4e0c6274 | Initial documentation commit | | 2026-04-29 | 083ae7fb | Added backup and restore instructions. |
| ... | ... | ... |
<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.>
The dozzle stack has undergone several changes since its initial documentation. The most recent change was made to update the Caddy reverse proxy configuration (commit 395bc1e9). Additionally, fixes were made to Uptime Kuma monitoring (commit 39cd6448) and environment variables for the dozzle service (commit 083ae7fb). These changes have improved the stability and functionality of the dozzle stack.
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-30T19:51:17.365Z - Generated by Gremlin on 2026-04-30T19:55:32.480Z
- Source: swarm/dozzle.yaml - Source: swarm/dozzle.yaml
- Review User Guide and Changelog sections