Files
homelab-optimized/docs/services/individual/firefly-db.md
Gitea Mirror Bot e7435fb92b
Some checks failed
Documentation / Build Docusaurus (push) Failing after 17m42s
Documentation / Deploy to GitHub Pages (push) Has been skipped
Sanitized mirror from private repository - 2026-04-06 10:21:40 UTC
2026-04-06 10:21:40 +00:00

4.0 KiB

Firefly Db

🟢 Other Service

📋 Service Overview

Property Value
Service Name firefly-db
Host Atlantis
Category Other
Difficulty 🟢
Docker Image postgres
Compose File Atlantis/firefly.yml
Directory Atlantis

🎯 Purpose

firefly-db 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 firefly-db

🔧 Configuration

Docker Compose Configuration

container_name: firefly-db
environment:
  POSTGRES_DB: firefly
  POSTGRES_PASSWORD: "REDACTED_PASSWORD"
  POSTGRES_USER: firefly
image: postgres
networks:
- internal
restart: always
volumes:
- /volume1/docker/fireflydb:/var/lib/postgresql/data

Environment Variables

Variable Value Description
POSTGRES_DB firefly Configuration variable
POSTGRES_USER firefly Configuration variable
POSTGRES_PASSWORD ***MASKED*** PostgreSQL password

Port Mappings

No ports exposed.

Volume Mappings

Host Path Container Path Type Purpose
/volume1/docker/fireflydb /var/lib/postgresql/data bind Application data

🌐 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

  • 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

Useful Commands

# Check service status
docker-compose ps

# View real-time logs
docker-compose logs -f firefly-db

# Restart service
docker-compose restart firefly-db

# Update service
docker-compose pull firefly-db
docker-compose up -d firefly-db

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

📚 Additional Resources

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

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