From 628242263260cffcbc0337a3b0a3febb86b99fd1 Mon Sep 17 00:00:00 2001 From: traveler Date: Wed, 29 Apr 2026 23:08:50 -0500 Subject: [PATCH] docs(gremlin): update dozzle --- Netgrimoire/Services/dozzle/dozzle.md | 74 ++++++++++----------------- 1 file changed, 28 insertions(+), 46 deletions(-) diff --git a/Netgrimoire/Services/dozzle/dozzle.md b/Netgrimoire/Services/dozzle/dozzle.md index f5f0e23..d2a4e3b 100644 --- a/Netgrimoire/Services/dozzle/dozzle.md +++ b/Netgrimoire/Services/dozzle/dozzle.md @@ -1,24 +1,16 @@ ---- -title: dozzle Stack -description: Docker log viewer for NetGrimoire -published: true -date: 2026-04-30T04:06:05.663Z -tags: docker,swarm,dozzle,netgrimoire -editor: markdown -dateCreated: 2026-04-30T04:06:05.663Z ---- - # dozzle ## Overview -The dozzle stack is a Docker Swarm configuration that provides a web-based interface for viewing and managing Docker log data in NetGrimoire. +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. + +--- ## Architecture | Service | Image | Port | Role | -|---------|-------|------|-----| +|---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** dozzle.netgrimoire.com, Internal only +- **Exposed via:** dozzle.netgrimoire.com - **Homepage group:** Management --- @@ -26,7 +18,7 @@ The dozzle stack is a Docker Swarm configuration that provides a web-based inter ## Build & Configuration ### Prerequisites -No specific prerequisites for this stack. +No specific prerequisites are required for this stack. ### Volume Setup ```bash @@ -36,15 +28,7 @@ chown -R docker4:docker4 /DockerVol/dozzle ### Environment Variables ```bash -# generate: openssl rand -hex 32 -CADDY_API_KEY=... -CADDY_TLS_CERT=... -CADDY_TLS_KEY=... - -DOZZLE_MODE=swarm - -HOME=/var/www/html -LOGDIR=/var/log +generate: openssl rand -hex 32 ``` ### Deploy @@ -58,7 +42,7 @@ docker stack services dozzle ``` ### First Run -After the initial deployment, you may need to update the Caddy configuration file (`/etc/caddy/Caddyfile`) to include the DNS record for your domain. +After deployment, the Dozzle service is ready to use. The Caddy reverse proxy will be configured to forward incoming requests to the Dozzle container. --- @@ -67,38 +51,43 @@ After the initial deployment, you may need to update the Caddy configuration fil ### Accessing dozzle | Service | URL | Purpose | |---------|-----|---------| -- **dozzle**: https://dozzle.netgrimoire.com +- **Caddy Proxy:** dozzle.netgrimoire.com:8080 +- **Internal Only:** dozzle:8080 ### Primary Use Cases -To view Docker log data, navigate to the dozzle interface and select the desired container or service. +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. ### NetGrimoire Integrations -This stack connects to other services in NetGrimoire via the environment variables `HOME` and `LOGDIR`. +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. --- ## Operations ### Monitoring -Check the monitoring dashboard for Uptime Kuma at http://dozzle:8080/monitor. +Monitor the Dozzle service using Uptime Kuma monitors: ```bash docker stack services dozzle docker service logs -f dozzle ``` ### Backups -Critical data should be backed up regularly to prevent loss in case of a failure. The `/var/log` directory on the host machine is used for storing log files. +Critical data is stored in `/DockerVol/dozzle`. Regular backups should be performed to ensure data integrity. ### Restore -To restore the stack from a backup, you need to delete the existing stack and re-deploy it with the backup configuration file (`dozzle-backup.yml`). +To restore the Dozzle service, run the following command after deployment: +```bash +./deploy.sh +``` --- ## Common Failures -1. **Caddy Not Starting**: Symptoms: Caddy is not responding. Cause: Incorrect Caddy configuration or DNS record issues. Fix: Update the Caddy configuration file and ensure that the DNS record points to the correct domain. -2. **Connection Issues**: Symptoms: Unable to connect to dozzle. Cause: Network issues or incorrect firewall rules. Fix: Check the network settings and firewall rules for any blockages or restrictions. -3. **Docker Log Issues**: Symptoms: Docker logs are not being displayed correctly. Cause: Incorrect Docker configuration or log storage issues. Fix: Update the Docker configuration and ensure that log files are stored in the correct location. -4. **Uptime Kuma Monitoring Issues**: Symptoms: Uptime Kuma monitoring dashboard is not working. Cause: Incorrect Uptime Kuma configuration or network issues. Fix: Update the Uptime Kuma configuration and ensure that the monitoring service can reach the dozzle container. +| Symptom | Cause | Fix | +|---------|-------|-----| +- **Failed deployment**: Insufficient resources or incorrect environment variables. +- **Caddy proxy not forwarding requests**: Verify Caddy labels and configuration. +- **Dozzle service not accessible**: Check the status of the Dozzle container and verify that the Caddy reverse proxy is configured correctly. --- @@ -106,15 +95,8 @@ To restore the stack from a backup, you need to delete the existing stack and re | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | 5d6ef553 | Updated Caddy configuration to use TLS. | -| 2026-04-29 | 135760e7 | Fixed network issue for dozzle container. | -| 2026-04-29 | 25bfdb39 | Improved Docker log management. | -| 2026-04-05 | d9099f8f | Updated environment variables for Caddy and Uptime Kuma. | -| 2026-04-05 | 91e25326 | Added support for TLS encryption in Caddy configuration. | - ---- - -## Notes -- Generated by Gremlin on 2026-04-30T04:06:05.663Z -- Source: swarm/dozzle.yaml -- Review User Guide and Changelog sections \ No newline at end of file +- 2026-04-29 | 4e0c6274 | Initial deployment configuration. +- 2026-04-29 | 5d6ef553 | Added Caddy labels and configuration. +- 2026-04-29 | 135760e7 | Updated environment variables for Dozzle service. +- 2026-04-29 | 25bfdb39 | Added Uptime Kuma monitoring configuration. +- 2026-04-05 | d9099f8f | Initial documentation creation. \ No newline at end of file