notifier

Checks current IM messages for different platforms and sends a notification for new messages
git clone https://src.jayvii.de/pub/notifier.git
Log | Files | Refs | README

README.md (2233B)


      1 # Instant Message Notifier
      2 
      3 ## What does it do?
      4 
      5 It checks your current IM messages via several CLI clients for different
      6 platform and notifies you about potential messages.
      7 
      8 Currently supported:
      9 - Telegram via [`telegram-cli`](https://github.com/vysheng/tg)
     10 
     11 Future work (WIP, currently not implemented):
     12 - Matrix via [`matrix-commander`](https://github.com/8go/matrix-commander)
     13 - Signal via [`signal-cli`](https://github.com/AsamK/signal-cli)
     14 
     15 ## Why?
     16 
     17 Many IM clients, such as the Telegram Desktop client or the Signal Desktop
     18 client are somewhat resource intensive, particularly on the CPU, leading to
     19 high(er) power consumption. With this lightweight notifier script, you are not
     20 required to have the desktop client running in the background at all times.
     21 
     22 ## Are there system requirements?
     23 
     24 Yes.
     25 
     26 ### Common
     27 
     28 Sending Notifications: `gdbus` (likely installed already)
     29 
     30 ### Telegram
     31 
     32 Checking Telegram Messages: [`telegram-cli`](https://github.com/vysheng/tg)
     33 ```
     34 # Debian
     35 apt install telegram-cli
     36 
     37 # PostmarketOS
     38 apk add tg
     39 ```
     40 
     41 Set it up via commandline:
     42 ```
     43 telegram-cli
     44 ```
     45 
     46 ## Install IM Notifier
     47 
     48 Pull this source directory, and run `debuild`:
     49 ```
     50 git pull https://src.jayvii.de/pub/notifier.git
     51 cd Notifier
     52 debuild
     53 ```
     54 
     55 This will create a Debian installation package `.deb`, which you may install
     56 via:
     57 ```
     58 sudo apt install ../im-notifier_*.deb
     59 ```
     60 
     61 Packages are being built automatically by Gitlab-CI:
     62 https://gitlab.com/jayvii_de/pp-notifier/-/jobs
     63 
     64 You can Download the "artifacts", which contain the latest `.deb` version, that
     65 you can also install via `apt`, just like above.
     66 
     67 ## Use IM Notifier
     68 
     69 Installing IM-Notifier also creates an App-Icon in your application menu.
     70 Opening this application will run the daemon in the background. You can start
     71 this notifier automatically upon login:
     72 ```
     73 mkdir -p ~/.config/autostart
     74 cp /usr/share/applications/im-notifier.desktop ~/.config/autostart/
     75 ```
     76 
     77 IM Notifier reads configurations from `~/.config/im-notifier/config`. A sample
     78 file can be found in the root repository as [`config.sample`](./config.sample)
     79 
     80 # Authoring & Maintenance
     81 
     82 - JayVii <jayvii [AT] posteo [DOT] de>
     83 
     84 # Contribute
     85 
     86 You may contribute by sending patches to one of the authors or maintainers above.