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!

[gantoine]

Will try the update romM template now to see how it looks

Please do let me know if the updated XML template is valid!

I can maybe write up a step-by-step process if it helps until an official Community App is made?

Yes that would be super helpful, even some basic instructions would go a long way to getting Unraid users setup.

[sfumat0]

Please forgive me if this could be in a better format, before an official (or unofficial) community app is hosted in UnRAID, here are the steps I took to get this working in the UnRAID GUI:

1. Click 'APPS', search for 'zurdi15 romm' and then click the link (Click Here To Get More Results From DockerHub).

2. You should see 'romm' as the first option if you typed the search term correctly in step 1. Click 'Install'.

3. Click 'YES' on the pop up window to determine configuration.

4. Next you will see the base template for RomM, as below. Note that my app name shows 'romm-1' this is because I already have the app installed. You will see 'romm' on first installation.

5. Configure the required environment variables, ports and paths as per the example docker-compose.yml - You should see something similar to the below image. Note, this is using mysql, to configure with MariaDB, you will need to add this to the template.

.... I hope this helps.

[sfumat0]

I should add that, with this setup I have a wonderful collection mapped:

[gantoine]

This is amazing, and should be enough to write a short wiki page. Could you do me one more favour and export the XML file? I'd like to compare it against the one submitted by smurre/merge them together before submitting it the CA team.

[Smurre95]

The settings he have is the same is mine since i copyied this settings when i re did mine. Have not had time to test the current template. But will do so soon

[Smurre95]

The template looks to be loading in to unraid. But tested the picture and that one did not load in to my current docker so might need a diffrent size on that one ?

[gantoine]

The template looks to be loading in to unraid

Nice!

But tested the picture and that one did not load in to my current docker so might need a diffrent size on that one

That might be since the image is an SVG, and it might expect a PNG/JPG. I'll find an alternate icon and switch it out.

[gantoine]

On a related note, I've just published a Wiki page with the instructions posted above: https://github.com/zurdi15/romm/wiki/Running-on-Unraid

[sfumat0]

Just a note that I clicked 'force update' which behaves correctly but it looks as though it has wiped my appdata folder, all resources still remain. I will need to rescan all platforms again but I will test if it duplicates resources.

My silly fault for not backing up appdata.

[sfumat0]

I've scanned 1 platform back in and it runs through the process of scanning at a similar speed, it does not duplicate any of the resources. There is no data in my appdata directory though. This doesn't seem correct. @Smurre95 - Do you see data in your config folder?

[Smurre95]

The config folder i dont think works because it refers to a YML file and not a folder so it seems to ignore it

All the others is here

[gantoine]

it refers to a YML file and not a folder so it seems to ignore it

That makes sense, I've updated the XML file to reflect the the fact it's s file.

[Smurre95]

Updated my template with the following link and that worked
https://raw.githubusercontent.com/zurdi15/romm/master/romm.png

Thanks @zurdi15 for the updated PNG
@gantoine If you have not updated the link then use the one i used above in the template and that should work

[zurdi15]

On a related note, I've just published a Wiki page with the instructions posted above: https://github.com/zurdi15/romm/wiki/Running-on-Unraid

By the way didn't noticed this, good work and thank you very much!

[Smurre95]

Should add the follwoing in the template
http://[IP]:[PORT:8091]/

http://[IP]:[PORT:8091]/

It just adds the webui button

[gantoine]

@Smurre95 done and done, thanks for pointing those out

[Smurre95]

With the new RC3 out i have updated my template with redis varaibales and stuff. Should i share a new XML ?

[zurdi15]

Yes sure! Share it and I will update it once we release 2.0.0. Thank you!!

[gantoine]

With the documentation in the wiki, I'm going to close this issue for now. Let's continue any conversations around the Unraid XML file in #323.