rommapp/docs
1
0
Fork 0
mirror of https://github.com/rommapp/docs.git synced 2026-04-23 06:54:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update quick-start.docker-compose.yml: add Screenscraper credentials and fix healthcheck command syntax

Browse Source
This commit is contained in:
zurdi
2025-05-13 09:03:09 +00:00
parent 0d1efeedff
commit 05f1d64a1c
1 changed files with 48 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/resources/snippets/quick-start.docker-compose.yml
+48 -47
View File
@@ -1,53 +1,54 @@
version: "3" version: "3"
volumes: volumes:
mysql_data: mysql_data:
romm_resources: romm_resources:
romm_redis_data: romm_redis_data:
services: services:
romm: romm:
image: rommapp/romm:latest image: rommapp/romm:latest
container_name: romm container_name: romm
restart: unless-stopped restart: unless-stopped
environment: environment:
- DB_HOST=romm-db - DB_HOST=romm-db
- DB_NAME=romm # Should match MARIADB_DATABASE in mariadb - DB_NAME=romm # Should match MARIADB_DATABASE in mariadb
- DB_USER=romm-user # Should match MARIADB_USER in mariadb - DB_USER=romm-user # Should match MARIADB_USER in mariadb
- DB_PASSWD= # Should match MARIADB_PASSWORD in mariadb - DB_PASSWD= # Should match MARIADB_PASSWORD in mariadb
- ROMM_AUTH_SECRET_KEY= # Generate a key with `openssl rand -hex 32` - ROMM_AUTH_SECRET_KEY= # Generate a key with `openssl rand -hex 32`
- IGDB_CLIENT_ID= # Generate an ID and SECRET in IGDB - IGDB_CLIENT_ID= # Generate an ID and SECRET in IGDB
- IGDB_CLIENT_SECRET= # https://api-docs.igdb.com/#account-creation - IGDB_CLIENT_SECRET= # https://api-docs.igdb.com/#account-creation
- MOBYGAMES_API_KEY= # https://www.mobygames.com/info/api/ - SCREENSCRAPER_USER= # Use your ScreenScraper username and password
- STEAMGRIDDB_API_KEY= # https://github.com/rommapp/romm/wiki/Generate-API-Keys#steamgriddb - SCREENSCRAPER_PASSWORD= # https://docs.romm.app/latest/Getting-Started/Generate-API-Keys/#screenscraper
volumes: - STEAMGRIDDB_API_KEY= # https://github.com/rommapp/romm/wiki/Generate-API-Keys#steamgriddb
- romm_resources:/romm/resources # Resources fetched from IGDB (covers, screenshots, etc.) volumes:
- romm_redis_data:/redis-data # Cached data for background tasks - romm_resources:/romm/resources # Resources fetched from IGDB (covers, screenshots, etc.)
- /path/to/library:/romm/library # Your game library. Check https://github.com/rommapp/romm?tab=readme-ov-file#folder-structure for more details. - romm_redis_data:/redis-data # Cached data for background tasks
- /path/to/assets:/romm/assets # Uploaded saves, states, etc. - /path/to/library:/romm/library # Your game library. Check https://github.com/rommapp/romm?tab=readme-ov-file#folder-structure for more details.
- /path/to/config:/romm/config # Path where config.yml is stored - /path/to/assets:/romm/assets # Uploaded saves, states, etc.
ports: - /path/to/config:/romm/config # Path where config.yml is stored
- 80:8080 ports:
depends_on: - 80:8080
romm-db: depends_on:
condition: service_healthy romm-db:
restart: true condition: service_healthy
restart: true
romm-db: romm-db:
image: mariadb:latest image: mariadb:latest
container_name: romm-db container_name: romm-db
restart: unless-stopped restart: unless-stopped
environment: environment:
- MARIADB_ROOT_PASSWORD= # Use a unique, secure password - MARIADB_ROOT_PASSWORD= # Use a unique, secure password
- MARIADB_DATABASE=romm - MARIADB_DATABASE=romm
- MARIADB_USER=romm-user - MARIADB_USER=romm-user
- MARIADB_PASSWORD= - MARIADB_PASSWORD=
volumes: volumes:
- mysql_data:/var/lib/mysql - mysql_data:/var/lib/mysql
healthcheck: healthcheck:
test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"] test: [CMD, healthcheck.sh, --connect, --innodb_initialized]
start_period: 30s start_period: 30s
start_interval: 10s start_interval: 10s
interval: 10s interval: 10s
timeout: 5s timeout: 5s
retries: 5 retries: 5