Updating docs after recent influx of queries

This commit is contained in:
danblu3
2025-08-25 20:50:25 +00:00
parent de561eaa2d
commit e16b5d31c8
3 changed files with 14 additions and 2 deletions
+2 -1
View File
@@ -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
<!-- prettier-ignore -->
!!! 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:
<!-- prettier-ignore -->
@@ -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.
<!-- prettier-ignore -->
+11
View File
@@ -1,5 +1,16 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->
## 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: