notify-webhook/README.md
Tristan b56f45abf8
All checks were successful
Build & Push Docker / docker (push) Successful in 53s
add readme
2026-01-07 16:02:18 +00:00

1.2 KiB

xmpp-webhook

This is a simple webhook to send xmpp messages via an webhook.

Publishing & usage

The docker image is automatically published on push.

docker pull git.fucktheforce.de/tristan/xmpp-webhook:latest

Docker parameters

Exposed Port: 5000

Volumes:

  • /app/.env
  • /app/logs

Configuration

The sender and receipient configuration is identified by an API-Key. The configuration is done via .env.

Env-Variable Description
ACCOUNT{NUM}_APIKEY The API-Key
ACCOUNT{NUM}_JID Sender JID
ACCOUNT{NUM}_PASS Password of sender JID
ACCOUNT{NUM}_RECEIPIENT Receipient JID - the address the notification to send to

Server Configuration

Env-Variable Description Default
LOG_FILE the log file to log to, used from python app logs/webhook.log
LOG_MAX_BYTES the maximum size of the log file, used from python app 10**6
LOG_BACKUP_COUNT the maximum number of files to keep, used from python app 5

Server Configuration (for systemd-usage)

Env-Variable Description Default
HOST the port to use to expose the service 0.0.0.0
PORT the port to use to expose the service 5000