Installer avec Docker

Chaque release publie une image officielle de l’API, ghcr.io/kuroctl/kuro-api, avec le panel et les prefabs officiels. Elle convient à une machine où Docker est déjà installé et où vous préférez tout gérer par Compose plutôt que par un service système.

Seule l’API est dans l’image. Un nœud (le daemon qui fait tourner les serveurs de jeu) pilote le Docker de l’hôte : il s’installe avec le script, sur la même machine ou ailleurs (Ajouter un nœud).

1. Prérequis

Docker avec Compose (docker compose version) ;
un nom public qui pointe déjà vers la machine (enregistrement DNS A ou AAAA) : Caddy en a besoin pour le certificat, les nœuds pour se connecter ;
les ports 80 et 443 (panel) et 8443 (nœuds, mTLS) ouverts en entrée.

2. Récupérer les fichiers

Trois fichiers, pris sur la version que vous installez :

mkdir kuro && cd kuro
for f in docker-compose.yml Caddyfile .env.example; do
  curl -fsSLO "https://raw.githubusercontent.com/kuroctl/kuro/v0.2.1/docker/$f"
done
cp .env.example .env

Remplissez .env : le nom public, un mot de passe pour PostgreSQL et la clé des sessions (openssl rand -hex 32). Cette clé ne doit plus changer ensuite.

3. Démarrer

docker compose up -d
docker compose logs -f api

Au premier démarrage, l’API applique ses migrations et crée l’autorité de certification privée des nœuds dans le volume kuro-data. Caddy obtient le certificat HTTPS à la première visite.

4. Première mise en route

Ouvrez https://panel.example.com : tant qu’aucun compte n’existe, le panel affiche un assistant qui demande le jeton de mise en route, écrit par l’API dans son volume :

docker compose exec api cat /var/lib/kuro/setup-token

Puis le compte super admin et le nom du projet, et la connexion. Sans panel :

docker compose exec api kuro-entrypoint setup --email vous@example.com --name "Votre nom"

Le mot de passe est demandé de façon interactive, jamais passé en argument.

Ajouter un nœud

Dans le panel, « Ajouter un nœud » donne la commande à lancer sur la machine du nœud. L’adresse de l’API y est https://panel.example.com:8443 : le port 8443 est publié directement par le service api, sans passer par Caddy.

Configurer

L’image se règle par des variables KURO_API_*, une par clé de la configuration, les sections séparées par __ (KURO_API_HTTP__BIND). Les valeurs de docker-compose.yml sont celles d’une installation par le script. Pour un fichier TOML complet, montez-le et indiquez son chemin :

services:
  api:
    environment:
      KURO_API_CONFIG: /etc/kuro/api.toml
    volumes:
      - ./api.toml:/etc/kuro/api.toml:ro

Les variables gardent la priorité sur le fichier.

Mettre à jour

docker compose pull
docker compose up -d

Pour une version précise, mettez-la dans .env (KURO_VERSION=0.2.1). Mettez à jour l’API avant les nœuds (Mettre à jour).

Vérifier l’image

Le fichier IMAGE de chaque release donne l’empreinte (sha256) de l’image publiée ; il est couvert par la signature de SHA256SUMS (Vérifier ce qu’on installe). Pour épingler l’image à cette empreinte plutôt qu’à son tag, remplacez image: dans docker-compose.yml par la ligne ghcr.io/kuroctl/kuro-api@sha256:… du fichier.

​1. Prérequis

​2. Récupérer les fichiers

​3. Démarrer

​4. Première mise en route

​Ajouter un nœud

​Configurer

​Mettre à jour

​Vérifier l’image

1. Prérequis

2. Récupérer les fichiers

3. Démarrer

4. Première mise en route

Ajouter un nœud

Configurer

Mettre à jour

Vérifier l’image