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

Romm

🟡 Other Service

📋 Service Overview

Property	Value
Service Name	romm
Host	homelab_vm
Category	Other
Difficulty	🟡
Docker Image	rommapp/romm:latest
Compose File	homelab_vm/romm/romm.yaml
Directory	homelab_vm/romm

🎯 Purpose

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

# Start the service
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f romm

🔧 Configuration

Docker Compose Configuration

container_name: RomM
depends_on:
- db
environment:
  DB_HOST: db
  DB_NAME: romm
  DB_PASSWD: "REDACTED_PASSWORD"
  DB_PORT: 3306
  DB_USER: rommuser
  ROMM_AUTH_SECRET_KEY: REDACTED_SECRET_KEY
  ROMM_DB_DRIVER: mariadb
healthcheck:
  interval: 10s
  retries: 3
  start_period: 90s
  test:
  - CMD
  - curl
  - -f
  - http://127.0.0.1:8080/
  timeout: 5s
image: rommapp/romm:latest
ports:
- 7676:8080
restart: on-failure:10
volumes:
- /mnt/atlantis_docker/romm/resources:/romm/resources:rw
- /mnt/atlantis_docker/romm/redis:/redis-data:rw
- /mnt/atlantis_docker/romm/games/library:/romm/library:rw
- /mnt/atlantis_docker/romm/games/assets:/romm/assets:rw
- /mnt/atlantis_docker/romm/games/config:/romm/config:rw

Environment Variables

Variable	Value	Description
ROMM_DB_DRIVER	mariadb	Configuration variable
DB_HOST	db	Configuration variable
DB_NAME	romm	Configuration variable
DB_USER	rommuser	Configuration variable
DB_PASSWD	rommpass	Configuration variable
DB_PORT	3306	Configuration variable
ROMM_AUTH_SECRET_KEY	***MASKED***	Application secret key

Port Mappings

Host Port	Container Port	Protocol	Purpose
7676	8080	TCP	Alternative HTTP port

Volume Mappings

Host Path	Container Path	Type	Purpose
/mnt/atlantis_docker/romm/resources	/romm/resources	bind	Data storage
/mnt/atlantis_docker/romm/redis	/redis-data	bind	Data storage
/mnt/atlantis_docker/romm/games/library	/romm/library	bind	Data storage
/mnt/atlantis_docker/romm/games/assets	/romm/assets	bind	Data storage
/mnt/atlantis_docker/romm/games/config	/romm/config	bind	Configuration files

🌐 Access Information

Web Interface

• HTTP: http://homelab_vm:7676

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 curl -f http://127.0.0.1:8080/ Check Interval: 10s Timeout: 5s 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 romm

# Restart service
docker-compose restart romm

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

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

📚 Additional Resources

• Official Documentation: Check the official docs for romm
• Docker Hub: rommapp/romm:latest
• 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/romm/romm.yaml