Skip to main content

Client application for ntfy.sh

Project description

ntfy-send

ntfy-send is a client application for notification service ntfy.sh.

Configuration

ntfy-send can be configured via a configuration file. It is recommended method of storing your credential informations, which simplifies obtaining and sending them to ntfy server.

All configuration options can be enclosed in backticks (`). When this is the case, the option is treated as a command whose output substitutes the configurration option.

Configuration files are stored in $XDG_CONFIG_HOME/ntfy-send/config.toml. If you don't have $XDG_CONFIG_HOME environment variale set, then it is stored in ~/.config/ntfy-send/config.toml. Below are documented all options:

# config.toml

# URL to the server
server = "https://ntfy.sh"

# Username and password can be automatically obtained each time they're
# required. This is done by passing commands which should echo credentials.
# For complex commands it's recommended to pot them in a separate script, due
# to problems with several levels of quote escaping

# Username and password can be passed in plain text. This isn't recommended.
username = "user"
password = "pass"

# Alternatively, ntfy-send can automatically run a command for username and
# password when they're enclosed in backticks (`):
username = """`gpg2 --decrypt pass.gpg | awk -F ":" '/user:/ { printf $2 }'`"""
password = """`gpg2 --decrypt pass.gpg | awk -F ":" '/password:/ { printf $2 }'`"""

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ntfy_send-0.4.1.tar.gz (15.4 kB view hashes)

Uploaded Source

Built Distribution

ntfy_send-0.4.1-py3-none-any.whl (16.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page