Skip to main content
ipmideck dostarcza jedno polecenie konsoli, ipmideck, które uruchamia serwer, resetuje hasło administratora lub generuje samopodpisany certyfikat.
CLI ma zastosowanie tylko wtedy, gdy uruchamiasz ipmideck bezpośrednio (instalacja pip lub kopia źródłowa). Obraz Docker uruchamia uvicorn backend.main:app bezpośrednio i nigdy nie wywołuje CLI, więc żadna z tych flag, pierwszeństwo wiązania ani zabezpieczenie pojedynczej instancji nie mają zastosowania do kontenera. Wiązanie kontenera ustawia jego własne polecenie startowe. Zobacz Instalacja.

​
Uruchamianie serwera

start to główne polecenie serwowania. Samo wywołanie bez podpolecenia serwuje identycznie, więc te są równoważne:
Bez flag ipmideck wiąże się domyślnie z 0.0.0.0:3000, osiągalny na każdym interfejsie, na porcie 3000. Otwórz http://<your-ip>:3000, gdy już działa. Nadpisz wiązanie za pomocą --host i --port:

​
Podpolecenia

serve to przestarzały alias start, preferuj start (lub samo ipmideck) w nowych skryptach.

​
Flagi

Te flagi najwyższego poziomu mają zastosowanie do ścieżki serwowania. --demo i --config są odczytywane przed każdą gałęzią podpolecenia, więc wpływają również na reset-password i --gen-cert.

​
Pierwszeństwo wiązania

Host i port, z którymi ipmideck faktycznie się wiąże, są ustalane w tej kolejności, najwyższy priorytet najpierw:
  1. Jawna flaga --host / --port w wierszu poleceń.
  2. Konfiguracja, która sama ustawia zmienną środowiskową (IPMIDECK_SERVER_HOST / IPMIDECK_SERVER_PORT) przed config.yaml przed wbudowaną wartością domyślną.
  3. Zakodowana na stałe wartość zapasowa 0.0.0.0:3000, używana, jeśli wczesne wczytanie konfiguracji zawiedzie.
Innymi słowy: wartość, którą utrwalisz do config.yaml, jest nadpisywana przez zmienną środowiskową IPMIDECK_ lub flagę --host / --port przy następnym uruchomieniu, env i CLI zawsze wygrywają. Jeśli config.yaml jest źle sformułowany, ipmideck wypisuje ostrzeżenie do stderr i wraca do 0.0.0.0:3000.
Zmienne środowiskowe IPMIDECK_SERVER_HOST i IPMIDECK_SERVER_PORT używają prefiksu IPMIDECK_. Zobacz Konfiguracja po pełną listę nadpisań.

​
HTTPS z —gen-cert

--gen-cert generuje samopodpisany certyfikat i klucz, następnie kończy działanie. Nie uruchamia serwera i nie włącza HTTPS samodzielnie:
Zapisuje parę cert + klucz pod data/certs/, zapisuje ich ścieżki do bloku server w config.yaml i wypisuje trzy wiersze:
Aby faktycznie serwować przez HTTPS, ustaw server.https: true w config.yaml i zrestartuj ipmideck. HTTPS nigdy nie jest włączane automatycznie.

​
Tryb demo

--demo uruchamia ipmideck na symulowanym sprzęcie zamiast prawdziwych BMC, przydatne do oceny pulpitu bez podłączonych serwerów:
Tryb demo jest ustawiany bardzo wcześnie, przed każdą gałęzią podpolecenia, więc cała aplikacja (konfiguracja i działający serwer) go widzi.

​
Resetowanie hasła administratora

reset-password interaktywnie tworzy lub aktualizuje login administratora, następnie kończy działanie bez uruchamiania serwera:
Pyta o Username:, a następnie New password: (ukryte wejście). Jeśli konto już istnieje, aktualizuje hasło tego użytkownika i wypisuje Password updated for <username>; w przeciwnym razie tworzy użytkownika i wypisuje User <username> created.

​
Automatyczne przeładowanie dla programowania

--reload to szybka ścieżka tylko dla programowania: przekazuje do własnego automatycznie przeładowującego nadzorcy uvicorn i wraca. Celowo pomija zabezpieczenie portu pojedynczej instancji opisane poniżej, ponieważ przeładowujący uruchamia własny proces nadzorcy.
--reload jest tylko dla programowania. Ponieważ omija zabezpieczenie pojedynczej instancji, uruchom go na hoście, gdzie żadna inna instancja ipmideck nie jest już związana z tym samym portem.

​
Kody wyjścia

Na ścieżce serwowania (nie --reload) ipmideck uruchamia zabezpieczenie pojedynczej instancji przed wiązaniem. Jeśli port jest już w użyciu, wypisuje błąd do stderr i kończy działanie z 1. Jeśli wiązanie zawodzi, ponieważ adres jest niedostępny lub niedozwolony, wypisuje odrębny błąd i również kończy działanie z 1.

​
Następne kroki