homelab-optimized/docs/services/individual/uptime-kuma.md

Uptime Kuma

🟢 Monitoring Service

📋 Service Overview

Property	Value
Service Name	uptime-kuma
Host	Atlantis
Category	Monitoring
Difficulty	🟢
Docker Image	louislam/uptime-kuma
Compose File	Atlantis/uptimekuma.yml
Directory	Atlantis

🎯 Purpose

uptime-kuma is a monitoring and observability tool that helps track system performance and health.

🚀 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 uptime-kuma

🔧 Configuration

Docker Compose Configuration

container_name: uptime_kuma
environment:
- PUID=1026
- PGID=100
- TZ=America/Los_Angeles
image: louislam/uptime-kuma
ports:
- 3444:3001
restart: always
volumes:
- /volume1/docker/uptimekuma:/app/data
- /var/run/docker.sock:/var/run/docker.sock

Environment Variables

Variable	Value	Description
PUID	1026	User ID for file permissions
PGID	100	Group ID for file permissions
TZ	America/Los_Angeles	Timezone setting

Port Mappings

Host Port	Container Port	Protocol	Purpose
3444	3001	TCP	Monitoring interface

Volume Mappings

Host Path	Container Path	Type	Purpose
/volume1/docker/uptimekuma	/app/data	bind	Application data
/var/run/docker.sock	/var/run/docker.sock	bind	Data storage

🌐 Access Information

Service ports: 3444:3001

🔒 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

⚠️ No health check configured Consider adding a health check:

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost:PORT/health"]
  interval: 30s
  timeout: 10s
  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

Metrics not collecting

• Check target endpoints are accessible
• Verify configuration syntax
• Check network connectivity

Useful Commands

# Check service status
docker-compose ps

# View real-time logs
docker-compose logs -f uptime-kuma

# Restart service
docker-compose restart uptime-kuma

# Update service
docker-compose pull uptime-kuma
docker-compose up -d uptime-kuma

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

📚 Additional Resources

• Official Documentation: Check the official docs for uptime-kuma
• Docker Hub: louislam/uptime-kuma
• Community Forums: Search for community discussions and solutions
• GitHub Issues: Check the project's GitHub for known issues

🔗 Related Services

Services REDACTED_APP_PASSWORD uptime-kuma:

• Grafana
• Prometheus
• Uptime Kuma
• Node Exporter

---

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/uptimekuma.yml