Self-host RomM with Levelrail

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.

  • Authorrommapp
  • LicenceAGPL-3.0
  • Memory1 GiB
  • Archarm64
  • Services2

How to self-host RomM

  1. Pull the images

    2 images are pulled on your server.

    Show images
    • mariadb:11.8.9
    • rommapp/romm:5.4.1
  2. Create the app

    2 services start in a single Compose app, with 6 named volume mounts for your data, on port 8080.

  3. Fill in the secrets

    4 secrets are generated and stored encrypted, 9 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

After the first start

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

RomM requirements

Memory
About 1 GiB
Architectures
amd64 image published, arm64 image published
Ports
8080
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
AGPL-3.0, network copyleft (agpl) license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then RomM. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the RomM docs page.

Deploy RomM your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy RomM from the CLI

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain db=app.example.com.

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

Deploy RomM with the API

Create a token in the dashboard first. Name, env and domains are the request fields.

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/romm/install \
  -d '{
    "name": "my-romm"
  }'

RomM configuration

RomM services

ServiceImagePortsVolumes
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

RomM environment variables

VariableServiceValue
MARIADB_DATABASE db Preset by the template
MARIADB_PASSWORD db Generated at deploy
MARIADB_ROOT_PASSWORD db Generated at deploy
MARIADB_USER db Preset by the template
DB_HOST romm Preset by the template
DB_NAME romm Preset by the template
DB_PASSWD romm Generated at deploy
DB_PORT romm Preset by the template
Show all 13 variables
  • DB_USERrommPreset by the template
  • DISABLE_DOWNLOAD_ENDPOINT_AUTHrommPreset by the template
  • ROMM_AUTH_SECRET_KEYrommGenerated at deploy
  • ROMM_DB_DRIVERrommPreset by the template
  • TZrommPreset by the template

Ports and volumes

Ports
8080
Volumes
6 named mounts: dbdata -> /var/lib/mysql, resources -> /romm/resources, library -> /romm/library, assets -> /romm/assets, config -> /romm/config, redis -> /redis-data

RomM FAQ

How much memory does RomM need?

The catalog lists about 1 GiB of memory for RomM across its 2 services.

Does RomM run on arm64?

For RomM, an arm64 image is published; amd64 is image published.

What licence is RomM under?

RomM is licensed under AGPL-3.0, which is network copyleft, so source sharing also applies when it is offered as a hosted service.

Does RomM need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which database does RomM bundle?

The template includes MySQL, running as its own service.

Which ports does RomM use?

RomM listens on port 8080 inside the stack.

Where does RomM keep its data?

In named volumes: dbdata mounted at /var/lib/mysql, resources mounted at /romm/resources, library mounted at /romm/library and assets mounted at /romm/assets.

Can I deploy RomM on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for RomM, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image mariadb:11.8.9, rommapp/romm:5.4.1 is what you deploy there.

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