From a9206f031449061246255a2b8bc73e7635ad6166 Mon Sep 17 00:00:00 2001 From: Simon Aronsson Date: Mon, 10 Aug 2020 10:53:54 +0200 Subject: [PATCH] add teams docs --- docs/index.md | 40 +++++++++++++------------------------ docs/services/discord.md | 2 +- docs/services/hangouts.md | 2 +- docs/services/mattermost.md | 2 +- docs/services/overview.md | 30 ++++++++++++++-------------- docs/services/pushover.md | 2 +- docs/services/teams.md | 18 +++++++++++++++++ docs/services/zulip.md | 2 +- mkdocs.yml | 13 ++++++------ 9 files changed, 59 insertions(+), 52 deletions(-) create mode 100644 docs/services/teams.md diff --git a/docs/index.md b/docs/index.md index 82ca4511..dbdbae84 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,29 +1,17 @@ -

- -

-

- Shoutrrr -

-

- Notification library for gophers and their furry friends. - Heavily inspired by caronc/apprise. -

-

- codacy coverage - circleci - codacy grade - GitHub code size in bytes - license - GoDoc -

+# Shoutrrr + + +[![shoutrrr logo](https://github.com/containrrr/shoutrrr/raw/gh-pages/shoutrrr.jpg)](https://github.com/containrrr/shoutrrr) + +Notification library for gophers and their furry friends. +Heavily inspired by caronc/apprise. + +[![codacy coverage](https://img.shields.io/codacy/coverage/30ce077eecde418ca328f4f7868f70c8.svg?style=flat-square)](https://app.codacy.com/app/containrrr/shoutrrr?utm_source=github.com&utm_medium=referral&utm_content=containrrr/shoutrrr&utm_campaign=Badge_Grade_Dashboard) +[![codacy grade](https://img.shields.io/codacy/grade/30ce077eecde418ca328f4f7868f70c8/master.svg?style=flat-square)](https://app.codacy.com/app/containrrr/shoutrrr?utm_source=github.com&utm_medium=referral&utm_content=containrrr/shoutrrr&utm_campaign=Badge_Grade_Dashboard) +[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/containrrr/shoutrrr.svg?style=flat-square)](https://github.com/containrrr/shoutrrr) +[![license](https://img.shields.io/github/license/containrrr/shoutrrr.svg?style=flat-square)](https://github.com/containrrr/shoutrrr/blob/master/LICENSE) +[![godoc](https://godoc.org/github.com/containrrr/shoutrrr?status.svg)](https://godoc.org/github.com/containrrr/shoutrrr) To make it easy and streamlined to consume shoutrrr regardless of the notification service you want to use, we've implemented a notification service url schema. To send notifications, instantiate the `ShoutrrrClient` using one of -the service urls below. \ No newline at end of file +the service urls from the [overview](/services/overview). \ No newline at end of file diff --git a/docs/services/discord.md b/docs/services/discord.md index fb3ea089..61d9dcf9 100644 --- a/docs/services/discord.md +++ b/docs/services/discord.md @@ -1,6 +1,6 @@ # Discord -## URL format +## URL Format Your Discord Webhook-URL will look like this: > https://discordapp.com/api/webhooks/__`channel`__/__`token`__ diff --git a/docs/services/hangouts.md b/docs/services/hangouts.md index 8f8546c2..496077e5 100644 --- a/docs/services/hangouts.md +++ b/docs/services/hangouts.md @@ -1,6 +1,6 @@ # Hangouts Chat -## URL format +## URL Format Your Hangouts Chat Incoming Webhook URL will look like this: diff --git a/docs/services/mattermost.md b/docs/services/mattermost.md index 67714414..0eaa90d8 100644 --- a/docs/services/mattermost.md +++ b/docs/services/mattermost.md @@ -1,6 +1,6 @@ # MatterMost -## URL format +## URL Format ## Creating a Webhook in MatterMost diff --git a/docs/services/overview.md b/docs/services/overview.md index e76a46f5..580928f7 100644 --- a/docs/services/overview.md +++ b/docs/services/overview.md @@ -2,18 +2,18 @@ Click on the service for a more thorough explanation. -| Service | URL format | -| -------------------------------------------- | ------------ | -| [Discord](/shoutrrr/services/discord) | *discord://__`token`__@__`channel`__* | -| [Telegram](/shoutrrr/services/not-documented) | *telegram://__`token`__@telegram?channels=__`channel-1`__[,__`channel-2`__,...]* | -| [Pushover](/shoutrrr/services/pushover) | *pushover://shoutrrr:__`apiToken`__@__`userKey`__/?devices=__`device1`__[,__`device2`__, ...]* | -| [Slack](/shoutrrr/services/not-documented) | *slack://[__`botname`__@]__`token-a`__/__`token-b`__/__`token-c`__* | -| [Email](/shoutrrr/services/not-documented) | *smtp://__`username`__:__`password`__@__`host`__:__`port`__/?fromAddress=__`fromAddress`__&toAddresses=__`recipient1`__[,__`recipient2`__,...]* | -| [Microsoft Teams](/shoutrrr/services/not-documented) | *teams://__`token-a`__/__`token-b`__/__`token-c`__* | -| [Gotify](/shoutrrr/services/not-documented) | *gotify://__`gotify-host`__/__`token`__* | -| [Pushbullet](/shoutrrr/services/not-documented) | *pushbullet://__`api-token`__[/__`device`__/#__`channel`__/__`email`__]* | -| [IFTTT](/shoutrrr/services/not-documented) | *ifttt://__`key`__/?events=__`event1`__[,__`event2`__,...]&value1=__`value1`__&value2=__`value2`__&value3=__`value3`__* | -| [Mattermost](/shoutrrr/services/not-documented) | *mattermost://[__`username`__@]__`mattermost-host`__/__`token`__[/__`channel`__]* | -| [Hangouts Chat](/shoutrrr/services/hangouts) | *hangouts://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz* | -| [Zulip Chat](/shoutrrr/services/zulip) | *zulip://__`bot-mail`__:__`bot-key`__@__`zulip-domain`__/?stream=__`name-or-id`__&topic=__`name`__* | -| [Join](/shoutrrr/services/not-documented) | *join://shoutrrr:__`api-key`__@join/?devices=__`device1`__[,__`device2`__, ...][&icon=__`icon`__][&title=__`title`__]* | +| Service | URL format | +| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| [Discord](./discord.md) | *discord://__`token`__@__`channel`__* | +| [Telegram](./not-documented.md) | *telegram://__`token`__@telegram?channels=__`channel-1`__[,__`channel-2`__,...]* | +| [Pushover](./pushover.md) | *pushover://shoutrrr:__`apiToken`__@__`userKey`__/?devices=__`device1`__[,__`device2`__, ...]* | +| [Slack](./not-documented.md) | *slack://[__`botname`__@]__`token-a`__/__`token-b`__/__`token-c`__* | +| [Email](./not-documented.md) | *smtp://__`username`__:__`password`__@__`host`__:__`port`__/?fromAddress=__`fromAddress`__&toAddresses=__`recipient1`__[,__`recipient2`__,...]* | +| [Microsoft Teams](./teams.md) | *teams://__`token-a`__/__`token-b`__/__`token-c`__* | +| [Gotify](./not-documented.md) | *gotify://__`gotify-host`__/__`token`__* | +| [Pushbullet](./not-documented.md) | *pushbullet://__`api-token`__[/__`device`__/#__`channel`__/__`email`__]* | +| [IFTTT](./not-documented.md) | *ifttt://__`key`__/?events=__`event1`__[,__`event2`__,...]&value1=__`value1`__&value2=__`value2`__&value3=__`value3`__* | +| [Mattermost](./not-documented.md) | *mattermost://[__`username`__@]__`mattermost-host`__/__`token`__[/__`channel`__]* | +| [Hangouts Chat](./hangouts.md) | *hangouts://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz* | +| [Zulip Chat](./zulip.md) | *zulip://__`bot-mail`__:__`bot-key`__@__`zulip-domain`__/?stream=__`name-or-id`__&topic=__`name`__* | +| [Join](./not-documented.md) | *join://shoutrrr:__`api-key`__@join/?devices=__`device1`__[,__`device2`__, ...][&icon=__`icon`__][&title=__`title`__]* | diff --git a/docs/services/pushover.md b/docs/services/pushover.md index da525ee1..d208cf04 100644 --- a/docs/services/pushover.md +++ b/docs/services/pushover.md @@ -1,6 +1,6 @@ # Pushover -## URL Reference +## URL Format *pushover://shoutrrr:__`apiToken`__@__`userKey`__/?devices=__`device1`__[,__`device2`__, ...]* diff --git a/docs/services/teams.md b/docs/services/teams.md new file mode 100644 index 00000000..53bb171a --- /dev/null +++ b/docs/services/teams.md @@ -0,0 +1,18 @@ +# Teams + +## URL Format + +*teams://__`token-a`__/__`token-b`__/__`token-c`__* + +## Setting up a webhook + +To be able to use the Microsoft Teams notification service, you first need to set up a custom webhook. +Instructions on how to do this can be found in [this guide](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using#setting-up-a-custom-incoming-webhook) + +## Extracting the token + +The token is extracted from your webhook URL: + +``` + https://outlook.office.com/webhook/{tokenA}/IncomingWebhook/{tokenB}/{tokenC} +``` \ No newline at end of file diff --git a/docs/services/zulip.md b/docs/services/zulip.md index 93e2eaa2..a3dd4fbd 100644 --- a/docs/services/zulip.md +++ b/docs/services/zulip.md @@ -1,6 +1,6 @@ # Zulip Chat -## URL format +## URL Format The shoutrrr service URL should look like this: > zulip://__`bot-mail`__:__`bot-key`__@__`zulip-domain`__/?stream=__`name-or-id`__&topic=__`name`__ diff --git a/mkdocs.yml b/mkdocs.yml index 2cc0ce2f..1bab3081 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,17 +11,18 @@ theme: markdown_extensions: - toc: permalink: True - separator: "_" + separator: '_' - codehilite nav: - 'Home': 'index.md' - 'Getting started': 'getting-started.md' + - 'Overview': 'services/overview.md' - Services: - - Overview: 'services/overview.md' - - Discord: 'services/discord.md' - - Hangouts Chat: 'services/hangouts.md' - - Pushover: 'services/pushover.md' - - Zulip Chat: 'services/zulip.md' + - Discord: 'services/discord.md' + - Hangouts Chat: 'services/hangouts.md' + - Pushover: 'services/pushover.md' + - Teams: 'services/teams.md' + - Zulip Chat: 'services/zulip.md' plugins: - search