Deutsch
Loslegen
← Alle Vorlagen

RomM mit einem Klick auf Pethost deployen

Eine Bibliothek und ein Player im Browser für deine Retro-Spiele

Was passiert

  1. Du meldest dich bei Pethost an oder legst ein Konto an, mit Passkey, GitHub oder Google.
  2. Noch keine Maschine? Du wählst einen Tarif, und wir bereiten eine für dich vor. Der Link wartet in deinem Browser, bis sie bereit ist.
  3. „Neues Projekt“ öffnet sich bei der App, und du klickst auf „Projekt erstellen“.
  4. In ein, zwei Minuten läuft die App unter eigener Adresse mit HTTPS. Ihre Secrets werden zufällig für sie erzeugt, und ihre Daten sind im nächtlichen Backup.
  5. Sie ist ein Projekt wie jedes andere: compose.yaml, .env, Logs und ein Terminal findest du im Panel, und dein Agent kann sie ändern, zurückrollen oder wiederherstellen.

Erste Schritte

Öffne die Adresse und geh den Einrichtungsassistenten durch: Wähl deine Plattformen und erstell dann das Admin-Konto. Mach das gleich: Bis dahin steht die Seite allen offen, die die Adresse haben. Spiele kommen nach /romm/library/roms/<platform> im Service romm, zum Beispiel roms/snes: Kopier sie per SFTP oder lad sie in RomM hoch und starte dann einen Scan. Die Keys von Metadatenanbietern, zum Beispiel IGDB_CLIENT_ID und IGDB_CLIENT_SECRET, trägst du in die .env des Projekts ein; deploy danach neu.

Was läuft

Die Vorlage ist diese compose.yaml und die Variablen, die sie in die .env des Projekts schreibt. Pethost führt die Datei so aus, wie sie geschrieben ist.

services:
  romm:
    image: rommapp/romm:5
    restart: unless-stopped
    depends_on:
      db:
        condition: service_healthy
    # Metadata services' keys (IGDB_CLIENT_ID, SCREENSCRAPER_USER, ...) go into .env.
    env_file: .env
    environment:
      ROMM_BASE_URL: ${URL}
      ROMM_AUTH_SECRET_KEY: ${ROMM_AUTH_SECRET_KEY}
      # TLS ends at the machine's proxy, which says so in X-Forwarded-Proto.
      ROMM_SESSION_SECURE_COOKIE: "true"
      DB_HOST: db
      DB_NAME: romm
      DB_USER: romm
      DB_PASSWD: ${DB_PASSWORD}
      # Matches games by their files' hashes, with no key, as RomM's own compose file does.
      HASHEOUS_API_ENABLED: "true"
      # Four API workers by default; two are plenty for a household and leave memory to the
      # machine's other projects.
      WEB_SERVER_CONCURRENCY: "2"
    # The image declares /romm a volume: the library, assets, resources and config are in it.
    volumes:
      - romm:/romm
      - redis-data:/redis-data
    # The page answers once the first start's migrations are done.
    healthcheck:
      test: ["CMD", "wget", "-q", "-O", "/dev/null", "http://127.0.0.1:8080/api/heartbeat"]
      interval: 10s
      timeout: 5s
      retries: 5
      start_period: 180s

  db:
    image: mariadb:11.8
    restart: unless-stopped
    environment:
      MARIADB_DATABASE: romm
      MARIADB_USER: romm
      MARIADB_PASSWORD: ${DB_PASSWORD}
      MARIADB_ROOT_PASSWORD: ${DB_ROOT_PASSWORD}
    volumes:
      - db:/var/lib/mysql
    healthcheck:
      test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"]
      interval: 5s
      timeout: 5s
      retries: 12
      start_period: 60s

volumes:
  romm:
  redis-data:
  db: