From a70ee81d3b1b59f2174bd6d1f7bc6b511126eff6 Mon Sep 17 00:00:00 2001 From: Philipp Heckel Date: Wed, 5 Oct 2022 15:12:51 -0400 Subject: [PATCH] Web app FAQ --- docs/faq.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/faq.md b/docs/faq.md index a9e5d165..1f820c0a 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -23,7 +23,7 @@ to facilitate service restarts, message polling and to overcome client network d 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). -## Why is Firebase used? +## Is Firebase used? In addition to caching messages locally and delivering them to long-polling subscribers, all messages are also published to Firebase Cloud Messaging (FCM) (if `FirebaseKeyFile` is set, which it is on ntfy.sh). This is to facilitate notifications on Android. @@ -43,6 +43,16 @@ decent now. server and listens for incoming notifications. This consumes additional battery (see above), but delivers notifications instantly. +## Can I disable the web app? Can I protect it with a login screen? +The web app is a static website without a backend (other than the ntfy API). All data is stored locally in the browser +cache and local storage. That means it does not need to be protected with a login screen, and it poses no additional +security risk. So technically, it does not need to be disabled. + +However, if you still want to disable it, you can do so with the `web-root: disable` option in the `server.yml` file. + +Think of the ntfy web app like an Android/iOS app. It is freely available and accessible to anyone, yet useless without +a proper backend. So as long as you secure your backend with ACLs, exposing the ntfy web app to the Internet is harmless. + ## Where can I donate? I have just very recently started accepting donations via [GitHub Sponsors](https://github.com/sponsors/binwiederhier). I would be humbled if you helped me carry the server and developer account costs. Even small donations are very much