提交项目
我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜
diff --git a/404.html b/404.html index fd70820c..60e3363d 100644 --- a/404.html +++ b/404.html @@ -15,7 +15,7 @@
404
But if you don't change your direction, and if you keep looking, you may end up where you are heading.
贡献者:
项目地址:nezha_api_tgbot
镜像备份(非实时更新):nezha_api_tgbot
机器人可以通过API向面板请求服务器状态信息,得到信息后发送给用户
你可以搭建此机器人来方便地查看指定服务器的当前状态且不需要打开面板
贡献者:
项目地址:nezha_api_tgbot
镜像备份(非实时更新):nezha_api_tgbot
机器人可以通过API向面板请求服务器状态信息,得到信息后发送给用户
你可以搭建此机器人来方便地查看指定服务器的当前状态且不需要打开面板
当前版本:V1.0
贡献者:
使用iPhone或iPad扫描以下二维码,获取快捷指令
MacOS用户请访问这里,获取快捷指令
面板URL
、API Token
、服务器ID
WARNING
每个快捷指令只能监控一台服务器,如需要监控多个服务器,请多次复制此快捷指令并分别配置,然后分别修改快捷指令名称,如;一号服务器状态、二号服务器状态等
当前版本:V1.0
贡献者:
使用iPhone或iPad扫描以下二维码,获取快捷指令
MacOS用户请访问这里,获取快捷指令
面板URL
、API Token
、服务器ID
WARNING
每个快捷指令只能监控一台服务器,如需要监控多个服务器,请多次复制此快捷指令并分别配置,然后分别修改快捷指令名称,如;一号服务器状态、二号服务器状态等
贡献者:
项目地址:nezha_telegram_bot
镜像备份(非实时更新):nezha_telegram_bot
开源Telegram机器人项目,可以基于API实时查询哪吒面板的服务器信息。
命令 | 功能 | 仅私聊 |
---|---|---|
start | 开始使用键盘主菜单 | ✔️ |
help | 帮助列表 | ❌ |
add | 添加面板链接和token | ✔️ |
url | 添加面板链接 | ✔️ |
token | 添加面板token | ✔️ |
info | 获取保存的面板链接和token | ✔️ |
delete | 删除保存的面板链接和token | ✔️ |
id | 命令后面添加整数id,来进行单个服务器信息查询(私聊带刷新按钮,群聊不带) | ❌ |
all | 查询所有服务器的统计信息 | ❌ |
search | 在服务器名字中搜索关键字(支持多个,用空格分开) | ❌ |
贡献者:
项目地址:nezha_telegram_bot
镜像备份(非实时更新):nezha_telegram_bot
开源Telegram机器人项目,可以基于API实时查询哪吒面板的服务器信息。
命令 | 功能 | 仅私聊 |
---|---|---|
start | 开始使用键盘主菜单 | ✔️ |
help | 帮助列表 | ❌ |
add | 添加面板链接和token | ✔️ |
url | 添加面板链接 | ✔️ |
token | 添加面板token | ✔️ |
info | 获取保存的面板链接和token | ✔️ |
delete | 删除保存的面板链接和token | ✔️ |
id | 命令后面添加整数id,来进行单个服务器信息查询(私聊带刷新按钮,群聊不带) | ❌ |
all | 查询所有服务器的统计信息 | ❌ |
search | 在服务器名字中搜索关键字(支持多个,用空格分开) | ❌ |
还在因为自己的小鸡配置太差被朋友嘲笑吗?
还在想参加以针会友活动却因为小鸡不够排面而觉得羞耻吗?
还在因为在哪吒TG群里机器人排名太低而觉得自己低人一等吗?
今天开始!找回自信!
来自南京的名老中医 dysf888 独家秘方!让你找回男人本色,激情畅享!
安装 Fake Agent,可随意修改服务器监测数据的倍数上传到 Dashboard,让你的小鸡 脱!胎!换!骨! 让你在 MJJ 面前硬起来!
镜像备份(非实时更新):Fake Agent
哪吒监控创始人奶爸也在用:
男人用了都说好:
还在因为自己的小鸡配置太差被朋友嘲笑吗?
还在想参加以针会友活动却因为小鸡不够排面而觉得羞耻吗?
还在因为在哪吒TG群里机器人排名太低而觉得自己低人一等吗?
今天开始!找回自信!
来自南京的名老中医 dysf888 独家秘方!让你找回男人本色,激情畅享!
安装 Fake Agent,可随意修改服务器监测数据的倍数上传到 Dashboard,让你的小鸡 脱!胎!换!骨! 让你在 MJJ 面前硬起来!
镜像备份(非实时更新):Fake Agent
哪吒监控创始人奶爸也在用:
男人用了都说好:
贡献者:
项目地址:Argo-Nezha-Service-Container
镜像备份(非实时更新):Argo-Nezha-Service-Container
网络
选项将 gRPC
开关打开面板域名加上 https://
开头,回调地址再加上 /oauth2/callback
结尾
Argo 隧道认证方式有 json 和 token,使用两个方式其中之一。推荐前者,理由脚本会处理好所有的 Argo 隧道参数和路径,后者需要到 Cloudflare 官网手动设置,容易出错。
proto.NezhaService
镜像 fscarmen/argo-nezha:latest
, 支持 amd64 和 arm64 架构
用到的变量
变量名 | 是否必须 | 备注 |
---|---|---|
GH_USER | 是 | github 的用户名,用于面板管理授权 |
GH_CLIENTID | 是 | 在 github 上申请 |
GH_CLIENTSECRET | 是 | 在 github 上申请 |
GH_BACKUP_USER | 否 | 在 github 上备份哪吒服务端数据库的 github 用户名,不填则与面板管理授权的账户 GH_USER 一致 |
GH_REPO | 否 | 在 github 上备份哪吒服务端数据库文件的 github 库 |
GH_EMAIL | 否 | github 的邮箱,用于备份的 git 推送到远程库 |
GH_PAT | 否 | github 的 PAT |
ARGO_AUTH | 是 | Json: 从 https://fscarmen.cloudflare.now.cc 获取的 Argo Json Token: 从 Cloudflare 官网获取 |
ARGO_DOMAIN | 是 | Argo 域名 |
Koyeb
docker run -dit \\
+import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1717546452000}'),l={name:"case/case5.md"},n=t(`使用 Argo 隧道的哪吒服务端
贡献者:
项目地址:Argo-Nezha-Service-Container
镜像备份(非实时更新):Argo-Nezha-Service-Container
目录
- 项目特点
- 准备需要用的变量
- Argo 认证的获取方式: json 或 token
- PaaS 部署实例
- VPS 部署方式 1 --- docker
- VPS 部署方式 2 --- 宿主机
- 客户端接入
- SSH 接入
- 手动备份数据
- 自动还原备份
- 手动还原备份
- 完美搬家
- 主体目录文件及说明
- 鸣谢下列作者的文章和项目
- 免责声明
项目特点:
- 适用范围更广 --- 只要能连通网络,就能安装哪吒服务端,如 LXC, OpenVZ VPS,Nas 虚拟机 , Container PaaS 等
- Argo 隧道突破需要公网入口的限制 --- 传统的哪吒需要有两个公网端口,一个用于面板的访问,另一个用于客户端上报数据,本项目借用 Cloudflare Argo 隧道,使用内网穿透的办法
- IPv4 / v6 具备更高的灵活性 --- 传统哪吒需要处理服务端和客户端的 IPv4/v6 兼容性问题,还需要通过 warp 等工具来解决不对应的情况。然而,本项目可以完全不需要考虑这些问题,可以任意对接,更加方便和简便
- 一条 Argo 隧道分流多个域名和协议 --- 建立一条内网穿透的 Argo 隧道,即可分流三个域名(hostname)和协议(protocal),分别用于面板的访问(http),客户端上报数据(tcp)和 ssh(可选)
- GrpcWebProxy 反向代理的 gRPC 数据端口 --- 配上证书做 tls 终结,然后 Argo 的隧道配置用 https 服务指向这个反向代理,启用http2回源,grpc(nezha)->GrpcWebProxy->h2(argo)->cf cdn edge->agent
- 每天自动备份 --- 北京时间每天 4 时 0 分自动备份整个哪吒面板文件夹到指定的 github 私库,包括面板主题,面板设置,探针数据和隧道信息,备份保留近 5 天数据;鉴于内容十分重要,必须要放在私库
- 每天自动更新面板 -- 北京时间每天 4 时 0 分自动检测最新的官方面板版本,有升级时自动更新
- 手/自一体还原备份 --- 每分钟检测一次在线还原文件的内容,遇到有更新立刻还原
- 默认内置本机探针 --- 能很方便的监控自身服务器信息
- 数据更安全 --- Argo 隧道使用TLS加密通信,可以将应用程序流量安全地传输到 Cloudflare 网络,提高了应用程序的安全性和可靠性。此外,Argo Tunnel也可以防止IP泄露和DDoS攻击等网络威胁

准备需要用的变量
- 到 Cloudflare 官网,选择使用的域名,打开
网络
选项将 gRPC
开关打开

- 获取 github 认证授权: https://github.com/settings/applications/new
面板域名加上 https://
开头,回调地址再加上 /oauth2/callback
结尾


- 获取 github 的 PAT (Personal Access Token): https://github.com/settings/tokens/new


- 创建 github 用于备份的私库: https://github.com/new

Argo 认证的获取方式: json 或 token
Argo 隧道认证方式有 json 和 token,使用两个方式其中之一。推荐前者,理由脚本会处理好所有的 Argo 隧道参数和路径,后者需要到 Cloudflare 官网手动设置,容易出错。
(方式 1 - Json):
通过 Cloudflare Json 生成网轻松获取 Argo 隧道 json 信息: https://fscarmen.cloudflare.now.cc

(方式 2 - Token): 通过 Cloudflare 官网,手动生成 Argo 隧道 token 信息
到 cf 官网:https://dash.cloudflare.com/
- 进入 zero trust 里生成 token 隧道和信息。
- 其中数据路径 443/https 为
proto.NezhaService
- ssh 路径 22/ssh 为 < client id >







PaaS 部署实例
镜像 fscarmen/argo-nezha:latest
, 支持 amd64 和 arm64 架构
用到的变量
变量名 是否必须 备注 GH_USER 是 github 的用户名,用于面板管理授权 GH_CLIENTID 是 在 github 上申请 GH_CLIENTSECRET 是 在 github 上申请 GH_BACKUP_USER 否 在 github 上备份哪吒服务端数据库的 github 用户名,不填则与面板管理授权的账户 GH_USER 一致 GH_REPO 否 在 github 上备份哪吒服务端数据库文件的 github 库 GH_EMAIL 否 github 的邮箱,用于备份的 git 推送到远程库 GH_PAT 否 github 的 PAT ARGO_AUTH 是 Json: 从 https://fscarmen.cloudflare.now.cc 获取的 Argo Json
Token: 从 Cloudflare 官网获取 ARGO_DOMAIN 是 Argo 域名
Koyeb





VPS 部署方式 1 --- docker
- 注意: ARGO_DOMAIN= 后面需要有单引号,不能去掉
- 如果 VPS 是 IPv6 only 的,请先安装 WARP IPv4 或者双栈: https://gitlab.com/fscarmen/warp
- 备份目录为当前路径的 dashboard 文件夹
docker 部署
docker run -dit \\
--name nezha_dashboard \\
--pull always \\
--restart always \\
diff --git a/assets/case_case5.md.e114920c.lean.js b/assets/case_case5.md.9f497658.lean.js
similarity index 85%
rename from assets/case_case5.md.e114920c.lean.js
rename to assets/case_case5.md.9f497658.lean.js
index 618bad03..a772c6ed 100644
--- a/assets/case_case5.md.e114920c.lean.js
+++ b/assets/case_case5.md.9f497658.lean.js
@@ -1 +1 @@
-import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1717546110000}'),l={name:"case/case5.md"},n=t("",89),r=[n];function o(c,i,p,h,d,g){return e(),s("div",null,r)}const u=a(l,[["render",o]]);export{m as __pageData,u as default};
+import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1717546452000}'),l={name:"case/case5.md"},n=t("",89),r=[n];function o(c,i,p,h,d,g){return e(),s("div",null,r)}const u=a(l,[["render",o]]);export{m as __pageData,u as default};
diff --git a/assets/case_index.md.f5da589d.js b/assets/case_index.md.6fb4808b.js
similarity index 94%
rename from assets/case_index.md.f5da589d.js
rename to assets/case_index.md.6fb4808b.js
index 4648b62e..23d0cd2c 100644
--- a/assets/case_index.md.f5da589d.js
+++ b/assets/case_index.md.6fb4808b.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1717546110000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1717546452000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
diff --git a/assets/case_index.md.f5da589d.lean.js b/assets/case_index.md.6fb4808b.lean.js
similarity index 94%
rename from assets/case_index.md.f5da589d.lean.js
rename to assets/case_index.md.6fb4808b.lean.js
index 4648b62e..23d0cd2c 100644
--- a/assets/case_index.md.f5da589d.lean.js
+++ b/assets/case_index.md.6fb4808b.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1717546110000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1717546452000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
diff --git a/assets/developer_index.md.ae610ffd.js b/assets/developer_index.md.0802bf60.js
similarity index 92%
rename from assets/developer_index.md.ae610ffd.js
rename to assets/developer_index.md.0802bf60.js
index 15b93d60..a1099793 100644
--- a/assets/developer_index.md.ae610ffd.js
+++ b/assets/developer_index.md.0802bf60.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1717546110000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1717546452000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
diff --git a/assets/developer_index.md.ae610ffd.lean.js b/assets/developer_index.md.0802bf60.lean.js
similarity index 92%
rename from assets/developer_index.md.ae610ffd.lean.js
rename to assets/developer_index.md.0802bf60.lean.js
index 15b93d60..a1099793 100644
--- a/assets/developer_index.md.ae610ffd.lean.js
+++ b/assets/developer_index.md.0802bf60.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1717546110000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1717546452000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
diff --git a/assets/developer_l10n.md.296175b2.js b/assets/developer_l10n.md.97699e69.js
similarity index 95%
rename from assets/developer_l10n.md.296175b2.js
rename to assets/developer_l10n.md.97699e69.js
index 46bd2d3b..16b92e51 100644
--- a/assets/developer_l10n.md.296175b2.js
+++ b/assets/developer_l10n.md.97699e69.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1717546110000}'),l={name:"developer/l10n.md"},r=t('哪吒监控的 Dashboard 已经添加本地化,支持多个语言,你可以在开发新功能时遵循以下步骤来支持本地化
介绍
- 你可以直接使用
/resource/l10n/zh-CN.toml
中已有的文本配置来替换新功能中的文本 - 如果新功能中有新增文本,请参考
zh-CN.toml
的配置文本,将新文本拉取到 zh-CN.toml
等其他语言的配置文件中,并添加翻译
新本地化文本的添加
- 在
/resource/l10n/
中添加新的语言文本配置 - 在新的语言文本配置中拉取其他语言已有的文本配置
- 为新的语言文本配置添加翻译
',5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1717546452000}'),l={name:"developer/l10n.md"},r=t('哪吒监控的 Dashboard 已经添加本地化,支持多个语言,你可以在开发新功能时遵循以下步骤来支持本地化
介绍
- 你可以直接使用
/resource/l10n/zh-CN.toml
中已有的文本配置来替换新功能中的文本 - 如果新功能中有新增文本,请参考
zh-CN.toml
的配置文本,将新文本拉取到 zh-CN.toml
等其他语言的配置文件中,并添加翻译
新本地化文本的添加
- 在
/resource/l10n/
中添加新的语言文本配置 - 在新的语言文本配置中拉取其他语言已有的文本配置
- 为新的语言文本配置添加翻译
',5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default};
diff --git a/assets/developer_l10n.md.296175b2.lean.js b/assets/developer_l10n.md.97699e69.lean.js
similarity index 84%
rename from assets/developer_l10n.md.296175b2.lean.js
rename to assets/developer_l10n.md.97699e69.lean.js
index c0b40976..7e17809d 100644
--- a/assets/developer_l10n.md.296175b2.lean.js
+++ b/assets/developer_l10n.md.97699e69.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1717546110000}'),l={name:"developer/l10n.md"},r=t("",5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1717546452000}'),l={name:"developer/l10n.md"},r=t("",5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default};
diff --git a/assets/developer_theme.md.6fd73092.js b/assets/developer_theme.md.b50d2eaf.js
similarity index 96%
rename from assets/developer_theme.md.6fd73092.js
rename to assets/developer_theme.md.b50d2eaf.js
index 9f0c28ca..e79542a0 100644
--- a/assets/developer_theme.md.6fd73092.js
+++ b/assets/developer_theme.md.b50d2eaf.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1717546110000}'),c={name:"developer/theme.md"},l=t('哪吒主题开发环境
哪吒面板提供了主题开发环境,你可以使用它来创建新的哪吒监控主题
WARNING
请注意: 此开发环境仅支持 dashboard v0.13.16
及更新版本。
使用说明
- 克隆此仓库到本地
- 修改
data/config.yaml
中的 Oauth2 配置(回调连接可以填 http://localhost
) - 运行
docker-compose up
- 开始开发
- 主题制作完成之后可以将
theme-custom
放置到服务器上的 /opt/nezha/dashboard/theme-custom
位置
FAQ
- 如果不能使用
80
端口,在 docker-compose.yaml
中修改配置。
',7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1717546452000}'),c={name:"developer/theme.md"},l=t('哪吒主题开发环境
哪吒面板提供了主题开发环境,你可以使用它来创建新的哪吒监控主题
WARNING
请注意: 此开发环境仅支持 dashboard v0.13.16
及更新版本。
使用说明
- 克隆此仓库到本地
- 修改
data/config.yaml
中的 Oauth2 配置(回调连接可以填 http://localhost
) - 运行
docker-compose up
- 开始开发
- 主题制作完成之后可以将
theme-custom
放置到服务器上的 /opt/nezha/dashboard/theme-custom
位置
FAQ
- 如果不能使用
80
端口,在 docker-compose.yaml
中修改配置。
',7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
diff --git a/assets/developer_theme.md.6fd73092.lean.js b/assets/developer_theme.md.b50d2eaf.lean.js
similarity index 84%
rename from assets/developer_theme.md.6fd73092.lean.js
rename to assets/developer_theme.md.b50d2eaf.lean.js
index 4236756b..6ad591ea 100644
--- a/assets/developer_theme.md.6fd73092.lean.js
+++ b/assets/developer_theme.md.b50d2eaf.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1717546110000}'),c={name:"developer/theme.md"},l=t("",7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1717546452000}'),c={name:"developer/theme.md"},l=t("",7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
diff --git a/assets/en_US_case_case1.md.69b18038.js b/assets/en_US_case_case1.md.53b001dd.js
similarity index 95%
rename from assets/en_US_case_case1.md.69b18038.js
rename to assets/en_US_case_case1.md.53b001dd.js
index 10149237..503ea76b 100644
--- a/assets/en_US_case_case1.md.69b18038.js
+++ b/assets/en_US_case_case1.md.53b001dd.js
@@ -1 +1 @@
-import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1717546110000}'),a={name:"en_US/case/case1.md"},n=o('Build your own Telegram bot to query server information
Contributors:
Project: nezha_api_tgbot (Chinese)
Mirror backup, non-real-time update: nezha_api_tgbot (Chinese)
The bot can request server status information from the Dashboard through the API, and then send the information to the user.
You can build this bot to easily view the current status of a given server without opening the Dashboard.
',6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
+import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1717546452000}'),a={name:"en_US/case/case1.md"},n=o('Build your own Telegram bot to query server information
Contributors:
Project: nezha_api_tgbot (Chinese)
Mirror backup, non-real-time update: nezha_api_tgbot (Chinese)
The bot can request server status information from the Dashboard through the API, and then send the information to the user.
You can build this bot to easily view the current status of a given server without opening the Dashboard.
',6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
diff --git a/assets/en_US_case_case1.md.69b18038.lean.js b/assets/en_US_case_case1.md.53b001dd.lean.js
similarity index 86%
rename from assets/en_US_case_case1.md.69b18038.lean.js
rename to assets/en_US_case_case1.md.53b001dd.lean.js
index 90cfca62..f3e2f702 100644
--- a/assets/en_US_case_case1.md.69b18038.lean.js
+++ b/assets/en_US_case_case1.md.53b001dd.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1717546110000}'),a={name:"en_US/case/case1.md"},n=o("",6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
+import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1717546452000}'),a={name:"en_US/case/case1.md"},n=o("",6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
diff --git a/assets/en_US_case_case2.md.156c05ea.js b/assets/en_US_case_case2.md.f0af1fcb.js
similarity index 97%
rename from assets/en_US_case_case2.md.156c05ea.js
rename to assets/en_US_case_case2.md.f0af1fcb.js
index 53250c03..a6a1e687 100644
--- a/assets/en_US_case_case2.md.156c05ea.js
+++ b/assets/en_US_case_case2.md.f0af1fcb.js
@@ -1 +1 @@
-import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1717546110000}'),a={name:"en_US/case/case2.md"},c=s('Use Siri to run shortcut to check server status in iOS/MacOS
Current Version:V1.0 (Chinese)
Contributor:
- 白歌 hhhkkk520
Get shortcut command
Scan the following QR code with your iPhone or iPad to get the shortcut

MacOS users please visit here to get the shortcut
How to use
- After getting the shortcut, open and edit the shortcut
- Fill in
Dashboard URL
, API Token
, Server ID
in the three text boxes - Save the edit and test run, if you can get the result, the setting is correct.
- Modify the name of the shortcut, such as: Server Status, then you can use Siri command: "Hey Siri, Server Status" to get the server status.
WARNING
Each shortcut can only monitor one server, if you need to monitor more than one server, please copy this shortcut several times and configure them separately, then modify the shortcut name separately, such as; Server 1 Status, Server 2 Status, etc.
',8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
+import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1717546452000}'),a={name:"en_US/case/case2.md"},c=s('Use Siri to run shortcut to check server status in iOS/MacOS
Current Version:V1.0 (Chinese)
Contributor:
- 白歌 hhhkkk520
Get shortcut command
Scan the following QR code with your iPhone or iPad to get the shortcut

MacOS users please visit here to get the shortcut
How to use
- After getting the shortcut, open and edit the shortcut
- Fill in
Dashboard URL
, API Token
, Server ID
in the three text boxes - Save the edit and test run, if you can get the result, the setting is correct.
- Modify the name of the shortcut, such as: Server Status, then you can use Siri command: "Hey Siri, Server Status" to get the server status.
WARNING
Each shortcut can only monitor one server, if you need to monitor more than one server, please copy this shortcut several times and configure them separately, then modify the shortcut name separately, such as; Server 1 Status, Server 2 Status, etc.
',8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
diff --git a/assets/en_US_case_case2.md.156c05ea.lean.js b/assets/en_US_case_case2.md.f0af1fcb.lean.js
similarity index 87%
rename from assets/en_US_case_case2.md.156c05ea.lean.js
rename to assets/en_US_case_case2.md.f0af1fcb.lean.js
index 27191c60..17371cc7 100644
--- a/assets/en_US_case_case2.md.156c05ea.lean.js
+++ b/assets/en_US_case_case2.md.f0af1fcb.lean.js
@@ -1 +1 @@
-import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1717546110000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
+import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1717546452000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
diff --git a/assets/en_US_case_case3.md.9d09cd6a.js b/assets/en_US_case_case3.md.799dd2d2.js
similarity index 98%
rename from assets/en_US_case_case3.md.9d09cd6a.js
rename to assets/en_US_case_case3.md.799dd2d2.js
index dea0b360..70440f3d 100644
--- a/assets/en_US_case_case3.md.9d09cd6a.js
+++ b/assets/en_US_case_case3.md.799dd2d2.js
@@ -1 +1 @@
-import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1717546110000}'),d={name:"en_US/case/case3.md"},i=a('Build your own server status query Telegram bot with multi-language and multi-user support
Contributor:
GitHub project: nezha_telegram_bot(English is already supported)
Mirror backup, non-real-time update : nezha_telegram_bot(English is already supported)
Features
- [x] Support Chinese/English multi-language switch
- [x] Support tag statistics (CPU, disk, memory, upstream and downstream speed, traffic statistics, etc.)
- [x] Support real-time refresh of single server data
- [x] Support keyboard interactive query
- [x] Support query by command
- [x] Support adding bot to group, privacy protection of bot replies in group chat
- [x] Support bot messages automatic deletion in group chat within 20 seconds
- [x] Support docker deployment
Commands list
Command Description Private chat only start Getting started with the keyboard main menu ✔️ help help message ❌ add Add Nezha monitoring url link and token ✔️ url Add Nezha monitoring url link ✔️ token Add Nezha monitoring token ✔️ info Get saved Nezha monitoring url link and token ✔️ delete Delete saved Nezha monitoring url link and token ✔️ id Add an integer id after the command to query the information of a single server (refresh button only available in private chat) ❌ all Query statistics for all servers ❌ search Search for keywords in server names (multiple keywords supported, split by spaces) ❌
',9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default};
+import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1717546452000}'),d={name:"en_US/case/case3.md"},i=a('Build your own server status query Telegram bot with multi-language and multi-user support
Contributor:
GitHub project: nezha_telegram_bot(English is already supported)
Mirror backup, non-real-time update : nezha_telegram_bot(English is already supported)
Features
- [x] Support Chinese/English multi-language switch
- [x] Support tag statistics (CPU, disk, memory, upstream and downstream speed, traffic statistics, etc.)
- [x] Support real-time refresh of single server data
- [x] Support keyboard interactive query
- [x] Support query by command
- [x] Support adding bot to group, privacy protection of bot replies in group chat
- [x] Support bot messages automatic deletion in group chat within 20 seconds
- [x] Support docker deployment
Commands list
Command Description Private chat only start Getting started with the keyboard main menu ✔️ help help message ❌ add Add Nezha monitoring url link and token ✔️ url Add Nezha monitoring url link ✔️ token Add Nezha monitoring token ✔️ info Get saved Nezha monitoring url link and token ✔️ delete Delete saved Nezha monitoring url link and token ✔️ id Add an integer id after the command to query the information of a single server (refresh button only available in private chat) ❌ all Query statistics for all servers ❌ search Search for keywords in server names (multiple keywords supported, split by spaces) ❌
',9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default};
diff --git a/assets/en_US_case_case3.md.9d09cd6a.lean.js b/assets/en_US_case_case3.md.799dd2d2.lean.js
similarity index 87%
rename from assets/en_US_case_case3.md.9d09cd6a.lean.js
rename to assets/en_US_case_case3.md.799dd2d2.lean.js
index e2d2d2ca..13a45116 100644
--- a/assets/en_US_case_case3.md.9d09cd6a.lean.js
+++ b/assets/en_US_case_case3.md.799dd2d2.lean.js
@@ -1 +1 @@
-import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1717546110000}'),d={name:"en_US/case/case3.md"},i=a("",9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default};
+import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1717546452000}'),d={name:"en_US/case/case3.md"},i=a("",9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default};
diff --git a/assets/en_US_case_case4.md.e73af4e3.js b/assets/en_US_case_case4.md.3093a6c0.js
similarity index 94%
rename from assets/en_US_case_case4.md.e73af4e3.js
rename to assets/en_US_case_case4.md.3093a6c0.js
index bb785632..d81276a5 100644
--- a/assets/en_US_case_case4.md.e73af4e3.js
+++ b/assets/en_US_case_case4.md.3093a6c0.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1717546110000}'),n={name:"en_US/case/case4.md"},o=r('Fake-agent, monitoring data cheater
Contributor:
GitHub project: fake-nezha-agent(Chinese)
Mirror backup, non-real-time update :fake-nezha-agent(Chinese)
You can modify the monitoring data uploaded to Dashboard by the Agent
Use it for cheating 😈
',5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
+import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1717546452000}'),n={name:"en_US/case/case4.md"},o=r('Fake-agent, monitoring data cheater
Contributor:
GitHub project: fake-nezha-agent(Chinese)
Mirror backup, non-real-time update :fake-nezha-agent(Chinese)
You can modify the monitoring data uploaded to Dashboard by the Agent
Use it for cheating 😈
',5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
diff --git a/assets/en_US_case_case4.md.e73af4e3.lean.js b/assets/en_US_case_case4.md.3093a6c0.lean.js
similarity index 85%
rename from assets/en_US_case_case4.md.e73af4e3.lean.js
rename to assets/en_US_case_case4.md.3093a6c0.lean.js
index a8743a1a..05c74b8d 100644
--- a/assets/en_US_case_case4.md.e73af4e3.lean.js
+++ b/assets/en_US_case_case4.md.3093a6c0.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1717546110000}'),n={name:"en_US/case/case4.md"},o=r("",5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
+import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1717546452000}'),n={name:"en_US/case/case4.md"},o=r("",5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
diff --git a/assets/en_US_case_case5.md.3c6e012a.js b/assets/en_US_case_case5.md.7e187bee.js
similarity index 99%
rename from assets/en_US_case_case5.md.3c6e012a.js
rename to assets/en_US_case_case5.md.7e187bee.js
index b0352ddb..fea70998 100644
--- a/assets/en_US_case_case5.md.3c6e012a.js
+++ b/assets/en_US_case_case5.md.7e187bee.js
@@ -1,4 +1,4 @@
-import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1717546110000}'),n={name:"en_US/case/case5.md"},o=s(`Nezha server over Argo tunnel
Contributors:
GitHub project: Argo-Nezha-Service-Container
Mirror backup (not live update): Argo-Nezha-Service-Container
Catalog
- Project Features
- How to get Argo authentication: json or token
- Variables to be used
- PaaS Deployment Example
- VPS Deployment Method 1 --- docker
- VPS Deployment Method 2 --- hosts
- Client Access
- SSH Access
- Manual Backup data
- Auto Restore Backup
- Manual Restore Backup
- Migrating data
- Main Directory Files and Descriptions
- Acknowledgment of articles and projects by the following authors
- Disclaimer
Project Features.
- Wider scope of application --- As long as there is a network connection, Nezha server can be installed, such as LXC, OpenVZ VPS, Nas Virtual Machine, Container PaaS, etc.
- Argo tunnel breaks through the restriction of requiring a public network portal --- The traditional Nezha requires two public network ports, one for panel visiting and the other for client reporting, this project uses Cloudflare Argo tunnels and uses intranet tunneling.
- IPv4 / v6 with higher flexibility --- The traditional Nezha needs to deal with IPv4/v6 compatibility between server and client, and also needs to resolve mismatches through tools such as warp. However, this project does not need to consider these issues at all, and can be docked arbitrarily, which is much more convenient and easy!
- One Argo tunnel for multiple domains and protocols --- Create an intranet-penetrating Argo tunnel for three domains (hostname) and protocols, which can be used for panel access (http), client reporting (tcp) and ssh (optional).
- GrpcWebProxy reverse proxy gRPC data port --- with a certificate for tls termination, then Argo's tunnel configuration with https service pointing to this reverse proxy, enable http2 back to the source, grpc(nezha)->GrpcWebProxy->h2(argo)->cf cdn edge->agent
- Daily automatic backup --- every day at 04:00 BST, the entire Nezha panel folder is automatically backed up to a designated private github repository, including panel themes, panel settings, probe data and tunnel information, the backup retains nearly 5 days of data; the content is so important that it must be placed in the private repository.
- Automatic daily panel update -- the latest official panel version is automatically detected every day at 4:00 BST, and updated when there is an upgrade.
- Manual/automatic restore backup --- check the content of online restore file once a minute, and restore immediately when there is any update.
- Default built-in local probes --- can easily monitor their own server information
- More secure data --- Argo Tunnel uses TLS encrypted communication to securely transmit application traffic to the Cloudflare network, improving application security and reliability. In addition, Argo Tunnel protects against network threats such as IP leaks and DDoS attacks.

