Add documentation for running on Unraid

[gantoine]

Discussed in #289

^{Originally posted by sfumat0 June 26, 2023}

I have seen a user reporting RomM working well on Unraid. I am attempting to set this up but failing. Is there a simple guide? I have used the docker-compose.example.yml to add in the variables, ports and paths but it doesn't seem to be creating the db or creating the config.
This is my first post so please forgive me if this is not the right place to request support.

[Smurre95]

I'm running it in unraid. with out any issues. I have not released the template as i was not sure it was done yet. I'm not home right now but i might be able to share this template later this week. But it was working fine for me just created a template no docker compose or so

[sfumat0]

I have it running but after the scan of atari2600 (as an initial test), the UI is very slow and after a few days the library was empty so I am sure I have not setup my template correctly. Here is a screenshot of my template (converted from Community App Store). I would love to update to latest release and start testing more.

[sfumat0]

I just wanted to report back that I updated to v1.9 and everything is working very well, everything is very responsive. I made no changes to the template just updated. I'll monitor over the next few days to ensure the config persists.

It would be great to see official UnRAID Community Apps support.

Great work on this project, really excited to see how far this goes and hope that I can contribute in some way over time.

[gantoine]

@sfumat0 @Smurre95 World either of you be keen on writing short setup instructions to get RomM running on Unraid? Even something posted here as a comment would help tremendously, and we can expand on it, then move it to an appropriate place.

On a related note, I'm going to open another issue for community app support, which we can backlog separately.

[Smurre95]

Yeah sure im open to do that. I have never added a template to the unraid community app but i have used and created alot of them when it comes to dockers that did not have a template. I would say for unraid best is to get an official template and have support on that one

[gantoine]

I would say for unraid best is to get an official template and have support on that one

Awesome! While you get something written up, I'll get Unraid setup and ready to go. If I'm able to get RomM running successfully using your template (sorry if I'm using the wrong wording, I'm not familiar with Unraid), I'll export the XML and submit it to the Community Apps team.

[Smurre95]

Here is a pastebin of my XML file
https://pastebin.com/nk5Mistq

So I re-did mine since i saw sfumats when i had the access issue. So this is kinda generic from my opinion. Removed all my keys and stuff. The only thing that needs to be added is the location to your roms then it should just deploy

Might need to be a image for it to be added since right now the docker dose not have one

@gantoine Should give you a good baseline for the template

[gantoine]

Thank you so much! I've expanded on the file you posted in #323 and will give it a try later this evening (after I figure Unraid out lol). So much for that, I don't have any spare PCs or drives to test it with. :(

[Smurre95]

If you need some testing help i have my unraid available ish. Im no guru on unraid but I know my way basics around it. Just tell me im happy to help. Since im not so much of a coder anything for the community to move forward :D Will try the update romM template now to see how it looks

[sfumat0]

I am also happy to test, I can maybe write up a step-by-step process if it helps until an official Community App is made?

Without an official community app, there is an option in UnRAID to build an app from Docker Hub, this will create a template and then the environment variables/paths can be added to that template by the user, this is how I installed. Note that I used mysql as I had issues with MariaDB although this is likely an issue on my side and I am not sure if using MariaDB carries any benefits. See image below:

Everything is working as far as I can see, the only real downside is that the app icon is not added to the Docker section which is a minor thing.

[zurdi15]

I can't test this neither for lack of hardware, but thank you very much for contributing with this and testing who anyone that can do it!