diff --git a/docs/Getting-Started/Quick-Start-Guide.md b/docs/Getting-Started/Quick-Start-Guide.md index de6866a..febd1a8 100644 --- a/docs/Getting-Started/Quick-Start-Guide.md +++ b/docs/Getting-Started/Quick-Start-Guide.md @@ -14,6 +14,7 @@ This guide will assume that you already have the following done, if not - stop h - [Docker installed](https://docs.docker.com/get-docker/) and running on your system - Your ROMs organized in the correct [folder structure](./Folder-Structure.md) - The recommended [metadata providers](./Metadata-Providers.md) set up +- 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 !!! warning @@ -53,7 +54,7 @@ Now that we have everything gathered, we can begin getting your instance set up! 6. Modify the following values in the **volumes** to configure the application - `/path/to/library`: Path to the directory where your rom files will be stored (usually the parent folder of the `roms` folder) - `/path/to/assets`: Path to the directory where you will store your saves, etc - - `/path/to/config`: Path to the directory where you will store the config.yml + - `/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. 7. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this: diff --git a/docs/Platforms-and-Players/EmulatorJS-Player.md b/docs/Platforms-and-Players/EmulatorJS-Player.md index a5cc83c..44ae206 100644 --- a/docs/Platforms-and-Players/EmulatorJS-Player.md +++ b/docs/Platforms-and-Players/EmulatorJS-Player.md @@ -11,7 +11,7 @@ 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) + - [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 - launching Chrome browser with the `--disable-web-security` and `--enable-features=SharedArrayBuffer` flags, which **WE STRONGLY DISCOURAGE** as it disables important security features. diff --git a/docs/System-Setup/Synology-Setup-Guide.md b/docs/System-Setup/Synology-Setup-Guide.md index d229cae..cae2dc2 100644 --- a/docs/System-Setup/Synology-Setup-Guide.md +++ b/docs/System-Setup/Synology-Setup-Guide.md @@ -1,5 +1,16 @@ +## External Written Guides + +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. + +[How to Install RomM on Your Synology NAS (MariaDB)](https://mariushosting.com/how-to-install-romm-on-your-synology-nas/) + +[How to Install RomM With PostgreSQL on Your Synology NAS](https://mariushosting.com/how-to-install-romm-with-postgresql-on-your-synology-nas/) + +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. + + ## Prerequisites This guide assumes you're familiar with Docker and have basic knowledge of server management. You'll need: