docs(gremlin): update dozzle
This commit is contained in:
parent
8b9ebe3675
commit
b2af2cb24d
1 changed files with 37 additions and 35 deletions
|
|
@ -2,41 +2,40 @@
|
|||
title: dozzle Stack
|
||||
description: Docker log viewer for NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-05T05:08:49.282Z
|
||||
date: 2026-04-05T05:10:20.507Z
|
||||
tags: docker,swarm,dozzle,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-05T05:08:49.282Z
|
||||
dateCreated: 2026-04-05T05:10:20.507Z
|
||||
---
|
||||
|
||||
# dozzle
|
||||
|
||||
## 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
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** dozzle.netgrimoire.com
|
||||
- **Homepage group:** Management
|
||||
|- **Host:** docker4 |
|
||||
|- **Network:** netgrimoire |
|
||||
|- **Exposed via:** caddy.netgrimoire.com |
|
||||
- **Homepage group:** Management |
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### 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
|
||||
```bash
|
||||
mkdir -p /DockerVol/dozzle
|
||||
chown docker4:docker4 /DockerVol/dozzle
|
||||
chown dozer:dozer /DockerVol/dozzle
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
generate: openssl rand -hex 32 DOZZLE_MODE=swarm
|
||||
```
|
||||
|
||||
### Deploy
|
||||
|
|
@ -50,9 +49,10 @@ docker stack services dozzle
|
|||
```
|
||||
|
||||
### First Run
|
||||
Perform the following steps after deploying the dozzle stack:
|
||||
- Verify the Caddy reverse proxy is working correctly.
|
||||
- Configure any additional security settings as needed.
|
||||
Run the following command to initialize the stack:
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -60,43 +60,43 @@ Perform the following steps after deploying the dozzle stack:
|
|||
|
||||
### Accessing dozzle
|
||||
| Service | URL | Purpose |
|
||||
- **Caddy Reverse Proxy:** https://dozzle.netgrimoire.com
|
||||
- **Uptime Kuma Monitoring:** kuma.dozzle.http.name: Dozzle, kuma.dozzle.http.url: https://dozzle.netgrimoire.com
|
||||
|- **Dozzle** | https://dozzle.netgrimoire.com | Docker log viewer |
|
||||
|
||||
### Primary Use Cases
|
||||
To use dozzle in NetGrimoire:
|
||||
1. Log into the Caddy reverse proxy at https://dozzle.netgrimoire.com.
|
||||
2. Configure and set up your Docker logs for monitoring.
|
||||
To view logs for a specific container, use the following command:
|
||||
```bash
|
||||
docker logs <container_id> --tail 100
|
||||
```
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The dozzle stack integrates with other services as follows:
|
||||
- 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.
|
||||
This stack integrates with Uptime Kuma and Caddy to provide monitoring and reverse proxy capabilities.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
Use Uptime Kuma to monitor the dozzle service:
|
||||
Monitor service using kuma:
|
||||
```bash
|
||||
docker stack services dozzle
|
||||
docker service logs -f dozzle | grep "Error"
|
||||
docker service logs -f dozzle
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical vs reconstructable Docker volumes are `/DockerVol/dozzle`.
|
||||
Critical data is stored on the Docker volume at /DockerVol/dozzle.
|
||||
|
||||
### 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
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
- **Service not running:** Insufficient Docker resources. | - Increase resources allocated to docker4 or add more workers to the swarm configuration. |
|
||||
- **Inaccessible Caddy reverse proxy:** Incorrect labels on services. | - Correct caddy: and caddy.reverse_proxy labels on the dozzle service. |
|
||||
| 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. |
|
||||
|- **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. |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -104,13 +104,15 @@ To restore the dozzle stack, run `./deploy.sh` from within the services/swarm/st
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-05 | 91e25326 | Updated dozzle configuration to use swarm mode. |
|
||||
| 2026-01-20 | 061ab0c2 | Initial setup of the dozzle service for NetGrimoire. |
|
||||
| 2026-04-05 | d9099f8f | Initial documentation creation. |
|
||||
| 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
|
||||
- Generated by Gremlin on 2026-04-05T05:08:49.282Z
|
||||
- Generated by Gremlin on 2026-04-05T05:10:20.507Z
|
||||
- Source: swarm/dozzle.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue