Merge branch 'master' into feat/retro_achievements

examples/docker-compose.example.yml

@@ -12,35 +12,44 @@ services:
     restart: unless-stopped
     environment:
       - DB_HOST=romm-db
-      - DB_NAME=romm # Should match MYSQL_DATABASE in mariadb
-      - DB_USER=romm-user # Should match MYSQL_USER in mariadb
-      - DB_PASSWD= # Should match MYSQL_PASSWORD in mariadb
+      - DB_NAME=romm # Should match MARIADB_DATABASE in mariadb
+      - DB_USER=romm-user # Should match MARIADB_USER in mariadb
+      - DB_PASSWD= # Should match MARIADB_PASSWORD in mariadb
       - ROMM_AUTH_SECRET_KEY= # Generate a key with `openssl rand -hex 32`
       - IGDB_CLIENT_ID= # Generate an ID and SECRET in IGDB
       - IGDB_CLIENT_SECRET= # https://api-docs.igdb.com/#account-creation
       - MOBYGAMES_API_KEY= # https://www.mobygames.com/info/api/
-      - STEAMGRIDDB_API_KEY # https://github.com/rommapp/romm/wiki/Generate-API-Keys#steamgriddb
-      - RETROACHIEVEMENTS_API_KEY # https://api-docs.retroachievements.org/#api-access
-      - RETROACHIEVEMENTS_USERNAME # https://api-docs.retroachievements.org/#api-access
+      - STEAMGRIDDB_API_KEY= # https://github.com/rommapp/romm/wiki/Generate-API-Keys#steamgriddb
+      - RETROACHIEVEMENTS_API_KEY= # https://api-docs.retroachievements.org/#api-access
+      - RETROACHIEVEMENTS_USERNAME= # https://api-docs.retroachievements.org/#api-access
     volumes:
       - romm_resources:/romm/resources # Resources fetched from IGDB (covers, screenshots, etc.)
       - romm_redis_data:/redis-data # Cached data for background tasks
-      - /path/to/library:/romm/library # Your game library
+      - /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/assets:/romm/assets # Uploaded saves, states, etc.
       - /path/to/config:/romm/config # Path where config.yml is stored
     ports:
       - 80:8080
     depends_on:
-      - romm-db
+      romm-db:
+        condition: service_healthy
+        restart: true
 
   romm-db:
-    image: mariadb:latest # if you experience issues, try: linuxserver/mariadb:latest
+    image: mariadb:latest
     container_name: romm-db
     restart: unless-stopped
     environment:
-      - MYSQL_ROOT_PASSWORD= # Use a unique, secure password
-      - MYSQL_DATABASE=romm
-      - MYSQL_USER=romm-user
-      - MYSQL_PASSWORD=
+      - MARIADB_ROOT_PASSWORD= # Use a unique, secure password
+      - MARIADB_DATABASE=romm
+      - MARIADB_USER=romm-user
+      - MARIADB_PASSWORD=
     volumes:
       - mysql_data:/var/lib/mysql
+    healthcheck:
+      test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"]
+      start_period: 30s
+      start_interval: 10s
+      interval: 10s
+      timeout: 5s
+      retries: 5