jokobsk/netalertx

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

27 收藏0 次下载activejokobsk

![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.

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

Default	Description	How to override
`20211`	Port of the web interface	`-e PORT=20222`
`20212`	Port of the backend API server	`-e APP_CONF_OVERRIDE={"GRAPHQL_PORT":"20214"}` or via the `GRAPHQL_PORT` Setting

Docker environment variables

Variable	Description	Example Value
`PORT`	Port of the web interface	`20211`
`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`
`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
✅	`:/data`	Folder which will contain the `/db/app.db`, `/config/app.conf` & `/config/devices.csv` (read about devices.csv) files
✅	`/etc/localtime:/etc/localtime:ro`	Ensuring the timezone is teh same as on teh server.
	`:/tmp/log`	Logs folder useful for debugging if you have issues setting up the container
	`:/tmp/api`	The API endpoint containing static (but regularly updated) json and other files. Path configurable via `NETALERTX_API` environment variable.
	`:/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 /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

![GitHub]([***]	![Buy Me A Coffee]([***]	![Patreon]([***]

***: ***
***: ***

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

查看更多 netalertx 相关镜像 →

jokobsk/netalertx-dev

by jokobsk

⛔ 开发专用镜像，生产环境请使用：https://hub.docker.com/r/jokobsk/netalertx

请迁移至NetAlertX镜像（详情参见概述）

381M+ pulls

上次更新：10 个月前

用户好评

来自真实用户的反馈，见证轩辕镜像的优质服务

oldzhang

运维工程师

Linux服务器

"Docker加速体验非常流畅，大镜像也能快速完成下载。"

常见问题

Q1:轩辕镜像免费版与专业版有什么区别？

免费版仅支持 Docker Hub 加速，不承诺可用性和速度；专业版支持更多镜像源，保证可用性和稳定速度，提供优先客服响应。

Q2:轩辕镜像免费版与专业版有分别支持哪些镜像？

免费版仅支持 docker.io；专业版支持 docker.io、gcr.io、ghcr.io、registry.k8s.io、nvcr.io、quay.io、mcr.microsoft.com、docker.elastic.co 等。

Q3:流量耗尽错误提示

当返回 402 Payment Required 错误时，表示流量已耗尽，需要充值流量包以恢复服务。

Q4:410 错误问题

通常由 Docker 版本过低导致，需要升级到 20.x 或更高版本以支持 V2 协议。

Q5:manifest unknown 错误

先检查 Docker 版本，版本过低则升级；版本正常则验证镜像信息是否正确。

Q6:镜像拉取成功后，如何去掉轩辕镜像域名前缀？

使用 docker tag 命令为镜像打上新标签，去掉域名前缀，使镜像名称更简洁。

查看全部问题→

轩辕镜像下载加速使用手册

探索更多轩辕镜像的使用方法，找到最适合您系统的配置方式

登录仓库拉取

通过 Docker 登录认证访问私有仓库

Linux

在 Linux 系统配置镜像加速服务

Windows/Mac

在 Docker Desktop 配置镜像加速

Docker Compose

Docker Compose 项目配置加速

K8s Containerd

Kubernetes 集群配置 Containerd

宝塔面板

在宝塔面板一键配置镜像加速

群晖

Synology 群晖 NAS 配置加速

飞牛

飞牛 fnOS 系统配置镜像加速

极空间

极空间 NAS 系统配置加速服务

爱快路由

爱快 iKuai 路由系统配置加速

绿联

绿联 NAS 系统配置镜像加速

威联通

QNAP 威联通 NAS 配置加速

Podman

Podman 容器引擎配置加速

Singularity/Apptainer

HPC 科学计算容器配置加速

其他仓库配置

ghcr、Quay、nvcr 等镜像仓库

专属域名拉取

无需登录使用专属域名加速

需要其他帮助？请查看我们的常见问题或官方QQ群: 13763429

netalertx Docker 镜像下载 - 轩辕镜像

netalertx 镜像详细信息和使用指南

netalertx 镜像标签列表和版本信息

netalertx 镜像拉取命令和加速下载

netalertx 镜像使用说明和配置指南

Docker 镜像加速服务 - 轩辕镜像平台

国内开发者首选的 Docker 镜像加速平台

极速拉取 Docker 镜像服务

相关 Docker 镜像推荐

热门 Docker 镜像下载

netalertx 镜像详细信息

netalertx 镜像标签列表

netalertx 镜像使用说明

netalertx 镜像拉取命令

Docker 镜像加速服务

轩辕镜像平台优势

镜像下载指南