1
0
Fork 0
mirror of https://github.com/binwiederhier/ntfy.git synced 2024-12-23 18:23:27 +01:00
ntfy/docs/deprecations.md
2024-03-07 10:07:42 -05:00

2.3 KiB

Deprecations and breaking changes

This page is used to list deprecation notices for ntfy. Deprecated commands and options will be removed after 1-3 months from the time they were deprecated. How long the feature is deprecated before the behavior is changed depends on the severity of the change, and how prominent the feature is.

Active deprecations

No active deprecations

Previous deprecations

ntfy CLI: ntfy publish --env-topic will be removed

Active since 2022-06-20, behavior changed with v1.30.1

The ntfy publish --env-topic option will be removed. It'll still be possible to specify a topic via the NTFY_TOPIC environment variable, but it won't be necessary anymore to specify the --env-topic flag.

=== "Before" $ NTFY_TOPIC=mytopic ntfy publish --env-topic "this is the message"

=== "After" $ NTFY_TOPIC=mytopic ntfy publish "this is the message"

Android app: WebSockets will become the default connection protocol

Active since 2022-03-13, behavior will not change (deprecation removed 2022-06-20)

Instant delivery connections and connections to self-hosted servers in the Android app were going to switch to use the WebSockets protocol by default. It was decided to keep JSON stream as the most compatible default and add a notice banner in the Android app instead.

Android app: Using since=<timestamp> instead of since=<id>

Active since 2022-02-27, behavior changed with v1.14.0

The Android app started using since=<id> instead of since=<timestamp>, which means as of Android app v1.14.0, it will not work with servers older than v1.16.0 anymore. This is to simplify handling of deduplication in the Android app.

The since=<timestamp> endpoint will continue to work. This is merely a notice that the Android app behavior will change.

Running server via ntfy (instead of ntfy serve)

Deprecated 2021-12-17, behavior changed with v1.10.0

As more commands are added to the ntfy CLI tool, using just ntfy to run the server is not practical anymore. Please use ntfy serve instead. This also applies to Docker images, as they can also execute more than just the server.

=== "Before" $ ntfy 2021/12/17 08:16:01 Listening on :80/http

=== "After" $ ntfy serve 2021/12/17 08:16:01 Listening on :80/http