Wdróż aplikację RomM na Pethost jednym kliknięciem

Co się dzieje

1. Logujesz się do Pethost albo zakładasz konto, kluczem dostępu, przez GitHub albo Google.
2. Nie masz jeszcze maszyny? Wybierasz plan, a my ją dla ciebie przygotowujemy. Link czeka w twojej przeglądarce, aż będzie gotowa.
3. Okno „Nowy projekt” otwiera się na tej aplikacji, a ty klikasz „Utwórz projekt”.
4. Za minutę czy dwie aplikacja działa pod własnym adresem z HTTPS. Jej sekrety są tworzone losowo, a dane trafiają do nocnego backupu.
5. To projekt jak każdy inny: jego compose.yaml, .env, logi i terminal są w panelu, a twój agent może go zmienić, cofnąć do wcześniejszej wersji albo przywrócić.

Pierwsze kroki

Otwórz adres projektu i przejdź przez kreator konfiguracji: wybierz swoje platformy, a potem utwórz konto administratora. Zrób to od razu: do tego czasu strona jest otwarta dla każdego, kto zna adres. Gry trafiają do /romm/library/roms/<platform> w usłudze romm, na przykład roms/snes: skopiuj je przez SFTP albo wgraj w RomM, a potem uruchom skanowanie. Klucze dostawców metadanych, na przykład IGDB_CLIENT_ID i IGDB_CLIENT_SECRET, wpisz do pliku .env projektu; potem wdróż ponownie.

Co uruchamia

Szablon to ten compose.yaml i zmienne, które zapisuje do .env projektu. Pethost uruchamia plik dokładnie tak, jak jest napisany.

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:

compose.yamlZobacz na GitHubie