From fd7f83378d74864be430e03ee7b3d34015a18d31 Mon Sep 17 00:00:00 2001 From: Philipp Heckel Date: Mon, 14 Nov 2022 15:21:02 -0500 Subject: [PATCH] Refine UP docs --- docs/config.md | 13 ++++++++----- docs/releases.md | 3 ++- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/config.md b/docs/config.md index fd367f00..655b56cf 100644 --- a/docs/config.md +++ b/docs/config.md @@ -309,9 +309,14 @@ with the given username/password. Be sure to use HTTPS to avoid eavesdropping an ])); ``` -### UnifiedPush compatibility +### Example: UnifiedPush +[UnifiedPush](https://unifiedpush.org) 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. Please refer to the +**[UnifiedPush documentation](https://unifiedpush.org/users/distributors/ntfy/#limit-access-to-some-users)** for more details. -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: +To enable support for UnifiedPush for private servers (i.e. `auth-default-access: "deny-all"`), you should either +allow anonymous write access for the entire prefix or explicitly per topic: === "Prefix" ``` @@ -320,11 +325,9 @@ UnifiedPush requires that the [application server](https://unifiedpush.org/spec/ === "Explicitly" ``` - $ ntfy access '*' 'upYzMtZGZiYTY5' write-only + $ 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. diff --git a/docs/releases.md b/docs/releases.md index 48c396bd..f5fc9a49 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -17,10 +17,11 @@ and the [ntfy Android app](https://github.com/binwiederhier/ntfy-android/release **Documentation:** * GitHub Actions example ([#492](https://github.com/binwiederhier/ntfy/pull/492), thanks to [@ksurl](https://github.com/ksurl)) +* UnifiedPush ACL clarification ([#497](https://github.com/binwiederhier/ntfy/issues/497), thanks to [@bt90](https://github.com/bt90)) **Other things:** -* Put ntfy.sh/docs assets on GitHub pages to reduce AWS outbound traffic cost ([#491](https://github.com/binwiederhier/ntfy/issues/491)) +* Put ntfy.sh docs on GitHub pages to reduce AWS outbound traffic cost ([#491](https://github.com/binwiederhier/ntfy/issues/491)) ## ntfy server v1.29.0 Released November 12, 2022