jokob-sk/NetAlertX - 学习路径

由于 trendforge.devlive.top 访问受限，请切换到 trendforge.devlive.org 域名

项目介绍快速开始学习路径项目截图 2 贡献者 135 增长趋势 Commit 历史代码统计生态关系项目时间线项目竞品依赖分析上榜历史

学习路径指南

难度等级

入门

预计时长

2-4小时

适合人群

家庭网络用户、IT爱好者、小型企业网络管理员、MSP（托管服务提供商）技术人员、需要网络资产可见性的任何人，尤其是对Docker有基本了解的用户。

学习目标：你将能够使用Docker快速部署NetAlertX，并通过其Web界面监控家庭或小型企业网络，发现并识别连接的设备，设置基本通知。

前置知识

基本计算机操作熟悉

能够下载软件、编辑文本文件、使用命令行执行基本命令。

Docker基础了解

理解Docker容器的概念，并知道如何使用`docker`或`docker-compose`命令启动一个服务。这是官方推荐的部署方式。

网络基础知识了解

了解IP地址、子网、局域网等基本概念，以便理解项目的扫描范围。

文本编辑了解

能够使用文本编辑器（如VS Code、记事本）编辑YAML格式的`docker-compose.yml`文件。

学习步骤

第一阶段：环境准备与部署

30-60分钟

安装Docker与Docker Compose

根据你的操作系统（Windows, macOS, Linux）安装Docker Desktop或Docker Engine。确保`docker`和`docker-compose`命令在终端中可用。

对于Windows/macOS，推荐使用官方Docker Desktop。对于Linux，可以按照官方文档安装Docker Engine和Compose插件。

创建数据存储目录

在你的主机上创建一个文件夹，例如`~/netalertx`。在此文件夹内，创建两个子文件夹：`config`和`db`。这用于持久化保存配置和数据库文件。

路径中避免使用中文或特殊字符。

编写docker-compose.yml文件

在`~/netalertx`目录下创建一个名为`docker-compose.yml`的文件，并将README中提供的示例代码粘贴进去。根据你的网络环境，可能需要调整`network`设置（例如，使用`host`模式以扫描本地网络）。

第二阶段：首次启动与基本配置

30-60分钟

启动NetAlertX容器

在`docker-compose.yml`所在的目录下，打开终端，运行命令 `docker-compose up -d`。这将在后台启动NetAlertX服务。

首次启动需要拉取镜像，可能需要几分钟。

访问Web界面并完成初始设置

在浏览器中打开 `http://localhost:80` 或 `http://<你的服务器IP>:80`。首次访问可能会进入一个设置向导。跟随向导完成基本设置，如设置管理员密码、配置网络扫描范围（通常选择自动发现或输入你的本地网络IP段，如192.168.1.0/24）。

验证设备发现

进入主仪表板，等待几分钟。NetAlertX会开始扫描你的网络，发现的设备会逐渐出现在列表中。检查设备是否被正确识别（如手机、电脑、IoT设备）。

第三阶段：探索核心功能

60-120分钟

熟悉仪表板和设备详情

浏览主界面，了解不同标签页（如“设备”、“网络”、“存在”）的含义。点击一个设备，查看其详细信息，如IP地址、MAC地址、厂商、首次/最后在线时间。

尝试给设备重命名（例如，将“Apple Inc.”改为“我的iPhone”）以方便管理。

配置一项通知

进入“设置” > “通知网关”。选择一种简单的通知方式，如Email（需要SMTP信息）或Telegram。完成配置后，尝试在“工作流”或“设置”中创建一个测试规则（例如“当新设备上线时通知我”），触发通知以验证功能。

初次测试建议使用Email或Telegram这类易于配置的方式。

尝试一个简单的自动化工作流

在“设置” > “工作流”中，创建一个新的工作流。例如，设置一条规则：“当设备离线超过5分钟，将其标记为‘疑似离线’”。这有助于理解项目的自动化能力。

学习路径常见错误

数据目录权限问题，导致容器无法写入`config`和`db`文件夹。

确保在宿主机上创建的数据目录（如`~/netalertx/config`）对Docker进程有读写权限。在Linux上，可能需要使用`chmod`或`chown`调整权限。

网络模式配置错误，导致无法扫描本地网络设备。

如果使用Docker默认的桥接网络，容器可能无法看到宿主机所在局域网的所有设备。在`docker-compose.yml`中，将`network_mode`设置为`host`（Linux）或仔细配置端口映射和网络（Windows/macOS）。

防火墙阻止了扫描或Web访问。

确保宿主机的防火墙允许Docker容器使用的端口（默认为80）以及用于网络扫描的协议（如ARP）的数据包通过。

在`docker-compose.yml`中忘记挂载数据卷。

必须将宿主机的`./config`和`./db`目录挂载到容器内的相应路径（如`/data/config`和`/data/db`），否则容器重启后所有数据会丢失。

期望它能像专业网管软件一样监控服务器性能。

明确NetAlertX的核心是**网络设备发现和资产智能**，而非服务器CPU/内存监控。它主要回答“网络上有什么设备”的问题。

学习路径下一步步骤

在掌握基础后，你可以探索：1. **配置更多扫描插件**：如SNMP、UNIFI控制器导入，以获取更丰富的设备信息。2. **深入设置通知和工作流**：实现复杂的自动化规则，如设备分类、自动清理。3. **探索API集成**：利用其API将NetAlertX的数据集成到你自己的监控面板或Home Assistant中。4. **学习为多站点（MSP场景）部署**：配置Sync Nodes来集中管理多个远程网络的资产信息。