Skip to main content
ipmideck levert één console-commando, ipmideck, dat de server start, het beheerderswachtwoord reset of een zelfondertekend certificaat genereert.
De CLI is alleen van toepassing wanneer je ipmideck rechtstreeks draait (pip-installatie of een source-checkout). De Docker-image start uvicorn backend.main:app rechtstreeks en roept de CLI nooit aan, dus geen van deze vlaggen, de bind-volgorde of de single-instance-bewaking is van toepassing op de container. De bind van de container wordt ingesteld door zijn eigen startcommando. Zie Installatie.

​
De server starten

start is het primaire serve-commando. Een kale aanroep zonder subcommando serveert identiek, dus deze zijn gelijkwaardig:
Zonder vlaggen bindt ipmideck standaard 0.0.0.0:3000, bereikbaar op elke interface, op poort 3000. Open http://<your-ip>:3000 zodra hij draait. Overschrijf de bind met --host en --port:

​
Subcommando’s

serve is een verouderde alias van start, geef de voorkeur aan start (of een kale ipmideck) in nieuwe scripts.

​
Vlaggen

Deze top-level vlaggen zijn van toepassing op het serve-pad. --demo en --config worden gelezen vóór elke subcommando-tak, dus ze beïnvloeden ook reset-password en --gen-cert.

​
Bind-volgorde

De host en poort waaraan ipmideck daadwerkelijk bindt, worden in deze volgorde bepaald, hoogste prioriteit eerst:
  1. Een expliciete --host / --port-vlag op de commandoregel.
  2. Configuratie, die zelf de omgevingsvariabele (IPMIDECK_SERVER_HOST / IPMIDECK_SERVER_PORT) boven config.yaml boven de ingebouwde standaard plaatst.
  3. De hardgecodeerde fallback 0.0.0.0:3000, gebruikt als het vroege laden van config mislukt.
Met andere woorden: een waarde die je naar config.yaml bewaart, wordt overschreven door een IPMIDECK_ omgevingsvariabele of een --host / --port-vlag bij de volgende boot, env en CLI winnen altijd. Als config.yaml ongeldig is, print ipmideck een waarschuwing naar stderr en valt terug op 0.0.0.0:3000.
De omgevingsvariabelen IPMIDECK_SERVER_HOST en IPMIDECK_SERVER_PORT gebruiken de IPMIDECK_-prefix. Zie Configuratie voor de volledige lijst met overrides.

​
HTTPS met —gen-cert

--gen-cert genereert een zelfondertekend certificaat en sleutel, en sluit dan af. Het start de server niet en zet HTTPS niet vanzelf aan:
Het schrijft een cert + sleutelpaar onder data/certs/, legt hun paden vast in het server-blok van config.yaml, en print drie regels:
Om daadwerkelijk over HTTPS te serveren, stel je server.https: true in config.yaml in en herstart je ipmideck. HTTPS wordt nooit automatisch ingeschakeld.

​
Demomodus

--demo draait ipmideck tegen gesimuleerde hardware in plaats van echte BMC’s, nuttig om het dashboard te evalueren zonder dat er servers aangesloten zijn:
De demomodus wordt heel vroeg ingesteld, vóór elke subcommando-tak, zodat de hele app (config en de draaiende server) het ziet.

​
Het beheerderswachtwoord resetten

reset-password maakt of werkt de beheerderslogin interactief bij, sluit dan af zonder ooit de server te starten:
Het vraagt om Username: en daarna New password: (verborgen invoer). Als er al een account bestaat, werkt het het wachtwoord van die gebruiker bij en print Password updated for <username>; anders maakt het de gebruiker aan en print User <username> created.

​
Auto-reload voor ontwikkeling

--reload is een snelpad alleen voor ontwikkeling: het draagt over aan uvicorn’s eigen auto-reloading supervisor en keert terug. Het slaat opzettelijk de single-instance-poortbewaking over die hieronder wordt beschreven, omdat de reloader zijn eigen supervisorproces draait.
--reload is alleen voor ontwikkeling. Omdat het de single-instance-bewaking omzeilt, draai het op een host waar nog geen andere ipmideck-instantie aan dezelfde poort gebonden is.

​
Exitcodes

Op het serve-pad (niet --reload) draait ipmideck een single-instance-bewaking vóór het binden. Als de poort al in gebruik is, print het een fout naar stderr en sluit af met 1. Als de bind mislukt omdat het adres niet beschikbaar of niet toegestaan is, print het een aparte fout en sluit ook af met 1.

​
Volgende stappen