https://github.com/nodebb/nodebb-plugin-ntfy
Push Notifications for NodeBB (via ntfy)
https://github.com/nodebb/nodebb-plugin-ntfy
Last synced: 11 months ago
JSON representation
Push Notifications for NodeBB (via ntfy)
- Host: GitHub
- URL: https://github.com/nodebb/nodebb-plugin-ntfy
- Owner: NodeBB
- License: mit
- Created: 2023-01-16T17:32:08.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-14T11:16:01.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T11:52:03.224Z (almost 2 years ago)
- Language: JavaScript
- Size: 429 KB
- Stars: 3
- Watchers: 3
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Push Notifications for NodeBB (via ntfy)
This plugin integrates NodeBB's notifications with [ntfy](https://ntfy.sh/), a simple HTTP-based [pub-sub](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern) notification service.
## How to use it
### As an administrator
This plugin comes bundled with NodeBB as of v3.0.0.
Activate this plugin from ACP > Extend > Plugins, and then rebuild & restart your NodeBB.
### As an end user
1. [Download the ntfy app](https://docs.ntfy.sh/subscribe/phone/) (alternatively, [use the web interface](https://ntfy.sh/app)).
1. Get your personal notification id via your profile. Protect this link — otherwise someone else can intercept and view your notifications as well.
1. Paste the topic name into the ntfy app or web app.
## Using a service other than ntfy.sh
You are able to specify a different server if you use a third-party (or are self-hosting) ntfy.
You can change the setting away from the default server in the ACP settings for this plugin.
## v2.x support
Basic functionality of this plugin is supported in NodeBB v2.x.
More advanced functionality is hidden away and only available for v3.x and up.
That would include (but is not limited to):
* Notify/Email on tagged topic