maubot-ntfy/README.md

14 lines
866 B
Markdown

# maubot-ntfy
This is a [maubot](https://maubot.xyz/) plugin to subscribe to [ntfy](https://ntfy.sh/) topics and send messages to a matrix room.
## Usage
Install as a maubot plugin and configure an instance. Until maubot supports installing python dependencies, you should install the `emoji` python package for full functionality. Alternatively, `@ntfy:catgirl.cloud` is available as well.
Use `!ntfy subscribe server/topic` (for example `!ntfy subscribe ntfy.sh/my_topic`) to subscribe the current room to the ntfy topic. Future messages will be sent to the room.
Use `!ntfy subscribe server/topic <access_token>` (for example `!ntfy subscribe ntfy.sh/my_protected_topic tk_be6uc2ca1x1orakcwg1j3hp0ylot6`) to subscribe to a protected topic via [access token](https://docs.ntfy.sh/config/#access-tokens).
To unsubscribe, use `!ntfy unsubscribe server/topic`.