Skip to content

Commit

Permalink
shoutrrr 0.7
Browse files Browse the repository at this point in the history
  • Loading branch information
@JosephKav
JosephKav committed Jun 1, 2023
1 parent b084c94 commit d4caf0e
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 18 deletions.
2 changes: 2 additions & 0 deletions content/en/docs/Config/defaults.md
View file
Expand Up @@ -35,6 +35,7 @@ Defaults can be defined for each `notify` type. Details about the vars for each
defaults:
...
notify:
bark:
discord:
email:
gotify:
Expand All @@ -43,6 +44,7 @@ defaults:
join:
mattermost:
matrix:
ntfy:
opsgenie:
pushbullet:
pushover:
Expand Down
90 changes: 72 additions & 18 deletions content/en/docs/Config/notify.md
View file
Expand Up @@ -6,7 +6,7 @@ description: >
Configure global notifiers that can be used by any Service.
---

We are running [Shoutrrr 0.6](https://containrrr.dev/shoutrrr/v0.6/services/overview/), which supports sending notifications to the following services below.
We are running [Shoutrrr 0.7](https://containrrr.dev/shoutrrr/v0.7/services/overview/), which supports sending notifications to the services listed below.

The 'URL Fields' go under `url_fields` and 'Query/Param Props' go under `params`.

Expand Down Expand Up @@ -57,10 +57,34 @@ For further guidance and other helpful examples on the templating used, start by

{{< tabpane text=true right=true >}}
{{% tab header="**types**:" disabled=true /%}}
{{% tab header="bark" %}}
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/bark/)

```yaml
notify:
...
# as many of these (below) as you like, just ensure they have unique ID's.
EXAMPLE_NOTIFY:
type: bark
url_fields:
DeviceKey: DEVICE_KEY
Host: your_host
# Path: /foo
# params:
# Badge: 0 # Number displayed next to App icon
# Copy: foo # Value to be copied
# Group: admins # Group of the notification
# Icon: https://example.com/icon.png # URL to an image
# Scheme: http/https # Server protocol
# Sound: '' # Fromm https://github.com/Finb/Bark/tree/master/Sounds
# Title: Release # Notification title
# URL: https://example.com # URL to open when notification is tapped
```
{{% /tab %}}
{{% tab header="discord" %}}
- As of writing, Discord Webhooks are in the format of `https://discord.com/api/webhooks/WEBHOOK_ID/TOKEN` (`<Server Settings> - <Integrations> - <Webhooks>`)

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/discord/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/discord/)

```yaml
notify:
Expand All @@ -80,7 +104,7 @@ notify:
{{% tab header="smtp" %}}
- email notifications

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/email/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/email/)

```yaml
notify:
Expand All @@ -106,7 +130,7 @@ notify:
{{% tab header="googlechat" %}}
- Example Google Chat incoming Webhook URL `https://chat.googleapis.com/v1/spaces/ FOO /messages?key= bar &token= baz`

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/googlechat/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/googlechat/)

```yaml
notify:
Expand All @@ -121,7 +145,7 @@ notify:
{{% tab header="gotify" %}}
- Create an application on the Gotify Web UI, and use that URL with the token for the application you make.

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/email/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/email/)

```yaml
notify:
Expand All @@ -141,7 +165,7 @@ notify:
```
{{% /tab %}}
{{% tab header="ifttt" %}}
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/ifttt/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/ifttt/)

```yaml
notify:
Expand All @@ -168,7 +192,7 @@ notify:
- Your `deviceId` is shown in the top
- Click **Show** next to `API Key` to see your key

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/join/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/join/)

```yaml
notify:
Expand All @@ -189,7 +213,7 @@ notify:

Example Mattermost Webhook - `https://mattermost.example.io/hooks/TOKEN`

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/mattermost/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/mattermost/)

```yaml
notify:
Expand All @@ -206,10 +230,40 @@ notify:
# Channel: releases
# params:
# Icon: https://release-argus.io/favicons/android-chrome-512x512.png # url/emoji
```
{{% /tab %}}
{{% tab header="ntfy" %}}
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/ntfy/)

