Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions docs/Getting-Started/Quick-Start-Guide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- trunk-ignore-all(markdownlint/MD033) -->

Check failure on line 1 in docs/Getting-Started/Quick-Start-Guide.md

View workflow job for this annotation

GitHub Actions / Trunk Check

prettier

Incorrect formatting, autoformat by running 'trunk fmt'
<!-- trunk-ignore-all(markdownlint/MD041) -->

This quick start guide will help you get a RomM instance up and running. It is split into 3 parts:
Expand All @@ -14,6 +14,7 @@
- [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](https://github.com/rommapp/romm/blob/master/examples/config.example.yml) in the config folder

<!-- prettier-ignore -->
!!! warning
Expand Down Expand Up @@ -54,6 +55,7 @@
- `/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 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:

<!-- prettier-ignore -->
Expand All @@ -65,21 +67,21 @@
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
Expand Down
2 changes: 1 addition & 1 deletion docs/Platforms-and-Players/EmulatorJS-Player.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) (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.

<!-- prettier-ignore -->
Expand Down
9 changes: 9 additions & 0 deletions docs/System-Setup/Synology-Setup-Guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<!-- trunk-ignore-all(markdownlint/MD041) -->

## External Written Guides

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 With PostgreSQL on Your Synology NAS](https://mariushosting.com/how-to-install-romm-with-postgresql-on-your-synology-nas/)

We suggest following the above guides if they fit your setup, and the guide below is available for all other use cases.

## Prerequisites

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