Skip to content

Commit 0d50987

Browse files
committed
fix(romm): 🐛 align RomM mounts with local RetroPie base
1 parent b57be1e commit 0d50987

3 files changed

Lines changed: 37 additions & 1 deletion

File tree

romm/.env.example

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# RomM Stack Environment Variables
2+
3+
# Required
4+
DOCKER_DATA_BASEFOLDER=/opt/docker/data
5+
DOCKER_MEDIA_BASEFOLDER=/opt/docker/media
6+
LOCAL_RETROPIE_BASE=/opt/docker/media/retropie
7+
ROMM_DB_NAME=romm
8+
ROMM_DB_USER=romm-user
9+
ROMM_DB_PASSWORD=REPLACE_ME
10+
ROMM_DB_ROOT_PASSWORD=REPLACE_ME
11+
ROMM_AUTH_SECRET_KEY=REPLACE_ME
12+
13+
# Optional metadata providers
14+
SCREENSCRAPER_USER=
15+
SCREENSCRAPER_PASSWORD=
16+
RETROACHIEVEMENTS_API_KEY=
17+
STEAMGRIDDB_API_KEY=
18+
HASHEOUS_API_ENABLED=true

romm/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# RomM Stack
2+
3+
RomM game library manager with MariaDB backend, adapted for a reverse-proxied homelab setup.
4+
5+
## Configuration
6+
7+
1. Copy `.env.example` to `.env`.
8+
2. Set the database credentials and `ROMM_AUTH_SECRET_KEY`.
9+
3. Set `LOCAL_RETROPIE_BASE` to the root folder that contains `roms/` and `BIOS/`.
10+
11+
## Notes
12+
13+
- The RomM web container is exposed internally on `8080` and joins `npm_network`.
14+
- MariaDB stays on the internal `romm_network`.
15+
- The ROM library and BIOS are mounted from `LOCAL_RETROPIE_BASE`.
16+
- Runtime secrets live in `.env`, not in the compose file.

romm/compose.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ services:
2424
volumes:
2525
- romm_resources:/romm/resources # Resources fetched from IGDB (covers, screenshots, etc.)
2626
- romm_redis_data:/redis-data # Cached data for background tasks
27-
- ${DOCKER_MEDIA_BASEFOLDER:-/opt/docker/media}/roms:/romm/library # Your game library. Check https://docs.romm.app/latest/Getting-Started/Folder-Structure/ for more details.
27+
# - ${DOCKER_MEDIA_BASEFOLDER:-/opt/docker/media}/romm_library:/romm/library # Your game library. Check https://docs.romm.app/latest/Getting-Started/Folder-Structure/ for more details.
28+
- ${LOCAL_RETROPIE_BASE:-/opt/docker/media/retropie}/roms:/romm/library/roms
29+
- ${LOCAL_RETROPIE_BASE:-/opt/docker/media/retropie}/BIOS:/romm/library/bios
2830
- ${DOCKER_DATA_BASEFOLDER:-/opt/docker/data}/romm/assets:/romm/assets # Uploaded saves, states, etc.
2931
- ${DOCKER_DATA_BASEFOLDER:-/opt/docker/data}/romm/config:/romm/config # (Optional) Path where config.yml is stored
3032
expose:

0 commit comments

Comments
 (0)