Unraid Setup
Before getting started, install the Community Apps plugin for Unraid.
You'll want to create a custom bridge-type network for both containers to communicate with each other. This will prevent a number of common issues Unraid users tend to come across during setup. This can be done with the following command: docker network create romm, and you can verify it worked with docker network ls.
MariaDB is required to run RomM, so install it from the plugin registry. Both the official and linuxserver versions are supported, but the linuxserver version is preferred.
Now fill in all the environment variables; descriptions of the options and sensible defaults are listed in the example docker-compose.yml file.
Warning
The network type must be set to "Custom: romm"
From the Unraid dashboard, click APPS in the navbar. In the search bar, search for romm, and install the app listed as "OFFICIAL". This one is maintained by our team and is the most up-to-date.
Configure the required environment variables, ports and paths as per the example docker-compose.yml file.
Warning
The network type must also be set to "Custom: romm"
Apply the changes, then head to the DOCKER tab. You should see both containers in a running state, and can access RomM using the IP:PORT of the container (highlighted below).
**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.)
AlienTech42 has published a great video on installing and running RomM on Unraid. While a bit out of date vis-a-vis install instructions, it's still very useful for general setup and debugging. Check it out!
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. 🤝