No description
  • Go 95.3%
  • Makefile 3.6%
  • Dockerfile 1.1%
Find a file
zemdregon bca23f09d8
Some checks are pending
CI / lint (push) Waiting to run
CI / test (push) Waiting to run
CI / build (push) Waiting to run
CI / docker (push) Blocked by required conditions
chore(deps): bump docker/setup-buildx-action to v4
Self-hosted CI workflows only.
2026-08-10 18:17:50 -05:00
.github/workflows chore(deps): bump docker/setup-buildx-action to v4 2026-08-10 18:17:50 -05:00
cmd/module chore: add CI/LICENSE and drop local notify proto 2026-07-22 19:10:04 -05:00
internal Advertise settings capability (v0.1.5). 2026-08-10 04:53:03 -05:00
.dockerignore Initial commit 2026-07-03 12:03:13 -05:00
.env.example chore: add CI/LICENSE and drop local notify proto 2026-07-22 19:10:04 -05:00
.gitignore Initial commit 2026-07-03 12:03:13 -05:00
.golangci.yml Initial commit 2026-07-03 12:03:13 -05:00
CHANGELOG.md Advertise settings capability (v0.1.5). 2026-08-10 04:53:03 -05:00
COMPATIBILITY.md docs: add CHANGELOG and COMPATIBILITY (#4) 2026-08-09 19:58:24 -05:00
Dockerfile Initial commit 2026-07-03 12:03:13 -05:00
go.mod Expose Apprise and webhook channels via RegisterSettings. (#7) 2026-08-10 02:15:22 -05:00
go.sum Expose Apprise and webhook channels via RegisterSettings. (#7) 2026-08-10 02:15:22 -05:00
LICENSE chore: add CI/LICENSE and drop local notify proto 2026-07-22 19:10:04 -05:00
Makefile Initial commit 2026-07-03 12:03:13 -05:00
muxcore.json Advertise settings capability (v0.1.5). 2026-08-10 04:53:03 -05:00
README.md chore: add CI/LICENSE and drop local notify proto 2026-07-22 19:10:04 -05:00

notification-apprise

A MuxCore notification sidecar that delivers alerts through Apprise — a universal notification gateway supporting 100+ services (Slack, Telegram, Pushover, email, SMS, and many more) — plus optional direct Discord, Slack, and generic webhook channels.

How it works

This module is a gRPC sidecar implementing the NotificationProvider contract (NotificationService: Notify, Configure, Status). Apprise destinations are posted to an Apprise API server; Discord, Slack, and generic webhook channels POST directly to their configured URLs. The module also subscribes to media events from core and forwards them as notifications.

Configuration

Env variable Default Description
APPRISE_URL http://localhost:8000 Base URL of the Apprise API server
APPRISE_URLS Semicolon-separated Apprise destination URLs
APPRISE_TOKEN Bearer token for Apprise authentication
DISCORD_WEBHOOK Discord webhook URL (direct channel)
SLACK_WEBHOOK Slack incoming webhook URL (direct channel)
WEBHOOK_URL Generic JSON webhook URL (direct channel)
NOTIFY_GRPC_ADDR :9445 gRPC listen address
MUXCORE_GRPC_ADDR localhost:9090 Core mesh gRPC address
MUXCORE_INSECURE_DISABLE_TLS Set true to disable TLS when dialing core (dev)
MUXCORE_MODULE_ID notification-apprise Module identity override (via module SDK)

Key features

  • Multi-protocol gateway — Apprise reaches any supported service; Discord/Slack/webhook channels send directly.
  • Severity mapping — Apprise: info → low, success/warning → normal, error → high priority.
  • Dynamic configuration — URLs and channels can be added at runtime via gRPC Configure calls.
  • Media event forwarding — subscribes to movie/TV/download events from core and notifies configured channels.