Prepare variables to be used
- Visit the Cloudflare website, select the domain name you want to use, and turn on the
network
option to turn the gRPC
switch on.

- Get github authentication license: https://github.com/settings/applications/new
Add https://
to the beginning of the panel's domain name and /oauth2/callback
to the end of the callback address.


- Get a PAT (Personal Access Token) for github: https://github.com/settings/tokens/new


- Create a private github repository for backups: https://github.com/new

How to get Argo authentication: json or token
Argo tunnel authentication methods include json and token, use one of the two methods. The former is recommended because the script will handle all the Argo tunnel parameters and paths, while the latter needs to be set manually on the Cloudflare website and is prone to errors.
(Methods 1 - Json):
Easily get Argo tunnel json information through Cloudflare Json Generation Network: https://fscarmen.cloudflare.now.cc

(Methods 2 - Token): Manually generate Argo tunnel token information via Cloudflare website.
Go to the cf website: https://dash.cloudflare.com/
- Go to zero trust and generate token tunnel and message.
- The data path 443/https is proto.
- ssh path 22/ssh for < client id >.







PaaS Deployment Example
Image fscarmen/argo-nezha:latest
, supports amd64 and arm64 architectures.
Variables used
Variable Name Required Remarks GH_USER Yes github username for panel admin authorization GH_CLIENTID yes apply on github GH_CLIENTSECRET yes apply on github GH_BACKUP_USER No The github username for backing up Nezha's server-side database on github, if not filled in, it is the same as the account GH_USER for panel management authorization GH_REPO No The github repository for backing up Nezha's server-side database files on github GH_EMAIL No github's mailbox for git push backups to remote repositories GH_PAT No github's PAT ARGO_AUTH Yes Argo Json from https://fscarmen.cloudflare.now.cc
Argo token from Cloudflare official website ARGO_DOMAIN Yes Argo domain
Koyeb





VPS Deployment Method 1 --- docker
- Note: ARGO_DOMAIN= must be followed by single quotes, which cannot be removed.
- If the VPS is IPv6 only, please install WARP IPv4 or dual-stack first: https://github.com/fscarmen/warp
- The backup directory is the dashboard folder in the current path.
docker deployment
docker run -dit \\
+import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1717546452000}'),n={name:"en_US/case/case5.md"},o=s(`Nezha server over Argo tunnel
Contributors:
GitHub project: Argo-Nezha-Service-Container
Mirror backup (not live update): Argo-Nezha-Service-Container
Catalog
- Project Features
- How to get Argo authentication: json or token
- Variables to be used
- PaaS Deployment Example
- VPS Deployment Method 1 --- docker
- VPS Deployment Method 2 --- hosts
- Client Access
- SSH Access
- Manual Backup data
- Auto Restore Backup
- Manual Restore Backup
- Migrating data
- Main Directory Files and Descriptions
- Acknowledgment of articles and projects by the following authors
- Disclaimer
Project Features.
- Wider scope of application --- As long as there is a network connection, Nezha server can be installed, such as LXC, OpenVZ VPS, Nas Virtual Machine, Container PaaS, etc.
- Argo tunnel breaks through the restriction of requiring a public network portal --- The traditional Nezha requires two public network ports, one for panel visiting and the other for client reporting, this project uses Cloudflare Argo tunnels and uses intranet tunneling.
- IPv4 / v6 with higher flexibility --- The traditional Nezha needs to deal with IPv4/v6 compatibility between server and client, and also needs to resolve mismatches through tools such as warp. However, this project does not need to consider these issues at all, and can be docked arbitrarily, which is much more convenient and easy!
- One Argo tunnel for multiple domains and protocols --- Create an intranet-penetrating Argo tunnel for three domains (hostname) and protocols, which can be used for panel access (http), client reporting (tcp) and ssh (optional).
- GrpcWebProxy reverse proxy gRPC data port --- with a certificate for tls termination, then Argo's tunnel configuration with https service pointing to this reverse proxy, enable http2 back to the source, grpc(nezha)->GrpcWebProxy->h2(argo)->cf cdn edge->agent
- Daily automatic backup --- every day at 04:00 BST, the entire Nezha panel folder is automatically backed up to a designated private github repository, including panel themes, panel settings, probe data and tunnel information, the backup retains nearly 5 days of data; the content is so important that it must be placed in the private repository.
- Automatic daily panel update -- the latest official panel version is automatically detected every day at 4:00 BST, and updated when there is an upgrade.
- Manual/automatic restore backup --- check the content of online restore file once a minute, and restore immediately when there is any update.
- Default built-in local probes --- can easily monitor their own server information
- More secure data --- Argo Tunnel uses TLS encrypted communication to securely transmit application traffic to the Cloudflare network, improving application security and reliability. In addition, Argo Tunnel protects against network threats such as IP leaks and DDoS attacks.

Prepare variables to be used
- Visit the Cloudflare website, select the domain name you want to use, and turn on the
network
option to turn the gRPC
switch on.

- Get github authentication license: https://github.com/settings/applications/new
Add https://
to the beginning of the panel's domain name and /oauth2/callback
to the end of the callback address.


- Get a PAT (Personal Access Token) for github: https://github.com/settings/tokens/new


- Create a private github repository for backups: https://github.com/new

How to get Argo authentication: json or token
Argo tunnel authentication methods include json and token, use one of the two methods. The former is recommended because the script will handle all the Argo tunnel parameters and paths, while the latter needs to be set manually on the Cloudflare website and is prone to errors.
(Methods 1 - Json):
Easily get Argo tunnel json information through Cloudflare Json Generation Network: https://fscarmen.cloudflare.now.cc

(Methods 2 - Token): Manually generate Argo tunnel token information via Cloudflare website.
Go to the cf website: https://dash.cloudflare.com/
- Go to zero trust and generate token tunnel and message.
- The data path 443/https is proto.
- ssh path 22/ssh for < client id >.







PaaS Deployment Example
Image fscarmen/argo-nezha:latest
, supports amd64 and arm64 architectures.
Variables used
Variable Name Required Remarks GH_USER Yes github username for panel admin authorization GH_CLIENTID yes apply on github GH_CLIENTSECRET yes apply on github GH_BACKUP_USER No The github username for backing up Nezha's server-side database on github, if not filled in, it is the same as the account GH_USER for panel management authorization GH_REPO No The github repository for backing up Nezha's server-side database files on github GH_EMAIL No github's mailbox for git push backups to remote repositories GH_PAT No github's PAT ARGO_AUTH Yes Argo Json from https://fscarmen.cloudflare.now.cc
Argo token from Cloudflare official website ARGO_DOMAIN Yes Argo domain
Koyeb





