Metadata-Version: 2.4
Name: moat-link-notify
Version: 0.0.8
Summary: Notification gateway for MoaT-Link
Author-email: Matthias Urlichs <matthias@urlichs.de>
Project-URL: homepage, https://m-o-a-t.org
Project-URL: repository, https://github.com/M-o-a-T/moat
Keywords: MoaT
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: AsyncIO
Classifier: Framework :: Trio
Classifier: Framework :: AnyIO
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: anyio~=4.2
Requires-Dist: asyncclick~=8.3
Requires-Dist: attrs
Requires-Dist: httpx
Requires-Dist: moat-util~=0.64.0
Requires-Dist: moat-link~=0.10.1
Dynamic: license-file

# Notification gateway

% start synopsis
% start main

Notification gateway for MoaT-Link.

This package provides notification services for MoaT-Link, allowing you to send
notifications to external services.

It includes an error mirror that watches the `error.*` subtree and forwards
qualifying entries to the `notify.*` subtree based on dynamically-configured
rules stored in a notify-vecs tree below `conv.*`.

% end synopsis

## Backends

Currently the only implemented backend is `ntfy.sh`.

% end main

## Usage

The notification gateway can be configured through MoaT-Link's configuration system.

### Error mirroring

Run `moat link notify mirror` to start the error mirror.  Set
`link.notify.vecs` to a path below `conv.*` holding the mirroring rules.
See `docs/moat-link/errors.md` for details.

## License

This project is licensed under the same terms as MoaT.
