vbatts/ntfy
1
0
Fork 0
Code Pull requests Activity

Refine UP docs

Browse source
This commit is contained in:
Philipp Heckel 2022-11-14 15:21:02 -05:00
parent e7b575badc
commit fd7f83378d
2 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/config.md
View file

@ -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" === "Prefix"
``` ```
@ -320,11 +325,9 @@ UnifiedPush requires that the [application server](https://unifiedpush.org/spec/
=== "Explicitly" === "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 ## E-mail notifications
To allow forwarding messages via e-mail, you can configure an **SMTP server for outgoing messages**. Once configured, 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. you can set the `X-Email` header to [send messages via e-mail](publish.md#e-mail-notifications) (e.g.

3
docs/releases.md
View file

@ -17,10 +17,11 @@ and the [ntfy Android app](https://github.com/binwiederhier/ntfy-android/release
**Documentation:** **Documentation:**
* GitHub Actions example ([#492](https://github.com/binwiederhier/ntfy/pull/492), thanks to [@ksurl](https://github.com/ksurl)) * 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:** **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 ## ntfy server v1.29.0
Released November 12, 2022 Released November 12, 2022