dendrite admin interface

Dendrite-Administratorschnittstelle

Eine Bot-Schnittstelle zum Verwalten eines Dendrite-Servers mithilfe der Verwaltungs-API und einiger Datenbankschnittstellen

Beiträge sind herzlich willkommen. Es wird jedoch zu diesem Zeitpunkt empfohlen, dass Sie sich dem Diskussionsraum anschließen, bevor Sie einen Beitrag leisten, um sicherzustellen, dass Ihre Beiträge mit dem Endziel des Projekts übereinstimmen

Fühlen Sie sich frei, für jede gewünschte Funktion ein Problem zu stellen, damit ich, wenn ich endlich Zeit habe, eine Liste durchgehen und abhaken kann.

Leerzeichen: #admin-interface:pain.agency | Diskussionsraum: #admin-interface-support:pain.agency

Aufstellen

• Stellen Sie sicher, dass Sie eine halb aktuelle Version von Node und NPM installiert haben. Ich verwende derzeit Node v18.18.0 (überprüfen Sie es mit node -v ) und NPM-Version 9.2.0 auf meinem VPS. Wenn Sie Debian ausführen, wie ich es auf meinem VPS tue, möchten Sie möglicherweise eine aktuellere Version des Knotens aus dem Snap Store erhalten oder aus dem Quellcode erstellen.
• Laden Sie die neueste stabile oder Beta-Version .zip oder .tar.gz von https://github.com/jjj333-p/dendrite-admin-interface/releases herunter und entpacken Sie sie oder klonen Sie sie vom main , wenn Sie auf dem neuesten Stand sein möchten.
• Führen Sie npm install aus, wodurch alle erforderlichen Abhängigkeiten installiert werden sollten.
• Kopieren Sie die Datei unter examples/login.yaml nach db/login.yaml und geben Sie diese Informationen ein. Anweisungen zum Ausfüllen dieser Informationen finden Sie in den Kommentaren der Beispieldatei.
• Führen Sie den Bot aus ( node index.js ).
• Befehle sind nur im Administrationsraum verfügbar, der in der Datei login.yaml definiert ist.

Derzeit implementierte Befehle:

• evacuate User MXID | Room ID | Room Alias> ?<--preserve | -p>

  • Wenn eine Raum-ID oder ein Alias ​​angegeben wird, führt die Schnittstelle den Endpunkt „Raum evakuieren“ auf dieser Raum-ID oder diesem Alias ​​aus, wodurch alle Benutzer auf diesem Server diesen Raum verlassen. Wenn das Flag --preserve oder -p nicht angegeben ist, wird auch der Endpunkt „Raum löschen“ ausgeführt, wodurch der Raumstatus aus der Datenbank gelöscht wird.
  • Bei Angabe einer MXID eines lokalen Benutzers, z. B. @localpart:your.server , führt die Schnittstelle den Endpunkt „Benutzer evakuieren“ für diesen Benutzer aus, wodurch dieses Konto alle Räume verlässt, in denen es sich befindet.

• passwd <mxid/localpart> <log out accounts?> ?<password>

  Setzen Sie das Passwort eines Benutzers zurück

  • mxid/localpart – Sie können entweder den lokalen Teil eines Benutzers (z. B. jjj333 ) oder die gesamte mxid (z. B. @jjj333:pain.agency ) angeben. Beachten Sie, dass es sich hierbei um einen lokalen Benutzer handeln muss, da für Remote-Benutzer nichts unternommen werden kann.
  • log out accounts?
    • t oder true um alle angemeldeten Sitzungen des Kontos abzumelden.
    • f oder false um alle Sitzungen angemeldet zu halten.
  • ? password – Legen Sie optional ein Passwort zum Zurücksetzen fest. Wenn kein Passwort angegeben wird, wird standardmäßig eine zufällige 35-Byte-Base64-Zeichenfolge zurückgegeben. Aufgrund von Dendrite muss das Passwort mindestens 8 Zeichen lang sein. Aufgrund technischer Schwierigkeiten können Sie über diese Schnittstelle keine Leerzeichen in einem Passwort festlegen.

• newaccount <mxid/localpart> ?<password>

  Erstellen Sie ein neues normales Benutzerkonto.

  • mxid/localpart – der Benutzername, der für den Benutzer erstellt werden soll. Dies kann entweder nur der lokale Teil oder die vollständige MXID sein.
  • ? password – Passwort, das für das neue Konto festgelegt werden soll. Wenn keine angegeben wird, wird eine Base64-Zeichenfolge mit 35 Bytes generiert und zurückgegeben.

• deactivate <mxid/localpart>

  deaktiviert den angegebenen Benutzer

  • mxid/localpart – Sie können entweder den lokalen Teil eines Benutzers (z. B. jjj333 ) oder die gesamte mxid (z. B. @jjj333:pain.agency ) angeben. Beachten Sie, dass es sich hierbei um einen lokalen Benutzer handeln muss, da für Remote-Benutzer nichts unternommen werden kann.
  • Setzt den Anzeigenamen und pfp auf die in der bot login.yaml definierten Werte, da Dendrite diese vor der Deaktivierung nicht entfernt. Daher müssen wir sie bereinigen und können ihnen in der Zwischenzeit Flair verleihen.
  • Ich werde um eine Bestätigung bitten, um versehentliche Fahrten zu verhindern
  • HINWEIS : Dieser Befehl ist permanent und muss mit Vorsicht verwendet werden!