VPS Deployment Method 1 --- docker
- Note: ARGO_DOMAIN= must be followed by single quotes, which cannot be removed.
- If the VPS is IPv6 only, please install WARP IPv4 or dual-stack first: https://github.com/fscarmen/warp
- The backup directory is the dashboard folder in the current path.
docker deployment
docker run -dit \\
--name nezha_dashboard \\
--pull always \\
--restart always \\
diff --git a/assets/en_US_case_case5.md.3c6e012a.lean.js b/assets/en_US_case_case5.md.7e187bee.lean.js
similarity index 85%
rename from assets/en_US_case_case5.md.3c6e012a.lean.js
rename to assets/en_US_case_case5.md.7e187bee.lean.js
index d27253b3..36ba2cbb 100644
--- a/assets/en_US_case_case5.md.3c6e012a.lean.js
+++ b/assets/en_US_case_case5.md.7e187bee.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1717546110000}'),n={name:"en_US/case/case5.md"},o=s("",89),r=[o];function l(i,c,h,p,d,u){return a(),t("div",null,r)}const f=e(n,[["render",l]]);export{g as __pageData,f as default};
+import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1717546452000}'),n={name:"en_US/case/case5.md"},o=s("",89),r=[o];function l(i,c,h,p,d,u){return a(),t("div",null,r)}const f=e(n,[["render",l]]);export{g as __pageData,f as default};
diff --git a/assets/en_US_case_index.md.4ce33bf9.js b/assets/en_US_case_index.md.61978637.js
similarity index 95%
rename from assets/en_US_case_index.md.4ce33bf9.js
rename to assets/en_US_case_index.md.61978637.js
index bcca3ca9..50601049 100644
--- a/assets/en_US_case_index.md.4ce33bf9.js
+++ b/assets/en_US_case_index.md.61978637.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1717546110000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1717546452000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default};
diff --git a/assets/en_US_case_index.md.4ce33bf9.lean.js b/assets/en_US_case_index.md.61978637.lean.js
similarity index 95%
rename from assets/en_US_case_index.md.4ce33bf9.lean.js
rename to assets/en_US_case_index.md.61978637.lean.js
index bcca3ca9..50601049 100644
--- a/assets/en_US_case_index.md.4ce33bf9.lean.js
+++ b/assets/en_US_case_index.md.61978637.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1717546110000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1717546452000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default};
diff --git a/assets/en_US_developer_index.md.65e2396c.js b/assets/en_US_developer_index.md.516b4a13.js
similarity index 91%
rename from assets/en_US_developer_index.md.65e2396c.js
rename to assets/en_US_developer_index.md.516b4a13.js
index b600387e..381ecfdb 100644
--- a/assets/en_US_developer_index.md.65e2396c.js
+++ b/assets/en_US_developer_index.md.516b4a13.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1717546110000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1717546452000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default};
diff --git a/assets/en_US_developer_index.md.65e2396c.lean.js b/assets/en_US_developer_index.md.516b4a13.lean.js
similarity index 91%
rename from assets/en_US_developer_index.md.65e2396c.lean.js
rename to assets/en_US_developer_index.md.516b4a13.lean.js
index b600387e..381ecfdb 100644
--- a/assets/en_US_developer_index.md.65e2396c.lean.js
+++ b/assets/en_US_developer_index.md.516b4a13.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1717546110000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1717546452000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default};
diff --git a/assets/en_US_developer_l10n.md.54f6a9bd.js b/assets/en_US_developer_l10n.md.2594a81b.js
similarity index 96%
rename from assets/en_US_developer_l10n.md.54f6a9bd.js
rename to assets/en_US_developer_l10n.md.2594a81b.js
index 46080e3f..5ad023f7 100644
--- a/assets/en_US_developer_l10n.md.54f6a9bd.js
+++ b/assets/en_US_developer_l10n.md.2594a81b.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1717546110000}'),o={name:"en_US/developer/l10n.md"},i=n('Nezha Monitoring's Dashboard has added localization to support multiple languages, and you can follow these steps to support localization when developing new features
Introduction
- You can directly use the text configuration already available in
/resource/l10n/en-US.toml
to replace the text in the new feature. - If there is new text in the new feature, please refer to the configuration text in
en-US.toml
, pull the new text into the configuration files of other languages such as en-US.toml
, and add translations.
Adding a new localized text file
- Add a new language text configuration in
/resource/l10n/
. - Pull existing text configurations from other languages in the new language text configuration.
- Add translations for the new language text configuration.
',5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default};
+import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1717546452000}'),o={name:"en_US/developer/l10n.md"},i=n('Nezha Monitoring's Dashboard has added localization to support multiple languages, and you can follow these steps to support localization when developing new features
Introduction
- You can directly use the text configuration already available in
/resource/l10n/en-US.toml
to replace the text in the new feature. - If there is new text in the new feature, please refer to the configuration text in
en-US.toml
, pull the new text into the configuration files of other languages such as en-US.toml
, and add translations.
Adding a new localized text file
- Add a new language text configuration in
/resource/l10n/
. - Pull existing text configurations from other languages in the new language text configuration.
- Add translations for the new language text configuration.
',5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default};
diff --git a/assets/en_US_developer_l10n.md.54f6a9bd.lean.js b/assets/en_US_developer_l10n.md.2594a81b.lean.js
similarity index 85%
rename from assets/en_US_developer_l10n.md.54f6a9bd.lean.js
rename to assets/en_US_developer_l10n.md.2594a81b.lean.js
index d940c94c..a9b1fcf3 100644
--- a/assets/en_US_developer_l10n.md.54f6a9bd.lean.js
+++ b/assets/en_US_developer_l10n.md.2594a81b.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1717546110000}'),o={name:"en_US/developer/l10n.md"},i=n("",5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default};
+import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1717546452000}'),o={name:"en_US/developer/l10n.md"},i=n("",5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default};
diff --git a/assets/en_US_developer_theme.md.b8f5ef8e.js b/assets/en_US_developer_theme.md.18cd6d02.js
similarity index 96%
rename from assets/en_US_developer_theme.md.b8f5ef8e.js
rename to assets/en_US_developer_theme.md.18cd6d02.js
index ce9bdf02..7290d69f 100644
--- a/assets/en_US_developer_theme.md.b8f5ef8e.js
+++ b/assets/en_US_developer_theme.md.18cd6d02.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1717546110000}'),n={name:"en_US/developer/theme.md"},c=a('Nezha Theme Development Environment
Nezha Monitoring provides a theme development environment that you can use to create new Nezha Monitoring themes
WARNING
Please note: This development environment only supports dashboard v0.13.16
and newer versions.
How to use
- Clone this repository to local
- Modify the Oauth2 configuration in
data/config.yaml
(The callback connection can be filled with http://localhost
) - Run
docker-compose up
- Start development
- Once the theme has been created, you can place
theme-custom
in /opt/nezha/dashboard/theme-custom
on the server
FAQ
- If you can't use port
80
, change the configuration in docker-compose.yaml
.
',7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
+import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1717546452000}'),n={name:"en_US/developer/theme.md"},c=a('Nezha Theme Development Environment
Nezha Monitoring provides a theme development environment that you can use to create new Nezha Monitoring themes
WARNING
Please note: This development environment only supports dashboard v0.13.16
and newer versions.
How to use
- Clone this repository to local
- Modify the Oauth2 configuration in
data/config.yaml
(The callback connection can be filled with http://localhost
) - Run
docker-compose up
- Start development
- Once the theme has been created, you can place
theme-custom
in /opt/nezha/dashboard/theme-custom
on the server
FAQ
- If you can't use port
80
, change the configuration in docker-compose.yaml
.
',7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
diff --git a/assets/en_US_developer_theme.md.b8f5ef8e.lean.js b/assets/en_US_developer_theme.md.18cd6d02.lean.js
similarity index 84%
rename from assets/en_US_developer_theme.md.b8f5ef8e.lean.js
rename to assets/en_US_developer_theme.md.18cd6d02.lean.js
index 5ae8a2c9..5b18087c 100644
--- a/assets/en_US_developer_theme.md.b8f5ef8e.lean.js
+++ b/assets/en_US_developer_theme.md.18cd6d02.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1717546110000}'),n={name:"en_US/developer/theme.md"},c=a("",7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
+import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1717546452000}'),n={name:"en_US/developer/theme.md"},c=a("",7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
diff --git a/assets/en_US_guide_agent.md.0747e1ed.js b/assets/en_US_guide_agent.md.c9376c41.js
similarity index 95%
rename from assets/en_US_guide_agent.md.0747e1ed.js
rename to assets/en_US_guide_agent.md.c9376c41.js
index 120bd795..ba93e5b0 100644
--- a/assets/en_US_guide_agent.md.0747e1ed.js
+++ b/assets/en_US_guide_agent.md.c9376c41.js
@@ -1,4 +1,4 @@
-import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"Install Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1717546110000}'),o={name:"en_US/guide/agent.md"},e=l(`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)
- First, add a server in the admin panel.
- Click the green Linux icon button next to the newly added server and copy the one-click installation command.
- 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
- First, add a server in the admin panel.
- Click the green Windows icon button next to the newly added server and copy the one-click installation command.
- Go to the Windows server, run PowerShell, and execute the copied installation command in PowerShell.
- If you encounter a prompt to "change execution policy," choose Y.
- 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
- First, add a server in the admin panel.
- Run the script on the monitored server:
bashcurl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
- Select “Install monitoring Agent.”
- Enter the communication domain, such as "data.example.com".
- Enter the dashboard communication port (gRPC port), default is 5555.
- 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.
- 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.
- Modify SERVER, SECRET, TLS, and execute in the shell:
shellcat >/etc/init.d/nezha-agent<< EOF
+import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"Install Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1717546452000}'),o={name:"en_US/guide/agent.md"},e=l(`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)
- First, add a server in the admin panel.
- Click the green Linux icon button next to the newly added server and copy the one-click installation command.
- 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
- First, add a server in the admin panel.
- Click the green Windows icon button next to the newly added server and copy the one-click installation command.
- Go to the Windows server, run PowerShell, and execute the copied installation command in PowerShell.
- If you encounter a prompt to "change execution policy," choose Y.
- 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
- First, add a server in the admin panel.
- Run the script on the monitored server:
bashcurl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
- Select “Install monitoring Agent.”
- Enter the communication domain, such as "data.example.com".
- Enter the dashboard communication port (gRPC port), default is 5555.
- 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.
- 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.
- Modify SERVER, SECRET, TLS, and execute in the shell:
shellcat >/etc/init.d/nezha-agent<< EOF
#!/sbin/openrc-run
SERVER="" # Dashboard domain ip:port
SECRET="" # SECRET
diff --git a/assets/en_US_guide_agent.md.0747e1ed.lean.js b/assets/en_US_guide_agent.md.c9376c41.lean.js
similarity index 85%
rename from assets/en_US_guide_agent.md.0747e1ed.lean.js
rename to assets/en_US_guide_agent.md.c9376c41.lean.js
index 7b347fc3..09b31aec 100644
--- a/assets/en_US_guide_agent.md.0747e1ed.lean.js
+++ b/assets/en_US_guide_agent.md.c9376c41.lean.js
@@ -1 +1 @@
-import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"Install Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1717546110000}'),o={name:"en_US/guide/agent.md"},e=l("",29),p=[e];function t(r,c,i,y,D,C){return n(),a("div",null,p)}const d=s(o,[["render",t]]);export{h as __pageData,d as default};
+import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"Install Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1717546452000}'),o={name:"en_US/guide/agent.md"},e=l("",29),p=[e];function t(r,c,i,y,D,C){return n(),a("div",null,p)}const d=s(o,[["render",t]]);export{h as __pageData,d as default};
diff --git a/assets/en_US_guide_agentq.md.df0bf60e.js b/assets/en_US_guide_agentq.md.1b63befc.js
similarity index 97%
rename from assets/en_US_guide_agentq.md.df0bf60e.js
rename to assets/en_US_guide_agentq.md.1b63befc.js
index 9b7b4861..80929d8e 100644
--- a/assets/en_US_guide_agentq.md.df0bf60e.js
+++ b/assets/en_US_guide_agentq.md.1b63befc.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Frequently Asked Questions about the Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1717546110000}'),i={name:"en_US/guide/agentq.md"},o=n('Frequently Asked Questions about the Agent
The IP Displayed in the Admin Panel is Different from the Actual Agent IP?
Please refer to Dashboard Related - Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?. This will not be repeated here.
Errors During One-Click Script Installation
curl: Failed to connect to raw.githubusercontent.com......
This mostly occurs on servers in mainland China. Currently, the one-click script fetches the installation script directly from Github. You may try several times, or manually install the Agent. Additionally, you can find third-party Github acceleration services or mirrors and set them in the one-click installation script.
sudo: command not found
Please manually install sudo first, for example, in Ubuntu:
shellapt install sudo
',9),s=[o];function l(r,c,d,h,u,p){return t(),a("div",null,s)}const g=e(i,[["render",l]]);export{f as __pageData,g as default};
+import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Frequently Asked Questions about the Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1717546452000}'),i={name:"en_US/guide/agentq.md"},o=n('Frequently Asked Questions about the Agent
The IP Displayed in the Admin Panel is Different from the Actual Agent IP?
Please refer to Dashboard Related - Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?. This will not be repeated here.
Errors During One-Click Script Installation
curl: Failed to connect to raw.githubusercontent.com......
This mostly occurs on servers in mainland China. Currently, the one-click script fetches the installation script directly from Github. You may try several times, or manually install the Agent. Additionally, you can find third-party Github acceleration services or mirrors and set them in the one-click installation script.
sudo: command not found
Please manually install sudo first, for example, in Ubuntu:
shellapt install sudo
',9),s=[o];function l(r,c,d,h,u,p){return t(),a("div",null,s)}const g=e(i,[["render",l]]);export{f as __pageData,g as default};
diff --git a/assets/en_US_guide_agentq.md.df0bf60e.lean.js b/assets/en_US_guide_agentq.md.1b63befc.lean.js
similarity index 86%
rename from assets/en_US_guide_agentq.md.df0bf60e.lean.js
rename to assets/en_US_guide_agentq.md.1b63befc.lean.js
index 8746f0e9..67e1c793 100644
--- a/assets/en_US_guide_agentq.md.df0bf60e.lean.js
+++ b/assets/en_US_guide_agentq.md.1b63befc.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Frequently Asked Questions about the Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1717546110000}'),i={name:"en_US/guide/agentq.md"},o=n("",9),s=[o];function l(r,c,d,h,u,p){return t(),a("div",null,s)}const g=e(i,[["render",l]]);export{f as __pageData,g as default};
+import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Frequently Asked Questions about the Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1717546452000}'),i={name:"en_US/guide/agentq.md"},o=n("",9),s=[o];function l(r,c,d,h,u,p){return t(),a("div",null,s)}const g=e(i,[["render",l]]);export{f as __pageData,g as default};
diff --git a/assets/en_US_guide_api.md.75545429.js b/assets/en_US_guide_api.md.5c3d0091.js
similarity index 99%
rename from assets/en_US_guide_api.md.75545429.js
rename to assets/en_US_guide_api.md.5c3d0091.js
index 400fa4d6..a9c751c8 100644
--- a/assets/en_US_guide_api.md.75545429.js
+++ b/assets/en_US_guide_api.md.5c3d0091.js
@@ -1,4 +1,4 @@
-import{_ as s,o as a,c as n,R as o}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"API Interface","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1717546110000}'),l={name:"en_US/guide/api.md"},p=o(`API Interface
Nezha Monitoring supports querying the status information of Agents using the API interface
Creating a Token
Nezha Monitoring's API interface allows for Token authentication and Cookies authentication. To create a new Token, go to the admin panel, click on the avatar in the top right corner, select "API Token," and enter the Token management page. Click "Add Token", add a custom note, and click "Add".
To delete a Token, select the corresponding Token and click the delete icon on the right.
WARNING
Tokens are the authentication credentials for the API interface. They are critical to the security of your Dashboard's information, so do not share your Token with others.
Authentication Method
Ensure the request header contains Authorization: Token
for authentication.
Token authentication method:
Request Headers:
+import{_ as s,o as a,c as n,R as o}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"API Interface","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1717546452000}'),l={name:"en_US/guide/api.md"},p=o(`API Interface
Nezha Monitoring supports querying the status information of Agents using the API interface
Creating a Token
Nezha Monitoring's API interface allows for Token authentication and Cookies authentication. To create a new Token, go to the admin panel, click on the avatar in the top right corner, select "API Token," and enter the Token management page. Click "Add Token", add a custom note, and click "Add".
To delete a Token, select the corresponding Token and click the delete icon on the right.
WARNING
Tokens are the authentication credentials for the API interface. They are critical to the security of your Dashboard's information, so do not share your Token with others.
Authentication Method
Ensure the request header contains Authorization: Token
for authentication.
Token authentication method:
Request Headers:
Authorization: Token
Usage Instructions
WARNING
Negative timestamps in the following examples represent 0000-00-00
. This currently indicates that the Agent has never reported since the Dashboard went online, but it is not recommended to use the positive or negative value to determine the status.
TIP
The request method is GET
, and the response format is JSON
.
Get Server List
Request:
GET /api/v1/server/list?tag=
Parameters:
tag
(optional): ServerTag is the server group. Provide this parameter to query only servers in that group.
Example response:
json{
"code": 0,
"message": "success",
diff --git a/assets/en_US_guide_api.md.75545429.lean.js b/assets/en_US_guide_api.md.5c3d0091.lean.js
similarity index 85%
rename from assets/en_US_guide_api.md.75545429.lean.js
rename to assets/en_US_guide_api.md.5c3d0091.lean.js
index cb043bb7..4bcd0a0f 100644
--- a/assets/en_US_guide_api.md.75545429.lean.js
+++ b/assets/en_US_guide_api.md.5c3d0091.lean.js
@@ -1 +1 @@
-import{_ as s,o as a,c as n,R as o}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"API Interface","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1717546110000}'),l={name:"en_US/guide/api.md"},p=o("",33),e=[p];function t(D,r,c,F,y,C){return a(),n("div",null,e)}const u=s(l,[["render",t]]);export{i as __pageData,u as default};
+import{_ as s,o as a,c as n,R as o}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"API Interface","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1717546452000}'),l={name:"en_US/guide/api.md"},p=o("",33),e=[p];function t(D,r,c,F,y,C){return a(),n("div",null,e)}const u=s(l,[["render",t]]);export{i as __pageData,u as default};
diff --git a/assets/en_US_guide_dashboard.md.645848ac.js b/assets/en_US_guide_dashboard.md.564b15f1.js
similarity index 99%
rename from assets/en_US_guide_dashboard.md.645848ac.js
rename to assets/en_US_guide_dashboard.md.564b15f1.js
index c7ed3c68..454dfb4d 100644
--- a/assets/en_US_guide_dashboard.md.645848ac.js
+++ b/assets/en_US_guide_dashboard.md.564b15f1.js
@@ -1,4 +1,4 @@
-import{_ as a,o as e,c as s,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Install Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1717546110000}'),t={name:"en_US/guide/dashboard.md"},n=o(`Install Dashboard
Preparation
To set up Nezha Monitoring, you need:
- A server with public internet access, with firewall and security policies allowing traffic on ports 8008 and 5555. These ports are necessary for accessing and receiving data. A server with a single core and 512MB of RAM is sufficient for most use cases.
- A domain with an A record set to point to your Dashboard server IP.
TIP
If you want to use a CDN, prepare two domains: one configured with CDN for public access (CDN must support WebSocket protocol), and another domain not using CDN for communication between the Agent and Dashboard.
This document uses "dashboard.example.com" and "data.example.com" as example domains.
- A Github account (or Gitlab, Gitee).
This document uses the aaPanel for reverse proxying the Dashboard as an example. As future versions change, some features may change their entry points. This document is for reference only.
WARNING
This project does not depend on the aaPanel; you can choose any server panel you prefer or manually install Nginx or Caddy to configure SSL and reverse proxy.
If you do not need to use ports 80 and 443 to access the Dashboard, you can directly use the installation script to install and run Nezha Monitoring without installing Nginx.
Obtaining Github Client ID and Secret
Nezha Monitoring uses Github, Gitlab, or Gitee as admin accounts.
- First, create an OAuth application. For Github, log in to Github, open Github OAuth Apps, and select "OAuth Apps" -> "New OAuth App".
Application name
- Fill in as you like.
Homepage URL
- Fill in with the domain for accessing the dashboard, such as "http://dashboard.example.com" (your domain).
Authorization callback URL
- Fill in with the callback address, such as "http://dashboard.example.com/oauth2/callback" (don't forget /oauth2/callback
). - Click “Register application”.
- Save the Client ID on the page, then click “Generate a new client secret” to create a new Client Secret, which will be displayed only once, please keep it safe.
Using Cloudflare Access as OAuth2 Provider
If you encounter issues using Github, Gitlab, or Gitee as admin login, consider switching to using Cloudflare Access as the OAuth2 provider.
Creating a SaaS-OIDC Application
- Go to Zero Trust Dashboard and log in with your Cloudflare account.
My Team
-> Users
-> <specific user>
-> Get User ID
and save it.Access
-> Application
-> Add an Application
.- Choose
SaaS
, enter a custom application name in Application
(e.g., nezha), select OIDC
, and click Add application
. - Select
Scopes
: openid
, email
, profile
, groups
. - Fill in your callback address in
Redirect URLs
, such as https://dashboard.example.com/oauth2/callback
. - Save the
Client ID
, Client Secret
, and Issuer
address (protocol and domain part), e.g., https://xxxxx.cloudflareaccess.com
.
If using this method, after installing the Dashboard, modify the configuration file /opt/nezha/dashboard/data/config.yaml
, and change the Endpoint
configuration to the Issuer
address saved earlier, e.g., https://xxxxx.cloudflareaccess.com
, and restart the Dashboard.
Installing the Dashboard on the Server
Run the installation script on the dashboard server:
bashcurl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
After Docker installation completes, enter the following values:
OAuth provider
- choose one from github, cloudflare, gitlab, gitee.Client ID
- the previously saved Client ID.Client Secret
- the previously saved Client Secret.Username
- the username/User ID from the OAuth provider.Site title
- custom site title.Access port
- public access port, customizable, default is 8008.Agent communication port
- port for Agent and Dashboard communication, default is 5555.
After inputting the values, wait for the image to be pulled.
When the installation completes, you can access the dashboard by visiting your domain and port number, such as “http://dashboard.example.com:8008”.
In the future, if you need to run the script again, run:
bash./nezha.sh
to open the management script.
Configuring Reverse Proxy
Create a new site in the aaPanel, with the domain filled in as the public access domain, such as “http://dashboard.example.com”. Then click “Settings” to enter the site settings options, select “Reverse Proxy” - “New Reverse Proxy”.
Customize a proxy name and fill in http://127.0.0.1
in the "Target URL" below, then click “Save”.
Open the “Configuration File” on the right side of the newly created reverse proxy and replace the configuration file with the following content:
nginx#PROXY-START/
+import{_ as a,o as e,c as s,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Install Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1717546452000}'),t={name:"en_US/guide/dashboard.md"},n=o(`Install Dashboard
Preparation
To set up Nezha Monitoring, you need:
- A server with public internet access, with firewall and security policies allowing traffic on ports 8008 and 5555. These ports are necessary for accessing and receiving data. A server with a single core and 512MB of RAM is sufficient for most use cases.
- A domain with an A record set to point to your Dashboard server IP.
TIP
If you want to use a CDN, prepare two domains: one configured with CDN for public access (CDN must support WebSocket protocol), and another domain not using CDN for communication between the Agent and Dashboard.
This document uses "dashboard.example.com" and "data.example.com" as example domains.
- A Github account (or Gitlab, Gitee).
This document uses the aaPanel for reverse proxying the Dashboard as an example. As future versions change, some features may change their entry points. This document is for reference only.
WARNING
This project does not depend on the aaPanel; you can choose any server panel you prefer or manually install Nginx or Caddy to configure SSL and reverse proxy.
If you do not need to use ports 80 and 443 to access the Dashboard, you can directly use the installation script to install and run Nezha Monitoring without installing Nginx.
Obtaining Github Client ID and Secret
Nezha Monitoring uses Github, Gitlab, or Gitee as admin accounts.
- First, create an OAuth application. For Github, log in to Github, open Github OAuth Apps, and select "OAuth Apps" -> "New OAuth App".
Application name
- Fill in as you like.
Homepage URL
- Fill in with the domain for accessing the dashboard, such as "http://dashboard.example.com" (your domain).
Authorization callback URL
- Fill in with the callback address, such as "http://dashboard.example.com/oauth2/callback" (don't forget /oauth2/callback
). - Click “Register application”.
- Save the Client ID on the page, then click “Generate a new client secret” to create a new Client Secret, which will be displayed only once, please keep it safe.
Using Cloudflare Access as OAuth2 Provider
If you encounter issues using Github, Gitlab, or Gitee as admin login, consider switching to using Cloudflare Access as the OAuth2 provider.
Creating a SaaS-OIDC Application
- Go to Zero Trust Dashboard and log in with your Cloudflare account.
My Team
-> Users
-> <specific user>
-> Get User ID
and save it.Access
-> Application
-> Add an Application
.- Choose
SaaS
, enter a custom application name in Application
(e.g., nezha), select OIDC
, and click Add application
. - Select
Scopes
: openid
, email
, profile
, groups
. - Fill in your callback address in
Redirect URLs
, such as https://dashboard.example.com/oauth2/callback
. - Save the
Client ID
, Client Secret
, and Issuer
address (protocol and domain part), e.g., https://xxxxx.cloudflareaccess.com
.
If using this method, after installing the Dashboard, modify the configuration file /opt/nezha/dashboard/data/config.yaml
, and change the Endpoint
configuration to the Issuer
address saved earlier, e.g., https://xxxxx.cloudflareaccess.com
, and restart the Dashboard.
Installing the Dashboard on the Server
Run the installation script on the dashboard server:
bashcurl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
After Docker installation completes, enter the following values:
OAuth provider
- choose one from github, cloudflare, gitlab, gitee.Client ID
- the previously saved Client ID.Client Secret
- the previously saved Client Secret.Username
- the username/User ID from the OAuth provider.Site title
- custom site title.Access port
- public access port, customizable, default is 8008.Agent communication port
- port for Agent and Dashboard communication, default is 5555.
After inputting the values, wait for the image to be pulled.
When the installation completes, you can access the dashboard by visiting your domain and port number, such as “http://dashboard.example.com:8008”.
In the future, if you need to run the script again, run:
bash./nezha.sh
to open the management script.
Configuring Reverse Proxy
Create a new site in the aaPanel, with the domain filled in as the public access domain, such as “http://dashboard.example.com”. Then click “Settings” to enter the site settings options, select “Reverse Proxy” - “New Reverse Proxy”.
Customize a proxy name and fill in http://127.0.0.1
in the "Target URL" below, then click “Save”.
Open the “Configuration File” on the right side of the newly created reverse proxy and replace the configuration file with the following content:
nginx#PROXY-START/
location / {
proxy_pass http://127.0.0.1:8008;
proxy_set_header Host $http_host;
diff --git a/assets/en_US_guide_dashboard.md.645848ac.lean.js b/assets/en_US_guide_dashboard.md.564b15f1.lean.js
similarity index 86%
rename from assets/en_US_guide_dashboard.md.645848ac.lean.js
rename to assets/en_US_guide_dashboard.md.564b15f1.lean.js
index 4f124400..87996605 100644
--- a/assets/en_US_guide_dashboard.md.645848ac.lean.js
+++ b/assets/en_US_guide_dashboard.md.564b15f1.lean.js
@@ -1 +1 @@
-import{_ as a,o as e,c as s,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Install Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1717546110000}'),t={name:"en_US/guide/dashboard.md"},n=o("",38),l=[n];function r(i,c,p,d,h,u){return e(),s("div",null,l)}const C=a(t,[["render",r]]);export{y as __pageData,C as default};
+import{_ as a,o as e,c as s,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Install Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1717546452000}'),t={name:"en_US/guide/dashboard.md"},n=o("",38),l=[n];function r(i,c,p,d,h,u){return e(),s("div",null,l)}const C=a(t,[["render",r]]);export{y as __pageData,C as default};
diff --git a/assets/en_US_guide_dashboardq.md.128c9ab5.js b/assets/en_US_guide_dashboardq.md.2b6c5e3b.js
similarity index 99%
rename from assets/en_US_guide_dashboardq.md.128c9ab5.js
rename to assets/en_US_guide_dashboardq.md.2b6c5e3b.js
index 6cab9f51..730a6cde 100644
--- a/assets/en_US_guide_dashboardq.md.128c9ab5.js
+++ b/assets/en_US_guide_dashboardq.md.2b6c5e3b.js
@@ -1,4 +1,4 @@
-import{_ as a,o as e,c as t,R as o}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Frequently Asked Questions about the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1717546110000}'),s={name:"en_US/guide/dashboardq.md"},n=o(`Frequently Asked Questions about the Dashboard
Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?
First, let's explain how the IP displayed in the Admin panel is obtained: The Agent periodically requests IP-API to get IP information and reports it to the Dashboard. The currently used IP-API can be viewed here: myip.go.
If you find that the IP displayed in the Admin panel is different from the IP provided by your service provider, it is most likely that the service provider has given you an entry IP, but the Agent is testing your exit IP. This issue can also occur with multi-line servers and IPLC private lines.
TIP
For example, a common scenario is that the service provider gives you a high-defense server. To meet both high defense and low network interruption rate goals, the IP provided may be a mapped high-defense IP rather than your server's real exit IP.
You can also test the exit IP on the Agent server by running the following commands:
shellcurl https://ipapi.co/ip/
+import{_ as a,o as e,c as t,R as o}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Frequently Asked Questions about the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1717546452000}'),s={name:"en_US/guide/dashboardq.md"},n=o(`Frequently Asked Questions about the Dashboard
Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?
First, let's explain how the IP displayed in the Admin panel is obtained: The Agent periodically requests IP-API to get IP information and reports it to the Dashboard. The currently used IP-API can be viewed here: myip.go.
If you find that the IP displayed in the Admin panel is different from the IP provided by your service provider, it is most likely that the service provider has given you an entry IP, but the Agent is testing your exit IP. This issue can also occur with multi-line servers and IPLC private lines.
TIP
For example, a common scenario is that the service provider gives you a high-defense server. To meet both high defense and low network interruption rate goals, the IP provided may be a mapped high-defense IP rather than your server's real exit IP.
You can also test the exit IP on the Agent server by running the following commands:
shellcurl https://ipapi.co/ip/
curl ip.sb
curl ip-api.com
Forgot or Deleted Viewing Password
Please view or edit the /opt/nezha/dashboard/data/config.yaml
file.
The password is located under the site-viewpassword
item.
Dashboard Installation/Restart/Update Failure: iptables ......
First, try restarting Docker before proceeding:
shellsystemctl status docker
systemctl restart docker
diff --git a/assets/en_US_guide_dashboardq.md.128c9ab5.lean.js b/assets/en_US_guide_dashboardq.md.2b6c5e3b.lean.js
similarity index 87%
rename from assets/en_US_guide_dashboardq.md.128c9ab5.lean.js
rename to assets/en_US_guide_dashboardq.md.2b6c5e3b.lean.js
index 7e9caaaa..86f1a8a2 100644
--- a/assets/en_US_guide_dashboardq.md.128c9ab5.lean.js
+++ b/assets/en_US_guide_dashboardq.md.2b6c5e3b.lean.js
@@ -1 +1 @@
-import{_ as a,o as e,c as t,R as o}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Frequently Asked Questions about the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1717546110000}'),s={name:"en_US/guide/dashboardq.md"},n=o("",31),i=[n];function r(l,d,c,p,h,u){return e(),t("div",null,i)}const y=a(s,[["render",r]]);export{f as __pageData,y as default};
+import{_ as a,o as e,c as t,R as o}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Frequently Asked Questions about the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1717546452000}'),s={name:"en_US/guide/dashboardq.md"},n=o("",31),i=[n];function r(l,d,c,p,h,u){return e(),t("div",null,i)}const y=a(s,[["render",r]]);export{f as __pageData,y as default};
diff --git a/assets/en_US_guide_loginq.md.e20982d3.js b/assets/en_US_guide_loginq.md.7ed1ad64.js
similarity index 99%
rename from assets/en_US_guide_loginq.md.e20982d3.js
rename to assets/en_US_guide_loginq.md.7ed1ad64.js
index 9df0e827..3180bcd8 100644
--- a/assets/en_US_guide_loginq.md.e20982d3.js
+++ b/assets/en_US_guide_loginq.md.7ed1ad64.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Frequently Asked Questions about logging into the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1717546110000}'),i={name:"en_US/guide/loginq.md"},n=a('Frequently Asked Questions about logging into the Dashboard
Stuck Page/Connection Refused/Long Response Time After Login Callback
These issues can manifest in various ways, but ultimately the browser cannot display correctly after login.
- Your server cannot connect to Github/Gitee, which is most common when configuring Github on servers in mainland China. You may try several times or switch to Cloudflare Access.
- You have configured the callback address incorrectly. Ensure that your callback address is correct and that both the port and protocol are accurate!
- An unknown error occurred on the Dashboard. You can use a script to check the logs.
TIP
What is a protocol? In the browser, the string that ends your domain with ://
is the protocol, usually http
or https
. Since there may be multiple protocol+domain+port combinations available for accessing the Dashboard in a normal deployment, make sure to choose the most appropriate one as the callback.
How to Check if My Callback Address is Wrong?
Ensure that the protocol+domain+port displayed in the browser before login and after the callback are consistent.
Ensure that your path is /oauth2/callback
, all in lowercase.
Errors After Logging into the Admin Panel
http: named cookie not present
- Clear cookies and log in again, or try a different browser.
- Check the callback address to ensure it is correct and that both the port and protocol are accurate! The address initiating the request must be in the same domain as the callback address, with the port, protocol, and domain (or IP) all matching.
lookup xxx
The container DNS resolution failed, usually due to modified iptables configurations.
It is recommended to restart Docker first, sudo systemctl restart docker
, then restart the Dashboard using the script.
If the lookup error persists, check if there are other tools controlling iptables, such as firewall.
This issue might also be related to the kernel, so try switching to the official kernel.
Invalid authorization method, or the login callback address is invalid, expired, or has been revoked
This issue appears only when using Gitee login, and the reason is unclear. Switching to GitHub is recommended.
oauth2: server response missing access_token
This could be caused by various factors, most likely a network issue. Check your network and try again.
If unresolved, switching to Github or another method is recommended.
The user is not an admin of this site and cannot log in
You logged in with the wrong account or configured the wrong username. Note that the username is not an email, and you can use a script to modify it.
For Cloudflare Access users, note that your username is not an email but a User ID.
dial tcp xxx:443 i/o timeout
This is a network issue. Try restarting Docker first, sudo systemctl restart docker
, then restart the Dashboard using the script.
If you are configuring Github login on a server in mainland China, switching to Cloudflare Access is recommended to avoid network interference.
net/http: TLS handshake timeout
Same as above.
',22),r=[n];function s(l,h,c,d,u,g){return o(),t("div",null,r)}const b=e(i,[["render",s]]);export{m as __pageData,b as default};
+import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Frequently Asked Questions about logging into the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1717546452000}'),i={name:"en_US/guide/loginq.md"},n=a('Frequently Asked Questions about logging into the Dashboard
Stuck Page/Connection Refused/Long Response Time After Login Callback
These issues can manifest in various ways, but ultimately the browser cannot display correctly after login.
- Your server cannot connect to Github/Gitee, which is most common when configuring Github on servers in mainland China. You may try several times or switch to Cloudflare Access.
- You have configured the callback address incorrectly. Ensure that your callback address is correct and that both the port and protocol are accurate!
- An unknown error occurred on the Dashboard. You can use a script to check the logs.
TIP
What is a protocol? In the browser, the string that ends your domain with ://
is the protocol, usually http
or https
. Since there may be multiple protocol+domain+port combinations available for accessing the Dashboard in a normal deployment, make sure to choose the most appropriate one as the callback.
How to Check if My Callback Address is Wrong?
Ensure that the protocol+domain+port displayed in the browser before login and after the callback are consistent.
Ensure that your path is /oauth2/callback
, all in lowercase.
Errors After Logging into the Admin Panel
http: named cookie not present
- Clear cookies and log in again, or try a different browser.
- Check the callback address to ensure it is correct and that both the port and protocol are accurate! The address initiating the request must be in the same domain as the callback address, with the port, protocol, and domain (or IP) all matching.
lookup xxx
The container DNS resolution failed, usually due to modified iptables configurations.
It is recommended to restart Docker first, sudo systemctl restart docker
, then restart the Dashboard using the script.
If the lookup error persists, check if there are other tools controlling iptables, such as firewall.
This issue might also be related to the kernel, so try switching to the official kernel.
Invalid authorization method, or the login callback address is invalid, expired, or has been revoked
This issue appears only when using Gitee login, and the reason is unclear. Switching to GitHub is recommended.
oauth2: server response missing access_token
This could be caused by various factors, most likely a network issue. Check your network and try again.
If unresolved, switching to Github or another method is recommended.
The user is not an admin of this site and cannot log in
You logged in with the wrong account or configured the wrong username. Note that the username is not an email, and you can use a script to modify it.
For Cloudflare Access users, note that your username is not an email but a User ID.
dial tcp xxx:443 i/o timeout
This is a network issue. Try restarting Docker first, sudo systemctl restart docker
, then restart the Dashboard using the script.
If you are configuring Github login on a server in mainland China, switching to Cloudflare Access is recommended to avoid network interference.
net/http: TLS handshake timeout
Same as above.
',22),r=[n];function s(l,h,c,d,u,g){return o(),t("div",null,r)}const b=e(i,[["render",s]]);export{m as __pageData,b as default};
diff --git a/assets/en_US_guide_loginq.md.e20982d3.lean.js b/assets/en_US_guide_loginq.md.7ed1ad64.lean.js
similarity index 87%
rename from assets/en_US_guide_loginq.md.e20982d3.lean.js
rename to assets/en_US_guide_loginq.md.7ed1ad64.lean.js
index 3ca9ff02..6d79e328 100644
--- a/assets/en_US_guide_loginq.md.e20982d3.lean.js
+++ b/assets/en_US_guide_loginq.md.7ed1ad64.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Frequently Asked Questions about logging into the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1717546110000}'),i={name:"en_US/guide/loginq.md"},n=a("",22),r=[n];function s(l,h,c,d,u,g){return o(),t("div",null,r)}const b=e(i,[["render",s]]);export{m as __pageData,b as default};
+import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Frequently Asked Questions about logging into the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1717546452000}'),i={name:"en_US/guide/loginq.md"},n=a("",22),r=[n];function s(l,h,c,d,u,g){return o(),t("div",null,r)}const b=e(i,[["render",s]]);export{m as __pageData,b as default};
diff --git a/assets/en_US_guide_notifications.md.5e830ab8.js b/assets/en_US_guide_notifications.md.9a87dbd0.js
similarity index 99%
rename from assets/en_US_guide_notifications.md.5e830ab8.js
rename to assets/en_US_guide_notifications.md.9a87dbd0.js
index 151cd6e4..f14283d8 100644
--- a/assets/en_US_guide_notifications.md.5e830ab8.js
+++ b/assets/en_US_guide_notifications.md.9a87dbd0.js
@@ -1,4 +1,4 @@
-import{_ as o,o as s,c as a,R as e}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"Notification Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1717546110000}'),n={name:"en_US/guide/notifications.md"},t=e(`Notification Configuration
Nezha Monitoring supports monitoring server load, CPU, memory, disk, traffic, monthly traffic, process count, and connection count, and sending notifications when user-defined thresholds are reached.
Flexible Notification Methods
- In Dashboard messages, the placeholder
#DATETIME#
represents the timestamp of the event. When the notification is triggered, the Dashboard automatically replaces #DATETIME#
with the actual event time. #NEZHA#
is a placeholder for Dashboard messages, and the Dashboard automatically replaces the placeholder with the actual message when the notification is triggered.- The body content is in
JSON
format: When the request type is FORM, the value is in key:value
form, and placeholders can be placed inside value
. The placeholders will be automatically replaced during notification. When the request type is JSON, only simple string replacement is performed before being submitted to the URL
. - Placeholders can also be placed inside the URL, and simple string replacement will be performed during the request.
Refer to the following notification method examples, and you can also flexibly set the push method according to your needs.
Bark Example
Click to expand/collapse
Name: Bark
URL structure: /:key/:body or /:key/:title/:body or /:key/:category/:title/:body
Request Method: GET
Request Type: Default
Body: Empty
Name: Bark
URL structure: /push
Request Method: POST
Request Type: form
Body: {"title": "#SERVER.NAME#","device_key":"xxxxxxxxx","body":"#NEZHA#","icon":"https://xxxxxxxx/nz.png"}
Slack Example Contributor: @白歌
Click to expand/collapse
URL Parameter Acquisition Instructions
Prepare your Slack Workspace in advance and create an App for this Workspace. If you have not created one, you can create an App at Slack API.
After creating the App, you need to add an Incoming Webhook to the App. In the App's settings page, find Incoming Webhooks, enable Activate Incoming Webhooks, and at the bottom of the page, find and click Add New Webhook to Workspace, choose a Channel, and click Allow. After creating, you will get a Webhook URL, which you will use to replace the example URL below.
- Name: Slack
- URL: https://hooks.slack.com/services/xxxxxxxxx/xxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx
- Request Method: POST
- Request Type: JSON
- Body:
{"text":"#NEZHA#"}
Telegram Example Contributor: @白歌
Click to expand/collapse
URL Parameter Acquisition Instructions
Create a bot in Telegram and get the bot's token and your Telegram user ID.
The token and user ID are alphanumeric strings. You can get your user ID by chatting with @userinfobot on Telegram. Create a bot by chatting with @BotFather, and you will get the bot's token.
Replace botXXXXXX with your bot token and YYYYYY with your user ID in the URL below. Note that you need to chat with the bot first, otherwise the bot cannot send messages to you.
- Name: Telegram
- URL: https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&text=#NEZHA#
- Request Method: GET
- Request Type: Default
- Body: Empty
Email Notification Example - Outlook Contributor: @白歌
Click to expand/collapse
Note: SendCloud has a daily free email sending limit. This is just an example. You can choose a paid service or other similar free services. The usage method is similar.
URL Parameter Acquisition Instructions
This example uses SendCloud as the email service. You need to register an account on SendCloud, create a sender email, and then obtain the APIUSER and APIKEY here.
Replace <replaceAPIUSER>
and <replaceAPIKEY>
in the example URL below with your APIUSER and APIKEY, and replace <customSenderEmail>
and <customRecipientEmail>
with any sender and recipient email addresses.
- Name: MS Mail Notification
- URL:https://graph.microsoft.com/v1.0/me/microsoft.graph.sendMail
- Request method: POST
- Request type: JSON
- Header:
{"Content-type":"application/json", "Authorization":"Bearer {Token}"}
- Body:json
{
+import{_ as o,o as s,c as a,R as e}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"Notification Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1717546452000}'),n={name:"en_US/guide/notifications.md"},t=e(`Notification Configuration
Nezha Monitoring supports monitoring server load, CPU, memory, disk, traffic, monthly traffic, process count, and connection count, and sending notifications when user-defined thresholds are reached.
Flexible Notification Methods
- In Dashboard messages, the placeholder
#DATETIME#
represents the timestamp of the event. When the notification is triggered, the Dashboard automatically replaces #DATETIME#
with the actual event time. #NEZHA#
is a placeholder for Dashboard messages, and the Dashboard automatically replaces the placeholder with the actual message when the notification is triggered.- The body content is in
JSON
format: When the request type is FORM, the value is in key:value
form, and placeholders can be placed inside value
. The placeholders will be automatically replaced during notification. When the request type is JSON, only simple string replacement is performed before being submitted to the URL
. - Placeholders can also be placed inside the URL, and simple string replacement will be performed during the request.
Refer to the following notification method examples, and you can also flexibly set the push method according to your needs.
Bark Example
Click to expand/collapse
Name: Bark
URL structure: /:key/:body or /:key/:title/:body or /:key/:category/:title/:body
Request Method: GET
Request Type: Default
Body: Empty
Name: Bark
URL structure: /push
Request Method: POST
Request Type: form
Body: {"title": "#SERVER.NAME#","device_key":"xxxxxxxxx","body":"#NEZHA#","icon":"https://xxxxxxxx/nz.png"}
Slack Example Contributor: @白歌
Click to expand/collapse
URL Parameter Acquisition Instructions
Prepare your Slack Workspace in advance and create an App for this Workspace. If you have not created one, you can create an App at Slack API.
After creating the App, you need to add an Incoming Webhook to the App. In the App's settings page, find Incoming Webhooks, enable Activate Incoming Webhooks, and at the bottom of the page, find and click Add New Webhook to Workspace, choose a Channel, and click Allow. After creating, you will get a Webhook URL, which you will use to replace the example URL below.
- Name: Slack
- URL: https://hooks.slack.com/services/xxxxxxxxx/xxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx
- Request Method: POST
- Request Type: JSON
- Body:
{"text":"#NEZHA#"}
Telegram Example Contributor: @白歌
Click to expand/collapse
URL Parameter Acquisition Instructions
Create a bot in Telegram and get the bot's token and your Telegram user ID.
The token and user ID are alphanumeric strings. You can get your user ID by chatting with @userinfobot on Telegram. Create a bot by chatting with @BotFather, and you will get the bot's token.
Replace botXXXXXX with your bot token and YYYYYY with your user ID in the URL below. Note that you need to chat with the bot first, otherwise the bot cannot send messages to you.
- Name: Telegram
- URL: https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&text=#NEZHA#
- Request Method: GET
- Request Type: Default
- Body: Empty
Email Notification Example - Outlook Contributor: @白歌
Click to expand/collapse
Note: SendCloud has a daily free email sending limit. This is just an example. You can choose a paid service or other similar free services. The usage method is similar.
URL Parameter Acquisition Instructions
This example uses SendCloud as the email service. You need to register an account on SendCloud, create a sender email, and then obtain the APIUSER and APIKEY here.
Replace <replaceAPIUSER>
and <replaceAPIKEY>
in the example URL below with your APIUSER and APIKEY, and replace <customSenderEmail>
and <customRecipientEmail>
with any sender and recipient email addresses.
- Name: MS Mail Notification
- URL:https://graph.microsoft.com/v1.0/me/microsoft.graph.sendMail
- Request method: POST
- Request type: JSON
- Header:
{"Content-type":"application/json", "Authorization":"Bearer {Token}"}
- Body:json
{
"message": {
"subject": "Server Status Notification",
"body": {
diff --git a/assets/en_US_guide_notifications.md.5e830ab8.lean.js b/assets/en_US_guide_notifications.md.9a87dbd0.lean.js
similarity index 86%
rename from assets/en_US_guide_notifications.md.5e830ab8.lean.js
rename to assets/en_US_guide_notifications.md.9a87dbd0.lean.js
index 3ab54fbb..3179b648 100644
--- a/assets/en_US_guide_notifications.md.5e830ab8.lean.js
+++ b/assets/en_US_guide_notifications.md.9a87dbd0.lean.js
@@ -1 +1 @@
-import{_ as o,o as s,c as a,R as e}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"Notification Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1717546110000}'),n={name:"en_US/guide/notifications.md"},t=e("",44),l=[t];function p(r,c,i,u,D,y){return s(),a("div",null,l)}const C=o(n,[["render",p]]);export{F as __pageData,C as default};
+import{_ as o,o as s,c as a,R as e}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"Notification Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1717546452000}'),n={name:"en_US/guide/notifications.md"},t=e("",44),l=[t];function p(r,c,i,u,D,y){return s(),a("div",null,l)}const C=o(n,[["render",p]]);export{F as __pageData,C as default};
diff --git a/assets/en_US_guide_q2.md.abb7eeab.js b/assets/en_US_guide_q2.md.3d129b56.js
similarity index 95%
rename from assets/en_US_guide_q2.md.abb7eeab.js
rename to assets/en_US_guide_q2.md.3d129b56.js
index a3acf21b..808358c5 100644
--- a/assets/en_US_guide_q2.md.abb7eeab.js
+++ b/assets/en_US_guide_q2.md.3d129b56.js
@@ -1 +1 @@
-import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Agent Startup/Online Troubleshooting Process","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q2.md","filePath":"en_US/guide/q2.md","lastUpdated":1717546110000}'),r={name:"en_US/guide/q2.md"},a=n('Agent Startup/Online Troubleshooting Process
- Directly execute
/opt/nezha/agent/nezha-agent -s DashboardIP or non-CDN domain:RPCPort -p AgentKey -d
to check if the logs indicate timeouts due to DNS or poor network conditions. - Use
nc -v Domain/IP RPCPort
or telnet Domain/IP RPCPort
to check for network issues, inspect the inbound and outbound firewalls of the local machine and the panel server. If you cannot determine the issue, you can use the port checking tool provided by https://port.ping.pe/. - If the above steps indicate no issues but the Agent still does not go online correctly, try disabling SELinux. How to disable SELinux?
',2),s=[a];function i(c,l,d,h,p,u){return t(),o("div",null,s)}const f=e(r,[["render",i]]);export{g as __pageData,f as default};
+import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Agent Startup/Online Troubleshooting Process","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q2.md","filePath":"en_US/guide/q2.md","lastUpdated":1717546452000}'),r={name:"en_US/guide/q2.md"},a=n('Agent Startup/Online Troubleshooting Process
- Directly execute
/opt/nezha/agent/nezha-agent -s DashboardIP or non-CDN domain:RPCPort -p AgentKey -d
to check if the logs indicate timeouts due to DNS or poor network conditions. - Use
nc -v Domain/IP RPCPort
or telnet Domain/IP RPCPort
to check for network issues, inspect the inbound and outbound firewalls of the local machine and the panel server. If you cannot determine the issue, you can use the port checking tool provided by https://port.ping.pe/. - If the above steps indicate no issues but the Agent still does not go online correctly, try disabling SELinux. How to disable SELinux?
',2),s=[a];function i(c,l,d,h,p,u){return t(),o("div",null,s)}const f=e(r,[["render",i]]);export{g as __pageData,f as default};
diff --git a/assets/en_US_guide_q2.md.abb7eeab.lean.js b/assets/en_US_guide_q2.md.3d129b56.lean.js
similarity index 85%
rename from assets/en_US_guide_q2.md.abb7eeab.lean.js
rename to assets/en_US_guide_q2.md.3d129b56.lean.js
index b1db474e..80bef1d8 100644
--- a/assets/en_US_guide_q2.md.abb7eeab.lean.js
+++ b/assets/en_US_guide_q2.md.3d129b56.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Agent Startup/Online Troubleshooting Process","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q2.md","filePath":"en_US/guide/q2.md","lastUpdated":1717546110000}'),r={name:"en_US/guide/q2.md"},a=n("",2),s=[a];function i(c,l,d,h,p,u){return t(),o("div",null,s)}const f=e(r,[["render",i]]);export{g as __pageData,f as default};
+import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Agent Startup/Online Troubleshooting Process","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q2.md","filePath":"en_US/guide/q2.md","lastUpdated":1717546452000}'),r={name:"en_US/guide/q2.md"},a=n("",2),s=[a];function i(c,l,d,h,p,u){return t(),o("div",null,s)}const f=e(r,[["render",i]]);export{g as __pageData,f as default};
diff --git a/assets/en_US_guide_q3.md.3401a231.js b/assets/en_US_guide_q3.md.8ce7d80c.js
similarity index 99%
rename from assets/en_US_guide_q3.md.3401a231.js
rename to assets/en_US_guide_q3.md.8ce7d80c.js
index 5bd62a0a..7988119b 100644
--- a/assets/en_US_guide_q3.md.3401a231.js
+++ b/assets/en_US_guide_q3.md.8ce7d80c.js
@@ -1,4 +1,4 @@
-import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"Reverse Proxy gRPC Port (Supports Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q3.md","filePath":"en_US/guide/q3.md","lastUpdated":1717546110000}'),l={name:"en_US/guide/q3.md"},p=o(`Reverse Proxy gRPC Port (Supports Cloudflare CDN)
Using Nginx or Caddy to reverse proxy gRPC
- Nginx Configuration
nginxserver {
+import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"Reverse Proxy gRPC Port (Supports Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q3.md","filePath":"en_US/guide/q3.md","lastUpdated":1717546452000}'),l={name:"en_US/guide/q3.md"},p=o(`Reverse Proxy gRPC Port (Supports Cloudflare CDN)
Using Nginx or Caddy to reverse proxy gRPC
- Nginx Configuration
nginxserver {
listen 443 ssl http2;
listen [::]:443 ssl http2;
server_name data.example.com; # Your domain that the Agent uses to connect to the Dashboard
diff --git a/assets/en_US_guide_q3.md.3401a231.lean.js b/assets/en_US_guide_q3.md.8ce7d80c.lean.js
similarity index 86%
rename from assets/en_US_guide_q3.md.3401a231.lean.js
rename to assets/en_US_guide_q3.md.8ce7d80c.lean.js
index fb05202e..ac41009a 100644
--- a/assets/en_US_guide_q3.md.3401a231.lean.js
+++ b/assets/en_US_guide_q3.md.8ce7d80c.lean.js
@@ -1 +1 @@
-import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"Reverse Proxy gRPC Port (Supports Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q3.md","filePath":"en_US/guide/q3.md","lastUpdated":1717546110000}'),l={name:"en_US/guide/q3.md"},p=o("",15),e=[p];function t(c,r,D,C,y,i){return n(),a("div",null,e)}const d=s(l,[["render",t]]);export{A as __pageData,d as default};
+import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"Reverse Proxy gRPC Port (Supports Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q3.md","filePath":"en_US/guide/q3.md","lastUpdated":1717546452000}'),l={name:"en_US/guide/q3.md"},p=o("",15),e=[p];function t(c,r,D,C,y,i){return n(),a("div",null,e)}const d=s(l,[["render",t]]);export{A as __pageData,d as default};
diff --git a/assets/en_US_guide_q4.md.d5e31a19.js b/assets/en_US_guide_q4.md.610d1745.js
similarity index 95%
rename from assets/en_US_guide_q4.md.d5e31a19.js
rename to assets/en_US_guide_q4.md.610d1745.js
index abe6f2bb..69be1007 100644
--- a/assets/en_US_guide_q4.md.d5e31a19.js
+++ b/assets/en_US_guide_q4.md.610d1745.js
@@ -1 +1 @@
-import{_ as a,o as i,c as o,z as e,a as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Real-Time Channel Disconnection/Online Terminal Connection Failure","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md","filePath":"en_US/guide/q4.md","lastUpdated":1717546110000}'),t={name:"en_US/guide/q4.md"},r=e("h1",{id:"real-time-channel-disconnection-online-terminal-connection-failure",tabindex:"-1"},[n("Real-Time Channel Disconnection/Online Terminal Connection Failure "),e("a",{class:"header-anchor",href:"#real-time-channel-disconnection-online-terminal-connection-failure","aria-label":'Permalink to "Real-Time Channel Disconnection/Online Terminal Connection Failure"'},"")],-1),l=e("ul",null,[e("li",null,"If you are using a CDN, ensure that the CDN provider offers WebSocket services and that WebSocket is enabled."),e("li",null,[n("Confirm that your reverse proxy rules have special configurations for the "),e("code",null,"/ws"),n(" and "),e("code",null,"/terminal"),n(" paths. You can "),e("a",{href:"/en_US/guide/dashboard.html#configure-reverse-proxy"},"click here"),n(" to view the reverse proxy configuration.")])],-1),c=[r,l];function s(d,u,h,m,_,f){return i(),o("div",null,c)}const v=a(t,[["render",s]]);export{g as __pageData,v as default};
+import{_ as a,o as i,c as o,z as e,a as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Real-Time Channel Disconnection/Online Terminal Connection Failure","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md","filePath":"en_US/guide/q4.md","lastUpdated":1717546452000}'),t={name:"en_US/guide/q4.md"},r=e("h1",{id:"real-time-channel-disconnection-online-terminal-connection-failure",tabindex:"-1"},[n("Real-Time Channel Disconnection/Online Terminal Connection Failure "),e("a",{class:"header-anchor",href:"#real-time-channel-disconnection-online-terminal-connection-failure","aria-label":'Permalink to "Real-Time Channel Disconnection/Online Terminal Connection Failure"'},"")],-1),l=e("ul",null,[e("li",null,"If you are using a CDN, ensure that the CDN provider offers WebSocket services and that WebSocket is enabled."),e("li",null,[n("Confirm that your reverse proxy rules have special configurations for the "),e("code",null,"/ws"),n(" and "),e("code",null,"/terminal"),n(" paths. You can "),e("a",{href:"/en_US/guide/dashboard.html#configure-reverse-proxy"},"click here"),n(" to view the reverse proxy configuration.")])],-1),c=[r,l];function s(d,u,h,m,_,f){return i(),o("div",null,c)}const v=a(t,[["render",s]]);export{g as __pageData,v as default};
diff --git a/assets/en_US_guide_q4.md.d5e31a19.lean.js b/assets/en_US_guide_q4.md.610d1745.lean.js
similarity index 95%
rename from assets/en_US_guide_q4.md.d5e31a19.lean.js
rename to assets/en_US_guide_q4.md.610d1745.lean.js
index abe6f2bb..69be1007 100644
--- a/assets/en_US_guide_q4.md.d5e31a19.lean.js
+++ b/assets/en_US_guide_q4.md.610d1745.lean.js
@@ -1 +1 @@
-import{_ as a,o as i,c as o,z as e,a as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Real-Time Channel Disconnection/Online Terminal Connection Failure","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md","filePath":"en_US/guide/q4.md","lastUpdated":1717546110000}'),t={name:"en_US/guide/q4.md"},r=e("h1",{id:"real-time-channel-disconnection-online-terminal-connection-failure",tabindex:"-1"},[n("Real-Time Channel Disconnection/Online Terminal Connection Failure "),e("a",{class:"header-anchor",href:"#real-time-channel-disconnection-online-terminal-connection-failure","aria-label":'Permalink to "Real-Time Channel Disconnection/Online Terminal Connection Failure"'},"")],-1),l=e("ul",null,[e("li",null,"If you are using a CDN, ensure that the CDN provider offers WebSocket services and that WebSocket is enabled."),e("li",null,[n("Confirm that your reverse proxy rules have special configurations for the "),e("code",null,"/ws"),n(" and "),e("code",null,"/terminal"),n(" paths. You can "),e("a",{href:"/en_US/guide/dashboard.html#configure-reverse-proxy"},"click here"),n(" to view the reverse proxy configuration.")])],-1),c=[r,l];function s(d,u,h,m,_,f){return i(),o("div",null,c)}const v=a(t,[["render",s]]);export{g as __pageData,v as default};
+import{_ as a,o as i,c as o,z as e,a as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Real-Time Channel Disconnection/Online Terminal Connection Failure","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md","filePath":"en_US/guide/q4.md","lastUpdated":1717546452000}'),t={name:"en_US/guide/q4.md"},r=e("h1",{id:"real-time-channel-disconnection-online-terminal-connection-failure",tabindex:"-1"},[n("Real-Time Channel Disconnection/Online Terminal Connection Failure "),e("a",{class:"header-anchor",href:"#real-time-channel-disconnection-online-terminal-connection-failure","aria-label":'Permalink to "Real-Time Channel Disconnection/Online Terminal Connection Failure"'},"")],-1),l=e("ul",null,[e("li",null,"If you are using a CDN, ensure that the CDN provider offers WebSocket services and that WebSocket is enabled."),e("li",null,[n("Confirm that your reverse proxy rules have special configurations for the "),e("code",null,"/ws"),n(" and "),e("code",null,"/terminal"),n(" paths. You can "),e("a",{href:"/en_US/guide/dashboard.html#configure-reverse-proxy"},"click here"),n(" to view the reverse proxy configuration.")])],-1),c=[r,l];function s(d,u,h,m,_,f){return i(),o("div",null,c)}const v=a(t,[["render",s]]);export{g as __pageData,v as default};
diff --git a/assets/en_US_guide_q5.md.477c87ee.js b/assets/en_US_guide_q5.md.1a18f39e.js
similarity index 94%
rename from assets/en_US_guide_q5.md.477c87ee.js
rename to assets/en_US_guide_q5.md.1a18f39e.js
index 6bb5bce7..e8135899 100644
--- a/assets/en_US_guide_q5.md.477c87ee.js
+++ b/assets/en_US_guide_q5.md.1a18f39e.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"How to Perform Data Migration and Backup Recovery?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q5.md","filePath":"en_US/guide/q5.md","lastUpdated":1717546110000}'),r={name:"en_US/guide/q5.md"},n=t('How to Perform Data Migration and Backup Recovery?
- Run the one-click script and choose
Stop Dashboard
. - On the old server, package the
/opt/nezha
folder, copy it to the same location in the new environment, and extract it. - In the new server, run the one-click script and choose
Start Dashboard
.
',2),c=[n];function i(d,s,_,l,h,p){return o(),a("div",null,c)}const f=e(r,[["render",i]]);export{u as __pageData,f as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"How to Perform Data Migration and Backup Recovery?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q5.md","filePath":"en_US/guide/q5.md","lastUpdated":1717546452000}'),r={name:"en_US/guide/q5.md"},n=t('How to Perform Data Migration and Backup Recovery?
- Run the one-click script and choose
Stop Dashboard
. - On the old server, package the
/opt/nezha
folder, copy it to the same location in the new environment, and extract it. - In the new server, run the one-click script and choose
Start Dashboard
.
',2),c=[n];function i(d,s,_,l,h,p){return o(),a("div",null,c)}const f=e(r,[["render",i]]);export{u as __pageData,f as default};
diff --git a/assets/en_US_guide_q5.md.477c87ee.lean.js b/assets/en_US_guide_q5.md.1a18f39e.lean.js
similarity index 85%
rename from assets/en_US_guide_q5.md.477c87ee.lean.js
rename to assets/en_US_guide_q5.md.1a18f39e.lean.js
index 607e706e..0a3cea2e 100644
--- a/assets/en_US_guide_q5.md.477c87ee.lean.js
+++ b/assets/en_US_guide_q5.md.1a18f39e.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"How to Perform Data Migration and Backup Recovery?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q5.md","filePath":"en_US/guide/q5.md","lastUpdated":1717546110000}'),r={name:"en_US/guide/q5.md"},n=t("",2),c=[n];function i(d,s,_,l,h,p){return o(),a("div",null,c)}const f=e(r,[["render",i]]);export{u as __pageData,f as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"How to Perform Data Migration and Backup Recovery?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q5.md","filePath":"en_US/guide/q5.md","lastUpdated":1717546452000}'),r={name:"en_US/guide/q5.md"},n=t("",2),c=[n];function i(d,s,_,l,h,p){return o(),a("div",null,c)}const f=e(r,[["render",i]]);export{u as __pageData,f as default};
diff --git a/assets/en_US_guide_q6.md.dd701652.js b/assets/en_US_guide_q6.md.87462315.js
similarity index 95%
rename from assets/en_US_guide_q6.md.dd701652.js
rename to assets/en_US_guide_q6.md.87462315.js
index 2a87b99f..e16eea61 100644
--- a/assets/en_US_guide_q6.md.dd701652.js
+++ b/assets/en_US_guide_q6.md.87462315.js
@@ -1 +1 @@
-import{_ as t,o as e,c as o,R as i}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"How to Reset Traffic Statistics Monthly?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q6.md","filePath":"en_US/guide/q6.md","lastUpdated":1717546110000}'),a={name:"en_US/guide/q6.md"},s=i('How to Reset Traffic Statistics Monthly?
The traffic statistics on the homepage reset every time the server restarts. To achieve a monthly reset of the traffic counter, you can do the following:
- Go to the
Notification
page in the management panel. - Refer to this document to create a monthly traffic notification.
- Return to the homepage and go to the
Services
page, where you can see the monthly traffic statistics. The statistics here will not reset when the server restarts.
TIP
This method allows you to set any period, including but not limited to hourly, daily, weekly, monthly, or yearly traffic statistics reset, offering great flexibility!
',4),c=[s];function r(n,l,h,f,d,_){return e(),o("div",null,c)}const u=t(a,[["render",r]]);export{p as __pageData,u as default};
+import{_ as t,o as e,c as o,R as i}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"How to Reset Traffic Statistics Monthly?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q6.md","filePath":"en_US/guide/q6.md","lastUpdated":1717546452000}'),a={name:"en_US/guide/q6.md"},s=i('How to Reset Traffic Statistics Monthly?
The traffic statistics on the homepage reset every time the server restarts. To achieve a monthly reset of the traffic counter, you can do the following:
- Go to the
Notification
page in the management panel. - Refer to this document to create a monthly traffic notification.
- Return to the homepage and go to the
Services
page, where you can see the monthly traffic statistics. The statistics here will not reset when the server restarts.
TIP
This method allows you to set any period, including but not limited to hourly, daily, weekly, monthly, or yearly traffic statistics reset, offering great flexibility!
',4),c=[s];function r(n,l,h,f,d,_){return e(),o("div",null,c)}const u=t(a,[["render",r]]);export{p as __pageData,u as default};
diff --git a/assets/en_US_guide_q6.md.dd701652.lean.js b/assets/en_US_guide_q6.md.87462315.lean.js
similarity index 85%
rename from assets/en_US_guide_q6.md.dd701652.lean.js
rename to assets/en_US_guide_q6.md.87462315.lean.js
index cc59e7ca..df12d2a2 100644
--- a/assets/en_US_guide_q6.md.dd701652.lean.js
+++ b/assets/en_US_guide_q6.md.87462315.lean.js
@@ -1 +1 @@
-import{_ as t,o as e,c as o,R as i}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"How to Reset Traffic Statistics Monthly?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q6.md","filePath":"en_US/guide/q6.md","lastUpdated":1717546110000}'),a={name:"en_US/guide/q6.md"},s=i("",4),c=[s];function r(n,l,h,f,d,_){return e(),o("div",null,c)}const u=t(a,[["render",r]]);export{p as __pageData,u as default};
+import{_ as t,o as e,c as o,R as i}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"How to Reset Traffic Statistics Monthly?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q6.md","filePath":"en_US/guide/q6.md","lastUpdated":1717546452000}'),a={name:"en_US/guide/q6.md"},s=i("",4),c=[s];function r(n,l,h,f,d,_){return e(),o("div",null,c)}const u=t(a,[["render",r]]);export{p as __pageData,u as default};
diff --git a/assets/en_US_guide_q7.md.db51c3db.js b/assets/en_US_guide_q7.md.54ba9420.js
similarity index 98%
rename from assets/en_US_guide_q7.md.db51c3db.js
rename to assets/en_US_guide_q7.md.54ba9420.js
index 501b91bb..a3606453 100644
--- a/assets/en_US_guide_q7.md.db51c3db.js
+++ b/assets/en_US_guide_q7.md.54ba9420.js
@@ -1 +1 @@
-import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Custom Agent Monitoring Projects","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q7.md","filePath":"en_US/guide/q7.md","lastUpdated":1717546110000}'),a={name:"en_US/guide/q7.md"},s=n('Custom Agent Monitoring Projects
Customizing Monitored Network Interfaces and Disk Partitions
Execute the following command to select custom network interfaces and partitions, then restart the Agent for the changes to take effect:
bash/opt/nezha/agent/nezha-agent --edit-agent-config
Other Runtime Parameters
To view the supported parameters, execute:
bash./nezha-agent --help
If you installed the Agent using the one-click script, you can edit /etc/systemd/system/nezha-agent.service
and add the following parameters at the end of the ExecStart=
line:
--report-delay
: Controls the interval for reporting system information. The default is 1 second. You can set it to 3 to further reduce the agent's system resource usage (configuration range: 1-4).--skip-conn
: Does not monitor connection counts. Recommended for servers with high connection density or high CPU usage.--skip-procs
: Does not monitor process counts, which can also reduce Agent resource usage.--disable-auto-update
: Disables automatic updates for the Agent (security feature).--disable-force-update
: Disables forced updates for the Agent (security feature).--disable-command-execute
: Disables the execution of scheduled tasks and the opening of the online terminal on the Agent (security feature).--tls
: Enables SSL/TLS encryption (required if you use nginx to reverse proxy the Agent's gRPC connection and nginx has SSL/TLS enabled).
',9),i=[s];function r(c,d,l,p,u,h){return t(),o("div",null,i)}const f=e(a,[["render",r]]);export{m as __pageData,f as default};
+import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Custom Agent Monitoring Projects","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q7.md","filePath":"en_US/guide/q7.md","lastUpdated":1717546452000}'),a={name:"en_US/guide/q7.md"},s=n('Custom Agent Monitoring Projects
Customizing Monitored Network Interfaces and Disk Partitions
Execute the following command to select custom network interfaces and partitions, then restart the Agent for the changes to take effect:
bash/opt/nezha/agent/nezha-agent --edit-agent-config
Other Runtime Parameters
To view the supported parameters, execute:
bash./nezha-agent --help
If you installed the Agent using the one-click script, you can edit /etc/systemd/system/nezha-agent.service
and add the following parameters at the end of the ExecStart=
line:
--report-delay
: Controls the interval for reporting system information. The default is 1 second. You can set it to 3 to further reduce the agent's system resource usage (configuration range: 1-4).--skip-conn
: Does not monitor connection counts. Recommended for servers with high connection density or high CPU usage.--skip-procs
: Does not monitor process counts, which can also reduce Agent resource usage.--disable-auto-update
: Disables automatic updates for the Agent (security feature).--disable-force-update
: Disables forced updates for the Agent (security feature).--disable-command-execute
: Disables the execution of scheduled tasks and the opening of the online terminal on the Agent (security feature).--tls
: Enables SSL/TLS encryption (required if you use nginx to reverse proxy the Agent's gRPC connection and nginx has SSL/TLS enabled).
',9),i=[s];function r(c,d,l,p,u,h){return t(),o("div",null,i)}const f=e(a,[["render",r]]);export{m as __pageData,f as default};
diff --git a/assets/en_US_guide_q7.md.db51c3db.lean.js b/assets/en_US_guide_q7.md.54ba9420.lean.js
similarity index 85%
rename from assets/en_US_guide_q7.md.db51c3db.lean.js
rename to assets/en_US_guide_q7.md.54ba9420.lean.js
index 2e2ee450..0c0edcd9 100644
--- a/assets/en_US_guide_q7.md.db51c3db.lean.js
+++ b/assets/en_US_guide_q7.md.54ba9420.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Custom Agent Monitoring Projects","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q7.md","filePath":"en_US/guide/q7.md","lastUpdated":1717546110000}'),a={name:"en_US/guide/q7.md"},s=n("",9),i=[s];function r(c,d,l,p,u,h){return t(),o("div",null,i)}const f=e(a,[["render",r]]);export{m as __pageData,f as default};
+import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Custom Agent Monitoring Projects","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q7.md","filePath":"en_US/guide/q7.md","lastUpdated":1717546452000}'),a={name:"en_US/guide/q7.md"},s=n("",9),i=[s];function r(c,d,l,p,u,h){return t(),o("div",null,i)}const f=e(a,[["render",r]]);export{m as __pageData,f as default};
diff --git a/assets/en_US_guide_q8.md.f19892de.js b/assets/en_US_guide_q8.md.47658763.js
similarity index 98%
rename from assets/en_US_guide_q8.md.f19892de.js
rename to assets/en_US_guide_q8.md.47658763.js
index 959e4562..d2b64c00 100644
--- a/assets/en_US_guide_q8.md.f19892de.js
+++ b/assets/en_US_guide_q8.md.47658763.js
@@ -1,4 +1,4 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Cloudflare Access OAuth2 Configuration","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q8.md","filePath":"en_US/guide/q8.md","lastUpdated":1717546110000}'),c={name:"en_US/guide/q8.md"},n=t(`Cloudflare Access OAuth2 Configuration
If you encounter issues logging in as an administrator using Github, Gitlab, or Gitee, you may consider switching to Cloudflare Access as the OAuth2 provider.
Example Configuration:
yamlOauth2:
+import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Cloudflare Access OAuth2 Configuration","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q8.md","filePath":"en_US/guide/q8.md","lastUpdated":1717546452000}'),c={name:"en_US/guide/q8.md"},n=t(`Cloudflare Access OAuth2 Configuration
If you encounter issues logging in as an administrator using Github, Gitlab, or Gitee, you may consider switching to Cloudflare Access as the OAuth2 provider.
Example Configuration:
yamlOauth2:
Admin: 701b9ea6-9f56-48cd-af3e-cbb4bfc1475c
ClientID: 3516291f53eca9b4901a01337e41be7dc52f565c8657d08a3fddb2178d13c5bf
ClientSecret: 0568b67c7b6d0ed51c663e2fe935683007c28f947a27b7bd47a5ad3d8b56fb67
diff --git a/assets/en_US_guide_q8.md.f19892de.lean.js b/assets/en_US_guide_q8.md.47658763.lean.js
similarity index 85%
rename from assets/en_US_guide_q8.md.f19892de.lean.js
rename to assets/en_US_guide_q8.md.47658763.lean.js
index d101e626..3ab31262 100644
--- a/assets/en_US_guide_q8.md.f19892de.lean.js
+++ b/assets/en_US_guide_q8.md.47658763.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Cloudflare Access OAuth2 Configuration","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q8.md","filePath":"en_US/guide/q8.md","lastUpdated":1717546110000}'),c={name:"en_US/guide/q8.md"},n=t("",11),s=[n];function i(l,d,r,p,u,h){return o(),a("div",null,s)}const C=e(c,[["render",i]]);export{g as __pageData,C as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Cloudflare Access OAuth2 Configuration","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q8.md","filePath":"en_US/guide/q8.md","lastUpdated":1717546452000}'),c={name:"en_US/guide/q8.md"},n=t("",11),s=[n];function i(l,d,r,p,u,h){return o(),a("div",null,s)}const C=e(c,[["render",i]]);export{g as __pageData,C as default};
diff --git a/assets/en_US_guide_servers.md.72116048.js b/assets/en_US_guide_servers.md.821981e8.js
similarity index 99%
rename from assets/en_US_guide_servers.md.72116048.js
rename to assets/en_US_guide_servers.md.821981e8.js
index e5fafc03..35f2e0c6 100644
--- a/assets/en_US_guide_servers.md.72116048.js
+++ b/assets/en_US_guide_servers.md.821981e8.js
@@ -1,4 +1,4 @@
-import{_ as e,o,c as s,R as n}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Server Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/servers.md","filePath":"en_US/guide/servers.md","lastUpdated":1717546110000}'),a={name:"en_US/guide/servers.md"},l=n(`Server Management
Introduction
The server section is responsible for managing Agents, forming the most fundamental part of Nezha monitoring and serving as the basis for other functionalities.
Adding a Server
The first step is to add a server, where you can customize the name, group, sorting, and notes.
Servers in the same group will be displayed together in supported themes. Notes will only be visible in the Admin Panel, so there's no need to worry about leaking information.
Installing the Agent
Please refer to the previous section on installing the Agent.
It is recommended to use the one-click installation. After configuring the parameters, click the corresponding system icon in the one-click installation column of the server to copy the installation command and execute it on the respective server.
Forced Update
Agent update-related parameters include --disable-auto-update
and --disable-force-update
as described in Custom Agent Monitoring Projects.
By default, the Agent will update automatically without intervention. However, if the user disables automatic updates, you can select specific servers for a forced update.
The forced update will not work if disable-force-update
is enabled.
Data Columns
- Version: Records the current version of the Agent.
- Hide from Guests: When true, guests cannot see this server in the Dashboard.
- Enable DDNS: When true, if the server IP changes, the Dashboard will automatically update the DNS records.
- DDNS Domain: The DDNS domain configured for this server.
- Secret: The secret/key used for configuring the Agent, which is used to verify communication between the Agent and the Dashboard.
- One-Click Install: Click the corresponding system button to copy the command and execute it on the server for a one-click installation.
- Management: Connects to WebShell, modifies server configuration, or deletes the server.
WebSSH Terminal
This is WebShell; the feature will not work if disable-command-execute
is enabled.
It is available for both Linux and Windows and supports Ctrl+Shift+V for pasting.
If the connection fails, refer to Real-Time Channel Disconnection/Online Terminal Connection Failure.
Note that in the WebSSH terminal function, the Agent connects to the public access domain via WebSocket, not through gRPC.
DDNS Functionality
The DDNS functionality is suitable for servers with dynamic IPs. When the Agent reports a new IP, the Dashboard will automatically update the DNS records based on the configuration.
Why Use Nezha Monitoring's DDNS Functionality?
- Centralized management of DDNS settings instead of deploying a DDNS service on each server.
- Confidential information is only stored on the Dashboard server, preventing leakage.
Configuration Instructions
Currently, the DDNS functionality supports two configuration forms: single configuration and multiple configurations. If single configuration is used, all Agent servers will use the same configuration to update DDNS. If multiple configurations are used, each server can be assigned a specific configuration to update DDNS, offering greater flexibility.
Single Configuration
yamlDDNS:
+import{_ as e,o,c as s,R as n}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Server Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/servers.md","filePath":"en_US/guide/servers.md","lastUpdated":1717546452000}'),a={name:"en_US/guide/servers.md"},l=n(`Server Management
Introduction
The server section is responsible for managing Agents, forming the most fundamental part of Nezha monitoring and serving as the basis for other functionalities.
Adding a Server
The first step is to add a server, where you can customize the name, group, sorting, and notes.
Servers in the same group will be displayed together in supported themes. Notes will only be visible in the Admin Panel, so there's no need to worry about leaking information.
Installing the Agent
Please refer to the previous section on installing the Agent.
It is recommended to use the one-click installation. After configuring the parameters, click the corresponding system icon in the one-click installation column of the server to copy the installation command and execute it on the respective server.
Forced Update
Agent update-related parameters include --disable-auto-update
and --disable-force-update
as described in Custom Agent Monitoring Projects.
By default, the Agent will update automatically without intervention. However, if the user disables automatic updates, you can select specific servers for a forced update.
The forced update will not work if disable-force-update
is enabled.
Data Columns
- Version: Records the current version of the Agent.
- Hide from Guests: When true, guests cannot see this server in the Dashboard.
- Enable DDNS: When true, if the server IP changes, the Dashboard will automatically update the DNS records.
- DDNS Domain: The DDNS domain configured for this server.
- Secret: The secret/key used for configuring the Agent, which is used to verify communication between the Agent and the Dashboard.
- One-Click Install: Click the corresponding system button to copy the command and execute it on the server for a one-click installation.
- Management: Connects to WebShell, modifies server configuration, or deletes the server.
WebSSH Terminal
This is WebShell; the feature will not work if disable-command-execute
is enabled.
It is available for both Linux and Windows and supports Ctrl+Shift+V for pasting.
If the connection fails, refer to Real-Time Channel Disconnection/Online Terminal Connection Failure.
Note that in the WebSSH terminal function, the Agent connects to the public access domain via WebSocket, not through gRPC.
DDNS Functionality
The DDNS functionality is suitable for servers with dynamic IPs. When the Agent reports a new IP, the Dashboard will automatically update the DNS records based on the configuration.
Why Use Nezha Monitoring's DDNS Functionality?
- Centralized management of DDNS settings instead of deploying a DDNS service on each server.
- Confidential information is only stored on the Dashboard server, preventing leakage.
Configuration Instructions
Currently, the DDNS functionality supports two configuration forms: single configuration and multiple configurations. If single configuration is used, all Agent servers will use the same configuration to update DDNS. If multiple configurations are used, each server can be assigned a specific configuration to update DDNS, offering greater flexibility.
Single Configuration
yamlDDNS:
Enable: true
Provider: "webhook"
AccessID: ""
diff --git a/assets/en_US_guide_servers.md.72116048.lean.js b/assets/en_US_guide_servers.md.821981e8.lean.js
similarity index 85%
rename from assets/en_US_guide_servers.md.72116048.lean.js
rename to assets/en_US_guide_servers.md.821981e8.lean.js
index cfa413a4..646b6181 100644
--- a/assets/en_US_guide_servers.md.72116048.lean.js
+++ b/assets/en_US_guide_servers.md.821981e8.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as s,R as n}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Server Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/servers.md","filePath":"en_US/guide/servers.md","lastUpdated":1717546110000}'),a={name:"en_US/guide/servers.md"},l=n("",39),t=[l];function i(r,c,p,d,u,h){return o(),s("div",null,t)}const g=e(a,[["render",i]]);export{y as __pageData,g as default};
+import{_ as e,o,c as s,R as n}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Server Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/servers.md","filePath":"en_US/guide/servers.md","lastUpdated":1717546452000}'),a={name:"en_US/guide/servers.md"},l=n("",39),t=[l];function i(r,c,p,d,u,h){return o(),s("div",null,t)}const g=e(a,[["render",i]]);export{y as __pageData,g as default};
diff --git a/assets/en_US_guide_services.md.1f68d826.js b/assets/en_US_guide_services.md.29090992.js
similarity index 98%
rename from assets/en_US_guide_services.md.1f68d826.js
rename to assets/en_US_guide_services.md.29090992.js
index 088354e4..bfa7230b 100644
--- a/assets/en_US_guide_services.md.1f68d826.js
+++ b/assets/en_US_guide_services.md.29090992.js
@@ -1 +1 @@
-import{_ as e,o as t,c as o,R as i}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Service Monitoring","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/services.md","filePath":"en_US/guide/services.md","lastUpdated":1717546110000}'),n={name:"en_US/guide/services.md"},a=i('Service Monitoring
The Services section is where you set up monitoring for external websites or servers using Agents.
Configured service monitors can be viewed on the "Services" page of the homepage, displaying the availability monitoring results for the past 30 days.
How to Use
To add a new monitor, go to the "Services" page in the Admin Panel and click "Add Monitor."
When adding a new service monitor, you need to set the following parameters:
Name: Customize a name.
Type: Select a monitor type. Nezha Monitoring currently supports three types: "HTTP-GET," "ICMP-Ping," and "TCP-Ping."
Target: Depending on the type you choose, the method for setting the target differs:
HTTP-GET
: For this type, you should enter a URL as the target, including http://
or https://
. If your target URL is https://
, the SSL certificate of that URL will also be monitored. Notifications will be triggered when the SSL certificate expires or changes. Example: https://example.com.ICMP-Ping
: For this type, you should enter a domain name or IP without a port number. Example: 1.1.1.1 or example.com.TCP-Ping
: For this type, you should enter a domain name or IP with a port number. Example: 1.1.1.1:80 or example.com:22.
Request Interval: Set the interval in seconds at which the Agent requests the target.
Coverage: Select a rule to determine which Agents will request the target.
Specific Servers: Used in conjunction with the coverage scope, select Agents within the rule to exclude.
Notification Group: Choose the notification methods you have already set up on the "Notification" page. Click here for more details.
Enable Fault Notification: Choose whether to receive fault notifications for the target as needed. The default is unchecked.
After setting it up, click "Add." Wait a moment and go to the "Services" page on the homepage to view the monitoring results.
Latency Change Notification
Nezha Monitoring can monitor and record the latency between the Agent and the target server, sending notifications when there are significant changes. This feature helps you monitor if the server's network route has changed.
- Enable Latency Notifications: When enabled, Notification will be sent if the latency from the Agent to the target server is greater than the
Maximum Latency
or less than the Minimum Latency
.
Trigger Tasks on Notification
If you need to execute tasks when service monitoring Notification are triggered, you can check "Enable Trigger Tasks" and select the pre-configured trigger tasks in "Task on Notification" and "Task on Recovery."
Network Latency Chart
The TCP-Ping and ICMP-Ping monitoring types set in the Services page will automatically enable the monitoring chart feature. On the "Network" page of the homepage, you can view historical network latency charts. The data in the charts is based on the latency from the Agent to the target server. You can click the Agent's name to toggle the chart display. In the chart, you can uncheck the target server's name to hide or show the corresponding data.
Managing Monitors
To manage existing service monitors, go to the "Services" page in the Admin Panel. Select a monitor configuration and click the icons on the right to edit or delete it.
',16),r=[a];function s(c,h,l,g,d,u){return t(),o("div",null,r)}const f=e(n,[["render",s]]);export{m as __pageData,f as default};
+import{_ as e,o as t,c as o,R as i}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Service Monitoring","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/services.md","filePath":"en_US/guide/services.md","lastUpdated":1717546452000}'),n={name:"en_US/guide/services.md"},a=i('Service Monitoring
The Services section is where you set up monitoring for external websites or servers using Agents.
Configured service monitors can be viewed on the "Services" page of the homepage, displaying the availability monitoring results for the past 30 days.
How to Use
To add a new monitor, go to the "Services" page in the Admin Panel and click "Add Monitor."
When adding a new service monitor, you need to set the following parameters:
Name: Customize a name.
Type: Select a monitor type. Nezha Monitoring currently supports three types: "HTTP-GET," "ICMP-Ping," and "TCP-Ping."
Target: Depending on the type you choose, the method for setting the target differs:
HTTP-GET
: For this type, you should enter a URL as the target, including http://
or https://
. If your target URL is https://
, the SSL certificate of that URL will also be monitored. Notifications will be triggered when the SSL certificate expires or changes. Example: https://example.com.ICMP-Ping
: For this type, you should enter a domain name or IP without a port number. Example: 1.1.1.1 or example.com.TCP-Ping
: For this type, you should enter a domain name or IP with a port number. Example: 1.1.1.1:80 or example.com:22.
Request Interval: Set the interval in seconds at which the Agent requests the target.
Coverage: Select a rule to determine which Agents will request the target.
Specific Servers: Used in conjunction with the coverage scope, select Agents within the rule to exclude.
Notification Group: Choose the notification methods you have already set up on the "Notification" page. Click here for more details.
Enable Fault Notification: Choose whether to receive fault notifications for the target as needed. The default is unchecked.
After setting it up, click "Add." Wait a moment and go to the "Services" page on the homepage to view the monitoring results.
Latency Change Notification
Nezha Monitoring can monitor and record the latency between the Agent and the target server, sending notifications when there are significant changes. This feature helps you monitor if the server's network route has changed.
- Enable Latency Notifications: When enabled, Notification will be sent if the latency from the Agent to the target server is greater than the
Maximum Latency
or less than the Minimum Latency
.
Trigger Tasks on Notification
If you need to execute tasks when service monitoring Notification are triggered, you can check "Enable Trigger Tasks" and select the pre-configured trigger tasks in "Task on Notification" and "Task on Recovery."
Network Latency Chart
The TCP-Ping and ICMP-Ping monitoring types set in the Services page will automatically enable the monitoring chart feature. On the "Network" page of the homepage, you can view historical network latency charts. The data in the charts is based on the latency from the Agent to the target server. You can click the Agent's name to toggle the chart display. In the chart, you can uncheck the target server's name to hide or show the corresponding data.
Managing Monitors
To manage existing service monitors, go to the "Services" page in the Admin Panel. Select a monitor configuration and click the icons on the right to edit or delete it.
',16),r=[a];function s(c,h,l,g,d,u){return t(),o("div",null,r)}const f=e(n,[["render",s]]);export{m as __pageData,f as default};
diff --git a/assets/en_US_guide_services.md.1f68d826.lean.js b/assets/en_US_guide_services.md.29090992.lean.js
similarity index 86%
rename from assets/en_US_guide_services.md.1f68d826.lean.js
rename to assets/en_US_guide_services.md.29090992.lean.js
index 64c3041e..343d6fed 100644
--- a/assets/en_US_guide_services.md.1f68d826.lean.js
+++ b/assets/en_US_guide_services.md.29090992.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as o,R as i}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Service Monitoring","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/services.md","filePath":"en_US/guide/services.md","lastUpdated":1717546110000}'),n={name:"en_US/guide/services.md"},a=i("",16),r=[a];function s(c,h,l,g,d,u){return t(),o("div",null,r)}const f=e(n,[["render",s]]);export{m as __pageData,f as default};
+import{_ as e,o as t,c as o,R as i}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Service Monitoring","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/services.md","filePath":"en_US/guide/services.md","lastUpdated":1717546452000}'),n={name:"en_US/guide/services.md"},a=i("",16),r=[a];function s(c,h,l,g,d,u){return t(),o("div",null,r)}const f=e(n,[["render",s]]);export{m as __pageData,f as default};
diff --git a/assets/en_US_guide_settings.md.0918413b.js b/assets/en_US_guide_settings.md.63bbd9f1.js
similarity index 99%
rename from assets/en_US_guide_settings.md.0918413b.js
rename to assets/en_US_guide_settings.md.63bbd9f1.js
index 23e9c9d1..963822de 100644
--- a/assets/en_US_guide_settings.md.0918413b.js
+++ b/assets/en_US_guide_settings.md.63bbd9f1.js
@@ -1,4 +1,4 @@
-import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"Settings","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/settings.md","filePath":"en_US/guide/settings.md","lastUpdated":1717546110000}'),p={name:"en_US/guide/settings.md"},o=l(`Settings
Site Title
You can customize the site title in this section.
Administrator List
- If you have changed your Github, Gitlab, or Gitee username, you need to update it here to avoid login issues. Separate multiple usernames with commas:
user1,user2
. - To change the administrator account, go to
/opt/nezha/dashboard/data/config.yaml
and reset the new administrator Client ID
and Client Secret
.
Theme
Select the theme for the homepage and admin panel here. If a theme that already exists is not in the options, update the Dashboard.
Before enabling the Custom theme, ensure you have installed the custom theme; otherwise, the Dashboard will not display correctly after enabling this option.
Language
Nezha Monitoring currently supports the following languages:
- Simplified Chinese (简体中文)
- Traditional Chinese (繁體中文)
- English
- Spanish (Español)
We welcome corrections to translations or contributions of more languages.
Custom Code (style, script)
You can modify the LOGO, adjust colors, add beautification code, and add statistical code here.
WARNING
Custom code only affects the visitor homepage, not the admin panel. Due to differences in code between themes, if you need to modify the content in the admin panel, please modify the theme files in Docker.
Example of Changing Progress Bar Color, Background Image, Navigation Bar, etc., in the Default Theme
Click to expand/collapse
html<style>
+import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"Settings","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/settings.md","filePath":"en_US/guide/settings.md","lastUpdated":1717546452000}'),p={name:"en_US/guide/settings.md"},o=l(`Settings
Site Title
You can customize the site title in this section.
Administrator List
- If you have changed your Github, Gitlab, or Gitee username, you need to update it here to avoid login issues. Separate multiple usernames with commas:
user1,user2
. - To change the administrator account, go to
/opt/nezha/dashboard/data/config.yaml
and reset the new administrator Client ID
and Client Secret
.
Theme
Select the theme for the homepage and admin panel here. If a theme that already exists is not in the options, update the Dashboard.
Before enabling the Custom theme, ensure you have installed the custom theme; otherwise, the Dashboard will not display correctly after enabling this option.
Language
Nezha Monitoring currently supports the following languages:
- Simplified Chinese (简体中文)
- Traditional Chinese (繁體中文)
- English
- Spanish (Español)
We welcome corrections to translations or contributions of more languages.
Custom Code (style, script)
You can modify the LOGO, adjust colors, add beautification code, and add statistical code here.
WARNING
Custom code only affects the visitor homepage, not the admin panel. Due to differences in code between themes, if you need to modify the content in the admin panel, please modify the theme files in Docker.
Example of Changing Progress Bar Color, Background Image, Navigation Bar, etc., in the Default Theme
Click to expand/collapse
html<style>
/* Screen adaptation */
@media only screen and (min-width: 1200px) {
.ui.container {
diff --git a/assets/en_US_guide_settings.md.0918413b.lean.js b/assets/en_US_guide_settings.md.63bbd9f1.lean.js
similarity index 85%
rename from assets/en_US_guide_settings.md.0918413b.lean.js
rename to assets/en_US_guide_settings.md.63bbd9f1.lean.js
index 9f5479c3..0c517591 100644
--- a/assets/en_US_guide_settings.md.0918413b.lean.js
+++ b/assets/en_US_guide_settings.md.63bbd9f1.lean.js
@@ -1 +1 @@
-import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"Settings","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/settings.md","filePath":"en_US/guide/settings.md","lastUpdated":1717546110000}'),p={name:"en_US/guide/settings.md"},o=l("",39),e=[o];function t(r,c,F,D,y,C){return a(),n("div",null,e)}const B=s(p,[["render",t]]);export{A as __pageData,B as default};
+import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"Settings","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/settings.md","filePath":"en_US/guide/settings.md","lastUpdated":1717546452000}'),p={name:"en_US/guide/settings.md"},o=l("",39),e=[o];function t(r,c,F,D,y,C){return a(),n("div",null,e)}const B=s(p,[["render",t]]);export{A as __pageData,B as default};
diff --git a/assets/en_US_guide_tasks.md.577a4312.js b/assets/en_US_guide_tasks.md.bedd3dbc.js
similarity index 98%
rename from assets/en_US_guide_tasks.md.577a4312.js
rename to assets/en_US_guide_tasks.md.bedd3dbc.js
index e8c6411b..918cdbf4 100644
--- a/assets/en_US_guide_tasks.md.577a4312.js
+++ b/assets/en_US_guide_tasks.md.bedd3dbc.js
@@ -1 +1 @@
-import{_ as e,o as t,c as o,R as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"Task Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/tasks.md","filePath":"en_US/guide/tasks.md","lastUpdated":1717546110000}'),n={name:"en_US/guide/tasks.md"},s=a('Task Management
In the Tasks section, you can set up scheduled tasks, trigger tasks, and batch execute tasks on multiple servers.
Nezha Monitoring supports pushing commands to Agents for execution. This feature is highly flexible and can be used for regular backups using tools like restic or rclone, periodically restarting a service to reset network connections, or executing a task when an notification is triggered, such as running a script when CPU usage is high for an extended period.
How to Use
Go to the "Tasks" page in the admin panel and click "Add Scheduled Task." When adding a scheduled task, you need to fill in the following parameters:
Name: Customize a task name.
Task Type: Choose the type of task.
- Scheduled Task: Executes periodically according to the schedule set below.
- Trigger Task: Only executed when triggered by an API call or notification rule, runs once per trigger.
Schedule: Set the schedule time (not enable when using trigger task type). The time format is * * * * * *
, corresponding to second minute hour day month weekday
. For more details, see Cron Expression Format.
For example: 0 0 3 * * *
means "3 AM every day."
Command: Set the command to execute, similar to writing Shell/Bat scripts, but it's recommended not to use new lines; connect multiple commands with &&
or &
.
For example, to schedule a reboot, you can enter reboot
here.
Coverage and Specific Servers: Select rules to determine which Agents execute the scheduled task, similar to the settings on the "Services" page. When using the trigger task type, you can choose "executed by the triggered server."
Notification Group: Choose the notification methods you have set up on the "Notifications" page. Click here for more details.
Send Success Notification: Check this option to trigger a notification upon successful task execution.
Managing Tasks
To manage existing scheduled tasks, go to the "Tasks" page in the admin panel. For each task configuration, the three icons on the right are:
- Execute Immediately: Click to ignore the scheduled time and execute the task immediately.
- Edit: Click to modify the task configuration.
- Delete: Delete the scheduled task.
Frequently Asked Questions
- Command not found error
If a command fails to run with a "command not found" error, it may be a PATH environment variable issue. On Linux servers, you can add source ~/.bashrc
at the beginning of the command or use the absolute path to execute the command.
',11),i=[s];function r(c,l,d,u,h,g){return t(),o("div",null,i)}const k=e(n,[["render",r]]);export{p as __pageData,k as default};
+import{_ as e,o as t,c as o,R as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"Task Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/tasks.md","filePath":"en_US/guide/tasks.md","lastUpdated":1717546452000}'),n={name:"en_US/guide/tasks.md"},s=a('Task Management
In the Tasks section, you can set up scheduled tasks, trigger tasks, and batch execute tasks on multiple servers.
Nezha Monitoring supports pushing commands to Agents for execution. This feature is highly flexible and can be used for regular backups using tools like restic or rclone, periodically restarting a service to reset network connections, or executing a task when an notification is triggered, such as running a script when CPU usage is high for an extended period.
How to Use
Go to the "Tasks" page in the admin panel and click "Add Scheduled Task." When adding a scheduled task, you need to fill in the following parameters:
Name: Customize a task name.
Task Type: Choose the type of task.
- Scheduled Task: Executes periodically according to the schedule set below.
- Trigger Task: Only executed when triggered by an API call or notification rule, runs once per trigger.
Schedule: Set the schedule time (not enable when using trigger task type). The time format is * * * * * *
, corresponding to second minute hour day month weekday
. For more details, see Cron Expression Format.
For example: 0 0 3 * * *
means "3 AM every day."
Command: Set the command to execute, similar to writing Shell/Bat scripts, but it's recommended not to use new lines; connect multiple commands with &&
or &
.
For example, to schedule a reboot, you can enter reboot
here.
Coverage and Specific Servers: Select rules to determine which Agents execute the scheduled task, similar to the settings on the "Services" page. When using the trigger task type, you can choose "executed by the triggered server."
Notification Group: Choose the notification methods you have set up on the "Notifications" page. Click here for more details.
Send Success Notification: Check this option to trigger a notification upon successful task execution.
Managing Tasks
To manage existing scheduled tasks, go to the "Tasks" page in the admin panel. For each task configuration, the three icons on the right are:
- Execute Immediately: Click to ignore the scheduled time and execute the task immediately.
- Edit: Click to modify the task configuration.
- Delete: Delete the scheduled task.
Frequently Asked Questions
- Command not found error
If a command fails to run with a "command not found" error, it may be a PATH environment variable issue. On Linux servers, you can add source ~/.bashrc
at the beginning of the command or use the absolute path to execute the command.
',11),i=[s];function r(c,l,d,u,h,g){return t(),o("div",null,i)}const k=e(n,[["render",r]]);export{p as __pageData,k as default};
diff --git a/assets/en_US_guide_tasks.md.577a4312.lean.js b/assets/en_US_guide_tasks.md.bedd3dbc.lean.js
similarity index 85%
rename from assets/en_US_guide_tasks.md.577a4312.lean.js
rename to assets/en_US_guide_tasks.md.bedd3dbc.lean.js
index d7f735a7..68770920 100644
--- a/assets/en_US_guide_tasks.md.577a4312.lean.js
+++ b/assets/en_US_guide_tasks.md.bedd3dbc.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as o,R as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"Task Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/tasks.md","filePath":"en_US/guide/tasks.md","lastUpdated":1717546110000}'),n={name:"en_US/guide/tasks.md"},s=a("",11),i=[s];function r(c,l,d,u,h,g){return t(),o("div",null,i)}const k=e(n,[["render",r]]);export{p as __pageData,k as default};
+import{_ as e,o as t,c as o,R as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"Task Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/tasks.md","filePath":"en_US/guide/tasks.md","lastUpdated":1717546452000}'),n={name:"en_US/guide/tasks.md"},s=a("",11),i=[s];function r(c,l,d,u,h,g){return t(),o("div",null,i)}const k=e(n,[["render",r]]);export{p as __pageData,k as default};
diff --git a/assets/en_US_index.md.73421e22.js b/assets/en_US_index.md.073a04c0.js
similarity index 96%
rename from assets/en_US_index.md.73421e22.js
rename to assets/en_US_index.md.073a04c0.js
index 7d5a05f2..f669c627 100644
--- a/assets/en_US_index.md.73421e22.js
+++ b/assets/en_US_index.md.073a04c0.js
@@ -1 +1 @@
-import{_ as t,o as e,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"User Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"User Manual","hero":{"name":"Nezha Monitoring","text":"Open-source, lightweight, and easy-to-use server monitoring and operation tool","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Preview","link":"https://ops.naibahq.com"},{"theme":"alt","text":"Get Started →","link":"en_US/guide/dashboard"}]},"features":[{"title":"One-Click Installation","details":"Supports one-click installation of the Dashboard and Agent services, making it easy to operate. Compatible with mainstream systems, including Linux, Windows, macOS, OpenWRT, and Synology."},{"title":"Real-Time Monitoring","details":"Supports monitoring the status of multiple servers simultaneously, providing historical network status and latency charts, monitoring webpage and port availability, and SSL certificate status. Supports alerts for status such as faults and traffic, with notifications via Telegram, email, Slack, and more."},{"title":"Easy Operations","details":"Provides an API to get server status, supports WebSSH, DDNS, and traffic monitoring. Allows setting up scheduled and triggered tasks and executing server tasks in batches."}]},"headers":[],"relativePath":"en_US/index.md","filePath":"en_US/index.md","lastUpdated":1717546110000}'),i={name:"en_US/index.md"};function n(s,o,r,l,d,c){return e(),a("div")}const u=t(i,[["render",n]]);export{m as __pageData,u as default};
+import{_ as t,o as e,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"User Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"User Manual","hero":{"name":"Nezha Monitoring","text":"Open-source, lightweight, and easy-to-use server monitoring and operation tool","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Preview","link":"https://ops.naibahq.com"},{"theme":"alt","text":"Get Started →","link":"en_US/guide/dashboard"}]},"features":[{"title":"One-Click Installation","details":"Supports one-click installation of the Dashboard and Agent services, making it easy to operate. Compatible with mainstream systems, including Linux, Windows, macOS, OpenWRT, and Synology."},{"title":"Real-Time Monitoring","details":"Supports monitoring the status of multiple servers simultaneously, providing historical network status and latency charts, monitoring webpage and port availability, and SSL certificate status. Supports alerts for status such as faults and traffic, with notifications via Telegram, email, Slack, and more."},{"title":"Easy Operations","details":"Provides an API to get server status, supports WebSSH, DDNS, and traffic monitoring. Allows setting up scheduled and triggered tasks and executing server tasks in batches."}]},"headers":[],"relativePath":"en_US/index.md","filePath":"en_US/index.md","lastUpdated":1717546452000}'),i={name:"en_US/index.md"};function n(s,o,r,l,d,c){return e(),a("div")}const u=t(i,[["render",n]]);export{m as __pageData,u as default};
diff --git a/assets/en_US_index.md.73421e22.lean.js b/assets/en_US_index.md.073a04c0.lean.js
similarity index 96%
rename from assets/en_US_index.md.73421e22.lean.js
rename to assets/en_US_index.md.073a04c0.lean.js
index 7d5a05f2..f669c627 100644
--- a/assets/en_US_index.md.73421e22.lean.js
+++ b/assets/en_US_index.md.073a04c0.lean.js
@@ -1 +1 @@
-import{_ as t,o as e,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"User Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"User Manual","hero":{"name":"Nezha Monitoring","text":"Open-source, lightweight, and easy-to-use server monitoring and operation tool","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Preview","link":"https://ops.naibahq.com"},{"theme":"alt","text":"Get Started →","link":"en_US/guide/dashboard"}]},"features":[{"title":"One-Click Installation","details":"Supports one-click installation of the Dashboard and Agent services, making it easy to operate. Compatible with mainstream systems, including Linux, Windows, macOS, OpenWRT, and Synology."},{"title":"Real-Time Monitoring","details":"Supports monitoring the status of multiple servers simultaneously, providing historical network status and latency charts, monitoring webpage and port availability, and SSL certificate status. Supports alerts for status such as faults and traffic, with notifications via Telegram, email, Slack, and more."},{"title":"Easy Operations","details":"Provides an API to get server status, supports WebSSH, DDNS, and traffic monitoring. Allows setting up scheduled and triggered tasks and executing server tasks in batches."}]},"headers":[],"relativePath":"en_US/index.md","filePath":"en_US/index.md","lastUpdated":1717546110000}'),i={name:"en_US/index.md"};function n(s,o,r,l,d,c){return e(),a("div")}const u=t(i,[["render",n]]);export{m as __pageData,u as default};
+import{_ as t,o as e,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"User Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"User Manual","hero":{"name":"Nezha Monitoring","text":"Open-source, lightweight, and easy-to-use server monitoring and operation tool","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Preview","link":"https://ops.naibahq.com"},{"theme":"alt","text":"Get Started →","link":"en_US/guide/dashboard"}]},"features":[{"title":"One-Click Installation","details":"Supports one-click installation of the Dashboard and Agent services, making it easy to operate. Compatible with mainstream systems, including Linux, Windows, macOS, OpenWRT, and Synology."},{"title":"Real-Time Monitoring","details":"Supports monitoring the status of multiple servers simultaneously, providing historical network status and latency charts, monitoring webpage and port availability, and SSL certificate status. Supports alerts for status such as faults and traffic, with notifications via Telegram, email, Slack, and more."},{"title":"Easy Operations","details":"Provides an API to get server status, supports WebSSH, DDNS, and traffic monitoring. Allows setting up scheduled and triggered tasks and executing server tasks in batches."}]},"headers":[],"relativePath":"en_US/index.md","filePath":"en_US/index.md","lastUpdated":1717546452000}'),i={name:"en_US/index.md"};function n(s,o,r,l,d,c){return e(),a("div")}const u=t(i,[["render",n]]);export{m as __pageData,u as default};
diff --git a/assets/guide_agent.md.38f882d9.js b/assets/guide_agent.md.8584acc4.js
similarity index 99%
rename from assets/guide_agent.md.38f882d9.js
rename to assets/guide_agent.md.8584acc4.js
index d85138b9..2077482f 100644
--- a/assets/guide_agent.md.38f882d9.js
+++ b/assets/guide_agent.md.8584acc4.js
@@ -1,4 +1,4 @@
-import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"安装 Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1717546110000}'),p={name:"guide/agent.md"},o=l(`安装 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)
- 首先在管理面板中添加一台服务器。
- 点击新添加的服务器旁的绿色 Linux 图标按钮,复制一键安装命令。
- 在被控端服务器中运行复制的一键安装命令,等待安装完成后返回到 Dashboard 主页查看服务器是否上线。
在 Windows 中一键安装
- 首先在管理面板中添加一台服务器。
- 点击新添加的服务器旁的绿色 Windows 图标按钮,复制一键安装命令。
- 进入 Windows 服务器,运行 PowerShell,在 PowerShell 中运行复制的安装命令。
- 如遇到确认「执行策略变更」请选择 Y。
- 等待安装完成后返回 Dashboard 主页查看服务器是否上线。
WARNING
如果在 PowerShell 中运行一键安装命令时遇到错误,请尝试下方的在 Windows 中手动安装 Agent。
其他方式安装 Agent
在 Linux 中安装 Agent (Ubuntu、Debian、CentOS)
点击展开/收起
- 首先在管理面板中添加一台服务器。
- 在被控服务器中,运行脚本(位于中国大陆的服务器请使用镜像):
bashcurl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
如果你的被控服务器位于中国大陆,可以使用镜像:
bashcurl -L https://gitee.com/naibahq/nezha/raw/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh
- 选择“安装监控 Agent”。
- 输入通信域名,如:”data.example.com“。
- 输入面板通信端口(gRPC 端口),默认为 5555。
- 输入 Agent 密钥,Agent 密钥在管理面板中添加服务器时生成,可以在管理面板中的“服务器”页中找到。
- 等待安装完成后返回 Dashboard 主页查看服务器是否上线。
在其他 Linux 发行版(如 Alpine 使用 Openrc)中安装 Agent
点击展开/收起
本节内容由 unknown0054 贡献。
- 修改 SERVER、SECRET、TLS,然后在 shell 中执行:
shellcat >/etc/init.d/nezha-agent<< EOF
+import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"安装 Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1717546452000}'),p={name:"guide/agent.md"},o=l(`安装 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)
- 首先在管理面板中添加一台服务器。
- 点击新添加的服务器旁的绿色 Linux 图标按钮,复制一键安装命令。
- 在被控端服务器中运行复制的一键安装命令,等待安装完成后返回到 Dashboard 主页查看服务器是否上线。
在 Windows 中一键安装
- 首先在管理面板中添加一台服务器。
- 点击新添加的服务器旁的绿色 Windows 图标按钮,复制一键安装命令。
- 进入 Windows 服务器,运行 PowerShell,在 PowerShell 中运行复制的安装命令。
- 如遇到确认「执行策略变更」请选择 Y。
- 等待安装完成后返回 Dashboard 主页查看服务器是否上线。
WARNING
如果在 PowerShell 中运行一键安装命令时遇到错误,请尝试下方的在 Windows 中手动安装 Agent。
其他方式安装 Agent
在 Linux 中安装 Agent (Ubuntu、Debian、CentOS)
点击展开/收起
- 首先在管理面板中添加一台服务器。
- 在被控服务器中,运行脚本(位于中国大陆的服务器请使用镜像):
bashcurl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
如果你的被控服务器位于中国大陆,可以使用镜像:
bashcurl -L https://gitee.com/naibahq/nezha/raw/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh
- 选择“安装监控 Agent”。
- 输入通信域名,如:”data.example.com“。
- 输入面板通信端口(gRPC 端口),默认为 5555。
- 输入 Agent 密钥,Agent 密钥在管理面板中添加服务器时生成,可以在管理面板中的“服务器”页中找到。
- 等待安装完成后返回 Dashboard 主页查看服务器是否上线。
在其他 Linux 发行版(如 Alpine 使用 Openrc)中安装 Agent
点击展开/收起
本节内容由 unknown0054 贡献。
- 修改 SERVER、SECRET、TLS,然后在 shell 中执行:
shellcat >/etc/init.d/nezha-agent<< EOF
#!/sbin/openrc-run
SERVER="" # Dashboard 地址 ip:port
SECRET="" # SECRET
diff --git a/assets/guide_agent.md.38f882d9.lean.js b/assets/guide_agent.md.8584acc4.lean.js
similarity index 85%
rename from assets/guide_agent.md.38f882d9.lean.js
rename to assets/guide_agent.md.8584acc4.lean.js
index 02734cc5..14552ed6 100644
--- a/assets/guide_agent.md.38f882d9.lean.js
+++ b/assets/guide_agent.md.8584acc4.lean.js
@@ -1 +1 @@
-import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"安装 Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1717546110000}'),p={name:"guide/agent.md"},o=l("",29),e=[o];function t(c,r,D,y,C,i){return a(),n("div",null,e)}const h=s(p,[["render",t]]);export{A as __pageData,h as default};
+import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"安装 Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1717546452000}'),p={name:"guide/agent.md"},o=l("",29),e=[o];function t(c,r,D,y,C,i){return a(),n("div",null,e)}const h=s(p,[["render",t]]);export{A as __pageData,h as default};
diff --git a/assets/guide_agentq.md.babc37d3.js b/assets/guide_agentq.md.226069ac.js
similarity index 97%
rename from assets/guide_agentq.md.babc37d3.js
rename to assets/guide_agentq.md.226069ac.js
index 653bad35..40adff29 100644
--- a/assets/guide_agentq.md.babc37d3.js
+++ b/assets/guide_agentq.md.226069ac.js
@@ -1 +1 @@
-import{_ as a,o as e,c as t,R as n}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Agent 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agentq.md","filePath":"guide/agentq.md","lastUpdated":1717546110000}'),o={name:"guide/agentq.md"},s=n('Agent 常见问题
后台显示的 IP 和 Agent 实际 IP 不一致?
请查看 Dashboard 相关-为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致?。在此不再赘述。
一键脚本安装时出错
curl: Failed to connect to raw.githubusercontent.com......
多出现在中国大陆的服务器中,目前一键脚本只从 Github 直接获取安装脚本,您可以多尝试几次,或者手动安装 Agent。另外,也可以自行寻找第三方 Github 加速服务或者镜像,并在一键安装脚本中设置。
sudo: command not found
请先手动安装 sudo,例如在 Ubuntu 中:
shellapt install sudo
',9),l=[s];function r(c,i,d,u,h,p){return e(),t("div",null,l)}const _=a(o,[["render",r]]);export{m as __pageData,_ as default};
+import{_ as a,o as e,c as t,R as n}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Agent 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agentq.md","filePath":"guide/agentq.md","lastUpdated":1717546452000}'),o={name:"guide/agentq.md"},s=n('Agent 常见问题
后台显示的 IP 和 Agent 实际 IP 不一致?
请查看 Dashboard 相关-为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致?。在此不再赘述。
一键脚本安装时出错
curl: Failed to connect to raw.githubusercontent.com......
多出现在中国大陆的服务器中,目前一键脚本只从 Github 直接获取安装脚本,您可以多尝试几次,或者手动安装 Agent。另外,也可以自行寻找第三方 Github 加速服务或者镜像,并在一键安装脚本中设置。
sudo: command not found
请先手动安装 sudo,例如在 Ubuntu 中:
shellapt install sudo
',9),l=[s];function r(c,i,d,u,h,p){return e(),t("div",null,l)}const _=a(o,[["render",r]]);export{m as __pageData,_ as default};
diff --git a/assets/guide_agentq.md.babc37d3.lean.js b/assets/guide_agentq.md.226069ac.lean.js
similarity index 85%
rename from assets/guide_agentq.md.babc37d3.lean.js
rename to assets/guide_agentq.md.226069ac.lean.js
index 50e3a463..24d63544 100644
--- a/assets/guide_agentq.md.babc37d3.lean.js
+++ b/assets/guide_agentq.md.226069ac.lean.js
@@ -1 +1 @@
-import{_ as a,o as e,c as t,R as n}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Agent 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agentq.md","filePath":"guide/agentq.md","lastUpdated":1717546110000}'),o={name:"guide/agentq.md"},s=n("",9),l=[s];function r(c,i,d,u,h,p){return e(),t("div",null,l)}const _=a(o,[["render",r]]);export{m as __pageData,_ as default};
+import{_ as a,o as e,c as t,R as n}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Agent 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agentq.md","filePath":"guide/agentq.md","lastUpdated":1717546452000}'),o={name:"guide/agentq.md"},s=n("",9),l=[s];function r(c,i,d,u,h,p){return e(),t("div",null,l)}const _=a(o,[["render",r]]);export{m as __pageData,_ as default};
diff --git a/assets/guide_api.md.7b1b60fd.js b/assets/guide_api.md.d093c9fb.js
similarity index 99%
rename from assets/guide_api.md.7b1b60fd.js
rename to assets/guide_api.md.d093c9fb.js
index 4d86903e..0a83cb97 100644
--- a/assets/guide_api.md.7b1b60fd.js
+++ b/assets/guide_api.md.d093c9fb.js
@@ -1,4 +1,4 @@
-import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"API 接口","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1717546110000}'),l={name:"guide/api.md"},p=o(`API 接口
哪吒监控支持使用 API 接口查询面板中 Agent 的状态信息
创建 Token
哪吒面板的 API 接口允许使用 Token 认证与 Cookies 认证。要新建一个 Token,在进入管理面板后,点击右上角的头像,选择 “API Token”,进入 Token 管理页面。点击 “API Token”,自定义备注后,点击 “添加”。
如需删除一个 Token,请选择相应的 Token,点击右侧的删除图标。
WARNING
Token 是 API 接口的鉴权凭据,它对你的面板的信息安全非常重要,请不要泄漏你的 Token 给他人。
认证方式
确保在请求头中包含 Authorization: Token
进行身份认证。
Token 认证方式:
Request Headers:
+import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"API 接口","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1717546452000}'),l={name:"guide/api.md"},p=o(`API 接口
哪吒监控支持使用 API 接口查询面板中 Agent 的状态信息
创建 Token
哪吒面板的 API 接口允许使用 Token 认证与 Cookies 认证。要新建一个 Token,在进入管理面板后,点击右上角的头像,选择 “API Token”,进入 Token 管理页面。点击 “API Token”,自定义备注后,点击 “添加”。
如需删除一个 Token,请选择相应的 Token,点击右侧的删除图标。
WARNING
Token 是 API 接口的鉴权凭据,它对你的面板的信息安全非常重要,请不要泄漏你的 Token 给他人。
认证方式
确保在请求头中包含 Authorization: Token
进行身份认证。
Token 认证方式:
Request Headers:
Authorization: Token
使用说明
WARNING
下面示例中的负数时间戳为(0000-00-00),目前表示 Dashboard 上线后该 Agent 从未汇报过,但不建议用正负性判断状态。
TIP
请求方式为 GET
,返回格式为 JSON
获取服务器列表
请求:
GET /api/v1/server/list?tag=
参数:
tag
(可选):ServerTag 是服务器的分组,提供此参数则仅查询该分组中的服务器。
返回示例:
json{
"code": 0,
"message": "success",
diff --git a/assets/guide_api.md.7b1b60fd.lean.js b/assets/guide_api.md.d093c9fb.lean.js
similarity index 69%
rename from assets/guide_api.md.7b1b60fd.lean.js
rename to assets/guide_api.md.d093c9fb.lean.js
index 50c343e1..b4d4f253 100644
--- a/assets/guide_api.md.7b1b60fd.lean.js
+++ b/assets/guide_api.md.d093c9fb.lean.js
@@ -1 +1 @@
-import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"API 接口","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1717546110000}'),l={name:"guide/api.md"},p=o("",33),t=[p];function e(D,F,c,r,y,C){return n(),a("div",null,t)}const i=s(l,[["render",e]]);export{u as __pageData,i as default};
+import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"API 接口","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1717546452000}'),l={name:"guide/api.md"},p=o("",33),t=[p];function e(D,F,c,r,y,C){return n(),a("div",null,t)}const i=s(l,[["render",e]]);export{u as __pageData,i as default};
diff --git a/assets/guide_dashboard.md.1cba73a9.js b/assets/guide_dashboard.md.a693f39f.js
similarity index 99%
rename from assets/guide_dashboard.md.1cba73a9.js
rename to assets/guide_dashboard.md.a693f39f.js
index 703d7670..2b5fa970 100644
--- a/assets/guide_dashboard.md.1cba73a9.js
+++ b/assets/guide_dashboard.md.a693f39f.js
@@ -1,4 +1,4 @@
-import{_ as a,o as s,c as e,R as o}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"安装 Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboard.md","filePath":"guide/dashboard.md","lastUpdated":1717546110000}'),l={name:"guide/dashboard.md"},n=o(`安装 Dashboard
准备工作
搭建一个哪吒监控,你需要:
- 一台可以连接公网的服务器,防火墙和安全策略需要放行 8008 和 5555 端口,否则会无法访问和无法接收数据。单核 512MB 内存的服务器配置就足以满足大多数使用场景。
- 一个已经设置好 A 记录,指向 Dashboard 服务器 IP 的域名。
TIP
如果你想使用 CDN,请准备两个域名,一个配置好 CDN 用作公开访问,CDN 需要支持 WebSocket 协议;另一个域名不要使用 CDN,用作 Agent 端与 Dashboard 的通信。
本文档分别以 "dashboard.example.com" 和 "data.example.com" 两个域名来演示。
- 一个 Github 账号(或:Gitlab、Gitee)。
本文档将以宝塔面板反代 Dashboard 的过程作为示范,随着未来版本的变化,部分功能的入口可能会发生改变,本文档仅供参考。
WARNING
本项目并不依赖宝塔,你可以选择使用你喜欢的任何服务器面板,或手动安装 Nginx 或 Caddy 来配置 SSL 和反代。
如果你认为没有必要使用 80、443 端口来访问 Dashboard,你甚至不需要安装 Nginx 就可以直接使用安装脚本安装并运行哪吒监控。
获取 Github 的 Client ID 和密钥
哪吒监控接入 Github、Gitlab、Gitee 作为后台管理员账号。
- 首先我们需要新建一个验证应用,以 Github 为例,登录 Github 后,打开 https://github.com/settings/developers,依次选择“OAuth Apps” - “New OAuth App”。
Application name
- 随意填写。
Homepage URL
- 填写面板的访问域名,如:"http://dashboard.example.com"(你的域名)。
Authorization callback URL
- 填写回调地址,如:"http://dashboard.example.com/oauth2/callback"(不要忘记/oauth2/callback
)。 - 点击 “Register application”。
- 保存页面中的 Client ID,然后点击 “Generate a new client secret“,创建一个新的 Client Secret,新建的密钥仅会显示一次,请妥善保存。
使用 Cloudflare Access 作为 OAuth2 提供方
位于中国大陆的用户可能无法直接连接 Github,如您在使用 Github、Gitlab、Gitee 作为管理员账户登录时遇到问题,可以优先考虑切换 使用 Cloudflare Access 作为 OAuth2 提供方 作为登录方式。
新建 SaaS-OIDC 应用流程
- 前往 Zero Trust Dashboard,使用 Cloudflare 账号登录。
My Team
-> Users
-> <具体用户>
-> 获取 User ID
并保存。Access
-> Application
-> Add an Application
。- 选择
SaaS
,在 Application
中输入自定义的应用名称(例如 nezha),选择 OIDC
后点击 Add application
。 Scopes
选择 openid
, email
, profile
, groups
。Redirect URLs
填写你的 callback 地址,例如 https://dashboard.example.com/oauth2/callback
。- 保存
Client ID
、Client Secret
、Issuer
地址中协议与域名的部分,例如 https://xxxxx.cloudflareaccess.com
。
如使用此方式,安装 Dashboard 完成后,需要修改配置文件 /opt/nezha/dashboard/data/config.yaml
,将 Endpoint
配置修改为之前保存的 Issuer
地址,例如 https://xxxxx.cloudflareaccess.com
,保存后需重启 Dashboard。
在服务器中安装 Dashboard
在面板服务器中,运行安装脚本:
bashcurl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
如果你的面板服务器位于中国大陆,可以使用镜像:
bashcurl -L https://gitee.com/naibahq/nezha/raw/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh
等待 Docker 安装完毕后,分别输入以下值:
OAuth提供商
- github、cloudflare、gitlab、gitee 中选择一个。Client ID
- 之前保存的 Client ID。Client Secret
- 之前保存的 Client Secret。用户名
- OAuth 提供商中的用户名/User ID。站点标题
- 自定义站点标题。访问端口
- 公开访问端口,可自定义,默认 8008。Agent的通信端口
- Agent 与 Dashboard 的通信端口,默认 5555。
输入完成后,等待拉取镜像。
安装结束后,如果一切正常,此时你可以访问域名+端口号,如 “http://dashboard.example.com:8008” 来查看面板。
将来如果需要再次运行脚本,可以运行:
bash./nezha.sh
来打开管理脚本。
配置反向代理
在宝塔面板中新建一个站点,域名填写公开访问域名,如 “http://dashboard.example.com“ ,然后点击“设置”进入站点设置选项,选择“反向代理” - “新建反向代理”。
自定义一个代理名称,在下方“目标 URL”中填入 http://127.0.0.1
然后点击“保存”。
打开刚刚新建的反向代理右边的“配置文件”,将配置文件替换为以下内容:
nginx#PROXY-START/
+import{_ as a,o as s,c as e,R as o}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"安装 Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboard.md","filePath":"guide/dashboard.md","lastUpdated":1717546452000}'),l={name:"guide/dashboard.md"},n=o(`安装 Dashboard
准备工作
搭建一个哪吒监控,你需要:
- 一台可以连接公网的服务器,防火墙和安全策略需要放行 8008 和 5555 端口,否则会无法访问和无法接收数据。单核 512MB 内存的服务器配置就足以满足大多数使用场景。
- 一个已经设置好 A 记录,指向 Dashboard 服务器 IP 的域名。
TIP
如果你想使用 CDN,请准备两个域名,一个配置好 CDN 用作公开访问,CDN 需要支持 WebSocket 协议;另一个域名不要使用 CDN,用作 Agent 端与 Dashboard 的通信。
本文档分别以 "dashboard.example.com" 和 "data.example.com" 两个域名来演示。
- 一个 Github 账号(或:Gitlab、Gitee)。
本文档将以宝塔面板反代 Dashboard 的过程作为示范,随着未来版本的变化,部分功能的入口可能会发生改变,本文档仅供参考。
WARNING
本项目并不依赖宝塔,你可以选择使用你喜欢的任何服务器面板,或手动安装 Nginx 或 Caddy 来配置 SSL 和反代。
如果你认为没有必要使用 80、443 端口来访问 Dashboard,你甚至不需要安装 Nginx 就可以直接使用安装脚本安装并运行哪吒监控。
获取 Github 的 Client ID 和密钥
哪吒监控接入 Github、Gitlab、Gitee 作为后台管理员账号。
- 首先我们需要新建一个验证应用,以 Github 为例,登录 Github 后,打开 https://github.com/settings/developers,依次选择“OAuth Apps” - “New OAuth App”。
Application name
- 随意填写。
Homepage URL
- 填写面板的访问域名,如:"http://dashboard.example.com"(你的域名)。
Authorization callback URL
- 填写回调地址,如:"http://dashboard.example.com/oauth2/callback"(不要忘记/oauth2/callback
)。 - 点击 “Register application”。
- 保存页面中的 Client ID,然后点击 “Generate a new client secret“,创建一个新的 Client Secret,新建的密钥仅会显示一次,请妥善保存。
使用 Cloudflare Access 作为 OAuth2 提供方
位于中国大陆的用户可能无法直接连接 Github,如您在使用 Github、Gitlab、Gitee 作为管理员账户登录时遇到问题,可以优先考虑切换 使用 Cloudflare Access 作为 OAuth2 提供方 作为登录方式。
新建 SaaS-OIDC 应用流程
- 前往 Zero Trust Dashboard,使用 Cloudflare 账号登录。
My Team
-> Users
-> <具体用户>
-> 获取 User ID
并保存。Access
-> Application
-> Add an Application
。- 选择
SaaS
,在 Application
中输入自定义的应用名称(例如 nezha),选择 OIDC
后点击 Add application
。 Scopes
选择 openid
, email
, profile
, groups
。Redirect URLs
填写你的 callback 地址,例如 https://dashboard.example.com/oauth2/callback
。- 保存
Client ID
、Client Secret
、Issuer
地址中协议与域名的部分,例如 https://xxxxx.cloudflareaccess.com
。
如使用此方式,安装 Dashboard 完成后,需要修改配置文件 /opt/nezha/dashboard/data/config.yaml
,将 Endpoint
配置修改为之前保存的 Issuer
地址,例如 https://xxxxx.cloudflareaccess.com
,保存后需重启 Dashboard。
在服务器中安装 Dashboard
在面板服务器中,运行安装脚本:
bashcurl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
如果你的面板服务器位于中国大陆,可以使用镜像:
bashcurl -L https://gitee.com/naibahq/nezha/raw/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh
等待 Docker 安装完毕后,分别输入以下值:
OAuth提供商
- github、cloudflare、gitlab、gitee 中选择一个。Client ID
- 之前保存的 Client ID。Client Secret
- 之前保存的 Client Secret。用户名
- OAuth 提供商中的用户名/User ID。站点标题
- 自定义站点标题。访问端口
- 公开访问端口,可自定义,默认 8008。Agent的通信端口
- Agent 与 Dashboard 的通信端口,默认 5555。
输入完成后,等待拉取镜像。
安装结束后,如果一切正常,此时你可以访问域名+端口号,如 “http://dashboard.example.com:8008” 来查看面板。
将来如果需要再次运行脚本,可以运行:
bash./nezha.sh
来打开管理脚本。
配置反向代理
在宝塔面板中新建一个站点,域名填写公开访问域名,如 “http://dashboard.example.com“ ,然后点击“设置”进入站点设置选项,选择“反向代理” - “新建反向代理”。
自定义一个代理名称,在下方“目标 URL”中填入 http://127.0.0.1
然后点击“保存”。
打开刚刚新建的反向代理右边的“配置文件”,将配置文件替换为以下内容:
nginx#PROXY-START/
location / {
proxy_pass http://127.0.0.1:8008;
proxy_set_header Host $http_host;
diff --git a/assets/guide_dashboard.md.1cba73a9.lean.js b/assets/guide_dashboard.md.a693f39f.lean.js
similarity index 85%
rename from assets/guide_dashboard.md.1cba73a9.lean.js
rename to assets/guide_dashboard.md.a693f39f.lean.js
index 3d41bc54..6f7e8621 100644
--- a/assets/guide_dashboard.md.1cba73a9.lean.js
+++ b/assets/guide_dashboard.md.a693f39f.lean.js
@@ -1 +1 @@
-import{_ as a,o as s,c as e,R as o}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"安装 Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboard.md","filePath":"guide/dashboard.md","lastUpdated":1717546110000}'),l={name:"guide/dashboard.md"},n=o("",40),t=[n];function p(c,r,d,i,h,C){return s(),e("div",null,t)}const y=a(l,[["render",p]]);export{A as __pageData,y as default};
+import{_ as a,o as s,c as e,R as o}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"安装 Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboard.md","filePath":"guide/dashboard.md","lastUpdated":1717546452000}'),l={name:"guide/dashboard.md"},n=o("",40),t=[n];function p(c,r,d,i,h,C){return s(),e("div",null,t)}const y=a(l,[["render",p]]);export{A as __pageData,y as default};
diff --git a/assets/guide_dashboardq.md.ecf504ff.js b/assets/guide_dashboardq.md.ed1e6ebb.js
similarity index 99%
rename from assets/guide_dashboardq.md.ecf504ff.js
rename to assets/guide_dashboardq.md.ed1e6ebb.js
index fd11be8d..04f6ceed 100644
--- a/assets/guide_dashboardq.md.ecf504ff.js
+++ b/assets/guide_dashboardq.md.ed1e6ebb.js
@@ -1,4 +1,4 @@
-import{_ as a,o as s,c as e,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Dashboard 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboardq.md","filePath":"guide/dashboardq.md","lastUpdated":1717546110000}'),n={name:"guide/dashboardq.md"},t=o(`Dashboard 常见问题
为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致?
首先解释管理面板中显示的IP是怎么得到的:Agent 会每隔一段时间请求一遍 IP-API,获取到 IP 信息后上报到 Dashboard,目前使用的 IP-API 可在此查看:myip.go。
如您发现管理面板中显示的 IP 和服务商提供给您的 IP 不一致,最大的可能是服务商给您的是入口 IP,但 Agent 测试的是您的出口 IP。这个问题也可能会出现在多线服务器和 IPLC 专线中。
TIP
举个简单也十分常见的例子,服务商给您提供的是一台高防服务器,为了同时满足高防和低网络中断率的目标,提供给您的 IP 可能是经过映射后的高防 IP 而并非您服务器的真实出口 IP。
您也可以在 Agent 服务器中运行以下命令测试出口 IP:
shellcurl https://ipapi.co/ip/
+import{_ as a,o as s,c as e,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Dashboard 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboardq.md","filePath":"guide/dashboardq.md","lastUpdated":1717546452000}'),n={name:"guide/dashboardq.md"},t=o(`Dashboard 常见问题
为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致?
首先解释管理面板中显示的IP是怎么得到的:Agent 会每隔一段时间请求一遍 IP-API,获取到 IP 信息后上报到 Dashboard,目前使用的 IP-API 可在此查看:myip.go。
如您发现管理面板中显示的 IP 和服务商提供给您的 IP 不一致,最大的可能是服务商给您的是入口 IP,但 Agent 测试的是您的出口 IP。这个问题也可能会出现在多线服务器和 IPLC 专线中。
TIP
举个简单也十分常见的例子,服务商给您提供的是一台高防服务器,为了同时满足高防和低网络中断率的目标,提供给您的 IP 可能是经过映射后的高防 IP 而并非您服务器的真实出口 IP。
您也可以在 Agent 服务器中运行以下命令测试出口 IP:
shellcurl https://ipapi.co/ip/
curl ip.sb
curl ip-api.com
忘记查看密码\\删除查看密码
请查看或编辑 /opt/nezha/dashboard/data/config.yaml
文件。
密码位于 site-viewpassword
项中。
面板安装/重启/更新失败: iptables ......
首先尝试重启 Docker 再操作:
shellsystemctl status docker
systemctl restart docker
diff --git a/assets/guide_dashboardq.md.ecf504ff.lean.js b/assets/guide_dashboardq.md.ed1e6ebb.lean.js
similarity index 85%
rename from assets/guide_dashboardq.md.ecf504ff.lean.js
rename to assets/guide_dashboardq.md.ed1e6ebb.lean.js
index 3ec40ecb..05bad827 100644
--- a/assets/guide_dashboardq.md.ecf504ff.lean.js
+++ b/assets/guide_dashboardq.md.ed1e6ebb.lean.js
@@ -1 +1 @@
-import{_ as a,o as s,c as e,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Dashboard 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboardq.md","filePath":"guide/dashboardq.md","lastUpdated":1717546110000}'),n={name:"guide/dashboardq.md"},t=o("",31),l=[t];function r(p,c,i,d,h,b){return s(),e("div",null,l)}const u=a(n,[["render",r]]);export{y as __pageData,u as default};
+import{_ as a,o as s,c as e,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Dashboard 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboardq.md","filePath":"guide/dashboardq.md","lastUpdated":1717546452000}'),n={name:"guide/dashboardq.md"},t=o("",31),l=[t];function r(p,c,i,d,h,b){return s(),e("div",null,l)}const u=a(n,[["render",r]]);export{y as __pageData,u as default};
diff --git a/assets/guide_loginq.md.2af51a3a.js b/assets/guide_loginq.md.272104d7.js
similarity index 98%
rename from assets/guide_loginq.md.2af51a3a.js
rename to assets/guide_loginq.md.272104d7.js
index f07ff32a..2e5e3e8f 100644
--- a/assets/guide_loginq.md.2af51a3a.js
+++ b/assets/guide_loginq.md.272104d7.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"登录常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/loginq.md","filePath":"guide/loginq.md","lastUpdated":1717546110000}'),r={name:"guide/loginq.md"},i=o('登录常见问题
登录回调后页面卡住\\拒绝连接\\响应时间过长
还有其他一些表现形式,总之登录后浏览器无法正常显示。
- 您的服务器无法连接到 Github/Gitee,最常见于国内服务器配置 Github 情况下,可以考虑多尝试几次或者切换到 Cloudflare Access。
- 您配置错了回调地址,确保您的回调地址正确且端口与协议均正确!
- Dashboard 发生未知错误,您可以使用脚本查看日志。
TIP
什么是协议? 在浏览器中,您的域名以 ://
结尾的字符串即为协议,通常为 http
和 https
两种。由于正常部署情况下面板可能有多种协议+域名+端口组合均可访问,请务必选一个最合适的作为回调。
如何检查我的回调地址是否错误?
请确保登录前浏览器显示的协议+域名+端口和登录后跳转到的协议+域名+端口一致。
请确保您的路径为 /oauth2/callback
,全部小写。
登录后面板报错
http: named cookie not present
- 清理 cookies 后重新登录,或换个浏览器。
- 检查回调地址,确保您的回调地址正确且端口与协议均正确!发起请求的地址需要和回调地址处于同域,端口、协议和域名(或IP)都需要一致。
lookup xxx
容器 DNS 解析失败,多数情况下为修改了 iptables 相关配置。
建议先重启 docker,sudo systemctl restart docker
,再使用脚本重启面板。
仍然出现 lookup 错误建议查看是否有其他控制 iptables 的工具,如宝塔防火墙等。
这个问题也可能与内核有关系,请尝试更换官方内核。
授权方式无效,或者登录回调地址无效、过期或已被撤销
只出现在 Gitee 登录方式中,原因不明,建议更换到 GitHub。
oauth2: server response missing access_token
可能由多种因素引起,最大可能性是网络问题,建议检查网络后重试。
无法解决的话建议更换 Github 等。
该用户不是本站点管理员,无法登录
您登陆错了账号或者配置错了用户名,注意用户名不是邮箱,可使用脚本修改。
Cloudflare Access 用户请注意,您的用户名不是邮箱,而是 User ID。
dial tcp xxx:443 i/o timeout
网络问题,可先重启 Docker,sudo systemctl restart docker
,再使用脚本重启面板。
如为国内服务器配置 Github 登陆方式,则建议切换到 Cloudflare Access 以避免网络干扰。
net/http: TLS handshake timeout
同上。
',22),s=[i];function l(n,c,h,d,p,u){return a(),t("div",null,s)}const k=e(r,[["render",l]]);export{m as __pageData,k as default};
+import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"登录常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/loginq.md","filePath":"guide/loginq.md","lastUpdated":1717546452000}'),r={name:"guide/loginq.md"},i=o('登录常见问题
登录回调后页面卡住\\拒绝连接\\响应时间过长
还有其他一些表现形式,总之登录后浏览器无法正常显示。
- 您的服务器无法连接到 Github/Gitee,最常见于国内服务器配置 Github 情况下,可以考虑多尝试几次或者切换到 Cloudflare Access。
- 您配置错了回调地址,确保您的回调地址正确且端口与协议均正确!
- Dashboard 发生未知错误,您可以使用脚本查看日志。
TIP
什么是协议? 在浏览器中,您的域名以 ://
结尾的字符串即为协议,通常为 http
和 https
两种。由于正常部署情况下面板可能有多种协议+域名+端口组合均可访问,请务必选一个最合适的作为回调。
如何检查我的回调地址是否错误?
请确保登录前浏览器显示的协议+域名+端口和登录后跳转到的协议+域名+端口一致。
请确保您的路径为 /oauth2/callback
,全部小写。
登录后面板报错
http: named cookie not present
- 清理 cookies 后重新登录,或换个浏览器。
- 检查回调地址,确保您的回调地址正确且端口与协议均正确!发起请求的地址需要和回调地址处于同域,端口、协议和域名(或IP)都需要一致。
lookup xxx
容器 DNS 解析失败,多数情况下为修改了 iptables 相关配置。
建议先重启 docker,sudo systemctl restart docker
,再使用脚本重启面板。
仍然出现 lookup 错误建议查看是否有其他控制 iptables 的工具,如宝塔防火墙等。
这个问题也可能与内核有关系,请尝试更换官方内核。
授权方式无效,或者登录回调地址无效、过期或已被撤销
只出现在 Gitee 登录方式中,原因不明,建议更换到 GitHub。
oauth2: server response missing access_token
可能由多种因素引起,最大可能性是网络问题,建议检查网络后重试。
无法解决的话建议更换 Github 等。
该用户不是本站点管理员,无法登录
您登陆错了账号或者配置错了用户名,注意用户名不是邮箱,可使用脚本修改。
Cloudflare Access 用户请注意,您的用户名不是邮箱,而是 User ID。
dial tcp xxx:443 i/o timeout
网络问题,可先重启 Docker,sudo systemctl restart docker
,再使用脚本重启面板。
如为国内服务器配置 Github 登陆方式,则建议切换到 Cloudflare Access 以避免网络干扰。
net/http: TLS handshake timeout
同上。
',22),s=[i];function l(n,c,h,d,p,u){return a(),t("div",null,s)}const k=e(r,[["render",l]]);export{m as __pageData,k as default};
diff --git a/assets/guide_loginq.md.2af51a3a.lean.js b/assets/guide_loginq.md.272104d7.lean.js
similarity index 85%
rename from assets/guide_loginq.md.2af51a3a.lean.js
rename to assets/guide_loginq.md.272104d7.lean.js
index 4be5a2bd..ca7c2900 100644
--- a/assets/guide_loginq.md.2af51a3a.lean.js
+++ b/assets/guide_loginq.md.272104d7.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"登录常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/loginq.md","filePath":"guide/loginq.md","lastUpdated":1717546110000}'),r={name:"guide/loginq.md"},i=o("",22),s=[i];function l(n,c,h,d,p,u){return a(),t("div",null,s)}const k=e(r,[["render",l]]);export{m as __pageData,k as default};
+import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"登录常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/loginq.md","filePath":"guide/loginq.md","lastUpdated":1717546452000}'),r={name:"guide/loginq.md"},i=o("",22),s=[i];function l(n,c,h,d,p,u){return a(),t("div",null,s)}const k=e(r,[["render",l]]);export{m as __pageData,k as default};
diff --git a/assets/guide_notifications.md.38c78f16.js b/assets/guide_notifications.md.d6f11641.js
similarity index 99%
rename from assets/guide_notifications.md.38c78f16.js
rename to assets/guide_notifications.md.d6f11641.js
index 64082085..0b7119ab 100644
--- a/assets/guide_notifications.md.38c78f16.js
+++ b/assets/guide_notifications.md.d6f11641.js
@@ -1,4 +1,4 @@
-import{_ as o,o as s,c as a,R as l}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"通知设置","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/notifications.md","filePath":"guide/notifications.md","lastUpdated":1717546110000}'),n={name:"guide/notifications.md"},t=l(`通知设置
哪吒监控支持对服务器的负载、CPU、内存、硬盘、流量、月流量、进程数、连接数进行监控,并在达到用户设定的阈值时发送告警通知。
灵活的通知方式
- 在面板消息中,占位符
#DATETIME#
代表事件发生的时间戳。当通知被触发时,面板会自动将 #DATETIME#
替换为事件的实际时间。 #NEZHA#
是面板消息占位符,面板触发通知时会自动用实际消息替换占位符。- Body 内容是
JSON
格式的:当请求类型为 FORM 时,值为 key:value
的形式,value
里面可放置占位符,通知时会自动替换。当请求类型为 JSON 时 只会简单进行字符串替换后直接提交到 URL
。 - URL 里面也可放置占位符,请求时会进行简单的字符串替换。
请参考以下的通知方式示例,也可以根据自己的需求灵活设置推送方式。
Bark 示例
点击展开/收起
名称:Bark
URL 组成: /:key/:body or /:key/:title/:body or /:key/:category/:title/:body
请求方式: GET
请求类型: 默认
Body: 空
名称:Bark
URL 组成: /push
请求方式: POST
请求类型: form
Body: {"title": "#SERVER.NAME#","device_key":"xxxxxxxxx","body":"#NEZHA#","icon":"https://xxxxxxxx/nz.png"}
Slack 示例 贡献者:@白歌
点击展开/收起
URL 参数获取说明
请提前准备好 Slack 的 Workspace 并为这个 Workspace 创建一个 App。如果你还没有创建,可以在 Slack API 创建一个 App。
创建完成 App 后,需要为这个 App 添加一个 Incoming Webhook。在 App 的设置页面中找到 Incoming Webhooks,将 Activate Incoming Webhooks 勾选为 ON,在页面下方找到并点击 Add New Webhook to Workspace,选择一个 Channel,然后点击允许。完成创建后,你会得到一个 Webhook URL,使用这个 URL 替换下方的示例 URL。
- 名称:Slack
- URL:https://hooks.slack.com/services/xxxxxxxxx/xxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx
- 请求方式: POST
- 请求类型: JSON
- Body:
{"text":"#NEZHA#"}
Server 酱示例
点击展开/收起
- 名称:Server 酱
- URL:https://sc.ftqq.com/SCUrandomkeys.send?title=哪吒告警信息&desp=#NEZHA#
- 请求方式: GET
- 请求类型: 默认
- Body: 空
Server 酱进阶
名称:Server 酱
请求方式: POST
请求类型: FORM
Body:
json{
+import{_ as o,o as s,c as a,R as l}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"通知设置","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/notifications.md","filePath":"guide/notifications.md","lastUpdated":1717546452000}'),n={name:"guide/notifications.md"},t=l(`通知设置
哪吒监控支持对服务器的负载、CPU、内存、硬盘、流量、月流量、进程数、连接数进行监控,并在达到用户设定的阈值时发送告警通知。
灵活的通知方式
- 在面板消息中,占位符
#DATETIME#
代表事件发生的时间戳。当通知被触发时,面板会自动将 #DATETIME#
替换为事件的实际时间。 #NEZHA#
是面板消息占位符,面板触发通知时会自动用实际消息替换占位符。- Body 内容是
JSON
格式的:当请求类型为 FORM 时,值为 key:value
的形式,value
里面可放置占位符,通知时会自动替换。当请求类型为 JSON 时 只会简单进行字符串替换后直接提交到 URL
。 - URL 里面也可放置占位符,请求时会进行简单的字符串替换。
请参考以下的通知方式示例,也可以根据自己的需求灵活设置推送方式。
Bark 示例
点击展开/收起
名称:Bark
URL 组成: /:key/:body or /:key/:title/:body or /:key/:category/:title/:body
请求方式: GET
请求类型: 默认
Body: 空
名称:Bark
URL 组成: /push
请求方式: POST
请求类型: form
Body: {"title": "#SERVER.NAME#","device_key":"xxxxxxxxx","body":"#NEZHA#","icon":"https://xxxxxxxx/nz.png"}
Slack 示例 贡献者:@白歌
点击展开/收起
URL 参数获取说明
请提前准备好 Slack 的 Workspace 并为这个 Workspace 创建一个 App。如果你还没有创建,可以在 Slack API 创建一个 App。
创建完成 App 后,需要为这个 App 添加一个 Incoming Webhook。在 App 的设置页面中找到 Incoming Webhooks,将 Activate Incoming Webhooks 勾选为 ON,在页面下方找到并点击 Add New Webhook to Workspace,选择一个 Channel,然后点击允许。完成创建后,你会得到一个 Webhook URL,使用这个 URL 替换下方的示例 URL。
- 名称:Slack
- URL:https://hooks.slack.com/services/xxxxxxxxx/xxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx
- 请求方式: POST
- 请求类型: JSON
- Body:
{"text":"#NEZHA#"}
Server 酱示例
点击展开/收起
- 名称:Server 酱
- URL:https://sc.ftqq.com/SCUrandomkeys.send?title=哪吒告警信息&desp=#NEZHA#
- 请求方式: GET
- 请求类型: 默认
- Body: 空
Server 酱进阶
名称:Server 酱
请求方式: POST
请求类型: FORM
Body:
json{
"title": "#SERVER.NAME#",
"desp": "**#NEZHA#\\n\\n平均负载: \\"#SERVER.LOAD1#\\",\\"#SERVER.LOAD5#\\",\\"#SERVER.LOAD15#\\"\\n\\n## [点击访问面板](https://你的面板域名)\\n\\n"
}

Telegram 示例 贡献者:@白歌
点击展开/收起
URL 参数获取说明
请提前在 Telegram 中创建一个机器人,获取到机器人的 token 和你的 Telegram 用户 ID。
机器人的 token 和用户 ID 都是数字和字母的组合,可以在 Telegram 中与 @userinfobot 对话获取自己的用户 ID。与 @BotFather 对话,输入命令 /newbot 创建一个机器人,创建完成后可以获得机器人的 token。
得到的 token 和用户 ID 都是字符串,可以直接拼接到 URL 中,如下所示,将其中的 botXXXXXX 替换为你的机器人 token,将 YYYYYY 替换为你的用户 ID。注意,你需要先与机器人对话,否则机器人无法发送消息给你。
- 名称:Telegram
- URL:https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&text=#NEZHA#
- 请求方式: GET
- 请求类型: 默认
- Body: 留空
wxpusher 示例
需要提前关注你的应用
点击展开/收起
- 名称: wxpusher
- URL:http://wxpusher.zjiecode.com/api/send/message
- 请求方式: POST
- 请求类型: JSON
- Body:
{"appToken":"你的appToken","topicIds":[],"content":"#NEZHA#","contentType":"1","uids":["你的uid"]}
邮件通知示例 - SendCloud 贡献者:@白歌
点击展开/收起
注意:SendCloud 有每日免费发送邮件限额限制,这里仅作示例,你可以选择付费服务或其他类似的免费服务,使用方法类似。
URL 参数获取说明
该示例使用 SendCloud 作为发信服务,需提前在 SendCloud 注册账号,创建发件邮箱,然后在这里获取 APIUSER 和 APIKEY。
替换示例 URL 中的 <替换APIUSER>
和 <替换APIKEY>
为自己的 APIUSER 和 APIKEY,替换 URL 中的 <自定义发件邮箱>
和 <自定义收件邮箱>
为任意的的发件邮箱和收件邮箱。
- 名称:邮件告警
- URL:https://api.sendcloud.net/apiv2/mail/send?apiUser=<替换APIUSER>&apiKey=<替换APIKEY>&from=<自定义发件邮箱>&fromName=Nezha&to=<自定义收件邮箱>&subject=Nezha-Notification&html=#NEZHA#
- 请求方式: POST
- 请求类型: JSON
- Header: 留空
- Body: 留空
钉钉群机器人配置 示例
点击展开/收起
URL 参数获取说明
请提前在钉钉中创建一个机器人,获取到机器人的 token。
机器人 URL 在钉钉群 - 管理机器人 - 创建机器人后获取,安全方式选择自定义关键词,Body 中 content 值内需包含该关键词。
- 名称: 哪吒探针小跟班
- URL:https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxxxxxxxxxxx
- 请求方式: POST
- 请求类型: JSON
- Header:
{"Content-Type": "application/json"}
- Body:
{"msgtype": "text","text": {"content":"哪吒探针:\\n#NEZHA#"}}
企业微信群机器人 示例 贡献者:@ChowRex
点击展开/收起
支持的占位符一览
json{
diff --git a/assets/guide_notifications.md.38c78f16.lean.js b/assets/guide_notifications.md.d6f11641.lean.js
similarity index 85%
rename from assets/guide_notifications.md.38c78f16.lean.js
rename to assets/guide_notifications.md.d6f11641.lean.js
index c2bd0e48..99573645 100644
--- a/assets/guide_notifications.md.38c78f16.lean.js
+++ b/assets/guide_notifications.md.d6f11641.lean.js
@@ -1 +1 @@
-import{_ as o,o as s,c as a,R as l}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"通知设置","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/notifications.md","filePath":"guide/notifications.md","lastUpdated":1717546110000}'),n={name:"guide/notifications.md"},t=l("",51),e=[t];function p(r,c,D,i,u,y){return s(),a("div",null,e)}const q=o(n,[["render",p]]);export{d as __pageData,q as default};
+import{_ as o,o as s,c as a,R as l}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"通知设置","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/notifications.md","filePath":"guide/notifications.md","lastUpdated":1717546452000}'),n={name:"guide/notifications.md"},t=l("",51),e=[t];function p(r,c,D,i,u,y){return s(),a("div",null,e)}const q=o(n,[["render",p]]);export{d as __pageData,q as default};
diff --git a/assets/guide_q1.md.4583d47c.js b/assets/guide_q1.md.9c44d7c6.js
similarity index 98%
rename from assets/guide_q1.md.4583d47c.js
rename to assets/guide_q1.md.9c44d7c6.js
index f31a8f88..dbc7c940 100644
--- a/assets/guide_q1.md.4583d47c.js
+++ b/assets/guide_q1.md.9c44d7c6.js
@@ -1,4 +1,4 @@
-import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"反向代理 Telegram Bot API","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q1.md","filePath":"guide/q1.md","lastUpdated":1717546110000}'),p={name:"guide/q1.md"},o=l(`反向代理 Telegram Bot API
如果你的 Dashboard 服务器无法访问 Telegram Bot API,但你依然想使用 Telegram 来推送通知,你可以尝试使用反向代理的方式解决这个问题。
准备工作
这里介绍使用你自己的服务器进行反代的方法。你也可以选择使用 Cloudflare 的 Workers 进行反代,但可能对于中国大陆的用户来说网络连通性依然不佳。
要搭建一个 Telegram Bot API 反代,你需要准备以下内容:
- 一个可以连接 Telegram Bot API 服务器(并安装好 Nginx)。
- 一个域名(提前申请 SSL 证书)。
NGINX 配置
编辑 Nginx 配置文件,在 http{}
中添加如下配置:
nginx# HTTP 强制跳转到 HTTPS
+import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"反向代理 Telegram Bot API","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q1.md","filePath":"guide/q1.md","lastUpdated":1717546452000}'),p={name:"guide/q1.md"},o=l(`反向代理 Telegram Bot API
如果你的 Dashboard 服务器无法访问 Telegram Bot API,但你依然想使用 Telegram 来推送通知,你可以尝试使用反向代理的方式解决这个问题。
准备工作
这里介绍使用你自己的服务器进行反代的方法。你也可以选择使用 Cloudflare 的 Workers 进行反代,但可能对于中国大陆的用户来说网络连通性依然不佳。
要搭建一个 Telegram Bot API 反代,你需要准备以下内容:
- 一个可以连接 Telegram Bot API 服务器(并安装好 Nginx)。
- 一个域名(提前申请 SSL 证书)。
NGINX 配置
编辑 Nginx 配置文件,在 http{}
中添加如下配置:
nginx# HTTP 强制跳转到 HTTPS
server {
listen 80;
listen [::]:80;
diff --git a/assets/guide_q1.md.4583d47c.lean.js b/assets/guide_q1.md.9c44d7c6.lean.js
similarity index 69%
rename from assets/guide_q1.md.4583d47c.lean.js
rename to assets/guide_q1.md.9c44d7c6.lean.js
index ce57f403..723d08b6 100644
--- a/assets/guide_q1.md.4583d47c.lean.js
+++ b/assets/guide_q1.md.9c44d7c6.lean.js
@@ -1 +1 @@
-import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"反向代理 Telegram Bot API","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q1.md","filePath":"guide/q1.md","lastUpdated":1717546110000}'),p={name:"guide/q1.md"},o=l("",17),e=[o];function t(c,r,C,y,D,A){return a(),n("div",null,e)}const d=s(p,[["render",t]]);export{F as __pageData,d as default};
+import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"反向代理 Telegram Bot API","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q1.md","filePath":"guide/q1.md","lastUpdated":1717546452000}'),p={name:"guide/q1.md"},o=l("",17),e=[o];function t(c,r,C,y,D,A){return a(),n("div",null,e)}const d=s(p,[["render",t]]);export{F as __pageData,d as default};
diff --git a/assets/guide_q2.md.17d230bc.js b/assets/guide_q2.md.90fc0fa0.js
similarity index 95%
rename from assets/guide_q2.md.17d230bc.js
rename to assets/guide_q2.md.90fc0fa0.js
index 6b9f2754..62b8facd 100644
--- a/assets/guide_q2.md.17d230bc.js
+++ b/assets/guide_q2.md.90fc0fa0.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Agent 启动/上线 问题自检流程","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q2.md","filePath":"guide/q2.md","lastUpdated":1717546110000}'),n={name:"guide/q2.md"},r=o('Agent 启动/上线 问题自检流程
- 直接执行
/opt/nezha/agent/nezha-agent -s 面板IP或非CDN域名:面板RPC端口 -p Agent密钥 -d
查看日志是否是因为 DNS、网络不佳导致超时(timeout) nc -v 域名/IP 面板RPC端口
或者 telnet 域名/IP 面板RPC端口
来检验是否是网络问题,检查本机与面板服务器的出入站防火墙,如果无法判断问题可借助 https://port.ping.pe/ 提供的端口检查工具进行检测。- 如果上面步骤检测正常,Agent 依然没有正常上线,请尝试关闭 SELinux,如何关闭 SELinux?
',2),i=[r];function c(s,_,d,l,p,g){return t(),a("div",null,i)}const u=e(n,[["render",c]]);export{f as __pageData,u as default};
+import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Agent 启动/上线 问题自检流程","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q2.md","filePath":"guide/q2.md","lastUpdated":1717546452000}'),n={name:"guide/q2.md"},r=o('Agent 启动/上线 问题自检流程
- 直接执行
/opt/nezha/agent/nezha-agent -s 面板IP或非CDN域名:面板RPC端口 -p Agent密钥 -d
查看日志是否是因为 DNS、网络不佳导致超时(timeout) nc -v 域名/IP 面板RPC端口
或者 telnet 域名/IP 面板RPC端口
来检验是否是网络问题,检查本机与面板服务器的出入站防火墙,如果无法判断问题可借助 https://port.ping.pe/ 提供的端口检查工具进行检测。- 如果上面步骤检测正常,Agent 依然没有正常上线,请尝试关闭 SELinux,如何关闭 SELinux?
',2),i=[r];function c(s,_,d,l,p,g){return t(),a("div",null,i)}const u=e(n,[["render",c]]);export{f as __pageData,u as default};
diff --git a/assets/guide_q2.md.17d230bc.lean.js b/assets/guide_q2.md.90fc0fa0.lean.js
similarity index 85%
rename from assets/guide_q2.md.17d230bc.lean.js
rename to assets/guide_q2.md.90fc0fa0.lean.js
index 1bcd31bc..934e0927 100644
--- a/assets/guide_q2.md.17d230bc.lean.js
+++ b/assets/guide_q2.md.90fc0fa0.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Agent 启动/上线 问题自检流程","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q2.md","filePath":"guide/q2.md","lastUpdated":1717546110000}'),n={name:"guide/q2.md"},r=o("",2),i=[r];function c(s,_,d,l,p,g){return t(),a("div",null,i)}const u=e(n,[["render",c]]);export{f as __pageData,u as default};
+import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Agent 启动/上线 问题自检流程","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q2.md","filePath":"guide/q2.md","lastUpdated":1717546452000}'),n={name:"guide/q2.md"},r=o("",2),i=[r];function c(s,_,d,l,p,g){return t(),a("div",null,i)}const u=e(n,[["render",c]]);export{f as __pageData,u as default};
diff --git a/assets/guide_q3.md.0512865c.js b/assets/guide_q3.md.87e45a0c.js
similarity index 99%
rename from assets/guide_q3.md.0512865c.js
rename to assets/guide_q3.md.87e45a0c.js
index 246e82cc..1d066b46 100644
--- a/assets/guide_q3.md.0512865c.js
+++ b/assets/guide_q3.md.87e45a0c.js
@@ -1,4 +1,4 @@
-import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"反向代理 gRPC 端口(支持 Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q3.md","filePath":"guide/q3.md","lastUpdated":1717546110000}'),p={name:"guide/q3.md"},o=l(`反向代理 gRPC 端口(支持 Cloudflare CDN)
使用 Nginx 或者 Caddy 反向代理 gRPC
- Nginx 配置
nginxserver {
+import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"反向代理 gRPC 端口(支持 Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q3.md","filePath":"guide/q3.md","lastUpdated":1717546452000}'),p={name:"guide/q3.md"},o=l(`反向代理 gRPC 端口(支持 Cloudflare CDN)
使用 Nginx 或者 Caddy 反向代理 gRPC
- Nginx 配置
nginxserver {
listen 443 ssl http2;
listen [::]:443 ssl http2;
server_name data.example.com; # 你的 Agent 连接 Dashboard 的域名
diff --git a/assets/guide_q3.md.0512865c.lean.js b/assets/guide_q3.md.87e45a0c.lean.js
similarity index 85%
rename from assets/guide_q3.md.0512865c.lean.js
rename to assets/guide_q3.md.87e45a0c.lean.js
index 6dbbe6d4..f3c86a5d 100644
--- a/assets/guide_q3.md.0512865c.lean.js
+++ b/assets/guide_q3.md.87e45a0c.lean.js
@@ -1 +1 @@
-import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"反向代理 gRPC 端口(支持 Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q3.md","filePath":"guide/q3.md","lastUpdated":1717546110000}'),p={name:"guide/q3.md"},o=l("",15),e=[o];function t(c,r,D,C,y,F){return n(),a("div",null,e)}const d=s(p,[["render",t]]);export{i as __pageData,d as default};
+import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"反向代理 gRPC 端口(支持 Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q3.md","filePath":"guide/q3.md","lastUpdated":1717546452000}'),p={name:"guide/q3.md"},o=l("",15),e=[o];function t(c,r,D,C,y,F){return n(),a("div",null,e)}const d=s(p,[["render",t]]);export{i as __pageData,d as default};
diff --git a/assets/guide_q4.md.6b1282ea.js b/assets/guide_q4.md.1db96d2f.js
similarity index 94%
rename from assets/guide_q4.md.6b1282ea.js
rename to assets/guide_q4.md.1db96d2f.js
index 749341a4..98b1b4a7 100644
--- a/assets/guide_q4.md.6b1282ea.js
+++ b/assets/guide_q4.md.1db96d2f.js
@@ -1 +1 @@
-import{_ as a,o,c as s,z as e,a as t}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"实时通道断开/在线终端连接失败","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q4.md","filePath":"guide/q4.md","lastUpdated":1717546110000}'),l={name:"guide/q4.md"},d=e("h1",{id:"实时通道断开-在线终端连接失败",tabindex:"-1"},[t("实时通道断开/在线终端连接失败 "),e("a",{class:"header-anchor",href:"#实时通道断开-在线终端连接失败","aria-label":'Permalink to "实时通道断开/在线终端连接失败"'},"")],-1),n=e("ul",null,[e("li",null,"如果你使用了 CDN,请确认 CDN 服务商提供 WebSocket 服务,并且已开启 WebSocket。"),e("li",null,[t("确认你的反代规则中针对 "),e("code",null,"/ws"),t(", "),e("code",null,"/terminal"),t(" 路径的 WebSocket 进行了特别配置,你可以 "),e("a",{href:"/guide/dashboard.html#配置反向代理"},"点击这里"),t(" 查看反向代理配置。")])],-1),r=[d,n];function c(i,_,u,h,m,p){return o(),s("div",null,r)}const k=a(l,[["render",c]]);export{b as __pageData,k as default};
+import{_ as a,o,c as s,z as e,a as t}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"实时通道断开/在线终端连接失败","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q4.md","filePath":"guide/q4.md","lastUpdated":1717546452000}'),l={name:"guide/q4.md"},d=e("h1",{id:"实时通道断开-在线终端连接失败",tabindex:"-1"},[t("实时通道断开/在线终端连接失败 "),e("a",{class:"header-anchor",href:"#实时通道断开-在线终端连接失败","aria-label":'Permalink to "实时通道断开/在线终端连接失败"'},"")],-1),n=e("ul",null,[e("li",null,"如果你使用了 CDN,请确认 CDN 服务商提供 WebSocket 服务,并且已开启 WebSocket。"),e("li",null,[t("确认你的反代规则中针对 "),e("code",null,"/ws"),t(", "),e("code",null,"/terminal"),t(" 路径的 WebSocket 进行了特别配置,你可以 "),e("a",{href:"/guide/dashboard.html#配置反向代理"},"点击这里"),t(" 查看反向代理配置。")])],-1),r=[d,n];function c(i,_,u,h,m,p){return o(),s("div",null,r)}const k=a(l,[["render",c]]);export{b as __pageData,k as default};
diff --git a/assets/guide_q4.md.6b1282ea.lean.js b/assets/guide_q4.md.1db96d2f.lean.js
similarity index 94%
rename from assets/guide_q4.md.6b1282ea.lean.js
rename to assets/guide_q4.md.1db96d2f.lean.js
index 749341a4..98b1b4a7 100644
--- a/assets/guide_q4.md.6b1282ea.lean.js
+++ b/assets/guide_q4.md.1db96d2f.lean.js
@@ -1 +1 @@
-import{_ as a,o,c as s,z as e,a as t}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"实时通道断开/在线终端连接失败","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q4.md","filePath":"guide/q4.md","lastUpdated":1717546110000}'),l={name:"guide/q4.md"},d=e("h1",{id:"实时通道断开-在线终端连接失败",tabindex:"-1"},[t("实时通道断开/在线终端连接失败 "),e("a",{class:"header-anchor",href:"#实时通道断开-在线终端连接失败","aria-label":'Permalink to "实时通道断开/在线终端连接失败"'},"")],-1),n=e("ul",null,[e("li",null,"如果你使用了 CDN,请确认 CDN 服务商提供 WebSocket 服务,并且已开启 WebSocket。"),e("li",null,[t("确认你的反代规则中针对 "),e("code",null,"/ws"),t(", "),e("code",null,"/terminal"),t(" 路径的 WebSocket 进行了特别配置,你可以 "),e("a",{href:"/guide/dashboard.html#配置反向代理"},"点击这里"),t(" 查看反向代理配置。")])],-1),r=[d,n];function c(i,_,u,h,m,p){return o(),s("div",null,r)}const k=a(l,[["render",c]]);export{b as __pageData,k as default};
+import{_ as a,o,c as s,z as e,a as t}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"实时通道断开/在线终端连接失败","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q4.md","filePath":"guide/q4.md","lastUpdated":1717546452000}'),l={name:"guide/q4.md"},d=e("h1",{id:"实时通道断开-在线终端连接失败",tabindex:"-1"},[t("实时通道断开/在线终端连接失败 "),e("a",{class:"header-anchor",href:"#实时通道断开-在线终端连接失败","aria-label":'Permalink to "实时通道断开/在线终端连接失败"'},"")],-1),n=e("ul",null,[e("li",null,"如果你使用了 CDN,请确认 CDN 服务商提供 WebSocket 服务,并且已开启 WebSocket。"),e("li",null,[t("确认你的反代规则中针对 "),e("code",null,"/ws"),t(", "),e("code",null,"/terminal"),t(" 路径的 WebSocket 进行了特别配置,你可以 "),e("a",{href:"/guide/dashboard.html#配置反向代理"},"点击这里"),t(" 查看反向代理配置。")])],-1),r=[d,n];function c(i,_,u,h,m,p){return o(),s("div",null,r)}const k=a(l,[["render",c]]);export{b as __pageData,k as default};
diff --git a/assets/guide_q5.md.851370fc.js b/assets/guide_q5.md.c0000c2d.js
similarity index 93%
rename from assets/guide_q5.md.851370fc.js
rename to assets/guide_q5.md.c0000c2d.js
index 378f5223..8536dac3 100644
--- a/assets/guide_q5.md.851370fc.js
+++ b/assets/guide_q5.md.c0000c2d.js
@@ -1 +1 @@
-import{_ as a,o as l,c as o,z as e,a as t}from"./chunks/framework.44fd0451.js";const x=JSON.parse('{"title":"如何进行数据迁移、备份恢复?","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q5.md","filePath":"guide/q5.md","lastUpdated":1717546110000}'),n={name:"guide/q5.md"},s=e("h1",{id:"如何进行数据迁移、备份恢复",tabindex:"-1"},[t("如何进行数据迁移、备份恢复? "),e("a",{class:"header-anchor",href:"#如何进行数据迁移、备份恢复","aria-label":'Permalink to "如何进行数据迁移、备份恢复?"'},"")],-1),d=e("ol",null,[e("li",null,[t("先运行一键脚本,选择 "),e("code",null,"停止面板")]),e("li",null,[t("在旧服务器中打包 "),e("code",null,"/opt/nezha"),t(" 文件夹,复制到新服务器相同位置解压")]),e("li",null,[t("在新服务器中运行一键脚本,选择 "),e("code",null,"启动面板")])],-1),c=[s,d];function r(i,_,u,p,h,m){return l(),o("div",null,c)}const g=a(n,[["render",r]]);export{x as __pageData,g as default};
+import{_ as a,o as l,c as o,z as e,a as t}from"./chunks/framework.44fd0451.js";const x=JSON.parse('{"title":"如何进行数据迁移、备份恢复?","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q5.md","filePath":"guide/q5.md","lastUpdated":1717546452000}'),n={name:"guide/q5.md"},s=e("h1",{id:"如何进行数据迁移、备份恢复",tabindex:"-1"},[t("如何进行数据迁移、备份恢复? "),e("a",{class:"header-anchor",href:"#如何进行数据迁移、备份恢复","aria-label":'Permalink to "如何进行数据迁移、备份恢复?"'},"")],-1),d=e("ol",null,[e("li",null,[t("先运行一键脚本,选择 "),e("code",null,"停止面板")]),e("li",null,[t("在旧服务器中打包 "),e("code",null,"/opt/nezha"),t(" 文件夹,复制到新服务器相同位置解压")]),e("li",null,[t("在新服务器中运行一键脚本,选择 "),e("code",null,"启动面板")])],-1),c=[s,d];function r(i,_,u,p,h,m){return l(),o("div",null,c)}const g=a(n,[["render",r]]);export{x as __pageData,g as default};
diff --git a/assets/guide_q5.md.851370fc.lean.js b/assets/guide_q5.md.c0000c2d.lean.js
similarity index 93%
rename from assets/guide_q5.md.851370fc.lean.js
rename to assets/guide_q5.md.c0000c2d.lean.js
index 378f5223..8536dac3 100644
--- a/assets/guide_q5.md.851370fc.lean.js
+++ b/assets/guide_q5.md.c0000c2d.lean.js
@@ -1 +1 @@
-import{_ as a,o as l,c as o,z as e,a as t}from"./chunks/framework.44fd0451.js";const x=JSON.parse('{"title":"如何进行数据迁移、备份恢复?","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q5.md","filePath":"guide/q5.md","lastUpdated":1717546110000}'),n={name:"guide/q5.md"},s=e("h1",{id:"如何进行数据迁移、备份恢复",tabindex:"-1"},[t("如何进行数据迁移、备份恢复? "),e("a",{class:"header-anchor",href:"#如何进行数据迁移、备份恢复","aria-label":'Permalink to "如何进行数据迁移、备份恢复?"'},"")],-1),d=e("ol",null,[e("li",null,[t("先运行一键脚本,选择 "),e("code",null,"停止面板")]),e("li",null,[t("在旧服务器中打包 "),e("code",null,"/opt/nezha"),t(" 文件夹,复制到新服务器相同位置解压")]),e("li",null,[t("在新服务器中运行一键脚本,选择 "),e("code",null,"启动面板")])],-1),c=[s,d];function r(i,_,u,p,h,m){return l(),o("div",null,c)}const g=a(n,[["render",r]]);export{x as __pageData,g as default};
+import{_ as a,o as l,c as o,z as e,a as t}from"./chunks/framework.44fd0451.js";const x=JSON.parse('{"title":"如何进行数据迁移、备份恢复?","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q5.md","filePath":"guide/q5.md","lastUpdated":1717546452000}'),n={name:"guide/q5.md"},s=e("h1",{id:"如何进行数据迁移、备份恢复",tabindex:"-1"},[t("如何进行数据迁移、备份恢复? "),e("a",{class:"header-anchor",href:"#如何进行数据迁移、备份恢复","aria-label":'Permalink to "如何进行数据迁移、备份恢复?"'},"")],-1),d=e("ol",null,[e("li",null,[t("先运行一键脚本,选择 "),e("code",null,"停止面板")]),e("li",null,[t("在旧服务器中打包 "),e("code",null,"/opt/nezha"),t(" 文件夹,复制到新服务器相同位置解压")]),e("li",null,[t("在新服务器中运行一键脚本,选择 "),e("code",null,"启动面板")])],-1),c=[s,d];function r(i,_,u,p,h,m){return l(),o("div",null,c)}const g=a(n,[["render",r]]);export{x as __pageData,g as default};
diff --git a/assets/guide_q6.md.b354fc64.js b/assets/guide_q6.md.e15f334b.js
similarity index 95%
rename from assets/guide_q6.md.b354fc64.js
rename to assets/guide_q6.md.e15f334b.js
index 89b76740..ce72e899 100644
--- a/assets/guide_q6.md.b354fc64.js
+++ b/assets/guide_q6.md.e15f334b.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"如何每月重置流量统计?","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q6.md","filePath":"guide/q6.md","lastUpdated":1717546110000}'),i={name:"guide/q6.md"},c=o('如何每月重置流量统计?
主页中的流量统计每次服务器重启时都会重置,如果要实现每月重置一次流量计数,可以这样实现:
- 进入管理面板的
告警
页 - 参考这篇文档,创建一个月流量告警
- 返回主页,在
服务
页中就可以看到月流量统计了,这里的统计数据不会因为服务器重启而重置
TIP
此方式可以设置任何周期,包括且不限于每小时/每天/每周/每月/每年重置流量统计,非常灵活!
',4),s=[c];function d(l,_,r,n,p,h){return t(),a("div",null,s)}const f=e(i,[["render",d]]);export{u as __pageData,f as default};
+import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"如何每月重置流量统计?","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q6.md","filePath":"guide/q6.md","lastUpdated":1717546452000}'),i={name:"guide/q6.md"},c=o('如何每月重置流量统计?
主页中的流量统计每次服务器重启时都会重置,如果要实现每月重置一次流量计数,可以这样实现:
- 进入管理面板的
告警
页 - 参考这篇文档,创建一个月流量告警
- 返回主页,在
服务
页中就可以看到月流量统计了,这里的统计数据不会因为服务器重启而重置
TIP
此方式可以设置任何周期,包括且不限于每小时/每天/每周/每月/每年重置流量统计,非常灵活!
',4),s=[c];function d(l,_,r,n,p,h){return t(),a("div",null,s)}const f=e(i,[["render",d]]);export{u as __pageData,f as default};
diff --git a/assets/guide_q6.md.b354fc64.lean.js b/assets/guide_q6.md.e15f334b.lean.js
similarity index 84%
rename from assets/guide_q6.md.b354fc64.lean.js
rename to assets/guide_q6.md.e15f334b.lean.js
index 8e54b07a..ede65878 100644
--- a/assets/guide_q6.md.b354fc64.lean.js
+++ b/assets/guide_q6.md.e15f334b.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"如何每月重置流量统计?","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q6.md","filePath":"guide/q6.md","lastUpdated":1717546110000}'),i={name:"guide/q6.md"},c=o("",4),s=[c];function d(l,_,r,n,p,h){return t(),a("div",null,s)}const f=e(i,[["render",d]]);export{u as __pageData,f as default};
+import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"如何每月重置流量统计?","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q6.md","filePath":"guide/q6.md","lastUpdated":1717546452000}'),i={name:"guide/q6.md"},c=o("",4),s=[c];function d(l,_,r,n,p,h){return t(),a("div",null,s)}const f=e(i,[["render",d]]);export{u as __pageData,f as default};
diff --git a/assets/guide_q7.md.43b16142.js b/assets/guide_q7.md.43a66b10.js
similarity index 95%
rename from assets/guide_q7.md.43b16142.js
rename to assets/guide_q7.md.43a66b10.js
index 8fcae75b..cdd9b4f0 100644
--- a/assets/guide_q7.md.43b16142.js
+++ b/assets/guide_q7.md.43a66b10.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"自定义 Agent 监控项目","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q7.md","filePath":"guide/q7.md","lastUpdated":1717546110000}'),n={name:"guide/q7.md"},o=s('自定义 Agent 监控项目
自定义监控的网卡和硬盘分区
执行以下命令来选择自定义的网卡和分区,然后重启 Agent 即可生效:
bash/opt/nezha/agent/nezha-agent --edit-agent-config
其他运行参数
通过执行以下命令查看支持的参数:
bash./nezha-agent --help
如果你使用了一键脚本安装 Agent,可以编辑 /etc/systemd/system/nezha-agent.service
,在 ExecStart=
这一行的末尾加上以下参数:
--report-delay
:控制系统信息上报的间隔,默认为 1 秒,可以设置为 3 来进一步降低 agent 端系统资源占用(配置区间 1-4)。--skip-conn
:不监控连接数,推荐在机场/连接密集型服务器或CPU占用较高的服务器上设置。--skip-procs
:不监控进程数,也可以降低 Agent 占用。--disable-auto-update
:禁止 自动更新 Agent(安全特性)。--disable-force-update
:禁止 强制更新 Agent(安全特性)。--disable-command-execute
:禁止在 Agent 上执行定时任务、打开在线终端(安全特性)。--tls
:启用 SSL/TLS 加密(使用 nginx 反向代理 Agent 的 grpc 连接,并且 nginx 开启 SSL/TLS 时,需要启用该项配置)。
',9),l=[o];function c(i,d,p,r,g,h){return a(),t("div",null,l)}const m=e(n,[["render",c]]);export{u as __pageData,m as default};
+import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"自定义 Agent 监控项目","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q7.md","filePath":"guide/q7.md","lastUpdated":1717546452000}'),n={name:"guide/q7.md"},o=s('自定义 Agent 监控项目
自定义监控的网卡和硬盘分区
执行以下命令来选择自定义的网卡和分区,然后重启 Agent 即可生效:
bash/opt/nezha/agent/nezha-agent --edit-agent-config
其他运行参数
通过执行以下命令查看支持的参数:
bash./nezha-agent --help
如果你使用了一键脚本安装 Agent,可以编辑 /etc/systemd/system/nezha-agent.service
,在 ExecStart=
这一行的末尾加上以下参数:
--report-delay
:控制系统信息上报的间隔,默认为 1 秒,可以设置为 3 来进一步降低 agent 端系统资源占用(配置区间 1-4)。--skip-conn
:不监控连接数,推荐在机场/连接密集型服务器或CPU占用较高的服务器上设置。--skip-procs
:不监控进程数,也可以降低 Agent 占用。--disable-auto-update
:禁止 自动更新 Agent(安全特性)。--disable-force-update
:禁止 强制更新 Agent(安全特性)。--disable-command-execute
:禁止在 Agent 上执行定时任务、打开在线终端(安全特性)。--tls
:启用 SSL/TLS 加密(使用 nginx 反向代理 Agent 的 grpc 连接,并且 nginx 开启 SSL/TLS 时,需要启用该项配置)。
',9),l=[o];function c(i,d,p,r,g,h){return a(),t("div",null,l)}const m=e(n,[["render",c]]);export{u as __pageData,m as default};
diff --git a/assets/guide_q7.md.43b16142.lean.js b/assets/guide_q7.md.43a66b10.lean.js
similarity index 69%
rename from assets/guide_q7.md.43b16142.lean.js
rename to assets/guide_q7.md.43a66b10.lean.js
index 35b7a5f2..1cd99ca0 100644
--- a/assets/guide_q7.md.43b16142.lean.js
+++ b/assets/guide_q7.md.43a66b10.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"自定义 Agent 监控项目","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q7.md","filePath":"guide/q7.md","lastUpdated":1717546110000}'),n={name:"guide/q7.md"},o=s("",9),l=[o];function c(i,d,p,r,g,h){return a(),t("div",null,l)}const m=e(n,[["render",c]]);export{u as __pageData,m as default};
+import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"自定义 Agent 监控项目","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q7.md","filePath":"guide/q7.md","lastUpdated":1717546452000}'),n={name:"guide/q7.md"},o=s("",9),l=[o];function c(i,d,p,r,g,h){return a(),t("div",null,l)}const m=e(n,[["render",c]]);export{u as __pageData,m as default};
diff --git a/assets/guide_q8.md.8d778be4.js b/assets/guide_q8.md.732e2dfd.js
similarity index 98%
rename from assets/guide_q8.md.8d778be4.js
rename to assets/guide_q8.md.732e2dfd.js
index bce71df0..e3760ff7 100644
--- a/assets/guide_q8.md.8d778be4.js
+++ b/assets/guide_q8.md.732e2dfd.js
@@ -1,4 +1,4 @@
-import{_ as e,o as a,c as o,R as c}from"./chunks/framework.44fd0451.js";const D=JSON.parse('{"title":"使用 Cloudflare Access 作为 OAuth2 提供方","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q8.md","filePath":"guide/q8.md","lastUpdated":1717546110000}'),s={name:"guide/q8.md"},t=c(`使用 Cloudflare Access 作为 OAuth2 提供方
相较于 Github,Cloudflare Access 对于中国大陆用户更加友好。如您当前使用 Github、Gitlab、Gitee 作为管理员账户登录时遇到问题,您可以考虑切换 Cloudflare Access 作为 OAuth2 提供方
示例配置:
yamlOauth2:
+import{_ as e,o as a,c as o,R as c}from"./chunks/framework.44fd0451.js";const D=JSON.parse('{"title":"使用 Cloudflare Access 作为 OAuth2 提供方","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q8.md","filePath":"guide/q8.md","lastUpdated":1717546452000}'),s={name:"guide/q8.md"},t=c(`使用 Cloudflare Access 作为 OAuth2 提供方
相较于 Github,Cloudflare Access 对于中国大陆用户更加友好。如您当前使用 Github、Gitlab、Gitee 作为管理员账户登录时遇到问题,您可以考虑切换 Cloudflare Access 作为 OAuth2 提供方
示例配置:
yamlOauth2:
Admin: 701b9ea6-9f56-48cd-af3e-cbb4bfc1475c
ClientID: 3516291f53eca9b4901a01337e41be7dc52f565c8657d08a3fddb2178d13c5bf
ClientSecret: 0568b67c7b6d0ed51c663e2fe935683007c28f947a27b7bd47a5ad3d8b56fb67
diff --git a/assets/guide_q8.md.8d778be4.lean.js b/assets/guide_q8.md.732e2dfd.lean.js
similarity index 85%
rename from assets/guide_q8.md.8d778be4.lean.js
rename to assets/guide_q8.md.732e2dfd.lean.js
index 078d9716..e0c67a79 100644
--- a/assets/guide_q8.md.8d778be4.lean.js
+++ b/assets/guide_q8.md.732e2dfd.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as o,R as c}from"./chunks/framework.44fd0451.js";const D=JSON.parse('{"title":"使用 Cloudflare Access 作为 OAuth2 提供方","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q8.md","filePath":"guide/q8.md","lastUpdated":1717546110000}'),s={name:"guide/q8.md"},t=c("",11),l=[t];function d(n,r,p,i,h,u){return a(),o("div",null,l)}const C=e(s,[["render",d]]);export{D as __pageData,C as default};
+import{_ as e,o as a,c as o,R as c}from"./chunks/framework.44fd0451.js";const D=JSON.parse('{"title":"使用 Cloudflare Access 作为 OAuth2 提供方","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q8.md","filePath":"guide/q8.md","lastUpdated":1717546452000}'),s={name:"guide/q8.md"},t=c("",11),l=[t];function d(n,r,p,i,h,u){return a(),o("div",null,l)}const C=e(s,[["render",d]]);export{D as __pageData,C as default};
diff --git a/assets/guide_servers.md.503f6740.js b/assets/guide_servers.md.c1c9d76d.js
similarity index 99%
rename from assets/guide_servers.md.503f6740.js
rename to assets/guide_servers.md.c1c9d76d.js
index 945e8e72..170216b6 100644
--- a/assets/guide_servers.md.503f6740.js
+++ b/assets/guide_servers.md.c1c9d76d.js
@@ -1,4 +1,4 @@
-import{_ as s,o as a,c as o,R as e}from"./chunks/framework.44fd0451.js";const C=JSON.parse('{"title":"服务器","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/servers.md","filePath":"guide/servers.md","lastUpdated":1717546110000}'),l={name:"guide/servers.md"},n=e(`服务器
介绍
服务器区域负责管理 Agent,是哪吒探针中最基础的区域,也是其他功能的基础。
新增服务器
第一步是新增服务器,可以自定义名称、分组、排序和备注。
拥有相同分组的服务器会在受支持的主题中划分到一起进行显示,备注仅会在后台显示,无需担心泄露信息。
安装 Agent
请参考前文安装 Agent。
推荐使用一键安装,即配置好参数后,点击服务器一键安装列上的对应的系统图标即可复制安装命令,在相应服务器上进行安装。
强制更新
Agent 更新相关的参数是 自定义 Agent 监控项目 中的 --disable-auto-update
和 --disable-force-update
。
默认情况下,Agent 会自动更新,无需干预。但当用户关闭自动更新后,也可以选中指定服务器进行强制更新。
disable-force-update
开启时此功能不生效。
数据列
- 版本号:记录 Agent 当前版本。
- 对游客隐藏:为 True 时,游客在面板中无法查看到此服务器。
- 启用 DDNS:为 True 时,当该服务器 IP 发生变化,Dashboard 会自动更新 DNS 记录。
- DDNS 域名:为该服务器配置的 DDNS 域名。
- 密钥:即 secret/key,配置 Agent 时会用到,用于验证 Agent 与 Dashboard 的通信。
- 一键安装:点击相应的系统按钮,复制命令到服务器执行即可一键安装。
- 管理:分别为连接 WebShell,修改服务器配置,删除服务器。
在线终端
即 WebShell,disable-command-execute
开启时此功能不生效。
Linux 和 Windows 均可用,可使用 Ctrl+Shift+V 粘贴。
连接失败请参考实时通道断开/在线终端连接失败。
注意在线终端功能中,Agent 也是通过 WebSocket 连接到公开访问域名,而非通过 gRPC 交互。
DDNS 功能
DDNS 功能适用于使用动态 IP 的服务器,当 Agent 上报了一个新的 IP,Dashboard 会根据配置自动更新 DNS 记录。
为什么我要使用哪吒监控的 DDNS 功能?
- 方便集中管理 DDNS 设置,而不是在每台服务器上都部署一个 DDNS 服务。
- 仅在面板服务器上保存您的机密信息,防止外泄。
配置说明
目前 DDNS 功能支持两种形式的配置:单配置和多配置。如使用单配置,则所有 Agent 服务器都使用相同的配置更新 DDNS;如使用多配置,则可为每台服务器指定一个配置更新 DDNS,灵活性更强。
单配置
yamlDDNS:
+import{_ as s,o as a,c as o,R as e}from"./chunks/framework.44fd0451.js";const C=JSON.parse('{"title":"服务器","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/servers.md","filePath":"guide/servers.md","lastUpdated":1717546452000}'),l={name:"guide/servers.md"},n=e(`服务器
介绍
服务器区域负责管理 Agent,是哪吒探针中最基础的区域,也是其他功能的基础。
新增服务器
第一步是新增服务器,可以自定义名称、分组、排序和备注。
拥有相同分组的服务器会在受支持的主题中划分到一起进行显示,备注仅会在后台显示,无需担心泄露信息。
安装 Agent
请参考前文安装 Agent。
推荐使用一键安装,即配置好参数后,点击服务器一键安装列上的对应的系统图标即可复制安装命令,在相应服务器上进行安装。
强制更新
Agent 更新相关的参数是 自定义 Agent 监控项目 中的 --disable-auto-update
和 --disable-force-update
。
默认情况下,Agent 会自动更新,无需干预。但当用户关闭自动更新后,也可以选中指定服务器进行强制更新。
disable-force-update
开启时此功能不生效。
数据列
- 版本号:记录 Agent 当前版本。
- 对游客隐藏:为 True 时,游客在面板中无法查看到此服务器。
- 启用 DDNS:为 True 时,当该服务器 IP 发生变化,Dashboard 会自动更新 DNS 记录。
- DDNS 域名:为该服务器配置的 DDNS 域名。
- 密钥:即 secret/key,配置 Agent 时会用到,用于验证 Agent 与 Dashboard 的通信。
- 一键安装:点击相应的系统按钮,复制命令到服务器执行即可一键安装。
- 管理:分别为连接 WebShell,修改服务器配置,删除服务器。
在线终端
即 WebShell,disable-command-execute
开启时此功能不生效。
Linux 和 Windows 均可用,可使用 Ctrl+Shift+V 粘贴。
连接失败请参考实时通道断开/在线终端连接失败。
注意在线终端功能中,Agent 也是通过 WebSocket 连接到公开访问域名,而非通过 gRPC 交互。
DDNS 功能
DDNS 功能适用于使用动态 IP 的服务器,当 Agent 上报了一个新的 IP,Dashboard 会根据配置自动更新 DNS 记录。
为什么我要使用哪吒监控的 DDNS 功能?
- 方便集中管理 DDNS 设置,而不是在每台服务器上都部署一个 DDNS 服务。
- 仅在面板服务器上保存您的机密信息,防止外泄。
配置说明
目前 DDNS 功能支持两种形式的配置:单配置和多配置。如使用单配置,则所有 Agent 服务器都使用相同的配置更新 DDNS;如使用多配置,则可为每台服务器指定一个配置更新 DDNS,灵活性更强。
单配置
yamlDDNS:
Enable: true
Provider: "webhook"
AccessID: ""
diff --git a/assets/guide_servers.md.503f6740.lean.js b/assets/guide_servers.md.c1c9d76d.lean.js
similarity index 85%
rename from assets/guide_servers.md.503f6740.lean.js
rename to assets/guide_servers.md.c1c9d76d.lean.js
index febd6f51..a54d1e5f 100644
--- a/assets/guide_servers.md.503f6740.lean.js
+++ b/assets/guide_servers.md.c1c9d76d.lean.js
@@ -1 +1 @@
-import{_ as s,o as a,c as o,R as e}from"./chunks/framework.44fd0451.js";const C=JSON.parse('{"title":"服务器","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/servers.md","filePath":"guide/servers.md","lastUpdated":1717546110000}'),l={name:"guide/servers.md"},n=e("",39),p=[n];function c(t,r,D,d,i,y){return a(),o("div",null,p)}const h=s(l,[["render",c]]);export{C as __pageData,h as default};
+import{_ as s,o as a,c as o,R as e}from"./chunks/framework.44fd0451.js";const C=JSON.parse('{"title":"服务器","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/servers.md","filePath":"guide/servers.md","lastUpdated":1717546452000}'),l={name:"guide/servers.md"},n=e("",39),p=[n];function c(t,r,D,d,i,y){return a(),o("div",null,p)}const h=s(l,[["render",c]]);export{C as __pageData,h as default};
diff --git a/assets/guide_services.md.d330cf8e.js b/assets/guide_services.md.9507c71b.js
similarity index 98%
rename from assets/guide_services.md.d330cf8e.js
rename to assets/guide_services.md.9507c71b.js
index 9985d466..85bed355 100644
--- a/assets/guide_services.md.d330cf8e.js
+++ b/assets/guide_services.md.9507c71b.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"服务监控","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/services.md","filePath":"guide/services.md","lastUpdated":1717546110000}'),r={name:"guide/services.md"},i=o('服务监控
服务区域是设置 Agent 监控外部网站或服务器的功能设置区
设置好的服务监控可以在主页中的“服务”页查看过去 30 天的可用性监控结果
使用方法
如需新增一个监控,可以进入管理面板中的“服务”页,点击“添加监控”。
新增一个服务监控时,你需要设置以下参数:
名称:自定义一个名称。
类型:选择一个监控类型。目前哪吒监控支持三种监控类型,分别是“HTTP-GET”、“ICMP-Ping”和“TCP-Ping”。
目标:根据你选择的类型不同,目标的设置方法也不同:
HTTP-GET
:选择此类型时,你应输入一个 URL 作为目标,URL 需添加 http://
或 https://
。如果你的目标 URL 是 https://
,将会同时监控该 URL 的 SSL 证书,当 SSL 证书到期或发生变更,会触发提醒。例如:https://example.com。ICMP-Ping
:选择此类型时,你应输入一个域名或 IP,不含端口号。例如:1.1.1.1 或 example.com。TCP-Ping
:选择此类型时,你应输入一个域名或 IP 并包含端口号。例如:1.1.1.1:80 或 example.com:22。
请求间隔:设定 Agent 每次请求目标的时间间隔,以秒为单位。
覆盖范围:选择一条规则来确定要使用哪些 Agent 来请求目标。
特定服务器:配合覆盖范围使用,选择规则内需要排除的 Agent。
通知方式组:选择你已经在“告警”页设置好的通知方式,点击这里了解详情。
启用故障通知:根据需要选择是否接收目标故障通知,默认为不勾选。
设置完成后,点击“添加”即可。稍等片刻前往主页的“服务”页查看监控结果。
延迟变化告警
哪吒监控可以监测并统计 Agent 到目标服务器之间的延迟,在发生较大变化的情况下发送通知。利用此功能可以帮助你监控服务器的线路是否发生了变化。
- 启用延迟通知:开启时,当 Agent 至目标服务器的延迟大于
最高延迟
或小于最低延迟
时,将会发送告警通知。
告警时触发任务
如果你需要在服务监控告警触发时执行一些任务,可以勾选“启用触发任务”,并在“告警时触发任务”和“恢复时触发任务”中选择你已经提前设置好的触发任务。
网络延迟图表
在服务页中设置的 TCP-Ping 和 ICMP-Ping 类型的监控都会自动启用监控图表功能。在主页的“网络”页中,你可以查看历史网络延迟监控图表。图表中的数据是根据 Agent 到目标服务器的延迟统计而来,你可以点击 Agent 的名称来切换图表。在图表中,可以取消勾选目标服务器的名称来隐藏或显示对应的数据。
管理监控
如需对已有的服务监控进行管理,可以前往管理面板中的“服务”页。选择一条监控配置,点击右侧的图标进行编辑或删除。
',16),n=[i];function l(s,c,d,p,g,h){return t(),a("div",null,n)}const P=e(r,[["render",l]]);export{_ as __pageData,P as default};
+import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"服务监控","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/services.md","filePath":"guide/services.md","lastUpdated":1717546452000}'),r={name:"guide/services.md"},i=o('服务监控
服务区域是设置 Agent 监控外部网站或服务器的功能设置区
设置好的服务监控可以在主页中的“服务”页查看过去 30 天的可用性监控结果
使用方法
如需新增一个监控,可以进入管理面板中的“服务”页,点击“添加监控”。
新增一个服务监控时,你需要设置以下参数:
名称:自定义一个名称。
类型:选择一个监控类型。目前哪吒监控支持三种监控类型,分别是“HTTP-GET”、“ICMP-Ping”和“TCP-Ping”。
目标:根据你选择的类型不同,目标的设置方法也不同:
HTTP-GET
:选择此类型时,你应输入一个 URL 作为目标,URL 需添加 http://
或 https://
。如果你的目标 URL 是 https://
,将会同时监控该 URL 的 SSL 证书,当 SSL 证书到期或发生变更,会触发提醒。例如:https://example.com。ICMP-Ping
:选择此类型时,你应输入一个域名或 IP,不含端口号。例如:1.1.1.1 或 example.com。TCP-Ping
:选择此类型时,你应输入一个域名或 IP 并包含端口号。例如:1.1.1.1:80 或 example.com:22。
请求间隔:设定 Agent 每次请求目标的时间间隔,以秒为单位。
覆盖范围:选择一条规则来确定要使用哪些 Agent 来请求目标。
特定服务器:配合覆盖范围使用,选择规则内需要排除的 Agent。
通知方式组:选择你已经在“告警”页设置好的通知方式,点击这里了解详情。
启用故障通知:根据需要选择是否接收目标故障通知,默认为不勾选。
设置完成后,点击“添加”即可。稍等片刻前往主页的“服务”页查看监控结果。
延迟变化告警
哪吒监控可以监测并统计 Agent 到目标服务器之间的延迟,在发生较大变化的情况下发送通知。利用此功能可以帮助你监控服务器的线路是否发生了变化。
- 启用延迟通知:开启时,当 Agent 至目标服务器的延迟大于
最高延迟
或小于最低延迟
时,将会发送告警通知。
告警时触发任务
如果你需要在服务监控告警触发时执行一些任务,可以勾选“启用触发任务”,并在“告警时触发任务”和“恢复时触发任务”中选择你已经提前设置好的触发任务。
网络延迟图表
在服务页中设置的 TCP-Ping 和 ICMP-Ping 类型的监控都会自动启用监控图表功能。在主页的“网络”页中,你可以查看历史网络延迟监控图表。图表中的数据是根据 Agent 到目标服务器的延迟统计而来,你可以点击 Agent 的名称来切换图表。在图表中,可以取消勾选目标服务器的名称来隐藏或显示对应的数据。
管理监控
如需对已有的服务监控进行管理,可以前往管理面板中的“服务”页。选择一条监控配置,点击右侧的图标进行编辑或删除。
',16),n=[i];function l(s,c,d,p,g,h){return t(),a("div",null,n)}const P=e(r,[["render",l]]);export{_ as __pageData,P as default};
diff --git a/assets/guide_services.md.d330cf8e.lean.js b/assets/guide_services.md.9507c71b.lean.js
similarity index 85%
rename from assets/guide_services.md.d330cf8e.lean.js
rename to assets/guide_services.md.9507c71b.lean.js
index 909fdf99..3ac57662 100644
--- a/assets/guide_services.md.d330cf8e.lean.js
+++ b/assets/guide_services.md.9507c71b.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"服务监控","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/services.md","filePath":"guide/services.md","lastUpdated":1717546110000}'),r={name:"guide/services.md"},i=o("",16),n=[i];function l(s,c,d,p,g,h){return t(),a("div",null,n)}const P=e(r,[["render",l]]);export{_ as __pageData,P as default};
+import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"服务监控","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/services.md","filePath":"guide/services.md","lastUpdated":1717546452000}'),r={name:"guide/services.md"},i=o("",16),n=[i];function l(s,c,d,p,g,h){return t(),a("div",null,n)}const P=e(r,[["render",l]]);export{_ as __pageData,P as default};
diff --git a/assets/guide_settings.md.e5b7fcac.js b/assets/guide_settings.md.7f9f3a08.js
similarity index 99%
rename from assets/guide_settings.md.e5b7fcac.js
rename to assets/guide_settings.md.7f9f3a08.js
index 018f028d..a3157545 100644
--- a/assets/guide_settings.md.e5b7fcac.js
+++ b/assets/guide_settings.md.7f9f3a08.js
@@ -1,4 +1,4 @@
-import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"设置","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/settings.md","filePath":"guide/settings.md","lastUpdated":1717546110000}'),p={name:"guide/settings.md"},o=l(`设置
站点标题
你可以在此项中自定义站点标题。
管理员列表
- 如果你修改了自己的 Github、Gitlab 或 Gitee 的用户名,需要在此项中同步修改,否则无法登录。多个用户请用逗号隔开:
user1,user2
。 - 如需更改管理员账户,请前往
/opt/nezha/dashboard/data/config.yaml
,重新设置新的管理员 Client ID
和 Client Secret
。
界面主题
在这里选择主页和管理界面主题,如果选项中没有某个已存在的主题,请更新面板。
启用 Custom 主题前,你需要提前安装自定义主题,否则启用该项后,面板将无法正常显示。
Language
哪吒监控目前支持以下语言:
- 简体中文
- 繁體中文
- English
- Español
我们欢迎您对翻译进行勘误或贡献更多语言。
自定义代码 (style, script)
可以在此修改 LOGO、修改色调、添加美化代码和统计代码等。
WARNING
自定义代码仅在游客首页生效,管理面板不生效。由于不同主题的代码不同,如确需修改管理面板中的内容,请修改 Docker 中的主题文件。
默认主题更改进度条颜色、背景图片、导航栏等效果示例
点击展开/收起
html<style>
+import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"设置","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/settings.md","filePath":"guide/settings.md","lastUpdated":1717546452000}'),p={name:"guide/settings.md"},o=l(`设置
站点标题
你可以在此项中自定义站点标题。
管理员列表
- 如果你修改了自己的 Github、Gitlab 或 Gitee 的用户名,需要在此项中同步修改,否则无法登录。多个用户请用逗号隔开:
user1,user2
。 - 如需更改管理员账户,请前往
/opt/nezha/dashboard/data/config.yaml
,重新设置新的管理员 Client ID
和 Client Secret
。
界面主题
在这里选择主页和管理界面主题,如果选项中没有某个已存在的主题,请更新面板。
启用 Custom 主题前,你需要提前安装自定义主题,否则启用该项后,面板将无法正常显示。
Language
哪吒监控目前支持以下语言:
- 简体中文
- 繁體中文
- English
- Español
我们欢迎您对翻译进行勘误或贡献更多语言。
自定义代码 (style, script)
可以在此修改 LOGO、修改色调、添加美化代码和统计代码等。
WARNING
自定义代码仅在游客首页生效,管理面板不生效。由于不同主题的代码不同,如确需修改管理面板中的内容,请修改 Docker 中的主题文件。
默认主题更改进度条颜色、背景图片、导航栏等效果示例
点击展开/收起
html<style>
/* 屏幕适配 */
@media only screen and (min-width: 1200px) {
.ui.container {
diff --git a/assets/guide_settings.md.e5b7fcac.lean.js b/assets/guide_settings.md.7f9f3a08.lean.js
similarity index 85%
rename from assets/guide_settings.md.e5b7fcac.lean.js
rename to assets/guide_settings.md.7f9f3a08.lean.js
index c9e8ded8..4f94fcd3 100644
--- a/assets/guide_settings.md.e5b7fcac.lean.js
+++ b/assets/guide_settings.md.7f9f3a08.lean.js
@@ -1 +1 @@
-import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"设置","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/settings.md","filePath":"guide/settings.md","lastUpdated":1717546110000}'),p={name:"guide/settings.md"},o=l("",39),e=[o];function t(r,c,F,D,y,C){return a(),n("div",null,e)}const B=s(p,[["render",t]]);export{i as __pageData,B as default};
+import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"设置","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/settings.md","filePath":"guide/settings.md","lastUpdated":1717546452000}'),p={name:"guide/settings.md"},o=l("",39),e=[o];function t(r,c,F,D,y,C){return a(),n("div",null,e)}const B=s(p,[["render",t]]);export{i as __pageData,B as default};
diff --git a/assets/guide_tasks.md.12a890b2.js b/assets/guide_tasks.md.ce8d2424.js
similarity index 96%
rename from assets/guide_tasks.md.12a890b2.js
rename to assets/guide_tasks.md.ce8d2424.js
index 90015922..5f44efd2 100644
--- a/assets/guide_tasks.md.12a890b2.js
+++ b/assets/guide_tasks.md.ce8d2424.js
@@ -1 +1 @@
-import{_ as t,o,c as e,R as r}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"任务管理","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/tasks.md","filePath":"guide/tasks.md","lastUpdated":1717546110000}'),a={name:"guide/tasks.md"},s=r('任务管理
在任务区域中,可以设置计划任务,触发任务,多服务器批量执行任务
哪吒监控支持推送命令到 Agent 执行,此功能非常灵活。使用此功能可以定期结合 restic、rclone 给服务器备份,定期重启某项服务来重置网络连接。也可以配合告警通知,在触发告警时执行某项任务,例如在 CPU 长时间高占用的情况下运行某个脚本。
使用方法
进入管理面板的“任务”页,点击“添加计划任务”。添加计划任务时,你需要填入以下参数:
名称:自定义一个任务名称。
任务类型:选择任务的类型。
- 计划任务:按下方设置的计划时间,周期性执行任务。
- 触发任务:仅被 API 或告警规则触发的任务,每次触发执行一次。
计划:设置计划时间(使用触发任务类型时不生效),时间格式为:* * * * * *
,分别对应秒 分 时 天 月 星期
,详情见计划表达式格式。
例如:0 0 3 * * *
对应为“每天 3 点”。
命令:设置需要执行的命令,就像写 Shell/Bat 脚本一样,但不推荐换行,多个命令使用 &&/&
连接。
例如执行定期重启命令,可以在这里输入 reboot
。
覆盖范围和特定服务器:选择规则来确定哪些 Agent 执行计划任务,类似于“服务”页中的设置。使用触发任务类型时,可选择“由触发的服务器执行”。
通知方式组:选择你已经在“告警”页设置好的通知方式,点击这里了解详情。
推送成功的消息:勾选此项,任务执行成功后会触发消息通知。
管理任务
如需对已有的计划任务进行管理,可以前往管理面板中的“任务”页。选择一条任务配置,右侧的三个图标分别是:
- 立即执行:点击后将忽略计划时间,立刻执行任务。
- 编辑:点击可以修改任务配置。
- 删除:删除这条计划任务。
常见问题
- xxx 命令找不到
如果运行失败,提示 xxx 命令找不到,可能是 PATH 环境变量的问题。在 Linux 服务器上,可以在命令开头加入 source ~/.bashrc
,或者使用绝对路径执行命令。
',11),n=[s];function i(l,c,d,g,p,h){return o(),e("div",null,n)}const m=t(a,[["render",i]]);export{u as __pageData,m as default};
+import{_ as t,o,c as e,R as r}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"任务管理","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/tasks.md","filePath":"guide/tasks.md","lastUpdated":1717546452000}'),a={name:"guide/tasks.md"},s=r('任务管理
在任务区域中,可以设置计划任务,触发任务,多服务器批量执行任务
哪吒监控支持推送命令到 Agent 执行,此功能非常灵活。使用此功能可以定期结合 restic、rclone 给服务器备份,定期重启某项服务来重置网络连接。也可以配合告警通知,在触发告警时执行某项任务,例如在 CPU 长时间高占用的情况下运行某个脚本。
使用方法
进入管理面板的“任务”页,点击“添加计划任务”。添加计划任务时,你需要填入以下参数:
名称:自定义一个任务名称。
任务类型:选择任务的类型。
- 计划任务:按下方设置的计划时间,周期性执行任务。
- 触发任务:仅被 API 或告警规则触发的任务,每次触发执行一次。
计划:设置计划时间(使用触发任务类型时不生效),时间格式为:* * * * * *
,分别对应秒 分 时 天 月 星期
,详情见计划表达式格式。
例如:0 0 3 * * *
对应为“每天 3 点”。
命令:设置需要执行的命令,就像写 Shell/Bat 脚本一样,但不推荐换行,多个命令使用 &&/&
连接。
例如执行定期重启命令,可以在这里输入 reboot
。
覆盖范围和特定服务器:选择规则来确定哪些 Agent 执行计划任务,类似于“服务”页中的设置。使用触发任务类型时,可选择“由触发的服务器执行”。
通知方式组:选择你已经在“告警”页设置好的通知方式,点击这里了解详情。
推送成功的消息:勾选此项,任务执行成功后会触发消息通知。
管理任务
如需对已有的计划任务进行管理,可以前往管理面板中的“任务”页。选择一条任务配置,右侧的三个图标分别是:
- 立即执行:点击后将忽略计划时间,立刻执行任务。
- 编辑:点击可以修改任务配置。
- 删除:删除这条计划任务。
常见问题
- xxx 命令找不到
如果运行失败,提示 xxx 命令找不到,可能是 PATH 环境变量的问题。在 Linux 服务器上,可以在命令开头加入 source ~/.bashrc
,或者使用绝对路径执行命令。
',11),n=[s];function i(l,c,d,g,p,h){return o(),e("div",null,n)}const m=t(a,[["render",i]]);export{u as __pageData,m as default};
diff --git a/assets/guide_tasks.md.12a890b2.lean.js b/assets/guide_tasks.md.ce8d2424.lean.js
similarity index 69%
rename from assets/guide_tasks.md.12a890b2.lean.js
rename to assets/guide_tasks.md.ce8d2424.lean.js
index 7acadb41..932cecbe 100644
--- a/assets/guide_tasks.md.12a890b2.lean.js
+++ b/assets/guide_tasks.md.ce8d2424.lean.js
@@ -1 +1 @@
-import{_ as t,o,c as e,R as r}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"任务管理","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/tasks.md","filePath":"guide/tasks.md","lastUpdated":1717546110000}'),a={name:"guide/tasks.md"},s=r("",11),n=[s];function i(l,c,d,g,p,h){return o(),e("div",null,n)}const m=t(a,[["render",i]]);export{u as __pageData,m as default};
+import{_ as t,o,c as e,R as r}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"任务管理","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/tasks.md","filePath":"guide/tasks.md","lastUpdated":1717546452000}'),a={name:"guide/tasks.md"},s=r("",11),n=[s];function i(l,c,d,g,p,h){return o(),e("div",null,n)}const m=t(a,[["render",i]]);export{u as __pageData,m as default};
diff --git a/assets/index.md.fc2b08ee.js b/assets/index.md.01a0fc66.js
similarity index 95%
rename from assets/index.md.fc2b08ee.js
rename to assets/index.md.01a0fc66.js
index 69c972c2..fb14fcdf 100644
--- a/assets/index.md.fc2b08ee.js
+++ b/assets/index.md.01a0fc66.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"使用文档","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"使用文档","hero":{"name":"哪吒监控","text":"开源、轻量、易用的服务器监控与运维工具","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"预览","link":"https://ops.naibahq.com"},{"theme":"alt","text":"开始使用 →","link":"/guide/dashboard"}]},"features":[{"title":"一键安装","details":"支持一键安装面板和监控服务,操作便捷。兼容主流系统,包括 Linux、Windows、macOS、OpenWRT 以及群晖。"},{"title":"实时监控","details":"支持同时监控多个服务器的状态,提供历史网络状态和延迟图表,监控网页、端口可用性和 SSL 证书状态。支持故障和流量等状态告警,可通过 Telegram、邮件、微信等多种方式提醒。"},{"title":"轻松运维","details":"提供 API 获取服务器状态,支持WebSSH、DDNS 和流量监控。可设置定时和触发任务,并批量执行服务器任务。"}]},"headers":[],"relativePath":"index.md","filePath":"index.md","lastUpdated":1717546110000}'),i={name:"index.md"};function n(s,r,o,d,l,c){return t(),a("div")}const h=e(i,[["render",n]]);export{p as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"使用文档","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"使用文档","hero":{"name":"哪吒监控","text":"开源、轻量、易用的服务器监控与运维工具","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"预览","link":"https://ops.naibahq.com"},{"theme":"alt","text":"开始使用 →","link":"/guide/dashboard"}]},"features":[{"title":"一键安装","details":"支持一键安装面板和监控服务,操作便捷。兼容主流系统,包括 Linux、Windows、macOS、OpenWRT 以及群晖。"},{"title":"实时监控","details":"支持同时监控多个服务器的状态,提供历史网络状态和延迟图表,监控网页、端口可用性和 SSL 证书状态。支持故障和流量等状态告警,可通过 Telegram、邮件、微信等多种方式提醒。"},{"title":"轻松运维","details":"提供 API 获取服务器状态,支持WebSSH、DDNS 和流量监控。可设置定时和触发任务,并批量执行服务器任务。"}]},"headers":[],"relativePath":"index.md","filePath":"index.md","lastUpdated":1717546452000}'),i={name:"index.md"};function n(s,r,o,d,l,c){return t(),a("div")}const h=e(i,[["render",n]]);export{p as __pageData,h as default};
diff --git a/assets/index.md.fc2b08ee.lean.js b/assets/index.md.01a0fc66.lean.js
similarity index 95%
rename from assets/index.md.fc2b08ee.lean.js
rename to assets/index.md.01a0fc66.lean.js
index 69c972c2..fb14fcdf 100644
--- a/assets/index.md.fc2b08ee.lean.js
+++ b/assets/index.md.01a0fc66.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"使用文档","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"使用文档","hero":{"name":"哪吒监控","text":"开源、轻量、易用的服务器监控与运维工具","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"预览","link":"https://ops.naibahq.com"},{"theme":"alt","text":"开始使用 →","link":"/guide/dashboard"}]},"features":[{"title":"一键安装","details":"支持一键安装面板和监控服务,操作便捷。兼容主流系统,包括 Linux、Windows、macOS、OpenWRT 以及群晖。"},{"title":"实时监控","details":"支持同时监控多个服务器的状态,提供历史网络状态和延迟图表,监控网页、端口可用性和 SSL 证书状态。支持故障和流量等状态告警,可通过 Telegram、邮件、微信等多种方式提醒。"},{"title":"轻松运维","details":"提供 API 获取服务器状态,支持WebSSH、DDNS 和流量监控。可设置定时和触发任务,并批量执行服务器任务。"}]},"headers":[],"relativePath":"index.md","filePath":"index.md","lastUpdated":1717546110000}'),i={name:"index.md"};function n(s,r,o,d,l,c){return t(),a("div")}const h=e(i,[["render",n]]);export{p as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"使用文档","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"使用文档","hero":{"name":"哪吒监控","text":"开源、轻量、易用的服务器监控与运维工具","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"预览","link":"https://ops.naibahq.com"},{"theme":"alt","text":"开始使用 →","link":"/guide/dashboard"}]},"features":[{"title":"一键安装","details":"支持一键安装面板和监控服务,操作便捷。兼容主流系统,包括 Linux、Windows、macOS、OpenWRT 以及群晖。"},{"title":"实时监控","details":"支持同时监控多个服务器的状态,提供历史网络状态和延迟图表,监控网页、端口可用性和 SSL 证书状态。支持故障和流量等状态告警,可通过 Telegram、邮件、微信等多种方式提醒。"},{"title":"轻松运维","details":"提供 API 获取服务器状态,支持WebSSH、DDNS 和流量监控。可设置定时和触发任务,并批量执行服务器任务。"}]},"headers":[],"relativePath":"index.md","filePath":"index.md","lastUpdated":1717546452000}'),i={name:"index.md"};function n(s,r,o,d,l,c){return t(),a("div")}const h=e(i,[["render",n]]);export{p as __pageData,h as default};
diff --git a/case/case1.html b/case/case1.html
index 2ce8cadf..0e5cbc7f 100644
--- a/case/case1.html
+++ b/case/case1.html
@@ -10,15 +10,15 @@
-
+
-
-
diff --git a/case/case2.html b/case/case2.html
index 1f4b27fb..9d50aa1c 100644
--- a/case/case2.html
+++ b/case/case2.html
@@ -11,15 +11,15 @@
-
+
-
-
diff --git a/case/case3.html b/case/case3.html
index edd5c247..4e42aded 100644
--- a/case/case3.html
+++ b/case/case3.html
@@ -10,15 +10,15 @@
-
+
-
-
diff --git a/case/case4.html b/case/case4.html
index d56380ed..df79e07b 100644
--- a/case/case4.html
+++ b/case/case4.html
@@ -10,15 +10,15 @@
-
+
-
-
diff --git a/case/case5.html b/case/case5.html
index c8bed9fd..c03ee162 100644
--- a/case/case5.html
+++ b/case/case5.html
@@ -10,7 +10,7 @@
-
+
@@ -63,8 +63,8 @@
|-- nezha.pem # SSL/TLS 证书文件
|-- cloudflared # Cloudflare Argo 隧道主程序
|-- grpcwebproxy # gRPC 反代主程序
-`-- nezha-agent # 哪吒客户端,用于监控本地 localhost
鸣谢下列作者的文章和项目:
- 热心的朝阳群众 Robin,讨论哪吒服务端与客户端的关系,从而诞生了此项目
- 哪吒官网: https://nezha.wiki/ , TG 群: https://t.me/nezhamonitoring
- 共穷国际老中医: http://solitud.es/
- Akkia's Blog: https://blog.akkia.moe/
- 胡桃's Blog: https://blog.萝莉.org/
- HiFeng's Blog: https://www.hicairo.com/
- 用 Cloudflare Tunnel 进行内网穿透: https://blog.outv.im/2021/cloudflared-tunnel/
- 如何给 GitHub Actions 添加自己的 Runner 主机: https://cloud.tencent.com/developer/article/1756690
- github self-hosted runner 添加与启动: https://blog.csdn.net/sinat_32188225/article/details/125978331
- 如何从Docker镜像中导出文件: https://www.pkslow.com/archives/extract-files-from-docker-image
- grpcwebproxy: https://github.com/improbable-eng/grpc-web/tree/master/go/grpcwebproxy
- Applexad 的哪吒官方改版的面板二进制文件: https://github.com/applexad/nezha-binary-build
免责声明:
- 本程序仅供学习了解, 非盈利目的,请于下载后 24 小时内删除, 不得用作任何商业用途, 文字、数据及图片均有所属版权, 如转载须注明来源。
- 使用本程序必循遵守部署免责声明。使用本程序必循遵守部署服务器所在地、所在国家和用户所在国家的法律法规, 程序作者不对使用者任何不当行为负责。
-
我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜
所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任
Community Project
Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.
We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information.
All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc.
Open-source, lightweight, and easy-to-use server monitoring and operation tool
Supports one-click installation of the Dashboard and Agent services, making it easy to operate. Compatible with mainstream systems, including Linux, Windows, macOS, OpenWRT, and Synology.
Supports monitoring the status of multiple servers simultaneously, providing historical network status and latency charts, monitoring webpage and port availability, and SSL certificate status. Supports alerts for status such as faults and traffic, with notifications via Telegram, email, Slack, and more.
Provides an API to get server status, supports WebSSH, DDNS, and traffic monitoring. Allows setting up scheduled and triggered tasks and executing server tasks in batches.