From 23dc57c96f8bd777028f3c8701a79ad3629016d7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jakobus=20Sch=C3=BCrz?= <jakobus.schuerz@home.arpa>
Date: Mon, 31 Oct 2022 00:36:10 +0100
Subject: [PATCH] add howto to README

---
 README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)

diff --git a/README.md b/README.md
index e69de29..fa51cc0 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,62 @@
+# UnifiedPush Server mit ntfy und CommonProxies für eine vollständige Notification im Selfhosting
+
+## Voraussetzungen:
+- Debian bullseye
+- 
+
+## Installation
+### ntfy
+Auf der Website von ntfy ist beschrieben, wie man ntfy am besten installiert. 
+Ich hab mich entschlossen, das Repo zu apt hinzuzufügen und ntfy dann über apt zu installieren.
+
+https://ntfy.sh/docs/install/
+
+Die Konfiguration in /etc/ntfy/server.yml muss noch an die eigenen Gegebenheiten angepasst werden.
+Z.B. die Domain unter der der Server später laufen wird.
+
+### common-proxies 
+Dazu lädt man sich von https://github.com/UnifiedPush/common-proxies/releases das letzte Release herunter (aktuell ist dies
+https://github.com/UnifiedPush/common-proxies/releases/download/v1.4.0/up-rewrite-linux-amd64 )
+
+Ich habe dies nach /opt/common-proxies getan.
+In dieses Verzeichnis kommt dann noch das Config-File /opt/common-proxies/config.toml mit folgendem Inhalt
+```
+listenAddr = "127.0.0.1:5000"
+verbose = true
+
+[gateway]
+        # AllowedHosts = ["abc.localhost:8443", "abc.localhost:8080",   "myinternaldomain.local"] 
+        AllowedHosts = ["ntfy.schuerz.at", "ntfy.schuerz.at:2586", "localhost", "localhost:2586"] 
+        [gateway.matrix]
+                enabled = true
+[rewrite]
+        [rewrite.fcm]
+                enabled = false
+        [rewrite.gotify]
+                enabled = false
+
+# see https://github.com/UnifiedPush/common-proxies/blob/main/docs/config.md for more info
+```
+
+wobei ntfy.schuerz.at die Domain ist, unter der mein ntfy-server erreichbar ist.
+
+Dann muss eine systemd-unit wie hier beschrieben https://github.com/UnifiedPush/common-proxies/blob/main/docs/install.md eingerichtet werden.
+
+### nginx
+In die nginx-config für den ntfy-Server https://ntfy.sh/docs/config/#nginxapache2caddy müssen lediglich folgende Zeilen hinzugefügt werden
+```
+# this sends traffic to common-proxies
+	location ~ ^/(FCM|UP|_matrix) {	
+		proxy_pass			http://127.0.0.1:5000;
+	}
+```
+
+## Installation der Clients
+Auf Android ist die App ntfy zu installieren. Idealerweise über F-Droid https://f-droid.org/de/packages/io.heckel.ntfy/
+In der App konfiguriert man noch den eigenen ntfy-Server als Default-Server.
+
+Für Element, Schildi-Chat oder Fluffychat kann man dann über die Einstellungen->Benachrichtigungen noch auswählen, dass ntfy für die Benachrichtigungen verwendet werden soll. 
+
+In den Einstellungen zu den Benachrichtigungen noch ganz unten bei "Benachrichtigungsziele" kontrollieren, ob wirklich die eigenen Server für die Benachrichtigungen verwendet werden.
+
+Und schon läuft die Benachrichtigung für Matrix gänzlich über eigene Benachrichtigungsservices.