Become an AceSign inSign up
dschep/ ntfy (v2.4.4) over 3 years ago
Zsh Linux Python Bash Shell macOS Windows
View on GitHub
Need help with ntfy?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

dschep
3.9K Stars 184 Forks GNU General Public License v3.0 596 Commits 75 Opened issues

Description

🖥️📱🔔 A utility for sending notifications, on demand and when commands finish.

Services available

!
?

Need anything else?

Contributors list

About 
ntfy

|Version|_ |Docs|_ |Build|_ |WinBuild|_ |Coverage|_ |SayThanks|_

.. |Version| image:: https://img.shields.io/pypi/v/ntfy.svg?logo=data%3Aimage/svg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNDAiIGhlaWdodD0iMjQwIj48cGF0aCBmaWxsPSIjMzY3MWEyIiBkPSJNNjIuNDc2IDMzLjRjMC0xNi4zNiA0LjM4Ni0yNS4yNiAyOC42MDctMjkuNDk4IDE2LjQ0NC0yLjg4IDM3LjUyOC0zLjI0MiA1Ny4xOTMgMCAxNS41MzMgMi41NjQgMjguNjA3IDE0LjEzNCAyOC42MDcgMjkuNDk3djUzLjk3YzAgMTUuODMtMTIuNjkzIDI4Ljc5NS0yOC42MDcgMjguNzk1SDkxLjA4M2MtMTkuNDEgMC0zNS43NyAxNi41NS0zNS43NyAzNS4yNnYyNS44OTVIMzUuNjVjLTE2LjYzNiAwLTI2LjMyLTExLjk5My0zMC4zODgtMjguNzc2LTUuNDktMjIuNTQ2LTUuMjU2LTM1Ljk4IDAtNTcuNTc0QzkuODE4IDcyLjEzNyAyNC4zNzUgNjIuMTk4IDQxLjAxIDYyLjE5OGg3OC42OHYtNy4yMDRINjIuNDc2VjMzLjR6Ii8%2BPHBhdGggZmlsbD0iI2ZmZDA0NiIgZD0iTTE3Ni44ODMgMjA2LjEyM2MwIDE2LjM2LTE0LjE5OCAyNC42NDQtMjguNjA3IDI4Ljc3Ni0yMS42NzggNi4yMy0zOS4wNzUgNS4yNzMtNTcuMTkzIDAtMTUuMTMtNC40MS0yOC42MDctMTMuNDE3LTI4LjYwNy0yOC43OHYtNTMuOTdjMC0xNS41MzMgMTIuOTQ3LTI4Ljc5OCAyOC42MDctMjguNzk4aDU3LjE5M2MxOS4wNSAwIDM1Ljc3LTE2LjQ2NSAzNS43Ny0zNS45OFY2Mi4xOTZoMjEuNDQ0YzE2LjY1NiAwIDI0LjQ5NiAxMi4zNzYgMjguNjA3IDI4Ljc3NyA1LjcyMiAyMi43OCA1Ljk3NiAzOS44MTcgMCA1Ny41NzQtNS43ODUgMTcuMjUtMTEuOTcyIDI4Ljc3Ny0yOC42MDcgMjguNzc3aC04NS44djcuMjA1aDU3LjE5M3YyMS41OXoiLz48L3N2Zz4%3D .. _Version: https://pypi.org/project/ntfy/ .. |Docs| image:: http://readthedocs.org/projects/ntfy/badge/?version=latest .. _Docs: http://ntfy.readthedocs.org/en/stable/?badge=latest .. |Build| image:: https://img.shields.io/travis/dschep/ntfy/master.svg?logo=data%3Aimage/svg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2aWV3Qm94PSItMTQyLjUgLTE0Mi41IDMyIDE2IiB3aWR0aD0iMzIiIGhlaWdodD0iMTYiPjxjaXJjbGUgcj0iOCIgY3g9Ii0xMzQuNSIgY3k9Ii0xMzQuNSIgZmlsbD0iI2RkNDgxNCIvPjxnIGlkPSJhIiB0cmFuc2Zvcm09Im1hdHJpeCguMDU2NDYgMCAwIC4wNTY0NiAtMTM0LjUgLTEzNC41KSIgZmlsbD0iI2ZmZiI%252BPGNpcmNsZSBjeD0iLTk2LjQiIHI9IjE4LjkiLz48cGF0aCBkPSJNLTQ1LjYgNjguNGMtMTYuNi0xMS0yOS0yOC0zNC00Ny44IDYtNSA5LjgtMTIuMyA5LjgtMjAuNnMtMy44LTE1LjctOS44LTIwLjZjNS0xOS44IDE3LjQtMzYuNyAzNC00Ny44bDEzLjggMjMuMkMtNDYtMzUuMi01NS4zLTE4LjctNTUuMyAwYzAgMTguNyA5LjMgMzUuMiAyMy41IDQ1LjJ6Ii8%252BPC9nPjx1c2UgeGxpbms6aHJlZj0iI2EiIHRyYW5zZm9ybT0icm90YXRlKDEyMCAtMTM0LjUgLTEzNC41KSIgd2lkdGg9IjEwMCUiIGhlaWdodD0iMTAwJSIvPjx1c2UgeGxpbms6aHJlZj0iI2EiIHRyYW5zZm9ybT0icm90YXRlKC0xMjAgLTEzNC41IC0xMzQuNSkiIHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiLz48Y2lyY2xlIGN5PSItMTM0LjUiIGN4PSItMTM0LjUiIHI9IjgiIGZpbGw9IiNkZDQ4MTQiLz48ZyB0cmFuc2Zvcm09Im1hdHJpeCguMDU2NDYgMCAwIC4wNTY0NiAtMTM0LjUgLTEzNC41KSIgZmlsbD0iI2ZmZiI%252BPGNpcmNsZSByPSIxOC45IiBjeD0iLTk2LjQiLz48cGF0aCBkPSJNLTQ1LjYgNjguNGMtMTYuNi0xMS0yOS0yOC0zNC00Ny44IDYtNSA5LjgtMTIuMyA5LjgtMjAuNnMtMy44LTE1LjctOS44LTIwLjZjNS0xOS44IDE3LjQtMzYuNyAzNC00Ny44bDEzLjggMjMuMkMtNDYtMzUuMi01NS4zLTE4LjctNTUuMyAwYzAgMTguNyA5LjMgMzUuMiAyMy41IDQ1LjJ6Ii8%252BPC9nPjx1c2UgaGVpZ2h0PSIxMDAlIiB3aWR0aD0iMTAwJSIgdHJhbnNmb3JtPSJyb3RhdGUoMTIwIC0xMzQuNSAtMTM0LjUpIiB4bGluazpocmVmPSIjYSIvPjx1c2UgaGVpZ2h0PSIxMDAlIiB3aWR0aD0iMTAwJSIgdHJhbnNmb3JtPSJyb3RhdGUoLTEyMCAtMTM0LjUgLTEzNC41KSIgeGxpbms6aHJlZj0iI2EiLz48cGF0aCBkPSJNLTExMS41NTUtMTMwLjAzMWE4LjY5OCA4LjY5OCAwIDAgMS0uODYgMS41NDZjLS40NTMuNjQ1LS44MjMgMS4wOTItMS4xMDkgMS4zNC0uNDQyLjQwNy0uOTE2LjYxNS0xLjQyNC42MjctLjM2NCAwLS44MDQtLjEwNC0xLjMxNS0uMzE0LS41MTQtLjIxLS45ODUtLjMxMy0xLjQxNy0uMzEzLS40NTIgMC0uOTM3LjEwMy0xLjQ1Ni4zMTMtLjUyLjIxLS45MzguMzItMS4yNTguMzMtLjQ4Ny4wMjEtLjk3Mi0uMTkzLTEuNDU3LS42NDMtLjMwOS0uMjctLjY5Ni0uNzMyLTEuMTU5LTEuMzg3LS40OTctLjctLjkwNS0xLjUxLTEuMjI1LTIuNDM0LS4zNDMtLjk5OS0uNTE1LTEuOTY2LS41MTUtMi45MDIgMC0xLjA3Mi4yMzItMS45OTcuNjk2LTIuNzcyYTQuMDgyIDQuMDgyIDAgMCAxIDEuNDU3LTEuNDc0IDMuOTIgMy45MiAwIDAgMSAxLjk3LS41NTZjLjM4NyAwIC44OTQuMTIgMS41MjQuMzU1LjYyOC4yMzYgMS4wMzIuMzU1IDEuMjA5LjM1NS4xMzIgMCAuNTgtLjE0IDEuMzQtLjQxOC43MTgtLjI1OSAxLjMyNS0uMzY2IDEuODIxLS4zMjQgMS4zNDcuMTA5IDIuMzU4LjY0IDMuMDMgMS41OTUtMS4yMDMuNzMtMS43OTkgMS43NTItMS43ODcgMy4wNjIuMDEgMS4wMjEuMzgxIDEuODcgMS4xMDkgMi41NDUuMzMuMzEzLjY5OC41NTUgMS4xMDguNzI3LS4wODkuMjU4LS4xODMuNTA1LS4yODIuNzQyem0tMy4wODgtMTIuMTQ5YzAgLjgtLjI5MiAxLjU0Ny0uODc1IDIuMjM5LS43MDMuODIyLTEuNTUzIDEuMjk3LTIuNDc2IDEuMjIyYTIuNTAyIDIuNTAyIDAgMCAxLS4wMTgtLjMwM2MwLS43NjguMzM0LTEuNTkuOTI4LTIuMjYzLjI5Ni0uMzQuNjczLS42MjMgMS4xMy0uODQ5LjQ1Ny0uMjIyLjg4OS0uMzQ1IDEuMjk1LS4zNjYuMDExLjEwNy4wMTYuMjE0LjAxNi4zMnoiIGZpbGw9IiNmZmYiLz48L3N2Zz4%3D .. _Build: https://travis-ci.org/dschep/ntfy .. |WinBuild| image:: https://img.shields.io/appveyor/ci/dschep/ntfy/master.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgd2lkdGg9IjEyOCIgaGVpZ2h0PSIxMjgiIHZpZXdCb3g9IjAgMCAxMjggMTI4Ij48ZyBmaWxsPSIjMUJBMUUyIiB0cmFuc2Zvcm09InNjYWxlKDgpIj48cGF0aCBkPSJNMCAyLjI2NWw2LjUzOS0uODg4LjAwMyA2LjI4OC02LjUzNi4wMzd6Ii8%2BPHBhdGggZD0iTTYuNTM2IDguMzlsLjAwNSA2LjI5My02LjUzNi0uODk2di01LjQ0eiIvPjxwYXRoIGQ9Ik03LjMyOCAxLjI2MWw4LjY3LTEuMjYxdjcuNTg1bC04LjY3LjA2OXoiLz48cGF0aCBkPSJNMTYgOC40NDlsLS4wMDIgNy41NTEtOC42Ny0xLjIyLS4wMTItNi4zNDV6Ii8%2BPC9nPjwvc3ZnPg== .. _WinBuild: https://ci.appveyor.com/project/dschep/ntfy .. |Coverage| image:: https://coveralls.io/repos/github/dschep/ntfy/badge.svg?branch=master .. _Coverage: https://coveralls.io/github/dschep/ntfy?brach=master .. |Requires| image:: https://requires.io/github/dschep/ntfy/requirements.svg?branch=master .. _Requires: https://requires.io/github/dschep/ntfy/requirements/?branch=master .. |SayThanks| image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg .. _SayThanks: https://saythanks.io/to/dschep

