Skip to content

一个开源的网络、终端探测及告警框架。

License

Notifications You must be signed in to change notification settings

purpose168/NetAlertX

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5,644 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Docker Size Docker Pulls GitHub Release Discord Home Assistant

NetAlertX - 网络终端扫描器和警报框架

了解您的 WIFI/LAN 网络上正在发生什么,并启用重要设备的终端检测。安排设备扫描、端口更改,如果发现未知设备或更改,则获取警报。编写您自己的插件,具有自动生成的 UI 和内置通知系统。构建并轻松维护您的网络事实来源(NSoT)和设备清单。

📋 目录

🚀 快速开始

Warning

⚠️ 重要提示: docker-compose 最近已更改。请仔细阅读迁移指南以获取详细说明。

使用 Docker 在几秒钟内启动 NetAlertX:

# 使用 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"}' \ # 覆盖 GraphQL 端口配置
  ghcr.io/jokob-sk/netalertx:latest   # 使用最新版本的 NetAlertX 镜像

注意:您的 /local_data_dir 应包含 configdb 文件夹。

要从源仓库直接部署容器化实例,请执行以下 BASH 序列:

# 克隆 NetAlertX 源代码仓库
git clone https://github.com/jokob-sk/NetAlertX.git
# 进入项目目录
cd NetAlertX
# 使用 Docker Compose 启动服务(强制重新创建并构建)
docker compose up --force-recreate --build
# 如需自定义:编辑 docker-compose.yaml 并再次运行上述命令

需要帮助配置?查看使用指南完整文档

对于 Home Assistant 用户:点击此处添加 NetAlertX

对于其他安装方法,请查看安装文档

📑 Docker 指南 🚀 发布版本 📚 文档 🔌 插件 🤖 询问 AI

showcase

📷 点击查看更多截图
主界面 设备详情 1 网络界面
终端检测 维护界面 设置界面
同步中心 报告1 设备 Nmap

访问 https://netalertx.com/ 查看更多 GIF 和截图 📷。

📦 功能特性

扫描器

该应用程序扫描您的网络以查找新设备新连接(重新连接)、断开连接"始终连接"的设备离线、设备IP 地址更改互联网 IP 地址更改。发现和扫描方法包括:arp-scanPi-hole - 数据库导入Pi-hole - DHCP 租约导入通用 DHCP 租约导入UNIFI 控制器导入支持 SNMP 的路由器导入。查看插件文档以获取可用插件的完整列表。

通知网关

向 80 多种服务发送通知,包括通过 Apprise 发送的 Telegram,或使用原生的 PushsaferPushoverNTFY 发布器。

集成和插件

将您的数据和设备更改输入到 Home Assistant 中,读取 API 端点,或使用 Webhooks 设置自定义自动化流程。您还可以使用插件系统15 分钟内构建自己的扫描器。

工作流

工作流模块允许自动化重复性任务,使网络管理更加高效。无论您是需要将新发现的设备分配到特定的网络节点、自动按供应商分组设备、如果检测到设备在线则取消归档,还是自动删除设备,该模块都提供了灵活性,可以根据您的需求定制自动化。

📚 文档

支持的浏览器:Chrome、Firefox

...或在此处探索所有文档。

🔐 安全与隐私

NetAlertX 扫描您的本地网络,并可以存储有关连接设备的元数据。默认情况下,所有数据都本地存储。除非您明确配置通知或集成,否则不会向外部服务发送任何信息。

为了进一步保护您的安装:

  • 在带有身份验证的反向代理后面运行它
  • 使用防火墙限制对 Web UI 的访问
  • 定期更新到最新版本以获取安全补丁

查看安全最佳实践以获取更多详细信息。

❓ 常见问题

问:为什么我看不到任何设备? 答:确保容器具有适当的网络访问权限(例如,在 Linux 上使用 --network host)。还要检查您的扫描方法在 UI 中是否正确配置。

问:这是否适用于仅 Wi-Fi 的设备(如 Raspberry Pi)? 答:是的,但某些扫描器(例如 ARP)在以太网上效果最佳。对于 Wi-Fi,请尝试 SNMP、DHCP 或 Pi-hole 导入。

问:这是否会向互联网发送任何数据? 答:不会。所有扫描和数据都保持本地,除非您设置基于云的通知。

问:我可以在不使用 Docker 的情况下使用它吗? 答:可以!您可以裸机安装它。查看裸机安装指南

问:数据存储在哪里? 答:在 /data/config/data/db 文件夹中。定期备份这些文件夹。

🐞 已知问题

  • 某些扫描器(例如 ARP)可能无法检测不同子网上的设备。请参阅远程网络指南以获取解决方案。
  • 仅 Wi-Fi 的网络可能需要备用扫描器才能准确检测。
  • 对于大型网络,可能需要通知限流以防止垃圾邮件。
  • 在某些系统上,低级扫描可能需要提升权限(如 CAP_NET_RAW)。

查看 GitHub Issues 以获取最新的错误报告和解决方案,并咨询官方文档

📃 其他信息

📧 获取新功能通知

获取有关新版本、您可以使用的新功能以及重大更改的通知。

关注和星标

🔀 其他替代应用

  • PiAlert by leiweibau(已维护,裸机安装)
  • WatchYourLAN - 带有 Web GUI 的轻量级网络 IP 扫描器(开源)
  • Fing - 用于互联网安全的网络扫描器应用程序(商业、手机应用程序、专有硬件)
  • NetBox - 网络管理软件(商业)

💙 捐赠

感谢所有欣赏此工具并捐赠的人。

点击查看更多捐赠方式
GitHub Buy Me A Coffee Patreon
  • Bitcoin(比特币):1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM
  • Ethereum(以太坊):0x6e2749Cb42F4411bc98501406BdcD82244e3f9C7

📧 如果您想联系我或我应该添加其他赞助平台,请发送电子邮件至 jokob@duck.com

🏗 贡献者

如果没有社区的出色工作,这个项目将一事无成,特别感谢:

pucherot/Pi.Alert(Pi.Alert 的原始创建者),leiweibau:深色模式(以及更多),Macleykun(帮助清理 Dockerfile),vladaurosh 提供 Alpine 重新基础的帮助,Final-Hawk(帮助 NTFY、样式和其他修复),TeroRERO(西班牙语翻译),Data-Monkey,(拆分 python.py 文件以及更多),cvc90(西班牙语翻译和各种 UI 工作)等等。查看所有出色的贡献者

🌍 翻译

自豪地使用 Weblate。在 Weblate 的在线门户中提供帮助并建议语言。

翻译状态

许可证

GPL 3.0 | 在此处阅读更多内容 | 动画 GIF(加载动画)的来源 | 自托管字体的来源

About

一个开源的网络、终端探测及告警框架。

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 36.3%
  • Python 35.6%
  • PHP 12.0%
  • CSS 10.4%
  • Shell 4.6%
  • Dockerfile 0.7%
  • Other 0.4%