Target

8080

Default

8080

Value

8080

Game files

Target

/romm/library/

Default

/romm/library

Value

/mnt/user/appdata/romm/library

Metadata storage (covers, screenshots, etc.)

Target

/romm/resources/

Value

/mnt/user/appdata/romm/resources

Uploaded saves, states, etc.

Target

/romm/assets/

Value

/mnt/user/appdata/romm/assets

Folder for config.yml

Target

/romm/config/

Value

/mnt/user/appdata/romm/config

Stores in-memory data

Target

/redis-data

Value

/mnt/user/appdata/romm/redis-data

Database driver to use

Default

mariadb

Value

mariadb

Host name of database instance

Default

mariadb

Port number of database instance

Default

3306

Should match MYSQL_DATABASE in MariaDB

Default

romm

Database username

Default

romm

Database password

Extra query parameters for the database connection, in JSON format

Host name of Redis/Valkey instance

Port number of Redis/Valkey instance

Username for Redis/Valkey instance

Password for Redis/Valkey instance

Database number for Redis/Valkey instance

Enable SSL for Redis/Valkey instance

Generate a key with `openssl rand -hex 32`

Disables CSRF protection (not recommended)

Default

false

Disable auth on download endpoint

Default

false

Disables login with username and password

Default

false

Maximum age of a session (in seconds)

Read-only mode for public displays or kiosks

Default

false

Enable OpenID Connect (OIDC) authentication

Default

false

Name of the OIDC provider in use

Client ID for OIDC authentication

Client secret for OIDC authentication

Absolute redirect URI for OIDC authentication

Absolute URL of the OIDC server application

Path to a file containing trusted CA certificates

Client ID for IGDB API

Client secret for IGDB API

Screenscraper username

Screenscraper password

MobyGames secret API key

SteamGridDB secret API key

Retroachievements secret API key

Retroachievements metadata cache refresh (in days)

Enable LaunchBox API integration

Default

false

Enable PlayMatch API integration

Default

false

Enable Hasheous API integration

Default

false

Enable Flashpoint API integration

Default

false

Enable HowLongToBeat API integration

Default

false

Number of processes running the app

Waiting time for requests on a Keep-Alive connection (in seconds)

Maximum number of requests a worker will process before restarting

Random jitter to add to the maximum number of requests a worker will process before restarting

Timeout for web server requests (in seconds)

Maximum number of simultaneous clients a single process can handle

Forces color output

Disables color output

Disables playing in browser with EmulatorJS

Default

false

Disables playing flash games with RuffleRS

Default

false

Base URL for alternate frontends

Timeout for file uploads (in seconds)

Timeout for the background scan/rescan tasks (in seconds)

Number of worker processes for scanning tasks

Timeout for the rest of the background tasks (in seconds)

How long to keep task results in Valkey (in seconds)

Timeout for 7-Zip operations (in seconds)

Enable re-scanning of library when filesystem changes

Default

false

Delay before re-scanning library when filesystem changes (in minutes)

Enable scheduled re-scanning of library

Default

false

Cron expression for scheduled re-scanning

Enable scheduled updating of Switch TitleDB index

Default

false

Cron expression for scheduled updating of Switch TitleDB

Enable scheduled updating of LaunchBox metadata

Default

false

Cron expression for scheduled updating of LaunchBox metadata

Enable scheduled conversion of images to WebP format

Default

false

Cron expression for scheduled conversion of images to WebP format

Enable scheduled syncing of Retroachievements progress

Default

false

Cron expression for scheduled syncing of Retroachievements progress

Logging level for the app

Value

INFO

DSN for Sentry error tracking