homelab-optimized/docs/services/individual/dockpeek.md

Dockpeek

🟢 Other Service

📋 Service Overview

Property	Value
Service Name	dockpeek
Host	Atlantis
Category	Other
Difficulty	🟢
Docker Image	ghcr.io/dockpeek/dockpeek:latest
Compose File	Atlantis/dockpeek.yml
Directory	Atlantis

🎯 Purpose

dockpeek is a specialized service that provides specific functionality for the homelab infrastructure.

🚀 Quick Start

Prerequisites

• Docker and Docker Compose installed
• Basic understanding of REDACTED_APP_PASSWORD
• Access to the host system (Atlantis)

Deployment

# Navigate to service directory
cd Atlantis

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f dockpeek

🔧 Configuration

Docker Compose Configuration

container_name: Dockpeek
environment:
  DOCKER_HOST: unix:///var/run/docker.sock
  PASSWORD: "REDACTED_PASSWORD"
  SECRET_KEY: REDACTED_SECRET_KEY
  USERNAME: vish
healthcheck:
  interval: 10s
  retries: 3
  start_period: 90s
  test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/8000' || exit 1
  timeout: 5s
image: ghcr.io/dockpeek/dockpeek:latest
ports:
- 3812:8000
restart: on-failure:5
volumes:
- /var/run/docker.sock:/var/run/docker.sock

Environment Variables

Variable	Value	Description
SECRET_KEY	***MASKED***	Application secret key
USERNAME	vish	Configuration variable
PASSWORD	***MASKED***	Configuration variable
DOCKER_HOST	unix:///var/run/docker.sock	Configuration variable

Port Mappings

Host Port	Container Port	Protocol	Purpose
3812	8000	TCP	Service port

Volume Mappings

Host Path	Container Path	Type	Purpose
/var/run/docker.sock	/var/run/docker.sock	bind	Data storage

🌐 Access Information

Web Interface

• HTTP: http://Atlantis:3812

Default Credentials

Refer to service documentation for default credentials

🔒 Security Considerations

• ⚠️ Consider adding security options (no-new-privileges)
• ⚠️ Consider running as non-root user

📊 Resource Requirements

No resource limits configured

Recommended Resources

• Minimum RAM: 512MB
• Recommended RAM: 1GB+
• CPU: 1 core minimum
• Storage: Varies by usage

Resource Monitoring

Monitor resource usage with:

docker stats

🔍 Health Monitoring

✅ Health check configured Test Command: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/8000' || exit 1 Check Interval: 10s Timeout: 5s Retries: 3

Manual Health Checks

# Check container health
docker inspect --format='{{.State.Health.Status}}' CONTAINER_NAME

# View health check logs
docker inspect --format='{{range .State.Health.Log}}{{.Output}}{{end}}' CONTAINER_NAME

🚨 Troubleshooting

Common Issues

Service won't start

• Check Docker logs: docker-compose logs service-name
• Verify port availability: netstat -tulpn | grep PORT
• Check file permissions on mounted volumes

Can't access web interface

• Verify service is running: docker-compose ps
• Check firewall settings
• Confirm correct port mapping

Performance issues

• Monitor resource usage: docker stats
• Check available disk space: df -h
• Review service logs for errors

Useful Commands

# Check service status
docker-compose ps

# View real-time logs
docker-compose logs -f dockpeek

# Restart service
docker-compose restart dockpeek

# Update service
docker-compose pull dockpeek
docker-compose up -d dockpeek

# Access service shell
docker-compose exec dockpeek /bin/bash
# or
docker-compose exec dockpeek /bin/sh

📚 Additional Resources

• Official Documentation: Check the official docs for dockpeek
• Docker Hub: ghcr.io/dockpeek/dockpeek:latest
• Community Forums: Search for community discussions and solutions
• GitHub Issues: Check the project's GitHub for known issues

🔗 Related Services

Other services in the other category on Atlantis

---

This documentation is auto-generated from the Docker Compose configuration. For the most up-to-date information, refer to the official documentation and the actual compose file.

Last Updated: 2025-11-17
Configuration Source: Atlantis/dockpeek.yml