docs(gremlin): update dozzle
This commit is contained in:
parent
a8b13f6bf0
commit
04a9863d37
1 changed files with 36 additions and 32 deletions
|
|
@ -2,47 +2,53 @@
|
|||
title: dozzle Stack
|
||||
description: Docker log viewer for NetGrimoire
|
||||
published: true
|
||||
date: 2026-05-01T02:41:19.906Z
|
||||
date: 2026-05-01T04:17:12.275Z
|
||||
tags: docker,swarm,dozzle,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-05-01T02:41:19.906Z
|
||||
dateCreated: 2026-05-01T04:17:12.275Z
|
||||
|
||||
---
|
||||
|
||||
# dozzle
|
||||
|
||||
## Overview
|
||||
The dozzle stack is a Docker Swarm-based service that provides a web-based interface for viewing and managing Docker logs in NetGrimoire.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|-----|------|
|
||||
- **dozzle** | amir20/dozzle:latest | 8080 | Log viewer |
|
||||
|
||||
Exposed via: dozzle.netgrimoire.com, Internal only
|
||||
|
||||
Homepage group: Monitoring
|
||||
|---------|-------|------|------|
|
||||
- **dozzle**: amir20/dozzle:latest | 8080 | Logging |
|
||||
- **Host:** docker4 | - | - | -
|
||||
- **Network:** netgrimoire | - | - | -
|
||||
- **Exposed via:** dozzle.netgrimoire.com, Internal only
|
||||
- **Homepage group:** Monitoring
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
To build and deploy the dozzle stack, ensure that you have Docker Swarm installed and configured on your manager node (znas).
|
||||
This stack requires the following prerequisites:
|
||||
* Docker Swarm installed and configured
|
||||
* Caddy installed and configured as a reverse proxy
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/dozzle
|
||||
chown -R docker4:docker4 /DockerVol/dozzle
|
||||
chown -R dozzle:dozzle /DockerVol/dozzle
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
generate: openssl rand -hex 32
|
||||
DOZZLE_MODE=swarm
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
DOZZLE_MODE=SWARM
|
||||
CADDY_DOMAIN=dozzle.netgrimoire.com
|
||||
CADDY_reverse_proxy=dozzle:8080
|
||||
CADDY_import_1=crowdsec
|
||||
CADDY_import_2=authentik
|
||||
```
|
||||
|
||||
### Deploy
|
||||
|
|
@ -56,7 +62,7 @@ docker stack services dozzle
|
|||
```
|
||||
|
||||
### First Run
|
||||
After deploying the dozzle stack, you may need to run `./deploy.sh` to complete the initial setup.
|
||||
After deploying the service for the first time, please update the Caddy configuration and restart it to enable reverse proxying.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -64,32 +70,30 @@ After deploying the dozzle stack, you may need to run `./deploy.sh` to complete
|
|||
|
||||
### Accessing dozzle
|
||||
| Service | URL | Purpose |
|
||||
- **dozzle** | https://dozzle.netgrimoire.com | Log viewer |
|
||||
|---------|-----|---------|
|
||||
| dozzle | http://dozzle.netgrimoire.com | Logging |
|
||||
|
||||
### Primary Use Cases
|
||||
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.
|
||||
To use Dozzle, navigate to the Caddy dashboard and configure the reverse proxy settings for the dozzle service.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
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.
|
||||
The dozzle service connects to other services through environment variables and labels. Please refer to the environment variables section for more information.
|
||||
|
||||
---
|
||||
|
||||
## 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 commands>
|
||||
docker service logs dozzle
|
||||
```
|
||||
|
||||
### Backups
|
||||
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.
|
||||
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.
|
||||
|
||||
### Restore
|
||||
In the event of a disaster recovery situation, you can redeploy the dozzle stack using the `deploy.sh` script.
|
||||
|
||||
To restore the service, run the following command:
|
||||
```bash
|
||||
cd services/swarm/stack/dozzle
|
||||
./deploy.sh
|
||||
|
|
@ -99,9 +103,9 @@ cd services/swarm/stack/dozzle
|
|||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|------|-----|
|
||||
- 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`. |
|
||||
|---------|-------|-----|
|
||||
| dozzle is not accessible | Caddy reverse proxy not enabled | Check and enable Caddy reverse proxy settings |
|
||||
| log data not preserved during backup | Volume not properly backed up | Ensure that the `/DockerVol/dozzle` volume is properly backed up |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -109,15 +113,15 @@ cd services/swarm/stack/dozzle
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 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. |
|
||||
| 2026-04-30 | d150805e | Initial documentation |
|
||||
| 2026-04-30 | 13bbfa55 | Updated Caddy reverse proxy settings |
|
||||
| 2026-04-30 | b7739d88 | Improved log data backup process |
|
||||
| 2026-04-30 | 3c650a78 | Enhanced monitoring and troubleshooting tools |
|
||||
| 2026-04-30 | 39e7aaae | Updated environment variables for better integration with other services |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
Generated by Gremlin on 2026-05-01T02:41:19.906Z
|
||||
Generated by Gremlin on 2026-05-01T04:17:12.275Z
|
||||
Source: swarm/dozzle.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue