Sanitized mirror from private repository - 2026-04-18 11:19:59 UTC

docs/services/individual/ddns-updater.md

@@ -0,0 +1,215 @@
+# Ddns Updater
+
+**🟢 Other Service**
+
+## 📋 Service Overview
+
+| Property | Value |
+|----------|-------|
+| **Service Name** | ddns-updater |
+| **Host** | homelab_vm |
+| **Category** | Other |
+| **Difficulty** | 🟢 |
+| **Docker Image** | `qmcgaw/ddns-updater` |
+| **Compose File** | `homelab_vm/ddns.yml` |
+| **Directory** | `homelab_vm` |
+
+## 🎯 Purpose
+
+ddns-updater 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
+```bash
+# 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 ddns-updater
+```
+
+## 🔧 Configuration
+
+### Docker Compose Configuration
+```yaml
+container_name: ddns-updater
+environment:
+- CONFIG=
+- PERIOD=5m
+- UPDATE_COOLDOWN_PERIOD=5m
+- PUBLICIP_FETCHERS=all
+- PUBLICIP_HTTP_PROVIDERS=all
+- PUBLICIPV4_HTTP_PROVIDERS=all
+- PUBLICIPV6_HTTP_PROVIDERS=all
+- PUBLICIP_DNS_PROVIDERS=all
+- PUBLICIP_DNS_TIMEOUT=3s
+- HTTP_TIMEOUT=10s
+- LISTENING_PORT=8000
+- ROOT_URL=/
+- BACKUP_PERIOD=0
+- BACKUP_DIRECTORY=/updater/data
+- LOG_LEVEL=info
+- LOG_CALLER=hidden
+- SHOUTRRR_ADDRESSES=
+image: qmcgaw/ddns-updater
+network_mode: bridge
+ports:
+- 8000:8000/tcp
+restart: always
+volumes:
+- /home/homelab/docker/ddns/data:/updater/data
+
+```
+
+### Environment Variables
+| Variable | Value | Description |
+|----------|-------|-------------|
+| `CONFIG` | `` | Configuration variable |
+| `PERIOD` | `5m` | Configuration variable |
+| `UPDATE_COOLDOWN_PERIOD` | `5m` | Configuration variable |
+| `PUBLICIP_FETCHERS` | `all` | Configuration variable |
+| `PUBLICIP_HTTP_PROVIDERS` | `all` | Configuration variable |
+| `PUBLICIPV4_HTTP_PROVIDERS` | `all` | Configuration variable |
+| `PUBLICIPV6_HTTP_PROVIDERS` | `all` | Configuration variable |
+| `PUBLICIP_DNS_PROVIDERS` | `all` | Configuration variable |
+| `PUBLICIP_DNS_TIMEOUT` | `3s` | Configuration variable |
+| `HTTP_TIMEOUT` | `10s` | Configuration variable |
+| `LISTENING_PORT` | `8000` | Configuration variable |
+| `ROOT_URL` | `/` | Configuration variable |
+| `BACKUP_PERIOD` | `0` | Configuration variable |
+| `BACKUP_DIRECTORY` | `/updater/data` | Configuration variable |
+| `LOG_LEVEL` | `info` | Logging verbosity level |
+| `LOG_CALLER` | `hidden` | Configuration variable |
+| `SHOUTRRR_ADDRESSES` | `` | Configuration variable |
+
+
+### Port Mappings
+| Host Port | Container Port | Protocol | Purpose |
+|-----------|----------------|----------|----------|
+| 8000 | 8000 | TCP | Service port |
+
+
+### Volume Mappings
+| Host Path | Container Path | Type | Purpose |
+|-----------|----------------|------|----------|
+| `/home/homelab/docker/ddns/data` | `/updater/data` | bind | Application data |
+
+
+## 🌐 Access Information
+
+### Web Interface
+- **HTTP**: `http://homelab_vm:8000`
+
+### 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:
+```bash
+docker stats
+```
+
+## 🔍 Health Monitoring
+
+⚠️ No health check configured
+Consider adding a health check:
+```yaml
+healthcheck:
+  test: ["CMD", "curl", "-f", "http://localhost:PORT/health"]
+  interval: 30s
+  timeout: 10s
+  retries: 3
+```
+
+### Manual Health Checks
+```bash
+# 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
+```bash
+# Check service status
+docker-compose ps
+
+# View real-time logs
+docker-compose logs -f ddns-updater
+
+# Restart service
+docker-compose restart ddns-updater
+
+# Update service
+docker-compose pull ddns-updater
+docker-compose up -d ddns-updater
+
+# Access service shell
+docker-compose exec ddns-updater /bin/bash
+# or
+docker-compose exec ddns-updater /bin/sh
+```
+
+## 📚 Additional Resources
+
+- **Official Documentation**: Check the official docs for ddns-updater
+- **Docker Hub**: [qmcgaw/ddns-updater](https://hub.docker.com/r/qmcgaw/ddns-updater)
+- **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 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/ddns.yml`