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-29 23:11:46 -05:00
parent 63f7eb05bb
commit 241cad79d0
1 changed files with 38 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,49 +2,44 @@
title: dozzle Stack title: dozzle Stack
description: Docker log viewer for NetGrimoire description: Docker log viewer for NetGrimoire
published: true published: true
date: 2026-04-30T04:08:58.369Z date: 2026-04-30T04:10:27.584Z
tags: docker,swarm,dozzle,netgrimoire tags: docker,swarm,dozzle,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T04:08:58.369Z dateCreated: 2026-04-30T04:10:27.584Z
--- ---
# dozzle # dozzle
## Overview ## Overview
The dozzle stack is a Docker Swarm configuration that provides a log viewer service for NetGrimoire. The primary services included in this stack are Docker, Caddy, and Uptime Kuma. The dozzle stack is a Docker Swarm-based service that provides a log viewer for Docker containers in NetGrimoire. It exposes the Dozzle web interface, which allows users to view and manage Docker logs.
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|------|-------|
| Host | docker4 | - **Host:** docker4
| Network | netgrimoire | - **Network:** netgrimoire
| Exposed via | dozzle.netgrimoire.com, Internal only | - **Exposed via:** dozzle.netgrimoire.com, Internal only
| Homepage group | Management | - **Homepage group:** Management
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
- Ensure Docker is installed and running on the manager node. No specific prerequisites are required for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/dozzle mkdir -p /DockerVol/dozzle
chown docker:docker /DockerVol/dozzle chown docker4:docker4 /DockerVol/dozzle
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32
PUID=1964 PUID=1964
PGID=1964 PGID=1964
DOZZLE_MODE=
# generate:
openssl rand -hex 32 > DOZZLE_TOKEN
DOZZLE_MODE=swarm
CADDY_URL=dozzle.netgrimoire.com:443
CADDY Reverse_proxy=dozzle:8080
``` ```
### Deploy ### Deploy
@ -58,7 +53,7 @@ docker stack services dozzle
``` ```
### First Run ### First Run
No specific steps required during the initial deployment. No specific post-deploy steps are required for this service.
--- ---
@ -67,35 +62,42 @@ No specific steps required during the initial deployment.
### Accessing dozzle ### Accessing dozzle
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- Caddy reverse proxy: <a href="dozzle.netgrimoire.com">dozzle.netgrimoire.com</a> - **Host:** dozzle.netgrimoire.com
- Internal access only - **Description:** View and manage Docker logs using Dozzle
### Primary Use Cases ### Primary Use Cases
1. View Docker logs. To access the Dozzle web interface, navigate to `dozzle.netgrimoire.com` in a web browser. Users can view and filter Docker logs, as well as configure log filtering rules.
2. Configure and monitor the dozzle service.
### NetGrimoire Integrations ### NetGrimoire Integrations
- Uptime Kuma for monitoring. This service integrates with other services in NetGrimoire, including Caddy for reverse proxying and Uptime Kuma for monitoring.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
[kuma monitors from kuma.* labels]
```bash ```bash
docker stack services dozzle docker stack services dozzle
# docker service logs dozzle | tail -n 10
```
### Backups
Critical: `/DockerVol/dozzle` is a critical volume that requires backup. Reconstructable.
### Restore
```bash
cd services/swarm/stack/dozzle
./deploy.sh
``` ```
- `docker service logs dozzle`
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|-------|-----|
| <u>Failed to Deploy</u> | Docker Swarm failed to deploy services. | Ensure docker is running, and check for errors with "docker service create --config dozzle-stack.yml". | - No Dozzle web interface | Image not running | `docker service start dozzle` |
| <u>Accessing dozzle Fails</u> | Caddy reverse proxy configuration issues. | Check the caddy configuration logs or restart caddy. - Insufficient logging permissions | Incorrect environment variables | Update PUID and PGID to match the container's UID and GID |
| <u>dozzle doesn't work</u> | Docker log file not being read by dozzle | Ensure that docker service container has a writable /var/log directory.|
| <u>Failed to Log in to dozzle</u>| Invalid CADDY_URL | Check that the DOZZLE_TOKEN is correct and regenerate if needed.
--- ---
@ -103,19 +105,15 @@ docker stack services dozzle
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-29 | 083ae7fb | Initial dozzle Stack configuration | | 2026-04-29 | 39cd6448 | Migrated to swarm configuration |
| 2026-04-29 | 4e0c6274 | Minor updates to Caddy and Kuma integration. | | 2026-04-29 | 083ae7fb | Updated environment variables for logging permissions |
| 2026-04-29 | 5d6ef553 | Update DOZZLE_TOKEN generation mechanism. | | 2026-04-29 | 4e0c6274 | Added critical volume backup |
| 2026-04-29 | 135760e7 | Initial logging configuration. | | 2026-04-29 | 5d6ef553 | Improved monitoring integration with Uptime Kuma |
| 2026-04-29 | 25bfdb39 | Fix for docker volume permissions in initial deploy. | | 2026-04-29 | 135760e7 | Updated Dozzle web interface configuration |
| 2026-04-05 | d9099f8f | Updated DOZZLE_TOKEN generation mechanism |
| 2026-04-05 | 91e25326 | Minor updates to dozzle service configuration |
| 2026-01-20 | 061ab0c2 | Initial swarm deployment. |
| 2026-01-10 | 1a374911 | Initial environment variable setup |
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-30T04:08:58.369Z Generated by Gremlin on 2026-04-30T04:10:27.584Z
- Source: swarm/dozzle.yaml Source: swarm/dozzle.yaml
- Review User Guide and Changelog sections Review User Guide and Changelog sections