docs(gremlin): create dozzle
This commit is contained in:
parent
5778ed1f1e
commit
8b9ebe3675
1 changed files with 116 additions and 0 deletions
116
Netgrimoire/Services/dozzle/dozzle.md
Normal file
116
Netgrimoire/Services/dozzle/dozzle.md
Normal file
|
|
@ -0,0 +1,116 @@
|
||||||
|
---
|
||||||
|
title: dozzle Stack
|
||||||
|
description: Docker log viewer for NetGrimoire
|
||||||
|
published: true
|
||||||
|
date: 2026-04-05T05:08:49.282Z
|
||||||
|
tags: docker,swarm,dozzle,netgrimoire
|
||||||
|
editor: markdown
|
||||||
|
dateCreated: 2026-04-05T05:08:49.282Z
|
||||||
|
---
|
||||||
|
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
| Service | Image | Port | Role |
|
||||||
|
|---------|-------|------|------|
|
||||||
|
- **Host:** docker4
|
||||||
|
- **Network:** netgrimoire
|
||||||
|
- **Exposed via:** dozzle.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.
|
||||||
|
|
||||||
|
### Volume Setup
|
||||||
|
```bash
|
||||||
|
mkdir -p /DockerVol/dozzle
|
||||||
|
chown 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
|
||||||
|
Perform the following steps after deploying the dozzle stack:
|
||||||
|
- Verify the Caddy reverse proxy is working correctly.
|
||||||
|
- Configure any additional security settings as needed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## User Guide
|
||||||
|
|
||||||
|
### 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
|
||||||
|
|
||||||
|
### 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.
|
||||||
|
|
||||||
|
### 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.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Operations
|
||||||
|
|
||||||
|
### Monitoring
|
||||||
|
Use Uptime Kuma to monitor the dozzle service:
|
||||||
|
```bash
|
||||||
|
docker stack services dozzle
|
||||||
|
docker service logs -f dozzle | grep "Error"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Backups
|
||||||
|
Critical vs reconstructable Docker volumes are `/DockerVol/dozzle`.
|
||||||
|
|
||||||
|
### Restore
|
||||||
|
To restore the dozzle stack, run `./deploy.sh` from within the services/swarm/stack/dozzle directory.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 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. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
| 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. |
|
||||||
|
|
||||||
|
<Note: This stack was created on 2026-04-05T05:08:49.282Z and last updated on the same date due to lack of commits>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Generated by Gremlin on 2026-04-05T05:08:49.282Z
|
||||||
|
- Source: swarm/dozzle.yaml
|
||||||
Loading…
Add table
Add a link
Reference in a new issue