Server über Befehle verwalten

Die SpaceBuilder-Programmdatei (setfn-spacebuilder) enthält neben der Funktion zum Starten des Servers auch Verwaltungsbefehle für das Terminal. Sie verwenden sie, um Konten und Zugangsbeschränkungen wiederherzustellen, wenn Sie sich nicht auf der Administrationsseite anmelden können, oder um Einstellungen wie Port und Sprache zu prüfen.

Dieses Dokument ist eine Referenz für Administratoren, die den Server installieren und betreiben. Erledigen Sie die übliche Verwaltung auf der Administrationsseite und verwenden Sie die Befehle nur, wenn die Administrationsseite nicht verfügbar ist.

Bevor Sie beginnen

• Führen Sie die Befehle im Terminal des Computers aus, auf dem SpaceBuilder installiert ist.
• Führen Sie sie mit demselben Betriebssystem-Benutzerkonto aus, unter dem SpaceBuilder läuft. Der Standardpfad der Konfiguration liegt im Home-Verzeichnis dieses Benutzers; wenn Sie in einem anderen Pfad installiert haben, müssen Sie dieselbe Konfigurationsdatei angeben wie der laufende Server.
• Die Beispiele gehen davon aus, dass die Programmdatei im Home-Verzeichnis liegt (~/setfn-spacebuilder). Liegt sie an einem anderen Ort, geben Sie stattdessen diesen Pfad ein.
• Verwaltungsbefehle, die mit user, unblock, ip, admin, login oder logout beginnen, führen Sie bei gestopptem Server aus.

Konfigurationspfad des laufenden Servers angeben

Die Standard-Konfigurationsdatei unter Linux ist ~/.config/SetFN/config.yaml. Wenn der Dienst unter einem anderen Konto oder mit einem eigenen Konfigurationspfad läuft, prüfen Sie den Pfad, der im Startbefehl des Dienstes angegeben ist.

Geben Sie diese Konfigurationsdatei mit -c oder --config an. Das folgende Beispiel zeigt einen Server, der mit /srv/setfn/config.yaml betrieben wird. Ersetzen Sie den Pfad durch den tatsächlichen Dateipfad.

~/setfn-spacebuilder -c /srv/setfn/config.yaml port get
~/setfn-spacebuilder -c /srv/setfn/config.yaml user list

Hängen Sie dieselbe Option -c auch an die anderen Verwaltungsbefehle in diesem Dokument an. Wenn Sie den Server mit einem über -H oder --home angegebenen Pfad betreiben, übernehmen Sie auch diese Option aus dem Betriebsbefehl. Wird -c zusätzlich angegeben, hat -c bei der Auswahl der Konfigurationsdatei Vorrang.

Server stoppen und wieder starten

Die Befehle zur Verwaltung von Benutzern, Zugangsbeschränkungen und Geräteverbindungen sowie admin status, admin logout-all usw. öffnen die Datenbank des Servers direkt. Wenn ein anderer Prozess dieselbe Datenbank verwendet, kann der Befehl nach erneuten Versuchen mit der Meldung Database is still locked enden. admin reset-config öffnet die Datenbank nicht, sondern löscht die Konfigurationsdatei; führen Sie aber auch diesen Vorgang bei gestopptem Server aus.

Wenn Sie den automatischen Start eingerichtet haben, gehen Sie in dieser Reihenfolge vor.

sudo systemctl stop setfn-spacebuilder

Führen Sie die benötigten Befehle aus und starten Sie den Server anschließend wieder.

sudo systemctl start setfn-spacebuilder

Wenn der Server direkt in einem Terminal läuft, stoppen Sie ihn dort mit Ctrl+C.

Passwort für den Konsolenzugriff festlegen

Die Befehle user und unblock fragen bei der Ausführung nach dem Console Access Password. Dieses Passwort ist der Wert, den Sie in der Umgebungsvariablen SETFN_CONSOLE_PASSWORD festgelegt haben. Legen Sie den Wert vor dem Ausführen des Befehls im selben Terminal fest.

export SETFN_CONSOLE_PASSWORD="selbst gewähltes Passwort"

Dieser Wert dient nur der Zugriffsprüfung für lokale Konsolenbefehle. Er ändert weder das Administratorpasswort des Workspace noch das Passwort des SetFN-Kontos. Bei Console Access Password geben Sie den Wert ein, den Sie in diesem Terminal festgelegt haben.

Befehle im Überblick

