From 218864338707a3eb7c3390c7fb09089091076347 Mon Sep 17 00:00:00 2001 From: Philipp Heckel Date: Wed, 9 Feb 2022 16:15:48 -0500 Subject: [PATCH] Update docs --- docs/config.md | 5 +---- docs/publish.md | 12 ++++++++++++ 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/config.md b/docs/config.md index d6b136a..5827edc 100644 --- a/docs/config.md +++ b/docs/config.md @@ -528,10 +528,7 @@ or the root domain: # Note that this config is most certainly incomplete. Please help out and let me know what's missing # via Discord/Matrix or in a GitHub issue. - ntfy.sh { - reverse_proxy 127.0.0.1:2586 - } - http://nfty.sh { + ntfy.sh, http://nfty.sh { reverse_proxy 127.0.0.1:2586 } ``` diff --git a/docs/publish.md b/docs/publish.md index f3c95e0..a1fd14a 100644 --- a/docs/publish.md +++ b/docs/publish.md @@ -1174,6 +1174,18 @@ parameter (or any of its aliases `unifiedpush` or `up`) to `1` to [disable Fireb option is mostly equivalent to `Firebase: no`, but was introduced to allow future flexibility. The flag additionally enables auto-detection of the message encoding. If the message is binary, it'll be encoded as base64. +## Public topics +Obviously all topics on ntfy.sh are public, but there are a few designated topics that are used in examples, and topics +that you can use to try out what [authentication and access control](#authentication) looks like. + +| Topic | User | Permissions | Description | +|------------------------------------------------|-----------------------------------|------------------------------------------------------|--------------------------------------| +| [announcements](https://ntfy.sh/announcements) | `*` (unauthenticated) | Read-only for everyone | Release announcements and such | +| [stats](https://ntfy.sh/stats) | `*` (unauthenticated) | Read-only for everyone | Daily statistics about ntfy.sh usage | +| [mytopic-rw](https://ntfy.sh/mytopic-rw) | `testuser` (password: `testuser`) | Read-write for `testuser`, no access for anyone else | Test topic | +| [mytopic-ro](https://ntfy.sh/mytopic-ro) | `testuser` (password: `testuser`) | Read-only for `testuser`, no access for anyone else | Test topic | +| [mytopic-wo](https://ntfy.sh/mytopic-wo) | `testuser` (password: `testuser`) | Write-only for `testuser`, no access for anyone else | Test topic | + ## Limitations There are a few limitations to the API to prevent abuse and to keep the server healthy. Almost all of these settings are configurable via the server side [rate limiting settings](config.md#rate-limiting). Most of these limits you won't run into,