The Lounge ntfy Plugin

A plugin for The Lounge that sends a message to an ntfy server whenever you are mentioned in a chat.

Installation

Via the thelounge command line:

thelounge install thelounge-plugin-ntfy

If you want notifications to open the channel when clicked, add a baseUrl entry in the config.js of your instance:

"use strict";
module.exports = {
  baseUrl: "https://thelounge.example.com",
  // rest of config...

Restart The Lounge after installation

Usage

This plugin introduces the /ntfy command, subcommands are:

• /ntfy start [all]: Start the ntfy listener for the network or all networks if 'all' is specified
• /ntfy stop [all]: Stop the ntfy listener for the network or all networks if 'all' is specified
• /ntfy status [all]: Show the ntfy listener status for this network or all networks if 'all' is specified
• /ntfy test: Send a test notification
• /ntfy config: Config commands
  • /ntfy config set <setting_key> <setting_value>: Set a global configuration setting
  • /ntfy config remove <setting_key>: Set a global configuration setting to null
  • /ntfy config network set <setting_key> <setting_value>: Set a per-network setting for this network
  • /ntfy config network remove <setting_key>: Remove per-network setting for this network
  • /ntfy config print: Print the current configuration with warnings if any

Setup

This plugin will not work out of the box, by default the plugin sends notifications to the official ntfy.sh server but no topic is set. To set a topic, enter this command:

/ntfy config set ntfy.topic <topic>

You may also set your account credentials or token as well if needed, see the config print command for all the possible settings.

To start/stop sending push notifications in the desired network, enter:

/ntfy start/stop

Private Messages

By default, you will only be notified when you are mentioned, this includes messages sent privately to you. If you want to be notified of all private messages on a specific network, enter this command while connected to that network and start the notifier like usual:

/ntfy config network set config.notify_on_private_messages true

This setting is per-network, so you can enable it for some networks and disable it for others.

License

This plugin is licensed under MIT