Die ausführlichen Optionen eines Befehls sehen Sie, indem Sie --help an den Befehl anhängen.

~/setfn-spacebuilder user --help

Zugang wiederherstellen, wenn die Anmeldung nicht möglich ist

Führen Sie alle folgenden Befehle aus, nachdem Sie den Server gestoppt und das Passwort für den Konsolenzugriff festgelegt haben.

Anmeldesperre aufheben

Wenn der Zugang des Administrators nach wiederholten Anmeldefehlern gesperrt wurde, fügen Sie die IP des Computers, von dem aus Sie zugreifen möchten, zur Sicherheits-Zulassungsliste hinzu.

~/setfn-spacebuilder unblock --ip 203.0.113.10

Den aktuellen Wiederherstellungsstatus prüfen Sie mit dem folgenden Befehl.

~/setfn-spacebuilder unblock --status

Wenn Sie auch nach dem Hinzufügen der IP keinen Zugang erhalten, schalten Sie die Anmeldesicherheit vorübergehend aus.

~/setfn-spacebuilder unblock --all

~/setfn-spacebuilder unblock --enable-security

Zielbenutzerkonto prüfen

Zeigen Sie zuerst die vorhandenen Benutzerkonten an.

~/setfn-spacebuilder user list

Suchen Sie in der Spalte Username den Anmeldenamen des Zielkontos. Ersetzen Sie in den folgenden Befehlen den gesamten Platzhalter "<Benutzerkonto>" durch diesen Wert. Die Spalte Nick enthält dagegen den Anzeigenamen.

Administratorpasswort ändern

~/setfn-spacebuilder user password -u "<Benutzerkonto>" --password "neues Passwort"

Ersetzen Sie bei -u den gesamten Platzhalter durch den in der Spalte Username angezeigten Anmeldenamen des bestehenden Workspace-Benutzerkontos. Verwenden Sie nicht den in Nick angezeigten Anzeigenamen. Da der eingegebene Befehl im Terminalverlauf gespeichert bleibt, empfiehlt es sich, das Passwort nach der Anmeldung auf der Administrationsseite noch einmal zu ändern. Das neue Passwort muss den Passwortregeln des Servers entsprechen; häufig verwendete oder aus Datenlecks bekannte Passwörter werden abgelehnt. Die Standardregel neu installierter Server verlangt mindestens 12 Zeichen.

Zwei-Faktor-Authentifizierung für Administratoren ausschalten

Verwenden Sie diesen Befehl, wenn ein Administrator Authenticator-App und Wiederherstellungscodes verloren hat, sich nicht anmelden kann und kein anderer Hauptadministrator die Zwei-Faktor-Authentifizierung auf der Administrationsseite zurücksetzen kann.

~/setfn-spacebuilder user mfa reset "<Benutzerkonto>"

Die Authenticator-App-Registrierung und die Wiederherstellungscodes dieses Kontos werden entfernt, und alle aktiven Anmeldesitzungen werden beendet. Die nächste Anmeldung erfolgt nur mit Passwort; ist die Richtlinie Zwei-Faktor für Administratoren erzwingen eingeschaltet, muss die Zwei-Faktor-Authentifizierung nach der Anmeldung neu eingerichtet werden. Die Ausführung wird im Auditprotokoll als Zwei-Faktor zurückgesetzt festgehalten. Bei einem Konto ohne Zwei-Faktor-Authentifizierung wird nichts geändert, sondern nur ein Hinweis angezeigt. Die Einrichtung ist unter Zwei-Faktor-Authentifizierung für Administratoren einrichten beschrieben.

Administratorrechte zurückerlangen

Wenn kein Konto mit Administratorrechten vorhanden ist, ändern Sie die Rolle eines bestehenden Benutzers.

~/setfn-spacebuilder user promote -u "<Benutzerkonto>" -r admin

Bei diesem Befehl bezeichnet -u den Anmeldenamen des bestehenden Benutzerkontos. -r admin weist den festen Rollenwert admin zu; admin in admin status ist dagegen der Name einer Verwaltungsbefehlsgruppe.

Benutzerkonten hinzufügen und löschen

~/setfn-spacebuilder user add -u newadmin -n "Neuer Administrator" --admin

Zum Löschen eines Kontos geben Sie den Benutzernamen an. Der letzte Administrator kann nicht gelöscht werden.

~/setfn-spacebuilder user delete -u olduser

IP-Zugriffsbeschränkung verwalten

Wenn die IP-Zugriffsbeschränkung eingeschaltet ist, ist der Zugriff auf die Administrationsseite nur von IPs in der Zulassungsliste möglich. Wenn Sie wegen einer falsch konfigurierten Zulassungsliste nicht auf die Administrationsseite zugreifen können, korrigieren Sie sie mit den Befehlen.

Prüfen Sie den aktuellen Status und die Zulassungsliste.

~/setfn-spacebuilder ip status

Fügen Sie der Zulassungsliste eine IP-Adresse oder einen CIDR-Bereich hinzu oder entfernen Sie sie.

~/setfn-spacebuilder ip add --ip 192.168.1.100
~/setfn-spacebuilder ip add --ip 192.168.1.0/24
~/setfn-spacebuilder ip remove --ip 192.168.1.100

Schalten Sie die Zugangsbeschränkung ein oder aus.

~/setfn-spacebuilder ip enable
~/setfn-spacebuilder ip disable

Servereinstellungen prüfen

~/setfn-spacebuilder port get
~/setfn-spacebuilder homepath get
~/setfn-spacebuilder lang get

• Die Sprache der Terminalmeldungen können Sie direkt ändern, z. B. mit lang set ko.
• port set <Port> und homepath set <Pfad> ändern den Wert nicht. Sie zeigen an, was in die Konfigurationsdatei einzutragen ist; port set zeigt zusätzlich, ob der Port verfügbar ist. Die Änderung wird erst wirksam, wenn Sie die Konfigurationsdatei angepasst und den Server neu gestartet haben.
• Verwendbar sind die Ports 3000 bis 65535. Der Standardport ist 8510.

Geräteverbindung zum SetFN-Konto wiederherstellen

Diese Befehle verwalten die Verbindung zwischen dem SetFN-Konto und dem Servergerät. Anmeldesperren oder Passwörter von Workspace-Benutzerkonten stellen Sie mit den oben beschriebenen Befehlen user und unblock wieder her.

Stoppen Sie den Server und starten Sie die Verbindung mit demselben Konfigurationspfad wie der laufende Server.

~/setfn-spacebuilder login

Folgen Sie den im Terminal angezeigten Authentifizierungshinweisen und schließen Sie die Freigabe im Browser ab. Um die Verbindung eines bereits registrierten Geräts erneut durchzuführen, verwenden Sie den folgenden Befehl.

~/setfn-spacebuilder login --force

Wenn die Authentifizierungsdaten abgelaufen oder ungültig sind und eine erneute Verbindung nötig ist, heben Sie die bestehende Verbindung auf und registrieren Sie das Gerät neu.

~/setfn-spacebuilder logout
~/setfn-spacebuilder login --force

logout bereinigt standardmäßig die lokalen Site-Token, den Geräteschlüssel und die Authentifizierungsdatei. logout --unlink ist eine Kompatibilitätsoption mit demselben vollständigen Trennvorgang. Um Geräteschlüssel und Authentifizierungsdatei zu behalten und nur die Site-Sitzungstoken zu bereinigen, verwenden Sie logout --keep-link.

Nach der erneuten Verbindung starten Sie den Server neu und prüfen auf der Administrationsseite den Status der Lizenzregistrierung.

Serverstatus und Anmeldesitzungen verwalten

Prüfen Sie den Serverstatus und die aktuellen Einstellungen.

~/setfn-spacebuilder admin status

Wenn Sie vermuten, dass Kontodaten abgeflossen sind, melden Sie alle Benutzer ab. Die Benutzer müssen sich erneut anmelden.

~/setfn-spacebuilder admin logout-all

Zum Sichern und Wiederherstellen des Wissensspeichers lesen Sie Wissensspeicher betreiben.

Hinweise

• Linux speichert nur die ersten 15 Zeichen eines Prozessnamens, daher wird der Prozess in ps -e oder top als setfn-spacebuil angezeigt. Um zu prüfen, ob der Server läuft, verwenden Sie pgrep -f setfn-spacebuilder.
• Aufgaben, die auf der Administrationsseite möglich sind, wie das Hinzufügen von Benutzern oder das Blockmanagement, sollten Sie bevorzugt dort erledigen. Die Befehle für Konten und Sperren lassen sich nur bei gestopptem Server ausführen.

Verwandte Dokumente

• Installation unter Linux
• Blockmanagement
• Zwei-Faktor-Authentifizierung für Administratoren einrichten
• Wissensspeicher betreiben
• Leitfaden zur Fehlerbehebung