Self-host RomM on a VPS

A self-hosted retro game library manager. It scans your ROM collection, matches metadata and cover art, and lets you browse, search and play games in the browser. Runs with a bundled MariaDB database. On first open, the setup page asks you to create the admin login.

levelrail-cli templates install romm --name my-romm

Specification

Status
Listed
Category
Media
Services
db, romm
Ports
8080
Volumes
6
Memory
about 1 GiB
arm64
image published
amd64
image published
Settings to fill in
none
Listing
Community template

About RomM

A self-hosted retro game library manager. It scans your ROM collection, matches metadata and cover art, and lets you browse, search and play games in the browser. Runs with a bundled MariaDB database. On first open, the setup page asks you to create the admin login.

What it deploys

RomM runs as 2 services in a single Compose app, listening on port 8080, with 6 named volume mounts.

ServiceImageTagPortsVolumes
db mariadb 11.8.9 none dbdata -> /var/lib/mysql
romm rommapp/romm 5.4.1 8080 resources -> /romm/resourceslibrary -> /romm/libraryassets -> /romm/assetsconfig -> /romm/configredis -> /redis-data

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.

Settings and environment

You do not have to fill in anything. 4 secrets are generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
dbMARIADB_DATABASEPreset by the template
dbMARIADB_PASSWORDGenerated at deploy
dbMARIADB_ROOT_PASSWORDGenerated at deploy
dbMARIADB_USERPreset by the template
rommDB_HOSTPreset by the template
rommDB_NAMEPreset by the template
rommDB_PASSWDGenerated at deploy
rommDB_PORTPreset by the template
rommDB_USERPreset by the template
rommDISABLE_DOWNLOAD_ENDPOINT_AUTHPreset by the template
rommROMM_AUTH_SECRET_KEYGenerated at deploy
rommROMM_DB_DRIVERPreset by the template
rommTZPreset by the template

First run

  1. Open the app and create the admin account on the setup page.
  2. Copy your ROM files into the library volume, one folder per platform, then run a scan from the app.

Install RomM on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get romm
  4. Install it

    This template has an install form, so the CLI fills each setting from --env, a generated secret or its default.

    levelrail-cli templates install romm --name my-romm

    To put a service behind a domain at install, add --domain SERVICE=HOST:

    levelrail-cli templates install romm --name my-romm --domain db=romm.example.com

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then RomM.

More in Media

All Media templates