---

# dockpeek Stack
description: Dockpeek service for NetGrimoire monitoring

---
### Overview
Dockpeek is a monitoring tool used in NetGrimoire to monitor services, including Docker containers. The stack consists of the dockpeek service running on docker4 with an overlay network and exposed via Caddy.

---
### Architecture
| Service | Image | Port | Role |
|---------|-------|-----|------|
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** `dockpeek.netgrimoire.com`
- **Homepage group:** Monitoring

---
### Build & Configuration

### Prerequisites
You need to have Docker, Docker Swarm, and Caddy installed on the manager node.

### Volume Setup
```bash
mkdir -p /DockerVol/dockpeek
chown -R 1964:1964 /DockerVol/dockpeek
```

### Environment Variables
```bash
SECRET_KEY=$(openssl rand -hex 32)
USERNAME=traveler
PASSWORD=F@lcon13
PUID=$(openssl rand -hex 8)
PGID=$(openssl rand -hex 8)
TZ=America/Chicago
```

### Deploy
```bash
cd services/swarm/stack/dockpeek
set -a && source .env && set +a
docker stack config --compose-file dockpeek-stack.yml > resolved.yml
docker stack deploy --compose-file resolved.yml dockpeek
rm resolved.yml
docker stack services dockpeek
```

### First Run
After deployment, you need to run `./deploy.sh` to complete the setup.

---
### User Guide

### Accessing dockpeek
| Service | URL | Purpose |
- **dockpeek** | http://dockpeek.netgrimoire.com:8000 | Monitoring tool |

### Primary Use Cases
To access dockpeek, use the provided URL. The service is used for monitoring purposes in NetGrimoire.

### NetGrimoire Integrations
The dockpeek service integrates with other services in NetGrimoire, including Authentik and Crowds.

---
### Operations

### Monitoring
```bash
docker stack services dockpeek
docker service logs dockpeek
```

### Backups
Critical data should be backed up to /DockerVol/dockpeek. Reconstructing from backups is possible.

### Restore
```bash
./deploy.sh
```

---
### Common Failures

| Symptom | Cause | Fix |
|---------|------|-----|
| Service not accessible | Caddy not running | Restart Caddy service |
| Docker container failed to deploy | Incorrect environment variables | Correct environment variable values in .env file |

---
### Changelog

| Date | Commit | Summary |
|------|--------|---------|
| 2026-05-05 | d8f5af61 | Initial documentation and deployment script creation |
| 2026-05-05 | 9d423d1b | Fixed incorrect environment variable values |
| 2026-05-01 | c3b0c0f5 | Updated deploy script to use resolved.yml |
| 2026-04-29 | 39f3f45c | Added backup and restore instructions |
| 2026-04-29 | 2256faaa | Fixed Caddy configuration for internal service |
| 2026-01-26 | 7e49e367 | Initial documentation creation |

---
### Notes
Generated by Gremlin on 2026-05-05T18:48:36.638Z
Source: swarm/dockpeek.yaml