2024-03-08 04:07:42 +13:00
|
|
|
# Deprecations and breaking changes
|
2021-12-18 03:32:59 +13:00
|
|
|
This page is used to list deprecation notices for ntfy. Deprecated commands and options will be
|
2022-06-21 15:03:16 +12:00
|
|
|
**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.
|
2021-12-18 03:32:59 +13:00
|
|
|
|
|
|
|
|
## Active deprecations
|
2022-11-29 05:06:47 +13:00
|
|
|
_No active deprecations_
|
|
|
|
|
|
|
|
|
|
## Previous deprecations
|
2021-12-18 03:32:59 +13:00
|
|
|
|
2022-06-21 15:03:16 +12:00
|
|
|
### ntfy CLI: `ntfy publish --env-topic` will be removed
|
2022-12-24 03:30:24 +13:00
|
|
|
> Active since 2022-06-20, behavior changed with v1.30.1
|
2022-03-14 15:16:48 +13:00
|
|
|
|
2022-11-29 05:06:47 +13:00
|
|
|
The `ntfy publish --env-topic` option will be removed. It'll still be possible to specify a topic via the
|
2022-06-21 15:03:16 +12:00
|
|
|
`NTFY_TOPIC` environment variable, but it won't be necessary anymore to specify the `--env-topic` flag.
|
2022-03-14 15:16:48 +13:00
|
|
|
|
2022-06-21 15:03:16 +12:00
|
|
|
=== "Before"
|
|
|
|
|
```
|
|
|
|
|
$ NTFY_TOPIC=mytopic ntfy publish --env-topic "this is the message"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
=== "After"
|
|
|
|
|
```
|
|
|
|
|
$ NTFY_TOPIC=mytopic ntfy publish "this is the message"
|
|
|
|
|
```
|
2022-03-31 03:01:16 +13:00
|
|
|
|
2022-06-21 15:03:16 +12:00
|
|
|
### <del>Android app: WebSockets will become the default connection protocol</del>
|
|
|
|
|
> 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.
|
|
|
|
|
|
2022-03-14 15:16:48 +13:00
|
|
|
### Android app: Using `since=<timestamp>` instead of `since=<id>`
|
2022-06-19 13:04:48 +12:00
|
|
|
> Active since 2022-02-27, behavior changed with v1.14.0
|
2022-02-28 08:57:44 +13:00
|
|
|
|
2022-06-19 13:04:48 +12:00
|
|
|
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.
|
2022-02-28 08:57:44 +13:00
|
|
|
|
|
|
|
|
The `since=<timestamp>` endpoint will continue to work. This is merely a notice that the Android app behavior will change.
|
|
|
|
|
|
2021-12-18 03:32:59 +13:00
|
|
|
### Running server via `ntfy` (instead of `ntfy serve`)
|
2022-03-17 12:20:36 +13:00
|
|
|
> Deprecated 2021-12-17, behavior changed with v1.10.0
|
2021-12-18 03:32:59 +13:00
|
|
|
|
|
|
|
|
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
|
|
|
|
|
```
|
|
|
|
|
|
