-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
71 changed files
with
1,680 additions
and
274 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,3 +8,5 @@ site/ | |
node_modules | ||
.vscode | ||
modules/ | ||
.aider* | ||
.venv/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
105 changes: 105 additions & 0 deletions
105
mission-control/docs/notifications/channels/discord.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
# Discord | ||
|
||
:::note URL Format | ||
discord://__`token`__@__`webhookid`__ | ||
::: | ||
|
||
import { FaGear } from "react-icons/fa6"; | ||
import Fields from '@site/src/components/Fields'; | ||
|
||
<Fields rows={[ | ||
{ | ||
field: "token", | ||
required: true, | ||
description: "Discord API application token", | ||
scheme: "string", | ||
}, | ||
{ | ||
field: "webhookID", | ||
required: true, | ||
description: "Discord webhook ID", | ||
scheme: "string", | ||
}, | ||
{ | ||
field: "avatar", | ||
description: "Override the webhook default avatar with specified URL", | ||
aliases: ["avatarurl"], | ||
scheme: "string", | ||
}, | ||
{ | ||
field: "color", | ||
description: "The color of the left border for plain messages", | ||
default: "0x50D9ff", | ||
scheme: "string", | ||
}, | ||
{ | ||
field: "colorDebug", | ||
description: "The color of the left border for debug messages", | ||
default: "0x7b00ab", | ||
scheme: "string", | ||
}, | ||
{ | ||
field: "colorError", | ||
description: "The color of the left border for error messages", | ||
default: "0xd60510", | ||
scheme: "string", | ||
}, | ||
{ | ||
field: "colorInfo", | ||
description: "The color of the left border for info messages", | ||
default: "0x2488ff", | ||
scheme: "string", | ||
}, | ||
{ | ||
field: "colorWarn", | ||
description: "The color of the left border for warning messages", | ||
default: "0xffc441", | ||
scheme: "string", | ||
}, | ||
{ | ||
field: "json", | ||
description: "Whether to send the whole message as the JSON payload instead of using it as the 'content' field", | ||
default: "No", | ||
scheme: "bool", | ||
}, | ||
{ | ||
field: "splitLines", | ||
description: "Whether to send each line as a separate embedded item", | ||
default: "Yes", | ||
scheme: "bool", | ||
}, | ||
{ | ||
field: "username", | ||
description: "Override the webhook default username", | ||
scheme: "string", | ||
}, | ||
]} /> | ||
|
||
|
||
## Getting a | ||
|
||
1. Click on the <FaGear /> next to your channel name | ||
![Screenshot 1](discord/sc-1.png) | ||
|
||
2. Click on **Integrations** | ||
![Screenshot 2](discord/sc-2.png) | ||
|
||
3. Click on **Create Webhook** | ||
![Screenshot 3](discord/sc-3.png) | ||
|
||
4. Set the name, channel and icon and then click on **Copy Webhook URL** | ||
![Screenshot 4](discord/sc-4.png) | ||
|
||
5. Click on **Save Changes** | ||
![Screenshot 5](discord/sc-5.png) | ||
|
||
6. Copy the `webhookId` and `token` fields from the URL | ||
``` | ||
https://discord.com/api/webhooks/693853386302554172/W3dE2OZz4C13_4z_uHfDOoC7BqTW288s-z1ykqI0iJnY_HjRqMGO8Sc7YDqvf_KVKjhJ | ||
└────────────────┘ └──────────────────────────────────────────────────────────────────┘ | ||
webhook id token | ||
discord://W3dE2OZz4C13_4z_uHfDOoC7BqTW288s-z1ykqI0iJnY_HjRqMGO8Sc7YDqvf_KVKjhJ@693853386302554172 | ||
└──────────────────────────────────────────────────────────────────┘ └────────────────┘ | ||
token webhook id | ||
``` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
|
||
|
||
:::note URL Format | ||
smtp://`username`:`password`@`host`:`port`/?from=`fromAddress`&to=`recipient1`[,`recipient2`,...] | ||
::: | ||
|
||
<Fields rows={[{ | ||
field: "username", | ||
description: "SMTP server username", | ||
default: "", | ||
required: false, | ||
urlPart: "username" | ||
}, | ||
{ | ||
field: "password", | ||
description: "SMTP server password or hash (for OAuth2)", | ||
default: "", | ||
required: false, | ||
urlPart: "password" | ||
}, | ||
{ | ||
field: "host", | ||
description: "SMTP server hostname or IP address", | ||
default: "", | ||
required: true, | ||
urlPart: "host" | ||
}, | ||
{ | ||
field: "port", | ||
description: "SMTP server port, common ones are 25, 465, 587 or 2525", | ||
default: "25", | ||
urlPart: "port" | ||
}, | ||
{ | ||
field: "fromAddress", | ||
description: "E-mail address that the mail are sent from", | ||
aliases: [ | ||
"from" | ||
], | ||
default: "", | ||
required: true | ||
}, | ||
{ | ||
field: "auth", | ||
description: "SMTP authentication method", | ||
default: "Unknown", | ||
oneOf: [ | ||
"None", | ||
"Plain", | ||
"CRAMMD5", | ||
"Unknown", | ||
"OAuth2" | ||
], | ||
required: false | ||
}, | ||
{ | ||
field: "clientHost", | ||
description: "The client host name sent to the SMTP server during HELLO phase. If set to \"auto\" it will use the OS hostname", | ||
default: "localhost", | ||
required: false | ||
}, | ||
{ | ||
field: "encryption", | ||
description: "Encryption method", | ||
default: "Auto", | ||
oneOf: [ | ||
"None", | ||
"ExplicitTLS", | ||
"ImplicitTLS", | ||
"Auto" | ||
], | ||
required: false | ||
}, | ||
{ | ||
field: "fromName", | ||
description: "Name of the sender", | ||
default: "", | ||
required: false | ||
}, | ||
{ | ||
field: "subject", | ||
description: "The subject of the sent mail", | ||
aliases: [ | ||
"title" | ||
], | ||
default: "Shoutrrr Notification", | ||
required: false | ||
}, | ||
{ | ||
field: "useHTML", | ||
description: "Whether the message being sent is in HTML", | ||
default: false, | ||
required: false | ||
}, | ||
{ | ||
field: "useStartTLS", | ||
description: "Whether to use StartTLS encryption", | ||
aliases: [ | ||
"starttls" | ||
], | ||
default: true, | ||
required: false | ||
}]}/> |
Oops, something went wrong.