You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Getting-Started/Quick-Start-Guide.md
+18-17Lines changed: 18 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ This guide will assume that you already have the following done, if not - stop h
14
14
-[Docker installed](https://docs.docker.com/get-docker/) and running on your system
15
15
- Your ROMs organized in the correct [folder structure](./Folder-Structure.md)
16
16
- The recommended [metadata providers](./Metadata-Providers.md) set up
17
-
- A copy of the config.yml from [RomM Github](https://github.com/rommapp/romm/blob/master/examples/config.example.yml)- This is now mandatory since 4.1
17
+
- A copy of the [config.yml](https://github.com/rommapp/romm/blob/master/examples/config.example.yml)in the config folder
18
18
19
19
<!-- prettier-ignore -->
20
20
!!! warning
@@ -54,7 +54,8 @@ Now that we have everything gathered, we can begin getting your instance set up!
54
54
6. Modify the following values in the **volumes** to configure the application
55
55
- `/path/to/library`: Path to the directory where your rom files will be stored (usually the parent folder of the `roms` folder)
56
56
- `/path/to/assets`: Path to the directory where you will store your saves, etc
57
-
- `/path/to/config`: Path to the directory where you will store the config.yml - At this step please store the `config.yml` file in this folder now.
57
+
- `/path/to/config`: Path to the directory where you will store the config.yml
58
+
> At this step store the `config.yml` file in this folder
58
59
7. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this:
59
60
60
61
<!-- prettier-ignore -->
@@ -66,21 +67,21 @@ Now that we have everything gathered, we can begin getting your instance set up!
66
67
8. Open the terminal and navigate to the directory containing the docker-compose file
67
68
9. Run `docker compose up -d` to kick off the docker pull. You will see it pull the container and set up the volumes and network:
Copy file name to clipboardExpand all lines: docs/Platforms-and-Players/EmulatorJS-Player.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@
11
11
PSP emulation with the PPSSPP core and MS-DOS with the dosbox-pure core requires one of the three options:
12
12
13
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) - If you use this you will be **MISSING** features within RomM and it is recommended to use the WebApp
14
+
- [special setup with a reverse proxy](https://emulatorjs.org/docs/options#ejs_threads) (which will break features within the app and is not recommended)
15
15
- launching Chrome browser with the `--disable-web-security` and `--enable-features=SharedArrayBuffer` flags, which **WE STRONGLY DISCOURAGE** as it disables important security features.
Copy file name to clipboardExpand all lines: docs/System-Setup/Synology-Setup-Guide.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,12 @@
2
2
3
3
## External Written Guides
4
4
5
-
While you can follow the below guide, there is written guides done by [Marius Bogdan Lixandru](https://mariushosting.com/) which focus on the synoloy infrastructure and using portainer. This supports both MariaDB and PostGresSQL.
5
+
While you can follow the below guide, [Marius Bogdan Lixandru](https://mariushosting.com/)has written excellent guides which focus on Synology infrastructure and with support for both MariaDB and PostGresSQL:
6
6
7
-
[How to Install RomM on Your Synology NAS (MariaDB)](https://mariushosting.com/how-to-install-romm-on-your-synology-nas/)
7
+
*[How to Install RomM on Your Synology NAS (MariaDB)](https://mariushosting.com/how-to-install-romm-on-your-synology-nas/)
8
+
*[How to Install RomM With PostgreSQL on Your Synology NAS](https://mariushosting.com/how-to-install-romm-with-postgresql-on-your-synology-nas/)
8
9
9
-
[How to Install RomM With PostgreSQL on Your Synology NAS](https://mariushosting.com/how-to-install-romm-with-postgresql-on-your-synology-nas/)
10
-
11
-
We would suggest to follow the above guides depending on your setup, but we will leave the other guide below as it was written by a community member.
10
+
We suggest following the above guides if they fit your setup, and the guide below is available for all other use cases.
0 commit comments