```yaml
notify:
...
# as many of these (below) as you like, just ensure they have unique ID's.
EXAMPLE_NOTIFY:
type: mattermost
url_fields:
# Username: Argus
# Password: PASS123
Host: mattermost.example.io
# Port: 443
Topic: Release123
# params:
# Actions: '' # see https://docs.ntfy.sh/publish/#action-buttons
# Attach: https://example.com # URL of an attachment
# Cache: yes # Cache messages
# Click: https://example.com # URL to open when notification is clicked
# Email: name@example # Email address for email notifications
# Filename: '' # Filename for attachment
# Firebase: yes # Send to Firebase
# Icon: https://example.com/icon.png # URL to an icon
# Priority: default # Priority of the notification
# Scheme: https # Server protocol
# Tags: '' # Comma separated list of tags that may/may not map to eemojis
# Title: Argus # Title of the notification
```
{{% /tab %}}
{{% tab header="matrix" %}}
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/matrix/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/matrix/)

```yaml
notify:
Expand All @@ -231,7 +285,7 @@ notify:
{{% tab header="opsgenie" %}}
Go to `<Settings> - <Integrastion List> - <API>`

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/opsgenie/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/opsgenie/)

```yaml
notify:
Expand Down Expand Up @@ -268,7 +322,7 @@ notify:
- Get your `token` by creating an **Access Token** at https://www.pushbullet.com/#settings/account
- Get your `targets` by going to https://www.pushbullet.com/#devices. Click on the device on the left pane and the URL should change to https://www.pushbullet.com/#devices/\<TARGET\>

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/pushbullet/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/pushbullet/)

```yaml
notify:
Expand All @@ -290,7 +344,7 @@ You can also make an Application specific for Argus by clicking 'Create an Appli

In the device list, the Name column is the field used to refer to your devices

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/pushover/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/pushover/)

```yaml
notify:
Expand All @@ -310,7 +364,7 @@ notify:
{{% tab header="rocketchat" %}}
Example URL `username@host:port/TOKEN_A/TOKEN_B/CHANNEL`

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/rocketchat/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/rocketchat/)

```yaml
notify:
Expand Down Expand Up @@ -345,7 +399,7 @@ To use Webhooks:
- e.g. https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
- becomes 'hook:T00000000-B00000000-XXXXXXXXXXXXXXXXXXXXXXXX

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/slack/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/slack/)

```yaml
notify:
Expand All @@ -368,7 +422,7 @@ notify:

Example URL `https://<organization>.webhook.office.com/webhookb2/<Group>@<Tenant>/IncomingWebhook/<AltId>/<GroupOwner>`

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/teams/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/teams/)

```yaml
notify:
Expand All @@ -394,7 +448,7 @@ notify:
- `chat_id` is required for private channels/group chats/private chats. To get the ID, you can forward a message (from the target chat) to [@UserInfoBot](https://t.me/userinfobot) or [@JsonDumpBot](https://t.me/jsondumpbot) and view it at `Id` and `message.forward_from_chat.id` from those bots respectively.
- (The above bots are created and hosted by [@nadam](https://github.com/nadam) and their sources are available to view at [nadam/userinfobot](https://github.com/nadam/userinfobot) and [nadam/jsondumpbot](https://github.com/nadam/jsondumpbot))

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/telegram/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/telegram/)

```yaml
notify:
Expand All @@ -415,7 +469,7 @@ notify:
{{% tab header="zulip" %}}
Zulip Chat

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/zulip/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/zulip/)

```yaml
notify:
Expand All @@ -435,7 +489,7 @@ notify:
{{% tab header="shoutrrr" %}}
`Shoutrrr` will expect the full Shoutrrr URL and so could be used for any of the services in the Shoutrrr v0.6 docs. Any params specified in `params` will also be passed.

[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.6/services/overview/)
[Shoutrrr docs](https://containrrr.dev/shoutrrr/v0.7/services/overview/)

```yaml
notify:
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/Overview/_index.md
View file
Expand Up @@ -16,6 +16,7 @@ aliases:
- To keep track of new releases of one or more pieces of (most likely open-source) software.

- To be notified of these new releases via:
- Bark
- Discord
- Email
- Gotify
Expand All @@ -24,6 +25,7 @@ aliases:
- Join
- Mattermost
- Matrix
- Ntfy
- OpsGenie
- Pushbullet
- Pushover
Expand Down

0 comments on commit d4caf0e

Please sign in to comment.