Skip to content
On this page

Install Agent

This document will introduce how to install the Agent on the monitored server and connect it to the Dashboard.

TIP

The repository for Agent binaries can be found at: https://github.com/nezhahq/agent/releases

One-Click Installation of the Agent

Nezha Monitoring supports one-click installation of the Agent on both Windows and Linux. By following the steps in this document, you can easily deploy it on your server.

Preparation

You need to set up a communication domain in the admin panel in advance, and this domain should not be connected to a CDN. This document uses the example communication domain “data.example.com”.
Go to the settings page in the admin panel, fill in the communication domain in the “Non-CDN Dashboard Server Domain/IP” field, and click "Save".

One-Click Installation on Linux (Ubuntu, Debian, CentOS)

  1. First, add a server in the admin panel.
  2. Click the green Linux icon button next to the newly added server and copy the one-click installation command.
  3. Run the copied installation command on the monitored server, and wait for the installation to complete. Then, check if the server is online in the Dashboard home page.

One-Click Installation on Windows

  1. First, add a server in the admin panel.
  2. Click the green Windows icon button next to the newly added server and copy the one-click installation command.
  3. Go to the Windows server, run PowerShell, and execute the copied installation command in PowerShell.
  4. If you encounter a prompt to "change execution policy," choose Y.
  5. Wait for the installation to complete, then check if the server is online in the Dashboard home page.

WARNING

If you encounter errors when running the one-click installation command in PowerShell, try the Manual Installation of the Agent on Windows below.

Other Ways to Install the Agent

Installing the Agent on Linux (Ubuntu, Debian, CentOS)

Click to expand/collapse
  1. First, add a server in the admin panel.
  2. Run the script on the monitored server:
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
  1. Select “Install monitoring Agent.”
  2. Enter the communication domain, such as "data.example.com".
  3. Enter the dashboard communication port (gRPC port), default is 5555.
  4. Enter the Agent secret, which is generated when you add a server in the admin panel and can be found on the “Servers” page in the admin panel.
  5. Wait for the installation to complete, then check if the server is online in the Dashboard home page.

Installing the Agent on Other Linux Distributions (e.g., Alpine using Openrc)

Click to expand/collapse

This section is contributed by unknown0054.

  1. Modify SERVER, SECRET, TLS, and execute in the shell:
shell
cat >/etc/init.d/nezha-agent<< EOF
#!/sbin/openrc-run
SERVER="" # Dashboard domain ip:port
SECRET="" # SECRET
TLS="" # Enable TLS if yes "--tls", leave empty if no
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 "Failed to get the version number. Please check if the server can connect to https://api.github.com/repos/nezhahq/agent/releases/latest"
      return 0
    else
      echo -e "The latest version is: ${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 "Failed to download Release. Please check if the server can connect to ${GITHUB_URL}"
      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. Add execute permissions
shell
chmod +x /etc/init.d/nezha-agent
  1. Start Nezha-Agent
shell
rc-service nezha-agent start
  1. Add to startup
shell
rc-update add nezha-agent

Manual Installation of the Agent on Windows

Installing the Agent on Synology DSM

Click to expand/collapse
sh
# Agent path
EXEC="/PATH/TO/nezha-agent"
# Log path
LOG="${EXEC}.log"
# Additional execution parameters, can be empty
ARGS=""
# Nezha server gRPC address
SERVER="HOST_OR_IP:gRPC_PORT"
# The secret key obtained in the previous step
SECRET="APP_SECRET"
# User running the service, *strongly recommended to use non-root user*
RUN_USER="nezha"

# Write to systemd service file
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

# Reload service
systemctl daemon-reload
# Start service
systemctl start nezha
# Enable service startup
systemctl enable nezha

‼️ Modify the corresponding information before running the above commands with the root account to complete the installation.

Installing the Agent on macOS

Click to expand/collapse

This section is adapted from Mitsea Blog with the author's permission

WARNING

