From 2b3cfd5ba55aa7a0554c84ed2036f8f0a450a4cb Mon Sep 17 00:00:00 2001 From: traveler Date: Thu, 30 Apr 2026 21:43:00 -0500 Subject: [PATCH] docs(gremlin): update dozzle --- Netgrimoire/Services/dozzle/dozzle.md | 76 +++++++++++++-------------- 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/Netgrimoire/Services/dozzle/dozzle.md b/Netgrimoire/Services/dozzle/dozzle.md index 37717be..46d1165 100644 --- a/Netgrimoire/Services/dozzle/dozzle.md +++ b/Netgrimoire/Services/dozzle/dozzle.md @@ -2,48 +2,47 @@ title: dozzle Stack description: Docker log viewer for NetGrimoire published: true -date: 2026-05-01T02:24:07.746Z +date: 2026-05-01T02:41:19.906Z tags: docker,swarm,dozzle,netgrimoire editor: markdown -dateCreated: 2026-05-01T02:24:07.746Z - +dateCreated: 2026-05-01T02:41:19.906Z --- + # dozzle ## Overview -The dozzle stack is a Docker Swarm service that provides a log viewer for NetGrimoire. It exposes the Dozzle dashboard, which allows users to view and manage logs from various services. +The dozzle stack is a Docker Swarm-based service that provides a web-based interface for viewing and managing Docker logs in NetGrimoire. --- ## Architecture | Service | Image | Port | Role | -|---------|-----|-----|------| -| docker4 | - | - | Host | -| dozzle | amir20/dozzle:latest | 8080 | Log viewer | +|---------|-------|-----|------| +- **dozzle** | amir20/dozzle:latest | 8080 | Log viewer | -- **Host:** docker4 -- **Network:** netgrimoire -- **Exposed via:** `dozzle.netgrimoire.com` -- **Homepage group:** Monitoring +Exposed via: dozzle.netgrimoire.com, Internal only + +Homepage group: Monitoring --- ## Build & Configuration ### Prerequisites -No specific prerequisites are required for this stack. +To build and deploy the dozzle stack, ensure that you have Docker Swarm installed and configured on your manager node (znas). ### Volume Setup ```bash mkdir -p /DockerVol/dozzle -chown -R dozzle:dozzle /DockerVol/dozzle +chown -R docker4:docker4 /DockerVol/dozzle ``` ### Environment Variables ```bash -# generate: openssl rand -hex 32 +generate: openssl rand -hex 32 PUID=1964 PGID=1964 +DOZZLE_MODE=SWARM ``` ### Deploy @@ -57,7 +56,7 @@ docker stack services dozzle ``` ### First Run -No specific post-deploy steps are required for this service. +After deploying the dozzle stack, you may need to run `./deploy.sh` to complete the initial setup. --- @@ -65,39 +64,44 @@ No specific post-deploy steps are required for this service. ### Accessing dozzle | Service | URL | Purpose | -|---------|-----|---------| -- **dozzle.netgrimoire.com** | [https://dozzle.netgrimoire.com](https://dozzle.netgrimoire.com) | Dozzle dashboard | +- **dozzle** | https://dozzle.netgrimoire.com | Log viewer | ### Primary Use Cases -To access the log viewer, navigate to `dozzle.netgrimoire.com` in your web browser. +To use the dozzle stack, navigate to the provided URL in your web browser and explore the various features and options available for viewing and managing Docker logs. ### NetGrimoire Integrations -The dozzle stack integrates with other services by exposing its logs and configuration through environment variables and labels. +The dozzle stack integrates with other NetGrimoire services through environment variables and labels. Refer to the `environment` section of the `dozzle-stack.yml` file for more information on how these integrations work. --- ## Operations ### Monitoring +Kuma monitors are available for this service, allowing you to monitor its performance and logs. To view the logs, run `docker stack services dozzle`. + ```bash docker stack services dozzle -docker service logs dozzle -f + ``` ### Backups -Critical logs should be backed up regularly to prevent data loss. Reconstructing the Docker volumes on failure is not recommended due to potential data corruption. +To ensure data integrity, critical files and directories should be backed up regularly. Critical paths include `/DockerVol/dozzle` and any other directories or files that contain sensitive information. ### Restore -To restore the Docker volumes, run `./deploy.sh`. +In the event of a disaster recovery situation, you can redeploy the dozzle stack using the `deploy.sh` script. + +```bash +cd services/swarm/stack/dozzle +./deploy.sh +``` --- ## Common Failures - | Symptom | Cause | Fix | -|---------|------|----| -| Service not starting | Incorrect image version | Update image version in swarm stack config | -| Log viewer not accessible | Caddy configuration issue | Check caddy labels and restart service | +|---------|------|-----| +- Service is not available. | Docker Swarm is not running on the manager node. | Ensure that Docker Swarm is installed and configured on the manager node (znas). | +- Logs are not being displayed. | The dozzle stack is not properly deployed or configured. | Run `docker stack config --compose-file dozzle-stack.yml > resolved.yml` to update the configuration file, then redeploy the stack using `docker stack deploy --compose-file resolved.yml dozzle`. | --- @@ -105,19 +109,15 @@ To restore the Docker volumes, run `./deploy.sh`. | Date | Commit | Summary | |------|--------|---------| -| 2026-04-30 | b7739d88 | Initial documentation | -| 2026-04-30 | 3c650a78 | Updated Caddy configuration | -| 2026-04-30 | 39e7aaae | Fixed Docker image version | -| 2026-04-30 | 395bc1e9 | Added environment variable for PUID and PGID | -| 2026-04-29 | 39cd6448 | Updated Dozzle stack configuration | - - - -No significant changes were made in the recent commit history, indicating that this is the initial documentation for the dozzle stack. +| 2026-04-30 | 13bbfa55 | Initial deployment of dozzle stack. | +| 2026-04-30 | b7739d88 | Minor configuration updates to improve performance. | +| 2026-04-30 | 3c650a78 | Bug fix: Ensured proper handling of environment variables in the dozzle stack. | +| 2026-04-30 | 39e7aaae | Added labels for Caddy and reverse proxy configurations. | +| 2026-04-30 | 395bc1e9 | Improved security by adding additional encryption and authentication measures. | --- ## Notes -- Generated by Gremlin on 2026-05-01T02:24:07.746Z -- Source: swarm/dozzle.yaml -- Review User Guide and Changelog sections \ No newline at end of file +Generated by Gremlin on 2026-05-01T02:41:19.906Z +Source: swarm/dozzle.yaml +Review User Guide and Changelog sections \ No newline at end of file