Python-ntfy

Released November 17, 2022

This is mostly a bugfix release to address the high load on ntfy.sh. There are now two new options that allow
synchronous batch-writing of messages to the cache. This avoids database locking, and subsequent pileups of waiting
requests.

**Bug fixes:**

* High-load servers: Allow asynchronous batch-writing of messages to cache via `cache-batch-*` options ([498](https://github.com/binwiederhier/ntfy/issues/498)/[#502](https://github.com/binwiederhier/ntfy/pull/502))
* Sender column in cache.db shows invalid IP ([503](https://github.com/binwiederhier/ntfy/issues/503))

**Documentation:**

* GitHub Actions example ([492](https://github.com/binwiederhier/ntfy/pull/492), thanks to [ksurl](https://github.com/ksurl))
* UnifiedPush ACL clarification ([497](https://github.com/binwiederhier/ntfy/issues/497), thanks to [bt90](https://github.com/bt90))
* Install instructions for Kustomize ([463](https://github.com/binwiederhier/ntfy/pull/463), thanks to [l-maciej](https://github.com/l-maciej))

**Other things:**

* Put ntfy.sh docs on GitHub pages to reduce AWS outbound traffic cost ([491](https://github.com/binwiederhier/ntfy/issues/491))
* The ntfy.sh server hardware was upgraded to a bigger box. If you'd like to help out carrying the server cost, **[sponsorships and donations](https://github.com/sponsors/binwiederhier)** 💸 would be very much appreciated

Released November 12, 2022

This release adds the ability to add rate limit exemptions for IP ranges instead of just specific IP addresses. It also fixes
a few bugs in the web app and the CLI and adds lots of new examples and install instructions.

Thanks to [some love on HN](https://news.ycombinator.com/item?id=33517944), we got so many new ntfy users trying out ntfy
and joining the [chat rooms](https://github.com/binwiederhier/ntfy#chat--forum). **Welcome to the ntfy community to all of you!**
We also got a ton of new **[sponsors and donations](https://github.com/sponsors/binwiederhier)** 💸, which is amazing. I'd like to thank
all of you for believing in the project, and for helping me pay the server cost. The HN spike increased the AWS cost quite a bit.

**Features:**

* Allow IP CIDRs in `visitor-request-limit-exempt-hosts` ([423](https://github.com/binwiederhier/ntfy/issues/423), thanks to [karmanyaahm](https://github.com/karmanyaahm))

**Bug fixes + maintenance:**

* Subscriptions can now have a display name ([370](https://github.com/binwiederhier/ntfy/issues/370), thanks to [tfheen](https://github.com/tfheen) for reporting)
* Bump Go version to Go 18.x ([422](https://github.com/binwiederhier/ntfy/issues/422))
* Web: Strip trailing slash when subscribing ([428](https://github.com/binwiederhier/ntfy/issues/428), thanks to [raining1123](https://github.com/raining1123) for reporting, and [wunter8](https://github.com/wunter8) for fixing)
* Web: Strip trailing slash after server URL in publish dialog ([441](https://github.com/binwiederhier/ntfy/issues/441), thanks to [wunter8](https://github.com/wunter8))
* Allow empty passwords in `client.yml` ([374](https://github.com/binwiederhier/ntfy/issues/374), thanks to [cyqsimon](https://github.com/cyqsimon) for reporting, and [wunter8](https://github.com/wunter8) for fixing)
* `ntfy pub` will now use default username and password from `client.yml` ([431](https://github.com/binwiederhier/ntfy/issues/431), thanks to [wunter8](https://github.com/wunter8) for fixing)
* Make `ntfy sub` work with `NTFY_USER` env variable ([447](https://github.com/binwiederhier/ntfy/pull/447), thanks to [SuperSandro2000](https://github.com/SuperSandro2000))
* Web: Disallow GET/HEAD requests with body in actions ([468](https://github.com/binwiederhier/ntfy/issues/468), thanks to [ollien](https://github.com/ollien))

**Documentation:**

* Updated developer docs, bump nodejs and go version ([414](https://github.com/binwiederhier/ntfy/issues/414), thanks to [YJSoft](https://github.com/YJSoft) for reporting)
* Officially document `?auth=..` query parameter ([433](https://github.com/binwiederhier/ntfy/pull/433), thanks to [wunter8](https://github.com/wunter8))
* Added Rundeck example ([427](https://github.com/binwiederhier/ntfy/pull/427), thanks to [demogorgonz](https://github.com/demogorgonz))
* Fix Debian installation instructions ([237](https://github.com/binwiederhier/ntfy/issues/237), thanks to [Joeharrison94](https://github.com/Joeharrison94) for reporting)
* Updated [example](https://ntfy.sh/docs/examples/#gatus) with official [Gatus](https://github.com/TwiN/gatus) integration (thanks to [TwiN](https://github.com/TwiN))
* Added [Kubernetes install instructions](https://ntfy.sh/docs/install/#kubernetes) ([452](https://github.com/binwiederhier/ntfy/pull/452), thanks to [gmemstr](https://github.com/gmemstr))
* Added [additional NixOS links for self-hosting](https://ntfy.sh/docs/install/#nixos-nix) ([462](https://github.com/binwiederhier/ntfy/pull/462), thanks to [wamserma](https://github.com/wamserma))
* Added additional [more secure nginx config example](https://ntfy.sh/docs/config/#nginxapache2caddy) ([451](https://github.com/binwiederhier/ntfy/pull/451), thanks to [SuperSandro2000](https://github.com/SuperSandro2000))
* Minor fixes in the config table ([470](https://github.com/binwiederhier/ntfy/pull/470), thanks to [snh](https://github.com/snh))
* Fix broken link ([476](https://github.com/binwiederhier/ntfy/pull/476), thanks to [shuuji3](https://github.com/shuuji3))

**Additional translations:**

* Korean (thanks to [YJSofta0f97461d82447ac](https://hosted.weblate.org/user/YJSofta0f97461d82447ac/))

**Sponsorships:**:

Thank you to the amazing folks who decided to [sponsor ntfy](https://github.com/sponsors/binwiederhier). Thank you for
helping carry the cost of the public server and developer licenses, and more importantly: Thank you for believing in ntfy!
You guys rock!

A list of all the sponsors can be found in the [README](https://github.com/binwiederhier/ntfy/blob/main/README.md).

Released September 27, 2022

This release primarily adds icon support for the Android app, and adds a display name to subscriptions in the web app.
Aside from that, we fixed a few random bugs, most importantly the `Priority` header bug that allows the use behind
Cloudflare. We also added a ton of documentation. Most prominently, an [integrations + projects page](https://ntfy.sh/docs/integrations/).

As of now, I also have started accepting **[donations and sponsorships](https://github.com/sponsors/binwiederhier)** 💸.
I would be very humbled if you consider donating.

**Features:**

* Subscription display name for the web app ([348](https://github.com/binwiederhier/ntfy/pull/348))
* Allow setting socket permissions via `--listen-unix-mode` ([356](https://github.com/binwiederhier/ntfy/pull/356), thanks to [koro666](https://github.com/koro666))
* Icons can be set for each individual notification ([126](https://github.com/binwiederhier/ntfy/issues/126), thanks to [wunter8](https://github.com/wunter8))
* CLI: Allow default username/password in `client.yml` ([372](https://github.com/binwiederhier/ntfy/pull/372), thanks to [wunter8](https://github.com/wunter8))
* Build support for other Unix systems ([393](https://github.com/binwiederhier/ntfy/pull/393), thanks to [la-ninpre](https://github.com/la-ninpre))

**Bug fixes:**

* `ntfy user` commands don't work with `auth_file` but works with `auth-file` ([344](https://github.com/binwiederhier/ntfy/issues/344), thanks to [Histalek](https://github.com/Histalek) for reporting)
* Ignore new draft HTTP `Priority` header ([351](https://github.com/binwiederhier/ntfy/issues/351), thanks to [ksurl](https://github.com/ksurl) for reporting)
* Delete expired attachments based on mod time instead of DB entry to avoid races (no ticket)
* Better logging for Matrix push key errors ([384](https://github.com/binwiederhier/ntfy/pull/384), thanks to [christophehenry](https://github.com/christophehenry))
* Web: Switched "Pop" and "Pop Swoosh" sounds ([352](https://github.com/binwiederhier/ntfy/issues/352), thanks to [coma-toast](https://github.com/coma-toast) for reporting)

**Documentation:**

* Added [integrations + projects page](https://ntfy.sh/docs/integrations/) (**so many integrations, whoa!**)
* Added example for [UptimeRobot](https://ntfy.sh/docs/examples/#uptimerobot)
* Fix some PowerShell publish docs ([345](https://github.com/binwiederhier/ntfy/pull/345), thanks to [noahpeltier](https://github.com/noahpeltier))
* Clarified Docker install instructions ([361](https://github.com/binwiederhier/ntfy/issues/361), thanks to [barart](https://github.com/barart) for reporting)
* Mismatched quotation marks ([392](https://github.com/binwiederhier/ntfy/pull/392)], thanks to [connorlanigan](https://github.com/connorlanigan))

**Additional translations:**

* Ukranian (thanks to [v.kopitsa](https://hosted.weblate.org/user/v.kopitsa/))
* Polish (thanks to [Namax0r](https://hosted.weblate.org/user/Namax0r/))

Released June 23, 2022

This release brings two new CLI options to wait for a command to finish, or for a PID to exit. It also adds more detail
to trace debug output. Aside from other bugs, it fixes a performance issue that occurred in large installations every
minute or so, due to competing stats gathering (personal installations will likely be unaffected by this).

**Features:**

* Add `cache-startup-queries` option to allow custom [SQLite performance tuning](config.mdwal-for-message-cache) (no ticket)
* ntfy CLI can now [wait for a command or PID](subscribe/cli.mdwait-for-pidcommand) before publishing ([263](https://github.com/binwiederhier/ntfy/issues/263), thanks to the [original ntfy](https://github.com/dschep/ntfy) for the idea)
* Trace: Log entire HTTP request to simplify debugging (no ticket)
* Allow setting user password via `NTFY_PASSWORD` env variable ([327](https://github.com/binwiederhier/ntfy/pull/327), thanks to [Kenix3](https://github.com/Kenix3))

**Bug fixes:**

* Fix slow requests due to excessive locking ([338](https://github.com/binwiederhier/ntfy/issues/338))
* Return HTTP 500 for `GET /_matrix/push/v1/notify` when `base-url` is not configured (no ticket)
* Disallow setting `upstream-base-url` to the same value as `base-url` ([334](https://github.com/binwiederhier/ntfy/issues/334), thanks to [oester](https://github.com/oester) for reporting)
* Fix `since=<id>` implementation for multiple topics ([336](https://github.com/binwiederhier/ntfy/issues/336), thanks to [karmanyaahm](https://github.com/karmanyaahm) for reporting)
* Simple parsing in `Actions` header now supports settings Android `intent=` key ([341](https://github.com/binwiederhier/ntfy/pull/341), thanks to [wunter8](https://github.com/wunter8))

**Deprecations:**

* The `ntfy publish --env-topic` option is deprecated as of now (see [deprecations](deprecations.md) for details)

Released June 16, 2022

This release adds a Matrix Push Gateway directly into ntfy, to make self-hosting a Matrix server easier. The Windows
CLI is now available via Scoop, and ntfy is now natively supported in Uptime Kuma.

**Features:**

* ntfy now is a [Matrix Push Gateway](https://spec.matrix.org/v1.2/push-gateway-api/) (in combination with [UnifiedPush](https://unifiedpush.org) as the [Provider Push Protocol](https://unifiedpush.org/developers/gateway/), [#319](https://github.com/binwiederhier/ntfy/issues/319)/[#326](https://github.com/binwiederhier/ntfy/pull/326), thanks to [MayeulC](https://github.com/MayeulC) for reporting)
* Windows CLI is now available via [Scoop](https://scoop.sh) ([ScoopInstaller#3594](https://github.com/ScoopInstaller/Main/pull/3594), [#311](https://github.com/binwiederhier/ntfy/pull/311), [#269](https://github.com/binwiederhier/ntfy/issues/269), thanks to [kzshantonu](https://github.com/kzshantonu))
* [Uptime Kuma](https://github.com/louislam/uptime-kuma) now allows publishing to ntfy ([uptime-kuma#1674](https://github.com/louislam/uptime-kuma/pull/1674), thanks to [philippdormann](https://github.com/philippdormann))
* Display ntfy version in `ntfy serve` command ([314](https://github.com/binwiederhier/ntfy/issues/314), thanks to [poblabs](https://github.com/poblabs))

**Bug fixes:**

* Web app: Show "notifications not supported" alert on HTTP ([323](https://github.com/binwiederhier/ntfy/issues/323), thanks to [milksteakjellybeans](https://github.com/milksteakjellybeans) for reporting)
* Use last address in `X-Forwarded-For` header as visitor address ([328](https://github.com/binwiederhier/ntfy/issues/328))

**Documentation**

* 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)
* 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)

Released June 2, 2022

This release adds the ability to set a log level to facilitate easier debugging of live systems. It also solves a
production problem with a few over-users that resulted in Firebase quota problems (only applying to the over-users).
We now block visitors from using Firebase if they trigger a quota exceeded response.

On top of that, we updated the Firebase SDK and are now building the release in GitHub Actions. We've also got two
more translations: Chinese/Simplified and Dutch.

**Features:**

* Advanced logging, with different log levels and hot reloading of the log level ([284](https://github.com/binwiederhier/ntfy/pull/284))

**Bugs**:

* Respect Firebase "quota exceeded" response for topics, block Firebase publishing for user for 10min ([289](https://github.com/binwiederhier/ntfy/issues/289))
* Fix documentation header blue header due to mkdocs-material theme update (no ticket)

**Maintenance:**

* Upgrade Firebase Admin SDK to 4.x ([274](https://github.com/binwiederhier/ntfy/issues/274))
* CI: Build from pipeline instead of locally ([36](https://github.com/binwiederhier/ntfy/issues/36))

**Documentation**:

* ⚠️ [Privacy policy](privacy.md) updated to reflect additional debug/tracing feature (no ticket)
* [Examples](examples.md) for [Home Assistant](https://www.home-assistant.io/) ([#282](https://github.com/binwiederhier/ntfy/pull/282), thanks to [poblabs](https://github.com/poblabs))
* Install instructions for [NixOS/Nix](https://ntfy.sh/docs/install/#nixos-nix) ([282](https://github.com/binwiederhier/ntfy/pull/282), thanks to [arjan-s](https://github.com/arjan-s))
* Clarify `poll_request` wording for [iOS push notifications](https://ntfy.sh/docs/config/#ios-instant-notifications) ([300](https://github.com/binwiederhier/ntfy/issues/300), thanks to [prabirshrestha](https://github.com/prabirshrestha) for reporting)
* Example for using ntfy with docker-compose.yml without root privileges ([304](https://github.com/binwiederhier/ntfy/pull/304), thanks to [ksurl](https://github.com/ksurl))

**Additional translations:**

* Chinese/Simplified (thanks to [yufei.im](https://hosted.weblate.org/user/yufei.im/))
* Dutch (thanks to [SchoNie](https://hosted.weblate.org/user/SchoNie/))