mirror
/
xmpp-webhook
kopia lustrzana https://github.com/tmsmr/xmpp-webhook
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
Multipurpose XMPP-Webhook : Grafana Webhook alerts Alertmanager Webhooks Slack Incoming Webhooks
69 Commity
1 Gałąź
0 Tagi
95 KiB
Go 85.8%
Shell 7.8%
Dockerfile 6.4%
 
 
 
Go to file
Thomas Maier dc1d33cf31 updates dev/test client 2021-02-28 10:21:50 +01:00
dev updates dev/test client 2021-02-28 10:21:50 +01:00
parser Add alertmanager parser 2021-02-27 20:25:05 +01:00
.gitignore ignore jetbrains project files 2018-12-09 15:50:14 +01:00
Dockerfile Introduces Dockerfile for deployment and a Docker Compose stack (Prosody server + test clients) for development 2019-10-30 18:43:46 +01:00
LICENSE Changes License (MIT) 2019-07-30 08:59:19 +02:00
README.md Make listen address configurable 2021-02-28 09:53:25 +01:00
THIRD-PARTY-NOTICES Updates THIRD-PARTY-NOTICES 2019-11-04 21:16:19 +01:00
go.mod Update dependencies 2021-02-28 09:53:25 +01:00
go.sum regenerate go.sum 2021-02-28 09:53:25 +01:00
handler.go refactored slack parser / reorganized parser functions 2020-01-06 18:18:24 +01:00
main.go add SCRAM-SHA-256 and SCRAM-SHA-256-PLUS as SASL mechanisms 2021-02-28 09:53:25 +01:00
xmpp-webhook.service adds systemd service file 2017-09-26 15:10:33 +02:00

README.md

xmpp-webhook

Status

xmpp-webhook currently support:

  • Grafana Webhook alerts
  • Slack Incoming Webhooks (Feedback appreciated)

Check https://github.com/tmsmr/xmpp-webhook/blob/master/parser/ to learn how to support more source services.

Usage

  • xmpp-webhook is configured via environment variables:
    • XMPP_ID - The JID we want to use
    • XMPP_PASS - The password
    • XMPP_RECEIVERS - Comma-seperated list of JID's
    • XMPP_SKIP_VERIFY - Skip TLS verification (Optional)
    • XMPP_OVER_TLS - Use dedicated TLS port (Optional)
    • XMPP_WEBHOOK_LISTEN_ADDRESS - Bind address (Optional)
  • After startup, xmpp-webhook tries to connect to the XMPP server and provides the implemented HTTP enpoints (on :4321). e.g.:
curl -X POST -d @grafana-webhook-alert-example.json localhost:4321/grafana
curl -X POST -d @slack-compatible-notification-example.json localhost:4321/slack
  • After parsing the body in the appropriate parserFunc, the notification is then distributed to the configured receivers.

Run with Docker

Build it

  • Build image: docker build -t xmpp-webhook .
  • Run: docker run -e "XMPP_ID=alerts@example.org" -e "XMPP_PASS=xxx" -e "XMPP_RECEIVERS=receiver1@example.org,receiver2@example.org" -p 4321:4321 -d --name xmpp-webhook xmpp-webhook

Use prebuilt image from Docker Hub

  • Run: docker run -e "XMPP_ID=alerts@example.org" -e "XMPP_PASS=xxx" -e "XMPP_RECEIVERS=receiver1@example.org,receiver2@example.org" -p 4321:4321 -d --name xmpp-webhook tmsmr/xmpp-webhook:latest

Installation

IMPORTANT NOTE: For the sake of simplicity, xmpp-webhook is not reconnecting to the XMPP server after a connection-loss. If you use the provided xmpp-webhook.service - Systemd will manage the reconnect by restarting the service..

-> https://github.com/mellium/xmpp automatically reconnects after a failure.

  • Download and extract the latest tarball (GitHub release page)
  • Install the binary: install -D -m 744 xmpp-webhook /usr/local/bin/xmpp-webhook
  • Install the service: install -D -m 644 xmpp-webhook.service /etc/systemd/system/xmpp-webhook.service
  • Configure XMPP credentials in /etc/xmpp-webhook.env. e.g.:
XMPP_ID='bot@example.com'
XMPP_PASS='passw0rd'
XMPP_RECEIVERS='jdoe@example.com,ops@example.com'
  • Enable and start the service:
systemctl daemon-reload
systemctl enable xmpp-webhook
systemctl start xmpp-webhook

Building

Need help?

Feel free to contact me!