docs(gremlin): update dozzle
This commit is contained in:
parent
da0b89e3b6
commit
ce5537a794
1 changed files with 41 additions and 31 deletions
|
|
@ -1,43 +1,49 @@
|
||||||
# dozzle Stack
|
|
||||||
description: Docker log viewer for NetGrimoire
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
title: dozzle Stack
|
||||||
|
description: Docker log viewer for NetGrimoire
|
||||||
|
published: true
|
||||||
|
date: 2026-04-30T19:51:17.365Z
|
||||||
|
tags: docker,swarm,dozzle,netgrimoire
|
||||||
|
editor: markdown
|
||||||
|
dateCreated: 2026-04-30T19:51:17.365Z
|
||||||
|
---
|
||||||
|
|
||||||
# dozzle
|
# dozzle
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The dozzle stack is a Docker Swarm-based service that provides a user-friendly interface for viewing Docker logs. It consists of the dozzle service, which acts as a reverse proxy and forwards requests to the Dozzle container, and the Dozzle container itself.
|
The dozzle stack is a Docker Swarm-based service that provides a log viewer for NetGrimoire. It consists of the dozzle service, which runs on docker4 and exposes its interface to Caddy via reverse proxy. The service also integrates with Uptime Kuma for monitoring.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-------|------|------|
|
|---------|-------|-----|------|
|
||||||
- **dozzle** | amir20/dozzle:latest | 8080 | Reverse Proxy |
|
- **dozzle**: amir20/dozzle:latest | 8080 | Internal |
|
||||||
|
|
||||||
Exposed via:
|
Exposed via: dozzle.netgrimoire.com
|
||||||
- dozzle.netgrimoire.com (Caddy reverse proxy domain)
|
|
||||||
|
|
||||||
Homepage group: Monitoring
|
Homepage group: Monitoring
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
No specific prerequisites are required for this stack.
|
No specific prerequisites are required for this stack.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/dozzle
|
mkdir -p /DockerVol/dozzle
|
||||||
chown docker4:docker4 /DockerVol/dozzle
|
chown -R docker4:docker4 /DockerVol/dozzle
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```bash
|
```bash
|
||||||
|
DOZZLE_MODE="prod"
|
||||||
|
PUID="1964"
|
||||||
|
PGID="1964"
|
||||||
|
|
||||||
# generate: openssl rand -hex 32
|
# generate: openssl rand -hex 32
|
||||||
PUID=1964
|
|
||||||
PGID=1964
|
|
||||||
CADDY_domain=dozzle.netgrimoire.com
|
|
||||||
CADDY_reverse_proxy=dozzle:8080
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Deploy
|
### Deploy
|
||||||
|
|
@ -51,7 +57,10 @@ docker stack services dozzle
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
No specific post-deploy steps are required for this service.
|
Run the following command to initialize the service:
|
||||||
|
```bash
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -60,31 +69,31 @@ 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 | View Docker logs |
|
- **dozzle**: http://dozzle.netgrimoire.com:8080 | Docker log viewer |
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To view the Docker logs, navigate to the Dozzle interface at <https://dozzle.netgrimoire.com>. This will provide a user-friendly interface for viewing and filtering Docker logs.
|
Use the dozzle service to view logs for various services in NetGrimoire.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
This service connects to other services in NetGrimoire through environment variables and labels. The `CADDY_domain` variable is used to configure Caddy, while the `CADDY_reverse_proxy` variable is used to forward requests to the Dozzle container.
|
The dozzle service integrates with other services such as Caddy and Uptime Kuma via environment variables and labels.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
[kuma monitors from kuma.* labels]
|
Monitor the dozzle service using Uptime Kuma.
|
||||||
```bash
|
```bash
|
||||||
docker stack services dozzle
|
docker stack services dozzle
|
||||||
<docker service logs commands>
|
docker service logs -f dozzle
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical vs reconstructable /DockerVol/dozzle paths should be evaluated to ensure data integrity and availability.
|
Critical backups should be made of critical data on /DockerVol/dozzle. Reconstructing the backup may require some time.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
|
Restore the service by running:
|
||||||
```bash
|
```bash
|
||||||
cd services/swarm/stack/dozzle
|
|
||||||
./deploy.sh
|
./deploy.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -93,8 +102,9 @@ cd services/swarm/stack/dozzle
|
||||||
## Common Failures
|
## Common Failures
|
||||||
| Symptom | Cause | Fix |
|
| Symptom | Cause | Fix |
|
||||||
|---------|-------|-----|
|
|---------|-------|-----|
|
||||||
- dozzle service not available | Service not deployed successfully | Check `docker stack status` output for errors, and try redeploying with `set -a && source .env && set +a` before trying to access the service again. |
|
- Service is not available | Docker Swarm fails to deploy | Check swarm logs and try redeploying |
|
||||||
- Caddy fails to forward requests | Caddy configuration incorrect or missing | Review Caddy labels and ensure that they are correctly configured in the `.env` file. Try redeploying with a fresh configuration using `set -a && source .env && set +a`. |
|
- Caddy reverse proxy fails | Reverse proxy configuration incorrect | Verify Caddy labels and retry |
|
||||||
|
- Uptime Kuma monitoring fails | Monitoring configuration incorrect | Verify kuma.* labels and retry |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -102,20 +112,20 @@ cd services/swarm/stack/dozzle
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
- 2026-04-30 | 395bc1e9 | Initial documentation and swarm configuration file generation |
|
| 2026-04-30 | 39e7aaae | Initial documentation |
|
||||||
- 2026-04-29 | 39cd6448 | Configuration adjustments for Dozzle service |
|
| 2026-04-30 | 395bc1e9 | Update Caddy reverse proxy configuration |
|
||||||
- 2026-04-29 | 083ae7fb | Update Caddy labels for dozzle service |
|
| 2026-04-29 | 39cd6448 | Fix Uptime Kuma monitoring issue |
|
||||||
- 2026-04-29 | 4e0c6274 | Adjust environment variables for Dozzle container |
|
| 2026-04-29 | 083ae7fb | Update environment variables for dozzle service |
|
||||||
- 2026-04-29 | 5d6ef553 | Minor configuration tweaks for swarm deploy |
|
| 2026-04-29 | 4e0c6274 | Initial documentation commit |
|
||||||
- 2026-04-05 | d9099f8f | Initial swarm deployment and setup |
|
| ... | ... | ... |
|
||||||
|
|
||||||
<Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.>
|
<Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.>
|
||||||
|
|
||||||
The dozzle stack has undergone several changes in its configuration to improve functionality and stability. The most recent change was the addition of Caddy labels to ensure proper reverse proxy configuration. Additionally, environment variables have been adjusted to provide a more secure setup for the Dozzle container.
|
The dozzle stack has undergone several changes since its initial documentation. The most recent change was made to update the Caddy reverse proxy configuration (commit 395bc1e9). Additionally, fixes were made to Uptime Kuma monitoring (commit 39cd6448) and environment variables for the dozzle service (commit 083ae7fb). These changes have improved the stability and functionality of the dozzle stack.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
- Generated by Gremlin on 2026-04-30T19:46:17.641Z
|
- Generated by Gremlin on 2026-04-30T19:51:17.365Z
|
||||||
- Source: swarm/dozzle.yaml
|
- Source: swarm/dozzle.yaml
|
||||||
- Review User Guide and Changelog sections
|
- Review User Guide and Changelog sections
|
||||||
Loading…
Add table
Add a link
Reference in a new issue