1 unstable release

0.1.0 Nov 22, 2022

#20 in #mastodon

21 downloads per month

Apache-2.0

24KB
573 lines

mastodon-notifier

Lightweight mastodon desktop notification daemon

Introduction

Mastodon notifier it's a simple rust application that connects to the user notification stream and send desktop notification.

Installation

With cargo

cargo install mastodon-notifier

Connecting to Mastodon's API

mastodon-notifier needs to access the the Mastodon API of your instance.

Follow this instruction for configuring a mastodon-notifier:

  • First create an app on your instance at url https://<instance_url>/settings/applications with read scope checked and redirect uri urn:ietf:wg:oauth:2.0:oob. Once it's created you will see Client Key and Client Secret

  • Run the mastodon notifier for configuring the account with mastodon-notifier --host <host> --user <user> --mode config and enter the Client Key and the Client Secret. You will be redirected then to your instance for authorization. Once authorized your instance will show an authorization code that you need to provide to the configurator. The configuration is now complete and mastodon-notifier will save the token in the user keyring.

Usage

The binary is named mastodon-notifier and can run as daemon which listens to user notification stream and sends desktop notifications.

 ./target/release/mastodon-notifier --host hachyderm.io --user wolf4ood --mode daemon
2022-11-22T18:49:01.532345Z  INFO mastodon_notifier::daemon: Found stored token for user wolf4ood@hachyderm.io
2022-11-22T18:49:02.063228Z  INFO mastodon_notifier::daemon: Started mastodon notify daemon on account wolf4ood@hachyderm.io

The daemon look in the keyring for the token associated to the account username@instance configured in the previous step.

If it's not available the daemon will wait until it's ready

Dependencies

~21–38MB
~646K SLoC