ntfy
brings notification to your shell. It can automatically provide desktop notifications when long running commands finish or it can send push notifications to your phone when a specific command finishes. Confused? This video demonstrates some of this functionality:

.. image:: https://raw.githubusercontent.com/dschep/ntfy/master/docs/demo.gif

Quickstart

.. code:: shell

$ sudo pip install ntfy
$ ntfy send test
# send a notification when the command `sleep 10` finishes
# this sends the message '"sleep 10" succeeded in 0:10 minutes'
$ ntfy done sleep 10
$ ntfy -b pushover -o user_key t0k3n send 'Pushover test!'
$ ntfy -t 'ntfy' send "Here's a custom notification title!"
$ echo -e 'backends: ["pushover"]\npushover: {"user_key": "t0k3n"}' > ~/.ntfy.yml
$ ntfy send "Pushover via config file!"
$ ntfy done --pid 6379  # pid extra
$ ntfy send ":tada: ntfy supports emoji! :100:"  # emoji extra
# Enable shell integration
$ echo 'eval "$(ntfy shell-integration)"' >> ~/.bashrc

Install

The install technique in the quickstart is the suggested method of installation. It can be installed in a virtualenv, but with some caveats: Linux notifications require 

--system-site-packages
for the virtualenv and OS X notifications don't work at all.

