jokobsk/netalertx

![]([]

NetAlertX - 网络扫描与通知框架

https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/GENERAL/github_social_image.jpg

访问 [***] 查看更多动图和截图 📷。

[!NOTE] 还提供实验性 🧪 https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md 方法。

📕 基本用法

[!WARNING] 除非使用其他 https://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS.md%EF%BC%8C%E5%90%A6%E5%88%99%E5%BF%85%E9%A1%BB%E5%9C%A8 host 网络上运行容器并指定 SCAN_SUBNETS。初始扫描可能需要几分钟，请等待 5-10 分钟完成初始设备发现。

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

查看其他 https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_COMPOSE.md%E3%80%82

默认端口

Docker 环境变量

可通过 APP_CONF_OVERRIDE 环境变量覆盖默认 GraphQL 端口设置 GRAPHQL_PORT（默认为 20212）。LOADED_PLUGINS 和 APP_CONF_OVERRIDE 中的设置也可通过 UI 指定。

Docker 路径

[!NOTE] 另见 https://github.com/jokob-sk/NetAlertX/blob/main/docs/BACKUPS.md%E3%80%82

请使用单独的 db 和 config 目录，不要嵌套它们。

初始设置

• 若配置文件不存在，应用首次运行时会生成默认的 app.conf 和 app.db 文件。
• 首选方式是通过 UI 中的“设置”部分管理配置，若无法访问 UI，可直接修改 /data/config/ 文件夹中的 https://github.com/jokob-sk/NetAlertX/tree/main/back%E3%80%82

设置扫描器

必须指定要扫描的网络。通过输入主机可访问的子网来完成。若使用默认 ARPSCAN 插件，必须在 SCAN_SUBNETS 设置中至少指定一个有效的子网和接口。有关故障排除和更高级场景，请参阅 https://github.com/jokob-sk/NetAlertX/blob/main/docs/SUBNETS.md 文档。

若运行 PiHole，可直接同步设备。详情请查看 https://github.com/jokob-sk/NetAlertX/blob/main/docs/PIHOLE_GUIDE.md%E3%80%82

[!NOTE] 可通过 https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEVICES_BULK_EDITING.md 批量导入设备。

社区指南

您可以阅读或观看多种语言的 https://github.com/jokob-sk/NetAlertX/blob/main/docs/COMMUNITY_GUIDES.md%EF%BC%8C%E5%8C%85%E6%8B%AC%E4%B8%AD%E6%96%87%E3%80%81%E9%9F%A9%E6%96%87%E3%80%81%E5%BE%B7%E6%96%87%E5%92%8C%E6%B3%95%E6%96%87%E3%80%82

请注意这些指南可能已过时。请优先参考官方文档。

常见问题

• 创建新 issue 前，请检查是否存在 https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed%E3%80%82
• 另请查看常见问题和 https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md%E3%80%82

💙 支持我

• ***: 1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM
• ***: 0x6e2749Cb42F4411bc98501406BdcD82244e3f9C7

📧 若想联系我或希望添加其他赞助平台，请发送邮件至 ***。