From b31dff281515c192db8d88581b5172feb84f6de9 Mon Sep 17 00:00:00 2001 From: jokob-sk Date: Tue, 24 Jun 2025 19:57:24 +1000 Subject: [PATCH] docs --- docs/HW_INSTALL.md | 3 ++- docs/WEBHOOK_N8N.md | 3 +++ docs/WEBHOOK_SECRET.md | 3 +++ 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/HW_INSTALL.md b/docs/HW_INSTALL.md index 758a88ec..68681b27 100755 --- a/docs/HW_INSTALL.md +++ b/docs/HW_INSTALL.md @@ -5,7 +5,8 @@ To download and install NetAlertX on the hardware/server directly use the `curl` > [!NOTE] > This is an Experimental feature ๐Ÿงช and it relies on community support. > -> ๐Ÿ™ Looking for maintainers for this installation method ๐Ÿ™‚ +> ๐Ÿ™ Looking for maintainers for this installation method ๐Ÿ™‚ Curent community volunteers: +> - [slammingprogramming](https://github.com/slammingprogramming) > > There is no guarantee that the install script or any other script will gracefully handle other installed software. > Data loss is a possibility, **it is recommended to install NetAlertX using the supplied Docker image**. diff --git a/docs/WEBHOOK_N8N.md b/docs/WEBHOOK_N8N.md index 5d04be0e..a919c6a3 100755 --- a/docs/WEBHOOK_N8N.md +++ b/docs/WEBHOOK_N8N.md @@ -1,5 +1,8 @@ ### Create a simple n8n workflow +> [!NOTE] +> You need to enable the `WEBHOOK` plugin first in order to follow this guide. See the [Plugins guide](./PLUGINS.md) for details. + N8N can be used for more advanced conditional notification use cases. For example, you want only to get notified if two out of a specified list of devices is down. Or you can use other plugins to process the notifiations further. The below is a simple example of sending an email on a webhook. ![n8n workflow](./img/WEBHOOK_N8N/n8n_workflow.png) diff --git a/docs/WEBHOOK_SECRET.md b/docs/WEBHOOK_SECRET.md index 17d35d6e..b503b7a3 100755 --- a/docs/WEBHOOK_SECRET.md +++ b/docs/WEBHOOK_SECRET.md @@ -1,5 +1,8 @@ # Webhook Secrets +> [!NOTE] +> You need to enable the `WEBHOOK` plugin first in order to follow this guide. See the [Plugins guide](./PLUGINS.md) for details. + ## How does the signing work? NetAlertX will use the configured secret to create a hash signature of the request body. This SHA256-HMAC signature will appear in the `X-Webhook-Signature` header of each request to the webhook target URL. You can use the value of this header to validate the request was sent by NetAlertX.