Aller au contenu
Selectionner la langue:Français

Installer Kept

Choisissez comment vous faites tourner Kept, puis suivez ses étapes. Chaque chemin a un guide complet dans cette section ; le lien se trouve à la fin de ses étapes.

Docker Compose

Ce qu’il vous faut

Docker avec le plugin Compose, et un terminal. Testé avec 1 Go de RAM et un cœur de CPU ; Kept et sa base de données en utilisent environ 200–400 Mo (ce qui a été testé).

  1. Téléchargez compose.yaml dans un dossier à lui : Kept et sa base de données dans un seul fichier, sans copie du dépôt et sans mot de passe à créer.

    Fenêtre de terminal
    mkdir kept && cd kept
    curl -fsSLO https://raw.githubusercontent.com/keptinventory/kept/v1.14.7/compose.yaml
  2. Écrivez .env. init demande l’adresse à laquelle vous ouvrirez Kept, comme http://kept.home.arpa:8080. Préférez un nom à une adresse IP : les étiquettes imprimées la portent.

    Fenêtre de terminal
    docker compose run --rm init

    Vous devriez voir

    Wrote .env.
    KEPT SETUP CODE: XXX-XXX
    Next: docker compose up -d, then open http://kept.home.arpa:8080 and enter the setup code.
  3. Démarrez-le. La base de données démarre, deux services à exécution unique créent ses identifiants et appliquent les migrations, puis Kept démarre sur le port 8080.

    Fenêtre de terminal
    docker compose up -d

    Vous devriez voir

    À l’adresse, la page Saisissez le code de configuration de Kept.

  4. Configurez-le. Saisissez le code qu’init a affiché et créez le premier compte : il devient l’administrateur de l’instance.

  5. Gardez les clés. Imprimez le kit de récupération et gardez-le ailleurs que sur ce serveur, par exemple dans un gestionnaire de mots de passe. Une sauvegarde ne restaure les valeurs secrètes qu’avec ces clés.

    Fenêtre de terminal
    docker compose exec kept kept admin recovery-kit

    Vous devriez voir

    Un texte qui commence par KEPT RECOVERY KIT.

Chaque étape en détail, avec Caddy pour HTTPS et Ollama pour l’IA locale : Installer avec Docker Compose.

Kubernetes

Ce qu’il vous faut

Un cluster Kubernetes comme k3s, kubectl et helm, et un terminal. Le chart demande 384 Mio de mémoire pour Kept (au plus 1 Gio) et 256 Mio pour son Postgres inclus (au plus 512 Mio).

  1. Créez les secrets. Le chart n’écrit jamais de secret : les identifiants de la base de données et le superutilisateur du Postgres inclus prennent leurs mots de passe dans des secrets que vous créez d’abord.

    Fenêtre de terminal
    kubectl create namespace kept
    pw() { openssl rand -hex 32; }
    # The four database logins (always).
    kubectl -n kept create secret generic kept-db \
    --from-literal=KEPT_DB_OWNER_PASSWORD="$(pw)" --from-literal=KEPT_DB_APP_PASSWORD="$(pw)" \
    --from-literal=KEPT_DB_AUTH_PASSWORD="$(pw)" --from-literal=KEPT_DB_SYSTEM_PASSWORD="$(pw)"
    # The bundled Postgres's superuser (or, for external Postgres with roles.create, the server admin's password).
    kubectl -n kept create secret generic kept-postgres --from-literal=POSTGRES_PASSWORD="$(pw)"
  2. Installez le chart, avec publicUrl à l’adresse que les gens ouvriront. N’ajoutez pas --wait à cette première installation : les migrations s’exécutent après.

    Fenêtre de terminal
    helm install kept oci://ghcr.io/keptinventory/charts/kept --version 1.14.7 -n kept \
    --set publicUrl=https://kept.example.org \
    --set roles.existingSecret=kept-db --set postgres.superuserSecret=kept-postgres

    Vous devriez voir

    La première ligne des notes qu’affiche Helm :

    Kept 1.14.7 is installed as "kept" in namespace "kept".
  3. Trouvez le code de configuration. Kept l’affiche une fois, à son premier démarrage.

    Fenêtre de terminal
    kubectl -n kept logs deploy/kept | grep 'KEPT SETUP CODE'

    Vous devriez voir

    KEPT SETUP CODE: XXX-XXX

    Ouvrez l’adresse, saisissez le code et créez le premier compte : il devient l’administrateur de l’instance.

  4. Gardez les clés. Enregistrez le kit de récupération et gardez-le hors du cluster.

    Fenêtre de terminal
    kubectl -n kept exec deploy/kept -- kept admin recovery-kit > kept-recovery-kit.txt

    Vous devriez voir

    kept-recovery-kit.txt, qui commence par KEPT RECOVERY KIT.

  5. Vérifiez-le. helm test demande /readyz et /version au Kept en cours d’exécution.

    Fenêtre de terminal
    helm test kept -n kept

Sous Windows, lancez ces commandes dans WSL. Les valeurs, les secrets facultatifs et ce que le chart exécute : Installation sur Kubernetes avec Helm.

Depuis les sources

Ce qu’il vous faut

