Netgrimoire/Netgrimoire/Services/dockpeek/dockpeek.md

3.2 KiB

title description published date tags editor dateCreated
dockpeek Stack Dockpeek services for NetGrimoire true 2026-04-30T03:20:09.765Z docker,swarm,dockpeek,netgrimoire markdown 2026-04-30T03:20:09.765Z

dockpeek

Overview

Dockpeek is a set of services used to provide monitoring and other tools in NetGrimoire. It includes the dockpeek service, which provides an interface for accessing monitoring data.

Architecture

| Service | Image | Port | Role | |- dockpeek | dockpeek/dockpeek:latest | 3420 | Monitoring |

Exposed via:

  • caddy-dockpeek.netgrimoire.com

Homepage group: "Monitoring"


Build & Configuration

Prerequisites

No specific prerequisites are required for this stack.

Volume Setup

mkdir -p /DockerVol/dockpeek
chown -R 1964:1964 /DockerVol/dockpeek

Environment Variables

SECRET_KEY=$(openssl rand -hex 32)
USERNAME=traveler
PASSWORD=F@lcon13

Deploy

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 deploying the service, navigate to caddy-dockpeek.netgrimoire.com to access the dashboard.


User Guide

Accessing dockpeek

| Service | URL | Purpose | |- dockpeek | caddy-dockpeek.netgrimoire.com | Monitoring Dashboard |

Primary Use Cases

To view monitoring data, navigate to caddy-dockpeek.netgrimoire.com and log in with the provided credentials.

NetGrimoire Integrations

The dockpeek service integrates with other services in NetGrimoire through environment variables and labels. Specifically, it connects to the Uptime Kuma dashboard for monitoring data.


Operations

Monitoring

docker stack services dockpeek
docker service logs dockpeek

Backups

Critical data is stored on /DockerVol/dockpeek. Non-critical data can be reconstructed from backups of this volume.

Restore

cd services/swarm/stack/dockpeek
./deploy.sh

Common Failures

| Symptom | Cause | Fix | |- dockpeek service not starting | Insufficient resources or incorrect deployment configuration. | Check the deployment logs and adjust the configuration as needed. | |- Monitoring data not updating | Inconsistent data from upstream services. | Verify that upstream services are providing consistent data and update accordingly. |


Changelog

| Date | Commit | Summary | |- 2026-04-29 | 2256faaa | Initial deployment of dockpeek stack | |- 2026-01-26 | 7e49e367 | Updated environment variables for better security | |- 2026-01-26 | a0b6663e | Improved logging and monitoring configuration | |- 2026-01-10 | 1a374911 | Initial deployment of dockpeek stack |

The dockpeek stack has undergone several changes since its initial deployment in January 2026. These changes have improved the security and reliability of the service, including updates to environment variables and logging configurations.

Notes

  • Generated by Gremlin on 2026-04-30T03:20:09.765Z
  • Source: swarm/dockpeek.yaml
  • Review User Guide and Changelog sections