Skip to content

With Docker Compose

Prerequisites

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

Install Docker Compose Addon from the CA (Community Apps Store)

Docker Compose Addon

Docker Tab

You will now see Compose option under the Docker Containers in your Docker Tab in Unraid

Docker Compose Section

Installation

Click Add New Stack

  • Name it RomM and click OK

  • Click the Gear Icon, edit stack, then edit the compose file

Edit Stack

  • Add in the example Docker Compose from our example docker-compose.yml

  • Add your environment variables, for example: API keys, MariaDB info, and metadata providers

    • You can use secrets and fill in information in a separate .env file

Edit Compose

  • Click the Gear Icon, edit stack, then edit the environment file

    • Fill in any environment variables if you used secrets, etc.

  • Make sure to click Save Changes after each edit to the compose and environment files

Edit Env

Warning

You need to make sure you are following either Folder Structure A or B (Recommend A Type) RomM Folder Structure

Warning

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.)

Finish

  • Click Compose Up

Compose Up Working

Grab IP:Port from romm, and open tab in browser in http://IP:Port and it should take you to setup screen

Compose Up

Romm Setup