broodjeaap/go-watch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

changed readme for new refactored notifiers

Browse source
This commit is contained in:
BroodjeAap 2022-12-28 13:23:41 +00:00
parent b9a7c66d10
commit 2524535a10
2 changed files with 19 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -273,13 +273,24 @@ The gopher-lua-libs provide an [http](https://github.com/vadv/gopher-lua-libs/tr
# Notifiers # Notifiers
The basic form is:
```
notifiers:
<notifier-name>:
type: "<notifier-type>"
other: ""
values: ""
etc: ""
```
See below for possible types.
## Shoutrrr ## Shoutrrr
[Shoutrrr](https://containrrr.dev/shoutrrr/v0.5/) can be used to notify many different services, check their docs for a [list](https://containrrr.dev/shoutrrr/v0.5/services/overview/) of which ones. [Shoutrrr](https://containrrr.dev/shoutrrr/v0.5/) can be used to notify many different services, check their docs for a [list](https://containrrr.dev/shoutrrr/v0.5/services/overview/) of which ones.
An example config for sending notifications through Shoutrrr: An example config for sending notifications through Shoutrrr:
``` ```
notifiers: notifiers:
shoutrrr: Shoutrrr-telegram-discord:
type: "shoutrrr"
urls: urls:
- telegram://<token>@telegram?chats=<channel-1-id>,<chat-2-id> - telegram://<token>@telegram?chats=<channel-1-id>,<chat-2-id>
- discord://<token>@<webhookid> - discord://<token>@<webhookid>
@ -295,7 +306,7 @@ Get a bot token from the [@BotFather](https://core.telegram.org/bots/tutorial) a
An example config for sending notifications through Telegram: An example config for sending notifications through Telegram:
``` ```
notifiers: notifiers:
telegram: Telegram:
token: "<token>" token: "<token>"
chat: "<chatID>" chat: "<chatID>"
debug: false debug: false
@ -311,7 +322,8 @@ Then you can right click on your username in any chat to copy your user ID or ri
An example config for sending DM notifications through Discord: An example config for sending DM notifications through Discord:
``` ```
notifiers: notifiers:
discord: Discord:
type: "discord"
token: "<token>" token: "<token>"
userID: "<userID>" userID: "<userID>"
debug: false debug: false
@ -323,7 +335,8 @@ database:
An example config for sending channel notifications: An example config for sending channel notifications:
``` ```
notifiers: notifiers:
discord: Discord:
type: "discord"
token: "<token>" token: "<token>"
server: server:
ID: "<serverID>" ID: "<serverID>"
@ -341,7 +354,8 @@ Both a userID and serverID/channelID is also possible.
An example config for sending email notifications through a SMTP relay server: An example config for sending email notifications through a SMTP relay server:
``` ```
notifiers: notifiers:
email: Email-to-at-email-com:
type: "email"
server: "smtp.relay.com" server: "smtp.relay.com"
port: "465" port: "465"
from: "from@email.com" from: "from@email.com"

2
todo.md
View file

@ -4,6 +4,4 @@
- comments - comments
- run/fix staticcheck - run/fix staticcheck
- add browserless support ? - add browserless support ?
- ~~refactor notifiers to be a list, with 'type' value?~~
- readme
- file output notifier? - file output notifier?