a797f4ccf1
- Add repository details to AGENTS.md for customized repo - Add customizations section to README.md describing new features: - Persistent notifications for priority 10 with flashing - Sound control for priority 10 only - Stacking multiple notifications - Tray icon click to close all
67 lines
2.8 KiB
Markdown
67 lines
2.8 KiB
Markdown
# Gotify Tray
|
|
|
|
|
|
A tray notification application for receiving messages from a [Gotify server](https://github.com/gotify/server).
|
|
|
|
|
|
## Getting started
|
|
|
|
|
|
- [Download the latest release.](https://github.com/seird/gotify-tray/releases/latest)
|
|
|
|
- or, install via pip:
|
|
```shell
|
|
$ pip install gotify-tray
|
|
```
|
|
|
|
- or, run from source:
|
|
```shell
|
|
$ pip install -r requirements.txt
|
|
$ python -m gotify_tray
|
|
```
|
|
|
|
|
|
## Features
|
|
|
|
- Receive gotify messages in the native notification area.
|
|
- Reconnect after wake from sleep or losing network connection.
|
|
- Disable notification banners for low priority messages.
|
|
- Manually delete received messages.
|
|
- Go through a history of all previously received messages.
|
|
- Receive missed messages after losing network connection.
|
|
|
|
## Customizations
|
|
|
|
- **Persistent Notifications for Priority 10**: Messages with priority 10 display as persistent pop-up windows that stay on screen until clicked, with a flashing background for attention.
|
|
- **Sound Notification Control**: Option to play notification sound only for priority 10 messages.
|
|
- **Multiple Persistent Notifications**: Multiple priority 10 messages stack vertically and can be closed all at once by clicking any one or the tray icon.
|
|
- **Enhanced UI Settings**: Added configurable options for persistent notifications and sound behavior in the settings dialog.
|
|
|
|
|
|
## Images
|
|
|
|
|
|
### Main window
|
|
|
|
Default | Dark
|
|
:-------------------------------------------------:|:---------------------------------------------------------:
|
|
 | 
|
|
|
|
|
|
### Notification banners
|
|
|
|
Windows 10 | KDE | MacOS 12
|
|
:-------------------------------------------------:|:---------------------------------------------------------:|:---------------------------------------------------------:
|
|
 |  | 
|
|
 |  |
|
|
|
|
|
|
## Build instructions
|
|
|
|
See [BUILDING](BUILDING.md).
|
|
|
|
|
|
## Requirements
|
|
|
|
- python >=3.10
|