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