vbatts/ntfy
1
0
Fork 0
Code Pull requests Activity

Update FAQ

Browse source
This commit is contained in:
Philipp Heckel 2022-06-12 11:22:15 -04:00
parent 41096ef1b0
commit eb2262d06e
2 changed files with 11 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/faq.md
View file

@ -11,17 +11,16 @@ the service.
Best effort. Best effort.
## What happens if there are multiple subscribers to the same topic? ## What happens if there are multiple subscribers to the same topic?
As per usual with pub-sub, all subscribers receive notifications if they are As per usual with pub-sub, all subscribers receive notifications if they are subscribed to a topic.
subscribed to a topic.
## Will you know what topics exist, can you spy on me? ## Will you know what topics exist, can you spy on me?
If you don't trust me or your messages are sensitive, run your own server. It's <a href="https://github.com/binwiederhier/ntfy">open source</a>. If you don't trust me or your messages are sensitive, run your own server. It's open source.
That said, the logs do not contain any topic names or other details about you. That said, the logs do contain topic names and IP addresses, but I don't use them for anything other than
Messages are cached for the duration configured in `server.yml` (12h by default) to facilitate service restarts, message polling and to overcome troubleshooting and rate limiting. Messages are cached for the duration configured in `server.yml` (12h by default)
client network disruptions. to facilitate service restarts, message polling and to overcome client network disruptions.
## Can I self-host it? ## Can I self-host it?
Yes. The server (including this Web UI) can be self-hosted, and the Android app supports adding topics from Yes. The server (including this Web UI) can be self-hosted, and the Android/iOS app supports adding topics from
your own server as well. Check out the [install instructions](install.md). your own server as well. Check out the [install instructions](install.md).
## Why is Firebase used? ## Why is Firebase used?
@ -34,16 +33,12 @@ of the app and [self-host your own ntfy server](install.md).
## How much battery does the Android app use? ## How much battery does the Android app use?
If you use the ntfy.sh server, and you don't use the [instant delivery](subscribe/phone.md#instant-delivery) feature, If you use the ntfy.sh server, and you don't use the [instant delivery](subscribe/phone.md#instant-delivery) feature,
the Android app uses no additional battery, since Firebase Cloud Messaging (FCM) is used. If you use your own server, the Android/iOS app uses no additional battery, since Firebase Cloud Messaging (FCM) is used. If you use your own server,
or you use *instant delivery*, the app has to maintain a constant connection to the server, which consumes about 0-1% of or you use *instant delivery* (Android only), the app has to maintain a constant connection to the server, which consumes
battery in 17h of use (on my phone). There has been a ton of testing and improvement around this. I think it's pretty about 0-1% of battery in 17h of use (on my phone). There has been a ton of testing and improvement around this. I think it's pretty
decent now. decent now.
## What is instant delivery? ## What is instant delivery?
[Instant delivery](subscribe/phone.md#instant-delivery) is a feature in the Android app. If turned on, the app maintains a constant connection to the [Instant delivery](subscribe/phone.md#instant-delivery) is a feature in the Android app. If turned on, the app maintains a constant connection to the
server and listens for incoming notifications. This consumes <a href="#battery-usage">additional battery</a>, server and listens for incoming notifications. This consumes additional battery (see above),
but delivers notifications instantly. but delivers notifications instantly.
## Why is there no iOS app (yet)?
I don't have an iPhone or a Mac, so I didn't make an iOS app yet. It'd be awesome if
<a href="https://github.com/binwiederhier/ntfy/issues/4">someone else could help out</a>.

1
docs/releases.md
View file

@ -23,6 +23,7 @@ and the [ntfy Android app](https://github.com/binwiederhier/ntfy-android/release
* Added [example](examples.md) for [Uptime Kuma](https://github.com/louislam/uptime-kuma) integration ([#315](https://github.com/binwiederhier/ntfy/pull/315), thanks to [@philippdormann](https://github.com/philippdormann)) * Added [example](examples.md) for [Uptime Kuma](https://github.com/louislam/uptime-kuma) integration ([#315](https://github.com/binwiederhier/ntfy/pull/315), thanks to [@philippdormann](https://github.com/philippdormann))
* Fix Docker install instructions ([#320](https://github.com/binwiederhier/ntfy/issues/320), thanks to [@milksteakjellybeans](https://github.com/milksteakjellybeans) for reporting) * Fix Docker install instructions ([#320](https://github.com/binwiederhier/ntfy/issues/320), thanks to [@milksteakjellybeans](https://github.com/milksteakjellybeans) for reporting)
* Add clarifying comments to base-url ([#322](https://github.com/binwiederhier/ntfy/issues/322), thanks to [@milksteakjellybeans](https://github.com/milksteakjellybeans) for reporting) * Add clarifying comments to base-url ([#322](https://github.com/binwiederhier/ntfy/issues/322), thanks to [@milksteakjellybeans](https://github.com/milksteakjellybeans) for reporting)
* Update FAQ for iOS app ([#321](https://github.com/binwiederhier/ntfy/issues/321), thanks to [@milksteakjellybeans](https://github.com/milksteakjellybeans) for reporting)
## ntfy iOS app v1.2 (UNRELEASED) ## ntfy iOS app v1.2 (UNRELEASED)