diff --git a/docs/install.md b/docs/install.md index 0707ddbe..55284da7 100644 --- a/docs/install.md +++ b/docs/install.md @@ -26,37 +26,37 @@ deb/rpm packages. === "x86_64/amd64" ```bash - wget https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_linux_x86_64.tar.gz - tar zxvf ntfy_1.26.0_linux_x86_64.tar.gz - sudo cp -a ntfy_1.26.0_linux_x86_64/ntfy /usr/bin/ntfy - sudo mkdir /etc/ntfy && sudo cp ntfy_1.26.0_linux_x86_64/{client,server}/*.yml /etc/ntfy + wget https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_linux_x86_64.tar.gz + tar zxvf ntfy_1.27.0_linux_x86_64.tar.gz + sudo cp -a ntfy_1.27.0_linux_x86_64/ntfy /usr/bin/ntfy + sudo mkdir /etc/ntfy && sudo cp ntfy_1.27.0_linux_x86_64/{client,server}/*.yml /etc/ntfy sudo ntfy serve ``` === "armv6" ```bash - wget https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_linux_armv6.tar.gz - tar zxvf ntfy_1.26.0_linux_armv6.tar.gz - sudo cp -a ntfy_1.26.0_linux_armv6/ntfy /usr/bin/ntfy - sudo mkdir /etc/ntfy && sudo cp ntfy_1.26.0_linux_armv6/{client,server}/*.yml /etc/ntfy + wget https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_linux_armv6.tar.gz + tar zxvf ntfy_1.27.0_linux_armv6.tar.gz + sudo cp -a ntfy_1.27.0_linux_armv6/ntfy /usr/bin/ntfy + sudo mkdir /etc/ntfy && sudo cp ntfy_1.27.0_linux_armv6/{client,server}/*.yml /etc/ntfy sudo ntfy serve ``` === "armv7/armhf" ```bash - wget https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_linux_armv7.tar.gz - tar zxvf ntfy_1.26.0_linux_armv7.tar.gz - sudo cp -a ntfy_1.26.0_linux_armv7/ntfy /usr/bin/ntfy - sudo mkdir /etc/ntfy && sudo cp ntfy_1.26.0_linux_armv7/{client,server}/*.yml /etc/ntfy + wget https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_linux_armv7.tar.gz + tar zxvf ntfy_1.27.0_linux_armv7.tar.gz + sudo cp -a ntfy_1.27.0_linux_armv7/ntfy /usr/bin/ntfy + sudo mkdir /etc/ntfy && sudo cp ntfy_1.27.0_linux_armv7/{client,server}/*.yml /etc/ntfy sudo ntfy serve ``` === "arm64" ```bash - wget https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_linux_arm64.tar.gz - tar zxvf ntfy_1.26.0_linux_arm64.tar.gz - sudo cp -a ntfy_1.26.0_linux_arm64/ntfy /usr/bin/ntfy - sudo mkdir /etc/ntfy && sudo cp ntfy_1.26.0_linux_arm64/{client,server}/*.yml /etc/ntfy + wget https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_linux_arm64.tar.gz + tar zxvf ntfy_1.27.0_linux_arm64.tar.gz + sudo cp -a ntfy_1.27.0_linux_arm64/ntfy /usr/bin/ntfy + sudo mkdir /etc/ntfy && sudo cp ntfy_1.27.0_linux_arm64/{client,server}/*.yml /etc/ntfy sudo ntfy serve ``` @@ -103,7 +103,7 @@ Manually installing the .deb file: === "x86_64/amd64" ```bash - wget https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_linux_amd64.deb + wget https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_linux_amd64.deb sudo dpkg -i ntfy_*.deb sudo systemctl enable ntfy sudo systemctl start ntfy @@ -111,7 +111,7 @@ Manually installing the .deb file: === "armv6" ```bash - wget https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_linux_armv6.deb + wget https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_linux_armv6.deb sudo dpkg -i ntfy_*.deb sudo systemctl enable ntfy sudo systemctl start ntfy @@ -119,7 +119,7 @@ Manually installing the .deb file: === "armv7/armhf" ```bash - wget https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_linux_armv7.deb + wget https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_linux_armv7.deb sudo dpkg -i ntfy_*.deb sudo systemctl enable ntfy sudo systemctl start ntfy @@ -127,7 +127,7 @@ Manually installing the .deb file: === "arm64" ```bash - wget https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_linux_arm64.deb + wget https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_linux_arm64.deb sudo dpkg -i ntfy_*.deb sudo systemctl enable ntfy sudo systemctl start ntfy @@ -137,28 +137,28 @@ Manually installing the .deb file: === "x86_64/amd64" ```bash - sudo rpm -ivh https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_linux_amd64.rpm + sudo rpm -ivh https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_linux_amd64.rpm sudo systemctl enable ntfy sudo systemctl start ntfy ``` === "armv6" ```bash - sudo rpm -ivh https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_linux_armv6.rpm + sudo rpm -ivh https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_linux_armv6.rpm sudo systemctl enable ntfy sudo systemctl start ntfy ``` === "armv7/armhf" ```bash - sudo rpm -ivh https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_linux_armv7.rpm + sudo rpm -ivh https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_linux_armv7.rpm sudo systemctl enable ntfy sudo systemctl start ntfy ``` === "arm64" ```bash - sudo rpm -ivh https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_linux_arm64.rpm + sudo rpm -ivh https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_linux_arm64.rpm sudo systemctl enable ntfy sudo systemctl start ntfy ``` @@ -184,29 +184,30 @@ nix-env -iA ntfy-sh ## macOS The [ntfy CLI](subscribe/cli.md) (`ntfy publish` and `ntfy subscribe` only) is supported on macOS as well. -To install, please download the tarball, extract it and place it somewhere in your `PATH` (e.g. `/usr/local/bin/ntfy`). +To install, please [download the tarball](https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_macOS_all.tar.gz), +extract it and place it somewhere in your `PATH` (e.g. `/usr/local/bin/ntfy`). If run as `root`, ntfy will look for its config at `/etc/ntfy/client.yml`. For all other users, it'll look for it at `~/Library/Application Support/ntfy/client.yml` (sample included in the tarball). ```bash -curl -L https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_1.26.0_macOS_all.tar.gz > ntfy_1.26.0_macOS_all.tar.gz -tar zxvf ntfy_1.26.0_macOS_all.tar.gz -sudo cp -a ntfy_1.26.0_macOS_all/ntfy /usr/local/bin/ntfy +curl -L https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_macOS_all.tar.gz > ntfy_1.27.0_macOS_all.tar.gz +tar zxvf ntfy_1.27.0_macOS_all.tar.gz +sudo cp -a ntfy_1.27.0_macOS_all/ntfy /usr/local/bin/ntfy mkdir ~/Library/Application\ Support/ntfy -cp ntfy_1.26.0_macOS_all/client/client.yml ~/Library/Application\ Support/ntfy/client.yml +cp ntfy_1.27.0_macOS_all/client/client.yml ~/Library/Application\ Support/ntfy/client.yml ntfy --help ``` !!! info - If there is a desire to install ntfy via [Homebrew](https://brew.sh/), please create a - [GitHub issue](https://github.com/binwiederhier/ntfy/issues) to let me know. Also, you can build and run the - ntfy server on macOS as well, though I don't officially support that. Check out the [build instructions](develop.md) - for details. + There is a [GitHub issue](https://github.com/binwiederhier/ntfy/issues/286) about making ntfy installable via + [Homebrew](https://brew.sh/). I'll eventually get to that, but I'd also love if somebody else stepped up to do it. + Also, you can build and run the ntfy server on macOS as well, though I don't officially support that. + Check out the [build instructions](develop.md) for details. ## Windows The [ntfy CLI](subscribe/cli.md) (`ntfy publish` and `ntfy subscribe` only) is supported on Windows as well. -To install, please [download the latest ZIP](https://github.com/binwiederhier/ntfy/releases/download/v1.26.0/ntfy_v1.26.0_windows_x86_64.zip), +To install, please [download the latest ZIP](https://github.com/binwiederhier/ntfy/releases/download/v1.27.0/ntfy_1.27.0_windows_x86_64.zip), extract it and place the `ntfy.exe` binary somewhere in your `%Path%`. The default path for the client config file is at `%AppData%\ntfy\client.yml` (not created automatically, sample in the ZIP file). diff --git a/docs/releases.md b/docs/releases.md index 45303491..d461e2db 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -4,24 +4,6 @@ and the [ntfy Android app](https://github.com/binwiederhier/ntfy-android/release +## ntfy server v1.27.0 +Released June 23, 2022 + +**Features:** + +* Add `cache-startup-queries` option to allow custom [SQLite performance tuning](config.md#wal-for-message-cache) (no ticket) +* ntfy CLI can now [wait for a command or PID](subscribe/cli.md#wait-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)) + +**Bugs:** + +* 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=` 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) + ## ntfy server v1.26.0 Released June 16, 2022 diff --git a/docs/subscribe/cli.md b/docs/subscribe/cli.md index 6f5a2060..03d9132a 100644 --- a/docs/subscribe/cli.md +++ b/docs/subscribe/cli.md @@ -78,9 +78,9 @@ $ ntfy pub --file README.md mytopic | jq . ``` ### Wait for PID/command -If you have a long-running command, you may wrap it directly with `ntfy publish --wait-cmd`, -or if you forgot to wrap it and it's already running, wait for the process to complete with -`ntfy publish --wait-pid`. +If you have a long-running command and want to **publish a notification when the command completes**, +you may wrap it with `ntfy publish --wait-cmd` (aliases: `--cmd`, `--done`). Or, if you forgot to wrap it, and the +command is already running, you can wait for the process to complete with `ntfy publish --wait-pid` (alias: `--pid`). Run a command and wait for it to complete (here: `rsync ...`): @@ -95,7 +95,7 @@ $ ntfy pub --wait-cmd mytopic rsync -av ./ root@example.com:/backups/ | jq . } ``` -Or, if you already started the long-running process and want to wait for it, you can do this: +Or, if you already started the long-running process and want to wait for it using its process ID (PID), you can do this: === "Using a PID directly" ```