Merge branch 'main' into universal-slugs

This commit is contained in:
Georges-Antoine Assi 2025-08-06 17:25:20 -04:00
commit 46c3cd95f4
No known key found for this signature in database
GPG Key ID: 30F6E9865ABBA06E
15 changed files with 69 additions and 3 deletions

Binary file not shown.

View File

@ -20,6 +20,7 @@ This is a complete list of available environment variables; required variables a
| SCAN_TIMEOUT | Timeout for the background scan/rescan tasks (in seconds) | | `14400` |
| DISABLE_EMULATOR_JS | Disables playing in browser with [EmulatorJS](../Platforms-and-Players/EmulatorJS-Player.md) | | `false` |
| DISABLE_RUFFLE_RS | Disables playing flash games with [RuffleRS](../Platforms-and-Players/RuffleRS-Player.md) | | `false` |
| YOUTUBE_BASE_URL | Base URL for alternate frontends (Piped, Invidious etc.) | | `https://www.youtube.com` |
| TZ | Sets the timezone | | `UTC` |
| WEB_CONCURRENCY | Number of processes running the app | | `2` |
| ROMM_PORT | Port on which the application listens | | `8080` |

View File

@ -22,7 +22,8 @@ search:
- [RuffleRS](Platforms-and-Players/RuffleRS-Player.md)
- [Custom Platforms](Platforms-and-Players/Custom-Platforms.md)
- System Setup Guides
- [Unraid Setup](System-Setup/Unraid-Setup-Guide.md)
- [Unraid](System-Setup/Unraid-Setup-Guide.md)
- [With Docker Compose](System-Setup/Unraid-Compose-Setup.md)
- [Synology Setup](System-Setup/Synology-Setup-Guide.md)
- [TrueNAS Setup](System-Setup/TrueNAS-Setup-Guide.md)
- OIDC Setup Guides

Binary file not shown.

View File

@ -8,8 +8,11 @@
<!-- prettier-ignore -->
!!! warning
PSP emulation with the PPSSPP core and MS-DOS with the dosbox-pure core requires [special setup with a reverse proxy](https://emulatorjs.org/docs/options#ejs_threads), or launching Chrome browser with the `--disable-web-security` and `--enable-features=SharedArrayBuffer` flags, which **WE STRONGLY DISCOURAGE** as it disables important security features.
Alternatively, use the unnoficial [desktop app](https://github.com/smurflabs/RommBrowser/releases) published by [smurflabs](https://github.com/smurflabs). Once logged into the app, you can enable the required settings settings under `Developer Settings`. Restart the app and you'll have access to PPSSPP and DOS.
PSP emulation with the PPSSPP core and MS-DOS with the dosbox-pure core requires one of the three options:
- the unofficial [desktop app](https://github.com/smurflabs/RommBrowser/releases) published by [smurflabs](https://github.com/smurflabs). Once logged into the app, you can enable the required settings under `Developer Settings`. (Preferred)
- [special setup with a reverse proxy](https://emulatorjs.org/docs/options#ejs_threads)
- launching Chrome browser with the `--disable-web-security` and `--enable-features=SharedArrayBuffer` flags, which **WE STRONGLY DISCOURAGE** as it disables important security features.
<!-- prettier-ignore -->
!!! warning

Binary file not shown.

View File

@ -0,0 +1,61 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
## Prerequisites
Before getting started, install the [Community Apps plugin](https://forums.unraid.net/topic/38582-plug-in-community-applications/) for Unraid.
Install [Docker Compose Addon](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/) from the CA (Community Apps Store)
![Docker Compose Addon](../resources/unraid/docker-compose.png)
### Docker Tab
You will now see Compose option under the Docker Containers in your Docker Tab in Unraid
![Docker Compose Section](../resources/unraid/unraid-start.png)
## Installation
Click **Add New Stack**
- Name it **RomM** and click **OK**
- Click the **Gear Icon**, edit stack, then edit the compose file
![Edit Stack](../resources/unraid/edit-stack.png)
- Add in the example Docker Compose from our [example docker-compose.yml](https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.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](../resources/unraid/unraid-compose.png)
- 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](../resources/unraid/romm-env.png)
<!-- prettier-ignore -->
!!! warning
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/)
<!-- prettier-ignore -->
!!! 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](../resources/unraid/docker-compose-loading.png)
Grab `IP:Port` from romm, and open tab in browser in `http://IP:Port` and it should take you to setup screen
![Compose Up](../resources/unraid/docker-compose-up.png)
![Romm Setup](../resources/unraid/unraid-success.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB