https://github.com/holgerhuo/ntfy-notify
A Linux daemon to send ntfy messages to desktop notifications.
https://github.com/holgerhuo/ntfy-notify
ntfy ntfy-desktop
Last synced: 5 months ago
JSON representation
A Linux daemon to send ntfy messages to desktop notifications.
- Host: GitHub
- URL: https://github.com/holgerhuo/ntfy-notify
- Owner: HolgerHuo
- License: gpl-3.0
- Created: 2024-10-29T18:40:49.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-30T18:13:34.000Z (11 months ago)
- Last Synced: 2024-10-30T18:35:50.525Z (11 months ago)
- Topics: ntfy, ntfy-desktop
- Language: Go
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ntfy-notify | Send ntfy messages to Linux desktop notifications
[](https://github.com/holgerhuo/ntfy-notify/releases/latest)[](https://github.com/HolgerHuo/ntfy-notify/actions/workflows/release.yml)
`ntfy-notify` is a simple Linux daemon to send subscribed ntfy messages to your Linux desktop via `notify-send`.
## Features
- Fetch missed notifications when you were offline
- WebSocket connection
## To-Dos
- [ ] Click actions
- [ ] Support icon and attachment
- [ ] Detect Internet connectivity
- [ ] Filter notifications
## Usage
1. Download ntfy-notify from [releases page](https://github.com/HolgerHuo/ntfy-notify/releases/latest)
2. Create [`config.yml`](https://github.com/HolgerHuo/ntfy-notify/blob/main/config.yml.sample)
```yaml
endpoint: ntfy.sh:443
#username: ntfy_user
#password: ntfy_password
topics: ntfy_notify_announcement,ntfy_notify_release
```
3. Run ntfy-notify
```bash
ntfy-notify -c ./config.yml
```
## Tips
If your Internet connection is not so stable, you could use nm-dispatcher or similar tools to manage this application's lifecycle. Please DO feedback on how to reliably and efficiently detect network connection and stop/restart `ntfy-notify` process.
```ini
[Unit]
Description=ntfy-notify
After=network.target NetworkManager.service
[Service]
Type=simple
Restart=always
ExecStart=/usr/bin/ntfy-notify -c %h/.config/ntfy-notify/config.yml -json
KillSignal=SIGINT
[Install]
WantedBy=default.target
```
## License
GPLv3 Holger Huo