Desktop Client

♾️ ntfy-electron ♾️

A ntfy.sh desktop client built with Electron which supports Windows, Linux, and MacOSX. This client rests in your taskbar tray and allows you to receive push notifications to your desktop without requiring you to leave your browser open.

About
- ntfy
Features
Key Binds
CLI Arguments
Build

About

This project allows you to access the official free / paid notification service ntfy.sh, or your own self-hosted version of ntfy from within a desktop application which utilizes Electron as the wrapper.

ntfy

ntfy.sh (pronounced "notify") is a simple HTTP-based pub-sub notification service. With ntfy, you can send notifications to your phone or desktop via scripts from any computer, without having to sign up or pay any fees. If you'd like to run your own instance of the service, you can easily do so since ntfy is open source.

Features

Usable with ntfy.sh and self-hosted instances
Two modes for minimizing app, configure in settings
1. Close button exits app completely, sits in taskbar and tray
2. Close button sends app to tray. Right-click tray icon to quit / show app
Shortcut keybinds
- Option to disable
Receive push notifications from ntfy server to desktop
- Advanced setting to adjust polling rate
- Datetime format setting
- Optional persistent notifications
- Topic filtering

Key Binds

The following keybinds can be used within ntfy-electron:

Key(s)	Description
`CTRL + R`	Refresh page
`CTRL + Q`	Quit application
`CTRL + M`	Minimize to tray
`CTRL + =`	Zoom in
`CTRL + -`	Zoom out
`CTRL + 0`	Zoom reset
`CTRL + SHIFT + I`	Developer tools
`F12`	Developer tools
`CTRL + G`	Show General settings window
`CTRL + U`	Show URL settings window
`CTRL + T`	Show API Token settings window
`CTRL + SHIFT + T`	Show Topics settings window
`CTRL + N`	Show Notifications settings window

Note

Hotkeys are disabled by default. To enable hotkeys, select Configure in the top menu, and select General.

Enable Allow usage of hotkeys to navigate

CLI Arguments

This client

Argument	Description	Available as setting
`--hidden`	Start app hidden in tray, suitable for auto-starting on login/boot	✅
`--hotkey`	Start app with hotkeys enabled	✅
`--quit`	Top-right close button will completely exit app instead of minimize to tray	✅
`--dev`	Start app with developer tools in `App` menu	✅

If you are running ntfy-electron from node, you can pass arguments using the following example:

npm run start -- --hidden

Build

To build this app, run the following commands:

Linux

git clone https://github.com/xdpirate/ntfy-electron.git
npm install
npm install -g electron-packager
sudo apt install wine64
sudo ln -s /usr/bin/wine /usr/bin/wine64

Windows

To test development on a Windows machine, run the following commands. A build script for windows will be available later.

git clone https://github.com/xdpirate/ntfy-electron.git
npm install
npm install -g electron

Once you have finished modifying the code, you can test the application with:

npm run start

When you are ready to build, run the build script:

sudo chmod +x build.sh
./build.sh

Contributors ✨

We are always looking for contributors. If you feel that you can provide something useful to Gistr, then we'd love to review your suggestion. Before submitting your contribution, please review the following resources:

Want to help but can't write code?

Review active questions by our community and answer the ones you know.

The following people have helped keep this project going:

_xdpirate
💻 📆

_Aetherinox
💻

Aetherinox/ntfy-desktop