Skip to content

Repository files navigation

RomM on Railway

Railway template scaffolding for RomM, a beautiful self-hosted ROM manager and player. The published Railway marketplace name is romm.

Based on the upstream Docker Compose example.

The template runs RomM as two Railway services:

  • app — RomM web UI + embedded Valkey (public)
  • mariadb — application database

Railway template

Follow docs/railway-wiring.md when creating or updating the marketplace template. It contains the exact service names, reference variables, generated secrets, ports, healthchecks, and volume mounts.

Paste docs/description.md into the Railway template Description field when publishing.

Only the app URL should be opened in a browser. MariaDB stays on Railway private networking. Railway allows one volume per service — mount /romm on app so library, resources, assets, and config share that volume. Leave REDIS_HOST unset so the image starts embedded Valkey; /redis-data is ephemeral on Railway (cache / task broker).

The wrapper currently tracks RomM 5.1.0 (Docker Hub tag matching upstream release 5.1.0).

Run locally

  1. Copy .env.example to .env.
  2. Replace ROMM_AUTH_SECRET_KEY with a random value (openssl rand -hex 32).
  3. Start the stack:
docker compose up --build

Open http://localhost:8080. Complete the first-boot setup wizard, then place ROMs under /romm/library (see folder structure) and scan from the UI.

Updating RomM

  1. Bump the image tag in services/app/Dockerfile to the new Docker Hub semver (GitHub release X.Y.Z → image tag X.Y.Z).
  2. Diff upstream docker-compose.example.yml and env.template for env/volume changes and port them here.
  3. Run docker compose config and smoke-test /api/heartbeat, first-boot wizard, a small library scan, and metadata fetch if keys are set.

upstream-check.yml opens a version-bump PR weekly. Review the changelog and smoke before merging.

License

This repository contains deployment configuration only. RomM is distributed under AGPL-3.0; see the upstream license.

Community-maintained Railway packaging — not an official RomM project.

About

Railway template for self-hosting RomM

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages