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-05-05 15:17:23 -05:00
parent f6b3ac0965
commit 186813aec6
1 changed files with 42 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,27 +2,24 @@
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-01T04:17:12.275Z date: 2026-05-05T20:16:08.910Z
tags: docker,swarm,dozzle,netgrimoire tags: docker,swarm,dozzle,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-05-01T04:17:12.275Z dateCreated: 2026-05-05T20:16:08.910Z
--- ---
# dozzle # dozzle
## Overview ## Overview
The dozzle stack is a Docker Swarm service that provides a log viewer for NetGrimoire. It exposes the Dozzle web interface, which allows users to view and manage logs from various sources. The dozzle stack is a Docker Swarm service that provides a log viewer for NetGrimoire. It exposes the Dozzle application, which allows users to view and manage logs from various sources.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|-----|------|
- **dozzle**: amir20/dozzle:latest | 8080 | Logging | - **Host:** docker4
- **Host:** docker4 | - | - | - - **Network:** netgrimoire
- **Network:** netgrimoire | - | - | - - **Exposed via:** dozzle.netgrimoire.com
- **Exposed via:** dozzle.netgrimoire.com, Internal only
- **Homepage group:** Monitoring - **Homepage group:** Monitoring
--- ---
@ -30,23 +27,24 @@ The dozzle stack is a Docker Swarm service that provides a log viewer for NetGri
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
This stack requires the following prerequisites: The swarm configuration requires the following prerequisites:
* Docker Swarm installed and configured - Docker Swarm manager and worker setup
* Caddy installed and configured as a reverse proxy - Caddy reverse proxy and Uptime Kuma monitoring setup
- Properly configured environment variables for authentication and authorization
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/dozzle mkdir -p /DockerVol/dozzle
chown -R dozzle:dozzle /DockerVol/dozzle chown dozzle:dozzle /DockerVol/dozzle
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32
DOZZLE_MODE=swarm DOZZLE_MODE=swarm
PUID=1964 PUID=1964
PGID=1964 PGID=1964
CADDY_DOMAIN=dozzle.netgrimoire.com CADDY ReverseProxy=dozzle.netgrimoire.com
CADDY_reverse_proxy=dozzle:8080
CADDY_import_1=crowdsec CADDY_import_1=crowdsec
CADDY_import_2=authentik CADDY_import_2=authentik
``` ```
@ -62,38 +60,45 @@ docker stack services dozzle
``` ```
### First Run ### First Run
After deploying the service for the first time, please update the Caddy configuration and restart it to enable reverse proxying. After deployment, the Dozzle application should be accessible at dozzle.netgrimoire.com.
--- ---
## User Guide ## User Guide
### Accessing dozzle ### Accessing dozzle
| Service | URL | Purpose | | Service | URL |
|---------|-----|---------| |---------|-----|
| dozzle | http://dozzle.netgrimoire.com | Logging | - **URL:** dozzle.netgrimoire.com
- **Purpose:** View and manage logs from various sources
### Primary Use Cases ### Primary Use Cases
To use Dozzle, navigate to the Caddy dashboard and configure the reverse proxy settings for the dozzle service. To use the Dozzle log viewer in NetGrimoire:
1. Navigate to the Dozzle web interface.
2. Select a source (e.g., Docker container) to view its logs.
3. Configure filters, timestamps, and other settings as needed.
### NetGrimoire Integrations ### NetGrimoire Integrations
The dozzle service connects to other services through environment variables and labels. Please refer to the environment variables section for more information. The dozzle stack integrates with the following services:
- Authentik (for authentication)
- Crowdsec (for threat detection)
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Kuma monitors are available for this service:
```bash ```bash
docker stack services dozzle docker stack services dozzle
docker service logs dozzle docker service logs -f dozzle
``` ```
### Backups ### Backups
Critical backups are required to preserve the log data. Please ensure that the `/DockerVol/dozzle` volume is properly backed up and restored in case of a failure. Critical data is stored in the /DockerVol/dozzle directory.
### Restore ### Restore
To restore the service, run the following command: To restore from a backup, re-run the deploy script:
```bash ```bash
cd services/swarm/stack/dozzle cd services/swarm/stack/dozzle
./deploy.sh ./deploy.sh
@ -103,9 +108,10 @@ cd services/swarm/stack/dozzle
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|------|-----|
| dozzle is not accessible | Caddy reverse proxy not enabled | Check and enable Caddy reverse proxy settings | 1. **No logs visible** | Incorrect authentication credentials | Check authentik and crowdsec setup.
| log data not preserved during backup | Volume not properly backed up | Ensure that the `/DockerVol/dozzle` volume is properly backed up | 2. **Service not responding** | Container not running | Restart the dozzle service.
3. **Authentication issues** | Incorrect CADDY settings | Review and correct environment variables.
--- ---
@ -113,15 +119,15 @@ cd services/swarm/stack/dozzle
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | d150805e | Initial documentation | | 2026-05-05 | 4c7304f5 | Initial documentation for dozzle stack |
| 2026-04-30 | 13bbfa55 | Updated Caddy reverse proxy settings | | 2026-05-01 | c3b0c0f5 | Updated Dozzle configuration |
| 2026-04-30 | b7739d88 | Improved log data backup process | | 2026-04-30 | d150805e | Initial deployment and setup |
| 2026-04-30 | 3c650a78 | Enhanced monitoring and troubleshooting tools |
| 2026-04-30 | 39e7aaae | Updated environment variables for better integration with other services | <No changes available from the diffs above>
--- ---
## Notes ## Notes
Generated by Gremlin on 2026-05-01T04:17:12.275Z - Generated by Gremlin on 2026-05-05T20:16:08.910Z
Source: swarm/dozzle.yaml - Source: swarm/dozzle.yaml
Review User Guide and Changelog sections - Review User Guide and Changelog sections