You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tellme-bot/README.md

53 lines
862 B

2 years ago
# tellme-bot
2 years ago
Simple Bot to receive Webhooks, parse and send them as Message to a XMPP-account. The idea result
from the missing support of [Kuma](https://github.com/louislam/uptime-kuma) for sending Notifications with
XMPP.
## Install
```
yarn install
yarn start
or
pm2 start yarn start --name=tellme-bot
```
## Konfiguration
```
APP_DEBUG=false
APP_PORT=
APP_API_TOKEN=
APP_API_ALLOWED_PARSERS=kuma
XMPP_SERVICE=
XMPP_DOMAIN=
XMPP_USERNAME=
XMPP_PASSWORD=
XMPP_TO=
```
## Webhook
2 years ago
\<domain\>/api/v1/webhook/\<parser\>/\<api-token\>
2 years ago
## health
\<domain\>/api/v1/health
## Parsers
2 years ago
Existing Parsers,
* Kuma / Getting Notifications from Kuma
* Text / Getting "text" Parameter in JSON-Body
## Custom Parsers
Create a new Class, extends is with parser.js, add a parser-function and add the name of the file in the .env to
2 years ago
**APP_API_ALLOWED_PARSERS**.