From e16b5d31c887029b97f4e3d0f79bf7db2e41b18b Mon Sep 17 00:00:00 2001 From: danblu3 Date: Mon, 25 Aug 2025 20:50:25 +0000 Subject: [PATCH 1/3] Updating docs after recent influx of queries --- docs/Getting-Started/Quick-Start-Guide.md | 3 ++- docs/Platforms-and-Players/EmulatorJS-Player.md | 2 +- docs/System-Setup/Synology-Setup-Guide.md | 11 +++++++++++ 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/Getting-Started/Quick-Start-Guide.md b/docs/Getting-Started/Quick-Start-Guide.md index de6866a8..febd1a88 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 a5cc83c5..44ae2061 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 d229caeb..cae2dc20 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: From ceffd5f95426b74251b3724ee21989a56ae3333a Mon Sep 17 00:00:00 2001 From: danblu3 Date: Mon, 25 Aug 2025 21:21:06 +0000 Subject: [PATCH 2/3] Trunk fmt --- docs/System-Setup/Synology-Setup-Guide.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/System-Setup/Synology-Setup-Guide.md b/docs/System-Setup/Synology-Setup-Guide.md index cae2dc20..c21d7462 100644 --- a/docs/System-Setup/Synology-Setup-Guide.md +++ b/docs/System-Setup/Synology-Setup-Guide.md @@ -8,8 +8,7 @@ While you can follow the below guide, there is written guides done by [Marius Bo [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. - +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 From 8a80c3f201af9a1f4d34e35968d778372a93f9e8 Mon Sep 17 00:00:00 2001 From: Georges-Antoine Assi Date: Mon, 25 Aug 2025 23:05:39 -0400 Subject: [PATCH 3/3] tweaks --- docs/Getting-Started/Quick-Start-Guide.md | 35 ++++++++++--------- .../EmulatorJS-Player.md | 2 +- docs/System-Setup/Synology-Setup-Guide.md | 9 +++-- 3 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/Getting-Started/Quick-Start-Guide.md b/docs/Getting-Started/Quick-Start-Guide.md index febd1a88..c59fe0c6 100644 --- a/docs/Getting-Started/Quick-Start-Guide.md +++ b/docs/Getting-Started/Quick-Start-Guide.md @@ -14,7 +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 +- A copy of the [config.yml](https://github.com/rommapp/romm/blob/master/examples/config.example.yml) in the config folder !!! warning @@ -54,7 +54,8 @@ 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 - At this step please store the `config.yml` file in this folder now. + - `/path/to/config`: Path to the directory where you will store the config.yml + > At this step store the `config.yml` file in this folder 7. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this: @@ -66,21 +67,21 @@ Now that we have everything gathered, we can begin getting your instance set up! 8. Open the terminal and navigate to the directory containing the docker-compose file 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: -```asciinema-player - { - "file": "../latest/resources/asciinema/quick-start-docker-compose.cast", - "title": "RomM docker compose install", - "preload": true, - "loop": true, - "auto_play": true, - "cols": 140, - "rows": 30, - "fit": "width", - "terminal_font_size": "small", - "terminal_line_height": "1.2", - "terminal_font_family": "Roboto Mono, Monaco, Consolas, monospace" - } -``` + ```asciinema-player + { + "file": "../latest/resources/asciinema/quick-start-docker-compose.cast", + "title": "RomM docker compose install", + "preload": true, + "loop": true, + "auto_play": true, + "cols": 140, + "rows": 30, + "fit": "width", + "terminal_font_size": "small", + "terminal_line_height": "1.2", + "terminal_font_family": "Roboto Mono, Monaco, Consolas, monospace" + } + ``` 1. Run `docker ps -f name=romm` to verify that the containers are running 2. Open a web browser and navigate to `http://localhost:80`, where you should be greeted with the RomM setup page diff --git a/docs/Platforms-and-Players/EmulatorJS-Player.md b/docs/Platforms-and-Players/EmulatorJS-Player.md index 44ae2061..c3d928f4 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) - If you use this you will be **MISSING** features within RomM and it is recommended to use the WebApp + - [special setup with a reverse proxy](https://emulatorjs.org/docs/options#ejs_threads) (which will break features within the app and is not recommended) - 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 c21d7462..1d3364e0 100644 --- a/docs/System-Setup/Synology-Setup-Guide.md +++ b/docs/System-Setup/Synology-Setup-Guide.md @@ -2,13 +2,12 @@ ## 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. +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: -[How to Install RomM on Your Synology NAS (MariaDB)](https://mariushosting.com/how-to-install-romm-on-your-synology-nas/) +- [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/) -[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. +We suggest following the above guides if they fit your setup, and the guide below is available for all other use cases. ## Prerequisites