import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const o=JSON.parse('{"title":"安装 Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1720539149000}'),t={name:"guide/agent.md"},l=n(`

安装 Agent ​

哪吒监控的被控端服务被称为 Agent，本文档将介绍如何在被控端服务器上安装 Agent，并与 Dashboard 连接。

TIP

Agent 二进制文件仓库地址为：https://github.com/nezhahq/agent/releases

一键安装 Agent ​

哪吒监控支持在 Windows 和 Linux 上一键安装 Agent。遵循本文档的步骤，你可以很轻松地在服务器上部署它。

准备工作 ​

你需要提前在管理面板中设置好通信域名，此域名不可以接入 CDN。本文档以示例通信域名 “data.example.com” 为例。
进入后台管理面板，转到“设置”页，在“未接入 CDN 的面板服务器域名/IP”项中填入通信域名，然后点击"保存"。

在 Linux 中一键安装 (Ubuntu、Debian、CentOS) ​

  1. 首先在管理面板中添加一台服务器。
  2. 点击新添加的服务器旁的绿色 Linux 图标按钮，复制一键安装命令。
  3. 在被控端服务器中运行复制的一键安装命令，等待安装完成后返回到 Dashboard 主页查看服务器是否上线。

在 Windows 中一键安装 ​

  1. 首先在管理面板中添加一台服务器。
  2. 点击新添加的服务器旁的绿色 Windows 图标按钮，复制一键安装命令。
  3. 进入 Windows 服务器，运行 PowerShell，在 PowerShell 中运行复制的安装命令。
  4. 如遇到确认「执行策略变更」请选择 Y。
  5. 等待安装完成后返回 Dashboard 主页查看服务器是否上线。

WARNING

如果在 PowerShell 中运行一键安装命令时遇到错误，请尝试下方的在 Windows 中手动安装 Agent。

其他方式安装 Agent ​

在 Linux 中安装 Agent (Ubuntu、Debian、CentOS) ​

点击展开/收起
  1. 首先在管理面板中添加一台服务器。
  2. 在被控服务器中，运行脚本（位于中国大陆的服务器请使用镜像）：
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh

如果你的被控服务器位于中国大陆，可以使用镜像：

bash
curl -L https://gitee.com/naibahq/nezha/raw/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh
  1. 选择“安装监控 Agent”。
  2. 输入通信域名，如：”data.example.com“。
  3. 输入面板通信端口（gRPC 端口），默认为 5555。
  4. 输入 Agent 密钥，Agent 密钥在管理面板中添加服务器时生成，可以在管理面板中的“服务器”页中找到。
  5. 等待安装完成后返回 Dashboard 主页查看服务器是否上线。

在其他 Linux 发行版（如 Alpine 使用 Openrc）中安装 Agent ​

点击展开/收起

本节内容由 unknown0054 贡献。

  1. 修改 SERVER、SECRET、TLS，然后在 shell 中执行：
shell
cat >/etc/init.d/nezha-agent<< EOF
#!/sbin/openrc-run
SERVER="" # Dashboard 地址 ip:port
SECRET="" # SECRET
TLS="" # 是否启用 TLS，是 "--tls" ，否留空
NZ_BASE_PATH="/opt/nezha"
NZ_AGENT_PATH="\${NZ_BASE_PATH}/agent"
pidfile="/run/\${RC_SVCNAME}.pid"
command="/opt/nezha/agent/nezha-agent"
command_args="-s \${SERVER} -p \${SECRET} \${TLS}"
command_background=true
depend() {
  need net
}
checkconfig() {
  GITHUB_URL="github.com"
  if [ ! -f "\${NZ_AGENT_PATH}/nezha-agent" ]; then
    if [[ $(uname -m | grep 'x86_64') != "" ]]; then
      os_arch="amd64"
    elif [[ $(uname -m | grep 'i386\\|i686') != "" ]]; then
      os_arch="386"
    elif [[ $(uname -m | grep 'aarch64\\|armv8b\\|armv8l') != "" ]]; then
      os_arch="arm64"
    elif [[ $(uname -m | grep 'arm') != "" ]]; then
      os_arch="arm"
    elif [[ $(uname -m | grep 's390x') != "" ]]; then
      os_arch="s390x"
    elif [[ $(uname -m | grep 'riscv64') != "" ]]; then
      os_arch="riscv64"
    fi
    local version=$(curl -m 10 -sL "https://api.github.com/repos/nezhahq/agent/releases/latest" | grep "tag_name" | head -n 1 | awk -F ":" '{print $2}' | sed 's/\\"//g;s/,//g;s/ //g')
    if [ ! -n "$version" ]; then
      version=$(curl -m 10 -sL "https://fastly.jsdelivr.net/gh/nezhahq/agent/" | grep "option\\.value" | awk -F "'" '{print $2}' | sed 's/nezhahq\\/agent@/v/g')
    fi
    if [ ! -n "$version" ]; then
      version=$(curl -m 10 -sL "https://gcore.jsdelivr.net/gh/nezhahq/agent/" | grep "option\\.value" | awk -F "'" '{print $2}' | sed 's/nezhahq\\/agent@/v/g')
    fi
    if [ ! -n "$version" ]; then
      echo -e "获取版本号失败，请检查本机能否链接 https://api.github.com/repos/nezhahq/agent/releases/latest"
      return 0
    else
      echo -e "当前最新版本为: \${version}"
    fi
    wget -t 2 -T 10 -O nezha-agent_linux_\${os_arch}.zip https://\${GITHUB_URL}/nezhahq/agent/releases/download/\${version}/nezha-agent_linux_\${os_arch}.zip >/dev/null 2>&1
    if [[ $? != 0 ]]; then
      echo -e "Release 下载失败，请检查本机能否连接 \${GITHUB_URL}\${plain}"
      return 0
    fi
    mkdir -p $NZ_AGENT_PATH
    chmod 755 -R $NZ_AGENT_PATH
    unzip -qo nezha-agent_linux_\${os_arch}.zip && mv nezha-agent $NZ_AGENT_PATH && rm -rf nezha-agent_linux_\${os_arch}.zip README.md
  fi
  if [ ! -x "\${NZ_AGENT_PATH}/nezha-agent" ]; then
    chmod +x \${NZ_AGENT_PATH}/nezha-agent
  fi
}
start_pre() {
  if [ "\${RC_CMD}" != "restart" ]; then
    checkconfig || return $?
  fi
}
EOF
  1. 增加运行权限
shell
chmod +x /etc/init.d/nezha-agent
  1. 运行 Nezha-Agent
shell
rc-service nezha-agent start
  1. 添加开机自启动
shell
rc-update add nezha-agent

在 Windows 中手动安装 Agent ​

在群晖 DSM 中安装 Agent ​

点击展开/收起
sh
# Agent 路径
EXEC="/PATH/TO/nezha-agent"
# 日志路径地址
LOG="\${EXEC}.log"
# 额外执行参数, 可留空
ARGS=""
# 哪吒服务端 gRPC 地址
SERVER="HOST_OR_IP:gRPC_PORT"
# 上一步获取的主机密钥
SECRET="APP_SECRET"
# 运行服务的用户名, *强烈建议使用非root用户执行*
RUN_USER="nezha"

# 写入到 systemd 服务文件
cat << EOF > /usr/lib/systemd/system/nezha.service
[Unit]
Description=Nezha Agent Service
After=network.target

[Service]
Type=simple
ExecStart=/bin/nohup \${EXEC} \${ARGS} -s \${SERVER} -p \${SECRET} &>> \${LOG} &
ExecStop=ps -fe |grep nezha-agent|awk '{print \\$2}'|xargs kill
User=\${RUN_USER

}
Restart=on-abort

[Install]
WantedBy=multi-user.target
EOF

# 重载服务
systemctl daemon-reload
# 启动服务
systemctl start nezha
# 服务自启动
systemctl enable nezha

‼️修改对应信息后‼️
使用 root 账号执行上述命令即可安装完成。

在 macOS 中安装 Agent ​

点击展开/收起

本节内容改编自 Mitsea Blog，改编已获得原作者授权

WARNING

安装过程中如提示“macOS 无法验证此 app“，请前往系统设置手动允许程序运行。

  1. 首先在管理面板中添加一台服务器。
  2. 前往 Release 页下载 Agent 二进制文件，根据 CPU 架构选择下载 darwin amd64 还是 arm64 的 Agent。
    如 Intel CPU 下载 amd64，Apple Silicon 下载 arm64 版本。下载完成后解压 Agent 二进制文件，如解压到下载文件夹。
  3. 新建一个名为 nezha_agent.plist 的文件并保存，修改文件内容如下：
xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
 <key>KeepAlive</key>
 <true/>
 <key>Label</key>
 <string>nezha_agent</string>
 <key>Program</key>
 <string>在这里修改 Agent 二进制文件的的路径，如：/Users/123/Downloads/nezha-agent</string>
 <key>ProgramArguments</key>
 <array>
  <string>在这里修改 Agent 二进制文件的的路径，同上</string>
  <string>--password</string>
  <string>通信密钥，如：529664783eeb23cc25</string>
  <string>--server</string>
  <string>通信网址和 gRPC 端口，如:data.example.com:5555</string>
 </array>
 <key>RunAtLoad</key>
 <true/>
</dict>
</plist>
  1. 在 Terminal 中使用下面的命令加载 plist 文件到 launchd 里，注意替换文件路径：
shell
launchctl load /Users/123/Desktop/nezha_agent.plist
  1. 启动进程：
shell
launchctl start nezha_agent
  1. 检查进程是否运行：
shell
launchctl list | grep nezha_agent
  1. 停止进程并移除：
shell
launchctl stop nezha_agent
shell
launchctl remove nezha_agent

在 macOS 中使用 Homebrew 安装 Agent ​

点击展开/收起

本节内容改编自 🐿️松鼠收集🌰，改编已获得原作者授权

WARNING

请务必先添加环境变量，再通过 Homebrew 安装 nezha-agent！ 因 Homebrew 在软件安装时创建服务所需 plist 文件，若先安装再添加环境变量，会因缺少参数而启动失败。

  1. 添加环境变量：
shell
echo 'export HOMEBREW_NEZHA_AGENT_PASSWORD="通信密钥，在服务页面获取"' >> ~/.zshrc
echo 'export HOMEBREW_NEZHA_AGENT_SERVER="你的服务器和端口，格式 your.domain:5555 "' >> ~/.zshrc
source ~/.zshrc
  1. 安装 Nezha Agent：

DANGER

请注意，此 Homebrew 仓库由第三方维护，与哪吒监控无关。 Nezha 项目组不对该仓库的可用性和安全性等方面作出背书。在使用前，请自行评估风险！

由于暂未提交到 Homebrew Core 官方库，暂时放在上述博客作者参与维护的 第三方 Homebrew 仓库 中：

shell
brew install brewforge/chinese/nezha-agent
  1. 通过 Homebrew 启动 Nezha Agent 服务：
shell
brew services start nezha-agent
  1. 检查服务状态：
shell
brew services info nezha-agent
  1. 停止服务：
shell
brew services stop nezha-agent
  1. 卸载 Nezha Agent：
shell
brew rm nezha-agent
  1. 报错时先检查环境变量：
shell
echo $HOMEBREW_NEZHA_AGENT_PASSWORD
echo $HOMEBREW_NEZHA_AGENT_SERVER
  1. 若环境变量配置正确，再尝试重装：
shell
brew services stop nezha-agent
brew reinstall nezha-agent
brew services start nezha-agent
  1. 若仍未解决，请前往上述 第三方 Homebrew 仓库 提交 issue。

在 OpenWRT 中安装 Agent ​

点击展开/收起

如何一步到位，解决安装过程中的疑难杂症？

如何使旧版 OpenWRT/LEDE 自启动？

如何使新版 OpenWRT 自启动？ 贡献者：@艾斯德斯

shell
#!/bin/sh /etc/rc.common

START=99
USE_PROCD=1

start_service() {
 procd_open_instance
 procd_set_param command /root/nezha-agent -s 面板通信地址:端口 -p 秘钥 -d
 procd_set_param respawn
 procd_close_instance
}

stop_service() {
  killall nezha-agent
}

restart() {
 stop
 sleep 2
 start
}

Agent 有 Docker 镜像吗？ ​

Agent 目前没有推出 Docker 镜像。
Agent 的设计思路和 Dashboard 相反，Dashboard 要尽可能不影响宿主机工作，但 Agent 则需要在宿主机中执行监控服务和运行命令。
将 Agent 放入容器中确实可以继续执行监控任务，但 WebShell 等功能无法正常运行，因此不提供 Docker 镜像。

`,29),h=[l];function e(p,k,r,g,d,F){return a(),i("div",null,h)}const c=s(t,[["render",e]]);export{o as __pageData,c as default};