netalertx/NetAlertX
GitHub: netalertx/NetAlertX
一款轻量级网络资产发现与持续监控工具,专注于实时设备清单管理和变更告警,填补简单扫描器与复杂 SIEM 之间的空白。
Stars: 5898 | Forks: 375
[](https://hub.docker.com/r/jokobsk/netalertx)
[](https://hub.docker.com/r/jokobsk/netalertx)
[](https://github.com/netalertx/NetAlertX/releases)
[](https://discord.gg/NczTUTWyRr)
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
# NetAlertX - 网络可见性与资产智能框架

集中式网络可见性与持续资产发现。
监控设备,检测变更,并时刻掌握分布式网络动态。
NetAlertX 提供了一个集中的网络基础设施“事实来源”。维护所有连接设备的实时清单,识别影子 IT 和未授权硬件以保持合规性,并跨分布式站点自动化合规工作流。
NetAlertX 旨在弥合简单网络扫描与复杂 SIEM 工具之间的差距,在不增加开销的情况下提供可操作的洞察。
## 目录
- [快速开始](#quick-start)
- [功能特性](#features)
- [文档](#documentation)
- [安全与隐私](#security--privacy)
- [常见问题](#faq)
- [故障排除提示](#troubleshooting-tips)
- [其他内容](#everything-else)
## 快速开始
使用 Docker 几秒钟即可启动 NetAlertX:
```
docker run -d \
--network=host \
--restart unless-stopped \
-v /local_data_dir:/data \
-v /etc/localtime:/etc/localtime:ro \
--tmpfs /tmp:uid=20211,gid=20211,mode=1700 \
-e PORT=20211 \
-e APP_CONF_OVERRIDE='{"GRAPHQL_PORT":"20214"}' \
ghcr.io/netalertx/netalertx:latest
```
注意:您的 `/local_data_dir` 应包含 `config` 和 `db` 文件夹。
要直接从源代码仓库部署容器化实例,请执行以下 BASH 命令序列:
```
git clone https://github.com/netalertx/NetAlertX.git
cd NetAlertX
docker compose up --force-recreate --build
# 自定义:编辑 docker-compose.yaml 并再次运行该命令
```
需要配置帮助?请查看 [使用指南](https://docs.netalertx.com/README) 或 [完整文档](https://docs.netalertx.com/)。
Home Assistant 用户:[点击此处添加 NetAlertX](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
如需其他安装方式,请查看 [安装文档](#documentation)
### || [Docker 指南](https://docs.netalertx.com/DOCKER_INSTALLATION) || [发布版本](https://github.com/netalertx/NetAlertX/releases) || [文档](https://docs.netalertx.com/) || [插件](https://docs.netalertx.com/PLUGINS) || [网站](https://netalertx.com)
## 功能特性
### 发现与资产智能
持续监控未授权资产发现、连接状态变更以及 IP 地址管理 (IPAM) 偏移。发现与扫描方法包括:**arp-scan**、**Pi-hole - DB 导入**、**Pi-hole - DHCP 租约导入**、**通用 DHCP 租约导入**、**UNIFI 控制器导入**、**SNMP 启用的路由器导入**。请查看 [插件](https://docs.netalertx.com/PLUGINS#readme) 文档以获取可用插件的完整列表。
### 通知网关
通过 [Apprise](https://hub.docker.com/r/caronc/apprise) 向包括 Telegram 在内的 80 多种服务发送通知,或使用原生的 [Pushsafer](https://www.pushsafer.com/)、[Pushover](https://www.pushover.net/) 或 [NTFY](https://ntfy.sh/) 发布器。
### 集成与插件
将您的数据和设备变更导入 [Home Assistant](https://docs.netalertx.com/HOME_ASSISTANT),读取 [API 端点](https://docs.netalertx.com/API),或使用 [Webhooks](https://docs.netalertx.com/WEBHOOK_N8N) 设置自定义自动化流程。您也可以利用 [插件系统](https://docs.netalertx.com/PLUGINS#readme) 在短短 [15 分钟](https://www.youtube.com/watch?v=cdbxlwiWhv8) 内构建您自己的扫描器。
### 工作流
[工作流模块](https://docs.netalertx.com/WORKFLOWS) 通过强制执行设备分类和清理策略来自动化 IT 治理。无论您是需要将新发现的设备分配给特定的网络节点,自动对来自特定供应商的设备进行分组,在检测到设备上线时将其取消归档,还是自动删除设备,该模块都提供了灵活的自定义自动化功能以满足您的需求。
## 文档
在此浏览所有 [文档](https://docs.netalertx.com/) 或导航至下方的特定安装选项。
支持的浏览器:Chrome, Firefox
- [[安装] Docker](https://docs.netalertx.com/DOCKER_INSTALLATION)
- [[安装] Home Assistant](https://github.com/alexbelgium/hassio-addons/tree/master/netalertx)
- [[安装] 裸机](https://docs.netalertx.com/HW_INSTALL)
- [[安装] Unraid 应用](https://unraid.net/community/apps)
- [[设置] 使用与配置](https://docs.netalertx.com/README)
- [[开发] API 文档](https://docs.netalertx.com/API)
- [[开发] 自定义插件](https://docs.netalertx.com/PLUGINS_DEV)
## 安全与隐私
NetAlertX 扫描您的本地网络,并可以存储有关已连接设备的元数据。默认情况下,所有数据均**本地**存储。除非您明确配置通知或集成,否则不会向外部服务发送任何信息。
合规与加固:
- 在带有身份验证的反向代理后运行
- 使用防火墙限制对 Web UI 的访问
- 定期更新至最新版本以获取安全补丁
- 通过反向代理进行基于角色的访问控制 (RBAC):与您现有的 SSO/身份提供商集成,以确保仪表板的安全访问。
有关更多详细信息,请参阅 [安全最佳实践](https://github.com/netalertx/NetAlertX/security)。
## 常见问题
**问:如何监控 VLAN 或远程子网?**
答:确保容器具有正确的网络访问权限(例如,在 Linux 上使用 `--network host`)。同时检查 UI 中的扫描方法是否配置正确。
**问:高可用性部署的建议是什么?**
答:我们建议通过 Docker 部署,并挂载持久化卷以确保数据库完整性,同时在反向代理后运行以确保安全访问。
**问:这会将任何数据发送到互联网吗?**
答:不会。除非您设置基于云的通知,否则所有扫描和数据都保留在本地。
**问:我可以在没有 Docker 的情况下使用吗?**
答:可以,您可以按照 [裸机安装指南](https://docs.netalertx.com/HW_INSTALL) 直接在您自己的硬件上安装应用程序。
**问:数据存储在哪里?**
答:存储在 `/data/config` 和 `/data/db` 文件夹中。请定期备份这些文件夹。
## 故障排除提示
- 某些扫描器(如 ARP)可能无法检测到不同子网上的设备。请参阅 [远程网络指南](https://docs.netalertx.com/REMOTE_NETWORKS) 了解解决方法。
- 仅 Wi-Fi 网络可能需要备用扫描器才能准确检测。
- 对于大型网络,可能需要通知限制以防止垃圾信息。
- 在某些系统上,低级扫描可能需要提升权限(如 `CAP_NET_RAW`)。
请查看 [GitHub Issues](https://github.com/netalertx/NetAlertX/issues) 以获取最新的错误报告和解决方案,并查阅 [官方文档](https://docs.netalertx.com/)。
## 其他内容
### 📧 获取最新动态通知
获取有关新版本发布、可用新功能以及重大变更的通知。

### 🔀 其他替代应用
- [Fing](https://www.fing.com/) - 用于互联网安全的网络扫描应用(商业软件,手机应用,专有硬件)
- [NetBox](https://netboxlabs.com/) - 网络事实来源 (NSoT) 和 IPAM 的黄金标准。
- [Zabbix](https://www.zabbix.com/) 或 [Nagios](https://www.nagios.org/) - 专注于基础设施监控。
- [NetAlertX](https://netalertx.com) - 精简、专注于发现的实时资产智能和零噪音警报选择。
### 🌍 翻译
自豪地使用 [Weblate](https://hosted.weblate.org/projects/pialert/)。请前往 [Weblate 在线门户](https://hosted.weblate.org/projects/pialert/core/) 提供语言建议和帮助。
### 许可证
_所有产品名称、徽标和品牌均为其各自所有者的财产。本网站使用的所有公司、产品和服务名称仅用于识别目的。使用这些名称、徽标和品牌并不暗示认可。_
📷 点击查看更多截图
|  |  |  | |----------------------|----------------------|----------------------| |  |  |  | |  |  |  | 请前往 [https://netalertx.com/](https://netalertx.com/) 查看更多动图和截图 📷。标签:API哈希动态解析, Docker, GPT, Home Assistant, IT运维, Socks5代理, 云存储安全, 人工智能安全, 入侵防御, 占用监测, 合规性, 安全防御评估, 影子IT, 插件系统, 数据可视化, 漏洞管理, 物联网, 系统分析, 网络分析, 网络可见性, 网络安全, 网络安全审计, 网络扫描, 自动化运维, 设备监控, 请求拦截, 调试插件, 资产管理, 进程隐藏, 逆向工具, 隐私保护