Added ntfy and Zulip (#4694) documentation.
Ylian Saint-Hilaire committed
Nov 1, 2022 at 12:54 UTC
e19caeefe450c0ee5cd72e9934b607a5ed6cb31d
2 files changed
+31
docs/docs/messaging/images/MC2-Ntfy1.png
Binary files /dev/null and b/docs/docs/messaging/images/MC2-Ntfy1.png differ
docs/docs/messaging/index.md
+31
@@ -8,6 +8,8 @@
8
[XMPP Setup](#xmpp-setup)
9
[CallMeBot Setup](#callmebot-setup)
10
[Pushover Setup](#pushover-setup)
11
+[ntfy Setup](#ntfy-setup)
12
+[Zulip Setup](#zulip-setup)
13
[User Setup](#user-setup)
14
[Administrator Management](#administrator-management)
15
[Two-Factor Authentication](#two-factor-authentication)
@@ -160,6 +162,35 @@ Once setup, the server will offer users the "Pushover" option when setting up me
162
163
164
165
+## ntfy setup
166
+
167
+[ntfy](https://ntfy.sh/) is a completely free notification service. You can enable the ntfy integration with the following config.json section:
168
+
169
+```json
170
+{
171
+ "messaging": {
172
+ "ntfy": true
173
+ }
174
+}
175
+```
176
+
177
+No setup is reqired to enable this. When using ntfy, make sure you use a suffisently random topic name so that others can't guess the name and subscribe to it to receive your messages.
178
+
179
+
180
+
181
+## Zulip setup
182
+
183
+You can enable the MeshCentral [Zulip](https://zulip.com/) integration with the following config.json section:
184
+
185
+```json
186
+{
187
+ "messaging": {
188
+ email: "your-bot@zulip.com",
189
+ api_key: "your_32_character_api_key"
190
+ }
191
+}
192
+```
193
+
194
## User Setup
195
196
Once one or more messaging systems are setup with MeshCentral, users will be able to register their handle and verify that they own that account by typing in a 6 digit code.