matrix-org/synapseSynapse: Matrix homeserver written in Python/Twisted.
Synapse |support| |development| |documentation| |license| |pypi| |python|
element-hq/synapse <https://github.com/element-hq/synapse>_Synapse ist ein Open-Source-Matrix <https://matrix.org/>-Homeserver, der von 2019 bis 2023 als Teil der Matrix.org Foundation entwickelt wurde. Die Matrix.org Foundation kann die Wartung von Synapse nicht finanzieren und es wird weiterhin von Element entwickelt <https://github.com/element-hq/synapse>; zusätzlich haben Sie die Wahl zwischen anderen Matrix-Homeservern <https://matrix.org/ecosystem/servers/>_.
Siehe den Blogbeitrag The future of Synapse and Dendrite <https://matrix.org/blog/2023/11/06/future-of-synapse-dendrite/>_ für weitere Informationen.
=========================================================================================================
Kurz gesagt, Matrix ist ein offener Standard für Kommunikation im Internet, der Föderation, Verschlüsselung und VoIP unterstützt. Matrix.org hat mehr zu den Zielen des Matrix-Projekts <https://matrix.org/docs/guides/introduction>_ zu sagen, und die formale Spezifikation <https://spec.matrix.org/>_ beschreibt die technischen Details.
.. contents::
Die Synapse-Dokumentation beschreibt, wie man Synapse installiert <https://matrix-org.github.io/synapse/latest/setup/installation.html>. Wir empfehlen die Verwendung von Docker-Images <https://matrix-org.github.io/synapse/latest/setup/installation.html#docker-images-and-ansible-playbooks> oder Debian-Paketen von Matrix.org <https://matrix-org.github.io/synapse/latest/setup/installation.html#matrixorg-packages>_.
.. _federation:
Synapse bietet eine Vielzahl von Konfigurationsoptionen <https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html>, die verwendet werden können, um sein Verhalten nach der Installation anzupassen. Es gibt zusätzliche Details, wie man Synapse für die Föderation konfiguriert <https://matrix-org.github.io/synapse/latest/federate.html>.
.. _reverse-proxy:
Es wird empfohlen, einen Reverse-Proxy wie nginx <https://nginx.org/en/docs/http/ngx_http_proxy_module.html>, Apache <https://httpd.apache.org/docs/current/mod/mod_proxy_http.html>, Caddy <https://caddyserver.com/docs/quick-starts/reverse-proxy>, HAProxy <https://www.haproxy.org/> oder relayd <https://man.openbsd.org/relayd.8>_ vor Synapse zu setzen. Ein Vorteil davon ist, dass Sie den standardmäßigen HTTPS-Port (443) für Matrix-Clients freigeben können, ohne Synapse mit Root-Rechten ausführen zu müssen. Informationen zur Konfiguration finden Sie in der Reverse-Proxy-Dokumentation <https://matrix-org.github.io/synapse/latest/reverse_proxy.html>_.
Die Anweisungen zum Aktualisieren von Synapse finden Sie in den Upgrade-Hinweisen_. Bitte überprüfen Sie diese Anweisungen, da das Upgrade für einige Versionen von Synapse zusätzliche Schritte erfordern kann.
.. _the upgrade notes: https://matrix-org.github.io/synapse/develop/upgrade.html
Synapse verwendet eine Reihe von Plattformabhängigkeiten wie Python und PostgreSQL und versucht, unterstützte Upstream-Versionen zu verfolgen. Weitere Einzelheiten finden Sie in der Deprecation Policy <https://matrix-org.github.io/synapse/latest/deprecation_policy.html>_.
Matrix liefert in einigen APIs rohe, vom Benutzer bereitgestellte Daten – insbesondere die Content-Repository-Endpunkte_.
.. _content repository endpoints: https://matrix.org/docs/spec/client_server/latest.html#get-matrix-media-r0-download-servername-mediaid
Obwohl wir uns angemessen bemühen, XSS-Angriffe zu mildern (z. B. durch Verwendung von CSP_), sollte ein Matrix-Homeserver nicht auf einer Domain gehostet werden, die andere Webanwendungen hostet. Dies gilt insbesondere für die gemeinsame Nutzung der Domain mit Matrix-Web-Clients und anderen sensiblen Anwendungen wie Webmail. Siehe https://developer.github.com/changes/2014-04-25-user-content-security für weitere Informationen.
.. _CSP: https://github.com/matrix-org/synapse/pull/1021
Idealerweise sollte der Homeserver nicht nur auf einer anderen Subdomain, sondern auf einer vollständig anderen registrierten Domain_ (auch als Top-Level-Site oder eTLD+1 bekannt) liegen. Dies liegt daran, dass einige Angriffe_ immer noch möglich sind, solange die beiden Anwendungen dieselbe registrierte Domain teilen.
.. _registered domain: https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-2.3
.. _some attacks: https://en.wikipedia.org/wiki/Session_fixation#Attacks_using_cross-subdomain_cookie
Um dies an einem Beispiel zu veranschaulichen: Wenn Ihre Element Web- oder andere sensible Webanwendung auf A.example1.com gehostet wird, sollten Sie Synapse idealerweise auf example2.com hosten. Ein gewisses Maß an Schutz wird durch das Hosten auf B.example1.com geboten, sodass dies in einigen Szenarien ebenfalls akzeptabel ist. Sie sollten Ihre Synapse jedoch nicht auf A.example1.com hosten.
Beachten Sie, dass sich all dies ausschließlich auf die Domain bezieht, die in Synapses public_baseurl-Einstellung verwendet wird. Insbesondere hat es keinen Einfluss auf die Domain, die in MXIDs erwähnt wird, die auf diesem Server gehostet werden.
Wenn Sie diesen Rat befolgen, stellen Sie sicher, dass selbst wenn ein XSS in Synapse gefunden wird, die Auswirkungen auf andere Anwendungen minimal sind.
Der einfachste Weg, Ihre neue Synapse-Installation auszuprobieren, ist, sich von einem Web-Client aus zu verbinden.
Sofern Sie keine Testinstanz von Synapse auf Ihrem lokalen Rechner betreiben, müssen Sie in der Regel TLS-Unterstützung aktivieren, bevor Sie sich erfolgreich von einem Client aus verbinden können: siehe TLS-Zertifikate <https://matrix-org.github.io/synapse/latest/setup/installation.html#tls-certificates>_.
Ein einfacher Einstieg ist die Anmeldung oder Registrierung über Element unter https://app.element.io/#/login bzw. https://app.element.io/#/register. Sie müssen den Server, bei dem Sie sich anmelden, von matrix.org ändern und stattdessen eine Homeserver-URL von https://<server_name>:8448 angeben (oder einfach https://<server_name>, wenn Sie einen Reverse-Proxy verwenden). Wenn Sie einen anderen Client bevorzugen, lesen Sie unsere Client-Übersicht <https://matrix.org/ecosystem/clients/>_.
Wenn alles gut geht, sollten Sie sich zumindest anmelden, einen Raum erstellen und Nachrichten senden können.
.. _client-user-reg:
Standardmäßig ist die Registrierung neuer Benutzer über Matrix-Clients deaktiviert. Um sie zu aktivieren:
Setzen Sie im
Konfigurationsabschnitt für die Registrierung <https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#registration>_
enable_registration: true in homeserver.yaml.
Dann entweder:
a. richten Sie ein CAPTCHA <https://matrix-org.github.io/synapse/latest/CAPTCHA_SETUP.html>_ ein, oder
b. setzen Sie enable_registration_without_verification: true in homeserver.yaml.
Wir empfehlen dringend die Verwendung eines CAPTCHA, insbesondere wenn Ihr Homeserver dem öffentlichen Internet ausgesetzt ist. Ohne diese Maßnahme kann jeder frei Konten auf Ihrem Homeserver registrieren. Dies kann von Angreifern ausgenutzt werden, um Spambots zu erstellen, die auf den Rest der Matrix-Föderation abzielen.
Ihr neuer Benutzername wird teilweise aus dem server_name und teilweise aus einem Localpart gebildet, den Sie bei der Erstellung des Kontos angeben. Ihr Name hat die Form::
@localpart:my.domain.name
(ausgesprochen „at localpart on my dot domain dot name“).
Wie beim Anmelden müssen Sie einen „Custom Server“ angeben. Geben Sie Ihren gewünschten localpart in das Feld „User name“ ein.
Die Admin-FAQ <https://matrix-org.github.io/synapse/latest/usage/administration/admin_faq.html>_ enthält Tipps zur Behebung einiger häufiger Probleme. Weitere Einzelheiten finden Sie in der umfassenderen Dokumentation von Synapse <https://matrix-org.github.io/synapse/latest/>_.
Für zusätzliche Unterstützung bei der Installation oder Verwaltung von Synapse fragen Sie bitte im Community-Support-Raum |room|_ (ggf. von einem matrix.org-Konto aus). Wir verwenden GitHub Issues nicht für Support-Anfragen, sondern nur für Fehlerberichte und Funktionswünsche.
.. |room| replace:: #synapse:matrix.org
.. _room: https://matrix.to/#/#synapse:matrix.org
.. |docs| replace:: docs
.. _docs: docs
Identitätsserver haben die Aufgabe, E-Mail-Adressen und andere Drittanbieter-IDs (3PIDs) auf Matrix-Benutzer-IDs abzubilden und den Besitz von 3PIDs zu überprüfen, bevor diese Zuordnung erstellt wird.
Sie sind nicht der Ort, an dem Konten oder Anmeldedaten gespeichert werden – diese befinden sich auf Homeservern. Identitätsserver dienen nur der Abbildung von Drittanbieter-IDs auf Matrix-IDs.
Dieser Prozess ist sehr sicherheitskritisch, da ein offensichtliches Spam-Risiko besteht, wenn es zu einfach ist, sich für Matrix-Konten anzumelden oder 3PID-Daten zu sammeln. Langfristig hoffen wir, ein dezentrales System zur Verwaltung zu schaffen (matrix-doc #712 <https://github.com/matrix-org/matrix-doc/issues/712>), aber in der Zwischenzeit wird die Rolle der Verwaltung vertrauenswürdiger Identitäten im Matrix-Ökosystem an einen Cluster bekannter vertrauenswürdiger Ökosystempartner ausgelagert, die „Matrix Identity Servers“ wie Sydent <https://github.com/matrix-org/sydent> betreiben, deren Aufgabe es ist, 3PID-Anmeldungen zu authentifizieren und zu verfolgen und öffentliche Schlüssel der Endbenutzer zu veröffentlichen.
Sie können Ihre eigene Kopie von Sydent hosten, aber dies verhindert, dass Sie andere Benutzer im Matrix-Ökosystem über ihre E-Mail-Adresse erreichen, und verhindert, dass sie Sie finden. Wir empfehlen daher, vorerst einen der zentralisierten Identitätsserver unter https://matrix.org oder https://vector.im zu verwenden.
Zur Wiederholung: Der Identitätsserver wird nur verwendet, wenn Sie sich dafür entscheiden, eine E-Mail-Adresse mit Ihrem Konto zu verknüpfen oder eine Einladung an einen anderen Benutzer über dessen E-Mail-Adresse zu senden.
Wir begrüßen Beiträge zur Synapse aus der Community! Der beste Einstieg ist unser Leitfaden für Mitwirkende <https://matrix-org.github.io/synapse/latest/development/contributing_guide.html>. Dieser ist Teil unserer umfangreicheren Dokumentation <https://matrix-org.github.io/synapse/latest>, die Informationen für Synapse-Entwickler sowie Synapse-Administratoren enthält. Entwickler könnten besonders interessiert sein an:
Synapses Datenbankschema <https://matrix-org.github.io/synapse/latest/development/database_schema.html>_,Notizen zu Synapses Implementierungsdetails <https://matrix-org.github.io/synapse/latest/development/internal_documentation/index.html>_, undwie wir Git verwenden <https://matrix-org.github.io/synapse/latest/development/git.html>_.Neben all dem treten Sie unserer Entwickler-Community auf Matrix bei: #synapse-dev:matrix.org <https://matrix.to/#/#synapse-dev:matrix.org>_, mit echten Menschen!
.. |support| image:: https://img.shields.io/matrix/synapse:matrix.org?label=support&logo=matrix :alt: (Holen Sie sich Support auf #synapse:matrix.org) :target: https://matrix.to/#/#synapse:matrix.org
.. |development| image:: https://img.shields.io/matrix/synapse-dev:matrix.org?label=development&logo=matrix :alt: (Diskutieren Sie die Entwicklung auf #synapse-dev:matrix.org) :target: https://matrix.to/#/#synapse-dev:matrix.org
.. |documentation| image:: https://img.shields.io/badge/documentation-%E2%9C%93-success :alt: (Gerenderte Dokumentation auf GitHub Pages) :target: https://matrix-org.github.io/synapse/latest/
.. |license| image:: https://img.shields.io/github/license/matrix-org/synapse :alt: (Lizenz in der LICENSE-Datei prüfen) :target: LICENSE
.. |pypi| image:: https://img.shields.io/pypi/v/matrix-synapse :alt: (Aktuelle Version auf PyPi) :target: https://pypi.org/project/matrix-synapse
.. |python| image:: https://img.shields.io/pypi/pyversions/matrix-synapse :alt: (Unterstützte Python-Versionen) :target: https://pypi.org/project/matrix-synapse