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

Ntfy

🟢 Other Service

📋 Service Overview

Property	Value
Service Name	ntfy
Host	homelab_vm
Category	Other
Difficulty	🟢
Docker Image	binwiederhier/ntfy
Compose File	homelab_vm/ntfy.yaml
Directory	homelab_vm

🎯 Purpose

ntfy 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 (homelab_vm)

Deployment

# Navigate to service directory
cd homelab_vm

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f ntfy

🔧 Configuration

Docker Compose Configuration

command:
- serve
container_name: NTFY
environment:
- TZ=America/Los_Angeles
healthcheck:
  interval: 60s
  retries: 3
  start_period: 40s
  test:
  - CMD-SHELL
  - wget -q --tries=1 http://localhost:80/v1/health -O - | grep -Eo '"healthy"\s*:\s*true'
    || exit 1
  timeout: 10s
image: binwiederhier/ntfy
ports:
- 8081:80
restart: on-failure:5
volumes:
- /home/homelab/docker/ntfy:/var/cache/ntfy:rw
- /home/homelab/docker/ntfy/config:/etc/ntfy:rw

Environment Variables

Variable	Value	Description
TZ	America/Los_Angeles	Timezone setting

Port Mappings

Host Port	Container Port	Protocol	Purpose
8081	80	TCP	HTTP web interface

Volume Mappings

Host Path	Container Path	Type	Purpose
/home/homelab/docker/ntfy	/var/cache/ntfy	bind	Cache data
/home/homelab/docker/ntfy/config	/etc/ntfy	bind	Configuration files

🌐 Access Information

Web Interface

• HTTP: http://homelab_vm:8081

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: CMD-SHELL wget -q --tries=1 http://localhost:80/v1/health -O - | grep -Eo '"healthy"\s*:\s*true' || exit 1 Check Interval: 60s 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

Useful Commands

# Check service status
docker-compose ps

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

# Restart service
docker-compose restart ntfy

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

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

📚 Additional Resources

• 🔔 Comprehensive ntfy System Documentation: ../admin/ntfy-notification-system.md - Complete guide to the homelab notification system
• 🚀 Quick Reference Guide: ../admin/ntfy-quick-reference.md - Quick commands and common tasks
• 🧪 Test Script: ../../scripts/test-ntfy-notifications.sh - Automated notification testing
• Official Documentation: ntfy.sh
• Docker Hub: binwiederhier/ntfy

🔗 Related Services

Other services in the other category on homelab_vm

---

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: homelab_vm/ntfy.yaml