From 50eb98dd92ef6de7ee30320f5c50e4a60900961b Mon Sep 17 00:00:00 2001 From: dalwar23 <5631766+dalwar23@users.noreply.github.com> Date: Sat, 25 May 2024 10:50:24 +0200 Subject: [PATCH] update notification readme --- docs/source/notifications.md | 71 +++++++++++++++++++++++++++++------- 1 file changed, 58 insertions(+), 13 deletions(-) diff --git a/docs/source/notifications.md b/docs/source/notifications.md index ae99038..0114a57 100644 --- a/docs/source/notifications.md +++ b/docs/source/notifications.md @@ -44,16 +44,58 @@ Following notification providers are supported by **`kumaone`** NOT `uptime kuma support for `uptime kuma` [please see here](https://github.com/louislam/uptime-kuma/wiki/Notification-Methods). ``` -- Opsgenie -- Rocket.Chat -- Slack -- Teams -- Webhook +- discord +- email +- opsgenie +- pagerduty +- rocketchat +- slack +- teams +- webhook ```{seealso} More notification providers will be added to `kumaone` in the future. ``` +## Get required arguments for each provider + +`kumaone` CLI provides functionality to get information on required parametes about any supported provider + +```shell +kumaone notification provider-args --type email +``` + +The above command should show information about `email` provider arguments. + +```text +$ kumaone notification provider-args --type email +๐Ÿฅณ Uptime kuma config file found at: /Users/dalwar23/.config/kumaone/kuma.yaml +๐Ÿฅจ Connected to http://uptime.homelab.do +๐Ÿ” Successfully logged in. +โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ +โ”ƒ Argument Key โ”ƒ Required? โ”ƒ +โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ +โ”‚ smtpFrom โ”‚ True โ”‚ +โ”‚ smtpTo โ”‚ True โ”‚ +โ”‚ smtpHost โ”‚ True โ”‚ +โ”‚ smtpPort โ”‚ True โ”‚ +โ”‚ smtpSecure โ”‚ False โ”‚ +โ”‚ smtpIgnoreTLSError โ”‚ False โ”‚ +โ”‚ smtpDkimDomain โ”‚ False โ”‚ +โ”‚ smtpDkimKeySelector โ”‚ False โ”‚ +โ”‚ smtpDkimPrivateKey โ”‚ False โ”‚ +โ”‚ smtpDkimHashAlgo โ”‚ False โ”‚ +โ”‚ smtpDkimheaderFieldNames โ”‚ False โ”‚ +โ”‚ smtpDkimskipFields โ”‚ False โ”‚ +โ”‚ smtpUsername โ”‚ False โ”‚ +โ”‚ smtpPassword โ”‚ False โ”‚ +โ”‚ customSubject โ”‚ False โ”‚ +โ”‚ smtpCC โ”‚ False โ”‚ +โ”‚ smtpBCC โ”‚ False โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ +๐Ÿงจ Disconnected from server. +``` + ## Add notification To add notification(s), use `add` subcommand with `notifications` command. To provide the notification config file @@ -132,14 +174,17 @@ $ kumaone notification list ๐Ÿฅจ Connected to http://uptime.homelab.do ๐Ÿ” Successfully logged in. ๐Ÿ“ฃ Available notification providers -โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ -โ”ƒ id โ”ƒ type โ”ƒ title โ”ƒ active โ”ƒ isDefault โ”ƒ -โ”กโ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ -โ”‚ 31 โ”‚ rocket.chat โ”‚ Uptime notification โ”‚ True โ”‚ False โ”‚ -โ”‚ 32 โ”‚ slack โ”‚ Uptime slack notification โ”‚ True โ”‚ False โ”‚ -โ”‚ 33 โ”‚ teams โ”‚ Uptime teams notification โ”‚ True โ”‚ False โ”‚ -โ”‚ 34 โ”‚ webhook โ”‚ Uptime webhook notification โ”‚ True โ”‚ False โ”‚ -โ””โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ +โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ +โ”ƒ id โ”ƒ type โ”ƒ title โ”ƒ active โ”ƒ isDefault โ”ƒ +โ”กโ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ +โ”‚ 281 โ”‚ discord โ”‚ Discord Notification โ”‚ True โ”‚ False โ”‚ +โ”‚ 282 โ”‚ Opsgenie โ”‚ Opsgenie Nofification โ”‚ True โ”‚ False โ”‚ +โ”‚ 283 โ”‚ PagerDuty โ”‚ Pagerduty Notifications โ”‚ True โ”‚ False โ”‚ +โ”‚ 284 โ”‚ rocket.chat โ”‚ RocketChat Notification โ”‚ True โ”‚ True โ”‚ +โ”‚ 285 โ”‚ slack โ”‚ Uptime Slack Notification โ”‚ True โ”‚ False โ”‚ +โ”‚ 286 โ”‚ teams โ”‚ Uptime Teams Notification โ”‚ True โ”‚ False โ”‚ +โ”‚ 287 โ”‚ webhook โ”‚ Uptime Webhook Notification โ”‚ True โ”‚ False โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ ๐Ÿงจ Disconnected from server. ```