:penguin: NOTE: 

Linux Desktop Notifications
_ require Python DBUS bindings. See 
here
_ for more info.

Shell integration ~~~~~~~~~~~~~~~~~ 

ntfy
has support for automatically sending notifications when long running commands finish in bash and zsh. In bash it emulates zsh's preexec and precmd functionality with 
rcaloras/bash-preexec
_. To enable it add the following to your 
.bashrc
or 
.zshrc
:

.. code:: shell

eval "$(ntfy shell-integration)"

By default it will only send notifications for commands lasting longer than 10 seconds and if the terminal is focused. Terminal focus works on X11(Linux) and with Terminal.app and iTerm2 on MacOS. Both options can be configured via the 

--longer-than
and 
--foreground-too
options.

To avoid unnecessary notifications when running interactive programs, programs listed in 

AUTO_NTFY_DONE_IGNORE
don't generate notifications. For example:

.. code:: shell

export AUTO_NTFY_DONE_IGNORE="vim screen meld"

Extras ~~~~~~ 

ntfy
has a few features that require extra dependencies. * 
ntfy done -p $PID
requires installing as 
pip install ntfy[pid]
* 
emoji
_ support requires installing as 
pip install ntfy[emoji]
* 
XMPP
_ support requires installing as 
pip install ntfy[xmpp]
* 
Telegram
_ support requires installing as 
pip install ntfy[telegram]
* 
Instapush
_ support requires installing as 
pip install ntfy[instapush]
* 
Slack
_ support requires installing as 
pip install ntfy[slack]
* 
Slack Incoming Webhooks
_ - simpler slack implementation that doesn't have additional dependencies * 
Rocket.Chat
_ support requires installing as 
pip install ntfy[rocketchat]

