From c8ff2e9922ab8bf36e9bba935f8b57a655dfe9e8 Mon Sep 17 00:00:00 2001 From: scriptos Date: Wed, 28 May 2025 10:17:11 +0200 Subject: [PATCH 1/3] initial --- Dockerfile | 2 ++ README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 77 insertions(+), 3 deletions(-) create mode 100644 Dockerfile diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..447c236 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,2 @@ +FROM matrixdotorg/synapse:latest +RUN pip install --no-cache-dir synapse-http-antispam \ No newline at end of file diff --git a/README.md b/README.md index ffe6696..eb588ea 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,81 @@ -# template_repository +# Synapse Docker Image mit integriertem HTTP Antispam Modul +> 📝 Diese Dokumentation ergĂ€nzt den Blogbeitrag +> [🔐 Matrix absichern mit Draupnir Antispam Modul (Blog)](https://www.cleveradmin.de/blog/2025/05/matrix-absichern-mit-draupnir-antispam-modul/) +> und bietet eine praktische Umsetzung in Form eines vorgefertigten Docker-Images mit integriertem Antispam-Modul fĂŒr Synapse. +Dieses Repository stellt ein angepasstes Docker-Image fĂŒr den Matrix Synapse Server bereit, welches das Modul [synapse-http-antispam](https://github.com/maunium/synapse-http-antispam) bereits enthĂ€lt. Es richtet sich an Administratoren, die Draupnir als externen Spamfilter fĂŒr ihre Synapse-Instanz nutzen möchten – besonders in Docker-Umgebungen. -Wichtig: Link fĂŒr Lizenz anpassen. +## 📩 Docker Image +Das Image basiert auf `matrixdotorg/synapse:latest` und wird automatisch um das HTTP Antispam Modul erweitert. Es kann direkt genutzt oder als Basis fĂŒr ein eigenes Compose-Setup verwendet werden. + +### VerfĂŒgbare Tags + +- `repo.techniverse.net/docker-hosted/custom-synapse:latest-antispam` – immer die aktuellste Version +- `repo.techniverse.net/docker-hosted/custom-synapse:v1.130.0-antispam` – spezifische Synapse-Version mit Modul + +### Beispiel: docker-compose.yml + +```yaml +services: + synapse-antispam: + build: + context: . + dockerfile: ./Dockerfile + image: custom-synapse:latest-antispam +``` + +Alternativ kannst du direkt ein vorgefertigtes Image mit Tag verwenden, z. B.: + +```yaml +image: repo.techniverse.net/docker-hosted/custom-synapse:v1.130.0-antispam +``` + +## 🔧 Konfiguration in homeserver.yaml + +Damit das Modul korrekt funktioniert, muss folgende Konfiguration in `homeserver.yaml` ergĂ€nzt werden: + +```yaml +modules: + - module: synapse_http_antispam.HTTPAntispam + config: + base_url: http://matrix-draupnir:8082/api/1/spam_check + authorization: '8EEGpJGVsR2yHmXaA9r74SwcmijLpQmraRm6HuivhG8in5KJ8H' + enabled_callbacks: + - check_event_for_spam + - user_may_invite + - user_may_join_room + fail_open: + check_event_for_spam: true + user_may_invite: false + user_may_join_room: false + async: + check_event_for_spam: true +``` + +## đŸ§© Funktionsweise des Moduls + +Das Modul leitet bestimmte Ereignisse an einen externen HTTP-Dienst weiter – in diesem Fall Draupnir – um dort zu prĂŒfen, ob eine Aktion als Spam gewertet werden soll. Es kann Nachrichten, Einladungen und Raumbeitritte blockieren, bevor sie ĂŒberhaupt ausgefĂŒhrt werden. + +**VerfĂŒgbare PrĂŒfungen (Callbacks):** +- `check_event_for_spam` – prĂŒft Nachrichten und Aktionen +- `user_may_invite` – prĂŒft Einladungserlaubnis +- `user_may_join_room` – prĂŒft Beitrittsberechtigung + +**Weitere Optionen:** +- `fail_open` – legt fest, ob bei Ausfall von Draupnir Aktionen erlaubt bleiben +- `async` – aktiviert die asynchrone PrĂŒfung fĂŒr bessere Performance + +## 🔗 WeiterfĂŒhrende Links + +- [🔐 Matrix absichern mit Draupnir Antispam Modul (Blog)](https://www.cleveradmin.de/blog/2025/05/matrix-absichern-mit-draupnir-antispam-modul/) +- [📚 Draupnir-Dokumentation](https://the-draupnir-project.github.io/draupnir-documentation/) +- [🧰 synapse-http-antispam (GitHub)](https://github.com/maunium/synapse-http-antispam) + +--- + +> Hinweis: Dieses Repository enthĂ€lt keine Quelltexte des Moduls selbst, sondern dokumentiert nur die Verwendung des vorkonfigurierten Docker-Images.

@@ -11,5 +83,5 @@ Wichtig: Link fĂŒr Lizenz anpassen.

-License License | Matrix Matrix | Matrix Mastodon +License License | Matrix Matrix | Matrix Mastodon

\ No newline at end of file -- 2.47.2 From 5a60eda9c76f006b7adc3e99464b10eff6140223 Mon Sep 17 00:00:00 2001 From: scriptos Date: Wed, 28 May 2025 10:21:02 +0200 Subject: [PATCH 2/3] =?UTF-8?q?'Verf=C3=BCgbare=20Tags'=20erweitert?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index eb588ea..3bd9e2e 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,10 @@ Das Image basiert auf `matrixdotorg/synapse:latest` und wird automatisch um das - `repo.techniverse.net/docker-hosted/custom-synapse:latest-antispam` – immer die aktuellste Version - `repo.techniverse.net/docker-hosted/custom-synapse:v1.130.0-antispam` – spezifische Synapse-Version mit Modul +👉 **Hinweis:** Die Images werden nur fĂŒr offizielle Hauptversionen von Synapse gebaut, nicht fĂŒr Pre-Releases oder Release Candidates. +Eine Übersicht aller verfĂŒgbaren Versionen findest du hier: +[https://github.com/element-hq/synapse/tags](https://github.com/element-hq/synapse/tags) + ### Beispiel: docker-compose.yml ```yaml -- 2.47.2 From 7f3b6c1aa2ec9b27464636ad4b4539e4fd829dc2 Mon Sep 17 00:00:00 2001 From: scriptos Date: Wed, 28 May 2025 10:25:14 +0200 Subject: [PATCH 3/3] Community gepflegt --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 3bd9e2e..2931bc5 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,12 @@ Das Modul leitet bestimmte Ereignisse an einen externen HTTP-Dienst weiter – i > Hinweis: Dieses Repository enthĂ€lt keine Quelltexte des Moduls selbst, sondern dokumentiert nur die Verwendung des vorkonfigurierten Docker-Images. +## 💬 Support & Community + +Du hast Fragen, brauchst UnterstĂŒtzung bei der Einrichtung oder möchtest dich einfach mit anderen austauschen, die Ă€hnliche Projekte betreiben? Dann schau gerne in unserer Techniverse Community vorbei: + +👉 **Matrix-Raum:** [#community:techniverse.net](https://matrix.to/#/#community:techniverse.net) +Wir freuen uns auf deinen Besuch und helfen dir gerne weiter!

-- 2.47.2