Files
homepage/docs/widgets/services/netalertx.md
shamoon 4d4fab391c
Some checks failed
Docker CI / Linting Checks (push) Has been cancelled
Docs / Linting Checks (push) Has been cancelled
Docker CI / Docker Build & Push (push) Has been cancelled
Docs / Test Build Docs (push) Has been cancelled
Docs / Build & Deploy Docs (push) Has been cancelled
Documentation: clarify URL port for netalertx widget version 2
2026-02-02 00:57:16 -08:00

26 lines
737 B
Markdown

---
title: NetAlertX
description: NetAlertX (formerly PiAlert) Widget Configuration
---
Learn more about [NetAlertX](https://github.com/jokob-sk/NetAlertX).
_Note that the project was renamed from PiAlert to NetAlertX._
Allowed fields: `["total", "connected", "new_devices", "down_alerts"]`.
Provide the `API_TOKEN` (f.k.a. `SYNC_api_token`) as the `key` in your config.
| NetAlertX Version | Homepage Widget Version |
| ----------------- | ----------------------- |
| < v26.1.17 | 1 (default) |
| > v26.1.17 | 2 |
```yaml
widget:
type: netalertx
url: http://ip:port # use backend port for widget version 2+
key: yournetalertxapitoken
version: 2 # optional, default is 1
```