To install multiple extras, separate with commas: e.g., 

pip install ntfy[pid,emoji]
.

Configuring 
ntfy

ntfy
is configured with a YAML file stored at 
~/.ntfy.yml
or in standard platform specific locations:
  • Linux - 
    ~/.config/ntfy/ntfy.yml
  • macOS - 
    ~/Library/Application Support/ntfy/ntfy.yml
  • Windows - 
    C:\Users\\AppData\Local\dschep\ntfy.yml

Backends ~~~~~~~~

The backends key specifies what backends to use by default. Each backend has its own configuration, stored in a key of its own name. For example:

.. code:: yaml

---
backends:
    - pushover
pushover:
    user_key: hunter2
pushbullet:
    access_token: hunter2
simplepush:
    key: hunter2
slack:
    token: slacktoken
    recipient: "#slackchannel"
xmpp:
     jid: "[email protected]"
     password: "xxxx"
     mtype: "chat"
     recipient: "[email protected]"

If you want mulitple configs for the same backend type, you can specify any name and then specify the backend with a backend key. For example:

.. code:: yaml

---
pushover:
    user_key: hunter2
cellphone:
    backend: pushover
    user_key: hunter2

See the backends below for available backends and options. As of v2.6.0 

ntfy
also supports 
3rd party backends
_ 

Pushover
_ - 
pushover
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Required parameters: * 
user_key

Optional parameters: * 

sound
* 
priority
* 
expire
* 
retry
* 
callback
* 
api_token
- use your own application token * 
device
- target a device, if omitted, notification is sent to all devices * 
url
* 
url_title
* 
html

Pushbullet
_ - 
pushbullet
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Required parameter: * 
access_token
- Your Pushbullet access token, created at https://www.pushbullet.com/#settings/account

Optional parameters: * 

device_iden
- a device identifier, if omited, notification is sent to all devices * 
email
- send notification to pushbullet user with the specified email or send an email if they aren't a pushullet user 

Simplepush
_ - 
simplepush
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Required parameter: * 
key
- Your Simplepush key, created by installing the Android App (no registration required) at https://simplepush.io

Optional parameters: * 

event
- sets ringtone and vibration pattern for incoming notifications (can be defined in the simplepush app)

XMPP - 

