vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 09:36:05 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs
Some checks are pending
Code checks / check-url-paths (push) Waiting to run
Details
docker / docker_dev (push) Waiting to run
Details
Deploy MkDocs / deploy (push) Waiting to run
Details

Browse Source
This commit is contained in:
jokob-sk
2025-06-24 19:57:24 +10:00
parent 3483d833a0
commit b31dff2815
3 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/HW_INSTALL.md
View File

@@ -5,7 +5,8 @@ To download and install NetAlertX on the hardware/server directly use the `curl`
> [!NOTE] > [!NOTE]
> This is an Experimental feature 🧪 and it relies on community support. > 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. > 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**. > Data loss is a possibility, **it is recommended to install NetAlertX using the supplied Docker image**.

3
docs/WEBHOOK_N8N.md
View File

@@ -1,5 +1,8 @@
### Create a simple n8n workflow ### 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 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) ![n8n workflow](./img/WEBHOOK_N8N/n8n_workflow.png)

3
docs/WEBHOOK_SECRET.md
View File

@@ -1,5 +1,8 @@
# Webhook Secrets # 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? ## 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. 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.