Nomploy Nomad Packs

← All packs

romm v0.1.0

Media

RomM — a self-hosted ROM manager and player: scan, organize, enrich (IGDB/ScreenScraper) and play your retro game library from the browser. Deployed as an all-in-one host-networked Nomad job (MariaDB + the RomM app, which bundles its own Redis).

nomad-pack run romm --registry nomploy
…or one line (add registry + run)
curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- romm

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

2 tasks http 8080db 3306 6 volumes image rommapp/romm:latest tracks :latest image bumped today
Variables 21
values.hcl

Save as values.hcl, edit, then run:

nomad-pack run romm -f values.hcl --registry nomploy
# The name of the Nomad job.
job_name = "romm"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The RomM container image. Pin a tag in production.
image = "rommapp/romm:latest"

# The MariaDB image for the bundled database.
mariadb_image = "mariadb:11"

# Host port for the RomM web UI.
port = 8080

# Host port for the bundled MariaDB (loopback only).
db_port = 3306

# Password for the RomM MariaDB user. CHANGE THIS.
db_password = "romm_change_me"

# Root password for the bundled MariaDB. CHANGE THIS.
db_root_password = "romm_root_change_me"

# Secret used to sign sessions (openssl rand -hex 32). CHANGE THIS and keep it stable.
auth_secret_key = "0000000000000000000000000000000000000000000000000000000000000000"

# IGDB (Twitch) client ID for metadata scraping. Optional — leave blank to configure later.
igdb_client_id = ""

# IGDB (Twitch) client secret for metadata scraping. Optional — leave blank to configure later.
igdb_client_secret = ""

# Named volume for the ROM library. Point this at a host path with your ROMs for real use (e.g. a bind mount).
library_volume = "romm_library"

# Named volume for RomM resources (artwork, metadata).
resources_volume = "romm_resources"

# Named volume for RomM user assets (saves, states, screenshots).
assets_volume = "romm_assets"

# Named volume for RomM config.
config_volume = "romm_config"

# Named volume for the bundled Redis data.
redis_volume = "romm_redis_data"

# Named volume for MariaDB data.
db_data_volume = "romm_db_data"

# Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# Resources for the RomM app task.
resources = {
    cpu    = 1000
    memory = 1024
  }

# Resources for the bundled MariaDB task.
db_resources = {
    cpu    = 500
    memory = 512
  }
NameTypeDefaultDescription
job_name string
"romm"
The name of the Nomad job.
namespace string
"default"
The Nomad namespace to deploy into.
datacenters list
["*"]
The datacenters to deploy to.
image string
"rommapp/romm:latest"
The RomM container image. Pin a tag in production.
mariadb_image string
"mariadb:11"
The MariaDB image for the bundled database.
port number
8080
Host port for the RomM web UI.
db_port number
3306
Host port for the bundled MariaDB (loopback only).
db_password set me string
"romm_change_me"
Password for the RomM MariaDB user. CHANGE THIS.
db_root_password set me string
"romm_root_change_me"
Root password for the bundled MariaDB. CHANGE THIS.
auth_secret_key key string
"0000000000000000000000000000000000000000000000000000000000000000"
Secret used to sign sessions (openssl rand -hex 32). CHANGE THIS and keep it stable.
igdb_client_id string
""
IGDB (Twitch) client ID for metadata scraping. Optional — leave blank to configure later.
igdb_client_secret key string
""
IGDB (Twitch) client secret for metadata scraping. Optional — leave blank to configure later.
library_volume string
"romm_library"
Named volume for the ROM library. Point this at a host path with your ROMs for real use (e.g. a bind mount).
resources_volume string
"romm_resources"
Named volume for RomM resources (artwork, metadata).
assets_volume string
"romm_assets"
Named volume for RomM user assets (saves, states, screenshots).
config_volume string
"romm_config"
Named volume for RomM config.
redis_volume string
"romm_redis_data"
Named volume for the bundled Redis data.
db_data_volume string
"romm_db_data"
Named volume for MariaDB data.
constraints list
[]
Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources object
{
    cpu    = 1000
    memory = 1024
  }
Resources for the RomM app task.
db_resources object
{
    cpu    = 500
    memory = 512
  }
Resources for the bundled MariaDB task.
Back up this pack

This pack stores data in 6 Docker named volumes: romm_db_dataromm_resourcesromm_redis_dataromm_libraryromm_assetsromm_config

⚠ This pack bundles a database. A cold copy of the volume can be inconsistent — for a reliable backup, dump the DB (pg_dump / mysqldump) or stop the job while backing up.

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/romm_db_data/_data \
  /var/lib/docker/volumes/romm_resources/_data \
  /var/lib/docker/volumes/romm_redis_data/_data \
  /var/lib/docker/volumes/romm_library/_data \
  /var/lib/docker/volumes/romm_assets/_data \
  /var/lib/docker/volumes/romm_config/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/romm_db_data/_data backup:<bucket>/romm_db_data
rclone sync /var/lib/docker/volumes/romm_resources/_data backup:<bucket>/romm_resources
rclone sync /var/lib/docker/volumes/romm_redis_data/_data backup:<bucket>/romm_redis_data
rclone sync /var/lib/docker/volumes/romm_library/_data backup:<bucket>/romm_library
rclone sync /var/lib/docker/volumes/romm_assets/_data backup:<bucket>/romm_assets
rclone sync /var/lib/docker/volumes/romm_config/_data backup:<bucket>/romm_config

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

romm

RomM is a self-hosted ROM manager and player — scan and organize your retro game library, enrich it with artwork and metadata from IGDB / ScreenScraper / LaunchBox / MobyGames, and play games straight from your browser.

This pack runs RomM all-in-one as a single host-networked Nomad job:

All tasks share the host network and talk over 127.0.0.1, so no mesh networking is required. Database migrations run automatically on first start.

Quick start

nomad-pack run romm --registry=nomploy

Then open http://<node-ip>:8080 and create the first admin account.

Configuration

Variable Default Notes
port 8080 Web UI host port
db_password change me RomM MariaDB user password
db_root_password change me MariaDB root password
auth_secret_key 0000… Session signing key (openssl rand -hex 32) — keep stable
igdb_client_id / igdb_client_secret (blank) IGDB (Twitch) keys for metadata scraping
library_volume romm_library Where your ROMs live — point at a host path for real use

Change every secret before deploying anywhere real, and keep auth_secret_key stable.

Your ROM library

ROMs go under /romm/library, backed by library_volume. For real use, set library_volume to a host path (a bind mount) that already holds your game files, laid out as RomM expects (library/roms/<platform>/...). See the RomM docs for the folder structure.

Metadata providers

Set igdb_client_id and igdb_client_secret (from a Twitch developer app) to enable IGDB scraping. Other providers (ScreenScraper, SteamGridDB, RetroAchievements) can be added later via their own environment variables.

Data persists in the romm_db_data, romm_resources, romm_assets, romm_config, romm_redis_data and romm_library named volumes.