![Docker Size]([] ![Docker Pulls]([] ![GitHub Release]([] ![]([] ![Home Assistant]([]

NetAlertX - Network scanner & notification framework

Head to [***] for more gifs and screenshots 📷.

[!NOTE] There is also an experimental 🧪 bare-metal install method available.

📕 Basic Usage

[!WARNING] You will have to run the container on the host network and specify SCAN_SUBNETS unless you use other plugin scanners. The initial scan can take a few minutes, so please wait 5-10 minutes for the initial discovery to finish.

bash
docker run -d --rm --network=host \
  -v /local_data_dir:/data \
  -v /etc/localtime:/etc/localtime \
  --tmpfs /tmp:uid=20211,gid=20211,mode=1700 \
  -e PORT=20211 \
  -e APP_CONF_OVERRIDE={"GRAPHQL_PORT":"20214"} \
  ghcr.io/jokob-sk/netalertx:latest

See alternative docked-compose examples.

Default ports

Docker environment variables

You can override the default GraphQL port setting GRAPHQL_PORT (set to 20212) by using the APP_CONF_OVERRIDE env variable. LOADED_PLUGINS and settings in APP_CONF_OVERRIDE can be specified via the UI as well.

Docker paths

[!NOTE] See also Backup strategies.

Use separate db and config directories, do not nest them.

Initial setup

• If unavailable, the app generates a default app.conf and app.db file on the first run.
• The preferred way is to manage the configuration via the Settings section in the UI, if UI is inaccessible you can modify app.conf in the /data/config/ folder directly

Setting up scanners

You have to specify which network(s) should be scanned. This is done by entering subnets that are accessible from the host. If you use the default ARPSCAN plugin, you have to specify at least one valid subnet and interface in the SCAN_SUBNETS setting. See the documentation on How to set up multiple SUBNETS, VLANs and what are limitations for troubleshooting and more advanced scenarios.

If you are running PiHole you can synchronize devices directly. Check the PiHole configuration guide for details.

[!NOTE] You can bulk-import devices via the CSV import method.

Community guides

You can read or watch several community configuration guides in Chinese, Korean, German, or French.

Please note these might be outdated. Rely on official documentation first.

Common issues

• Before creating a new issue, please check if a similar issue was already resolved.
• Check also common issues and debugging tips.

💙 Support me

• ***: ***
• ***: ***

📧 Email me at *** if you want to get in touch or if I should add other ***hip platforms.