Skip to content

Commit 2188643

Browse files
author
Philipp Heckel
committed
Update docs
1 parent 344031b commit 2188643

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

docs/config.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -528,10 +528,7 @@ or the root domain:
528528
# Note that this config is most certainly incomplete. Please help out and let me know what's missing
529529
# via Discord/Matrix or in a GitHub issue.
530530

531-
ntfy.sh {
532-
reverse_proxy 127.0.0.1:2586
533-
}
534-
http://nfty.sh {
531+
ntfy.sh, http://nfty.sh {
535532
reverse_proxy 127.0.0.1:2586
536533
}
537534
```

docs/publish.md

+12
Original file line numberDiff line numberDiff line change
@@ -1174,6 +1174,18 @@ parameter (or any of its aliases `unifiedpush` or `up`) to `1` to [disable Fireb
11741174
option is mostly equivalent to `Firebase: no`, but was introduced to allow future flexibility. The flag additionally
11751175
enables auto-detection of the message encoding. If the message is binary, it'll be encoded as base64.
11761176

1177+
## Public topics
1178+
Obviously all topics on ntfy.sh are public, but there are a few designated topics that are used in examples, and topics
1179+
that you can use to try out what [authentication and access control](#authentication) looks like.
1180+
1181+
| Topic | User | Permissions | Description |
1182+
|------------------------------------------------|-----------------------------------|------------------------------------------------------|--------------------------------------|
1183+
| [announcements](https://ntfy.sh/announcements) | `*` (unauthenticated) | Read-only for everyone | Release announcements and such |
1184+
| [stats](https://ntfy.sh/stats) | `*` (unauthenticated) | Read-only for everyone | Daily statistics about ntfy.sh usage |
1185+
| [mytopic-rw](https://ntfy.sh/mytopic-rw) | `testuser` (password: `testuser`) | Read-write for `testuser`, no access for anyone else | Test topic |
1186+
| [mytopic-ro](https://ntfy.sh/mytopic-ro) | `testuser` (password: `testuser`) | Read-only for `testuser`, no access for anyone else | Test topic |
1187+
| [mytopic-wo](https://ntfy.sh/mytopic-wo) | `testuser` (password: `testuser`) | Write-only for `testuser`, no access for anyone else | Test topic |
1188+
11771189
## Limitations
11781190
There are a few limitations to the API to prevent abuse and to keep the server healthy. Almost all of these settings
11791191
are configurable via the server side [rate limiting settings](config.md#rate-limiting). Most of these limits you won't run into,

0 commit comments

Comments
 (0)