Skip to content

Latest commit

 

History

History
70 lines (49 loc) · 2.84 KB

README.md

File metadata and controls

70 lines (49 loc) · 2.84 KB

Gotify desktop

Build status AUR version License

Small Gotify daemon to receive messages and forward them as desktop notifications.

Features

  • Read Gotify messages, and forward them as standard desktop notification (works on Linux/MacOS, and likely other Unix flavors)
  • Forward message priority
  • Auto reconnect if server connection is lost (unreliable network, laptop suspend...), and get missed messages
  • Automatically download, cache, and show app icons
  • Fast and self contained binary (no runtime dependencies)
  • Optional features:
    • ignore messages below a given priority level
    • delete messages once received
    • run command on each received message

Installation

From source

You need a Rust build environment for example from rustup.

cargo build --release
sudo install -Dm 755 -t /usr/local/bin target/release/gotify-desktop

If you want to add a Desktop Entry:

sudo install -Dm 644 desktop/gotify-desktop.desktop /usr/share/applications/gotify-desktop.desktop
curl https://raw.githubusercontent.com/gotify/logo/master/gotify-logo-small.svg -o /tmp/gotify-logo-small.svg
sudo install -Dm 644 /tmp/gotify-logo-small.svg /usr/share/icons/hicolor/scalable/apps/gotify-desktop.svg
# update icon cache (may differ depending on Linux distribution)
sudo gtk-update-icon-cache /usr/share/icons/hicolor/

From AUR

Arch Linux users can install the gotify-desktop AUR package.

Configuration

Edit ~/.config/gotify-desktop/config.toml with your server URL and client token, and other settings:

[gotify]
url = "wss://SERVER_DOMAIN:SERVER_PORT"
token = "YOUR_SECRET_TOKEN"
auto_delete = true  # optional, if true, deletes messages that have been handled, defaults to false

[notification]
min_priority = 1  # optional, ignores messages with priority lower than given value

[action]
# optional, run the given command for each message, with the following environment variables set: GOTIFY_MSG_PRIORITY, GOTIFY_MSG_TITLE and GOTIFY_MSG_TEXT.
on_msg_command = "/usr/bin/beep"

Usage

Start gotify-desktop in the background using your favorite init system, desktop environment or windows manager.

License

GPLv3