Skip to content

Commit

Permalink
docs: Update notification docs (#146)
Browse files Browse the repository at this point in the history
* docs: Update notification docs

* typo

* false link
  • Loading branch information
raosan authored Apr 16, 2021
1 parent 0e4334d commit d939625
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 19 deletions.
8 changes: 5 additions & 3 deletions config_sample/config.mailgun.example.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@
],
"probes": [
{
"request": {
"url": "https://github.com"
}
"requests": [
{
"url": "https://github.com"
}
]
}
]
}
21 changes: 21 additions & 0 deletions config_sample/config.telegram.example.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"notifications": [
{
"id": "unique-id-telegram",
"type": "telegram",
"data": {
"group_id": "YOUR_GROUP_ID",
"bot_token": "YOUR_BOT_TOKEN"
}
}
],
"probes": [
{
"requests": [
{
"url": "https://github.com"
}
]
}
]
}
17 changes: 9 additions & 8 deletions docs/src/pages/guides/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@ Monika will send notifications to you whenever [alerts](https://hyperjumptech.gi

At this moment, Monika support these channel of notifications (You can use just one or more):

1. SMTP
2. Webhook
3. Mailgun
4. Sendgrid
5. Slack
6. Whatsapp
7. Microsoft Teams
8. Discord
1. [SMTP](https://hyperjumptech.github.io/monika/guides/notifications#smtp)
2. [Mailgun](https://hyperjumptech.github.io/monika/guides/notifications#mailgun)
3. [SendGrid](https://hyperjumptech.github.io/monika/guides/notifications#sendgrid)
4. [Webhook](https://hyperjumptech.github.io/monika/guides/notifications#webhook)
5. [Slack](https://hyperjumptech.github.io/monika/guides/notifications#slack-incoming-webhook)
6. [Telegram](https://hyperjumptech.github.io/monika/guides/notifications#telegram)
7. [WhatsApp](https://hyperjumptech.github.io/monika/guides/notifications#whatsapp)
8. [Microsoft Teams](https://hyperjumptech.github.io/monika/guides/notifications#microsoft-teams)
9. [Discord](https://hyperjumptech.github.io/monika/guides/notifications#discord)

We are working on more notifications like Telegram, and many more. You can help!

Expand Down
17 changes: 9 additions & 8 deletions docs/src/pages/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ title: Quick Start

To start monitoring URLs, you need to create a configuration file (JSON file). The configuration file contains the probes, alerts, and notification configurations. You can copy from one of these examples:

- [config.smtp-gmail.example.json](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.smtp-gmail.example.json)
- [config.mailgun.example.json](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.mailgun.example.json)
- [config.sendgrid.example.json](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.sendgrid.example.json)
- [config.webhook.example.json](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.webhook.example.json)
- [config.slack.example.json](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.slack.example.json)
- [config.whatsapp.example.json](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.whatsapp.example.json)
- [config.teams.example.json](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.teams.example.json)
- [config.example.json](https://github.com/hyperjumptech/monika/blob/main/config.example.json)
1. [SMTP Gmail](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.smtp-gmail.example.json)
2. [Mailgun](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.mailgun.example.json)
3. [SendGrid](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.sendgrid.example.json)
4. [Webhook](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.webhook.example.json)
5. [Slack](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.slack.example.json)
6. [Telegram](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.telegram.example.json)
7. [WhatsApp](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.whatsapp.example.json)
8. [Microsoft Teams](https://github.com/hyperjumptech/monika/blob/main/config_sample/config.teams.example.json)
9. [Default](https://github.com/hyperjumptech/monika/blob/main/config.example.json)

When you have created the configuration file, you can run `monika` as follows

Expand Down

0 comments on commit d939625

Please sign in to comment.