xmpp
~~~~~~~~~~~~~~~ Requires parameters: * 
jid
* 
password
* 
recipient
Optional parameters * 
hostname
(if not from jid) * 
port
* 
path_to_certs
* 
mtype

Requires extras, install like this: 

pip install ntfy[xmpp]
.

To verify the SSL certificates offered by a server: pathtocerts = "path/to/ca/cert"

Without dnspython library installed, you will need to specify the server hostname if it doesn't match the jid.

Specify port if other than 5222. NOTE: Ignored without specified hostname

NOTE: Google Hangouts doesn't support XMPP since 2017

Telegram
_ - 
telegram
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Requires extras, install like this: 
pip install ntfy[telegram]
.

Requires 

ntfy
to be installed as 
ntfy[telegram]
. This backend is configured the first time you will try to use it: 
ntfy -b telegram send
"Telegram configured for ntfy"
. 

Pushjet
_ - 
pushjet
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Required parameter: * 
secret
- The Pushjet service secret token, created with http://docs.pushjet.io/docs/creating-a-new-service

Optional parameters: * 

endpoint
- custom Pushjet API endpoint (defaults to https://api.pushjet.io) * 
level
- The importance level from 1(low) to 5(high) * 
link

Notifico
_ - 
notifico
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Required parameter: * 
webhook
- The webhook link, created at https://n.tkte.ch/ (choose 
Plain Text
service when creating the webhook) 

Slack
_ - 
slack
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Requires extras, install like this: 
pip install ntfy[slack]
.

Required parameter: * 

token
- The Slack service secret token, either a legacy user token created at https://api.slack.com/custom-integrations/legacy-tokens or a token obtained by creating an app at https://api.slack.com/apps?new_app=1 with 
chat:write:bot
scope and linking it to a workspace. * 
recipient
- The Slack channel or user to send notifications to. If you use the 
#
symbol the message is send to a Slack channel and if you use the 
@
symbol the message is send to a Slack user. 

Slack Incoming Webhook
_ - 
slack_webhook
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Required parameter: * 
url
- the URL of the incoming webhook * 
user
- The Slack channel or user to send notifications to 

Instapush
_ - 
insta
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Requires extras, install like this 
pip install ntfy[instapush]
.

Instapush does not support notification title. It sends template-driven notifications, so you have to setup you events on the dashboard first. The backend is called insta due to homonymy with the instapush python wrapper

Required parameters: * 

appid
- The application id * 
secret
- The application secret * 
event_name
- The instapush event to be used * 
trackers
- The array of trakers to use

Note on trackers: Trackers are placeholders for events (a sort of notification template). If you defined more than one tracker in your event you'll have to provide more messages. At the moment, the only way to do so is to separate each message with a colon (:) character. You can also escape the separator character: Example:

.. code:: shell

ntfy -b insta send "message1:message2"
ntfy -b insta send "message1:message2\:with\:colons"


Prowl
_ - 
prowl
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Optional parameters: * 
api_key
* 
provider_key
* 
priority
* 
url

Linux Desktop Notifications
_ - 
linux
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Works via 
dbus
, works with most DEs like Gnome, KDE, XFCE and with libnotify.

The following dependecies should be installed.

.. code:: shell

$ sudo apt install python-dbus # on ubuntu/debian

You will need to install some font that supports emojis (in Debian 

fonts-symbola
or Gentoo 
media-fonts/symbola
).

Optional parameters: * 

icon
- Specifies path to the notification icon, empty string for no icon. * 
urgency
- Specifies the urgency level (low, normal, critical). * 
transient
- Skip the history (exp: the Gnome message tray) (true, false). * 
soundfile
- Specifies the notification sound file (e.g. /usr/share/sounds/notif.wav). * 
timeout
- Specifies notification expiration time level (-1 - system default, 0 - never expire).

Windows Desktop Notifications - 

win32
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Uses 
pywin32
.

Mac OS X Notification Center - 

darwin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Requires 
ntfy
to be installed globally (not in a virtualenv).

System log - 

systemlog
~~~~~~~~~~~~~~~~~~~~~~~~~~ Uses the 
syslog
core Python module, which is not available on Windows platforms.

Optional parameters: * 

