mirror of
https://github.com/Termix-SSH/Termix.git
synced 2026-10-28 06:05:24 +00:00
chore: simplify plugin readmes, changelogs and manifest descriptions
This commit is contained in:
1 parent
7423e33184
commit
8043d6dbdd
96 files changed
+1147
-722
No files matched your search
@@ -2,4 +2,6 @@
|
||||
|
||||
## 1.0.0
|
||||
|
||||
Bundled with Termix 2.9.0.
|
||||
First release, bundled with Termix 2.9.0.
|
||||
|
||||
Adds one inbox for every alert in Termix. Alerts can also be sent to webhooks, ntfy, Discord and email, with delivery rules to pick what goes where.
|
||||
+32
-14
@@ -2,22 +2,40 @@
|
||||
|
||||
One inbox for every alert, with delivery to webhooks, ntfy, Discord and email.
|
||||
|
||||
Bundled with Termix and enabled by default. Any plugin sends through
|
||||
`ctx.notify.send`; this plugin is the hub that stores and delivers them.
|
||||
## Features
|
||||
|
||||
## Layout
|
||||
- One inbox for alerts from every part of Termix.
|
||||
- Popups for new alerts, filtered by severity.
|
||||
- Channels that send alerts to webhooks, ntfy, Discord and email.
|
||||
- Delivery rules that pick which alerts go to which channel.
|
||||
- Optional news from the Termix team, like security notices and new releases.
|
||||
|
||||
manifest.json id, capabilities and what this plugin contributes
|
||||
src/backend/ activate(ctx) / deactivate(), plus the routes
|
||||
src/frontend/ the UI it registers
|
||||
locales/en.json its strings (English only; the rest are translated)
|
||||
tests/backend/ vitest, node
|
||||
tests/frontend/ vitest, jsdom
|
||||
## Settings
|
||||
|
||||
## Commands
|
||||
### Admin
|
||||
|
||||
npm run build bundle into dist/
|
||||
npm run test run this plugin's tests
|
||||
npm run typecheck
|
||||
- Termix announcements: show news from the Termix team in everyone's inbox.
|
||||
- Keep alerts for (days): older alerts are removed from every inbox.
|
||||
- SMTP server, port, TLS, username, password and from address: needed for email channels. Leave the server empty to turn email off.
|
||||
|
||||
See packages/plugin-sdk/ARCHITECTURE.md for the contract this follows.
|
||||
### User
|
||||
|
||||
- Alert popups: all alerts, warnings and critical, critical only, or none.
|
||||
|
||||
## Permissions
|
||||
|
||||
- `alerts.use`: Get alerts in the inbox and send them to your own channels. Admins and users have it by default.
|
||||
|
||||
## For plugin authors
|
||||
|
||||
Send an alert from any plugin with `ctx.notify.send()`. This plugin stores it and delivers it. Do not build a separate notification system into a plugin.
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
npm run build # build into dist/
|
||||
npm run test # run this plugin's tests
|
||||
npm run typecheck # type-check this plugin
|
||||
```
|
||||
|
||||
See `packages/plugin-sdk/ARCHITECTURE.md` for the plugin contract.
|
||||
Reference in new issue
Block a user