How to install Apprise on Ubuntu Server Latest

In this tutorial, we will guide you on how to install Apprise on Ubuntu Server Latest. Apprise is a python-based library that enables you to send notifications to various messaging services such as Slack, Discord, and many more.

Prerequisites

  • A Ubuntu Server Latest (18.04 / 20.04) with sudo access.
  • Basic knowledge of command line interface.

Installation

Here are the steps to install Apprise on Ubuntu Server Latest:

  1. Start by updating your system's package list and installing Certbot by running the commands below:
sudo apt update
sudo apt install python3-certbot python3-certbot-nginx
  1. Next, install the prerequisites needed to build and compile python dependencies:
sudo apt-get install build-essential libssl-dev libffi-dev python3-dev python3-pip
  1. Once done, install the latest version of Apprise by running the command below:
sudo pip3 install apprise
  1. Confirm that the installation was successful by checking the version installed:
apprise --version

Configuration

After installing the Apprise library, it's time to configure it. Follow these simple steps to get started:

  1. Choose any messaging application or protocol from Apprise's supported list.
  2. Gather the required credentials such as API key or webhook URL.
  3. Create a configuration file in your home directory.

Example configuration file:

[apprise]
# Example configuration file.

# Slack Configuration
# -------------------
[smtp://smtp.gmail.com]
username=USERNAME
password=PASSWORD
[email protected]

[slack://T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX]

In the above example config file, we have added support for both Slack and SMTP. In the Slack section, we have added our web hook URL, while in the SMTP section, we provided the SMTP server details along with the login credentials.

Usage

Now that we have installed and configured Apprise, it's time to put it into action. You can use the apprise command to send notifications.

Here's the basic syntax of the command:

apprise -vvv -c ~/.apprise example
  • -vvv: increase verbosity of the logs.
  • -c: use the configuration file located in the path provided.
  • example: use the namespace defined in the configuration file to send the notification.

Conclusion

In this tutorial, we have shown you how to install and use the Apprise library to send notifications to various endpoints such as Slack or email. You can now use this knowledge to keep your systems fully informed of what's happening.