Spis treści dokumentacji

Narzędzie gadka admin

Znajdziesz wszystkie polecenia programu gadka z flagami i przykładami.

Program /usr/local/bin/gadka to jednocześnie serwer i narzędzie administracyjne. Polecenia uruchamiasz na serwerze jako root.

Jak wywoływać

sudo gadka --config /etc/gadka/gadka.yaml admin <polecenie>

Flagę --config możesz zastąpić zmienną środowiskową GADKA_CONFIG.

Polecenia administracyjne

PolecenieFlagiCo robi
admin tenant-create--slug (wymagana), --name (wymagana)tworzy workspace
admin user-create--tenant, --email, --name (wymagane), --role (owner, admin albo member; domyślnie member)tworzy konto lokalne; hasło czyta ze standardowego wejścia
admin license server-id—wypisuje Server ID
admin license request—wypisuje kod instalacji potrzebny do zakupu klucza
admin license install--file (wymagana)sprawdza i instaluje klucz licencji
admin backup--out (wymagana)robi spójną kopię działającej bazy SQLite

Pozostałe polecenia

PolecenieFlagiCo robi
serve--roles (domyślnie api,gateway,worker)uruchamia serwer; tak startuje go usługa systemd
migrate up—uzupełnia schemat bazy do bieżącej wersji
migrate status—pokazuje stan migracji
healthcheck--url (domyślnie http://127.0.0.1:9090/readyz)kończy się kodem 0, gdy serwer jest gotowy
--version—wypisuje wersję programu

Przykłady

Utworzenie workspace'u i właściciela:

sudo gadka --config /etc/gadka/gadka.yaml admin tenant-create --slug firma --name "Firma Sp. z o.o."
sudo gadka --config /etc/gadka/gadka.yaml admin user-create --tenant firma --email jan@example.com --name "Jan Kowalski" --role owner

Hasło z pliku zamiast z klawiatury (plik usuń zaraz po użyciu):

sudo gadka --config /etc/gadka/gadka.yaml admin user-create --tenant firma --email ola@example.com --name "Ola Nowak" < haslo.txt

Kod instalacji i instalacja klucza:

sudo gadka --config /etc/gadka/gadka.yaml admin license request
sudo gadka --config /etc/gadka/gadka.yaml admin license install --file gadka-license.txt

Kopia bazy:

sudo gadka --config /etc/gadka/gadka.yaml admin backup --out /var/lib/gadka/gadka-kopia.db

Czego narzędzie nie robi

Nie ma poleceń do resetu hasła, resetu 2FA, usuwania kont ani zmiany ról. Role zmieniasz w aplikacji. Zobacz Użytkownicy i role.

Polecenia tworzące konta podlegają tym samym limitom licencji co aplikacja.

Co dalej