Git, Docker avec le plugin Compose, et un terminal. Kept tourne comme avec Docker Compose, sur votre propre image.

  1. Récupérez le code.

    Fenêtre de terminal
    git clone https://github.com/keptinventory/kept.git && cd kept
  2. Construisez l’image, étiquetée kept:local.

    Fenêtre de terminal
    docker build -t kept:local .
  3. Écrivez .env. Faites pointer compose.yaml vers votre image, puis lancez init. Il trouve le .env, demande s’il doit le mettre à jour (répondez Y), puis demande l’adresse à laquelle vous ouvrirez Kept.

    Fenêtre de terminal
    echo KEPT_IMAGE=kept:local >> .env
    docker compose run --rm init

    Vous devriez voir

    Updated .env.
    KEPT SETUP CODE: XXX-XXX
  4. Démarrez-le, et ouvrez l’adresse.

    Fenêtre de terminal
    docker compose up -d

    Vous devriez voir

    La page Saisissez le code de configuration de Kept. Saisissez le code qu’init a affiché et créez le premier compte : il devient l’administrateur de l’instance.

  5. Gardez les clés. Imprimez le kit de récupération et gardez-le ailleurs que sur ce serveur.

    Fenêtre de terminal
    docker compose exec kept kept admin recovery-kit

    Vous devriez voir

    Un texte qui commence par KEPT RECOVERY KIT.

Sous Windows, lancez ces commandes dans WSL. Le même compose.yaml que pour une version publiée, expliqué en détail : Installer avec Docker Compose.

Home Assistant

Ce qu’il vous faut

Home Assistant OS avec Supervisor 2026.10.4 ou ultérieur : les applications ont besoin du Supervisor, donc pas Home Assistant Container ni Core. Une machine aarch64 ou amd64, comme un Raspberry Pi 4 ou 5 en 64 bits ou un mini-PC. 4 Go de mémoire ; 2 Go suffisent avec peu d’autres applications. Pas de terminal.

  1. Ajoutez le dépôt de Kept. Le bouton ouvre votre Home Assistant avec le dépôt déjà rempli. Ou allez dans Paramètres → Applications → Installer l’application → ⋮ → Dépôts et ajoutez https://github.com/keptinventory/kept.

    Ajouter Kept à Home Assistant
  2. Installer, puis Commencer. Trouvez Kept dans la boutique d’applications, puis Installer, puis Commencer.

    Vous devriez voir

    Dans l’onglet Journal de l’application, l’adresse propre de Kept et le code de configuration :

    Kept is at http://homeassistant.local:8080 (change it in Configuration: "Kept's address")
    KEPT SETUP CODE: XXX-XXX
  3. Ouvrir l’interface Web. Kept s’ouvre dans Home Assistant, et aussi dans la barre latérale.

    Vous devriez voir

    Pour un administrateur de Home Assistant, Créer le premier compte, sans code. Toute autre personne voit Saisissez le code de configuration et tape le code de l’onglet Journal.

L’adresse de Kept, HTTPS et les sauvegardes : Installer Kept comme application Home Assistant.

  • Le conteneur redémarre sans cesse. Lisez son journal : docker compose logs kept. Kept vérifie ses réglages avant de démarrer et s’arrête sur une ligne qui nomme le premier problème, comme kept: invalid environment: KEPT_PUBLIC_URL (lancez docker compose run --rm init). Si docker compose up -d s’arrête à bootstrap, docker compose logs bootstrap dit pourquoi. Avec moins de 1 Go de mémoire, une sauvegarde peut en manquer et Docker redémarre Kept (ce dont il a besoin). Plus
  • Le port est déjà pris. Kept utilise le port 8080 de l’hôte. Relancez docker compose run --rm init avec une adresse http:// sur un port libre : il écrit l’adresse et le port (KEPT_HTTP_PORT) dans .env. Puis docker compose up -d. Dans l’application Home Assistant, changez le port sous Configuration → Réseau et réglez L’adresse de Kept en conséquence. Plus
  • Permission refusée. Kept tourne avec l’utilisateur 10001 sur un système de fichiers en lecture seule, donc un dossier que vous y montez, comme un répertoire de sauvegarde, doit appartenir à l’uid 10001. init écrit .env dans le dossier d’où vous le lancez : lancez-le dans un dossier qui vous appartient. Plus
  • Les autres appareils ne l’ouvrent pas. localhost ne s’ouvre que sur cette machine. Utilisez un nom que les autres appareils trouvent, défini dans le DNS de votre routeur ou dans le fichier hosts de chaque appareil, et relancez init avec lui. Si Kept dit « Ce Kept est configuré pour adresse. Ouvrez-le à cette adresse. », ouvrez-le exactement à cette adresse, ou ajoutez l’autre dans KEPT_EXTRA_ADDRESSES (plusieurs adresses). Plus
  • Une erreur 502 du proxy inverse. Kept parle en HTTP simple sur le port 8080 : faites pointer le proxy vers http://, pas https://, sur ce port (derrière un proxy inverse). Kept ne démarre qu’une fois migrate terminé ; en cas d’échec, docker compose logs migrate dit pourquoi. Plus

Tout le reste : Dépannage.

  • Docker Compose : mettez la nouvelle version dans KEPT_IMAGE de .env, puis :

    Fenêtre de terminal
    docker compose pull
    docker compose up -d

    Une version qui change compose.yaml le dit dans ses notes : téléchargez son fichier par-dessus le vôtre.

  • Depuis les sources :

    Fenêtre de terminal
    git pull
    docker build -t kept:local .
    docker compose up -d
  • Kubernetes : chaque version publie un chart de la même version, et ses migrations s’exécutent dans un Job avant que la nouvelle version ne serve.

  • Home Assistant : Home Assistant propose la mise à jour. Activez Conserver une sauvegarde de la dernière version dans sa boîte de dialogue de mise à jour.

Avec une destination de sauvegarde définie, Kept prend un instantané avant de migrer. Mises à niveau et retour en arrière.