docs: refactor notifications to use tabs
This commit is contained in:
parent
ff9decb54b
commit
c5e35cf8b1
1 changed files with 151 additions and 134 deletions
|
|
@ -77,8 +77,20 @@ Each assignment is independent. One schedule can send failures to Email, warning
|
||||||
|
|
||||||
## Type reference
|
## Type reference
|
||||||
|
|
||||||
### Email (SMTP)
|
<Tabs
|
||||||
|
items={[
|
||||||
|
"Email (SMTP)",
|
||||||
|
"Slack",
|
||||||
|
"Discord",
|
||||||
|
"Gotify",
|
||||||
|
"ntfy",
|
||||||
|
"Pushover",
|
||||||
|
"Telegram",
|
||||||
|
"Generic Webhook",
|
||||||
|
"Custom",
|
||||||
|
]}
|
||||||
|
>
|
||||||
|
<Tab value="Email (SMTP)">
|
||||||
Use Email when you want alerts to go to people, shared mailboxes, or downstream systems that already process email.
|
Use Email when you want alerts to go to people, shared mailboxes, or downstream systems that already process email.
|
||||||
|
|
||||||
**Fields**
|
**Fields**
|
||||||
|
|
@ -110,9 +122,9 @@ From Name: Zerobyte Alerts
|
||||||
To Addresses: ops@example.com, backups@example.com
|
To Addresses: ops@example.com, backups@example.com
|
||||||
Use TLS: On
|
Use TLS: On
|
||||||
```
|
```
|
||||||
|
</Tab>
|
||||||
|
|
||||||
### Slack
|
<Tab value="Slack">
|
||||||
|
|
||||||
Use Slack for shared operational visibility in a team channel.
|
Use Slack for shared operational visibility in a team channel.
|
||||||
|
|
||||||
**Fields**
|
**Fields**
|
||||||
|
|
@ -129,9 +141,9 @@ Webhook URL: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXX
|
||||||
Bot Username: Zerobyte
|
Bot Username: Zerobyte
|
||||||
Icon Emoji: :floppy_disk:
|
Icon Emoji: :floppy_disk:
|
||||||
```
|
```
|
||||||
|
</Tab>
|
||||||
|
|
||||||
### Discord
|
<Tab value="Discord">
|
||||||
|
|
||||||
Use Discord when your team lives in a server channel, or when you want to post to a specific thread.
|
Use Discord when your team lives in a server channel, or when you want to post to a specific thread.
|
||||||
|
|
||||||
**Fields**
|
**Fields**
|
||||||
|
|
@ -140,9 +152,9 @@ Use Discord when your team lives in a server channel, or when you want to post t
|
||||||
- `Bot Username` (optional)
|
- `Bot Username` (optional)
|
||||||
- `Avatar URL` (optional)
|
- `Avatar URL` (optional)
|
||||||
- `Thread ID` (optional)
|
- `Thread ID` (optional)
|
||||||
|
</Tab>
|
||||||
|
|
||||||
### Gotify
|
<Tab value="Gotify">
|
||||||
|
|
||||||
Use Gotify when you want self-hosted push with explicit priority control.
|
Use Gotify when you want self-hosted push with explicit priority control.
|
||||||
|
|
||||||
**Fields**
|
**Fields**
|
||||||
|
|
@ -151,9 +163,9 @@ Use Gotify when you want self-hosted push with explicit priority control.
|
||||||
- `App Token`
|
- `App Token`
|
||||||
- `Priority` from `0` to `10`
|
- `Priority` from `0` to `10`
|
||||||
- `Path` (optional)
|
- `Path` (optional)
|
||||||
|
</Tab>
|
||||||
|
|
||||||
### ntfy
|
<Tab value="ntfy">
|
||||||
|
|
||||||
Use ntfy when you want a simple topic-based push service, either on `ntfy.sh` or your own server.
|
Use ntfy when you want a simple topic-based push service, either on `ntfy.sh` or your own server.
|
||||||
|
|
||||||
**Fields**
|
**Fields**
|
||||||
|
|
@ -178,9 +190,9 @@ Topic: zerobyte-backups
|
||||||
Access token: <token>
|
Access token: <token>
|
||||||
Priority: high
|
Priority: high
|
||||||
```
|
```
|
||||||
|
</Tab>
|
||||||
|
|
||||||
### Pushover
|
<Tab value="Pushover">
|
||||||
|
|
||||||
Use Pushover for direct, personal push notifications.
|
Use Pushover for direct, personal push notifications.
|
||||||
|
|
||||||
**Fields**
|
**Fields**
|
||||||
|
|
@ -189,9 +201,9 @@ Use Pushover for direct, personal push notifications.
|
||||||
- `API Token`
|
- `API Token`
|
||||||
- `Devices` (optional)
|
- `Devices` (optional)
|
||||||
- `Priority` as `-1`, `0`, or `1`
|
- `Priority` as `-1`, `0`, or `1`
|
||||||
|
</Tab>
|
||||||
|
|
||||||
### Telegram
|
<Tab value="Telegram">
|
||||||
|
|
||||||
Use Telegram when you want notifications in a bot chat or a group topic.
|
Use Telegram when you want notifications in a bot chat or a group topic.
|
||||||
|
|
||||||
**Fields**
|
**Fields**
|
||||||
|
|
@ -208,9 +220,9 @@ Bot Token: 123456789:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
|
||||||
Chat ID: -1231234567890
|
Chat ID: -1231234567890
|
||||||
Thread ID: 3
|
Thread ID: 3
|
||||||
```
|
```
|
||||||
|
</Tab>
|
||||||
|
|
||||||
### Generic Webhook
|
<Tab value="Generic Webhook">
|
||||||
|
|
||||||
Use Generic Webhook when another service expects a normal HTTP request instead of a provider-specific webhook format.
|
Use Generic Webhook when another service expects a normal HTTP request instead of a provider-specific webhook format.
|
||||||
|
|
||||||
**Fields**
|
**Fields**
|
||||||
|
|
@ -242,11 +254,13 @@ Use JSON Template: On
|
||||||
Title Key: title
|
Title Key: title
|
||||||
Message Key: message
|
Message Key: message
|
||||||
```
|
```
|
||||||
|
</Tab>
|
||||||
|
|
||||||
### Custom (Shoutrrr URL)
|
<Tab value="Custom">
|
||||||
|
|
||||||
Use Custom when you already know the exact Shoutrrr URL you want Zerobyte to use.
|
Use Custom when you already know the exact Shoutrrr URL you want Zerobyte to use.
|
||||||
|
|
||||||
|
See the [Shoutrrr documentation](https://shoutrrr.nickfedor.com/services/overview) for the supported URL formats and service-specific options.
|
||||||
|
|
||||||
**Fields**
|
**Fields**
|
||||||
|
|
||||||
- `Shoutrrr URL`
|
- `Shoutrrr URL`
|
||||||
|
|
@ -256,6 +270,8 @@ Use Custom when you already know the exact Shoutrrr URL you want Zerobyte to use
|
||||||
```text
|
```text
|
||||||
slack://hook:T000-B000-XXX@webhook?username=Zerobyte
|
slack://hook:T000-B000-XXX@webhook?username=Zerobyte
|
||||||
```
|
```
|
||||||
|
</Tab>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
## Practical routing patterns
|
## Practical routing patterns
|
||||||
|
|
||||||
|
|
@ -273,3 +289,4 @@ slack://hook:T000-B000-XXX@webhook?username=Zerobyte
|
||||||
- [Repository maintenance and status](/docs/guides/repository-maintenance)
|
- [Repository maintenance and status](/docs/guides/repository-maintenance)
|
||||||
|
|
||||||
import { Callout } from "fumadocs-ui/components/callout";
|
import { Callout } from "fumadocs-ui/components/callout";
|
||||||
|
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue