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-05 00:11:19 -05:00
parent 8b9ebe3675
commit b2af2cb24d
1 changed files with 37 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,41 +2,40 @@
title: dozzle Stack title: dozzle Stack
description: Docker log viewer for NetGrimoire description: Docker log viewer for NetGrimoire
published: true published: true
date: 2026-04-05T05:08:49.282Z date: 2026-04-05T05:10:20.507Z
tags: docker,swarm,dozzle,netgrimoire tags: docker,swarm,dozzle,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-05T05:08:49.282Z dateCreated: 2026-04-05T05:10:20.507Z
--- ---
# dozzle # dozzle
## Overview ## Overview
The dozzle stack is a Docker Swarm configuration for the dozzle log viewer service in NetGrimoire. It provides an interface to view and manage Docker logs. The dozzle stack provides a Docker log viewer for NetGrimoire, allowing users to view and manage container logs in one place.
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |- **Host:** docker4 |
- **Host:** docker4 |- **Network:** netgrimoire |
- **Network:** netgrimoire |- **Exposed via:** caddy.netgrimoire.com |
- **Exposed via:** dozzle.netgrimoire.com - **Homepage group:** Management |
- **Homepage group:** Management
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
To build and deploy the dozzle stack, ensure you have Docker installed and running on your system. Ensure Docker is installed and configured on the host machine.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/dozzle mkdir -p /DockerVol/dozzle
chown docker4:docker4 /DockerVol/dozzle chown dozer:dozer /DockerVol/dozzle
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32 generate: openssl rand -hex 32 DOZZLE_MODE=swarm
``` ```
### Deploy ### Deploy
@ -50,9 +49,10 @@ docker stack services dozzle
``` ```
### First Run ### First Run
Perform the following steps after deploying the dozzle stack: Run the following command to initialize the stack:
- Verify the Caddy reverse proxy is working correctly. ```bash
- Configure any additional security settings as needed. ./deploy.sh
```
--- ---
@ -60,43 +60,43 @@ Perform the following steps after deploying the dozzle stack:
### Accessing dozzle ### Accessing dozzle
| Service | URL | Purpose | | Service | URL | Purpose |
- **Caddy Reverse Proxy:** https://dozzle.netgrimoire.com |- **Dozzle** | https://dozzle.netgrimoire.com | Docker log viewer |
- **Uptime Kuma Monitoring:** kuma.dozzle.http.name: Dozzle, kuma.dozzle.http.url: https://dozzle.netgrimoire.com
### Primary Use Cases ### Primary Use Cases
To use dozzle in NetGrimoire: To view logs for a specific container, use the following command:
1. Log into the Caddy reverse proxy at https://dozzle.netgrimoire.com. ```bash
2. Configure and set up your Docker logs for monitoring. docker logs <container_id> --tail 100
```
### NetGrimoire Integrations ### NetGrimoire Integrations
The dozzle stack integrates with other services as follows: This stack integrates with Uptime Kuma and Caddy to provide monitoring and reverse proxy capabilities.
- The `DOZZLE_MODE` environment variable is set to "swarm" to configure the service.
- Uptime Kuma monitors the dozzle service's HTTP endpoint at https://dozzle.netgrimoire.com.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Use Uptime Kuma to monitor the dozzle service: Monitor service using kuma:
```bash ```bash
docker stack services dozzle docker stack services dozzle
docker service logs -f dozzle | grep "Error" docker service logs -f dozzle
``` ```
### Backups ### Backups
Critical vs reconstructable Docker volumes are `/DockerVol/dozzle`. Critical data is stored on the Docker volume at /DockerVol/dozzle.
### Restore ### Restore
To restore the dozzle stack, run `./deploy.sh` from within the services/swarm/stack/dozzle directory. Restore the stack by running the following command:
```bash
./deploy.sh
```
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Failure Mode | Symptom | Cause | Fix |
|---------|-------|-----| |- **Container log not available** | Logs are empty or missing. | Incorrect container ID or permissions issue. | Verify container ID and ensure necessary permissions. |
- **Service not running:** Insufficient Docker resources. | - Increase resources allocated to docker4 or add more workers to the swarm configuration. | |- **Caddy not started** | Caddy is not responding to requests. | Caddy service is not running. | Run `docker stack services dozzle` and verify that Caddy is running. |
- **Inaccessible Caddy reverse proxy:** Incorrect labels on services. | - Correct caddy: and caddy.reverse_proxy labels on the dozzle service. |
--- ---
@ -104,13 +104,15 @@ To restore the dozzle stack, run `./deploy.sh` from within the services/swarm/st
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-05 | 91e25326 | Updated dozzle configuration to use swarm mode. | | 2026-04-05 | d9099f8f | Initial documentation creation. |
| 2026-01-20 | 061ab0c2 | Initial setup of the dozzle service for NetGrimoire. | | 2026-04-05 | 91e25326 | Added volume setup and environment variable generation commands. |
| 2026-01-20 | 061ab0c2 | Initial commit for dozzle stack configuration. |
<Note: This stack was created on 2026-04-05T05:08:49.282Z and last updated on the same date due to lack of commits> <Note: This is the initial documentation for the dozzle stack, and no further changes have been made at this time.>
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-05T05:08:49.282Z - Generated by Gremlin on 2026-04-05T05:10:20.507Z
- Source: swarm/dozzle.yaml - Source: swarm/dozzle.yaml
- Review User Guide and Changelog sections