Skip to content

Commit e16b5d3

Browse files
committed
Updating docs after recent influx of queries
1 parent de561ea commit e16b5d3

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

docs/Getting-Started/Quick-Start-Guide.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ This guide will assume that you already have the following done, if not - stop h
1414
- [Docker installed](https://docs.docker.com/get-docker/) and running on your system
1515
- Your ROMs organized in the correct [folder structure](./Folder-Structure.md)
1616
- 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
1718

1819
<!-- prettier-ignore -->
1920
!!! warning
@@ -53,7 +54,7 @@ Now that we have everything gathered, we can begin getting your instance set up!
5354
6. Modify the following values in the **volumes** to configure the application
5455
- `/path/to/library`: Path to the directory where your rom files will be stored (usually the parent folder of the `roms` folder)
5556
- `/path/to/assets`: Path to the directory where you will store your saves, etc
56-
- `/path/to/config`: Path to the directory where you will store the config.yml
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.
5758
7. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this:
5859

5960
<!-- prettier-ignore -->

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
PSP emulation with the PPSSPP core and MS-DOS with the dosbox-pure core requires one of the three options:
1212

1313
- 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)
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
1515
- launching Chrome browser with the `--disable-web-security` and `--enable-features=SharedArrayBuffer` flags, which **WE STRONGLY DISCOURAGE** as it disables important security features.
1616

1717
<!-- prettier-ignore -->

docs/System-Setup/Synology-Setup-Guide.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
<!-- trunk-ignore-all(markdownlint/MD041) -->
22

3+
## External Written Guides
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.
6+
7+
[How to Install RomM on Your Synology NAS (MariaDB)](https://mariushosting.com/how-to-install-romm-on-your-synology-nas/)
8+
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.
12+
13+
314
## Prerequisites
415

516
This guide assumes you're familiar with Docker and have basic knowledge of server management. You'll need:

0 commit comments

Comments
 (0)