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

Db

🟢 Storage Service

📋 Service Overview

Property	Value
Service Name	db
Host	homelab_vm
Category	Storage
Difficulty	🟢
Docker Image	mariadb:11.4-noble
Compose File	homelab_vm/romm/romm.yaml
Directory	homelab_vm/romm

🎯 Purpose

db is a storage solution that manages data persistence, backup, or file sharing.

🚀 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/romm

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f db

🔧 Configuration

Docker Compose Configuration

container_name: RomM-DB
environment:
  MYSQL_DATABASE: romm
  MYSQL_PASSWORD: "REDACTED_PASSWORD"
  MYSQL_ROOT_PASSWORD: "REDACTED_PASSWORD"
  MYSQL_USER: rommuser
  TZ: America/Los_Angeles
image: mariadb:11.4-noble
restart: on-failure:5
security_opt:
- no-new-privileges:false
volumes:
- /mnt/atlantis_docker/romm/db:/var/lib/mysql:rw

Environment Variables

Variable	Value	Description
MYSQL_DATABASE	romm	Configuration variable
MYSQL_USER	rommuser	Configuration variable
MYSQL_PASSWORD	***MASKED***	Configuration variable
MYSQL_ROOT_PASSWORD	***MASKED***	MySQL root password
TZ	America/Los_Angeles	Timezone setting

Port Mappings

No ports exposed.

Volume Mappings

Host Path	Container Path	Type	Purpose
/mnt/atlantis_docker/romm/db	/var/lib/mysql	bind	Service data

🌐 Access Information

This service does not expose any web interfaces.

🔒 Security Considerations

• ✅ Security options configured
• ⚠️ 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

Useful Commands

# Check service status
docker-compose ps

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

# Restart service
docker-compose restart db

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

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

📚 Additional Resources

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

🔗 Related Services

Other services in the storage 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/romm/romm.yaml