From e7b575badcc793c85c9e8c66e62c8a68801a06f4 Mon Sep 17 00:00:00 2001 From: bt90 <btom1990@googlemail.com> Date: Mon, 14 Nov 2022 19:38:55 +0100 Subject: [PATCH] Add UnifiedPush section --- docs/config.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/config.md b/docs/config.md index babb5839..fd367f00 100644 --- a/docs/config.md +++ b/docs/config.md @@ -309,6 +309,22 @@ with the given username/password. Be sure to use HTTPS to avoid eavesdropping an ])); ``` +### UnifiedPush compatibility + +UnifiedPush requires that the [application server](https://unifiedpush.org/spec/definitions/#application-server) (e.g. Synapse, Fediverse Server, …) has anonymous write access to the [topic](https://unifiedpush.org/spec/definitions/#endpoint) used for push messages. The topic names used by UnifiedPush all start with the `up` prefix. You should either allow anonymous write access for the entire prefix or explicitly per topic: + +=== "Prefix" + ``` + $ ntfy access '*' 'up*' write-only + ``` + +=== "Explicitly" + ``` + $ ntfy access '*' 'upYzMtZGZiYTY5' write-only + ``` + +see https://unifiedpush.org/users/distributors/ntfy/#limit-access-to-some-users + ## E-mail notifications To allow forwarding messages via e-mail, you can configure an **SMTP server for outgoing messages**. Once configured, you can set the `X-Email` header to [send messages via e-mail](publish.md#e-mail-notifications) (e.g.