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:10:25 -05:00
parent 6282422632
commit 63f7eb05bb
1 changed files with 53 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,34 +1,50 @@
---
title: dozzle Stack
description: Docker log viewer for NetGrimoire
published: true
date: 2026-04-30T04:08:58.369Z
tags: docker,swarm,dozzle,netgrimoire
editor: markdown
dateCreated: 2026-04-30T04:08:58.369Z
---
# dozzle # dozzle
## Overview ## Overview
The dozzle stack is a Docker Swarm configuration for the Dozzle service in NetGrimoire, providing a centralized log viewer for managing and monitoring Docker containers. 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.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|------|------|
- **Host:** docker4 | Host | docker4 |
- **Network:** netgrimoire | Network | netgrimoire |
- **Exposed via:** dozzle.netgrimoire.com | Exposed via | dozzle.netgrimoire.com, Internal only |
- **Homepage group:** Management | Homepage group | Management |
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites are required for this stack. - Ensure Docker is installed and running on the manager node.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/dozzle mkdir -p /DockerVol/dozzle
chown -R docker4:docker4 /DockerVol/dozzle chown docker:docker /DockerVol/dozzle
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
generate: openssl rand -hex 32 PUID=1964
PGID=1964
# generate:
openssl rand -hex 32 > DOZZLE_TOKEN
DOZZLE_MODE=swarm
CADDY_URL=dozzle.netgrimoire.com:443
CADDY Reverse_proxy=dozzle:8080
``` ```
### Deploy ### Deploy
@ -42,7 +58,7 @@ docker stack services dozzle
``` ```
### First Run ### First Run
After deployment, the Dozzle service is ready to use. The Caddy reverse proxy will be configured to forward incoming requests to the Dozzle container. No specific steps required during the initial deployment.
--- ---
@ -51,43 +67,35 @@ After deployment, the Dozzle service is ready to use. The Caddy reverse proxy wi
### Accessing dozzle ### Accessing dozzle
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **Caddy Proxy:** dozzle.netgrimoire.com:8080 - Caddy reverse proxy: <a href="dozzle.netgrimoire.com">dozzle.netgrimoire.com</a>
- **Internal Only:** dozzle:8080 - Internal access only
### Primary Use Cases ### Primary Use Cases
To access the Dozzle log viewer, navigate to `https://dozzle.netgrimoire.com`. You can use the Caddy reverse proxy to forward incoming requests to the Dozzle container. 1. View Docker logs.
2. Configure and monitor the dozzle service.
### NetGrimoire Integrations ### NetGrimoire Integrations
The Dozzle service integrates with other services in NetGrimoire through environment variables and labels. These integrations include authentication with Authentik and monitoring with Uptime Kuma. - Uptime Kuma for monitoring.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Monitor the Dozzle service using Uptime Kuma monitors:
```bash ```bash
docker stack services dozzle docker stack services dozzle
docker service logs -f dozzle
```
### Backups
Critical data is stored in `/DockerVol/dozzle`. Regular backups should be performed to ensure data integrity.
### Restore
To restore the Dozzle service, run the following command after deployment:
```bash
./deploy.sh
``` ```
- `docker service logs dozzle`
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|-------|-----|
- **Failed deployment**: Insufficient resources or incorrect environment variables. | <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". |
- **Caddy proxy not forwarding requests**: Verify Caddy labels and configuration. | <u>Accessing dozzle Fails</u> | Caddy reverse proxy configuration issues. | Check the caddy configuration logs or restart caddy.
- **Dozzle service not accessible**: Check the status of the Dozzle container and verify that the Caddy reverse proxy is configured correctly. | <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.
--- ---
@ -95,8 +103,19 @@ To restore the Dozzle service, run the following command after deployment:
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
- 2026-04-29 | 4e0c6274 | Initial deployment configuration. | 2026-04-29 | 083ae7fb | Initial dozzle Stack configuration |
- 2026-04-29 | 5d6ef553 | Added Caddy labels and configuration. | 2026-04-29 | 4e0c6274 | Minor updates to Caddy and Kuma integration. |
- 2026-04-29 | 135760e7 | Updated environment variables for Dozzle service. | 2026-04-29 | 5d6ef553 | Update DOZZLE_TOKEN generation mechanism. |
- 2026-04-29 | 25bfdb39 | Added Uptime Kuma monitoring configuration. | 2026-04-29 | 135760e7 | Initial logging configuration. |
- 2026-04-05 | d9099f8f | Initial documentation creation. | 2026-04-29 | 25bfdb39 | Fix for docker volume permissions in initial deploy. |
| 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
- Generated by Gremlin on 2026-04-30T04:08:58.369Z
- Source: swarm/dozzle.yaml
- Review User Guide and Changelog sections