Skip to content

Commit 75ee015

Browse files
committed
DOCS+PLG: ICMP defaults, community docs disclaimer
Signed-off-by: jokob-sk <jokob.sk@gmail.com>
1 parent 689cd09 commit 75ee015

7 files changed

Lines changed: 33 additions & 12 deletions

File tree

docs/AUTHELIA.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## Authelia support
22

3-
> [!WARNING]
4-
>
5-
> This is community contributed content and work in progress. Contributions are welcome.
3+
> [!NOTE]
4+
> This is community-contributed. Due to environment, setup, or networking differences, results may vary. Please open a PR to improve it instead of creating an issue, as the maintainer is not actively maintaining it.
5+
66

77
```yaml
88
theme: dark
@@ -274,4 +274,4 @@ notifier:
274274
subject: "[Authelia] {title}"
275275
startup_check_address: postmaster@MYOTHERDOMAIN.LTD
276276

277-
```
277+
```

docs/COMMUNITY_GUIDES.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
11
# Community Guides
22

3-
Use the official installation guides at first and use community content as supplementary material. Open an issue or PR if you'd like to add your link to the list 🙏 (Ordered by last update time)
3+
> [!NOTE]
4+
> This is community-contributed. Due to environment, setup, or networking differences, results may vary. Please open a PR to improve it instead of creating an issue, as the maintainer is not actively maintaining it.
5+
6+
7+
Use the official installation guides at first and use community content as supplementary material. (Ordered by last update time)
48

59
-[Discover & Monitor Your Network with This Self-Hosted Open Source Tool - Lawrence Systems](https://www.youtube.com/watch?v=R3b5cxLZMpo) (June 2025)
610
-[Home Lab Network Monitoring - Scotti-BYTE Enterprise Consulting Services](https://www.youtube.com/watch?v=0DryhzrQSJA) (July 2024)
711
- 📄 [How to Install NetAlertX on Your Synology NAS - Marius hosting](https://mariushosting.com/how-to-install-pi-alert-on-your-synology-nas/) (Updated frequently)
812
- 📄 [Using the PiAlert Network Security Scanner on a Raspberry Pi - PiMyLifeUp](https://pimylifeup.com/raspberry-pi-pialert/)
9-
-[How to Setup Pi.Alert on Your Synology NAS - Digital Aloha](https://www.youtube.com/watch?v=M4YhpuRFaUg)
13+
-[How to Setup Pi.Alert on Your Synology NAS - Digital Aloha](https://www.youtube.com/watch?v=M4YhpuRFaUg)
1014
- 📄 [防蹭网神器,网络安全助手 | 极空间部署网络扫描和通知系统『NetAlertX』](https://blog.csdn.net/qq_63499861/article/details/141105273)
1115
- 📄 [시놀/헤놀에서 네트워크 스캐너 Pi.Alert Docker로 설치 및 사용하기](https://blog.dalso.org/article/%EC%8B%9C%EB%86%80-%ED%97%A4%EB%86%80%EC%97%90%EC%84%9C-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC-%EC%8A%A4%EC%BA%90%EB%84%88-pi-alert-docker%EB%A1%9C-%EC%84%A4%EC%B9%98-%EB%B0%8F-%EC%82%AC%EC%9A%A9) (July 2023)
1216
- 📄 [网络入侵探测器Pi.Alert (Chinese)](https://codeantenna.com/a/VgUvIAjZ7J) (May 2023)
1317
-[Pi.Alert auf Synology & Docker by - Jürgen Barth](https://www.youtube.com/watch?v=-ouvA2UNu-A) (March 2023)
1418
-[Top Docker Container for Home Server Security - VirtualizationHowto](https://www.youtube.com/watch?v=tY-w-enLF6Q) (March 2023)
1519
-[Pi.Alert or WatchYourLAN can alert you to unknown devices appearing on your WiFi or LAN network - Danie van der Merwe](https://www.youtube.com/watch?v=v6an9QG2xF0) (November 2022)
20+
21+

docs/DOCKER_INSTALLATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ See alternative [docked-compose examples](https://github.com/jokob-sk/NetAlertX/
4848

4949
| Variable | Description | Example/Default Value |
5050
| :------------- |:------------------------| -----:|
51-
| `PUID` |Runtime UID override | `20211` |
51+
| `PUID` |Runtime UID override, Set to `0` to run as root. | `20211` |
5252
| `PGID` |Runtime GID override | `20211` |
5353
| `PORT` |Port of the web interface | `20211` |
5454
| `LISTEN_ADDR` |Set the specific IP Address for the listener address for the nginx webserver (web interface). This could be useful when using multiple subnets to hide the web interface from all untrusted networks. | `0.0.0.0` |

docs/DOCKER_SWARM.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Docker Swarm Deployment Guide (IPvlan)
22

3+
> [!NOTE]
4+
> This is community-contributed. Due to environment, setup, or networking differences, results may vary. Please open a PR to improve it instead of creating an issue, as the maintainer is not actively maintaining it.
5+
6+
37
This guide describes how to deploy **NetAlertX** in a **Docker Swarm** environment using an `ipvlan` network. This enables the container to receive a LAN IP address directly, which is ideal for network monitoring.
48

59
---
@@ -68,4 +72,3 @@ networks:
6872
* Make sure the assigned IP (`192.168.1.240` above) is not in use or managed by DHCP.
6973
* You may also use a node label constraint instead of `node.role == manager` for more control.
7074

71-

docs/REVERSE_PROXY.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Reverse Proxy Configuration
22

3+
> [!NOTE]
4+
> This is community-contributed. Due to environment, setup, or networking differences, results may vary. Please open a PR to improve it instead of creating an issue, as the maintainer is not actively maintaining it.
5+
6+
37
> [!TIP]
48
> You will need to specify the `BACKEND_API_URL` setting if you are running reverse proxies. This is the URL that points to the backend server url (including your `GRAPHQL_PORT`)
59
>
@@ -508,3 +512,5 @@ Mapping the updated file (on the local filesystem at `/appl/docker/netalertx/def
508512
- /appl/docker/netalertx/default:/etc/nginx/sites-available/default
509513
...
510514
```
515+
516+

docs/WEBHOOK_SECRET.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# Webhook Secrets
22

33
> [!NOTE]
4-
> You need to enable the `WEBHOOK` plugin first in order to follow this guide. See the [Plugins guide](./PLUGINS.md) for details.
4+
> This is community-contributed. Due to environment, setup, or networking differences, results may vary. Please open a PR to improve it instead of creating an issue, as the maintainer is not actively maintaining it.
5+
6+
7+
> [!NOTE]
8+
> You need to enable the `WEBHOOK` plugin first in order to follow this guide. See the [Plugins guide](./PLUGINS.md) for details.
59
610
## How does the signing work?
711

@@ -39,3 +43,5 @@ If your implementation is correct, the signature you generated should match the
3943
If you want to learn more about webhook security, take a look at [GitHub's webhook documentation](https://docs.github.com/en/webhooks/about-webhooks).
4044

4145
You can find examples for validating a webhook delivery [here](https://docs.github.com/en/webhooks/using-webhooks/validating-webhook-deliveries#examples).
46+
47+

front/plugins/icmp_scan/config.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,10 @@
8484
{ "elementType": "select", "elementOptions": [], "transformers": [] }
8585
]
8686
},
87-
"default_value": "ping",
87+
"default_value": "fping",
8888
"options": [
89-
"ping",
90-
"fping"
89+
"fping",
90+
"ping"
9191
],
9292
"localized": ["name", "description"],
9393
"name": [

0 commit comments

Comments
 (0)