Synapse-admin

auch angeboten in: English, Русский

Synapse-admin ist ein Werkzeug zum Administrieren ihrees (Matrix) Synapse Homeservers - Hier können sie Benutzer Accounts verwalten, oder Medien und Chatverläufe löschen um Speicher freizugeben, etc. Auf dieser Seite finden sie eine Anleitung zur verwendung dieses Werkzeugs.

Die Benutzerverwaltungsübersicht von synapse-admin

Einloggen

Standardmäßig erreichen Sie die Administrationsoberfläche unter https://matrix.yourserver.com/synapse-admin und sie präsentiert Ihnen die folgenden Felder:

  • Username: Benötigt Ihre MXID (@username:yourserver.com), wie im Bild unten zu erkennen
  • Password: Benötigt Ihr matrix User Passwort
  • Homeserver URL: Dieses Feld sollte nach Eingabe einer korrekten MXID in das Username Feld automatisch vorausgefüllt seien, sollte das nicht passieren, geben sie die Adresse ihres Servers folgendermaßen ein https://matrix.yourserver.com, wie im Bild unten zu erkennen

Ein initial verstecktes “Label” zeigt Ihnen unterhalb der Eingabemaske die Homeserver Version an (z.B. Synapse version 1.62.0 wie im Bild unten zu erkennen). Dieses Label wird erst Angezeigt werden wenn Sie die korrekte URL ins Homeserver URL Feld eingetragen haben.

synapse-admin login page

Bekannte Probleme

Ungültige oder Leere Homeserver URL

Üblicherweise heißt dass das Sie nur den lokalen teil ihrer MXID in das Username Feld eingetragen haben. Sie müssen die ganze MXID (@username:yourserver.com) eintragen müssen, nicht nur username oder @username. In ganz besonderen Fällen, wie z.B. bei Verwendung eines CDNs ohne CORS Header, schlägt das automatische Setzen des Feldes fehl und sie müssen es manuell korrigieren.

Es erscheint kein Label mit der Homeserver Version

Wenn Sie keine Versionsangabe wie Synapse version x.xx.x unter dem Homeserver URL Feld sehen, haben Sie wahrscheinlich im Feld Homeserver URL eine falsche Adresse eingegeben oder Ihr Homeserver ist heruntergefahren (in 99% der Fälle ist die Homeserver URLnur falsch angegeben).

Netzwerk Fehler

You may see different error messages, but all of them can be split into the following groups: Sie könnten verschiedene Fehlermeldungen sehen, aber alle von ihnen fallen in eine der folgenden Gruppen:

Ungültige Homeserver URL

Yes, if your Homeserver URL field doesn’t contain a value like https://matrix.yourserver.com, that’s usually the problem Wenn Ihr Homeserver URL Feld keinen Wert im Format wie https://matrix.yourserver.com enthält, ist dies üblicherweise das Problem

Benutzername anstatt der MXID

Wenn Sie ihren Benutzernamen in das Username feld eingeben (der lokale Teil Ihrer MXID), wird es nicht funktionieren. Sie müssen die Vollständige MXID eingeben (@username:yourserver.com), nicht nur username oder @username.

Der Benutzer besitzt keine Homeserver Administrationsprivilegien

Um sich in den synapse-admin oder der synapse-admin API (dies verschiedene dinge) einzuloggen, benötigen sie einen matrix Benutzer der Homeserver Administrationsprivilegien hat.

Massen Registrierung

Um viele Benutzer auf einmal zu registrieren, können Sie die CSV-Importfunktion von synapse-admin verwenden.

Zunächst müssen Sie eine “csv”-Datei mit den zu importierenden Benutzerdaten mit folgendem Inhalt erstellen:

id,displayname,password,is_guest,admin,deactivated
jane.doe,Jane Doe,secretpassword,false,false,false

HINWEIS: die zweite Zeile ist ein Beispiel

  • id - den lokalen Teil der vermeintlichen Matrix-ID (username von @username:yourserver.com)
  • displayname - der menschenfreundliche Name des Nutzers
  • password - Passwort des Benutzers im Klartext
  • is_guest - Soll es ein Gastkonto sein?
  • admin - Sollte es ein Server-Administratorkonto sein?
  • deactivated - sollte es ein deaktiviertes Konto sein?

Als nächstes müssen Sie die Seite CSV-Import öffnen (klicken Sie auf die Schaltfläche “CSV IMPORT” in der rechten Ecke über der Benutzertabelle).

synapse-admin Benutzer Seite hervorgehoben CSV Import

Standardmäßig ist es auf https://matrix.yourserver.com/synapse-admin/#/import_users gehostet.

synapse-admin Benutzer CSV-Import

Auf dieser Seite müssen Sie die folgenden Optionen auswählen:

  • Conflict strategy: Stop on conflict (Optional, Standard)
  • IDs: Update existing records (verpflichtend)
  • Simulate only (linke untere Ecke): abwählen (verpflichtend)

Nachdem Sie all diese Optionen ausgewählt haben, klicken Sie auf IMPORT.

Löschen alter Medien

Um etwas Speicherplatz freizugeben, müssen Sie gelegentlich alte Medien (hochgeladene Dateien) von Ihrem Homeserver löschen.

Sie müssen sich dafür einloggen:

  • Klicken Sie auf den Users' Media Knopf in der Seitenleiste
  • Klicken Sie auf den DELETE MEDIA Knopf in der rechten Ecke, über der Tabelle

synapse-admin Medien Seite des Benutzers

Es wird sich daraufhin ein neues Fenster mit 2 verfügbaren Filtern öffnen:

  • last access before - Der übliche Filter. Alle zuletzt verfügbaren Medien (uploaded/viewed/downloaded) von vor dem angegebenen Datum werden gelöscht. Zum Beispiel, wenn Sie alle unbenutzten Medien der letzten 7 Tage löschen möchten, wählen Sie einfach als Datum die Vorwoche (wie im Bild unten zu sehen)
  • Larger then (in bytes) - Dies ist eine üblicherweise ungenutzte Option. Wenn sie benutzt wird, Löschen sie alle Medien die die angegebene Größe überschreiten und ist Zeitrahmen unabhängig

synapse-admin Fenster zum Löschen von Medien