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

docs/services/individual/firefly-db-backup.md

@@ -0,0 +1,189 @@
+# Firefly Db Backup
+
+**🟢 Other Service**
+
+## 📋 Service Overview
+
+| Property | Value |
+|----------|-------|
+| **Service Name** | firefly-db-backup |
+| **Host** | Atlantis |
+| **Category** | Other |
+| **Difficulty** | 🟢 |
+| **Docker Image** | `postgres` |
+| **Compose File** | `Atlantis/firefly.yml` |
+| **Directory** | `Atlantis` |
+
+## 🎯 Purpose
+
+firefly-db-backup 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
+```bash
+# 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 firefly-db-backup
+```
+
+## 🔧 Configuration
+
+### Docker Compose Configuration
+```yaml
+container_name: firefly-db-backup
+entrypoint: "bash -c 'bash -s < /dump/dump_\\`date +%d-%m-%Y\"_\"%H_%M_%S\\`.psql\
+  \ \n  (ls -t /dump/dump*.psql|head -n $$BACKUP_NUM_KEEP;ls /dump/dump*.psql)|sort|uniq\
+  \ -u|xargs rm -- {} \n  sleep $$BACKUP_FREQUENCY \ndone \nEOF'\n"
+environment:
+  BACKUP_FREQUENCY: 7d
+  BACKUP_NUM_KEEP: 10
+  PGDATABASE: firefly
+  PGHOST: firefly-db
+  PGPASSWORD: "REDACTED_PASSWORD"
+  PGUSER: firefly
+image: postgres
+networks:
+- internal
+volumes:
+- /volume1/docker/fireflydb:/dump
+- /etc/localtime:/etc/localtime:ro
+
+```
+
+### Environment Variables
+| Variable | Value | Description |
+|----------|-------|-------------|
+| `PGHOST` | `firefly-db` | Configuration variable |
+| `PGDATABASE` | `firefly` | Configuration variable |
+| `PGUSER` | `firefly` | Configuration variable |
+| `PGPASSWORD` | `***MASKED***` | Configuration variable |
+| `BACKUP_NUM_KEEP` | `10` | Configuration variable |
+| `BACKUP_FREQUENCY` | `7d` | Configuration variable |
+
+
+### Port Mappings
+No ports exposed.
+
+### Volume Mappings
+| Host Path | Container Path | Type | Purpose |
+|-----------|----------------|------|----------|
+| `/volume1/docker/fireflydb` | `/dump` | bind | Data storage |
+| `/etc/localtime` | `/etc/localtime` | bind | Configuration files |
+
+
+## 🌐 Access Information
+
+This service does not expose any web interfaces.
+
+## 🔒 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 firefly-db-backup
+
+# Restart service
+docker-compose restart firefly-db-backup
+
+# Update service
+docker-compose pull firefly-db-backup
+docker-compose up -d firefly-db-backup
+
+# Access service shell
+docker-compose exec firefly-db-backup /bin/bash
+# or
+docker-compose exec firefly-db-backup /bin/sh
+```
+
+## 📚 Additional Resources
+
+- **Official Documentation**: Check the official docs for firefly-db-backup
+- **Docker Hub**: [Official firefly-db-backup](https://hub.docker.com/_/postgres)
+- **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/firefly.yml`