docs(gremlin): update dozzle
This commit is contained in:
parent
277c4ea712
commit
5d6530a6c3
1 changed files with 38 additions and 50 deletions
|
|
@ -1,25 +1,29 @@
|
|||
---
|
||||
title: dozzle Stack
|
||||
description: Docker log viewer
|
||||
description: Docker log viewer for NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-30T19:55:32.480Z
|
||||
date: 2026-05-01T02:24:07.746Z
|
||||
tags: docker,swarm,dozzle,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-30T19:55:32.480Z
|
||||
---
|
||||
dateCreated: 2026-05-01T02:24:07.746Z
|
||||
|
||||
---
|
||||
# dozzle
|
||||
|
||||
## Overview
|
||||
The dozzle stack is a Docker Swarm service that provides a log viewer for Docker containers. It consists of the amir20/dozzle:latest image and exposes port 8080.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
|---------|-----|-----|------|
|
||||
| docker4 | - | - | Host |
|
||||
| dozzle | amir20/dozzle:latest | 8080 | Log viewer |
|
||||
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** dozzle.netgrimoire.com, Internal only
|
||||
- **Exposed via:** `dozzle.netgrimoire.com`
|
||||
- **Homepage group:** Monitoring
|
||||
|
||||
---
|
||||
|
|
@ -27,20 +31,19 @@ The dozzle stack is a Docker Swarm service that provides a log viewer for Docker
|
|||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
The required environment variable DOZZLE_MODE is set to SWARM.
|
||||
No specific prerequisites are required for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/dozzle
|
||||
chown -R docker4:docker4 /DockerVol/dozzle
|
||||
chown -R dozzle:dozzle /DockerVol/dozzle
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
DOZZLE_MODE=SWARM
|
||||
# generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
# generate: openssl rand -hex 32
|
||||
```
|
||||
|
||||
### Deploy
|
||||
|
|
@ -54,7 +57,7 @@ docker stack services dozzle
|
|||
```
|
||||
|
||||
### First Run
|
||||
After deployment, verify that the service is running and accessible at http://dozzle.netgrimoire.com.
|
||||
No specific post-deploy steps are required for this service.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -63,16 +66,13 @@ After deployment, verify that the service is running and accessible at http://do
|
|||
### Accessing dozzle
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **Host:** dozzle.netgrimoire.com
|
||||
- **URL:** http://dozzle:8080
|
||||
- **Purpose:** Docker log viewer
|
||||
- **dozzle.netgrimoire.com** | [https://dozzle.netgrimoire.com](https://dozzle.netgrimoire.com) | Dozzle dashboard |
|
||||
|
||||
### Primary Use Cases
|
||||
The primary use case for the dozzle stack is to provide a centralized log viewer for Docker containers in NetGrimoire.
|
||||
To access the log viewer, navigate to `dozzle.netgrimoire.com` in your web browser.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This service connects to other services through the following environment variables:
|
||||
- Caddy domains: dozzle.netgrimoire.com, caddy-docker-proxy labels
|
||||
The dozzle stack integrates with other services by exposing its logs and configuration through environment variables and labels.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -81,40 +81,23 @@ This service connects to other services through the following environment variab
|
|||
### Monitoring
|
||||
```bash
|
||||
docker stack services dozzle
|
||||
<docker service logs commands>
|
||||
docker service logs dozzle -f
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data is stored in /DockerVol/dozzle. Reconstructing the data may be required.
|
||||
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.
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
cd services/swarm/stack/dozzle
|
||||
./deploy.sh
|
||||
```
|
||||
To restore the Docker volumes, run `./deploy.sh`.
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
1. Symptom: Service not running.
|
||||
Cause: Deployment fails due to incorrect environment variables or Docker Swarm configuration.
|
||||
Fix: Review and correct deployment files, then re-deploy the service.
|
||||
|
||||
2. Symptom: Service does not expose port 8080.
|
||||
Cause: DOZZLE_PORT environment variable is missing.
|
||||
Fix: Set the DOZZLE_PORT environment variable to a valid value.
|
||||
|
||||
3. Symptom: Log data is incomplete or corrupted.
|
||||
Cause: Data corruption during backup or deployment.
|
||||
Fix: Reconstructing the lost data may be required.
|
||||
|
||||
4. Symptom: Service is not accessible at http://dozzle.netgrimoire.com.
|
||||
Cause: Caddy configuration issues.
|
||||
Fix: Review and correct caddy configuration files, then re-deploy the service.
|
||||
|
||||
5. Symptom: Monitoring fails to detect running containers.
|
||||
Cause: Environment variable DOZZLE_MODE is missing or incorrect.
|
||||
Fix: Set the DOZZLE_MODE environment variable to SWARM.
|
||||
| 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 |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -122,14 +105,19 @@ Fix: Set the DOZZLE_MODE environment variable to SWARM.
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-30 | 3c650a78 | Initial documentation for dozzle stack. |
|
||||
| 2026-04-30 | 39e7aaae | Updated deployment configuration to use resolved.yml. |
|
||||
| 2026-04-30 | 395bc1e9 | Fixed Caddy reverse proxy label format. |
|
||||
| 2026-04-29 | 39cd6448 | Corrected DOZZLE_MODE environment variable check. |
|
||||
| 2026-04-29 | 083ae7fb | Added backup and restore instructions. |
|
||||
| 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 |
|
||||
|
||||
<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
|
||||
- Generated by Gremlin on 2026-04-30T19:55:32.480Z
|
||||
- Generated by Gremlin on 2026-05-01T02:24:07.746Z
|
||||
- Source: swarm/dozzle.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue