Aller au contenu

Installation

ROMKADE Manager s'installe avec Docker, de la même façon sur macOS, Windows et Linux. Comptez une dizaine de minutes la première fois, surtout pour installer Docker.

1. Installer Docker

  1. Téléchargez Docker Desktop depuis la documentation officielle de Docker, en choisissant votre processeur (Apple Silicon ou Intel).
  2. Ouvrez le fichier téléchargé et faites glisser Docker dans le dossier Applications.
  3. Lancez Docker Desktop et attendez qu'il indique que le moteur tourne (icône de baleine dans la barre des menus).
  4. Si macOS demande si Docker peut trouver des appareils sur votre réseau local, acceptez : c'est ce qui permet à ROMKADE Manager de joindre la console.
  1. Activez WSL 2 en suivant le guide de Microsoft.
  2. Installez Docker Desktop depuis la documentation officielle de Docker, avec l'option WSL 2.
  3. Redémarrez si l'installeur le demande, puis lancez Docker Desktop et attendez que le moteur tourne.
  4. Si le Pare-feu Windows le demande, autorisez Docker sur les réseaux privés.
  1. Installez Docker Engine en suivant la page de votre distribution dans la documentation officielle.
  2. Installez le plugin Docker Compose (instructions).
  3. Facultatif : suivez les étapes post-installation pour utiliser Docker sans sudo. Sinon, ajoutez sudo devant les commandes docker ci-dessous.

Vérifiez dans un terminal (le Terminal sur macOS et Linux, PowerShell sur Windows) : les deux commandes doivent afficher un numéro de version.

docker --version
docker compose version

2. Télécharger et lancer ROMKADE Manager

Ces commandes créent un dossier romkade, y téléchargent le fichier officiel compose.yaml de la dernière version, puis lancent ROMKADE Manager en arrière-plan.

mkdir romkade && cd romkade
curl -fsSLO https://github.com/RomKade/romkade-manager/releases/latest/download/compose.yaml
docker compose up -d

mkdir romkade; cd romkade
curl.exe -fsSLO https://github.com/RomKade/romkade-manager/releases/latest/download/compose.yaml
docker compose up -d

Le premier lancement télécharge les images (quelques centaines de Mo). Vous pouvez lire le fichier avant de le lancer : il décrit deux services, ROMKADE Manager et son moteur de recherche, et rien d'autre.

3. Ouvrir l'interface

Ouvrez http://localhost:8765 dans votre navigateur. Une fenêtre présente les conditions d'utilisation au premier lancement ; elles restent accessibles à tout moment depuis la barre latérale.

L'interface ne répond que sur cet ordinateur : c'est voulu, puisqu'elle pilote votre console.

Étape suivante

Connectez votre console.

Bon à savoir

  • Rien à configurer : le fichier fonctionne tel quel.
  • Vos données (catalogue, réglages, copies de sauvegardes, secrets) sont dans le volume Docker romkade-data. Elles survivent aux mises à jour et à docker compose down. Voir Données et confidentialité.
  • Démarrage automatique : ROMKADE Manager redémarre avec Docker. Pour l'arrêter : docker compose down dans le dossier romkade.

  • Le port 8765 est déjà utilisé ? Lancez-le sur un autre port, puis ouvrez celui-ci (par exemple http://localhost:8780) :

    ROMKADE_PORT=8780 docker compose up -d

    $env:ROMKADE_PORT=8780; docker compose up -d

Mettre à jour

Dans le dossier romkade :

docker compose pull
docker compose up -d

Les notes de version sont sur GitHub. Vos données sont conservées.

Commandes utiles

À lancer dans le dossier romkade.

Commande Effet
docker compose ps État des services
docker compose logs -f Journaux en direct (Ctrl+C arrête l'affichage ; le service continue de tourner)
docker compose pull Télécharge la nouvelle version des images, sans rien redémarrer
docker compose up -d Lance, ou relance avec les images mises à jour
docker compose down Arrête et supprime les conteneurs ; les volumes, donc vos données, sont conservés

Jamais de docker compose down -v par habitude

L'option -v supprime aussi les volumes : le catalogue, les copies de sauvegardes et les réglages seraient perdus.

À partir du code source (macOS)

Pour les contributeurs, ou pour utiliser l'application depuis un téléphone. Nécessite Python 3.13 de python.org (le Python de Homebrew est bloqué par l'autorisation macOS Réseau local et ne peut pas joindre la console), et Node 20 ou plus (brew install node) pour compiler l'interface.

git clone https://github.com/RomKade/romkade-manager.git
cd romkade-manager
./run.sh

Au premier lancement, le script crée l'environnement Python et compile l'interface (quelques minutes), puis démarre le serveur et ouvre http://127.0.0.1:8765. Gardez la fenêtre du Terminal ouverte ; Ctrl+C arrête le serveur. La première fois, autorisez le Terminal à trouver des appareils sur le réseau local.

  • Les mots de passe et les clés sont rangés dans le trousseau macOS ; les données dans ~/Library/Application Support/AnbernicGameManager/.
  • La recherche utilise Typesense si Docker Desktop est lancé (conteneur agm-typesense), sinon une recherche intégrée.
  • Mise à jour : git pull, puis ./run.sh.