From 4f548803cbcace48d7493bd98a80bfc3c2e29312 Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Sun, 12 Feb 2023 17:50:49 +1100 Subject: [PATCH] Plugins 0.1 - Readme update 0.1 --- README.md | 6 +++--- docs/API.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ebfeb1e3..658747ad 100755 --- a/README.md +++ b/README.md @@ -34,9 +34,9 @@ The system continuously scans the network for, **New devices**, **New connection ## 🧩 Integrations - [Apprise](https://hub.docker.com/r/caronc/apprise), [Pushsafer](https://www.pushsafer.com/), [NTFY](https://ntfy.sh/) - [Webhooks](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/WEBHOOK_N8N.md) ([sample JSON](docs/webhook_json_sample.json)) - - Home Assistant via [MQTT](https://www.home-assistant.io/integrations/mqtt/) - - discovery ~10s per device, deleting not supported, use [MQTT Explorer](https://mqtt-explorer.com/) for now - - A simple [API endpoint](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/API.md) + - Home Assistant via [MQTT](https://www.home-assistant.io/integrations/mqtt/) - discovery ~10s per device, use [MQTT Explorer](https://mqtt-explorer.com/) to delete devices + - [API endpoint](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/API.md) + - [Plugin system](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins) for custom script monitoring ## 🔐 Security diff --git a/docs/API.md b/docs/API.md index 38eac9ac..4aba177e 100755 --- a/docs/API.md +++ b/docs/API.md @@ -30,7 +30,7 @@ You can access the following files: | `table_pholus_scan.json` | The latest state of the [pholus](https://github.com/jokob-sk/Pi.Alert/tree/main/pholus) (A multicast DNS and DNS Service Discovery Security Assessment Tool) scan results. | | `table_events_pending_alert.json` | The list of the unprocessed (pending) notification events. | | `table_settings.json` | The content of the settings table. | - | `table_plugins_entries.json` | The content of the plugins_entries table. | + | `table_plugins_entries.json` | The content of the plugins_entries table. Find more info on the [Plugin system here](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins)| | `table_plugins_unprocessed_entries.json` | The content of the plugins_unprocessed_entries table. | | `table_custom_endpoint.json` | A custom endpoint generated by the SQL query specified by the `API_CUSTOM_SQL` setting. |