Skip to content

Commit 46c3cd9

Browse files
committed
Merge branch 'main' into universal-slugs
2 parents a9e594d + 3923900 commit 46c3cd9

15 files changed

+69
-3
lines changed

docs/.Navigation.md.kate-swp

61 Bytes
Binary file not shown.

docs/Getting-Started/Environment-Variables.md

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

docs/Navigation.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ search:
2222
- [RuffleRS](Platforms-and-Players/RuffleRS-Player.md)
2323
- [Custom Platforms](Platforms-and-Players/Custom-Platforms.md)
2424
- System Setup Guides
25-
- [Unraid Setup](System-Setup/Unraid-Setup-Guide.md)
25+
- [Unraid](System-Setup/Unraid-Setup-Guide.md)
26+
- [With Docker Compose](System-Setup/Unraid-Compose-Setup.md)
2627
- [Synology Setup](System-Setup/Synology-Setup-Guide.md)
2728
- [TrueNAS Setup](System-Setup/TrueNAS-Setup-Guide.md)
2829
- OIDC Setup Guides
128 Bytes
Binary file not shown.

docs/Platforms-and-Players/EmulatorJS-Player.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@
88

99
<!-- prettier-ignore -->
1010
!!! warning
11-
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.
12-
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.
11+
PSP emulation with the PPSSPP core and MS-DOS with the dosbox-pure core requires one of the three options:
12+
13+
- 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)
14+
- [special setup with a reverse proxy](https://emulatorjs.org/docs/options#ejs_threads)
15+
- launching Chrome browser with the `--disable-web-security` and `--enable-features=SharedArrayBuffer` flags, which **WE STRONGLY DISCOURAGE** as it disables important security features.
1316

1417
<!-- prettier-ignore -->
1518
!!! warning
75 Bytes
Binary file not shown.
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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+
![Docker Compose Addon](../resources/unraid/docker-compose.png)
10+
11+
### Docker Tab
12+
13+
You will now see Compose option under the Docker Containers in your Docker Tab in Unraid
14+
15+
![Docker Compose Section](../resources/unraid/unraid-start.png)
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+
![Edit Stack](../resources/unraid/edit-stack.png)
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+
![Edit Compose](../resources/unraid/unraid-compose.png)
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+
![Edit Env](../resources/unraid/romm-env.png)
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+
![Compose Up Working](../resources/unraid/docker-compose-loading.png)
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+
![Compose Up](../resources/unraid/docker-compose-up.png)
60+
61+
![Romm Setup](../resources/unraid/unraid-success.png)
7.18 KB
Loading
26.8 KB
Loading
29.7 KB
Loading

0 commit comments

Comments
 (0)