If you are prompted "macOS cannot verify this app" during installation, manually allow the program to run in System Settings.

  1. First, add a server in the admin panel.
  2. Go to the Release page to download the Agent binary file. Choose to download the darwin amd64 or arm64 Agent according to your CPU architecture. Download the amd64 version for Intel CPU, or the arm64 version for Apple Silicon. After downloading, unzip the Agent binary file, such as unzipping it to the Downloads folder.
  3. Create a file named nezha_agent.plist and save it with the following content:
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>Modify the path to the Agent binary file here, such as: /Users/123/Downloads/nezha-agent</string>
 <key>ProgramArguments</key>
 <array>
  <string>Modify the path to the Agent binary file here, same as above</string>
  <string>--password</string>
  <string>The communication secret, such as: 529664783eeb23cc25</string>
  <string>--server</string>
  <string>The communication URL and gRPC port, such as: data.example.com:5555</string>
 </array>
 <key>RunAtLoad</key>
 <true/>
</dict>
</plist>
  1. Load the plist file into launchd using the following command in Terminal, make sure to replace the file path:
shell
launchctl load /Users/123/Desktop/nezha_agent.plist
  1. Start the process:
shell
launchctl start nezha_agent
  1. Check if the process is running:
shell
launchctl list | grep nezha_agent
  1. Stop the process and remove it:
shell
launchctl stop nezha_agent
shell
launchctl remove nezha_agent

Installing the Agent on macOS Using Homebrew

Click to expand/collapse

This section is adapted from 🐿️松鼠收集🌰 with the author's permission

WARNING

Please be sure to add environment variables before installing nezha-agent through Homebrew! Homebrew creates the service-required plist file during software installation, and if you add the environment variables after installation, it will fail to start due to missing parameters.

  1. Add environment variables:
shell
echo 'export HOMEBREW_NEZHA_AGENT_PASSWORD="Communication key, obtained from the service page"' >> ~/.zshrc
echo 'export HOMEBREW_NEZHA_AGENT_SERVER="Your server and port, format your.domain:5555 "' >> ~/.zshrc
source ~/.zshrc
  1. Install Nezha Agent:

DANGER

Note that this Homebrew repository is maintained by a third party and is unrelated to Nezha Monitoring. The Nezha project team does not endorse this repository's usability, security, etc. Please evaluate the risks yourself before using!

Since it has not yet been submitted to the Homebrew Core official library, it is temporarily placed in the third-party Homebrew repository maintained by the author of the blog:

shell
brew install brewforge/chinese/nezha-agent
  1. Start Nezha Agent service through Homebrew:
shell
brew services start nezha-agent
  1. Check the service status:
shell
brew services info nezha-agent
  1. Stop the service:
shell
brew services stop nezha-agent
  1. Uninstall Nezha Agent:
shell
brew rm nezha-agent
  1. If there is an error, first check the environment variables:
shell
echo $HOMEBREW_NEZHA_AGENT_PASSWORD
echo $HOMEBREW_NEZHA_AGENT_SERVER
  1. If the environment variables are configured correctly, try reinstalling:
shell
brew services stop nezha-agent
brew reinstall nezha-agent
brew services start nezha-agent
  1. If the issue persists, submit a issue to the third-party Homebrew repository.

Installing the Agent on OpenWRT

Click to expand/collapse

How to solve installation difficulties and issues in one step?

How to enable autostart on older OpenWRT/LEDE?

How to enable autostart on newer OpenWRT? Contributor: @艾斯德斯

  • First, download the corresponding binary from the release, unzip the zip package, and place it in /root.
  • Run chmod +x /root/nezha-agent to grant execution permission, then create /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 Dashboard communication domain:port -p Key -d
 procd_set_param respawn
 procd_close_instance
}

stop_service() {
  killall nezha-agent
}

restart() {
 stop
 sleep 2
 start
}
  • Run chmod +x /etc/init.d/nezha-service to grant execution permission.
  • Start the service: /etc/init.d/nezha-service enable && /etc/init.d/nezha-service start

Does the Agent Have a Docker Image?

The Agent does not currently have a Docker image.
The design philosophy of the Agent is opposite to that of the Dashboard. While the Dashboard should minimally impact the server, the Agent needs to execute monitoring services and run commands within the server.
Running the Agent inside a container can still perform monitoring tasks, but features like WebShell will not function properly, so no Docker image is provided.