|
| 1 | +<!-- trunk-ignore-all(markdownlint/MD041) --> |
| 2 | + |
| 3 | +## Prerequisites |
| 4 | + |
| 5 | +Before getting started, install the [Community Apps plugin](https://forums.unraid.net/topic/38582-plug-in-community-applications/) for Unraid. |
| 6 | + |
| 7 | +Install [Docker Compose Addon](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/) from the CA (Community Apps Store) |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +### Docker Tab |
| 12 | + |
| 13 | +You will now see Compose option under the Docker Containers in your Docker Tab in Unraid |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +## Installation |
| 18 | + |
| 19 | +Click **Add New Stack** |
| 20 | + |
| 21 | +- Name it **RomM** and click **OK** |
| 22 | + |
| 23 | +- Click the **Gear Icon**, edit stack, then edit the compose file |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +- Add in the example Docker Compose from our [example docker-compose.yml](https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml) |
| 28 | + |
| 29 | +- Add your environment variables, for example: API keys, MariaDB info, and metadata providers |
| 30 | + |
| 31 | + - You can use secrets and fill in information in a separate `.env` file |
| 32 | + |
| 33 | + |
| 34 | + |
| 35 | +- Click the **Gear Icon**, edit stack, then edit the environment file |
| 36 | + |
| 37 | + - Fill in any environment variables if you used secrets, etc. |
| 38 | + |
| 39 | +- Make sure to click **Save Changes** after each edit to the compose and environment files |
| 40 | + |
| 41 | + |
| 42 | + |
| 43 | +<!-- prettier-ignore --> |
| 44 | +!!! warning |
| 45 | + You need to make sure you are following either Folder Structure A or B (Recommend A Type) [RomM Folder Structure](https://docs.romm.app/latest/Getting-Started/Folder-Structure/) |
| 46 | + |
| 47 | +<!-- prettier-ignore --> |
| 48 | +!!! warning |
| 49 | + 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.) |
| 50 | + |
| 51 | +## Finish |
| 52 | + |
| 53 | +- Click Compose Up |
| 54 | + |
| 55 | + |
| 56 | + |
| 57 | +Grab `IP:Port` from romm, and open tab in browser in `http://IP:Port` and it should take you to setup screen |
| 58 | + |
| 59 | + |
| 60 | + |
| 61 | + |
0 commit comments