nezha/README.md at v0-final · oneclickvirt/nezha

LOGO designed by 熊大 .

Nezha Monitoring: Self-hostable, lightweight, servers and websites monitoring and O&M tool.

Supports monitoring system status, HTTP (SSL certificate change, upcoming expiration, expired), TCP, Ping and supports push alerts, run scheduled tasks and web terminal.

>> Telegram Channel: 哪吒监控（中文通知频道）

>> Telegram Group: Nezha Monitoring Global (English Only), 哪吒监控（中文群组）

>> Use Cases | 我们的用户 (Google)

User Guide

Install Dashboard

Dashboard release assets are published from this repository. Download the dashboard installer from the v0-final branch, then use install for a new deployment or upgrade for an existing one. The installer uses spiritlhl CDN acceleration and falls back to raw GitHub when needed.

curl -fsSL https://cdn0.spiritlhl.top/https://raw.githubusercontent.com/oneclickvirt/nezha/refs/heads/v0-final/script/install-dashboard.sh -o install-dashboard.sh
chmod +x install-dashboard.sh
sudo ./install-dashboard.sh install

Upgrade an existing installation:

sudo ./install-dashboard.sh upgrade

Pin a specific release version:

sudo INSTALL_VERSION=vX.Y.Z ./install-dashboard.sh install
sudo INSTALL_VERSION=vX.Y.Z ./install-dashboard.sh upgrade

Config values can be provided non-interactively via environment variables: NZ_ADMIN_LOGINS, NZ_OAUTH2_CLIENT_ID, NZ_OAUTH2_CLIENT_SECRET, NZ_GRPC_HOST, NZ_ENABLE_TLS, etc.

Agent install commands shown inside the dashboard fetch scripts from this repository, but the agent binary itself comes from the official nezhahq/agent release.

Docker Deployment

A Docker image is built and published to GHCR on every release:

ghcr.io/oneclickvirt/nezha-dashboard:latest

Quick start with docker compose using the provided template:

# Download the compose template
curl -fsSL https://cdn0.spiritlhl.top/https://raw.githubusercontent.com/oneclickvirt/nezha/refs/heads/v0-final/script/docker-compose.yaml -o docker-compose.yaml

# Create required directories and a minimal config
mkdir -p data

# Pull and start
docker compose up -d

Or run directly without compose:

docker run -d \
  --name nezha-dashboard \
  --restart always \
  -p 8008:80 \
  -p 5555:5555 \
  -v "$(pwd)/data:/dashboard/data" \
  ghcr.io/oneclickvirt/nezha-dashboard:latest

The docker-compose.yaml template uses placeholder values (nz_site_port, nz_grpc_port, nz_image_url) that the install-dashboard.sh script replaces automatically during setup. If you manage Docker manually, substitute these with your actual values.