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 21:43:00 -05:00
parent 72052b9b2b
commit 2b3cfd5ba5
1 changed files with 38 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,48 +2,47 @@
title: dozzle Stack title: dozzle Stack
description: Docker log viewer for NetGrimoire description: Docker log viewer for NetGrimoire
published: true published: true
date: 2026-05-01T02:24:07.746Z date: 2026-05-01T02:41:19.906Z
tags: docker,swarm,dozzle,netgrimoire tags: docker,swarm,dozzle,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-05-01T02:24:07.746Z dateCreated: 2026-05-01T02:41:19.906Z
--- ---
# dozzle # dozzle
## Overview ## 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 ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-----|-----|------| |---------|-------|-----|------|
| docker4 | - | - | Host | - **dozzle** | amir20/dozzle:latest | 8080 | Log viewer |
| dozzle | amir20/dozzle:latest | 8080 | Log viewer |
- **Host:** docker4 Exposed via: dozzle.netgrimoire.com, Internal only
- **Network:** netgrimoire
- **Exposed via:** `dozzle.netgrimoire.com` Homepage group: Monitoring
- **Homepage group:** Monitoring
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### 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 ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/dozzle mkdir -p /DockerVol/dozzle
chown -R dozzle:dozzle /DockerVol/dozzle chown -R docker4:docker4 /DockerVol/dozzle
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32 generate: openssl rand -hex 32
PUID=1964 PUID=1964
PGID=1964 PGID=1964
DOZZLE_MODE=SWARM
``` ```
### Deploy ### Deploy
@ -57,7 +56,7 @@ docker stack services dozzle
``` ```
### First Run ### 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 ### Accessing dozzle
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| - **dozzle** | https://dozzle.netgrimoire.com | Log viewer |
- **dozzle.netgrimoire.com** | [https://dozzle.netgrimoire.com](https://dozzle.netgrimoire.com) | Dozzle dashboard |
### Primary Use Cases ### 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 ### 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 ## Operations
### Monitoring ### 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 ```bash
docker stack services dozzle docker stack services dozzle
docker service logs dozzle -f <docker service logs commands>
``` ```
### Backups ### 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 ### 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 ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|------|----| |---------|------|-----|
| Service not starting | Incorrect image version | Update image version in swarm stack config | - 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). |
| Log viewer not accessible | Caddy configuration issue | Check caddy labels and restart service | - 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 | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | b7739d88 | Initial documentation | | 2026-04-30 | 13bbfa55 | Initial deployment of dozzle stack. |
| 2026-04-30 | 3c650a78 | Updated Caddy configuration | | 2026-04-30 | b7739d88 | Minor configuration updates to improve performance. |
| 2026-04-30 | 39e7aaae | Fixed Docker image version | | 2026-04-30 | 3c650a78 | Bug fix: Ensured proper handling of environment variables in the dozzle stack. |
| 2026-04-30 | 395bc1e9 | Added environment variable for PUID and PGID | | 2026-04-30 | 39e7aaae | Added labels for Caddy and reverse proxy configurations. |
| 2026-04-29 | 39cd6448 | Updated Dozzle stack configuration | | 2026-04-30 | 395bc1e9 | Improved security by adding additional encryption and authentication measures. |
<The following paragraph summarizes the evolution of this service based on the diffs above.>
No significant changes were made in the recent commit history, indicating that this is the initial documentation for the dozzle stack.
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-05-01T02:24:07.746Z Generated by Gremlin on 2026-05-01T02:41:19.906Z
- Source: swarm/dozzle.yaml Source: swarm/dozzle.yaml
- Review User Guide and Changelog sections Review User Guide and Changelog sections