本站支持搜索的镜像仓库：Docker Hub、gcr.io、ghcr.io、quay.io、k8s.gcr.io、registry.gcr.io、elastic.co、mcr.microsoft.com

jokobsk/netalertx

🔍NetAlertX is monitoring your WIFI/LAN network and alerting of new devices.

26 收藏0 次下载activejokobsk

🚀轩辕镜像专业版更稳定💎一键安装 Docker 配置镜像源

镜像简介版本下载

🚀轩辕镜像专业版更稳定💎一键安装 Docker 配置镜像源

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

NetAlertX - Network scanner & notification framework

📑 Docker guide	🚀 Releases	📚 Docs	🔌 Plugins	🤖 Ask AI

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.

docker run -d --rm --network=host \
  -v local_path/config:/app/config \
  -v local_path/db:/app/db \
  --mount type=tmpfs,target=/app/api \
  -e PUID=200 -e PGID=300 \
  -e TZ=Europe/Berlin \
  -e PORT=20211 \
  ghcr.io/jokob-sk/netalertx:latest

See alternative docked-compose examples.

Docker environment variables

Variable	Description	Example Value
`PORT`	Port of the web interface	`20211`
`PUID`	Application User UID	`102`
`PGID`	Application User GID	`82`
`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`
`TZ`	Time zone to display stats correctly. Find your time zone here	`Europe/Berlin`
`LOADED_PLUGINS`	Default plugins to load. Plugins cannot be loaded with `APP_CONF_OVERRIDE`, you need to use this variable instead and then specify the plugins settings with `APP_CONF_OVERRIDE`.	`["PIHOLE","ASUSWRT"]`
`APP_CONF_OVERRIDE`	JSON override for settings (except `LOADED_PLUGINS`).	`{"SCAN_SUBNETS":"['192.168.1.0/24 --interface=eth1']","GRAPHQL_PORT":"20212"}`
`ALWAYS_FRESH_INSTALL`	⚠ If `true` will delete the content of the `/db` & `/config` folders. For testing purposes. Can be coupled with watchtower to have an always freshly installed `netalertx`/`netalertx-dev` image.	`true`

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.

Required	Path	Description
✅	`:/app/config`	Folder which will contain the `app.conf` & `devices.csv` (read about devices.csv) files
✅	`:/app/db`	Folder which will contain the `app.db` database file
	`:/app/log`	Logs folder useful for debugging if you have issues setting up the container
	`:/app/api`	A simple API endpoint containing static (but regularly updated) json and other files.
	`:/app/front/plugins/<plugin>/ignore_plugin`	Map a file `ignore_plugin` to ignore a plugin. Plugins can be soft-disabled via settings. More in the Plugin docs.
	`:/etc/resolv.conf`	Use a custom `resolv.conf` file for better name resolution.

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 /app/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.