prio
- Syslog priority level. Default is 
ALERT
. Possible values are: 
  * EMERG
  * ALERT
  * CRIT
  * ERR
  * WARNING
  * NOTICE
  * INFO
  * DEBUG


    

  • facility - Syslog facility.  Default is LOCAL5.  Possible values
are:
    

      

    • KERN
      • 

    • USER
      • 

    • MAIL
      • 

    • DAEMON
      • 

    • AUTH
      • 

    • LPR
      • 

    • NEWS
      • 

    • UUCP
      • 

    • CRON
      • 

    • SYSLOG
      • 

    • LOCAL0
      • 

    • LOCAL1
      • 

    • LOCAL2
      • 

    • LOCAL3
      • 

    • LOCAL4
      • 

    • LOCAL5
      • 

    • LOCAL6
      • 

    • LOCAL7
      • 

    

    • 

  • fmt - Format of the message to be sent to the system logger.  The
title and the message are specified using the following placeholders:
    

      

    • {title}
      • 

    • {message}
      • 

    

    Default is [{title}] {message}.


Termux:API
_ - 
termux
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Requires the app to be install from the Play store and the CLI utility be installed with 
apt install termux-api
. 

Pushalot
_ - 
pushalot
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Required parameter: * 
auth_token
- Your private Pushalot auth token, found here https://pushalot.com/manager/authorizations

Optional parameters: * 

source
- source of the notification * 
ttl
- message expire time in minutes (time to live) * 
url
- URL to include in the notifications * 
url_title
- visible URL title (ignored if no url specified) * 
image
- URL of image included in the notifications * 
important
- mark notifications as important * 
silent
- mark notifications as silent 

Rocket.Chat
_ - 
rocketchat
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Requires extras, install like this: 
pip install ntfy[rocketchat]
.

Required parameters: * 

url
- URL of your Rocket.Chat instance * 
username
- login username * 
password
- login password * 
room
- room/channel name to post in 

Matrix.org
_ - 
matrix
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Requires extras, install like this: 
pip install ntfy[matrix]
.

Required parameters: * 

url
- URL of your homeserver instance * 
roomId
- room to post in * 
userId
- login userid * 
password
- login password * 
token
- access token

You must either specify 

token
, or 
userId
and 
password
. 

Webpush
_ - 
ntfy_webpush
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Webpush support is provded by an external ntfy module, install like this: 
pip install ntfy ntfy-webpush
.

Required parameters: * 

subscription_info
- A 
PushSubscription
_ Object * 
private_key
- the path to private key file or anything else that works with 
pywebpush
_.

For more info, see 

ntfy-webpush
https://github.com/dschep/ntfy-webpush`

3rd party backends ~~~~~~~~~~~~~~~~~~ To use or implement your own backends, specify the full path of the module as your backend. The module needs to contain a module with a function called 

notify
with the following signature:

.. code:: python

def notify(title, message, **kwargs):
    """
    kwargs contains retcode if using ntfy done or ntfy shell-integration
    and all options in your backend's section of the config
    """
    pass

Other options ~~~~~~~~~~~~~

Title is configurable with the 

title
key in the config. Example:

.. code:: yaml

---
title: Customized Title

Backends ToDo ~~~~~~~~~~~~~ - 

Airgram
_ - 
Boxcar
_

Testing

.. code:: shell

python setup.py test

Contributors

  • dschep
    _ - Maintainer & Lead Developer
  • danryder
    _ - XMPP Backend & emoji support
  • oz123
    _ - Linux desktop notification improvements
  • schwert
    _ - PushJet support
  • rahiel
    _ - Telegram support
  • tymm
    _ - Simplepush support
  • jungle-boogie
    _ - Documentation updates
  • tjbenator
    _ - Advanced Pushover options
  • mobiusklein
    _ - Win32 Bugfix
  • rcaloras
    _ - Creator of 
    bash-prexec
    , without which there woudn't be bash shell integration for 
    ntfy
  • eightnoteight
    _ - Notifico support
  • juanpabloaj
    _ - Slack support
  • giuseongit
    _ - Instapush support
  • jlesage
    _ - Systemlog support
  • sambrightman
    _ - Prowl support
  • mlesniew
    _ - Pushalot support
  • webworxshop
    _ - Rocket.Chat support
  • rhabbachi
    _ - transient option in Linux desktop notifications
  • Half-Shot
    _ - Matrix support

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.