哪吒监控系统搭建
参考文档:https://nezha.wiki/guide/dashboard.html
github:https://github.com/naiba/nezha
安装 Dashboard
准备工作
搭建一个哪吒监控,你需要:
1、一台可以连接公网的 VPS,防火墙和安全策略需要放行 8008 和 5555 端口,否则会无法访问和无法接收数据。单核 512MB 内存的服务器配置就足以满足大多数使用场景
2、一个已经设置好 A 记录,指向 Dashboard 服务器 ip 的域名
TIP:
如果你想使用 CDN,请准备两个域名,一个配置好 CDN 用作公开访问,CDN 需要支持WebSocket 协议;另一个域名不要使用 CDN,用作 Agent 端与 Dashboard 的通信
本文档分别以 “cdn.example.com“ 和 “data.example.com“ 两个域名来演示
3、一个 Github 账号(或:Gitlab、Jihulab、Gitee)
TIP:
如果您位于中国大陆,访问 Github 有困难,我们建议您选择 Jihulab 作为 OAuth 提供商
本文档将以宝塔面板反代面板的过程作为范例,随着未来版本的变化,部分功能的入口可能会发生改变,本文档仅供参考
WARNING
本项目并不依赖宝塔,你可以选择使用你喜欢的任何服务器面板,如果你能力足够,可以手动安装 NginX 或 Caddy 来配置 SSL 和反代。
如果你认为没有必要使用 80、443 端口来访问 Dashboard,你甚至不需要安装 NginX 就可以直接使用安装脚本。
获取 Github/Jihulab 的 Client ID 和密钥
哪吒监控接入 Github、Gitlab、Jihulab、Gitee 作为后台管理员账号
- 首先我们需要新建一个验证应用,以 Github 为例,登录 Github 后,打开 https://github.com/settings/developers ,依次选择“OAuth Apps” - “New OAuth App”
Application name
- 随意填写Homepage URL
- 填写面板的访问域名,如:”http://cdn.example.com“Authorization callback URL
- 填写回调地址,如:”http://cdn.example.com/oauth2/callback" - 点击 “Register application”
- 保存页面中的 Client ID,然后点击 “Generate a new client secret“,创建一个新的 Client Secret,新建的密钥仅会显示一次,请妥善保存
- JihuLab 的应用创建入口为:https://jihulab.com/-/profile/applications
Redirect URL
中应填入回调地址- 在下方
范围
中勾选read_user
和read_api
- 创建完成后,保存好应用程序 ID 和密码
在服务器中安装 Dashboard
- 在面板服务器中,运行安装脚本:
1 | curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh |
如果你的面板服务器位于中国大陆,可以使用镜像:
1 | curl -L https://cdn.jsdelivr.net/gh/naiba/nezha/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh |
- 等待Docker安装完毕后,分别输入以下值:
OAuth提供商
- Github,Gitlab,Jihulab,Gitee 中选择一个Client ID
- 之前保存的 Client IDClient Secret
- 之前保存的密钥用户名
- OAuth 提供商中的用户名站点标题
- 自定义站点标题访问端口
- 公开访问端口,可自定义,默认 8008Agent的通信端口
- Agent与Dashboard的通信端口,默认 5555 - 输入完成后,等待拉取镜像
安装结束后,如果一切正常,此时你可以访问域名+端口号,如 “http://cdn.example.com:8008” 来查看面板 - 将来如果需要再次运行脚本,可以运行:
1 | ./nezha.sh |
来打开管理脚本
配置反向代理
- 在宝塔面板中新建一个站点,域名填写公开访问域名,如 “http://cdn.example.com“ ,然后点击“设置”进入站点设置选项,选择“反向代理” - “新建反向代理”
- 自定义一个代理名称,在下方“目标 URL”中填入
http://127.0.0.1
然后点击“保存” - 打开刚刚新建的反向代理右边的“配置文件”,将配置文件替换为以下内容:
1 | PROXY-START/ |
- 点击“保存”
现在,你应该可以直接使用域名,如:“http://cdn.example.com“ 来访问面板了
安装 Agent
目前哪吒监控已支持在 Windows 和 Linux上一键安装 Agent,遵循本文档的步骤,你可以很轻松的在服务器上部署它
准备工作
你需要提前在管理面板中设置好通信域名,此域名不可以接入CDN,这里以前面提到过的示例通信域名 “data.example.com” 来做演示
进入后台管理面板,转到“设置”页,在“未接入 CDN 的面板服务器域名/IP”项中填入通信域名,然后点击”保存”
在 Linux 中一键安装 (Ubuntu、Debian、CentOS)#
首先在管理面板中添加一台服务器
点击新添加的服务器旁,绿色的 Linux 图标按钮,复制一键安装命令
在被控端服务器中运行复制的一键安装命令,等待安装完成后返回到 Dashboard 主页查看服务器是否上线
在 Windows 中一键安装#
- 首先在管理面板中添加一台服务器
- 点击新添加的服务器旁,绿色的 Windows 图标按钮,复制一键安装命令
- 进入 Windows 服务器,运行 PowerShell,在 PowerShell 中运行复制的安装命令
- 如遇到确认「执行策略变更」请选择 Y
- 等待安装完成后返回 Dashboard 主页查看服务器是否上线
其他方式安装 Agent#
在 Linux 中安装 Agent (Ubuntu、Debian、CentOS)#
- 首先在管理面板中添加一台服务器
- 在被控服务器中,运行脚本(位于中国大陆的服务器请使用镜像):
1 | curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh |
如果你的被控服务器位于中国大陆,可以使用镜像:
1 | curl -L https://cdn.jsdelivr.net/gh/naiba/nezha/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh |
- 选择“安装监控 Agent”
- 输入通信域名,如:”data.example.com“
- 输入面板通信端口(RPC端口),默认为 5555
- 输入 Agent 密钥,Agent 密钥在管理面板中添加服务器时生成,可以在管理面板中的“主机”页中找到
- 等待安装完成后返回 Dashboard 主页查看服务器是否上线
在 MacOS 中安装 Agent#
本节内容改编自 Mitsea Blog,改编已获得原作者授权
WARNING
安装过程中如提示“macOS 无法验证此 app“,请前往系统设置手动允许程序运行
- 首先在管理面板中添加一台服务器
- 前往 Release 页下载 Agent 二进制文件,根据 CPU 架构选择下载 darwin amd64 还是 arm64 的 Agent
如 Intel CPU 下载 amd64,Apple Silicon 下载 arm64 版本。下载完成后解压 Agent 二进制文件,如解压到下载文件夹 - 新建一个名为
nezha_agent.plist
的文件并保存,修改文件内容如下:
1 | <?xml version="1.0" encoding="UTF-8"?> |
- 在 Terminal 中使用下面的命令加载 plist 文件到 launchd 里,注意替换文件路径
1 | launchctl load /Users/123/Desktop/nezha_agent.plist |
- 启动进程
1 | launchctl start nezha_agent |
- 检查进程是否运行
1 | launchctl list | grep nezha_agent |
- 停止进程并移除
1 | launchctl stop nezha_agent |
在 Windows 中安装 Agent#
- 请参考社区文章:
哪吒探针 - Windows 客户端安装
在 群晖DSM 中安装 Agent#
- 请参考社区文章:
哪吒探针——群晖客户端(被控端)安装教程
在 OpenWRT 中安装 Agent#
如何 一步到位,解决安装过程疑难杂症
- 请参考项目:
NZ-OpenWrt
防止盗用
serverIp
- Agent 的 ip 地址,你系统安装的哪个就用哪个命令,ufw iptables 都可.
1 | ubuntu |