Skip to content

Running on Unraid

Georges-Antoine Assi edited this page May 9, 2024 · 9 revisions

Video tutorial

AlienTech42 has published a great video on installing and running RomM on Unraid. Check it out!

IMAGE ALT TEXT HERE

Prerequisites

Before getting started, install the Community Apps plugin for Unraid.

If you're planning to use MariaDB as your database, install it from the plugin registry. Both the official and linuxserver versions are supported.

Official Linuxserver
Screenshot 2023-08-07 at 12 38 48 PM Screenshot 2023-08-07 at 12 38 44 PM

Installation

From the Unraid dashboard, click APPS in the navbar. In the search bar, search for zurdi15 romm; no results will appear, but that's normal. On the right side of the screen, click Click Here To Get More Results From DockerHub.

258859203-2582da70-dcae-4505-8463-23f8f2e6c64b

One of the first results should be romm by zurdi15. Once you find it, click Install.

258859891-6efb8696-d5d7-45dd-b1b3-d6365ee4ff07

If a confirmation window appears, click YES and CA will attempt to determine paths, ports and variables from the template.

258860339-5fc2c451-bfa9-4871-8bee-b04a72d602ca

Once the installation finishes, the configuration page will appear and should look something like this:

258861319-88c331d0-4586-444e-b922-d2465fd14c96

Configuration

Configure the required environment variables, ports and paths as per the example docker-compose.yml file.

258862729-c0e0ae7e-c3e2-46c8-91f8-2c5ca2a1039e

MariaDB

To use the MariaDB container setup in #prerequisites, add config options for the environment variables. Descriptions of the config options and sensible defaults are listed in the example docker-compose.yml file.

  • DB_HOST
  • DB_PORT
  • DB_USER
  • DB_NAME
  • DB_PASSWD

Troubleshooting

Open an issue if you're having trouble getting RomM to run. State that you're trying to run RomM in Unraid, be specific about the issue, and append screenshots of your configuration.

Updating

To update to the latest version, select force update from the container list. **It's strongly recommended to backup the appdata folder (or mount it in a safe location) before updating, since tearing down the container will wipe the resources (covers, screenshots, etc.)

Shoutouts

We want to give a special shoutout to @Smurre95 and @sfumat0 for their help documenting this process, and working towards getting RomM listed in CA. 🤝