docs(gremlin): create dozzle
This commit is contained in:
parent
9ee8f7790f
commit
7f92e4d099
1 changed files with 117 additions and 0 deletions
117
Netgrimoire/Services/dozzle/dozzle.md
Normal file
117
Netgrimoire/Services/dozzle/dozzle.md
Normal file
|
|
@ -0,0 +1,117 @@
|
||||||
|
---
|
||||||
|
title: dozzle Stack
|
||||||
|
description: Docker log viewer for NetGrimoire
|
||||||
|
published: true
|
||||||
|
date: 2026-04-30T03:24:04.231Z
|
||||||
|
tags: docker,swarm,dozzle,netgrimoire
|
||||||
|
editor: markdown
|
||||||
|
dateCreated: 2026-04-30T03:24:04.231Z
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# dozzle
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The dozzle stack is a Docker Swarm configuration for NetGrimoire that provides a Docker log viewer service.
|
||||||
|
|
||||||
|
---
|
||||||
|
## Architecture
|
||||||
|
| Service | Image | Port | Role |
|
||||||
|
|---------|-------|-----|------|
|
||||||
|
- **Host:** docker4
|
||||||
|
- **Network:** netgrimoire
|
||||||
|
- **Exposed via:** `dozzle.netgrimoire.com`
|
||||||
|
- **Homepage group:** Management
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Build & Configuration
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
This service requires the `docker` and `caddy` Docker Swarm modes to be enabled.
|
||||||
|
|
||||||
|
### Volume Setup
|
||||||
|
```bash
|
||||||
|
mkdir -p /DockerVol/dozzle
|
||||||
|
chown -R docker4:docker4 /DockerVol/dozzle
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environment Variables
|
||||||
|
```bash
|
||||||
|
generate: openssl rand -hex 32
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deploy
|
||||||
|
```bash
|
||||||
|
cd services/swarm/stack/dozzle
|
||||||
|
set -a && source .env && set +a
|
||||||
|
docker stack config --compose-file dozzle-stack.yml > resolved.yml
|
||||||
|
docker stack deploy --compose-file resolved.yml dozzle
|
||||||
|
rm resolved.yml
|
||||||
|
docker stack services dozzle
|
||||||
|
```
|
||||||
|
|
||||||
|
### First Run
|
||||||
|
After deployment, the first run requires initializing the Docker log collector and indexer.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## User Guide
|
||||||
|
|
||||||
|
### Accessing dozzle
|
||||||
|
| Service | URL |
|
||||||
|
|---------|-----|
|
||||||
|
- **Host:** `dozzle.netgrimoire.com`
|
||||||
|
- **Internal only:**
|
||||||
|
|
||||||
|
### Primary Use Cases
|
||||||
|
To use this service in NetGrimoire, you need to add the Docker log viewer to your workflow or dashboard.
|
||||||
|
|
||||||
|
### NetGrimoire Integrations
|
||||||
|
This service connects to other NetGrimoire services via environment variables and labels.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Operations
|
||||||
|
|
||||||
|
### Monitoring
|
||||||
|
[kuma monitors: kuma.dozzle.http.name: Dozzle, kuma.dozzle.http.url: https://dozzle.netgrimoire.com]
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker stack services dozzle
|
||||||
|
docker service logs -f dozzle
|
||||||
|
```
|
||||||
|
|
||||||
|
### Backups
|
||||||
|
The Docker log data is stored in the `/DockerVol/dozzle` volume. To backup this data, use a critical backup process.
|
||||||
|
|
||||||
|
### Restore
|
||||||
|
To restore the data from a backup, run the `deploy.sh` script.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Common Failures
|
||||||
|
| Symptom | Cause | Fix |
|
||||||
|
|---------|-------|-----|
|
||||||
|
- Service not available | Caddy failed to start | Check caddy logs and restart service |
|
||||||
|
- No log data is displayed | Docker logs collector index not updated | Run `./deploy.sh` to update and re-index |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
| Date | Commit | Summary |
|
||||||
|
|------|--------|---------|
|
||||||
|
| 2026-04-29 | 25bfdb39 | Initial documentation creation |
|
||||||
|
| 2026-04-05 | d9099f8f | Initial configuration changes |
|
||||||
|
| 2026-04-05 | 91e25326 | Network and Caddy changes |
|
||||||
|
| 2026-01-20 | 061ab0c2 | Initial release |
|
||||||
|
|
||||||
|
<The dozzle stack was initially created to provide a Docker log viewer service for NetGrimoire. Since its inception, the service has undergone several configuration changes to improve performance and stability.>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Generated by Gremlin on 2026-04-30T03:24:04.231Z
|
||||||
|
- Source: swarm/dozzle.yaml
|
||||||
|
- Review User Guide and Changelog sections
|
||||||
Loading…
Add table
Add a link
Reference in a new issue