/OctoPrint_Signal-Notifier

Recieve Signal (https://signal.org/) messages when OctoPrint jobs are complete. signal-cli is required.

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

OctoPrint_Signal-Notifier

Build Status

Recieve Signal (https://signal.org/) messages when OctoPrint jobs are complete.

Requires signal-cli be installed and configured. See Prerequisites for more information.

Settings tab screenshot

Prerequisites

two phone numbers

You can't send and receive from the same phone number. Google Voice is handy for this.

signal-cli

signal-cli (https://github.com/AsamK/signal-cli) is required for operation. You'll need to enable strong encryption or ensure you're running a recent version of Java.

Helpful Links:

Test by running the following as the user Octoprint runs as.

signal-cli -u <sender> send -m "signal-cli works from $USER@$HOSTNAME" <recipient>

Installation

Install via the bundled Plugin Manager or manually using this URL:

https://github.com/aerickson/OctoPrint_Signal-Notifier/archive/master.zip

Configuration

Configuration is done via the settings panel. You must set a full path to signal-cli (I recommend placing signal-cli in /usr/local/), sender (must be configured in signal-cli), and a recipient.

Senders and recipients are phone numbers (e.g. +12225554444).

Acknowledgements

Loosely based on OctoPrint_FreeMobile-Notifier.

License

Licensed under the terms of the AGPLv3.