From 6dbe25fcc540a55a4a318d53a935501d1cd73aa4 Mon Sep 17 00:00:00 2001 From: binwiederhier Date: Tue, 20 Dec 2022 21:58:54 -0500 Subject: [PATCH] Known issues --- docs/faq.md | 24 +++++++++++++++++++++--- docs/known-issues.md | 28 ++++++++++++++++++++++++++++ mkdocs.yml | 3 ++- 3 files changed, 51 insertions(+), 4 deletions(-) create mode 100644 docs/known-issues.md diff --git a/docs/faq.md b/docs/faq.md index 1f820c0a..4eb17b98 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -4,11 +4,20 @@ Who knows. I didn't do a lot of research before making this. It was fun making it. ## Can I use this in my app? Will it stay free? -Yes. As long as you don't abuse it, it'll be available and free of charge. I do not plan on monetizing -the service. +Yes. As long as you don't abuse it, it'll be available and free of charge. While I will always allow usage of the ntfy.sh +server without signup and free of charge, I may also offer paid plans in the future. ## What are the uptime guarantees? -Best effort. +Best effort. + +ntfy currently runs on a single DigitalOcean droplet, without any scale out strategy or redundancies. When the time comes, +I'll add scale out features, but for now it is what it is. + +In the first year of its life, and to this day (Dec'22), ntfy had **no outages** that I can remember. Other than short +blips and some HTTP 500 spikes, it has been rock solid. + +There is a [status page](https://ntfy.statuspage.io/) which is updated based on some automated checks via the amazingly +awesome [healthchecks.io](https://healthchecks.io/) (_no affiliation, just a fan_). ## What happens if there are multiple subscribers to the same topic? As per usual with pub-sub, all subscribers receive notifications if they are subscribed to a topic. @@ -43,6 +52,15 @@ decent now. server and listens for incoming notifications. This consumes additional battery (see above), but delivers notifications instantly. +## Can you implement feature X? +Yes, maybe. Check out [existing GitHub issues](https://github.com/binwiederhier/ntfy/issues) to see if somebody else had +the same idea before you, or file a new issue. I'll likely get back to you within a few days. + +## I'm having issues with iOS, can you help? The iOS app is behind compared to the Android app, can you fix that? +The iOS is very bare bones and quite frankly a little buggy. I wanted to get something out the door to make the iOS users +happy, but halfway through I got frustrated with iOS development and paused development. I will eventually get back to +it, or hopefully, somebody else will come along and help out. Please review the [known issues](known-issues.md) for details. + ## 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 diff --git a/docs/known-issues.md b/docs/known-issues.md new file mode 100644 index 00000000..defb4a6e --- /dev/null +++ b/docs/known-issues.md @@ -0,0 +1,28 @@ +# Known issues +This is an incomplete list of known issues with the ntfy server, Android app, and iOS app. You can find a complete +list [on GitHub](https://github.com/binwiederhier/ntfy/labels/%F0%9F%AA%B2%20bug), but I thought it may be helpful +to have the prominent ones here to link to. + +## iOS app not refreshing (see [#267](https://github.com/binwiederhier/ntfy/issues/267)) +For some (many?) users, the iOS app is not refreshing the view when new notifications come in. Until you manually +swipe down, you do not see the newly arrived messages, even though the popup appeared before. + +This is caused by some weirdness between the Notification Service Extension (NSE), SwiftUI and Core Data. I am entirely +clueless on how to fix it, sadly, as it is ephemeral and now clear to me what is causing it. + +Please send experienced iOS developers my way to help me figure this out. + +## iOS app not receiving notifications (anymore) +If notifications do not show up at all anymore, there are a few causes for it (that I know of): + +**Firebase+APNS are being weird and buggy**: +If this is the case, usually it helps to **remove the topic/subscription and re-add it**. That will force Firebase to +re-subscribe to the Firebase topic. + +**Self-hosted only: No `upstream-base-url` set, or `base-url` mismatch**: +To make self-hosted servers work with the iOS +app, I had to do some horrible things (see [iOS instant notifications](config.md#ios-instant-notifications) for details). +Be sure that in your selfhosted server: + +* Set `upstream-base-url: "https://ntfy.sh"` (**not your own hostname!**) +* Ensure that the URL you set in `base-url` **matches exactly** what you set the Default Server in iOS to diff --git a/mkdocs.yml b/mkdocs.yml index 5a13edee..bd6e02f6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -87,8 +87,9 @@ nav: - "Examples": examples.md - "Integrations + projects": integrations.md - "Release notes": releases.md - - "Deprecation notices": deprecations.md - "Emojis 🥳 🎉": emojis.md + - "Known issues": known-issues.md + - "Deprecation notices": deprecations.md - "Development": develop.md - "Privacy policy": privacy.md