Skip to main content
ipmideck fournit une seule commande de console, ipmideck, qui démarre le serveur, réinitialise le mot de passe administrateur ou génère un certificat auto-signé.
La CLI ne s’applique que lorsque vous exécutez ipmideck directement (installation pip ou un checkout des sources). L’ image Docker lance uvicorn backend.main:app directement et n’invoque jamais la CLI, donc aucun de ces flags, ni la précedence de liaison, ni la garde d’instance unique ne s’appliquent au conteneur. La liaison du conteneur est définie par sa propre commande de démarrage. Consultez Installation.

Démarrer le serveur

start est la commande principale de service. Une invocation seule sans sous-commande sert de façon identique, donc celles-ci sont équivalentes :
Sans flags, ipmideck se lie à 0.0.0.0:3000 par défaut, joignable sur chaque interface, sur le port 3000. Ouvrez http://<your-ip>:3000 une fois qu’il est en route. Surchargez la liaison avec --host et --port :

Sous-commandes

serve est un alias déprécié de start, préférez start (ou un ipmideck seul) dans les nouveaux scripts.

Flags

Ces flags de premier niveau s’appliquent au chemin de service. --demo et --config sont lus avant toute ramification de sous-commande, donc ils affectent aussi reset-password et --gen-cert.

Précedence de liaison

L’hôte et le port auxquels ipmideck se lie réellement sont résolus dans cet ordre, priorité la plus haute d’abord :
  1. Un flag --host / --port explicite en ligne de commande.
  2. La configuration, qui résout elle-même la variable d’environnement (IPMIDECK_SERVER_HOST / IPMIDECK_SERVER_PORT) au-dessus de config.yaml au-dessus du défaut intégré.
  3. Le repli codé en dur 0.0.0.0:3000, utilisé si le chargement précoce de la configuration échoue.
Autrement dit : une valeur que vous persistez dans config.yaml est surchargée par une variable d’environnement IPMIDECK_ ou un flag --host / --port au prochain démarrage, l’environnement et la CLI l’emportent toujours. Si config.yaml est mal formé, ipmideck affiche un avertissement sur stderr et revient à 0.0.0.0:3000.
Les variables d’environnement IPMIDECK_SERVER_HOST et IPMIDECK_SERVER_PORT utilisent le préfixe IPMIDECK_. Consultez Configuration pour la liste complète des surcharges.

HTTPS avec —gen-cert

--gen-cert génère un certificat et une clé auto-signés, puis se termine. Il ne démarre pas le serveur et n’active pas HTTPS de lui-même :
Il écrit une paire certificat + clé sous data/certs/, enregistre leurs chemins dans le bloc server de config.yaml, et affiche trois lignes :
Pour servir réellement en HTTPS, définissez server.https: true dans config.yaml et redémarrez ipmideck. HTTPS n’est jamais activé automatiquement.

Mode démo

--demo exécute ipmideck contre du matériel simulé au lieu de vrais BMC, utile pour évaluer le tableau de bord sans aucun serveur câblé :
Le mode démo est défini très tôt, avant toute ramification de sous-commande, donc toute l’application (la configuration et le serveur en cours d’exécution) le voit.

Réinitialiser le mot de passe administrateur

reset-password crée ou met à jour de façon interactive la connexion administrateur, puis se termine sans jamais démarrer le serveur :
Il demande Username: puis New password: (saisie masquée). Si un compte existe déjà, il met à jour le mot de passe de cet utilisateur et affiche Password updated for <username> ; sinon il crée l’utilisateur et affiche User <username> created.

Rechargement automatique de développement

--reload est une voie rapide réservée au développement : il délègue au propre superviseur de rechargement automatique d’uvicorn et retourne. Il saute intentionnellement la garde de port d’instance unique décrite ci-dessous, car le rechargeur exécute son propre processus superviseur.
--reload est réservé au développement. Comme il contourne la garde d’instance unique, exécutez-le sur un hôte où aucune autre instance d’ipmideck n’est déjà liée au même port.

Codes de sortie

Sur le chemin de service (pas --reload), ipmideck exécute une garde d’instance unique avant de se lier. Si le port est déjà utilisé, il affiche une erreur sur stderr et se termine avec 1. Si la liaison échoue parce que l’ adresse est indisponible ou non autorisée, il affiche une erreur distincte et se termine également avec 1.

Étapes suivantes

  • Configuration : les clés de config.yaml et les surcharges d’environnement IPMIDECK_.
  • Installation : installez ipmideck avec Docker ou pip.
  • Dépannage : erreurs de connexion, de port et IPMI.