---
outline: deep
---

# 安装 Agent

**哪吒监控的被控端服务被称为 Agent，本文档将介绍如何在被控端服务器上安装 Agent，并与 Dashboard 连接。**  
::: tip  
Agent 二进制文件仓库地址为：<https://github.com/nezhahq/agent/releases>
:::

## 一键安装 Agent

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

### 准备工作

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

### 在 Linux 中一键安装

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

### 在 macOS 中一键安装

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

### 在 Windows 中一键安装

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

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

## 其他方式安装 Agent

### 在 Linux 中安装 Agent（支持大部分发行版）
<details>
  <summary>点击展开/收起</summary>

1. 首先在管理面板中添加一台服务器。  
2. 在被控服务器中，运行脚本（位于中国大陆的服务器请使用镜像）：

```bash
curl -L https://raw.githubusercontent.com/nezhahq/scripts/main/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
```

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

```bash
curl -L https://gitee.com/naibahq/scripts/raw/main/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh
```

3. 选择“安装监控 Agent”。  
4. 输入通信域名，如：”data.example.com“。  
5. 输入面板通信端口（gRPC 端口），默认为 5555。  
6. 输入 Agent 密钥，Agent 密钥在管理面板中添加服务器时生成，可以在管理面板中的“服务器”页中找到。  
7. 等待安装完成后返回 Dashboard 主页查看服务器是否上线。

</details>

### 使用 Agent 内置服务命令安装（支持主流系统）
<details>
  <summary>点击展开/收起</summary>

首先获取 Agent 的二进制文件：https://github.com/nezhahq/agent/releases

解压后输入以下命令安装服务（可能需要 root 权限）：

```bash
./nezha-agent service install -s server_name:port -p password
```

除了服务器地址和密码，还可以添加其它支持的参数。具体参考[自定义 Agent 监控项目](/guide/q7.html)

卸载服务：

```bash
./nezha-agent service uninstall
```

启动服务：

```bash
./nezha-agent service start
```

停止服务：

```bash
./nezha-agent service stop
```

重启服务：

```bash
./nezha-agent service restart
```

</details>

### runit 安装 Agent
<details>
  <summary>点击展开/收起</summary>

目前 Agent 内置的服务功能已经支持了绝大部分 init 系统，包括 FreeBSD rc.d 和 openrc。尽管如此还是有一些漏网之鱼。

这里使用 Void Linux 的 runit 作为示例：

1. 创建 `/etc/sv/nezha-agent` 目录：

```bash
mkdir /etc/sv/nezha-agent
```

2. 创建 `/etc/sv/nezha-agent/run` 服务文件，写入以下内容：

```bash
#!/bin/sh
exec 2>&1
exec /opt/nezha/agent/nezha-agent -s server_name:port -p password 2>&1
```

这里同样可以添加其它参数。

3. 创建 `/etc/sv/nezha-agent/log/run`：

```bash
#!/bin/sh
exec vlogger -t nezha-agent -p daemon
```

4. 启用服务：

```bash
sudo ln -s /etc/sv/nezha-agent/ /var/service
```

之后可以通过 `sv` 命令来操作服务。

如何查看日志：

1. 安装 `socklog`，并启用：

```bash
sudo xbps-install -S socklog-void
sudo ln -s /etc/sv/socklog-unix /var/service
```

2. 运行 `svlogtail` 查看日志：

```bash
sudo svlogtail | grep nezha-agent
```

</details>

### 在 Windows 中手动安装 Agent
* 请参考社区文章：  
[哪吒探针 - Windows 客户端安装](https://nyko.me/2020/12/13/nezha-windows-client.html)

### 在群晖 DSM 中安装 Agent
<details>
  <summary>点击展开/收起</summary>

* 请参考社区文章：  
[群晖 DSM 7.x 安装 哪吒监控 Agent](https://blog.mitsea.com/3929551d08bd4bb0a8baa453e2d92b0c/)  
[哪吒探针——群晖客户端（被控端）安装教程](https://wl.gta5pdx.cn/archives/546/)

* Systemd 实现 *仅适用于 DSM7*:

```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` 账号执行上述命令即可安装完成。

</details>

### 在 macOS 中使用 Homebrew 安装 Agent
<details>
  <summary>点击展开/收起</summary>

***本节内容改编自 [🐿️松鼠收集🌰](https://blog.mre.red/archives/install_nezha_monitoring_agent_service_with_homebrew)，改编已获得原作者授权***

::: 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
```

2. 安装 Nezha Agent：

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

由于暂未提交到 Homebrew Core 官方库，暂时放在上述博客作者参与维护的 [第三方 Homebrew 仓库](https://github.com/Brewforge/homebrew-chinese) 中：

```shell
brew install brewforge/chinese/nezha-agent
```

3. 通过 Homebrew 启动 Nezha Agent 服务：

```shell
brew services start nezha-agent
```

4. 检查服务状态：

```shell
brew services info nezha-agent
```

5. 停止服务：

```shell
brew services stop nezha-agent
```

6. 卸载 Nezha Agent：

```shell
brew rm nezha-agent
```

7. 报错时先检查环境变量：

```shell
echo $HOMEBREW_NEZHA_AGENT_PASSWORD
echo $HOMEBREW_NEZHA_AGENT_SERVER
```

8. 若环境变量配置正确，再尝试重装：

```shell
brew services stop nezha-agent
brew reinstall nezha-agent
brew services start nezha-agent
```

9. 若仍未解决，请前往上述 [第三方 Homebrew 仓库](https://github.com/Brewforge/homebrew-chinese) 提交 issue。

</details>

### 在 OpenWRT 中安装 Agent
<details>
  <summary>点击展开/收起</summary>

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

* 请参考项目：  
[NZ-OpenWrt](https://github.com/dysf888/NZ-OpenWrt)  

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

* 请参考项目：  
[哪吒监控 For OpenWRT](https://github.com/Erope/openwrt_nezha)  

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

* 首先在 release 下载对应的二进制解压 zip 包后放置到 `/root`。  
* 运行 `chmod +x /root/nezha-agent` 赋予执行权限，然后创建 `/etc/init.d/nezha-service`：

```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
}
```

* 运行 `chmod +x /etc/init.d/nezha-service` 赋予执行权限。  
* 启动服务： `/etc/init.d/nezha-service enable && /etc/init.d/nezha-service start`

</details>

## Agent 有 Docker 镜像吗？

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