diff --git a/404.html b/404.html index f4c37971..74095423 100644 --- a/404.html +++ b/404.html @@ -20,7 +20,7 @@
- + \ No newline at end of file diff --git a/assets/case_case1.md.B9poWoiH.js b/assets/case_case1.md.BkOtCvls.js similarity index 95% rename from assets/case_case1.md.B9poWoiH.js rename to assets/case_case1.md.BkOtCvls.js index ab8ebf24..a7c3e758 100644 --- a/assets/case_case1.md.B9poWoiH.js +++ b/assets/case_case1.md.BkOtCvls.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1733103039000}'),s={name:"case/case1.md"},o=r('

自建一个TG机器人来查询服务器信息 ​

贡献者:

项目地址：nezha_api_tgbot

机器人可以通过API向面板请求服务器状态信息，得到信息后发送给用户
你可以搭建此机器人来方便地查看指定服务器的当前状态且不需要打开面板

',5),_=[o];function i(c,n,p,l,h,d){return a(),t("div",null,_)}const u=e(s,[["render",i]]);export{m as __pageData,u as default}; +import{_ as e,c as t,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1733144698000}'),s={name:"case/case1.md"},o=r('

自建一个TG机器人来查询服务器信息 ​

贡献者:

项目地址：nezha_api_tgbot

机器人可以通过API向面板请求服务器状态信息，得到信息后发送给用户
你可以搭建此机器人来方便地查看指定服务器的当前状态且不需要打开面板

',5),_=[o];function i(c,n,p,l,h,d){return a(),t("div",null,_)}const u=e(s,[["render",i]]);export{m as __pageData,u as default}; diff --git a/assets/case_case1.md.B9poWoiH.lean.js b/assets/case_case1.md.BkOtCvls.lean.js similarity index 85% rename from assets/case_case1.md.B9poWoiH.lean.js rename to assets/case_case1.md.BkOtCvls.lean.js index 6efc32c5..19b0fe19 100644 --- a/assets/case_case1.md.B9poWoiH.lean.js +++ b/assets/case_case1.md.BkOtCvls.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1733103039000}'),s={name:"case/case1.md"},o=r("",5),_=[o];function i(c,n,p,l,h,d){return a(),t("div",null,_)}const u=e(s,[["render",i]]);export{m as __pageData,u as default}; +import{_ as e,c as t,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1733144698000}'),s={name:"case/case1.md"},o=r("",5),_=[o];function i(c,n,p,l,h,d){return a(),t("div",null,_)}const u=e(s,[["render",i]]);export{m as __pageData,u as default}; diff --git a/assets/case_case2.md.BpKrYqP-.js b/assets/case_case2.md.BViuX1X4.js similarity index 97% rename from assets/case_case2.md.BpKrYqP-.js rename to assets/case_case2.md.BViuX1X4.js index d5d94ae7..37cc0358 100644 --- a/assets/case_case2.md.BpKrYqP-.js +++ b/assets/case_case2.md.BViuX1X4.js @@ -1 +1 @@ -import{_ as a}from"./chunks/qrcode.CZOxHFH-.js";import{_ as e,c as r,o as i,a4 as t}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1733103039000}'),o={name:"case/case2.md"},c=t('

在iOS/MacOS中使用Siri运行快捷指令查询服务器状态 ​

当前版本：V1.0
贡献者：

获取快捷指令 ​

使用iPhone或iPad扫描以下二维码，获取快捷指令

coode

MacOS用户请访问这里，获取快捷指令

使用说明 ​

WARNING

每个快捷指令只能监控一台服务器，如需要监控多个服务器，请多次复制此快捷指令并分别配置，然后分别修改快捷指令名称，如；一号服务器状态、二号服务器状态等

',8),s=[c];function l(d,n,h,_,p,m){return i(),r("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; +import{_ as a}from"./chunks/qrcode.CZOxHFH-.js";import{_ as e,c as r,o as i,a4 as t}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1733144698000}'),o={name:"case/case2.md"},c=t('

在iOS/MacOS中使用Siri运行快捷指令查询服务器状态 ​

当前版本：V1.0
贡献者：

获取快捷指令 ​

使用iPhone或iPad扫描以下二维码，获取快捷指令

coode

MacOS用户请访问这里，获取快捷指令

使用说明 ​

WARNING

每个快捷指令只能监控一台服务器，如需要监控多个服务器，请多次复制此快捷指令并分别配置，然后分别修改快捷指令名称，如；一号服务器状态、二号服务器状态等

',8),s=[c];function l(d,n,h,_,p,m){return i(),r("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; diff --git a/assets/case_case2.md.BpKrYqP-.lean.js b/assets/case_case2.md.BViuX1X4.lean.js similarity index 87% rename from assets/case_case2.md.BpKrYqP-.lean.js rename to assets/case_case2.md.BViuX1X4.lean.js index 2e1f20c3..6caec0ef 100644 --- a/assets/case_case2.md.BpKrYqP-.lean.js +++ b/assets/case_case2.md.BViuX1X4.lean.js @@ -1 +1 @@ -import{_ as a}from"./chunks/qrcode.CZOxHFH-.js";import{_ as e,c as r,o as i,a4 as t}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1733103039000}'),o={name:"case/case2.md"},c=t("",8),s=[c];function l(d,n,h,_,p,m){return i(),r("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; +import{_ as a}from"./chunks/qrcode.CZOxHFH-.js";import{_ as e,c as r,o as i,a4 as t}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1733144698000}'),o={name:"case/case2.md"},c=t("",8),s=[c];function l(d,n,h,_,p,m){return i(),r("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; diff --git a/assets/case_case3.md.DuwCIGQb.js b/assets/case_case3.md.BH0S5H4a.js similarity index 98% rename from assets/case_case3.md.DuwCIGQb.js rename to assets/case_case3.md.BH0S5H4a.js index dedf000a..cbf65d50 100644 --- a/assets/case_case3.md.DuwCIGQb.js +++ b/assets/case_case3.md.BH0S5H4a.js @@ -1 +1 @@ -import{_ as t,c as e,o as a,a4 as d}from"./chunks/framework.BmdFiWrL.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1733103039000}'),r={name:"case/case3.md"},l=d('

自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人 ​

贡献者:

项目地址：nezha_telegram_bot

项目特色 ​

开源Telegram机器人项目，可以基于API实时查询哪吒面板的服务器信息。

命令列表 ​

命令功能仅私聊
start开始使用键盘主菜单✔️
help帮助列表❌
add添加面板链接和token✔️
url添加面板链接✔️
token添加面板token✔️
info获取保存的面板链接和token✔️
delete删除保存的面板链接和token✔️
id命令后面添加整数id，来进行单个服务器信息查询（私聊带刷新按钮，群聊不带）❌
all查询所有服务器的统计信息❌
search在服务器名字中搜索关键字（支持多个，用空格分开）❌

效果展示 ​

imageimage

',11),i=[l];function o(h,c,s,n,_,m){return a(),e("div",null,i)}const b=t(r,[["render",o]]);export{f as __pageData,b as default}; +import{_ as t,c as e,o as a,a4 as d}from"./chunks/framework.BmdFiWrL.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1733144698000}'),r={name:"case/case3.md"},l=d('

自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人 ​

贡献者:

项目地址：nezha_telegram_bot

项目特色 ​

开源Telegram机器人项目，可以基于API实时查询哪吒面板的服务器信息。

命令列表 ​

命令功能仅私聊
start开始使用键盘主菜单✔️
help帮助列表❌
add添加面板链接和token✔️
url添加面板链接✔️
token添加面板token✔️
info获取保存的面板链接和token✔️
delete删除保存的面板链接和token✔️
id命令后面添加整数id，来进行单个服务器信息查询（私聊带刷新按钮，群聊不带）❌
all查询所有服务器的统计信息❌
search在服务器名字中搜索关键字（支持多个，用空格分开）❌

效果展示 ​

imageimage

',11),i=[l];function o(h,c,s,n,_,m){return a(),e("div",null,i)}const b=t(r,[["render",o]]);export{f as __pageData,b as default}; diff --git a/assets/case_case3.md.DuwCIGQb.lean.js b/assets/case_case3.md.BH0S5H4a.lean.js similarity index 86% rename from assets/case_case3.md.DuwCIGQb.lean.js rename to assets/case_case3.md.BH0S5H4a.lean.js index ac37dd92..20d93858 100644 --- a/assets/case_case3.md.DuwCIGQb.lean.js +++ b/assets/case_case3.md.BH0S5H4a.lean.js @@ -1 +1 @@ -import{_ as t,c as e,o as a,a4 as d}from"./chunks/framework.BmdFiWrL.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1733103039000}'),r={name:"case/case3.md"},l=d("",11),i=[l];function o(h,c,s,n,_,m){return a(),e("div",null,i)}const b=t(r,[["render",o]]);export{f as __pageData,b as default}; +import{_ as t,c as e,o as a,a4 as d}from"./chunks/framework.BmdFiWrL.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1733144698000}'),r={name:"case/case3.md"},l=d("",11),i=[l];function o(h,c,s,n,_,m){return a(),e("div",null,i)}const b=t(r,[["render",o]]);export{f as __pageData,b as default}; diff --git a/assets/case_case4.md.CXto-okl.js b/assets/case_case4.md.Dy49O6NN.js similarity index 97% rename from assets/case_case4.md.CXto-okl.js rename to assets/case_case4.md.Dy49O6NN.js index 94f5d177..2a1f60bd 100644 --- a/assets/case_case4.md.CXto-okl.js +++ b/assets/case_case4.md.Dy49O6NN.js @@ -1 +1 @@ -import{_ as s,c as t,o as e,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/2.r5IbCoDU.png",n="/assets/5.DI5HceD6.png",o="/assets/6.B0QVmape.png",p="/assets/4.DAp6JO4C.jpg",c="/assets/1.VA-CzEkF.jpeg",z=JSON.parse('{"title":"重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1733103039000}'),_={name:"case/case4.md"},i=a('

重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑 ​


2

还在因为自己的小鸡配置太差被朋友嘲笑吗？
还在想参加以针会友活动却因为小鸡不够排面而觉得羞耻吗？
还在因为在哪吒TG群里机器人排名太低而觉得自己低人一等吗？


今天开始！找回自信！

来自南京的名老中医 dysf888 独家秘方！让你找回男人本色，激情畅享！
安装 Fake Agent，可随意修改服务器监测数据的倍数上传到 Dashboard，让你的小鸡 脱！胎！换！骨！ 让你在 MJJ 面前硬起来！


哪吒监控创始人奶爸也在用：
5


男人用了都说好：
6
4


1

',12),l=[i];function g(b,f,m,d,h,y){return e(),t("div",null,l)}const k=s(_,[["render",g]]);export{z as __pageData,k as default}; +import{_ as s,c as t,o as e,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/2.r5IbCoDU.png",n="/assets/5.DI5HceD6.png",o="/assets/6.B0QVmape.png",p="/assets/4.DAp6JO4C.jpg",c="/assets/1.VA-CzEkF.jpeg",z=JSON.parse('{"title":"重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1733144698000}'),_={name:"case/case4.md"},i=a('

重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑 ​


2

还在因为自己的小鸡配置太差被朋友嘲笑吗？
还在想参加以针会友活动却因为小鸡不够排面而觉得羞耻吗？
还在因为在哪吒TG群里机器人排名太低而觉得自己低人一等吗？


今天开始！找回自信！

来自南京的名老中医 dysf888 独家秘方！让你找回男人本色，激情畅享！
安装 Fake Agent，可随意修改服务器监测数据的倍数上传到 Dashboard，让你的小鸡 脱！胎！换！骨！ 让你在 MJJ 面前硬起来！


哪吒监控创始人奶爸也在用：
5


男人用了都说好：
6
4


1

',12),l=[i];function g(b,f,m,d,h,y){return e(),t("div",null,l)}const k=s(_,[["render",g]]);export{z as __pageData,k as default}; diff --git a/assets/case_case4.md.CXto-okl.lean.js b/assets/case_case4.md.Dy49O6NN.lean.js similarity index 89% rename from assets/case_case4.md.CXto-okl.lean.js rename to assets/case_case4.md.Dy49O6NN.lean.js index f31f1718..d5da331a 100644 --- a/assets/case_case4.md.CXto-okl.lean.js +++ b/assets/case_case4.md.Dy49O6NN.lean.js @@ -1 +1 @@ -import{_ as s,c as t,o as e,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/2.r5IbCoDU.png",n="/assets/5.DI5HceD6.png",o="/assets/6.B0QVmape.png",p="/assets/4.DAp6JO4C.jpg",c="/assets/1.VA-CzEkF.jpeg",z=JSON.parse('{"title":"重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1733103039000}'),_={name:"case/case4.md"},i=a("",12),l=[i];function g(b,f,m,d,h,y){return e(),t("div",null,l)}const k=s(_,[["render",g]]);export{z as __pageData,k as default}; +import{_ as s,c as t,o as e,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/2.r5IbCoDU.png",n="/assets/5.DI5HceD6.png",o="/assets/6.B0QVmape.png",p="/assets/4.DAp6JO4C.jpg",c="/assets/1.VA-CzEkF.jpeg",z=JSON.parse('{"title":"重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1733144698000}'),_={name:"case/case4.md"},i=a("",12),l=[i];function g(b,f,m,d,h,y){return e(),t("div",null,l)}const k=s(_,[["render",g]]);export{z as __pageData,k as default}; diff --git a/assets/case_case5.md.4z-WCS1d.js b/assets/case_case5.md.BKRp8Yf4.js similarity index 99% rename from assets/case_case5.md.4z-WCS1d.js rename to assets/case_case5.md.BKRp8Yf4.js index 317c6f5e..d6901e7c 100644 --- a/assets/case_case5.md.4z-WCS1d.js +++ b/assets/case_case5.md.BKRp8Yf4.js @@ -1,4 +1,4 @@ -import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1733103039000}'),n={name:"case/case5.md"},r=t(`

使用 Argo 隧道的哪吒服务端 ​

贡献者:

项目地址：Argo-Nezha-Service-Container

目录 ​

项目特点: ​

image

准备需要用的变量 ​

image

面板域名加上 https:// 开头，回调地址再加上 /oauth2/callback 结尾

imageimageimageimageimage

Argo 认证的获取方式: json 或 token ​

Argo 隧道认证方式有 json 和 token，使用两个方式其中之一。推荐前者，理由脚本会处理好所有的 Argo 隧道参数和路径，后者需要到 Cloudflare 官网手动设置，容易出错。

(方式 1 - Json): ​

通过 Cloudflare Json 生成网轻松获取 Argo 隧道 json 信息: https://fscarmen.cloudflare.now.cc ​

image

(方式 2 - Token): 通过 Cloudflare 官网，手动生成 Argo 隧道 token 信息 ​

到 cf 官网：https://dash.cloudflare.com/ ​

imageimageimageimageimageimageimage

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

Deploy to Koyeb

imageimageimageimageimage

VPS 部署方式 1 --- docker ​

docker 部署 ​

docker run -dit \\
+import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1733144698000}'),n={name:"case/case5.md"},r=t(`
使用 Argo 隧道的哪吒服务端 ​
贡献者:
项目地址：Argo-Nezha-Service-Container
目录 ​
项目特点: ​
  • 适用范围更广 --- 只要能连通网络，就能安装哪吒服务端，如 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攻击等网络威胁
image
准备需要用的变量 ​
  • 到 Cloudflare 官网，选择使用的域名，打开 网络 选项将 gRPC 开关打开
image
面板域名加上 https:// 开头，回调地址再加上 /oauth2/callback 结尾
imageimageimageimageimage
Argo 认证的获取方式: json 或 token ​
Argo 隧道认证方式有 json 和 token，使用两个方式其中之一。推荐前者，理由脚本会处理好所有的 Argo 隧道参数和路径，后者需要到 Cloudflare 官网手动设置，容易出错。
(方式 1 - Json): ​
通过 Cloudflare Json 生成网轻松获取 Argo 隧道 json 信息: https://fscarmen.cloudflare.now.cc ​
image
(方式 2 - Token): 通过 Cloudflare 官网，手动生成 Argo 隧道 token 信息 ​
到 cf 官网：https://dash.cloudflare.com/ ​
  • 进入 zero trust 里生成 token 隧道和信息。
  • 其中数据路径 443/https 为 proto.NezhaService
  • ssh 路径 22/ssh 为 < client id >
imageimageimageimageimageimageimage
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
Deploy to Koyeb
imageimageimageimageimage
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.4z-WCS1d.lean.js b/assets/case_case5.md.BKRp8Yf4.lean.js
similarity index 85%
rename from assets/case_case5.md.4z-WCS1d.lean.js
rename to assets/case_case5.md.BKRp8Yf4.lean.js
index 37017a8a..bc85e148 100644
--- a/assets/case_case5.md.4z-WCS1d.lean.js
+++ b/assets/case_case5.md.BKRp8Yf4.lean.js
@@ -1 +1 @@
-import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1733103039000}'),n={name:"case/case5.md"},r=t("",88),l=[r];function i(o,c,h,p,d,g){return s(),e("div",null,l)}const m=a(n,[["render",i]]);export{u as __pageData,m as default};
+import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1733144698000}'),n={name:"case/case5.md"},r=t("",88),l=[r];function i(o,c,h,p,d,g){return s(),e("div",null,l)}const m=a(n,[["render",i]]);export{u as __pageData,m as default};
diff --git a/assets/case_case6.md.CFQ8_6vY.js b/assets/case_case6.md.C_54h5oe.js
similarity index 98%
rename from assets/case_case6.md.CFQ8_6vY.js
rename to assets/case_case6.md.C_54h5oe.js
index f09692b9..927cbb72 100644
--- a/assets/case_case6.md.CFQ8_6vY.js
+++ b/assets/case_case6.md.C_54h5oe.js
@@ -1 +1 @@
-import{_ as a,c as e,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const s="/assets/Download_on_the_App_Store_Badge_CNSC_RGB_blk_092917.B6iCCvXs.svg",r="/assets/1.BL34OYdd.png",i="/assets/2.BqfHYLGJ.png",l="/assets/3.D4KlWCds.png",k=JSON.parse('{"title":"Nezha Mobile - Nezha Dashboard 的 iOS 客户端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case6.md","filePath":"case/case6.md","lastUpdated":1733103039000}'),n={name:"case/case6.md"},h=o('
Nezha Mobile - Nezha Dashboard 的 iOS 客户端 ​
贡献者：
为项目作出贡献 ​
项目地址
INFO
我们欢迎对项目的任何贡献，并将积极合并你的修改至下一次的Release，但我们可能会对不符合App Review Guidelines的内容（或潜在内容）进行一些修改。
从 App Store 下载 ​
Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917
WARNING
App Store版本的Nezha Mobile由于ICP备案原因不在中国大陆提供服务。
TestFlight 测试计划 ​
加入 TestFlight 测试
使用说明 ​
  • 首次使用时你需要输入Dashboard链接和API Token。Dashboard链接形如server.hidandelion.com，不要添加协议头和末尾斜杠。API Token可通过Dashboard管理后台获取。 step1
配置小组件（可选） ​
  • 在Springboard添加小组件，长按后点击编辑小组件。 step2
  • 在随后的页面中选择一台你需要监控的服务器。你可以为多个小组件配置不同的服务器。 step3
',15),p=[h];function d(c,_,b,g,m,u){return t(),e("div",null,p)}const N=a(n,[["render",d]]);export{k as __pageData,N as default};
+import{_ as a,c as e,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const s="/assets/Download_on_the_App_Store_Badge_CNSC_RGB_blk_092917.B6iCCvXs.svg",r="/assets/1.BL34OYdd.png",i="/assets/2.BqfHYLGJ.png",l="/assets/3.D4KlWCds.png",k=JSON.parse('{"title":"Nezha Mobile - Nezha Dashboard 的 iOS 客户端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case6.md","filePath":"case/case6.md","lastUpdated":1733144698000}'),n={name:"case/case6.md"},h=o('
Nezha Mobile - Nezha Dashboard 的 iOS 客户端 ​
贡献者：
为项目作出贡献 ​
项目地址
INFO
我们欢迎对项目的任何贡献，并将积极合并你的修改至下一次的Release，但我们可能会对不符合App Review Guidelines的内容（或潜在内容）进行一些修改。
从 App Store 下载 ​
Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917
WARNING
App Store版本的Nezha Mobile由于ICP备案原因不在中国大陆提供服务。
TestFlight 测试计划 ​
加入 TestFlight 测试
使用说明 ​
  • 首次使用时你需要输入Dashboard链接和API Token。Dashboard链接形如server.hidandelion.com，不要添加协议头和末尾斜杠。API Token可通过Dashboard管理后台获取。 step1
配置小组件（可选） ​
  • 在Springboard添加小组件，长按后点击编辑小组件。 step2
  • 在随后的页面中选择一台你需要监控的服务器。你可以为多个小组件配置不同的服务器。 step3
',15),p=[h];function d(c,_,b,g,m,u){return t(),e("div",null,p)}const N=a(n,[["render",d]]);export{k as __pageData,N as default};
diff --git a/assets/case_case6.md.CFQ8_6vY.lean.js b/assets/case_case6.md.C_54h5oe.lean.js
similarity index 89%
rename from assets/case_case6.md.CFQ8_6vY.lean.js
rename to assets/case_case6.md.C_54h5oe.lean.js
index 585f416f..db56bd08 100644
--- a/assets/case_case6.md.CFQ8_6vY.lean.js
+++ b/assets/case_case6.md.C_54h5oe.lean.js
@@ -1 +1 @@
-import{_ as a,c as e,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const s="/assets/Download_on_the_App_Store_Badge_CNSC_RGB_blk_092917.B6iCCvXs.svg",r="/assets/1.BL34OYdd.png",i="/assets/2.BqfHYLGJ.png",l="/assets/3.D4KlWCds.png",k=JSON.parse('{"title":"Nezha Mobile - Nezha Dashboard 的 iOS 客户端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case6.md","filePath":"case/case6.md","lastUpdated":1733103039000}'),n={name:"case/case6.md"},h=o("",15),p=[h];function d(c,_,b,g,m,u){return t(),e("div",null,p)}const N=a(n,[["render",d]]);export{k as __pageData,N as default};
+import{_ as a,c as e,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const s="/assets/Download_on_the_App_Store_Badge_CNSC_RGB_blk_092917.B6iCCvXs.svg",r="/assets/1.BL34OYdd.png",i="/assets/2.BqfHYLGJ.png",l="/assets/3.D4KlWCds.png",k=JSON.parse('{"title":"Nezha Mobile - Nezha Dashboard 的 iOS 客户端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case6.md","filePath":"case/case6.md","lastUpdated":1733144698000}'),n={name:"case/case6.md"},h=o("",15),p=[h];function d(c,_,b,g,m,u){return t(),e("div",null,p)}const N=a(n,[["render",d]]);export{k as __pageData,N as default};
diff --git a/assets/case_case7.md.DJ_vIrr3.js b/assets/case_case7.md.DnCzHV6b.js
similarity index 97%
rename from assets/case_case7.md.DJ_vIrr3.js
rename to assets/case_case7.md.DnCzHV6b.js
index b0402048..c4d98f4d 100644
--- a/assets/case_case7.md.DJ_vIrr3.js
+++ b/assets/case_case7.md.DnCzHV6b.js
@@ -1 +1 @@
-import{_ as e,a as r}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as a,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Broker for Nezha - 拓展 Nezha 接入平台","description":"","frontmatter":{},"headers":[],"relativePath":"case/case7.md","filePath":"case/case7.md","lastUpdated":1733103039000}'),l={name:"case/case7.md"},n=i('
Broker for Nezha - 拓展 Nezha 接入平台 ​
贡献者:
Broker for Nezha 是一个 Nezha Agent 的修改版本，其通过分离 Agent 的数据收集和 gRPC 上报功能，可使小型设备接入 Nezha Dashboard。
项目地址：https://codeberg.org/uubulb/broker
文档：Broker for Nezha
与原项目的不同 ​
  • 使用外置数据源，而不是从本地获取。
  • 多数据源与多面板支持
  • 仅支持部分任务类型，可参考项目 README 获取详细信息。
Broker for Nezha 需要与特定的数据收集软件一同使用。目前提供两种数据获取方式：
  1. HTTP 主动获取（HTTP/1.1）
  2. TCP 被动获取（推荐）
如需获取现有的数据收集软件，可以参考项目 README。
因数据获取方式缺乏安全性，建议仅在信任的网络环境使用。
编写数据收集端 ​
如需自行编写数据收集端，除实现基本 HTTP 服务器或 TCP 客户端外，还需要使用特定的数据格式才可被 Broker 正常接收。具体请参考：数据类型
效果参考 ​
Dashboard
 Dashboard 

WebSSH
 WebSSH 
',18),s=[n];function h(c,p,f,u,_,b){return o(),t("div",null,s)}const m=a(l,[["render",h]]);export{k as __pageData,m as default};
+import{_ as e,a as r}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as a,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Broker for Nezha - 拓展 Nezha 接入平台","description":"","frontmatter":{},"headers":[],"relativePath":"case/case7.md","filePath":"case/case7.md","lastUpdated":1733144698000}'),l={name:"case/case7.md"},n=i('
Broker for Nezha - 拓展 Nezha 接入平台 ​
贡献者:
Broker for Nezha 是一个 Nezha Agent 的修改版本，其通过分离 Agent 的数据收集和 gRPC 上报功能，可使小型设备接入 Nezha Dashboard。
项目地址：https://codeberg.org/uubulb/broker
文档：Broker for Nezha
与原项目的不同 ​
  • 使用外置数据源，而不是从本地获取。
  • 多数据源与多面板支持
  • 仅支持部分任务类型，可参考项目 README 获取详细信息。
Broker for Nezha 需要与特定的数据收集软件一同使用。目前提供两种数据获取方式：
  1. HTTP 主动获取（HTTP/1.1）
  2. TCP 被动获取（推荐）
如需获取现有的数据收集软件，可以参考项目 README。
因数据获取方式缺乏安全性，建议仅在信任的网络环境使用。
编写数据收集端 ​
如需自行编写数据收集端，除实现基本 HTTP 服务器或 TCP 客户端外，还需要使用特定的数据格式才可被 Broker 正常接收。具体请参考：数据类型
效果参考 ​
Dashboard
 Dashboard 

WebSSH
 WebSSH 
',18),s=[n];function h(c,p,f,u,_,b){return o(),t("div",null,s)}const m=a(l,[["render",h]]);export{k as __pageData,m as default};
diff --git a/assets/case_case7.md.DJ_vIrr3.lean.js b/assets/case_case7.md.DnCzHV6b.lean.js
similarity index 87%
rename from assets/case_case7.md.DJ_vIrr3.lean.js
rename to assets/case_case7.md.DnCzHV6b.lean.js
index 6102d30d..dee60f67 100644
--- a/assets/case_case7.md.DJ_vIrr3.lean.js
+++ b/assets/case_case7.md.DnCzHV6b.lean.js
@@ -1 +1 @@
-import{_ as e,a as r}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as a,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Broker for Nezha - 拓展 Nezha 接入平台","description":"","frontmatter":{},"headers":[],"relativePath":"case/case7.md","filePath":"case/case7.md","lastUpdated":1733103039000}'),l={name:"case/case7.md"},n=i("",18),s=[n];function h(c,p,f,u,_,b){return o(),t("div",null,s)}const m=a(l,[["render",h]]);export{k as __pageData,m as default};
+import{_ as e,a as r}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as a,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Broker for Nezha - 拓展 Nezha 接入平台","description":"","frontmatter":{},"headers":[],"relativePath":"case/case7.md","filePath":"case/case7.md","lastUpdated":1733144698000}'),l={name:"case/case7.md"},n=i("",18),s=[n];function h(c,p,f,u,_,b){return o(),t("div",null,s)}const m=a(l,[["render",h]]);export{k as __pageData,m as default};
diff --git a/assets/case_index.md.BMcGcKCT.js b/assets/case_index.md.D98y31Eb.js
similarity index 94%
rename from assets/case_index.md.BMcGcKCT.js
rename to assets/case_index.md.D98y31Eb.js
index 1a25e5ca..2929c6c8 100644
--- a/assets/case_index.md.BMcGcKCT.js
+++ b/assets/case_index.md.D98y31Eb.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.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":1733103039000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return a(),t("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
+import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.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":1733144698000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return a(),t("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
diff --git a/assets/case_index.md.BMcGcKCT.lean.js b/assets/case_index.md.D98y31Eb.lean.js
similarity index 94%
rename from assets/case_index.md.BMcGcKCT.lean.js
rename to assets/case_index.md.D98y31Eb.lean.js
index 1a25e5ca..2929c6c8 100644
--- a/assets/case_index.md.BMcGcKCT.lean.js
+++ b/assets/case_index.md.D98y31Eb.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.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":1733103039000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return a(),t("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
+import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.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":1733144698000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return a(),t("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
diff --git a/assets/developer_index.md.StLfv4EA.js b/assets/developer_index.md.CuaVrhgY.js
similarity index 92%
rename from assets/developer_index.md.StLfv4EA.js
rename to assets/developer_index.md.CuaVrhgY.js
index b9336800..491dd4e2 100644
--- a/assets/developer_index.md.StLfv4EA.js
+++ b/assets/developer_index.md.CuaVrhgY.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.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":1733103039000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return a(),t("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
+import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.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":1733144698000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return a(),t("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
diff --git a/assets/developer_index.md.StLfv4EA.lean.js b/assets/developer_index.md.CuaVrhgY.lean.js
similarity index 92%
rename from assets/developer_index.md.StLfv4EA.lean.js
rename to assets/developer_index.md.CuaVrhgY.lean.js
index b9336800..491dd4e2 100644
--- a/assets/developer_index.md.StLfv4EA.lean.js
+++ b/assets/developer_index.md.CuaVrhgY.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.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":1733103039000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return a(),t("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
+import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.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":1733144698000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return a(),t("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
diff --git a/assets/developer_l10n.md.DWpbCSE2.js b/assets/developer_l10n.md.d0vjFxi6.js
similarity index 96%
rename from assets/developer_l10n.md.DWpbCSE2.js
rename to assets/developer_l10n.md.d0vjFxi6.js
index 32ef4439..8e056b04 100644
--- a/assets/developer_l10n.md.DWpbCSE2.js
+++ b/assets/developer_l10n.md.d0vjFxi6.js
@@ -1 +1 @@
-import{_ as e,c as a,o,a4 as l}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"l10n 本地化开发指南","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1733103039000}'),t={name:"developer/l10n.md"},r=l('
l10n 本地化开发指南 ​
哪吒监控的 Dashboard 已经添加本地化，支持多个语言，你可以在开发新功能时遵循以下步骤来支持本地化
介绍 ​
  1. 你可以直接使用 /resource/l10n/zh-CN.toml 中已有的文本配置来替换新功能中的文本
  2. 如果新功能中有新增文本，请参考 zh-CN.toml 的配置文本，将新文本拉取到 zh-CN.toml 等其他语言的配置文件中，并添加翻译
新本地化文本的添加 ​
  1. 在 /resource/l10n/ 中添加新的语言文本配置
  2. 在新的语言文本配置中拉取其他语言已有的文本配置
  3. 为新的语言文本配置添加翻译
',6),n=[r];function d(c,i,s,_,h,p){return o(),a("div",null,n)}const f=e(t,[["render",d]]);export{u as __pageData,f as default};
+import{_ as e,c as a,o,a4 as l}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"l10n 本地化开发指南","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1733144698000}'),t={name:"developer/l10n.md"},r=l('
l10n 本地化开发指南 ​
哪吒监控的 Dashboard 已经添加本地化，支持多个语言，你可以在开发新功能时遵循以下步骤来支持本地化
介绍 ​
  1. 你可以直接使用 /resource/l10n/zh-CN.toml 中已有的文本配置来替换新功能中的文本
  2. 如果新功能中有新增文本，请参考 zh-CN.toml 的配置文本，将新文本拉取到 zh-CN.toml 等其他语言的配置文件中，并添加翻译
新本地化文本的添加 ​
  1. 在 /resource/l10n/ 中添加新的语言文本配置
  2. 在新的语言文本配置中拉取其他语言已有的文本配置
  3. 为新的语言文本配置添加翻译
',6),n=[r];function d(c,i,s,_,h,p){return o(),a("div",null,n)}const f=e(t,[["render",d]]);export{u as __pageData,f as default};
diff --git a/assets/developer_l10n.md.DWpbCSE2.lean.js b/assets/developer_l10n.md.d0vjFxi6.lean.js
similarity index 85%
rename from assets/developer_l10n.md.DWpbCSE2.lean.js
rename to assets/developer_l10n.md.d0vjFxi6.lean.js
index 87c861ec..945d7122 100644
--- a/assets/developer_l10n.md.DWpbCSE2.lean.js
+++ b/assets/developer_l10n.md.d0vjFxi6.lean.js
@@ -1 +1 @@
-import{_ as e,c as a,o,a4 as l}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"l10n 本地化开发指南","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1733103039000}'),t={name:"developer/l10n.md"},r=l("",6),n=[r];function d(c,i,s,_,h,p){return o(),a("div",null,n)}const f=e(t,[["render",d]]);export{u as __pageData,f as default};
+import{_ as e,c as a,o,a4 as l}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"l10n 本地化开发指南","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1733144698000}'),t={name:"developer/l10n.md"},r=l("",6),n=[r];function d(c,i,s,_,h,p){return o(),a("div",null,n)}const f=e(t,[["render",d]]);export{u as __pageData,f as default};
diff --git a/assets/developer_theme.md.CnqVR0Pr.js b/assets/developer_theme.md.Ckz8hyyD.js
similarity index 96%
rename from assets/developer_theme.md.CnqVR0Pr.js
rename to assets/developer_theme.md.Ckz8hyyD.js
index fc09637c..04ab22ca 100644
--- a/assets/developer_theme.md.CnqVR0Pr.js
+++ b/assets/developer_theme.md.Ckz8hyyD.js
@@ -1 +1 @@
-import{_ as e,c as o,o as a,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"哪吒主题开发环境","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1733103039000}'),c={name:"developer/theme.md"},d=t('
哪吒主题开发环境 ​
哪吒面板提供了主题开发环境，你可以使用它来创建新的哪吒监控主题
WARNING
请注意： 此开发环境仅支持 dashboard v0.19.20 及更新版本。
使用说明 ​
  1. 克隆此仓库到本地
  2. 修改 data/config.yaml 中的 Oauth2 配置（回调连接可以填 http://localhost）
  3. 运行 docker-compose up
  4. 开始开发
  5. 主题制作完成之后可以将 theme-custom(前台主题)、static-custom(前台主题静态文件) 和 dashboard-custom(后台主题) 放置到服务器上的 /opt/nezha/dashboard/ 中（如使用 Docker 安装）
FAQ ​
  • 如果不能使用 80 端口，在 docker-compose.yaml 中修改配置。
',7),l=[d];function r(s,i,h,n,m,_){return a(),o("div",null,l)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
+import{_ as e,c as o,o as a,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"哪吒主题开发环境","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1733144698000}'),c={name:"developer/theme.md"},d=t('
哪吒主题开发环境 ​
哪吒面板提供了主题开发环境，你可以使用它来创建新的哪吒监控主题
WARNING
请注意： 此开发环境仅支持 dashboard v0.19.20 及更新版本。
使用说明 ​
  1. 克隆此仓库到本地
  2. 修改 data/config.yaml 中的 Oauth2 配置（回调连接可以填 http://localhost）
  3. 运行 docker-compose up
  4. 开始开发
  5. 主题制作完成之后可以将 theme-custom(前台主题)、static-custom(前台主题静态文件) 和 dashboard-custom(后台主题) 放置到服务器上的 /opt/nezha/dashboard/ 中（如使用 Docker 安装）
FAQ ​
  • 如果不能使用 80 端口，在 docker-compose.yaml 中修改配置。
',7),l=[d];function r(s,i,h,n,m,_){return a(),o("div",null,l)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
diff --git a/assets/developer_theme.md.CnqVR0Pr.lean.js b/assets/developer_theme.md.Ckz8hyyD.lean.js
similarity index 85%
rename from assets/developer_theme.md.CnqVR0Pr.lean.js
rename to assets/developer_theme.md.Ckz8hyyD.lean.js
index 443798e6..c909b525 100644
--- a/assets/developer_theme.md.CnqVR0Pr.lean.js
+++ b/assets/developer_theme.md.Ckz8hyyD.lean.js
@@ -1 +1 @@
-import{_ as e,c as o,o as a,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"哪吒主题开发环境","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1733103039000}'),c={name:"developer/theme.md"},d=t("",7),l=[d];function r(s,i,h,n,m,_){return a(),o("div",null,l)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
+import{_ as e,c as o,o as a,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"哪吒主题开发环境","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1733144698000}'),c={name:"developer/theme.md"},d=t("",7),l=[d];function r(s,i,h,n,m,_){return a(),o("div",null,l)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
diff --git a/assets/en_US_case_case1.md.BWd47m_m.js b/assets/en_US_case_case1.md.C2WqGMx8.js
similarity index 95%
rename from assets/en_US_case_case1.md.BWd47m_m.js
rename to assets/en_US_case_case1.md.C2WqGMx8.js
index 701d88d7..eaceb471 100644
--- a/assets/en_US_case_case1.md.BWd47m_m.js
+++ b/assets/en_US_case_case1.md.C2WqGMx8.js
@@ -1 +1 @@
-import{_ as e,c as t,o as r,a4 as o}from"./chunks/framework.BmdFiWrL.js";const m=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":1733103039000}'),a={name:"en_US/case/case1.md"},n=o('
Build your own Telegram bot to query server information ​
Contributors:
Project: 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.
',5),i=[n];function s(l,h,u,_,c,p){return r(),t("div",null,i)}const b=e(a,[["render",s]]);export{m as __pageData,b as default};
+import{_ as e,c as t,o as r,a4 as o}from"./chunks/framework.BmdFiWrL.js";const m=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":1733144698000}'),a={name:"en_US/case/case1.md"},n=o('
Build your own Telegram bot to query server information ​
Contributors:
Project: 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.
',5),i=[n];function s(l,h,u,_,c,p){return r(),t("div",null,i)}const b=e(a,[["render",s]]);export{m as __pageData,b as default};
diff --git a/assets/en_US_case_case1.md.BWd47m_m.lean.js b/assets/en_US_case_case1.md.C2WqGMx8.lean.js
similarity index 86%
rename from assets/en_US_case_case1.md.BWd47m_m.lean.js
rename to assets/en_US_case_case1.md.C2WqGMx8.lean.js
index 1b0c45de..4f39e7d1 100644
--- a/assets/en_US_case_case1.md.BWd47m_m.lean.js
+++ b/assets/en_US_case_case1.md.C2WqGMx8.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as r,a4 as o}from"./chunks/framework.BmdFiWrL.js";const m=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":1733103039000}'),a={name:"en_US/case/case1.md"},n=o("",5),i=[n];function s(l,h,u,_,c,p){return r(),t("div",null,i)}const b=e(a,[["render",s]]);export{m as __pageData,b as default};
+import{_ as e,c as t,o as r,a4 as o}from"./chunks/framework.BmdFiWrL.js";const m=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":1733144698000}'),a={name:"en_US/case/case1.md"},n=o("",5),i=[n];function s(l,h,u,_,c,p){return r(),t("div",null,i)}const b=e(a,[["render",s]]);export{m as __pageData,b as default};
diff --git a/assets/en_US_case_case2.md.MEfIUzXU.js b/assets/en_US_case_case2.md.9gRKyIdW.js
similarity index 97%
rename from assets/en_US_case_case2.md.MEfIUzXU.js
rename to assets/en_US_case_case2.md.9gRKyIdW.js
index d4ffb0f7..9fa6c3a7 100644
--- a/assets/en_US_case_case2.md.MEfIUzXU.js
+++ b/assets/en_US_case_case2.md.9gRKyIdW.js
@@ -1 +1 @@
-import{_ as e}from"./chunks/qrcode.CZOxHFH-.js";import{_ as t,c as r,o,a4 as s}from"./chunks/framework.BmdFiWrL.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":1733103039000}'),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:
Get shortcut command ​
Scan the following QR code with your iPhone or iPad to get the shortcut

coode


 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 o(),r("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
+import{_ as e}from"./chunks/qrcode.CZOxHFH-.js";import{_ as t,c as r,o,a4 as s}from"./chunks/framework.BmdFiWrL.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":1733144698000}'),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:
Get shortcut command ​
Scan the following QR code with your iPhone or iPad to get the shortcut

coode


 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 o(),r("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.MEfIUzXU.lean.js b/assets/en_US_case_case2.md.9gRKyIdW.lean.js
similarity index 87%
rename from assets/en_US_case_case2.md.MEfIUzXU.lean.js
rename to assets/en_US_case_case2.md.9gRKyIdW.lean.js
index 431966ac..5d596126 100644
--- a/assets/en_US_case_case2.md.MEfIUzXU.lean.js
+++ b/assets/en_US_case_case2.md.9gRKyIdW.lean.js
@@ -1 +1 @@
-import{_ as e}from"./chunks/qrcode.CZOxHFH-.js";import{_ as t,c as r,o,a4 as s}from"./chunks/framework.BmdFiWrL.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":1733103039000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return o(),r("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
+import{_ as e}from"./chunks/qrcode.CZOxHFH-.js";import{_ as t,c as r,o,a4 as s}from"./chunks/framework.BmdFiWrL.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":1733144698000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return o(),r("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.D_0H_Yfy.js b/assets/en_US_case_case3.md.DrOE6o9H.js
similarity index 97%
rename from assets/en_US_case_case3.md.D_0H_Yfy.js
rename to assets/en_US_case_case3.md.DrOE6o9H.js
index 64f0ecef..77993bbe 100644
--- a/assets/en_US_case_case3.md.D_0H_Yfy.js
+++ b/assets/en_US_case_case3.md.DrOE6o9H.js
@@ -1 +1 @@
-import{_ as t,c as e,o as r,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Build your own server status query Telegram bot","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1733103039000}'),d={name:"en_US/case/case3.md"},o=a('
Build your own server status query Telegram bot ​
Contributor:
GitHub project: 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 ​
CommandDescriptionPrivate chat only
startGetting started with the keyboard main menu✔️
helphelp message❌
addAdd Nezha monitoring url link and token✔️
urlAdd Nezha monitoring url link✔️
tokenAdd Nezha monitoring token✔️
infoGet saved Nezha monitoring url link and token✔️
deleteDelete saved Nezha monitoring url link and token✔️
idAdd an integer id after the command to query the information of a single server (refresh button only available in private chat)❌
allQuery statistics for all servers❌
searchSearch for keywords in server names (multiple keywords supported, split by spaces)❌
',8),i=[o];function s(n,l,u,h,c,m){return r(),e("div",null,i)}const b=t(d,[["render",s]]);export{_ as __pageData,b as default};
+import{_ as t,c as e,o as r,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Build your own server status query Telegram bot","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1733144698000}'),d={name:"en_US/case/case3.md"},o=a('
Build your own server status query Telegram bot ​
Contributor:
GitHub project: 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 ​
CommandDescriptionPrivate chat only
startGetting started with the keyboard main menu✔️
helphelp message❌
addAdd Nezha monitoring url link and token✔️
urlAdd Nezha monitoring url link✔️
tokenAdd Nezha monitoring token✔️
infoGet saved Nezha monitoring url link and token✔️
deleteDelete saved Nezha monitoring url link and token✔️
idAdd an integer id after the command to query the information of a single server (refresh button only available in private chat)❌
allQuery statistics for all servers❌
searchSearch for keywords in server names (multiple keywords supported, split by spaces)❌
',8),i=[o];function s(n,l,u,h,c,m){return r(),e("div",null,i)}const b=t(d,[["render",s]]);export{_ as __pageData,b as default};
diff --git a/assets/en_US_case_case3.md.D_0H_Yfy.lean.js b/assets/en_US_case_case3.md.DrOE6o9H.lean.js
similarity index 86%
rename from assets/en_US_case_case3.md.D_0H_Yfy.lean.js
rename to assets/en_US_case_case3.md.DrOE6o9H.lean.js
index bc5d9cfb..1a54c4a2 100644
--- a/assets/en_US_case_case3.md.D_0H_Yfy.lean.js
+++ b/assets/en_US_case_case3.md.DrOE6o9H.lean.js
@@ -1 +1 @@
-import{_ as t,c as e,o as r,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Build your own server status query Telegram bot","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1733103039000}'),d={name:"en_US/case/case3.md"},o=a("",8),i=[o];function s(n,l,u,h,c,m){return r(),e("div",null,i)}const b=t(d,[["render",s]]);export{_ as __pageData,b as default};
+import{_ as t,c as e,o as r,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Build your own server status query Telegram bot","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1733144698000}'),d={name:"en_US/case/case3.md"},o=a("",8),i=[o];function s(n,l,u,h,c,m){return r(),e("div",null,i)}const b=t(d,[["render",s]]);export{_ as __pageData,b as default};
diff --git a/assets/en_US_case_case4.md.BcRIl0yT.js b/assets/en_US_case_case4.md.CNUV74Br.js
similarity index 94%
rename from assets/en_US_case_case4.md.BcRIl0yT.js
rename to assets/en_US_case_case4.md.CNUV74Br.js
index ca77704f..97416a72 100644
--- a/assets/en_US_case_case4.md.BcRIl0yT.js
+++ b/assets/en_US_case_case4.md.CNUV74Br.js
@@ -1 +1 @@
-import{_ as t,c as n,o,j as e,a}from"./chunks/framework.BmdFiWrL.js";const x=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1733103039000}'),r={name:"en_US/case/case4.md"},s=e("h1",{id:"fake-agent-monitoring-data-cheater",tabindex:"-1"},[a("Fake-agent, monitoring data cheater "),e("a",{class:"header-anchor",href:"#fake-agent-monitoring-data-cheater","aria-label":'Permalink to "Fake-agent, monitoring data cheater"'},"​")],-1),c=e("p",null,"Contributor:",-1),i=e("ul",null,[e("li",null,[e("a",{href:"https://github.com/dysf888",target:"_blank",rel:"noreferrer"},"dysf888")])],-1),d=e("p",null,[a("GitHub project: "),e("a",{href:"https://github.com/dysf888/fake-nezha-agent",target:"_blank",rel:"noreferrer"},"fake-nezha-agent"),a("（Chinese）")],-1),h=e("p",null,[a("You can modify the monitoring data uploaded to Dashboard by the Agent"),e("br"),a(" Use it for cheating 😈")],-1),l=[s,c,i,d,h];function _(f,g,m,p,u,k){return o(),n("div",null,l)}const y=t(r,[["render",_]]);export{x as __pageData,y as default};
+import{_ as t,c as n,o,j as e,a}from"./chunks/framework.BmdFiWrL.js";const x=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1733144698000}'),r={name:"en_US/case/case4.md"},s=e("h1",{id:"fake-agent-monitoring-data-cheater",tabindex:"-1"},[a("Fake-agent, monitoring data cheater "),e("a",{class:"header-anchor",href:"#fake-agent-monitoring-data-cheater","aria-label":'Permalink to "Fake-agent, monitoring data cheater"'},"​")],-1),c=e("p",null,"Contributor:",-1),i=e("ul",null,[e("li",null,[e("a",{href:"https://github.com/dysf888",target:"_blank",rel:"noreferrer"},"dysf888")])],-1),d=e("p",null,[a("GitHub project: "),e("a",{href:"https://github.com/dysf888/fake-nezha-agent",target:"_blank",rel:"noreferrer"},"fake-nezha-agent"),a("（Chinese）")],-1),h=e("p",null,[a("You can modify the monitoring data uploaded to Dashboard by the Agent"),e("br"),a(" Use it for cheating 😈")],-1),l=[s,c,i,d,h];function _(f,g,m,p,u,k){return o(),n("div",null,l)}const y=t(r,[["render",_]]);export{x as __pageData,y as default};
diff --git a/assets/en_US_case_case4.md.BcRIl0yT.lean.js b/assets/en_US_case_case4.md.CNUV74Br.lean.js
similarity index 94%
rename from assets/en_US_case_case4.md.BcRIl0yT.lean.js
rename to assets/en_US_case_case4.md.CNUV74Br.lean.js
index ca77704f..97416a72 100644
--- a/assets/en_US_case_case4.md.BcRIl0yT.lean.js
+++ b/assets/en_US_case_case4.md.CNUV74Br.lean.js
@@ -1 +1 @@
-import{_ as t,c as n,o,j as e,a}from"./chunks/framework.BmdFiWrL.js";const x=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1733103039000}'),r={name:"en_US/case/case4.md"},s=e("h1",{id:"fake-agent-monitoring-data-cheater",tabindex:"-1"},[a("Fake-agent, monitoring data cheater "),e("a",{class:"header-anchor",href:"#fake-agent-monitoring-data-cheater","aria-label":'Permalink to "Fake-agent, monitoring data cheater"'},"​")],-1),c=e("p",null,"Contributor:",-1),i=e("ul",null,[e("li",null,[e("a",{href:"https://github.com/dysf888",target:"_blank",rel:"noreferrer"},"dysf888")])],-1),d=e("p",null,[a("GitHub project: "),e("a",{href:"https://github.com/dysf888/fake-nezha-agent",target:"_blank",rel:"noreferrer"},"fake-nezha-agent"),a("（Chinese）")],-1),h=e("p",null,[a("You can modify the monitoring data uploaded to Dashboard by the Agent"),e("br"),a(" Use it for cheating 😈")],-1),l=[s,c,i,d,h];function _(f,g,m,p,u,k){return o(),n("div",null,l)}const y=t(r,[["render",_]]);export{x as __pageData,y as default};
+import{_ as t,c as n,o,j as e,a}from"./chunks/framework.BmdFiWrL.js";const x=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1733144698000}'),r={name:"en_US/case/case4.md"},s=e("h1",{id:"fake-agent-monitoring-data-cheater",tabindex:"-1"},[a("Fake-agent, monitoring data cheater "),e("a",{class:"header-anchor",href:"#fake-agent-monitoring-data-cheater","aria-label":'Permalink to "Fake-agent, monitoring data cheater"'},"​")],-1),c=e("p",null,"Contributor:",-1),i=e("ul",null,[e("li",null,[e("a",{href:"https://github.com/dysf888",target:"_blank",rel:"noreferrer"},"dysf888")])],-1),d=e("p",null,[a("GitHub project: "),e("a",{href:"https://github.com/dysf888/fake-nezha-agent",target:"_blank",rel:"noreferrer"},"fake-nezha-agent"),a("（Chinese）")],-1),h=e("p",null,[a("You can modify the monitoring data uploaded to Dashboard by the Agent"),e("br"),a(" Use it for cheating 😈")],-1),l=[s,c,i,d,h];function _(f,g,m,p,u,k){return o(),n("div",null,l)}const y=t(r,[["render",_]]);export{x as __pageData,y as default};
diff --git a/assets/en_US_case_case5.md.C-8AxizL.js b/assets/en_US_case_case5.md.Ret5X66G.js
similarity index 99%
rename from assets/en_US_case_case5.md.C-8AxizL.js
rename to assets/en_US_case_case5.md.Ret5X66G.js
index cb308e5a..188247d9 100644
--- a/assets/en_US_case_case5.md.C-8AxizL.js
+++ b/assets/en_US_case_case5.md.Ret5X66G.js
@@ -1,4 +1,4 @@
-import{_ as e,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.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":1733103039000}'),s={name:"en_US/case/case5.md"},o=n(`
Nezha server over Argo tunnel ​
Contributors:
GitHub project: Argo-Nezha-Service-Container
Catalog ​
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.
image
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.
image
Add https:// to the beginning of the panel's domain name and /oauth2/callback to the end of the callback address.
imageimageimageimageimage
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 ​
image
(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 >.
imageimageimageimageimageimageimage
PaaS Deployment Example ​
Image fscarmen/argo-nezha:latest, supports amd64 and arm64 architectures.
Variables used
Variable NameRequiredRemarks
GH_USERYesgithub username for panel admin authorization
GH_CLIENTIDyesapply on github
GH_CLIENTSECRETyesapply on github
GH_BACKUP_USERNoThe 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_REPONoThe github repository for backing up Nezha's server-side database files on github
GH_EMAILNogithub's mailbox for git push backups to remote repositories
GH_PATNogithub's PAT
ARGO_AUTHYesArgo Json from https://fscarmen.cloudflare.now.cc
Argo token from Cloudflare official website
ARGO_DOMAINYesArgo domain
Koyeb
Deploy to Koyeb
imageimageimageimageimage
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,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.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":1733144698000}'),s={name:"en_US/case/case5.md"},o=n(`
Nezha server over Argo tunnel ​
Contributors:
GitHub project: Argo-Nezha-Service-Container
Catalog ​
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.
image
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.
image
Add https:// to the beginning of the panel's domain name and /oauth2/callback to the end of the callback address.
imageimageimageimageimage
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 ​
image
(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 >.
imageimageimageimageimageimageimage
PaaS Deployment Example ​
Image fscarmen/argo-nezha:latest, supports amd64 and arm64 architectures.
Variables used
Variable NameRequiredRemarks
GH_USERYesgithub username for panel admin authorization
GH_CLIENTIDyesapply on github
GH_CLIENTSECRETyesapply on github
GH_BACKUP_USERNoThe 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_REPONoThe github repository for backing up Nezha's server-side database files on github
GH_EMAILNogithub's mailbox for git push backups to remote repositories
GH_PATNogithub's PAT
ARGO_AUTHYesArgo Json from https://fscarmen.cloudflare.now.cc
Argo token from Cloudflare official website
ARGO_DOMAINYesArgo domain
Koyeb
Deploy to Koyeb
imageimageimageimageimage
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.C-8AxizL.lean.js b/assets/en_US_case_case5.md.Ret5X66G.lean.js
similarity index 85%
rename from assets/en_US_case_case5.md.C-8AxizL.lean.js
rename to assets/en_US_case_case5.md.Ret5X66G.lean.js
index ed79affb..1d63dd16 100644
--- a/assets/en_US_case_case5.md.C-8AxizL.lean.js
+++ b/assets/en_US_case_case5.md.Ret5X66G.lean.js
@@ -1 +1 @@
-import{_ as e,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.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":1733103039000}'),s={name:"en_US/case/case5.md"},o=n("",88),r=[o];function i(l,c,h,d,p,u){return t(),a("div",null,r)}const f=e(s,[["render",i]]);export{g as __pageData,f as default};
+import{_ as e,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.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":1733144698000}'),s={name:"en_US/case/case5.md"},o=n("",88),r=[o];function i(l,c,h,d,p,u){return t(),a("div",null,r)}const f=e(s,[["render",i]]);export{g as __pageData,f as default};
diff --git a/assets/en_US_case_case6.md.dZg_cPuX.js b/assets/en_US_case_case6.md.D0s7jzQO.js
similarity index 98%
rename from assets/en_US_case_case6.md.dZg_cPuX.js
rename to assets/en_US_case_case6.md.D0s7jzQO.js
index aa537073..0b3777ad 100644
--- a/assets/en_US_case_case6.md.dZg_cPuX.js
+++ b/assets/en_US_case_case6.md.D0s7jzQO.js
@@ -1 +1 @@
-import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917.CVyK0T4N.svg",i="/assets/1_en_US.CE_aSW8N.png",n="/assets/2_en_US.Dm8rLo_N.png",s="/assets/3_en_US.SUOW4yEM.png",k=JSON.parse('{"title":"Nezha Mobile - An iOS Client For Nezha Dashboard","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case6.md","filePath":"en_US/case/case6.md","lastUpdated":1733103039000}'),l={name:"en_US/case/case6.md"},h=a('
Nezha Mobile - An iOS Client For Nezha Dashboard ​
Contributor:
Contribute to the project ​
Project Link
INFO
We appreciate any contribution to the project, and we will actively merge your commits into next Release. However, we may modify your work in order to comply with App Review Guidelines.
Download on the App Store ​
Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917
WARNING
Due to ICP Filing Policy, Nezha Mobile is not available in China mainland.
TestFlight Testing Program ​
Join TestFlight Testing
Instructions ​
  • Enter your Dashboard link like server.hidandelion.com and API token on your first use. Do not add a protocol prefix or a trailing slash to the link. API Token can be retrieved from Admin Center of Dashboard. step1
Configure Widget(Optional) ​
  • Add a widget on your Springboard. Long-tap the widget and then tap Edit Widget. step2
  • Choose a server you want to monitor on the next view. You can choose different servers for each widget. step3
',15),c=[h];function d(p,_,g,u,m,b){return o(),t("div",null,c)}const w=e(l,[["render",d]]);export{k as __pageData,w as default};
+import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917.CVyK0T4N.svg",i="/assets/1_en_US.CE_aSW8N.png",n="/assets/2_en_US.Dm8rLo_N.png",s="/assets/3_en_US.SUOW4yEM.png",k=JSON.parse('{"title":"Nezha Mobile - An iOS Client For Nezha Dashboard","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case6.md","filePath":"en_US/case/case6.md","lastUpdated":1733144698000}'),l={name:"en_US/case/case6.md"},h=a('
Nezha Mobile - An iOS Client For Nezha Dashboard ​
Contributor:
Contribute to the project ​
Project Link
INFO
We appreciate any contribution to the project, and we will actively merge your commits into next Release. However, we may modify your work in order to comply with App Review Guidelines.
Download on the App Store ​
Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917
WARNING
Due to ICP Filing Policy, Nezha Mobile is not available in China mainland.
TestFlight Testing Program ​
Join TestFlight Testing
Instructions ​
  • Enter your Dashboard link like server.hidandelion.com and API token on your first use. Do not add a protocol prefix or a trailing slash to the link. API Token can be retrieved from Admin Center of Dashboard. step1
Configure Widget(Optional) ​
  • Add a widget on your Springboard. Long-tap the widget and then tap Edit Widget. step2
  • Choose a server you want to monitor on the next view. You can choose different servers for each widget. step3
',15),c=[h];function d(p,_,g,u,m,b){return o(),t("div",null,c)}const w=e(l,[["render",d]]);export{k as __pageData,w as default};
diff --git a/assets/en_US_case_case6.md.dZg_cPuX.lean.js b/assets/en_US_case_case6.md.D0s7jzQO.lean.js
similarity index 89%
rename from assets/en_US_case_case6.md.dZg_cPuX.lean.js
rename to assets/en_US_case_case6.md.D0s7jzQO.lean.js
index 628b114f..fbcc5c33 100644
--- a/assets/en_US_case_case6.md.dZg_cPuX.lean.js
+++ b/assets/en_US_case_case6.md.D0s7jzQO.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917.CVyK0T4N.svg",i="/assets/1_en_US.CE_aSW8N.png",n="/assets/2_en_US.Dm8rLo_N.png",s="/assets/3_en_US.SUOW4yEM.png",k=JSON.parse('{"title":"Nezha Mobile - An iOS Client For Nezha Dashboard","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case6.md","filePath":"en_US/case/case6.md","lastUpdated":1733103039000}'),l={name:"en_US/case/case6.md"},h=a("",15),c=[h];function d(p,_,g,u,m,b){return o(),t("div",null,c)}const w=e(l,[["render",d]]);export{k as __pageData,w as default};
+import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917.CVyK0T4N.svg",i="/assets/1_en_US.CE_aSW8N.png",n="/assets/2_en_US.Dm8rLo_N.png",s="/assets/3_en_US.SUOW4yEM.png",k=JSON.parse('{"title":"Nezha Mobile - An iOS Client For Nezha Dashboard","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case6.md","filePath":"en_US/case/case6.md","lastUpdated":1733144698000}'),l={name:"en_US/case/case6.md"},h=a("",15),c=[h];function d(p,_,g,u,m,b){return o(),t("div",null,c)}const w=e(l,[["render",d]]);export{k as __pageData,w as default};
diff --git a/assets/en_US_case_case7.md.CqiR3Gyi.js b/assets/en_US_case_case7.md.Du0bNPj-.js
similarity index 97%
rename from assets/en_US_case_case7.md.CqiR3Gyi.js
rename to assets/en_US_case_case7.md.Du0bNPj-.js
index e8192e78..70bf717c 100644
--- a/assets/en_US_case_case7.md.CqiR3Gyi.js
+++ b/assets/en_US_case_case7.md.Du0bNPj-.js
@@ -1 +1 @@
-import{_ as e,a as r}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as a,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Broker for Nezha - Advancing on more platforms","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case7.md","filePath":"en_US/case/case7.md","lastUpdated":1733103039000}'),i={name:"en_US/case/case7.md"},l=n('
Broker for Nezha - Advancing on more platforms ​
Contributor:
Broker for Nezha is a modified version of the Nezha Agent that separates data collection from gRPC reporting, enabling small devices to connect to the Nezha Dashboard.
Project link: https://codeberg.org/uubulb/broker
Online Documentation: Broker for Nezha
Difference from Nezha Agent ​
  • Utilizes external data sources to report to Nezha Dashboard.
  • Supports configuring multiple sources and connecting to multiple Dashboards.
  • Only has limited task support. For details, view the project README.
Broker for Nezha needs to be used with specific data collection software. Currently, it provides two data collection methods:
  1. HTTP (HTTP/1.1) - Active polling
  2. TCP - Passive collection (recommended to avoid creating redundant connections)
For existing data collection software, refer to the project README. Due to security concerns, it's recommended to use this only in a trusted network.
Writing a Data Collector ​
If you need to write your own data collector, you'll need to implement a basic HTTP server or TCP client and use a specific data format that Broker can recognize. For details, see: Data types
Examples ​
Dashboard
 Dashboard 

WebSSH
 WebSSH 
',17),s=[l];function c(d,f,h,p,u,m){return o(),t("div",null,s)}const k=a(i,[["render",c]]);export{_ as __pageData,k as default};
+import{_ as e,a as r}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as a,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Broker for Nezha - Advancing on more platforms","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case7.md","filePath":"en_US/case/case7.md","lastUpdated":1733144698000}'),i={name:"en_US/case/case7.md"},l=n('
Broker for Nezha - Advancing on more platforms ​
Contributor:
Broker for Nezha is a modified version of the Nezha Agent that separates data collection from gRPC reporting, enabling small devices to connect to the Nezha Dashboard.
Project link: https://codeberg.org/uubulb/broker
Online Documentation: Broker for Nezha
Difference from Nezha Agent ​
  • Utilizes external data sources to report to Nezha Dashboard.
  • Supports configuring multiple sources and connecting to multiple Dashboards.
  • Only has limited task support. For details, view the project README.
Broker for Nezha needs to be used with specific data collection software. Currently, it provides two data collection methods:
  1. HTTP (HTTP/1.1) - Active polling
  2. TCP - Passive collection (recommended to avoid creating redundant connections)
For existing data collection software, refer to the project README. Due to security concerns, it's recommended to use this only in a trusted network.
Writing a Data Collector ​
If you need to write your own data collector, you'll need to implement a basic HTTP server or TCP client and use a specific data format that Broker can recognize. For details, see: Data types
Examples ​
Dashboard
 Dashboard 

WebSSH
 WebSSH 
',17),s=[l];function c(d,f,h,p,u,m){return o(),t("div",null,s)}const k=a(i,[["render",c]]);export{_ as __pageData,k as default};
diff --git a/assets/en_US_case_case7.md.CqiR3Gyi.lean.js b/assets/en_US_case_case7.md.Du0bNPj-.lean.js
similarity index 87%
rename from assets/en_US_case_case7.md.CqiR3Gyi.lean.js
rename to assets/en_US_case_case7.md.Du0bNPj-.lean.js
index d62e7090..4243f49c 100644
--- a/assets/en_US_case_case7.md.CqiR3Gyi.lean.js
+++ b/assets/en_US_case_case7.md.Du0bNPj-.lean.js
@@ -1 +1 @@
-import{_ as e,a as r}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as a,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Broker for Nezha - Advancing on more platforms","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case7.md","filePath":"en_US/case/case7.md","lastUpdated":1733103039000}'),i={name:"en_US/case/case7.md"},l=n("",17),s=[l];function c(d,f,h,p,u,m){return o(),t("div",null,s)}const k=a(i,[["render",c]]);export{_ as __pageData,k as default};
+import{_ as e,a as r}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as a,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Broker for Nezha - Advancing on more platforms","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case7.md","filePath":"en_US/case/case7.md","lastUpdated":1733144698000}'),i={name:"en_US/case/case7.md"},l=n("",17),s=[l];function c(d,f,h,p,u,m){return o(),t("div",null,s)}const k=a(i,[["render",c]]);export{_ as __pageData,k as default};
diff --git a/assets/en_US_case_index.md.BoiWbPsb.js b/assets/en_US_case_index.md.B9dR1rfW.js
similarity index 95%
rename from assets/en_US_case_index.md.BoiWbPsb.js
rename to assets/en_US_case_index.md.B9dR1rfW.js
index b0fd05e4..94a3a218 100644
--- a/assets/en_US_case_index.md.BoiWbPsb.js
+++ b/assets/en_US_case_index.md.B9dR1rfW.js
@@ -1 +1 @@
-import{_ as e,c as t,o}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","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":1733103039000}'),a={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return o(),t("div")}const h=e(a,[["render",i]]);export{u as __pageData,h as default};
+import{_ as e,c as t,o}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","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":1733144698000}'),a={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return o(),t("div")}const h=e(a,[["render",i]]);export{u as __pageData,h as default};
diff --git a/assets/en_US_case_index.md.BoiWbPsb.lean.js b/assets/en_US_case_index.md.B9dR1rfW.lean.js
similarity index 95%
rename from assets/en_US_case_index.md.BoiWbPsb.lean.js
rename to assets/en_US_case_index.md.B9dR1rfW.lean.js
index b0fd05e4..94a3a218 100644
--- a/assets/en_US_case_index.md.BoiWbPsb.lean.js
+++ b/assets/en_US_case_index.md.B9dR1rfW.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","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":1733103039000}'),a={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return o(),t("div")}const h=e(a,[["render",i]]);export{u as __pageData,h as default};
+import{_ as e,c as t,o}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","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":1733144698000}'),a={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return o(),t("div")}const h=e(a,[["render",i]]);export{u as __pageData,h as default};
diff --git a/assets/en_US_developer_index.md.Dn9U3265.js b/assets/en_US_developer_index.md.B3YfUGsU.js
similarity index 92%
rename from assets/en_US_developer_index.md.Dn9U3265.js
rename to assets/en_US_developer_index.md.B3YfUGsU.js
index d2ea7f0c..1ce4b8cb 100644
--- a/assets/en_US_developer_index.md.Dn9U3265.js
+++ b/assets/en_US_developer_index.md.B3YfUGsU.js
@@ -1 +1 @@
-import{_ as e,c as t,o as n}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","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":1733103039000}'),a={name:"en_US/developer/index.md"};function o(r,i,l,m,s,p){return n(),t("div")}const _=e(a,[["render",o]]);export{c as __pageData,_ as default};
+import{_ as e,c as t,o as n}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","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":1733144698000}'),a={name:"en_US/developer/index.md"};function o(r,i,l,m,s,p){return n(),t("div")}const _=e(a,[["render",o]]);export{c as __pageData,_ as default};
diff --git a/assets/en_US_developer_index.md.Dn9U3265.lean.js b/assets/en_US_developer_index.md.B3YfUGsU.lean.js
similarity index 92%
rename from assets/en_US_developer_index.md.Dn9U3265.lean.js
rename to assets/en_US_developer_index.md.B3YfUGsU.lean.js
index d2ea7f0c..1ce4b8cb 100644
--- a/assets/en_US_developer_index.md.Dn9U3265.lean.js
+++ b/assets/en_US_developer_index.md.B3YfUGsU.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as n}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","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":1733103039000}'),a={name:"en_US/developer/index.md"};function o(r,i,l,m,s,p){return n(),t("div")}const _=e(a,[["render",o]]);export{c as __pageData,_ as default};
+import{_ as e,c as t,o as n}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","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":1733144698000}'),a={name:"en_US/developer/index.md"};function o(r,i,l,m,s,p){return n(),t("div")}const _=e(a,[["render",o]]);export{c as __pageData,_ as default};
diff --git a/assets/en_US_developer_l10n.md.CwiS7FZZ.js b/assets/en_US_developer_l10n.md.BWjfIUVn.js
similarity index 96%
rename from assets/en_US_developer_l10n.md.CwiS7FZZ.js
rename to assets/en_US_developer_l10n.md.BWjfIUVn.js
index e1eee86b..9768cd90 100644
--- a/assets/en_US_developer_l10n.md.CwiS7FZZ.js
+++ b/assets/en_US_developer_l10n.md.BWjfIUVn.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,a4 as o}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Localization","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1733103039000}'),n={name:"en_US/developer/l10n.md"},i=o('
Localization ​
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 ​
  1. You can directly use the text configuration already available in /resource/l10n/en-US.toml to replace the text in the new feature.
  2. 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 ​
  1. Add a new language text configuration in /resource/l10n/.
  2. Pull existing text configurations from other languages in the new language text configuration.
  3. Add translations for the new language text configuration.
',6),l=[i];function r(d,c,s,u,h,f){return a(),t("div",null,l)}const p=e(n,[["render",r]]);export{g as __pageData,p as default};
+import{_ as e,c as t,o as a,a4 as o}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Localization","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1733144698000}'),n={name:"en_US/developer/l10n.md"},i=o('
Localization ​
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 ​
  1. You can directly use the text configuration already available in /resource/l10n/en-US.toml to replace the text in the new feature.
  2. 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 ​
  1. Add a new language text configuration in /resource/l10n/.
  2. Pull existing text configurations from other languages in the new language text configuration.
  3. Add translations for the new language text configuration.
',6),l=[i];function r(d,c,s,u,h,f){return a(),t("div",null,l)}const p=e(n,[["render",r]]);export{g as __pageData,p as default};
diff --git a/assets/en_US_developer_l10n.md.CwiS7FZZ.lean.js b/assets/en_US_developer_l10n.md.BWjfIUVn.lean.js
similarity index 85%
rename from assets/en_US_developer_l10n.md.CwiS7FZZ.lean.js
rename to assets/en_US_developer_l10n.md.BWjfIUVn.lean.js
index 7ab858b3..077cbcf5 100644
--- a/assets/en_US_developer_l10n.md.CwiS7FZZ.lean.js
+++ b/assets/en_US_developer_l10n.md.BWjfIUVn.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,a4 as o}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Localization","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1733103039000}'),n={name:"en_US/developer/l10n.md"},i=o("",6),l=[i];function r(d,c,s,u,h,f){return a(),t("div",null,l)}const p=e(n,[["render",r]]);export{g as __pageData,p as default};
+import{_ as e,c as t,o as a,a4 as o}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Localization","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1733144698000}'),n={name:"en_US/developer/l10n.md"},i=o("",6),l=[i];function r(d,c,s,u,h,f){return a(),t("div",null,l)}const p=e(n,[["render",r]]);export{g as __pageData,p as default};
diff --git a/assets/en_US_developer_theme.md.DJoIeh2J.js b/assets/en_US_developer_theme.md.D4mBFp1x.js
similarity index 96%
rename from assets/en_US_developer_theme.md.DJoIeh2J.js
rename to assets/en_US_developer_theme.md.D4mBFp1x.js
index 47ff8ec0..31fbc8da 100644
--- a/assets/en_US_developer_theme.md.DJoIeh2J.js
+++ b/assets/en_US_developer_theme.md.D4mBFp1x.js
@@ -1 +1 @@
-import{_ as e,c as o,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Nezha Theme Development Environment","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1733103039000}'),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.19.20 and newer versions.
How to use ​
  1. Clone this repository to local
  2. Modify the Oauth2 configuration in data/config.yaml（The callback connection can be filled with http://localhost）
  3. Run docker-compose up
  4. Start development
  5. After completing the theme creation, you can place theme-custom (frontend theme), static-custom (frontend theme static files), and dashboard-custom (backend theme) into the /opt/nezha/dashboard/ directory on the server (if installed using Docker).
FAQ ​
  • If you can't use port 80, change the configuration in docker-compose.yaml.
',7),i=[c];function r(l,d,h,s,m,p){return t(),o("div",null,i)}const f=e(n,[["render",r]]);export{_ as __pageData,f as default};
+import{_ as e,c as o,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Nezha Theme Development Environment","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1733144698000}'),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.19.20 and newer versions.
How to use ​
  1. Clone this repository to local
  2. Modify the Oauth2 configuration in data/config.yaml（The callback connection can be filled with http://localhost）
  3. Run docker-compose up
  4. Start development
  5. After completing the theme creation, you can place theme-custom (frontend theme), static-custom (frontend theme static files), and dashboard-custom (backend theme) into the /opt/nezha/dashboard/ directory on the server (if installed using Docker).
FAQ ​
  • If you can't use port 80, change the configuration in docker-compose.yaml.
',7),i=[c];function r(l,d,h,s,m,p){return t(),o("div",null,i)}const f=e(n,[["render",r]]);export{_ as __pageData,f as default};
diff --git a/assets/en_US_developer_theme.md.DJoIeh2J.lean.js b/assets/en_US_developer_theme.md.D4mBFp1x.lean.js
similarity index 86%
rename from assets/en_US_developer_theme.md.DJoIeh2J.lean.js
rename to assets/en_US_developer_theme.md.D4mBFp1x.lean.js
index f1ee8c72..5a083452 100644
--- a/assets/en_US_developer_theme.md.DJoIeh2J.lean.js
+++ b/assets/en_US_developer_theme.md.D4mBFp1x.lean.js
@@ -1 +1 @@
-import{_ as e,c as o,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Nezha Theme Development Environment","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1733103039000}'),n={name:"en_US/developer/theme.md"},c=a("",7),i=[c];function r(l,d,h,s,m,p){return t(),o("div",null,i)}const f=e(n,[["render",r]]);export{_ as __pageData,f as default};
+import{_ as e,c as o,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Nezha Theme Development Environment","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1733144698000}'),n={name:"en_US/developer/theme.md"},c=a("",7),i=[c];function r(l,d,h,s,m,p){return t(),o("div",null,i)}const f=e(n,[["render",r]]);export{_ as __pageData,f as default};
diff --git a/assets/en_US_guide_agent.md.FHT_o8SS.js b/assets/en_US_guide_agent.md.G69D4bG1.js
similarity index 99%
rename from assets/en_US_guide_agent.md.FHT_o8SS.js
rename to assets/en_US_guide_agent.md.G69D4bG1.js
index 6937da08..7ae8d592 100644
--- a/assets/en_US_guide_agent.md.FHT_o8SS.js
+++ b/assets/en_US_guide_agent.md.G69D4bG1.js
@@ -1,4 +1,4 @@
-import{_ as s,c as i,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"Install Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1733103039000}'),n={name:"en_US/guide/agent.md"},t=e(`
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 ​
  1. First, add a server in the admin panel.
  2. Click the green Linux icon button next to the newly added server and copy the one-click installation command.
  3. Run the copied installation command on the monitored server, and wait for the installation to complete. Then, check if the server is online in the Dashboard home page.
One-Click Installation on macOS ​
  1. First, add a server in the admin panel.
  2. Click the green Apple icon button next to the newly added server and copy the one-click installation command.
  3. Run the copied installation command on the monitored server, and wait for the installation to complete. Then, check if the server is online in the Dashboard home page.
One-Click Installation on Windows ​
  1. First, add a server in the admin panel.
  2. Click the green Windows icon button next to the newly added server and copy the one-click installation command.
  3. Go to the Windows server, run PowerShell, and execute the copied installation command in PowerShell.
  4. If you encounter a prompt to "change execution policy," choose Y.
  5. Wait for the installation to complete, then check if the server is online in the Dashboard home page.
WARNING
If you encounter errors when running the one-click installation command in PowerShell, try the Manual Installation of the Agent on Windows below.
Other Ways to Install the Agent ​
Installing the Agent on Linux (Support most distros) ​
Click to expand/collapse
  1. First, add a server in the admin panel.
  2. Run the script on the monitored server:
bash
curl -L https://raw.githubusercontent.com/nezhahq/scripts/main/install_en.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
  1. Select “Install monitoring Agent.”
  2. Enter the communication domain, such as "data.example.com".
  3. Enter the dashboard communication port (gRPC port), default is 5555.
  4. Enter the Agent secret, which is generated when you add a server in the admin panel and can be found on the “Servers” page in the admin panel.
  5. Wait for the installation to complete, then check if the server is online in the Dashboard home page.
Installing the Agent using the built-in service command (Support most systems) ​
Click to expand/collapse
First, get a copy of Nezha Agent: https://github.com/nezhahq/agent/releases
After extracting the archive, run the following command to install the service (may require root permission):
bash
./nezha-agent service install -s server_name:port -p password
You can also add other arguments except the server address and password. For more details, refer to the documentation: Customizing Agent Monitoring Items.
Uninstall the service:
bash
./nezha-agent service uninstall
Start the service:
bash
./nezha-agent service start
Stop the service:
bash
./nezha-agent service stop
Restart the service:
bash
./nezha-agent service restart
Installing the Agent with runit ​
Click to expand/collapse
The built-in service command of Agent supports most init systems, including FreeBSD rc.d and openrc, but still missing some of them.
Here we take Void Linux's runit as an example:
  1. Create directory /etc/sv/nezha-agent:
bash
mkdir /etc/sv/nezha-agent
  1. Create service file /etc/sv/nezha-agent/run, with following content:
bash
#!/bin/sh
+import{_ as s,c as i,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"Install Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1733144698000}'),n={name:"en_US/guide/agent.md"},t=e(`
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 ​
  1. First, add a server in the admin panel.
  2. Click the green Linux icon button next to the newly added server and copy the one-click installation command.
  3. Run the copied installation command on the monitored server, and wait for the installation to complete. Then, check if the server is online in the Dashboard home page.
One-Click Installation on macOS ​
  1. First, add a server in the admin panel.
  2. Click the green Apple icon button next to the newly added server and copy the one-click installation command.
  3. Run the copied installation command on the monitored server, and wait for the installation to complete. Then, check if the server is online in the Dashboard home page.
One-Click Installation on Windows ​
  1. First, add a server in the admin panel.
  2. Click the green Windows icon button next to the newly added server and copy the one-click installation command.
  3. Go to the Windows server, run PowerShell, and execute the copied installation command in PowerShell.
  4. If you encounter a prompt to "change execution policy," choose Y.
  5. Wait for the installation to complete, then check if the server is online in the Dashboard home page.
WARNING
If you encounter errors when running the one-click installation command in PowerShell, try the Manual Installation of the Agent on Windows below.
Other Ways to Install the Agent ​
Installing the Agent on Linux (Support most distros) ​
Click to expand/collapse
  1. First, add a server in the admin panel.
  2. Run the script on the monitored server:
bash
curl -L https://raw.githubusercontent.com/nezhahq/scripts/main/install_en.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
  1. Select “Install monitoring Agent.”
  2. Enter the communication domain, such as "data.example.com".
  3. Enter the dashboard communication port (gRPC port), default is 5555.
  4. Enter the Agent secret, which is generated when you add a server in the admin panel and can be found on the “Servers” page in the admin panel.
  5. Wait for the installation to complete, then check if the server is online in the Dashboard home page.
Installing the Agent using the built-in service command (Support most systems) ​
Click to expand/collapse
First, get a copy of Nezha Agent: https://github.com/nezhahq/agent/releases
After extracting the archive, run the following command to install the service (may require root permission):
bash
./nezha-agent service install -s server_name:port -p password
You can also add other arguments except the server address and password. For more details, refer to the documentation: Customizing Agent Monitoring Items.
Uninstall the service:
bash
./nezha-agent service uninstall
Start the service:
bash
./nezha-agent service start
Stop the service:
bash
./nezha-agent service stop
Restart the service:
bash
./nezha-agent service restart
Installing the Agent with runit ​
Click to expand/collapse
The built-in service command of Agent supports most init systems, including FreeBSD rc.d and openrc, but still missing some of them.
Here we take Void Linux's runit as an example:
  1. Create directory /etc/sv/nezha-agent:
bash
mkdir /etc/sv/nezha-agent
  1. Create service file /etc/sv/nezha-agent/run, with following content:
bash
#!/bin/sh
 exec 2>&1
 exec /opt/nezha/agent/nezha-agent -s server_name:port -p password 2>&1
You can add other arguments here as well.
  1. Create logging service file /etc/sv/nezha-agent/log/run:
bash
#!/bin/sh
 exec vlogger -t nezha-agent -p daemon
  1. Enable the service:
bash
sudo ln -s /etc/sv/nezha-agent/ /var/service
Use the sv command to manage the service.
How to view logs:
  1. Install socklog and enable it:
bash
sudo xbps-install -S socklog-void
diff --git a/assets/en_US_guide_agent.md.FHT_o8SS.lean.js b/assets/en_US_guide_agent.md.G69D4bG1.lean.js
similarity index 85%
rename from assets/en_US_guide_agent.md.FHT_o8SS.lean.js
rename to assets/en_US_guide_agent.md.G69D4bG1.lean.js
index a9f7d6e0..2af14cb3 100644
--- a/assets/en_US_guide_agent.md.FHT_o8SS.lean.js
+++ b/assets/en_US_guide_agent.md.G69D4bG1.lean.js
@@ -1 +1 @@
-import{_ as s,c as i,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"Install Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1733103039000}'),n={name:"en_US/guide/agent.md"},t=e("",31),l=[t];function h(p,o,r,k,d,c){return a(),i("div",null,l)}const u=s(n,[["render",h]]);export{F as __pageData,u as default};
+import{_ as s,c as i,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"Install Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1733144698000}'),n={name:"en_US/guide/agent.md"},t=e("",31),l=[t];function h(p,o,r,k,d,c){return a(),i("div",null,l)}const u=s(n,[["render",h]]);export{F as __pageData,u as default};
diff --git a/assets/en_US_guide_agentq.md.BkyR0FBx.js b/assets/en_US_guide_agentq.md.CEbylkU1.js
similarity index 97%
rename from assets/en_US_guide_agentq.md.BkyR0FBx.js
rename to assets/en_US_guide_agentq.md.CEbylkU1.js
index cb9365ab..8c22e859 100644
--- a/assets/en_US_guide_agentq.md.BkyR0FBx.js
+++ b/assets/en_US_guide_agentq.md.CEbylkU1.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.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":1733103039000}'),i={name:"en_US/guide/agentq.md"},s=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:
shell
apt install sudo
',9),o=[s];function r(l,d,h,c,u,p){return a(),t("div",null,o)}const g=e(i,[["render",r]]);export{f as __pageData,g as default};
+import{_ as e,c as t,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.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":1733144698000}'),i={name:"en_US/guide/agentq.md"},s=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:
shell
apt install sudo
',9),o=[s];function r(l,d,h,c,u,p){return a(),t("div",null,o)}const g=e(i,[["render",r]]);export{f as __pageData,g as default};
diff --git a/assets/en_US_guide_agentq.md.BkyR0FBx.lean.js b/assets/en_US_guide_agentq.md.CEbylkU1.lean.js
similarity index 86%
rename from assets/en_US_guide_agentq.md.BkyR0FBx.lean.js
rename to assets/en_US_guide_agentq.md.CEbylkU1.lean.js
index 6be587ec..85bbfb81 100644
--- a/assets/en_US_guide_agentq.md.BkyR0FBx.lean.js
+++ b/assets/en_US_guide_agentq.md.CEbylkU1.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.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":1733103039000}'),i={name:"en_US/guide/agentq.md"},s=n("",9),o=[s];function r(l,d,h,c,u,p){return a(),t("div",null,o)}const g=e(i,[["render",r]]);export{f as __pageData,g as default};
+import{_ as e,c as t,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.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":1733144698000}'),i={name:"en_US/guide/agentq.md"},s=n("",9),o=[s];function r(l,d,h,c,u,p){return a(),t("div",null,o)}const g=e(i,[["render",r]]);export{f as __pageData,g as default};
diff --git a/assets/en_US_guide_api.md.cXcFxIK9.js b/assets/en_US_guide_api.md.ChtD4_vy.js
similarity index 99%
rename from assets/en_US_guide_api.md.cXcFxIK9.js
rename to assets/en_US_guide_api.md.ChtD4_vy.js
index 82865f60..a0636d28 100644
--- a/assets/en_US_guide_api.md.cXcFxIK9.js
+++ b/assets/en_US_guide_api.md.ChtD4_vy.js
@@ -1,4 +1,4 @@
-import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"API Interface","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1733103039000}'),t={name:"en_US/guide/api.md"},h=n(`
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,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"API Interface","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1733144698000}'),t={name:"en_US/guide/api.md"},h=n(`
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.cXcFxIK9.lean.js b/assets/en_US_guide_api.md.ChtD4_vy.lean.js
similarity index 85%
rename from assets/en_US_guide_api.md.cXcFxIK9.lean.js
rename to assets/en_US_guide_api.md.ChtD4_vy.lean.js
index fb1df28c..a6550343 100644
--- a/assets/en_US_guide_api.md.cXcFxIK9.lean.js
+++ b/assets/en_US_guide_api.md.ChtD4_vy.lean.js
@@ -1 +1 @@
-import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"API Interface","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1733103039000}'),t={name:"en_US/guide/api.md"},h=n("",61),k=[h];function l(p,e,E,r,d,o){return a(),i("div",null,k)}const y=s(t,[["render",l]]);export{F as __pageData,y as default};
+import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"API Interface","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1733144698000}'),t={name:"en_US/guide/api.md"},h=n("",61),k=[h];function l(p,e,E,r,d,o){return a(),i("div",null,k)}const y=s(t,[["render",l]]);export{F as __pageData,y as default};
diff --git a/assets/en_US_guide_dashboard.md.Bjr4AhFC.js b/assets/en_US_guide_dashboard.md.rLfT63xV.js
similarity index 99%
rename from assets/en_US_guide_dashboard.md.Bjr4AhFC.js
rename to assets/en_US_guide_dashboard.md.rLfT63xV.js
index 2b8c66ce..d46a50fc 100644
--- a/assets/en_US_guide_dashboard.md.Bjr4AhFC.js
+++ b/assets/en_US_guide_dashboard.md.rLfT63xV.js
@@ -1,4 +1,4 @@
-import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Install Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1733103039000}'),i={name:"en_US/guide/dashboard.md"},n=t(`
Install Dashboard ​
Preparation ​
To set up Nezha Monitoring, you need:
  1. 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.
  2. 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.
  1. 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.
  1. 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).
  2. Click “Register application”.
  3. 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 an OAuth2 Provider ​
If you encounter issues using GitHub, GitLab, or Gitee for admin account logins, consider switching to Cloudflare Access as your OAuth2 provider for authentication.
Setting Up a New SaaS-OIDC Application ​
WARNING
The following steps are for users who have already started using Zero Trust. If you have not previously used Cloudflare Zero Trust, we strongly recommend that you first read the Guide on Using Cloudflare Access as an OAuth2 Provider to understand the configuration examples and setup process.
  1. Go to Zero Trust Dashboard and log in with your Cloudflare account.
  2. My Team -> Users -> <specific user> -> Get User ID and save it.
  3. Access -> Application -> Add an Application.
  4. Choose SaaS, enter a custom application name in Application (e.g., nezha), select OIDC, and click Add application.
  5. Select Scopes: openid, email, profile, groups.
  6. Fill in your callback address in Redirect URLs, such as https://dashboard.example.com/oauth2/callback.
  7. 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.
OIDC Authentication Configuration (Optional) ​
Nazha supports custom OIDC authentication login. For configuration details, please refer to the documentation: Enable OIDC authorization.
Installing the Dashboard on the Server ​
Run the installation script on the dashboard server:
bash
curl -L https://raw.githubusercontent.com/nezhahq/scripts/main/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,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Install Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1733144698000}'),i={name:"en_US/guide/dashboard.md"},n=t(`
Install Dashboard ​
Preparation ​
To set up Nezha Monitoring, you need:
  1. 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.
  2. 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.
  1. 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.
  1. 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).
  2. Click “Register application”.
  3. 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 an OAuth2 Provider ​
If you encounter issues using GitHub, GitLab, or Gitee for admin account logins, consider switching to Cloudflare Access as your OAuth2 provider for authentication.
Setting Up a New SaaS-OIDC Application ​
WARNING
The following steps are for users who have already started using Zero Trust. If you have not previously used Cloudflare Zero Trust, we strongly recommend that you first read the Guide on Using Cloudflare Access as an OAuth2 Provider to understand the configuration examples and setup process.
  1. Go to Zero Trust Dashboard and log in with your Cloudflare account.
  2. My Team -> Users -> <specific user> -> Get User ID and save it.
  3. Access -> Application -> Add an Application.
  4. Choose SaaS, enter a custom application name in Application (e.g., nezha), select OIDC, and click Add application.
  5. Select Scopes: openid, email, profile, groups.
  6. Fill in your callback address in Redirect URLs, such as https://dashboard.example.com/oauth2/callback.
  7. 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.
OIDC Authentication Configuration (Optional) ​
Nazha supports custom OIDC authentication login. For configuration details, please refer to the documentation: Enable OIDC authorization.
Installing the Dashboard on the Server ​
Run the installation script on the dashboard server:
bash
curl -L https://raw.githubusercontent.com/nezhahq/scripts/main/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.Bjr4AhFC.lean.js b/assets/en_US_guide_dashboard.md.rLfT63xV.lean.js
similarity index 86%
rename from assets/en_US_guide_dashboard.md.Bjr4AhFC.lean.js
rename to assets/en_US_guide_dashboard.md.rLfT63xV.lean.js
index 555f3bce..a0278f10 100644
--- a/assets/en_US_guide_dashboard.md.Bjr4AhFC.lean.js
+++ b/assets/en_US_guide_dashboard.md.rLfT63xV.lean.js
@@ -1 +1 @@
-import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Install Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1733103039000}'),i={name:"en_US/guide/dashboard.md"},n=t("",41),o=[n];function r(l,h,p,d,c,u){return s(),e("div",null,o)}const b=a(i,[["render",r]]);export{k as __pageData,b as default};
+import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Install Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1733144698000}'),i={name:"en_US/guide/dashboard.md"},n=t("",41),o=[n];function r(l,h,p,d,c,u){return s(),e("div",null,o)}const b=a(i,[["render",r]]);export{k as __pageData,b as default};
diff --git a/assets/en_US_guide_dashboardq.md.CvqutlhT.js b/assets/en_US_guide_dashboardq.md.C9BOMoaE.js
similarity index 99%
rename from assets/en_US_guide_dashboardq.md.CvqutlhT.js
rename to assets/en_US_guide_dashboardq.md.C9BOMoaE.js
index bdcb2c51..fff41233 100644
--- a/assets/en_US_guide_dashboardq.md.CvqutlhT.js
+++ b/assets/en_US_guide_dashboardq.md.C9BOMoaE.js
@@ -1,4 +1,4 @@
-import{_ as e,c as a,o as t,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=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":1733103039000}'),s={name:"en_US/guide/dashboardq.md"},n=i(`
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:
shell
curl https://ipapi.co/ip/
+import{_ as e,c as a,o as t,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=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":1733144698000}'),s={name:"en_US/guide/dashboardq.md"},n=i(`
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:
shell
curl 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:
shell
systemctl status docker
 systemctl restart docker
diff --git a/assets/en_US_guide_dashboardq.md.CvqutlhT.lean.js b/assets/en_US_guide_dashboardq.md.C9BOMoaE.lean.js
similarity index 87%
rename from assets/en_US_guide_dashboardq.md.CvqutlhT.lean.js
rename to assets/en_US_guide_dashboardq.md.C9BOMoaE.lean.js
index ffd12daf..714ed1c2 100644
--- a/assets/en_US_guide_dashboardq.md.CvqutlhT.lean.js
+++ b/assets/en_US_guide_dashboardq.md.C9BOMoaE.lean.js
@@ -1 +1 @@
-import{_ as e,c as a,o as t,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=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":1733103039000}'),s={name:"en_US/guide/dashboardq.md"},n=i("",40),o=[n];function r(d,l,h,c,p,u){return t(),a("div",null,o)}const f=e(s,[["render",r]]);export{b as __pageData,f as default};
+import{_ as e,c as a,o as t,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=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":1733144698000}'),s={name:"en_US/guide/dashboardq.md"},n=i("",40),o=[n];function r(d,l,h,c,p,u){return t(),a("div",null,o)}const f=e(s,[["render",r]]);export{b as __pageData,f as default};
diff --git a/assets/en_US_guide_ddns.md.BMnemOVM.js b/assets/en_US_guide_ddns.md.Dw1k13mk.js
similarity index 99%
rename from assets/en_US_guide_ddns.md.BMnemOVM.js
rename to assets/en_US_guide_ddns.md.Dw1k13mk.js
index ee8925b7..1d390a9c 100644
--- a/assets/en_US_guide_ddns.md.BMnemOVM.js
+++ b/assets/en_US_guide_ddns.md.Dw1k13mk.js
@@ -1,2 +1,2 @@
-import{_ as e,c as i,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"DDNS","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/ddns.md","filePath":"en_US/guide/ddns.md","lastUpdated":1733103039000}'),s={name:"en_US/guide/ddns.md"},a=o(`
DDNS ​
The DDNS functionality is designed for servers with dynamic IP addresses. When the Agent server reports a new IP (every 10 minutes), Dashboard will automatically update the DNS record based on the configuration.
Why should I use Nezha's DDNS functionality? ​
  • Convenient centralized management of DDNS settings, instead of deploying a DDNS service on every server.
  • Your confidential information is only stored on the Dashboard server, preventing leaks.
Configuration ​
You can directly add DDNS configurations in the Dashboard management page.
  1. Click on the "Dynamic DNS" option in the menu bar to enter the configuration page.
  2. Click the "New Profile" button and fill in the required information in the pop-up window. Option details: 
    • Name: The name of the configuration.
    • DDNS Provider: The type of provider, determining the method used to update DNS records.
    • Domains (separate with comma): The domain(s), if you enter multiple domains, they should be separated by commas. IDNs (Internationalized Domain Names) are supported.
    • Maximum retry attempts: The number of attempts for updating DDNS, default is 3, and the range is between 1 and 10.
    • DDNS Credential 1 and DDNS Credential 2 are optional. Typically, at least one needs to be provided. The table below lists the options for all providers.
  3. If using the webhook provider, the corresponding options need to be filled out as required. For detailed instructions, see Webhook Configuration.
  4. You need to check at least one of IPv4 Enabled and IPv6 Enabled; otherwise, no update operations will be performed.
  5. After adding a new configuration, you also need to modify the server settings to activate DDNS. Server-related options include: 
    • Enable DDNS: Enable DDNS functionality for this server.
    • DDNS Profiles: The list of DDNS configuration IDs to use, searchable by configuration name.
Webhook Configuration ​
Webhook requires manually constructing HTTP requests, suitable for using other provider services when operations are simple.
Webhook option descriptions:
  • Webhook URL: The URL for the HTTP request, where parameters can use placeholders.
  • Webhook Request Method: The HTTP request method. Supported methods include GET, POST, PATCH, DELETE, and PUT.
  • Webhook Request Type: The format of the HTTP request body, either JSON or Form.
  • Webhook Request Headers: HTTP request headers, filled in JSON format, but nesting is not supported.
  • Webhook Request Body: The HTTP request body. It won't be used for GET and DELETE. If you need to use a nested format, you must choose JSON as the request type.
Supported Webhook placeholders:
  • #ip#: Host IP.
  • #domain#: DDNS domain. Each request is made separately for each domain, so this value will be a single domain string.
  • #type#: IP type, either "ipv4" or "ipv6".
  • #record#: Record type, either "A" or "AAAA".
  • #access_id#: DDNS Credential 1.
  • #access_secret#: DDNS Credential 2.
Oray Webhook Example ​
Click to expand/collapse
  • URL：http://ddns.oray.com/ph/update?hostname=#domain#&myip=#ip#
  • Request Method: GET
  • Request Header：{"Authorization": "Basic pass"}, replace pass with the Base64-encoded userpass (e.g., user:pass becomes dXNlcjpwYXNzCg==).
  • Oray only supports A records, so only enable IPv4. Other Webhook options are not required.
Provider List ​
ProviderCredential 1 (ID)Credential 2 (Secret)
dummy❌️❌️
webhookOptionalOptional
cloudflare❌️✅
tencentcloud✅✅
Viewing Logs ​
In the Dashboard logs, you can see the relevant logs for the DDNS functionality. When configured correctly, there will be corresponding log entries when updating DNS records.
shell
dashboard_1  | 2024/03/16 23:16:25 NEZHA>> 正在尝试更新域名(ddns.example.com)DDNS(1/3)
+import{_ as e,c as i,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"DDNS","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/ddns.md","filePath":"en_US/guide/ddns.md","lastUpdated":1733144698000}'),s={name:"en_US/guide/ddns.md"},a=o(`
DDNS ​
The DDNS functionality is designed for servers with dynamic IP addresses. When the Agent server reports a new IP (every 10 minutes), Dashboard will automatically update the DNS record based on the configuration.
Why should I use Nezha's DDNS functionality? ​
  • Convenient centralized management of DDNS settings, instead of deploying a DDNS service on every server.
  • Your confidential information is only stored on the Dashboard server, preventing leaks.
Configuration ​
You can directly add DDNS configurations in the Dashboard management page.
  1. Click on the "Dynamic DNS" option in the menu bar to enter the configuration page.
  2. Click the "New Profile" button and fill in the required information in the pop-up window. Option details: 
    • Name: The name of the configuration.
    • DDNS Provider: The type of provider, determining the method used to update DNS records.
    • Domains (separate with comma): The domain(s), if you enter multiple domains, they should be separated by commas. IDNs (Internationalized Domain Names) are supported.
    • Maximum retry attempts: The number of attempts for updating DDNS, default is 3, and the range is between 1 and 10.
    • DDNS Credential 1 and DDNS Credential 2 are optional. Typically, at least one needs to be provided. The table below lists the options for all providers.
  3. If using the webhook provider, the corresponding options need to be filled out as required. For detailed instructions, see Webhook Configuration.
  4. You need to check at least one of IPv4 Enabled and IPv6 Enabled; otherwise, no update operations will be performed.
  5. After adding a new configuration, you also need to modify the server settings to activate DDNS. Server-related options include: 
    • Enable DDNS: Enable DDNS functionality for this server.
    • DDNS Profiles: The list of DDNS configuration IDs to use, searchable by configuration name.
Webhook Configuration ​
Webhook requires manually constructing HTTP requests, suitable for using other provider services when operations are simple.
Webhook option descriptions:
  • Webhook URL: The URL for the HTTP request, where parameters can use placeholders.
  • Webhook Request Method: The HTTP request method. Supported methods include GET, POST, PATCH, DELETE, and PUT.
  • Webhook Request Type: The format of the HTTP request body, either JSON or Form.
  • Webhook Request Headers: HTTP request headers, filled in JSON format, but nesting is not supported.
  • Webhook Request Body: The HTTP request body. It won't be used for GET and DELETE. If you need to use a nested format, you must choose JSON as the request type.
Supported Webhook placeholders:
  • #ip#: Host IP.
  • #domain#: DDNS domain. Each request is made separately for each domain, so this value will be a single domain string.
  • #type#: IP type, either "ipv4" or "ipv6".
  • #record#: Record type, either "A" or "AAAA".
  • #access_id#: DDNS Credential 1.
  • #access_secret#: DDNS Credential 2.
Oray Webhook Example ​
Click to expand/collapse
  • URL：http://ddns.oray.com/ph/update?hostname=#domain#&myip=#ip#
  • Request Method: GET
  • Request Header：{"Authorization": "Basic pass"}, replace pass with the Base64-encoded userpass (e.g., user:pass becomes dXNlcjpwYXNzCg==).
  • Oray only supports A records, so only enable IPv4. Other Webhook options are not required.
Provider List ​
ProviderCredential 1 (ID)Credential 2 (Secret)
dummy❌️❌️
webhookOptionalOptional
cloudflare❌️✅
tencentcloud✅✅
Viewing Logs ​
In the Dashboard logs, you can see the relevant logs for the DDNS functionality. When configured correctly, there will be corresponding log entries when updating DNS records.
shell
dashboard_1  | 2024/03/16 23:16:25 NEZHA>> 正在尝试更新域名(ddns.example.com)DDNS(1/3)
 dashboard_1  | 2024/03/16 23:16:28 NEZHA>> 尝试更新域名(ddns.example.com)DDNS成功
`,20),n=[a];function d(r,l,h,c,p,u){return t(),i("div",null,n)}const m=e(s,[["render",d]]);export{k as __pageData,m as default};
diff --git a/assets/en_US_guide_ddns.md.BMnemOVM.lean.js b/assets/en_US_guide_ddns.md.Dw1k13mk.lean.js
similarity index 85%
rename from assets/en_US_guide_ddns.md.BMnemOVM.lean.js
rename to assets/en_US_guide_ddns.md.Dw1k13mk.lean.js
index 75f30004..cb2c22c1 100644
--- a/assets/en_US_guide_ddns.md.BMnemOVM.lean.js
+++ b/assets/en_US_guide_ddns.md.Dw1k13mk.lean.js
@@ -1 +1 @@
-import{_ as e,c as i,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"DDNS","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/ddns.md","filePath":"en_US/guide/ddns.md","lastUpdated":1733103039000}'),s={name:"en_US/guide/ddns.md"},a=o("",20),n=[a];function d(r,l,h,c,p,u){return t(),i("div",null,n)}const m=e(s,[["render",d]]);export{k as __pageData,m as default};
+import{_ as e,c as i,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"DDNS","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/ddns.md","filePath":"en_US/guide/ddns.md","lastUpdated":1733144698000}'),s={name:"en_US/guide/ddns.md"},a=o("",20),n=[a];function d(r,l,h,c,p,u){return t(),i("div",null,n)}const m=e(s,[["render",d]]);export{k as __pageData,m as default};
diff --git a/assets/en_US_guide_loginq.md.C99vyzYh.js b/assets/en_US_guide_loginq.md.CH4756jr.js
similarity index 99%
rename from assets/en_US_guide_loginq.md.C99vyzYh.js
rename to assets/en_US_guide_loginq.md.CH4756jr.js
index 6dc544eb..17eff8b9 100644
--- a/assets/en_US_guide_loginq.md.C99vyzYh.js
+++ b/assets/en_US_guide_loginq.md.CH4756jr.js
@@ -1 +1 @@
-import{_ as e,c as a,o,a4 as t}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"FAQ about logging into the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1733103039000}'),i={name:"en_US/guide/loginq.md"},r=t('
FAQ 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.
  1. 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.
  2. You have configured the callback address incorrectly. Ensure that your callback address is correct and that both the port and protocol are accurate!
  3. 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 ​
  1. Clear cookies and log in again, or try a different browser.
  2. 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.
Unable to receive email verification codes using Cloudflare Access as an OAuth2 Provider ​
  • Ensure that the email verification policy has been correctly configured in Policies.
  • Verify that the email address you provided is correct. Note that email addresses not on the policy whitelist will not receive verification codes.
',24),n=[r];function s(l,c,h,d,u,g){return o(),a("div",null,n)}const b=e(i,[["render",s]]);export{p as __pageData,b as default};
+import{_ as e,c as a,o,a4 as t}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"FAQ about logging into the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1733144698000}'),i={name:"en_US/guide/loginq.md"},r=t('
FAQ 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.
  1. 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.
  2. You have configured the callback address incorrectly. Ensure that your callback address is correct and that both the port and protocol are accurate!
  3. 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 ​
  1. Clear cookies and log in again, or try a different browser.
  2. 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.
Unable to receive email verification codes using Cloudflare Access as an OAuth2 Provider ​
  • Ensure that the email verification policy has been correctly configured in Policies.
  • Verify that the email address you provided is correct. Note that email addresses not on the policy whitelist will not receive verification codes.
',24),n=[r];function s(l,c,h,d,u,g){return o(),a("div",null,n)}const b=e(i,[["render",s]]);export{p as __pageData,b as default};
diff --git a/assets/en_US_guide_loginq.md.C99vyzYh.lean.js b/assets/en_US_guide_loginq.md.CH4756jr.lean.js
similarity index 86%
rename from assets/en_US_guide_loginq.md.C99vyzYh.lean.js
rename to assets/en_US_guide_loginq.md.CH4756jr.lean.js
index 2ad372e7..92eab7b3 100644
--- a/assets/en_US_guide_loginq.md.C99vyzYh.lean.js
+++ b/assets/en_US_guide_loginq.md.CH4756jr.lean.js
@@ -1 +1 @@
-import{_ as e,c as a,o,a4 as t}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"FAQ about logging into the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1733103039000}'),i={name:"en_US/guide/loginq.md"},r=t("",24),n=[r];function s(l,c,h,d,u,g){return o(),a("div",null,n)}const b=e(i,[["render",s]]);export{p as __pageData,b as default};
+import{_ as e,c as a,o,a4 as t}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"FAQ about logging into the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1733144698000}'),i={name:"en_US/guide/loginq.md"},r=t("",24),n=[r];function s(l,c,h,d,u,g){return o(),a("div",null,n)}const b=e(i,[["render",s]]);export{p as __pageData,b as default};
diff --git a/assets/en_US_guide_nat.md.3ipBwYV4.js b/assets/en_US_guide_nat.md.CM8Rfh1E.js
similarity index 98%
rename from assets/en_US_guide_nat.md.3ipBwYV4.js
rename to assets/en_US_guide_nat.md.CM8Rfh1E.js
index 7a81caa9..595a5766 100644
--- a/assets/en_US_guide_nat.md.3ipBwYV4.js
+++ b/assets/en_US_guide_nat.md.CM8Rfh1E.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,a4 as o}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"NAT Traversal Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/nat.md","filePath":"en_US/guide/nat.md","lastUpdated":1733103039000}'),i={name:"en_US/guide/nat.md"},n=o('
NAT Traversal Configuration ​
Nezha Server Monitoring includes built-in NAT traversal capabilities, allowing users to expose internal services running on an Agent (such as home OpenWrt routers or NAS devices) to the public internet. This functionality facilitates remote access and is currently limited to supporting plain HTTP traversal.
Preparation ​
Prior to configuring NAT traversal, please ensure the following preparatory steps are completed:
  • Verify that the Nezha Monitoring Agent is installed and actively running on your device and maintains a stable connection with the Dashboard.
  • Acquire a public domain name, ideally using a subdomain configuration, such as service-1.example.com. Point this domain name to the public IP address of your Dashboard server.
  • It is important to note that each domain name can only map to the service of one Agent. For mapping services from multiple Agents, distinct domain names should be used, such as service-2.example.com.
WARNING
If your Dashboard server uses tools like the aaPanel or similar management platforms, ensure that your domain (e.g., service-1.example.com) is correctly linked to the Dashboard site within these tools to avoid access issues.
NAT Traversal Configuration Steps ​
  1. Log into the Dashboard Admin Panel and navigate to the "NAT Traversal" section in the menu.
  2. Click the "Add" button and provide the following required details: 
    • Name: Assign a custom name to this traversal setup, for example, OpenWrt Login Page.
    • Agent ID: Input the ID of the Agent for which traversal is needed.
    • Local service: Specify the internal service address that requires traversal, in the IP:port format, such as 127.0.0.1:80.
    • Bind hostname: Enter the previously configured public domain name, such as service-1.example.com. If a non-standard port is used by Dashboard (e.g. default 8008), be sure to include it as well.
  3. After filling in the details, click the "Add" button and wait for the traversal setup to activate.
  4. Test the configuration by accessing http://service-1.example.com to ensure the internal service on the Agent is successfully accessible.
Usage Notes ​
  • Continuous connectivity between the Agent and the Dashboard is crucial for the NAT traversal functionality to operate correctly. If the connection to the Agent is lost, the traversal setup will temporarily cease to function.
  • Given that the NAT traversal does not encrypt traffic by itself, it is recommended to secure data transmissions by employing TLS/SSL between the Agent and the Dashboard, as well as between the Dashboard and the client browser, to ensure data security during transmission.
',10),r=[n];function s(l,c,d,u,h,p){return a(),t("div",null,r)}const f=e(i,[["render",s]]);export{g as __pageData,f as default};
+import{_ as e,c as t,o as a,a4 as o}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"NAT Traversal Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/nat.md","filePath":"en_US/guide/nat.md","lastUpdated":1733144698000}'),i={name:"en_US/guide/nat.md"},n=o('
NAT Traversal Configuration ​
Nezha Server Monitoring includes built-in NAT traversal capabilities, allowing users to expose internal services running on an Agent (such as home OpenWrt routers or NAS devices) to the public internet. This functionality facilitates remote access and is currently limited to supporting plain HTTP traversal.
Preparation ​
Prior to configuring NAT traversal, please ensure the following preparatory steps are completed:
  • Verify that the Nezha Monitoring Agent is installed and actively running on your device and maintains a stable connection with the Dashboard.
  • Acquire a public domain name, ideally using a subdomain configuration, such as service-1.example.com. Point this domain name to the public IP address of your Dashboard server.
  • It is important to note that each domain name can only map to the service of one Agent. For mapping services from multiple Agents, distinct domain names should be used, such as service-2.example.com.
WARNING
If your Dashboard server uses tools like the aaPanel or similar management platforms, ensure that your domain (e.g., service-1.example.com) is correctly linked to the Dashboard site within these tools to avoid access issues.
NAT Traversal Configuration Steps ​
  1. Log into the Dashboard Admin Panel and navigate to the "NAT Traversal" section in the menu.
  2. Click the "Add" button and provide the following required details: 
    • Name: Assign a custom name to this traversal setup, for example, OpenWrt Login Page.
    • Agent ID: Input the ID of the Agent for which traversal is needed.
    • Local service: Specify the internal service address that requires traversal, in the IP:port format, such as 127.0.0.1:80.
    • Bind hostname: Enter the previously configured public domain name, such as service-1.example.com. If a non-standard port is used by Dashboard (e.g. default 8008), be sure to include it as well.
  3. After filling in the details, click the "Add" button and wait for the traversal setup to activate.
  4. Test the configuration by accessing http://service-1.example.com to ensure the internal service on the Agent is successfully accessible.
Usage Notes ​
  • Continuous connectivity between the Agent and the Dashboard is crucial for the NAT traversal functionality to operate correctly. If the connection to the Agent is lost, the traversal setup will temporarily cease to function.
  • Given that the NAT traversal does not encrypt traffic by itself, it is recommended to secure data transmissions by employing TLS/SSL between the Agent and the Dashboard, as well as between the Dashboard and the client browser, to ensure data security during transmission.
',10),r=[n];function s(l,c,d,u,h,p){return a(),t("div",null,r)}const f=e(i,[["render",s]]);export{g as __pageData,f as default};
diff --git a/assets/en_US_guide_nat.md.3ipBwYV4.lean.js b/assets/en_US_guide_nat.md.CM8Rfh1E.lean.js
similarity index 86%
rename from assets/en_US_guide_nat.md.3ipBwYV4.lean.js
rename to assets/en_US_guide_nat.md.CM8Rfh1E.lean.js
index a88fc928..2baaf705 100644
--- a/assets/en_US_guide_nat.md.3ipBwYV4.lean.js
+++ b/assets/en_US_guide_nat.md.CM8Rfh1E.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,a4 as o}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"NAT Traversal Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/nat.md","filePath":"en_US/guide/nat.md","lastUpdated":1733103039000}'),i={name:"en_US/guide/nat.md"},n=o("",10),r=[n];function s(l,c,d,u,h,p){return a(),t("div",null,r)}const f=e(i,[["render",s]]);export{g as __pageData,f as default};
+import{_ as e,c as t,o as a,a4 as o}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"NAT Traversal Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/nat.md","filePath":"en_US/guide/nat.md","lastUpdated":1733144698000}'),i={name:"en_US/guide/nat.md"},n=o("",10),r=[n];function s(l,c,d,u,h,p){return a(),t("div",null,r)}const f=e(i,[["render",s]]);export{g as __pageData,f as default};
diff --git a/assets/en_US_guide_notifications.md.Bhfh6XwZ.js b/assets/en_US_guide_notifications.md.BOxjPE2Z.js
similarity index 99%
rename from assets/en_US_guide_notifications.md.Bhfh6XwZ.js
rename to assets/en_US_guide_notifications.md.BOxjPE2Z.js
index a4641948..5827a281 100644
--- a/assets/en_US_guide_notifications.md.Bhfh6XwZ.js
+++ b/assets/en_US_guide_notifications.md.BOxjPE2Z.js
@@ -1,4 +1,4 @@
-import{_ as i,c as s,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const E=JSON.parse('{"title":"Notification Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1733103039000}'),e={name:"en_US/guide/notifications.md"},n=a(`
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.
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.
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.

+    
     
   
 
\ No newline at end of file
diff --git a/en_US/case/case6.html b/en_US/case/case6.html
index f155654a..60a56066 100644
--- a/en_US/case/case6.html
+++ b/en_US/case/case6.html
@@ -12,7 +12,7 @@
     
     
     
-    
+    
     
     
     
@@ -22,8 +22,8 @@
     
   
   
-    
Nezha Server Monitoring
English
简体中文
English
简体中文
Appearance
Nezha Mobile - An iOS Client For Nezha Dashboard ​
Contributor:
Contribute to the project ​
Project Link
INFO
We appreciate any contribution to the project, and we will actively merge your commits into next Release. However, we may modify your work in order to comply with App Review Guidelines.
Download on the App Store ​
Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917
WARNING
Due to ICP Filing Policy, Nezha Mobile is not available in China mainland.
TestFlight Testing Program ​
Join TestFlight Testing
Instructions ​
  • Enter your Dashboard link like server.hidandelion.com and API token on your first use. Do not add a protocol prefix or a trailing slash to the link. API Token can be retrieved from Admin Center of Dashboard. step1
Configure Widget(Optional) ​
  • Add a widget on your Springboard. Long-tap the widget and then tap Edit Widget. step2
  • Choose a server you want to monitor on the next view. You can choose different servers for each widget. step3

-    
+    
Nezha Server Monitoring
English
简体中文
English
简体中文
Appearance
Nezha Mobile - An iOS Client For Nezha Dashboard ​
Contributor:
Contribute to the project ​
Project Link
INFO
We appreciate any contribution to the project, and we will actively merge your commits into next Release. However, we may modify your work in order to comply with App Review Guidelines.
Download on the App Store ​
Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917
WARNING
Due to ICP Filing Policy, Nezha Mobile is not available in China mainland.
TestFlight Testing Program ​
Join TestFlight Testing
Instructions ​
  • Enter your Dashboard link like server.hidandelion.com and API token on your first use. Do not add a protocol prefix or a trailing slash to the link. API Token can be retrieved from Admin Center of Dashboard. step1
Configure Widget(Optional) ​
  • Add a widget on your Springboard. Long-tap the widget and then tap Edit Widget. step2
  • Choose a server you want to monitor on the next view. You can choose different servers for each widget. step3

+    
     
   
 
\ No newline at end of file
diff --git a/en_US/case/case7.html b/en_US/case/case7.html
index 57459915..df36e579 100644
--- a/en_US/case/case7.html
+++ b/en_US/case/case7.html
@@ -13,7 +13,7 @@
     
     
     
-    
+    
     
     
     
@@ -23,8 +23,8 @@
     
   
   
-    
Nezha Server Monitoring
English
简体中文
English
简体中文
Appearance
Broker for Nezha - Advancing on more platforms ​
Contributor:
Broker for Nezha is a modified version of the Nezha Agent that separates data collection from gRPC reporting, enabling small devices to connect to the Nezha Dashboard.
Project link: https://codeberg.org/uubulb/broker
Online Documentation: Broker for Nezha
Difference from Nezha Agent ​
  • Utilizes external data sources to report to Nezha Dashboard.
  • Supports configuring multiple sources and connecting to multiple Dashboards.
  • Only has limited task support. For details, view the project README.
Broker for Nezha needs to be used with specific data collection software. Currently, it provides two data collection methods:
  1. HTTP (HTTP/1.1) - Active polling
  2. TCP - Passive collection (recommended to avoid creating redundant connections)
For existing data collection software, refer to the project README. Due to security concerns, it's recommended to use this only in a trusted network.
Writing a Data Collector ​
If you need to write your own data collector, you'll need to implement a basic HTTP server or TCP client and use a specific data format that Broker can recognize. For details, see: Data types
Examples ​
Dashboard
 Dashboard 

WebSSH
 WebSSH 

-    
+    
Nezha Server Monitoring
English
简体中文
English
简体中文
Appearance
Broker for Nezha - Advancing on more platforms ​
Contributor:
Broker for Nezha is a modified version of the Nezha Agent that separates data collection from gRPC reporting, enabling small devices to connect to the Nezha Dashboard.
Project link: https://codeberg.org/uubulb/broker
Online Documentation: Broker for Nezha
Difference from Nezha Agent ​
  • Utilizes external data sources to report to Nezha Dashboard.
  • Supports configuring multiple sources and connecting to multiple Dashboards.
  • Only has limited task support. For details, view the project README.
Broker for Nezha needs to be used with specific data collection software. Currently, it provides two data collection methods:
  1. HTTP (HTTP/1.1) - Active polling
  2. TCP - Passive collection (recommended to avoid creating redundant connections)
For existing data collection software, refer to the project README. Due to security concerns, it's recommended to use this only in a trusted network.
Writing a Data Collector ​
If you need to write your own data collector, you'll need to implement a basic HTTP server or TCP client and use a specific data format that Broker can recognize. For details, see: Data types
Examples ​
Dashboard
 Dashboard 

WebSSH
 WebSSH 

+    
     
   
 
\ No newline at end of file
diff --git a/en_US/case/index.html b/en_US/case/index.html
index 194dced2..edbcda49 100644
--- a/en_US/case/index.html
+++ b/en_US/case/index.html
@@ -12,7 +12,7 @@
     
     
     
-    
+    
     
     
     
@@ -23,7 +23,7 @@
   
   
     
Nezha Server Monitoring
English
简体中文
English
简体中文
Appearance
Nezha Monitoring
Community Project
Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.
Learn More →
Submit a project
We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information.
Important Notes
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.

-    
+    
     
   
 
\ No newline at end of file
diff --git a/en_US/developer/index.html b/en_US/developer/index.html
index 155d185a..b0dee663 100644
--- a/en_US/developer/index.html
+++ b/en_US/developer/index.html
@@ -12,7 +12,7 @@
     
     
     
-    
+    
     
     
     
@@ -23,7 +23,7 @@
   
   
     
-    
+    
     
   
 
\ No newline at end of file
diff --git a/en_US/developer/l10n.html b/en_US/developer/l10n.html
index a6cc089a..5ce4412e 100644
--- a/en_US/developer/l10n.html
+++ b/en_US/developer/l10n.html
@@ -12,7 +12,7 @@
     
     
     
-    
+    
     
     
     
@@ -22,8 +22,8 @@
     
   
   
-    
Nezha Server Monitoring
English
简体中文
English
简体中文
Appearance
Localization ​
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 ​
  1. You can directly use the text configuration already available in /resource/l10n/en-US.toml to replace the text in the new feature.
  2. 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 ​
  1. Add a new language text configuration in /resource/l10n/.
  2. Pull existing text configurations from other languages in the new language text configuration.
  3. Add translations for the new language text configuration.

-    
+    
Nezha Server Monitoring
English
简体中文
English
简体中文
Appearance
Localization ​
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 ​
  1. You can directly use the text configuration already available in /resource/l10n/en-US.toml to replace the text in the new feature.
  2. 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 ​
  1. Add a new language text configuration in /resource/l10n/.
  2. Pull existing text configurations from other languages in the new language text configuration.
  3. Add translations for the new language text configuration.

+    
     
   
 
\ No newline at end of file
diff --git a/en_US/developer/theme.html b/en_US/developer/theme.html
index a8cec21b..7b16ff0c 100644
--- a/en_US/developer/theme.html
+++ b/en_US/developer/theme.html
@@ -12,7 +12,7 @@
     
     
     
-    
+    
     
     
     
@@ -22,8 +22,8 @@
     
   
   
-    
Nezha Server Monitoring
English
简体中文
English
简体中文
Appearance
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.19.20 and newer versions.
How to use ​
  1. Clone this repository to local
  2. Modify the Oauth2 configuration in data/config.yaml（The callback connection can be filled with http://localhost）
  3. Run docker-compose up
  4. Start development
  5. After completing the theme creation, you can place theme-custom (frontend theme), static-custom (frontend theme static files), and dashboard-custom (backend theme) into the /opt/nezha/dashboard/ directory on the server (if installed using Docker).
FAQ ​
  • If you can't use port 80, change the configuration in docker-compose.yaml.

-    
+    
Nezha Server Monitoring
English
简体中文
English
简体中文
Appearance
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.19.20 and newer versions.
How to use ​
  1. Clone this repository to local
  2. Modify the Oauth2 configuration in data/config.yaml（The callback connection can be filled with http://localhost）
  3. Run docker-compose up
  4. Start development
  5. After completing the theme creation, you can place theme-custom (frontend theme), static-custom (frontend theme static files), and dashboard-custom (backend theme) into the /opt/nezha/dashboard/ directory on the server (if installed using Docker).
FAQ ​
  • If you can't use port 80, change the configuration in docker-compose.yaml.

+    
     
   
 
\ No newline at end of file
diff --git a/en_US/guide/agent.html b/en_US/guide/agent.html
index 45498c13..eb84a725 100644
--- a/en_US/guide/agent.html
+++ b/en_US/guide/agent.html
@@ -12,7 +12,7 @@
     
     
     
-    
+    
     
     
     
@@ -87,8 +87,8 @@
  stop
  sleep 2
  start
-}
Does the Agent Have a Docker Image? ​
The Agent does not currently have a Docker image.
 The design philosophy of the Agent is opposite to that of the Dashboard. While the Dashboard should minimally impact the server, the Agent needs to execute monitoring services and run commands within the server.
 Running the Agent inside a container can still perform monitoring tasks, but features like WebShell will not function properly, so no Docker image is provided.
- +}

Does the Agent Have a Docker Image? ​

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

+ \ No newline at end of file diff --git a/en_US/guide/agentq.html b/en_US/guide/agentq.html index 18d108c2..081d54d7 100644 --- a/en_US/guide/agentq.html +++ b/en_US/guide/agentq.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
Nezha Server Monitoring

English

简体中文

English

简体中文

Appearance

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:

shell
apt install sudo
- +
Nezha Server Monitoring

English

简体中文

English

简体中文

Appearance

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:

shell
apt install sudo
+ \ No newline at end of file diff --git a/en_US/guide/api.html b/en_US/guide/api.html index 89e17d2d..3db2343b 100644 --- a/en_US/guide/api.html +++ b/en_US/guide/api.html @@ -12,7 +12,7 @@ - + @@ -261,8 +261,8 @@ eval $CMD
  1. Grant execution permission to the script: chmod +x nezha_register.sh
  2. Get Token from Nezha dashboard, e.g. POXbxorKJBM8wPMKX8r2PdMblyXvpggB
  3. Set Environment Variables
bash
export NEZHA_TOKEN="POXbxorKJBM8wPMKX8r2PdMblyXvpggB" # Obtain this token from the dashboard
 export NEZHA_PROBE_ADDRESS="your_probe_address"        # Set your probe address
 export NEZHA_DASHBOARD_URL="https://nezha.example.com" # Replace with your dashboard URL
-export NEZHA_PROBE_PORT="5555"                         # Modify this port if needed
  1. Run the script to complete node registration and probe installation:
bash
./nezha_register.sh
  1. If the script runs successfully, you will see output like the following:
bash
Run command: ./nezha.sh install_agent probe.example.com 5555 YOUR_SECRET --tls
 - +export NEZHA_PROBE_PORT="5555" # Modify this port if needed
  1. Run the script to complete node registration and probe installation:
bash
./nezha_register.sh
  1. If the script runs successfully, you will see output like the following:
bash
Run command: ./nezha.sh install_agent probe.example.com 5555 YOUR_SECRET --tls
 + \ No newline at end of file diff --git a/en_US/guide/dashboard.html b/en_US/guide/dashboard.html index 519c3196..7f3b2cbd 100644 --- a/en_US/guide/dashboard.html +++ b/en_US/guide/dashboard.html @@ -12,7 +12,7 @@ - + @@ -46,8 +46,8 @@ proxy /file/* http://ip:8008 { websocket header_upstream -Origin -}

Configuring SSL in the aaPanel ​

First, temporarily disable the reverse proxy.
Like configuring SSL certificates for other websites, enter the “SSL” in the site settings, and you can choose to automatically apply for a Let’s Encrypt certificate or manually configure an existing certificate.
After completing the SSL settings, go back to Github OAuth Apps and edit the previously created OAuth application. Change all the domain parts in "Homepage URL" and "Authorization callback URL" from http to https, such as "https://dashboard.example.com" and "https://dashboard.example.com/oauth2/callback". Failing to change this may result in being unable to log in to the admin panel.

Updating the Dashboard ​

Run the script ./nezha.sh, and select to restart and update the dashboard.

- +}

Configuring SSL in the aaPanel ​

First, temporarily disable the reverse proxy.
Like configuring SSL certificates for other websites, enter the “SSL” in the site settings, and you can choose to automatically apply for a Let’s Encrypt certificate or manually configure an existing certificate.
After completing the SSL settings, go back to Github OAuth Apps and edit the previously created OAuth application. Change all the domain parts in "Homepage URL" and "Authorization callback URL" from http to https, such as "https://dashboard.example.com" and "https://dashboard.example.com/oauth2/callback". Failing to change this may result in being unable to log in to the admin panel.

Updating the Dashboard ​

Run the script ./nezha.sh, and select to restart and update the dashboard.

+ \ No newline at end of file diff --git a/en_US/guide/dashboardq.html b/en_US/guide/dashboardq.html index 4e54a55b..1f42a602 100644 --- a/en_US/guide/dashboardq.html +++ b/en_US/guide/dashboardq.html @@ -12,7 +12,7 @@ - + @@ -31,8 +31,8 @@ expires 12h; error_log /dev/null; access_log /dev/null; - }

  • Save the configuration, clear the browser, Nginx, and CDN caches, and refresh the page to see if it returns to normal.

    • Dashboard Cannot Start: panic: Unable to find the configured DDNS provider... ​

    The value entered for the DDNS provider is incorrect. Currently, only webhook, cloudflare, tencentcloud, and dummy are supported.

    Dashboard DDNS Update Crash: panic: interface conversion: interface {} is nil, not []interface {} ​

    The entered DDNS AccessID or AccessSecret is incorrect.

    Dashboard warning: NEZHA>> 错误的服务监控上报... ​

    1. The installed versions of the Dashboard and Agent are not compatible and have a TaskType that is unsupported by its counterpart. Updating both to the latest version could solve this problem.

    2. This could be a specific issue in Dashboard v0.17.10 - v0.18.0. Updating to the latest version could solve this.

    Unable to start the Agent service: Unix syslog delivery error ​

    Appears in Agent v0.16.9+. Mostly caused by a malfunctioning /dev/log socket (or it does not exist at all). You can refer to https://unix.stackexchange.com/questions/317064/how-do-i-restore-dev-log-in-systemdrsyslog-host to solve this problem. Try avoiding using init systems like systemd in a Docker installation.

    Network Monitoring Page Shows: server monitor history not found ​

    This error indicates that no TCP-Ping or ICMP-Ping type monitoring has been set in the services page or monitoring data has not yet been generated.
    If it has been set up, wait for some time and then check again.

    What to do if /terminal or /ws can't connect properly after enabling HTTPS? ​

    This is often due to an incomplete certificate. Add the -d parameter to the agent run command. If the log contains x509:certificate signed by unknown authority, replacing with a complete certificate will solve the problem.

    What if I'm not satisfied with the data modification/addition functionality provided by the dashboard and want to modify/add data myself? ​

    Common in scenarios like batch adding Agents, you can directly modify the database.
    Note that not everything in the database can be modified; incorrect modifications can lead to data corruption and inability to start the Dashboard. Do not modify the database casually!

    DANGER

    Again, do not modify the database casually!

    If you need to modify data in the database, stop the dashboard container first.
    The database type is sqlite3, located at /opt/nezha/dashboard/data/sqlite.db. Backup before modifying.

    Will the Dashboard automatically update? ​

    Agents typically update automatically, but the Dashboard does not and requires manual updates.

    Agent Command Issuance Failed When Connecting to Web Terminal ​

    When the Agent is offline, or the connection between the Agent and the Dashboard is unstable, it may cause issues with connecting to the Web Terminal. Please check if the Agent is running normally and maintaining a stable connection with the Dashboard.

    FM freezes during downloading/uploading ​

    Ensure your proxy's buffer is larger than 1 MiB, as FM sends data chunks of this size.

    Using a CDN may cause severe performance degradation. Try connecting directly instead.

    - + }

  • Save the configuration, clear the browser, Nginx, and CDN caches, and refresh the page to see if it returns to normal.

    • Dashboard Cannot Start: panic: Unable to find the configured DDNS provider... ​

    The value entered for the DDNS provider is incorrect. Currently, only webhook, cloudflare, tencentcloud, and dummy are supported.

    Dashboard DDNS Update Crash: panic: interface conversion: interface {} is nil, not []interface {} ​

    The entered DDNS AccessID or AccessSecret is incorrect.

    Dashboard warning: NEZHA>> 错误的服务监控上报... ​

    1. The installed versions of the Dashboard and Agent are not compatible and have a TaskType that is unsupported by its counterpart. Updating both to the latest version could solve this problem.

    2. This could be a specific issue in Dashboard v0.17.10 - v0.18.0. Updating to the latest version could solve this.

    Unable to start the Agent service: Unix syslog delivery error ​

    Appears in Agent v0.16.9+. Mostly caused by a malfunctioning /dev/log socket (or it does not exist at all). You can refer to https://unix.stackexchange.com/questions/317064/how-do-i-restore-dev-log-in-systemdrsyslog-host to solve this problem. Try avoiding using init systems like systemd in a Docker installation.

    Network Monitoring Page Shows: server monitor history not found ​

    This error indicates that no TCP-Ping or ICMP-Ping type monitoring has been set in the services page or monitoring data has not yet been generated.
    If it has been set up, wait for some time and then check again.

    What to do if /terminal or /ws can't connect properly after enabling HTTPS? ​

    This is often due to an incomplete certificate. Add the -d parameter to the agent run command. If the log contains x509:certificate signed by unknown authority, replacing with a complete certificate will solve the problem.

    What if I'm not satisfied with the data modification/addition functionality provided by the dashboard and want to modify/add data myself? ​

    Common in scenarios like batch adding Agents, you can directly modify the database.
    Note that not everything in the database can be modified; incorrect modifications can lead to data corruption and inability to start the Dashboard. Do not modify the database casually!

    DANGER

    Again, do not modify the database casually!

    If you need to modify data in the database, stop the dashboard container first.
    The database type is sqlite3, located at /opt/nezha/dashboard/data/sqlite.db. Backup before modifying.

    Will the Dashboard automatically update? ​

    Agents typically update automatically, but the Dashboard does not and requires manual updates.

    Agent Command Issuance Failed When Connecting to Web Terminal ​

    When the Agent is offline, or the connection between the Agent and the Dashboard is unstable, it may cause issues with connecting to the Web Terminal. Please check if the Agent is running normally and maintaining a stable connection with the Dashboard.

    FM freezes during downloading/uploading ​

    Ensure your proxy's buffer is larger than 1 MiB, as FM sends data chunks of this size.

    Using a CDN may cause severe performance degradation. Try connecting directly instead.

    + \ No newline at end of file diff --git a/en_US/guide/ddns.html b/en_US/guide/ddns.html index 97e64c30..447e392c 100644 --- a/en_US/guide/ddns.html +++ b/en_US/guide/ddns.html @@ -12,7 +12,7 @@ - + @@ -23,8 +23,8 @@
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    DDNS ​

    The DDNS functionality is designed for servers with dynamic IP addresses. When the Agent server reports a new IP (every 10 minutes), Dashboard will automatically update the DNS record based on the configuration.

    Why should I use Nezha's DDNS functionality? ​

    • Convenient centralized management of DDNS settings, instead of deploying a DDNS service on every server.
    • Your confidential information is only stored on the Dashboard server, preventing leaks.

    Configuration ​

    You can directly add DDNS configurations in the Dashboard management page.

    1. Click on the "Dynamic DNS" option in the menu bar to enter the configuration page.
    2. Click the "New Profile" button and fill in the required information in the pop-up window. Option details:
      • Name: The name of the configuration.
      • DDNS Provider: The type of provider, determining the method used to update DNS records.
      • Domains (separate with comma): The domain(s), if you enter multiple domains, they should be separated by commas. IDNs (Internationalized Domain Names) are supported.
      • Maximum retry attempts: The number of attempts for updating DDNS, default is 3, and the range is between 1 and 10.
      • DDNS Credential 1 and DDNS Credential 2 are optional. Typically, at least one needs to be provided. The table below lists the options for all providers.
    3. If using the webhook provider, the corresponding options need to be filled out as required. For detailed instructions, see Webhook Configuration.
    4. You need to check at least one of IPv4 Enabled and IPv6 Enabled; otherwise, no update operations will be performed.
    5. After adding a new configuration, you also need to modify the server settings to activate DDNS. Server-related options include:
      • Enable DDNS: Enable DDNS functionality for this server.
      • DDNS Profiles: The list of DDNS configuration IDs to use, searchable by configuration name.

    Webhook Configuration ​

    Webhook requires manually constructing HTTP requests, suitable for using other provider services when operations are simple.

    Webhook option descriptions:

    • Webhook URL: The URL for the HTTP request, where parameters can use placeholders.
    • Webhook Request Method: The HTTP request method. Supported methods include GET, POST, PATCH, DELETE, and PUT.
    • Webhook Request Type: The format of the HTTP request body, either JSON or Form.
    • Webhook Request Headers: HTTP request headers, filled in JSON format, but nesting is not supported.
    • Webhook Request Body: The HTTP request body. It won't be used for GET and DELETE. If you need to use a nested format, you must choose JSON as the request type.

    Supported Webhook placeholders:

    • #ip#: Host IP.
    • #domain#: DDNS domain. Each request is made separately for each domain, so this value will be a single domain string.
    • #type#: IP type, either "ipv4" or "ipv6".
    • #record#: Record type, either "A" or "AAAA".
    • #access_id#: DDNS Credential 1.
    • #access_secret#: DDNS Credential 2.

    Oray Webhook Example ​

    Click to expand/collapse
    • URL：http://ddns.oray.com/ph/update?hostname=#domain#&myip=#ip#
    • Request Method: GET
    • Request Header：{"Authorization": "Basic pass"}, replace pass with the Base64-encoded userpass (e.g., user:pass becomes dXNlcjpwYXNzCg==).
    • Oray only supports A records, so only enable IPv4. Other Webhook options are not required.

    Provider List ​

    ProviderCredential 1 (ID)Credential 2 (Secret)
    dummy❌️❌️
    webhookOptionalOptional
    cloudflare❌️✅
    tencentcloud✅✅

    Viewing Logs ​

    In the Dashboard logs, you can see the relevant logs for the DDNS functionality. When configured correctly, there will be corresponding log entries when updating DNS records.

    shell
    dashboard_1  | 2024/03/16 23:16:25 NEZHA>> 正在尝试更新域名(ddns.example.com)DDNS(1/3)
-dashboard_1  | 2024/03/16 23:16:28 NEZHA>> 尝试更新域名(ddns.example.com)DDNS成功
    - +dashboard_1 | 2024/03/16 23:16:28 NEZHA>> 尝试更新域名(ddns.example.com)DDNS成功 + \ No newline at end of file diff --git a/en_US/guide/loginq.html b/en_US/guide/loginq.html index 42e37822..8d1c4174 100644 --- a/en_US/guide/loginq.html +++ b/en_US/guide/loginq.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    FAQ 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.

    1. 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.
    2. You have configured the callback address incorrectly. Ensure that your callback address is correct and that both the port and protocol are accurate!
    3. 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 ​

    1. Clear cookies and log in again, or try a different browser.
    2. 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.

    Unable to receive email verification codes using Cloudflare Access as an OAuth2 Provider ​

    • Ensure that the email verification policy has been correctly configured in Policies.
    • Verify that the email address you provided is correct. Note that email addresses not on the policy whitelist will not receive verification codes.
    - +
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    FAQ 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.

    1. 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.
    2. You have configured the callback address incorrectly. Ensure that your callback address is correct and that both the port and protocol are accurate!
    3. 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 ​

    1. Clear cookies and log in again, or try a different browser.
    2. 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.

    Unable to receive email verification codes using Cloudflare Access as an OAuth2 Provider ​

    • Ensure that the email verification policy has been correctly configured in Policies.
    • Verify that the email address you provided is correct. Note that email addresses not on the policy whitelist will not receive verification codes.
    + \ No newline at end of file diff --git a/en_US/guide/nat.html b/en_US/guide/nat.html index e4cabcfb..9b87ecf3 100644 --- a/en_US/guide/nat.html +++ b/en_US/guide/nat.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    NAT Traversal Configuration ​

    Nezha Server Monitoring includes built-in NAT traversal capabilities, allowing users to expose internal services running on an Agent (such as home OpenWrt routers or NAS devices) to the public internet. This functionality facilitates remote access and is currently limited to supporting plain HTTP traversal.

    Preparation ​

    Prior to configuring NAT traversal, please ensure the following preparatory steps are completed:

    • Verify that the Nezha Monitoring Agent is installed and actively running on your device and maintains a stable connection with the Dashboard.
    • Acquire a public domain name, ideally using a subdomain configuration, such as service-1.example.com. Point this domain name to the public IP address of your Dashboard server.
    • It is important to note that each domain name can only map to the service of one Agent. For mapping services from multiple Agents, distinct domain names should be used, such as service-2.example.com.

    WARNING

    If your Dashboard server uses tools like the aaPanel or similar management platforms, ensure that your domain (e.g., service-1.example.com) is correctly linked to the Dashboard site within these tools to avoid access issues.

    NAT Traversal Configuration Steps ​

    1. Log into the Dashboard Admin Panel and navigate to the "NAT Traversal" section in the menu.
    2. Click the "Add" button and provide the following required details:
      • Name: Assign a custom name to this traversal setup, for example, OpenWrt Login Page.
      • Agent ID: Input the ID of the Agent for which traversal is needed.
      • Local service: Specify the internal service address that requires traversal, in the IP:port format, such as 127.0.0.1:80.
      • Bind hostname: Enter the previously configured public domain name, such as service-1.example.com. If a non-standard port is used by Dashboard (e.g. default 8008), be sure to include it as well.
    3. After filling in the details, click the "Add" button and wait for the traversal setup to activate.
    4. Test the configuration by accessing http://service-1.example.com to ensure the internal service on the Agent is successfully accessible.

    Usage Notes ​

    • Continuous connectivity between the Agent and the Dashboard is crucial for the NAT traversal functionality to operate correctly. If the connection to the Agent is lost, the traversal setup will temporarily cease to function.
    • Given that the NAT traversal does not encrypt traffic by itself, it is recommended to secure data transmissions by employing TLS/SSL between the Agent and the Dashboard, as well as between the Dashboard and the client browser, to ensure data security during transmission.
    - +
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    NAT Traversal Configuration ​

    Nezha Server Monitoring includes built-in NAT traversal capabilities, allowing users to expose internal services running on an Agent (such as home OpenWrt routers or NAS devices) to the public internet. This functionality facilitates remote access and is currently limited to supporting plain HTTP traversal.

    Preparation ​

    Prior to configuring NAT traversal, please ensure the following preparatory steps are completed:

    • Verify that the Nezha Monitoring Agent is installed and actively running on your device and maintains a stable connection with the Dashboard.
    • Acquire a public domain name, ideally using a subdomain configuration, such as service-1.example.com. Point this domain name to the public IP address of your Dashboard server.
    • It is important to note that each domain name can only map to the service of one Agent. For mapping services from multiple Agents, distinct domain names should be used, such as service-2.example.com.

    WARNING

    If your Dashboard server uses tools like the aaPanel or similar management platforms, ensure that your domain (e.g., service-1.example.com) is correctly linked to the Dashboard site within these tools to avoid access issues.

    NAT Traversal Configuration Steps ​

    1. Log into the Dashboard Admin Panel and navigate to the "NAT Traversal" section in the menu.
    2. Click the "Add" button and provide the following required details:
      • Name: Assign a custom name to this traversal setup, for example, OpenWrt Login Page.
      • Agent ID: Input the ID of the Agent for which traversal is needed.
      • Local service: Specify the internal service address that requires traversal, in the IP:port format, such as 127.0.0.1:80.
      • Bind hostname: Enter the previously configured public domain name, such as service-1.example.com. If a non-standard port is used by Dashboard (e.g. default 8008), be sure to include it as well.
    3. After filling in the details, click the "Add" button and wait for the traversal setup to activate.
    4. Test the configuration by accessing http://service-1.example.com to ensure the internal service on the Agent is successfully accessible.

    Usage Notes ​

    • Continuous connectivity between the Agent and the Dashboard is crucial for the NAT traversal functionality to operate correctly. If the connection to the Agent is lost, the traversal setup will temporarily cease to function.
    • Given that the NAT traversal does not encrypt traffic by itself, it is recommended to secure data transmissions by employing TLS/SSL between the Agent and the Dashboard, as well as between the Dashboard and the client browser, to ensure data security during transmission.
    + \ No newline at end of file diff --git a/en_US/guide/notifications.html b/en_US/guide/notifications.html index cf94b4c3..3cfd92e6 100644 --- a/en_US/guide/notifications.html +++ b/en_US/guide/notifications.html @@ -12,7 +12,7 @@ - + @@ -68,8 +68,8 @@ "format": "org.matrix.custom.html", "formatted_body": "<html><head><title>Nezha Dashboard</title></head><body><h1><a href=\"$YOUR_NEZHA_URL\" target=\"_blank\">Nezha Dashboard</a></h1><ul><li>datetime: #DATETIME#</li><li>Message: #NEZHA#</li></ul></body></html>", "body": "#NEZHA#" -}

    Usage Steps ​

    1. Replace Variables: Replace $YOUR_HOME_SERVER, $YOUR_NEZHA_URL, $YOUR_MATRIX_USERNAME, $YOUR_MATRIX_PASSWD, and $YOUR_MATRIX_TOKEN with your own values.
    2. Retrieve Token: Use the curl command provided above to get YOUR_MATRIX_TOKEN, making sure to replace all relevant variables.
    3. Configure Request: Set up your request using the configuration provided above, ensuring the correct URL, headers, and body are used.
    4. Send Notification: Send the Matrix message using the configured request to integrate Nezha monitoring notifications into your Matrix room.

    Once configured, you will receive formatted Nezha dashboard information in your Matrix room whenever a notification is triggered.

    Notification Rule Explanation ​

    Basic Rules ​

    Complete Examples:

    Add an offline notification:

    Add an notification for CPU usage exceeding 50% for 10 seconds and memory usage below 20% for 20 seconds:

    Send notifications for specific servers to specific notification groups:

    Scenario example:
    There are 4 servers (1, 2, 3, 4) and two notification groups (A, B).
    Notify group A if servers 1 and 2 are offline for 10 minutes.
    Notify group B if servers 3 and 4 are offline for 10 minutes.

    First, set up notification groups A and B, then add two notification rules:

    Rule 1:

    Rule 2:

    Flexibly using parameters can make your notification function fully utilized

    Special: Any Cycle Traffic notification ​

    Can be used for monthly traffic monitoring

    Example:

    For servers with IDs 3 and 4 (defined in ignore), if the monthly outbound traffic exceeds 1TB starting from the 1st of each month, send an notification:

    json
    [{"type":"transfer_out_cycle","max":1099511627776,"cycle_start":"2022-01-01T00:00:00+08:00","cycle_interval":1,"cycle_unit":"month","cover":1,"ignore":{"3":true,"4":true}}]

    TIP

    If you still have trouble editing rules, you can try the rule generators below to simplify the process. Note that Nezha Monitoring does not guarantee the functionality of these generated rules.

    Notification Trigger Modes ​

    Set Tasks to Execute on notifications ​

    If you need to execute a task while sending an notification message, you can set this item.

    - +}

    Usage Steps ​

    1. Replace Variables: Replace $YOUR_HOME_SERVER, $YOUR_NEZHA_URL, $YOUR_MATRIX_USERNAME, $YOUR_MATRIX_PASSWD, and $YOUR_MATRIX_TOKEN with your own values.
    2. Retrieve Token: Use the curl command provided above to get YOUR_MATRIX_TOKEN, making sure to replace all relevant variables.
    3. Configure Request: Set up your request using the configuration provided above, ensuring the correct URL, headers, and body are used.
    4. Send Notification: Send the Matrix message using the configured request to integrate Nezha monitoring notifications into your Matrix room.

    Once configured, you will receive formatted Nezha dashboard information in your Matrix room whenever a notification is triggered.

    Notification Rule Explanation ​

    Basic Rules ​

    Complete Examples:

    Add an offline notification:

    Add an notification for CPU usage exceeding 50% for 10 seconds and memory usage below 20% for 20 seconds:

    Send notifications for specific servers to specific notification groups:

    Scenario example:
    There are 4 servers (1, 2, 3, 4) and two notification groups (A, B).
    Notify group A if servers 1 and 2 are offline for 10 minutes.
    Notify group B if servers 3 and 4 are offline for 10 minutes.

    First, set up notification groups A and B, then add two notification rules:

    Rule 1:

    Rule 2:

    Flexibly using parameters can make your notification function fully utilized

    Special: Any Cycle Traffic notification ​

    Can be used for monthly traffic monitoring

    Example:

    For servers with IDs 3 and 4 (defined in ignore), if the monthly outbound traffic exceeds 1TB starting from the 1st of each month, send an notification:

    json
    [{"type":"transfer_out_cycle","max":1099511627776,"cycle_start":"2022-01-01T00:00:00+08:00","cycle_interval":1,"cycle_unit":"month","cover":1,"ignore":{"3":true,"4":true}}]

    TIP

    If you still have trouble editing rules, you can try the rule generators below to simplify the process. Note that Nezha Monitoring does not guarantee the functionality of these generated rules.

    Notification Trigger Modes ​

    Set Tasks to Execute on notifications ​

    If you need to execute a task while sending an notification message, you can set this item.

    + \ No newline at end of file diff --git a/en_US/guide/q10.html b/en_US/guide/q10.html index a7fb1494..104b4f1a 100644 --- a/en_US/guide/q10.html +++ b/en_US/guide/q10.html @@ -12,7 +12,7 @@ - + @@ -36,8 +36,8 @@ oidcLoginClaim: sub # (Optional, default: sub) The username field returned by OIDC, can be preferred_username, sub, or email oidcGroupsClaim: groups # (Required if using adminGroups, default: groups) The user group information field returned by OIDC, can be groups or roles oidcAutoCreate: false # (Optional, default: false) Whether to automatically create a user if they do not exist - oidcAutoLogin: false # (Optional, default: false) Whether to automatically redirect to the OIDC login page when the path is /login - + oidcAutoLogin: false # (Optional, default: false) Whether to automatically redirect to the OIDC login page when the path is /login + \ No newline at end of file diff --git a/en_US/guide/q11.html b/en_US/guide/q11.html index f9e07fa1..dcd7eb55 100644 --- a/en_US/guide/q11.html +++ b/en_US/guide/q11.html @@ -12,7 +12,7 @@ - + @@ -49,8 +49,8 @@ ], "Lookup": "114.5.1.4" } -]

    Once the format and information are confirmed to be correct, the database can be used for compiling the Dashboard. Afterwards, you can test if the query API is working correctly using grpcurl or similar tools:

    shell
    grpcurl -proto ./nezha/proto/nezha.proto -plaintext -H 'client_secret: test' -d '{"ip": "114.5.1.4"}' 127.0.0.1:5555 proto.NezhaService/LookupGeoIP
     - +]

    Once the format and information are confirmed to be correct, the database can be used for compiling the Dashboard. Afterwards, you can test if the query API is working correctly using grpcurl or similar tools:

    shell
    grpcurl -proto ./nezha/proto/nezha.proto -plaintext -H 'client_secret: test' -d '{"ip": "114.5.1.4"}' 127.0.0.1:5555 proto.NezhaService/LookupGeoIP
     + \ No newline at end of file diff --git a/en_US/guide/q2.html b/en_US/guide/q2.html index 34d08966..c10b7afd 100644 --- a/en_US/guide/q2.html +++ b/en_US/guide/q2.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    Agent Startup/Online Troubleshooting Process ​

    1. 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.
    2. 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/.
    3. If the above steps indicate no issues but the Agent still does not go online correctly, try disabling SELinux. How to disable SELinux?
    - +
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    Agent Startup/Online Troubleshooting Process ​

    1. 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.
    2. 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/.
    3. If the above steps indicate no issues but the Agent still does not go online correctly, try disabling SELinux. How to disable SELinux?
    + \ No newline at end of file diff --git a/en_US/guide/q3.html b/en_US/guide/q3.html index 5c5e1396..4bd3ee20 100644 --- a/en_US/guide/q3.html +++ b/en_US/guide/q3.html @@ -12,7 +12,7 @@ - + @@ -95,8 +95,8 @@ localhost:~/agent# /opt/nezha/agent/nezha-agent -s nezha.xxx.xxx:443 -p YOUR_KEY --tls -d NEZHA@2023-12-20 05:14:00>> 检查更新： 0.15.14 NEZHA@2023-12-20 05:14:01>> 上报系统信息失败： rpc error: code = Unknown desc = EOF # You need to modify the GRPCHost and TLS options in the Dashboard /opt/nezha/dashboard/data/config.yaml -NEZHA@2023-12-20 05:14:01>> Error to close connection ... - +NEZHA@2023-12-20 05:14:01>> Error to close connection ... + \ No newline at end of file diff --git a/en_US/guide/q4.html b/en_US/guide/q4.html index a6c1ff32..03b4fb88 100644 --- a/en_US/guide/q4.html +++ b/en_US/guide/q4.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    Real-Time Channel Disconnection ​

    • If you are using a CDN, ensure that the CDN provider offers WebSocket services and that WebSocket is enabled.
    • Confirm that your reverse proxy rules have special configurations for the /ws and /terminal paths. You can click here to view the reverse proxy configuration.
    - +
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    Real-Time Channel Disconnection ​

    • If you are using a CDN, ensure that the CDN provider offers WebSocket services and that WebSocket is enabled.
    • Confirm that your reverse proxy rules have special configurations for the /ws and /terminal paths. You can click here to view the reverse proxy configuration.
    + \ No newline at end of file diff --git a/en_US/guide/q5.html b/en_US/guide/q5.html index d4563593..f95f0f9e 100644 --- a/en_US/guide/q5.html +++ b/en_US/guide/q5.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    How to Perform Data Migration and Backup Recovery? ​

    1. Run the one-click script and choose Stop Dashboard.
    2. On the old server, package the /opt/nezha folder, copy it to the same location in the new environment, and extract it.
    3. In the new server, run the one-click script and choose Start Dashboard.
    - +
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    How to Perform Data Migration and Backup Recovery? ​

    1. Run the one-click script and choose Stop Dashboard.
    2. On the old server, package the /opt/nezha folder, copy it to the same location in the new environment, and extract it.
    3. In the new server, run the one-click script and choose Start Dashboard.
    + \ No newline at end of file diff --git a/en_US/guide/q6.html b/en_US/guide/q6.html index ef9da092..160e3fae 100644 --- a/en_US/guide/q6.html +++ b/en_US/guide/q6.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    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:

    1. Go to the Notification page in the management panel.
    2. Refer to this document to create a monthly traffic notification.
    3. 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!

    - +
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    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:

    1. Go to the Notification page in the management panel.
    2. Refer to this document to create a monthly traffic notification.
    3. 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!

    + \ No newline at end of file diff --git a/en_US/guide/q7.html b/en_US/guide/q7.html index c0be5e3f..9db3a071 100644 --- a/en_US/guide/q7.html +++ b/en_US/guide/q7.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    Customizing Agent Monitoring Items ​

    Customize Monitoring for Network Interfaces and Disk Partitions ​

    Execute the following command to select network interfaces and partitions, then restart the Agent for changes to take effect:

    bash
    /opt/nezha/agent/nezha-agent edit

    Additional Runtime Parameters ​

    Viewing Supported Parameters ​

    To view the supported runtime parameters, please execute the following command:

    bash
    ./nezha-agent --help

    Configuring Parameters ​

    If you installed the Agent using a one-click script, you can add or modify parameters by editing the system service configuration. Edit the file /etc/systemd/system/nezha-agent.service and append your desired parameters at the end of the ExecStart= line:

    • --report-delay: Sets the interval for reporting system information. The default is 1 second. To reduce system resource usage, you can set this to 3 (valid range: 1-4 seconds).
    • --skip-conn: Disables monitoring of network connections. Recommended for servers with high numbers of connections or high CPU usage.
    • --skip-procs: Disables monitoring of process counts, helping to reduce resource usage of the Agent.
    • --disable-auto-update: Disables the automatic update feature of the Agent, enhancing security.
    • --disable-force-update: Disables the forced update feature of the Agent, enhancing security.
    • --disable-command-execute: Prevents execution of any scheduled tasks or use of the WebSSH on the Agent, enhancing security.
    • --tls: Enables SSL/TLS encryption. This should be enabled when you are using nginx to reverse proxy the Agent's gRPC connections and nginx is configured with SSL/TLS.
    • --use-ipv6-countrycode: Forces the use of IPv6 addresses to query country codes. By default, the Agent uses IPv4 addresses to query country codes. If server supports IPv6 and the country code of the IPv4 address is different, can use this parameter.
    • --gpu: Enables GPU monitoring. Note: Monitoring GPU usage may require installation of additional dependencies. For more details, refer to the documentation: Enable GPU Monitoring.
    • --temperature: Enables hardware temperature monitoring. Only effective on supported hardware, some VPS may not be able to retrieve temperature information.
    • -d --debug: Enables debug mode.
    • -u --ip-report-period: Set IP update interval. Is only effective when the set value is higher than --report-delay. The default is 1800 seconds.
    • -k --insecure: Disable TLS certificate integrity check. Useful in situations involving a self-signed certificate.
    - +
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    Customizing Agent Monitoring Items ​

    Customize Monitoring for Network Interfaces and Disk Partitions ​

    Execute the following command to select network interfaces and partitions, then restart the Agent for changes to take effect:

    bash
    /opt/nezha/agent/nezha-agent edit

    Additional Runtime Parameters ​

    Viewing Supported Parameters ​

    To view the supported runtime parameters, please execute the following command:

    bash
    ./nezha-agent --help

    Configuring Parameters ​

    If you installed the Agent using a one-click script, you can add or modify parameters by editing the system service configuration. Edit the file /etc/systemd/system/nezha-agent.service and append your desired parameters at the end of the ExecStart= line:

    • --report-delay: Sets the interval for reporting system information. The default is 1 second. To reduce system resource usage, you can set this to 3 (valid range: 1-4 seconds).
    • --skip-conn: Disables monitoring of network connections. Recommended for servers with high numbers of connections or high CPU usage.
    • --skip-procs: Disables monitoring of process counts, helping to reduce resource usage of the Agent.
    • --disable-auto-update: Disables the automatic update feature of the Agent, enhancing security.
    • --disable-force-update: Disables the forced update feature of the Agent, enhancing security.
    • --disable-command-execute: Prevents execution of any scheduled tasks or use of the WebSSH on the Agent, enhancing security.
    • --tls: Enables SSL/TLS encryption. This should be enabled when you are using nginx to reverse proxy the Agent's gRPC connections and nginx is configured with SSL/TLS.
    • --use-ipv6-countrycode: Forces the use of IPv6 addresses to query country codes. By default, the Agent uses IPv4 addresses to query country codes. If server supports IPv6 and the country code of the IPv4 address is different, can use this parameter.
    • --gpu: Enables GPU monitoring. Note: Monitoring GPU usage may require installation of additional dependencies. For more details, refer to the documentation: Enable GPU Monitoring.
    • --temperature: Enables hardware temperature monitoring. Only effective on supported hardware, some VPS may not be able to retrieve temperature information.
    • -d --debug: Enables debug mode.
    • -u --ip-report-period: Set IP update interval. Is only effective when the set value is higher than --report-delay. The default is 1800 seconds.
    • -k --insecure: Disable TLS certificate integrity check. Useful in situations involving a self-signed certificate.
    + \ No newline at end of file diff --git a/en_US/guide/q8.html b/en_US/guide/q8.html index 50a2b3cd..7f6bafee 100644 --- a/en_US/guide/q8.html +++ b/en_US/guide/q8.html @@ -12,7 +12,7 @@ - + @@ -27,8 +27,8 @@ ClientID: 3516291f53eca9b4901a01337e41be7dc52f565c8657d08a3fddb2178d13c5bf ClientSecret: 0568b67c7b6d0ed51c663e2fe935683007c28f947a27b7bd47a5ad3d8b56fb67 Endpoint: "https://xxxxx.cloudflareaccess.com" - Type: cloudflare

    Configuration Description: ​

    ParameterRetrieval Method
    AdminMy Team -> Users -> <specific user> -> User ID
    ClientID/ClientSecretAccess -> Application -> Add an Application
    -> SaaS -> OIDC
    EndpointAccess -> Application -> Application URL -> Only keep the protocol and domain, no path

    Setting Up a New SaaS-OIDC Application ​

    Navigate to the Zero Trust Dashboard: https://one.dash.cloudflare.com/. Choose or create a new account, then follow these steps:

    1. Go to My Team -> Users -> Click <specific user> -> Obtain and save the User ID. (If this is your first time using Zero Trust, the Users list will be empty, and you can skip this step; users will appear after completing a verification.)
    2. Navigate to Access -> Applications -> Add an Application.
    3. Select SaaS. In the Application field, enter a custom application name (e.g., nezha), select OIDC, and then click Add application.
    4. For Scopes, select openid, email, profile, groups.
    5. In Redirect URLs, enter your Dashboard Callback URL, such as https://dashboard.example.com/oauth2/callback.
    6. Record the Client ID, Client Secret, and the protocol and domain part of the Issuer address, for example, https://xxxxx.cloudflareaccess.com.
    7. Edit the Dashboard configuration file (usually located at /opt/nezha/dashboard/data/config.yaml), adjust the OAuth2 settings according to the example configuration, and restart the Dashboard service.

    Identity Verification Strategy Configuration ​

    After setting up the Dashboard, you need to configure identity verification policies in the Zero Trust Dashboard. Navigate to: Access -> Applications -> <application name> -> Policies. You can choose from various SSO authentication methods, including email OTP and hardware key verification. For detailed configurations, refer to the Cloudflare Zero Trust Documentation.

    Policy Configuration Example (One-time PIN) ​

    Using email OTP as the default verification method:

    1. Navigate to Access -> Applications -> <application name> -> Policies -> Add a policy.
    2. Set a Policy Name, for example, OTP, and set Action to Allow.
    3. Under Configure rules, add a new Include rule. Select Emails as the Selector and enter your email address in the textbox.
    4. Click Save policy to save the configuration.

    Testing the Policy ​

    1. If the configuration is correct, when you visit the Dashboard login interface, it will display as "Log in with Cloudflare Account." Clicking on login will redirect you to the Cloudflare Access login page.
    2. Enter the email address configured previously, click Send me a code, and then enter the code received to log in to the Dashboard.
    3. If User ID was not specified in Admin during previous steps, an error message will be displayed after login: "This user is not an administrator of this site and cannot log in." At this point, you need to go to My Team -> Users, find the corresponding user, click on the username to get the User ID, and enter it into the Admin section of the Dashboard configuration file. After restarting the Dashboard service, try logging in again.
    - + Type: cloudflare

    Configuration Description: ​

    ParameterRetrieval Method
    AdminMy Team -> Users -> <specific user> -> User ID
    ClientID/ClientSecretAccess -> Application -> Add an Application
    -> SaaS -> OIDC
    EndpointAccess -> Application -> Application URL -> Only keep the protocol and domain, no path

    Setting Up a New SaaS-OIDC Application ​

    Navigate to the Zero Trust Dashboard: https://one.dash.cloudflare.com/. Choose or create a new account, then follow these steps:

    1. Go to My Team -> Users -> Click <specific user> -> Obtain and save the User ID. (If this is your first time using Zero Trust, the Users list will be empty, and you can skip this step; users will appear after completing a verification.)
    2. Navigate to Access -> Applications -> Add an Application.
    3. Select SaaS. In the Application field, enter a custom application name (e.g., nezha), select OIDC, and then click Add application.
    4. For Scopes, select openid, email, profile, groups.
    5. In Redirect URLs, enter your Dashboard Callback URL, such as https://dashboard.example.com/oauth2/callback.
    6. Record the Client ID, Client Secret, and the protocol and domain part of the Issuer address, for example, https://xxxxx.cloudflareaccess.com.
    7. Edit the Dashboard configuration file (usually located at /opt/nezha/dashboard/data/config.yaml), adjust the OAuth2 settings according to the example configuration, and restart the Dashboard service.

    Identity Verification Strategy Configuration ​

    After setting up the Dashboard, you need to configure identity verification policies in the Zero Trust Dashboard. Navigate to: Access -> Applications -> <application name> -> Policies. You can choose from various SSO authentication methods, including email OTP and hardware key verification. For detailed configurations, refer to the Cloudflare Zero Trust Documentation.

    Policy Configuration Example (One-time PIN) ​

    Using email OTP as the default verification method:

    1. Navigate to Access -> Applications -> <application name> -> Policies -> Add a policy.
    2. Set a Policy Name, for example, OTP, and set Action to Allow.
    3. Under Configure rules, add a new Include rule. Select Emails as the Selector and enter your email address in the textbox.
    4. Click Save policy to save the configuration.

    Testing the Policy ​

    1. If the configuration is correct, when you visit the Dashboard login interface, it will display as "Log in with Cloudflare Account." Clicking on login will redirect you to the Cloudflare Access login page.
    2. Enter the email address configured previously, click Send me a code, and then enter the code received to log in to the Dashboard.
    3. If User ID was not specified in Admin during previous steps, an error message will be displayed after login: "This user is not an administrator of this site and cannot log in." At this point, you need to go to My Team -> Users, find the corresponding user, click on the username to get the User ID, and enter it into the Admin section of the Dashboard configuration file. After restarting the Dashboard service, try logging in again.
    + \ No newline at end of file diff --git a/en_US/guide/q9.html b/en_US/guide/q9.html index d60ef14a..ed8d60f8 100644 --- a/en_US/guide/q9.html +++ b/en_US/guide/q9.html @@ -12,7 +12,7 @@ - + @@ -35,8 +35,8 @@ cmake .. make -j $(nproc) # Install library file and header; default location is /opt/rocm -make install - +make install + \ No newline at end of file diff --git a/en_US/guide/servers.html b/en_US/guide/servers.html index 10a798b5..8a062990 100644 --- a/en_US/guide/servers.html +++ b/en_US/guide/servers.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    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.
    • Note: Server notes, visible only after verification.
    • Public Note: Server public notes, visible on the frontend. You can customize frontend theme based on this field; see Public Note Example for details.
    • Installation commands: Click the corresponding system button to copy the command and execute it on the server for an instant 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.

    FM ​

    Added in Dashboard v0.19.1 / Agent v0.19.0. A pseudo file manager embedded in WebShell, supports file download/upload, directory navigation and copying current path. Access it by clicking the blue button in the bottom-right corner of the WebShell.

    Public Note Example ​

    ServerStatus Theme Agent Billing Information Display ​

    Click to expand/collapse

    See https://github.com/naiba/nezha/pull/425.

    - +
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    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.
    • Note: Server notes, visible only after verification.
    • Public Note: Server public notes, visible on the frontend. You can customize frontend theme based on this field; see Public Note Example for details.
    • Installation commands: Click the corresponding system button to copy the command and execute it on the server for an instant 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.

    FM ​

    Added in Dashboard v0.19.1 / Agent v0.19.0. A pseudo file manager embedded in WebShell, supports file download/upload, directory navigation and copying current path. Access it by clicking the blue button in the bottom-right corner of the WebShell.

    Public Note Example ​

    ServerStatus Theme Agent Billing Information Display ​

    Click to expand/collapse

    See https://github.com/naiba/nezha/pull/425.

    + \ No newline at end of file diff --git a/en_US/guide/services.html b/en_US/guide/services.html index 17452e24..7553cd0e 100644 --- a/en_US/guide/services.html +++ b/en_US/guide/services.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    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 dashboard 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.

    - +
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    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 dashboard 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.

    + \ No newline at end of file diff --git a/en_US/guide/settings.html b/en_US/guide/settings.html index d1094ac9..74d510e6 100644 --- a/en_US/guide/settings.html +++ b/en_US/guide/settings.html @@ -12,7 +12,7 @@ - + @@ -332,8 +332,8 @@ .hotaru-cover { background: url(https://s3.ax1x.com/2020/12/08/DzHv6A.jpg) center; } -</style>

    View Password ​

    If you don't want to display your Dashboard directly to visitors, you can set a view password here. After setting the password, visitors need to enter the password to access the homepage.

    Non-CDN Dashboard Server Domain/IP ​

    This setting is a prerequisite for using the one-click script to install the Agent. For details, please see here.

    IP Change Notifications ​

    If you want to receive notifications when a server's IP changes, you can set it up here.

    Coverage ​

    Select a rule to determine which servers to monitor. Choose according to your needs.

    Specific Servers ​

    Set exclusions for the selected rule in conjunction with the coverage scope.

    Send Notifications to a Specific Notification Group ​

    Choose a notification method, which should be set up in advance on the "Notification" page.

    WARNING

    Notifications take effect after enabling this setting.

    Show Full IP Address in Notifications ​

    IP change notifications hide the full IP by default. If you don't want to hide it, check "Show Full IP Address in Notification."

    Disable Homepage Theme Switching ​

    By default, the Dashboard allows visitors to change the theme. This feature only affects individual visitors and does not affect the theme set by the administrator in the admin panel. If you don't want visitors to switch themes, check this option.

    - +</style>

    View Password ​

    If you don't want to display your Dashboard directly to visitors, you can set a view password here. After setting the password, visitors need to enter the password to access the homepage.

    Non-CDN Dashboard Server Domain/IP ​

    This setting is a prerequisite for using the one-click script to install the Agent. For details, please see here.

    IP Change Notifications ​

    If you want to receive notifications when a server's IP changes, you can set it up here.

    Coverage ​

    Select a rule to determine which servers to monitor. Choose according to your needs.

    Specific Servers ​

    Set exclusions for the selected rule in conjunction with the coverage scope.

    Send Notifications to a Specific Notification Group ​

    Choose a notification method, which should be set up in advance on the "Notification" page.

    WARNING

    Notifications take effect after enabling this setting.

    Show Full IP Address in Notifications ​

    IP change notifications hide the full IP by default. If you don't want to hide it, check "Show Full IP Address in Notification."

    Disable Homepage Theme Switching ​

    By default, the Dashboard allows visitors to change the theme. This feature only affects individual visitors and does not affect the theme set by the administrator in the admin panel. If you don't want visitors to switch themes, check this option.

    + \ No newline at end of file diff --git a/en_US/guide/tasks.html b/en_US/guide/tasks.html index ae1c1591..02ca0958 100644 --- a/en_US/guide/tasks.html +++ b/en_US/guide/tasks.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    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 ​

    1. 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.
    - +
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    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 ​

    1. 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.
    + \ No newline at end of file diff --git a/en_US/index.html b/en_US/index.html index 179319e3..fcf32257 100644 --- a/en_US/index.html +++ b/en_US/index.html @@ -12,7 +12,7 @@ - + @@ -23,7 +23,7 @@
    Nezha Server Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    Nezha Monitoring

    Open-source, lightweight, and easy-to-use server monitoring and operation tool

    Preview
    Get Started →

    One-Click Installation

    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.

    Real-Time Monitoring

    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.

    Easy Operations

    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.

    - + \ No newline at end of file diff --git a/guide/agent.html b/guide/agent.html index c7168a01..db4a9ec2 100644 --- a/guide/agent.html +++ b/guide/agent.html @@ -12,7 +12,7 @@ - + @@ -42,8 +42,8 @@ tls: false use_gitee_to_upgrade: false use_ipv6_country_code: false -uuid: your_uuid

    4. 运行 Agent ​

    1. 赋予执行权限并启动 Agent

      bash
      chmod +x /volume1/nezha/nezha-agent && /volume1/nezha/nezha-agent -c /volume1/nezha/config.yml

    2. 验证 Agent 连接

    5. 设置为开机自启动 ​

    群晖系统不支持 systemd，但可以通过任务计划（Task Scheduler）实现开机自启动：

    1. 登录群晖 DSM 管理界面
      使用管理员账户登录 DSM。

    2. 打开任务计划
      前往 控制面板 > 任务计划。

    3. 创建新任务

    4. 保存并运行任务

    - +uuid: your_uuid

    4. 运行 Agent ​

    1. 赋予执行权限并启动 Agent

      bash
      chmod +x /volume1/nezha/nezha-agent && /volume1/nezha/nezha-agent -c /volume1/nezha/config.yml

    2. 验证 Agent 连接

    5. 设置为开机自启动 ​

    群晖系统不支持 systemd，但可以通过任务计划（Task Scheduler）实现开机自启动：

    1. 登录群晖 DSM 管理界面
      使用管理员账户登录 DSM。

    2. 打开任务计划
      前往 控制面板 > 任务计划。

    3. 创建新任务

    4. 保存并运行任务

    + \ No newline at end of file diff --git a/guide/agentq.html b/guide/agentq.html index 977d583c..66e75d15 100644 --- a/guide/agentq.html +++ b/guide/agentq.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    Agent 常见问题 ​

    后台显示的 IP 和 Agent 实际 IP 不一致？ ​

    如果后台显示的 IP 和 Agent 的实际 IP 不一致，请参考 Dashboard 相关 - 为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？。
    该问题的详细解决方法已在相关文档中说明，此处不再赘述。

    一键脚本安装时出错 ​

    1. curl: Failed to connect to raw.githubusercontent.com...... ​

    此问题多发生在中国大陆的服务器上，原因是 Github 的连接不稳定。解决方法：

    1. 多次尝试：直接多尝试几次运行一键脚本。
    2. 手动安装：按照 手动安装 Agent 的指南完成安装。
    3. 使用加速服务：可使用第三方 Github 加速服务或镜像。找到加速地址后，在一键安装脚本中进行替换。

    2. sudo: command not found ​

    如果提示 sudo: command not found，说明目标服务器未安装 sudo 工具。解决方法：

    1. 手动安装 sudo：
      • 对于 Ubuntu 系统，可以运行以下命令：
        shell
        apt install sudo
      • 对于 CentOS 系统，可以运行以下命令：
        shell
        yum install sudo
    2. 检查安装成功：安装完成后，再次运行一键脚本进行安装。

    Agent 有 Docker 镜像吗？ ​

    Agent 目前没有推出 Docker 镜像。
    Agent 的设计思路和 Dashboard 相反：Dashboard 的目标是尽量减少对宿主机的干扰，而 Agent 则需要深度与宿主机集成以执行监控服务和命令任务。

    虽然将 Agent 放入容器中可以继续执行监控任务，但 WebShell 等功能将无法正常运行，因此官方不提供 Docker 镜像支持。

    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    Agent 常见问题 ​

    后台显示的 IP 和 Agent 实际 IP 不一致？ ​

    如果后台显示的 IP 和 Agent 的实际 IP 不一致，请参考 Dashboard 相关 - 为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？。
    该问题的详细解决方法已在相关文档中说明，此处不再赘述。

    一键脚本安装时出错 ​

    1. curl: Failed to connect to raw.githubusercontent.com...... ​

    此问题多发生在中国大陆的服务器上，原因是 Github 的连接不稳定。解决方法：

    1. 多次尝试：直接多尝试几次运行一键脚本。
    2. 手动安装：按照 手动安装 Agent 的指南完成安装。
    3. 使用加速服务：可使用第三方 Github 加速服务或镜像。找到加速地址后，在一键安装脚本中进行替换。

    2. sudo: command not found ​

    如果提示 sudo: command not found，说明目标服务器未安装 sudo 工具。解决方法：

    1. 手动安装 sudo：
      • 对于 Ubuntu 系统，可以运行以下命令：
        shell
        apt install sudo
      • 对于 CentOS 系统，可以运行以下命令：
        shell
        yum install sudo
    2. 检查安装成功：安装完成后，再次运行一键脚本进行安装。

    Agent 有 Docker 镜像吗？ ​

    Agent 目前没有推出 Docker 镜像。
    Agent 的设计思路和 Dashboard 相反：Dashboard 的目标是尽量减少对宿主机的干扰，而 Agent 则需要深度与宿主机集成以执行监控服务和命令任务。

    虽然将 Agent 放入容器中可以继续执行监控任务，但 WebShell 等功能将无法正常运行，因此官方不提供 Docker 镜像支持。

    + \ No newline at end of file diff --git a/guide/api.html b/guide/api.html index 0c0bc3d1..8f5c46d0 100644 --- a/guide/api.html +++ b/guide/api.html @@ -12,7 +12,7 @@ - + @@ -263,8 +263,8 @@ eval $CMD
    1. 为脚本赋予可执行权限： chmod +x nezha_register.sh
    2. 从dashboard获取token, 比如为 POXbxorKJBM8wPMKX8r2PdMblyXvpggB
    3. 配置环境变量
    bash
    export NEZHA_TOKEN="POXbxorKJBM8wPMKX8r2PdMblyXvpggB" # 从面板获取
 export NEZHA_PROBE_ADDRESS="your_probe_address"        # 填写探针地址
 export NEZHA_DASHBOARD_URL="https://nezha.example.com" # 修改为你的面板地址
-export NEZHA_PROBE_PORT="5555"                         # 修改为你的探针端口（如有不同）
    1. 运行注册脚本
    bash
    ./nezha_register.sh
    1. 如果脚本成功运行，你会看到类似以下的日志：
    bash
    Run command: ./nezha.sh install_agent probe.example.com 5555 YOUR_SECRET --tls
     - +export NEZHA_PROBE_PORT="5555" # 修改为你的探针端口（如有不同）
    1. 运行注册脚本
    bash
    ./nezha_register.sh
    1. 如果脚本成功运行，你会看到类似以下的日志：
    bash
    Run command: ./nezha.sh install_agent probe.example.com 5555 YOUR_SECRET --tls
     + \ No newline at end of file diff --git a/guide/dashboard.html b/guide/dashboard.html index 02689e50..d977fcc5 100644 --- a/guide/dashboard.html +++ b/guide/dashboard.html @@ -12,7 +12,7 @@ - + @@ -41,8 +41,8 @@ proxy_set_header Connection "Upgrade"; proxy_set_header Host $http_host; } -#PROXY-END/
    1. 点击“保存”。

    现在，你可以直接通过域名访问面板，例如：
    http://dashboard.example.com

    更新 Dashboard ​

    运行脚本：

    bash
    ./nezha.sh

    选择重启面板并更新。

    - +#PROXY-END/
    1. 点击“保存”。

    现在，你可以直接通过域名访问面板，例如：
    http://dashboard.example.com

    更新 Dashboard ​

    运行脚本：

    bash
    ./nezha.sh

    选择重启面板并更新。

    + \ No newline at end of file diff --git a/guide/dashboardq.html b/guide/dashboardq.html index 395b2ca0..b8ca4d0d 100644 --- a/guide/dashboardq.html +++ b/guide/dashboardq.html @@ -12,7 +12,7 @@ - + @@ -38,8 +38,8 @@ read_buffer 2MB write_buffer 2MB } -}

    2. 尝试直接连接 ​

    如果使用 CDN，建议绕过 CDN，直接连接到源服务器进行文件传输。
    检查连接方式是否直接指向源服务器的 IP 或域名，并确保网络畅通。

    - +}

    2. 尝试直接连接 ​

    如果使用 CDN，建议绕过 CDN，直接连接到源服务器进行文件传输。
    检查连接方式是否直接指向源服务器的 IP 或域名，并确保网络畅通。

    + \ No newline at end of file diff --git a/guide/ddns.html b/guide/ddns.html index a18e217f..d36fe12f 100644 --- a/guide/ddns.html +++ b/guide/ddns.html @@ -12,7 +12,7 @@ - + @@ -25,8 +25,8 @@
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    DDNS ​

    DDNS 功能适用于使用动态 IP 的服务器。当 Agent 每 10 分钟上报一个新 IP 时，Dashboard 会根据配置自动更新 DNS 记录。

    为什么使用哪吒监控的 DDNS 功能？ ​

    • 集中管理：方便在 Dashboard 中集中管理 DDNS 设置，无需在每台服务器上部署单独的 DDNS 服务。
    • 更高安全性：机密信息仅存储在面板服务器中，降低泄露风险。

    配置说明 ​

    可以直接在 Dashboard 的管理页面中添加 DDNS 配置。

    1. 进入动态域名解析配置页面
      点击菜单栏中的“动态域名解析”，进入配置页面。
    2. 新建配置
      点击“新配置”按钮，在弹出窗口中填写相关信息：
      • 名称：配置的名称，便于管理。
      • DDNS 供应商：选择提供服务的供应商类型。
      • 域名（逗号分隔）：填写需要更新的域名，多个域名用逗号分隔。支持 IDN（国际化域名）。
      • 最大重试次数：DDNS 更新的最大尝试次数，默认为 3，可设置范围为 1-10 的整数。
      • DDNS 凭据 1 和 DDNS 凭据 2：凭据选填，具体需求参见供应商列表。
    3. Webhook 特殊说明
      如果使用 webhook 供应商，请根据Webhook 配置说明填写相关选项。
    4. 启用选项
      至少勾选 启用 DDNS IPv4 或 启用 DDNS IPv6，否则不会进行更新。
    5. 关联服务器
      添加配置后，需要修改服务器设置以启用 DDNS 功能：
      • 启用 DDNS：在 服务器 页面中为目标服务器启用 DDNS。
      • DDNS 配置：选择适用的 DDNS 配置 ID，支持通过名称搜索。

    Webhook 配置说明 ​

    Webhook 支持自定义 HTTP 请求，适用于第三方供应商或其他定制化需求。

    选项说明 ​

    • Webhook URL：目标请求的 URL，支持占位符替换。
    • Webhook 请求方式：支持 GET、POST、PATCH、DELETE 和 PUT。
    • Webhook 请求类型：请求体格式，可选择 JSON 或 Form。
    • Webhook 请求头：以 JSON 格式填写请求头，注意不支持嵌套。
    • Webhook 请求体：GET 和 DELETE 不使用请求体；如果使用嵌套格式，请选择 JSON 类型。

    占位符说明 ​

    占位符含义
    #ip#主机 IP 地址
    #domain#域名（每次单独请求）
    #type#IP 类型："ipv4" 或 "ipv6"
    #record#记录类型："A" 或 "AAAA"
    #access_id#DDNS 凭据 1
    #access_secret#DDNS 凭据 2

    花生壳 Webhook 示例 ​

    点击展开/收起
    • URL：http://ddns.oray.com/ph/update?hostname=#domain#&myip=#ip#
    • 请求方式: GET
    • 请求头:
      json
      {
   "Authorization": "Basic pass"
 }
      其中 pass 是 Base64 编码后的用户名和密码（例如，user:pass 转换为 dXNlcjpwYXNzCg==）。
    • 注意：花生壳仅支持 A 记录，因此只需启用 IPv4。

    供应商列表 ​

    供应商凭据1（ID）凭据2（Secret）
    dummy❌️❌️
    webhook可选可选
    cloudflare❌️✅
    tencentcloud✅✅

    查看日志 ​

    在 Dashboard 的日志页面，可以查看 DDNS 更新的详细记录。如果配置正确，日志中会显示更新状态。例如：

    shell
    dashboard_1  | 2024/03/16 23:16:25 NEZHA>> 正在尝试更新域名(ddns.example.com)DDNS(1/3)
-dashboard_1  | 2024/03/16 23:16:28 NEZHA>> 尝试更新域名(ddns.example.com)DDNS成功
    - +dashboard_1 | 2024/03/16 23:16:28 NEZHA>> 尝试更新域名(ddns.example.com)DDNS成功 + \ No newline at end of file diff --git a/guide/group.html b/guide/group.html index 3448fe25..c412b4ad 100644 --- a/guide/group.html +++ b/guide/group.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    分组管理 ​

    分组管理允许用户更高效地组织服务器和通知设置，提高 Dashboard 的可读性和操作便捷性。

    服务器分组 ​

    功能说明 ​

    服务器分组用于在 Dashboard 中为服务器分类管理。分组后的服务器会在不同的标签页中展示，便于快速查找和区分。

    配置步骤 ​

    1. 进入服务器页面
      在服务器页面中完成服务器的基础配置。

    2. 设置分组
      为服务器设置分组名称，相同分组名称的服务器会被归类到同一个标签页。

    应用场景 ​

    • 区域划分：按地理位置（如 中国区、海外区）对服务器进行分组。
    • 用途划分：按服务器用途（如 数据库、Web服务）分组。
    • 部门划分：按使用部门（如 研发部、运营部）分组。

    通知分组 ​

    功能说明 ​

    通知分组允许用户将多个通知方式组合成一个通知组，通知组可用作任务或告警的通知目标，实现一键发送多种方式的通知。

    配置步骤 ​

    1. 进入通知页面
      在通知页面中配置所需的通知方式（如 Telegram、邮件、钉钉等）。

    2. 创建通知组
      将一个或多个通知方式添加到同一个通知组中，命名该分组便于识别。

    3. 应用通知组
      在任务或告警规则中选择通知组作为通知目标，触发时会同时通过分组内的所有通知方式发送通知。

    应用场景 ​

    • 多渠道通知：通过 Telegram 和邮件同时接收服务器告警。
    • 分级通知：针对不同告警类型或服务器分组，设置不同的通知组（如 高优先级 通知组与 普通通知组）。
    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    分组管理 ​

    分组管理允许用户更高效地组织服务器和通知设置，提高 Dashboard 的可读性和操作便捷性。

    服务器分组 ​

    功能说明 ​

    服务器分组用于在 Dashboard 中为服务器分类管理。分组后的服务器会在不同的标签页中展示，便于快速查找和区分。

    配置步骤 ​

    1. 进入服务器页面
      在服务器页面中完成服务器的基础配置。

    2. 设置分组
      为服务器设置分组名称，相同分组名称的服务器会被归类到同一个标签页。

    应用场景 ​

    • 区域划分：按地理位置（如 中国区、海外区）对服务器进行分组。
    • 用途划分：按服务器用途（如 数据库、Web服务）分组。
    • 部门划分：按使用部门（如 研发部、运营部）分组。

    通知分组 ​

    功能说明 ​

    通知分组允许用户将多个通知方式组合成一个通知组，通知组可用作任务或告警的通知目标，实现一键发送多种方式的通知。

    配置步骤 ​

    1. 进入通知页面
      在通知页面中配置所需的通知方式（如 Telegram、邮件、钉钉等）。

    2. 创建通知组
      将一个或多个通知方式添加到同一个通知组中，命名该分组便于识别。

    3. 应用通知组
      在任务或告警规则中选择通知组作为通知目标，触发时会同时通过分组内的所有通知方式发送通知。

    应用场景 ​

    • 多渠道通知：通过 Telegram 和邮件同时接收服务器告警。
    • 分级通知：针对不同告警类型或服务器分组，设置不同的通知组（如 高优先级 通知组与 普通通知组）。
    + \ No newline at end of file diff --git a/guide/loginq.html b/guide/loginq.html index 66aeca40..8c14423e 100644 --- a/guide/loginq.html +++ b/guide/loginq.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    登录常见问题 ​

    V0版本，不适用于V1版本

    登录后面板报错 ​

    1. http: named cookie not present ​

    可能原因及解决方法：

    1. 清理浏览器的 cookies 后重新登录，或者尝试更换浏览器。
    2. 检查回调地址配置，确保回调地址正确且 端口与协议一致。
      • 发起请求的地址和回调地址需同域，协议、端口和域名（或 IP） 都必须一致。

    2. lookup xxx ​

    此问题通常由于容器的 DNS 解析失败，可能原因包括 iptables 配置被修改。解决方法：

    1. 重启 Docker 服务：
      bash
      sudo systemctl restart docker
    2. 使用脚本重启面板后查看是否恢复正常。
    3. 如果问题依然存在：
      • 检查是否有其他工具（如宝塔防火墙）控制了 iptables。
      • 考虑切换到官方内核，因为某些问题可能与当前内核版本相关。

    3. dial tcp xxx:443 i/o timeout ​

    此问题通常与网络问题有关。解决方法：

    1. 重启 Docker 服务：
      bash
      sudo systemctl restart docker
    2. 使用脚本重启面板后查看是否恢复正常。
    3. 如果您使用国内服务器并配置了 GitHub 登录方式：
      • 建议切换到 Cloudflare Access 以减少网络干扰。

    4. net/http: TLS handshake timeout ​

    此问题与网络问题类似，处理方式与上文相同：

    1. 重启 Docker 服务：
      bash
      sudo systemctl restart docker
    2. 使用脚本重启面板后检查是否正常。
    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    登录常见问题 ​

    V0版本，不适用于V1版本

    登录后面板报错 ​

    1. http: named cookie not present ​

    可能原因及解决方法：

    1. 清理浏览器的 cookies 后重新登录，或者尝试更换浏览器。
    2. 检查回调地址配置，确保回调地址正确且 端口与协议一致。
      • 发起请求的地址和回调地址需同域，协议、端口和域名（或 IP） 都必须一致。

    2. lookup xxx ​

    此问题通常由于容器的 DNS 解析失败，可能原因包括 iptables 配置被修改。解决方法：

    1. 重启 Docker 服务：
      bash
      sudo systemctl restart docker
    2. 使用脚本重启面板后查看是否恢复正常。
    3. 如果问题依然存在：
      • 检查是否有其他工具（如宝塔防火墙）控制了 iptables。
      • 考虑切换到官方内核，因为某些问题可能与当前内核版本相关。

    3. dial tcp xxx:443 i/o timeout ​

    此问题通常与网络问题有关。解决方法：

    1. 重启 Docker 服务：
      bash
      sudo systemctl restart docker
    2. 使用脚本重启面板后查看是否恢复正常。
    3. 如果您使用国内服务器并配置了 GitHub 登录方式：
      • 建议切换到 Cloudflare Access 以减少网络干扰。

    4. net/http: TLS handshake timeout ​

    此问题与网络问题类似，处理方式与上文相同：

    1. 重启 Docker 服务：
      bash
      sudo systemctl restart docker
    2. 使用脚本重启面板后检查是否正常。
    + \ No newline at end of file diff --git a/guide/nat.html b/guide/nat.html index 9cc65f99..7de2a06c 100644 --- a/guide/nat.html +++ b/guide/nat.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    内网穿透功能配置 ​

    哪吒服务器监控提供内置的内网穿透功能，允许用户通过设定 Dashboard 作为服务端，将运行在 Agent 上的内网服务（如家庭 OpenWrt 路由器、NAS 设备等）映射到公网，便于外部访问。目前仅支持明文 HTTP 的穿透。

    准备工作 ​

    在配置内网穿透前，请确保完成以下准备工作：

    1. 安装并运行 Agent：确保目标设备已正确安装并运行哪吒监控的 Agent，且保持与 Dashboard 的连接状态。
    2. 准备公网域名：建议使用子域名操作，例如 service-1.example.com，并解析至 Dashboard 服务器的公网 IP。
    3. 一对一映射：每个域名只能映射一个 Agent 的内网服务。需要映射多个服务时，请分别使用不同域名，例如 service-2.example.com。

    WARNING

    如果使用宝塔面板或其他管理工具，请确保绑定的域名（如 service-1.example.com）已正确配置为指向 Dashboard 服务站点，否则可能导致无法访问。

    配置步骤 ​

    1. 登录 Dashboard 管理页面
      在菜单栏中选择“内网穿透”选项，进入配置页面。

    2. 添加穿透配置
      点击“添加”按钮，填写以下信息：

      • 名称：自定义配置名称，如 OpenWrt 登录页。
      • 服务器 ID：填写目标 Agent 的 ID。
      • 本地服务：填写需穿透的内网服务地址，格式为 IP:端口（如 127.0.0.1:80）。
      • 绑定域名：填写公网域名（如 service-1.example.com）。如果 Dashboard 使用非标准端口（如 8008），需手动添加端口。

    3. 保存配置
      点击“新增”按钮，完成配置并等待穿透生效。

    4. 验证穿透
      在浏览器中访问 http://service-1.example.com，确认是否成功映射到目标内网服务。

    使用须知 ​

    1. 保持连接状态
      Agent 与 Dashboard 的持续连接是内网穿透功能正常运行的前提。如果连接中断，配置的穿透功能将暂时失效。

    2. 安全注意事项

      • 内网穿透隧道仅支持明文 HTTP 数据传输，无内置加密功能。
      • 强烈建议在以下两处启用 TLS/SSL 以确保数据传输安全：
        • Agent 与 Dashboard 之间的通信。
        • Dashboard 与外部访问客户端之间的通信。

    通过以上步骤，您可以轻松配置内网穿透功能，并安全地将内网服务映射到公网。

    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    内网穿透功能配置 ​

    哪吒服务器监控提供内置的内网穿透功能，允许用户通过设定 Dashboard 作为服务端，将运行在 Agent 上的内网服务（如家庭 OpenWrt 路由器、NAS 设备等）映射到公网，便于外部访问。目前仅支持明文 HTTP 的穿透。

    准备工作 ​

    在配置内网穿透前，请确保完成以下准备工作：

    1. 安装并运行 Agent：确保目标设备已正确安装并运行哪吒监控的 Agent，且保持与 Dashboard 的连接状态。
    2. 准备公网域名：建议使用子域名操作，例如 service-1.example.com，并解析至 Dashboard 服务器的公网 IP。
    3. 一对一映射：每个域名只能映射一个 Agent 的内网服务。需要映射多个服务时，请分别使用不同域名，例如 service-2.example.com。

    WARNING

    如果使用宝塔面板或其他管理工具，请确保绑定的域名（如 service-1.example.com）已正确配置为指向 Dashboard 服务站点，否则可能导致无法访问。

    配置步骤 ​

    1. 登录 Dashboard 管理页面
      在菜单栏中选择“内网穿透”选项，进入配置页面。

    2. 添加穿透配置
      点击“添加”按钮，填写以下信息：

      • 名称：自定义配置名称，如 OpenWrt 登录页。
      • 服务器 ID：填写目标 Agent 的 ID。
      • 本地服务：填写需穿透的内网服务地址，格式为 IP:端口（如 127.0.0.1:80）。
      • 绑定域名：填写公网域名（如 service-1.example.com）。如果 Dashboard 使用非标准端口（如 8008），需手动添加端口。

    3. 保存配置
      点击“新增”按钮，完成配置并等待穿透生效。

    4. 验证穿透
      在浏览器中访问 http://service-1.example.com，确认是否成功映射到目标内网服务。

    使用须知 ​

    1. 保持连接状态
      Agent 与 Dashboard 的持续连接是内网穿透功能正常运行的前提。如果连接中断，配置的穿透功能将暂时失效。

    2. 安全注意事项

      • 内网穿透隧道仅支持明文 HTTP 数据传输，无内置加密功能。
      • 强烈建议在以下两处启用 TLS/SSL 以确保数据传输安全：
        • Agent 与 Dashboard 之间的通信。
        • Dashboard 与外部访问客户端之间的通信。

    通过以上步骤，您可以轻松配置内网穿透功能，并安全地将内网服务映射到公网。

    + \ No newline at end of file diff --git a/guide/notifications.html b/guide/notifications.html index 7df58604..1b9216b2 100644 --- a/guide/notifications.html +++ b/guide/notifications.html @@ -12,7 +12,7 @@ - + @@ -75,8 +75,8 @@ "Cover": 1, "Ignore": {"3": true, "4": true} } -]

  • 说明：服务器 3、4 的出站月流量超过 1TB 时触发通知，统计周期从每月 1 号开始。

    • TIP

    如果对通知配置有疑问，可以使用以下第三方配置生成器简化操作（哪吒监控不对第三方生成器的功能性作任何保证）：

    通知触发模式 ​

    设置通知时执行任务 ​

    如果需要在发送通知的同时执行特定任务，可以进行如下设置：

    - +]

  • 说明：服务器 3、4 的出站月流量超过 1TB 时触发通知，统计周期从每月 1 号开始。

    • TIP

    如果对通知配置有疑问，可以使用以下第三方配置生成器简化操作（哪吒监控不对第三方生成器的功能性作任何保证）：

    通知触发模式 ​

    设置通知时执行任务 ​

    如果需要在发送通知的同时执行特定任务，可以进行如下设置：

    + \ No newline at end of file diff --git a/guide/q1.html b/guide/q1.html index c2056112..ec87055c 100644 --- a/guide/q1.html +++ b/guide/q1.html @@ -12,7 +12,7 @@ - + @@ -67,8 +67,8 @@ # CentOS iptables -I INPUT -p tcp --dport 443 -j DROP -iptables -I INPUT -s <serverIp> -p tcp --dport 443 -j ACCEPT

    通过以上配置，可以有效防止未经授权的访问。

     - +iptables -I INPUT -s <serverIp> -p tcp --dport 443 -j ACCEPT

    通过以上配置，可以有效防止未经授权的访问。

     + \ No newline at end of file diff --git a/guide/q10.html b/guide/q10.html index 5e2d8332..e3a929e4 100644 --- a/guide/q10.html +++ b/guide/q10.html @@ -12,7 +12,7 @@ - + @@ -36,8 +36,8 @@ oidcLoginClaim: sub # （可选，默认值为 sub）OIDC 返回的用户名字段，可以是 preferred_username、sub 或email oidcGroupsClaim: groups # （如果使用 adminGroups，则必填，默认值为 groups ）OIDC 返回的用户组信息字段，可以是 groups 或 roles oidcAutoCreate: false # （可选，默认值为 false）如果用户不存在，是否自动创建用户 - oidcAutoLogin: false # （可选，默认值为 false）当地址是 /login 时，是否自动跳转到OIDC登录页面 - + oidcAutoLogin: false # （可选，默认值为 false）当地址是 /login 时，是否自动跳转到OIDC登录页面 + \ No newline at end of file diff --git a/guide/q11.html b/guide/q11.html index 26e8bb05..bb817e55 100644 --- a/guide/q11.html +++ b/guide/q11.html @@ -12,7 +12,7 @@ - + @@ -49,8 +49,8 @@ ], "Lookup": "114.5.1.4" } -]

    确定格式、信息无误后便可用于 Dashboard 编译。之后可通过 grpcurl 或类似工具测试查询 API 是否工作正常：

    shell
    grpcurl -proto ./nezha/proto/nezha.proto -plaintext -H 'client_secret: test' -d '{"ip": "114.5.1.4"}' 127.0.0.1:5555 proto.NezhaService/LookupGeoIP
     - +]

    确定格式、信息无误后便可用于 Dashboard 编译。之后可通过 grpcurl 或类似工具测试查询 API 是否工作正常：

    shell
    grpcurl -proto ./nezha/proto/nezha.proto -plaintext -H 'client_secret: test' -d '{"ip": "114.5.1.4"}' 127.0.0.1:5555 proto.NezhaService/LookupGeoIP
     + \ No newline at end of file diff --git a/guide/q2.html b/guide/q2.html index e15230e7..8fa4c4e4 100644 --- a/guide/q2.html +++ b/guide/q2.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    Agent 启动/上线 问题自检流程 ​

    1. nc -v 域名/IP 通讯端口 或者 telnet 域名/IP 通讯端口 来检验是否是网络问题，检查本机与面板服务器的出入站防火墙，如果无法判断问题可借助 https://port.ping.pe/ 提供的端口检查工具进行检测。
    2. 如果上面步骤检测正常，Agent 依然没有正常上线，请尝试关闭 SELinux，如何关闭 SELinux？
    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    Agent 启动/上线 问题自检流程 ​

    1. nc -v 域名/IP 通讯端口 或者 telnet 域名/IP 通讯端口 来检验是否是网络问题，检查本机与面板服务器的出入站防火墙，如果无法判断问题可借助 https://port.ping.pe/ 提供的端口检查工具进行检测。
    2. 如果上面步骤检测正常，Agent 依然没有正常上线，请尝试关闭 SELinux，如何关闭 SELinux？
    + \ No newline at end of file diff --git a/guide/q3.html b/guide/q3.html index 71ddb042..9355cf19 100644 --- a/guide/q3.html +++ b/guide/q3.html @@ -12,7 +12,7 @@ - + @@ -38,25 +38,38 @@ underscores_in_headers on; set_real_ip_from 0.0.0.0/0; # 替换为你的 CDN 回源 IP 地址段 real_ip_header CF-Connecting-IP; # 替换为你的 CDN 提供的私有 header，此处为 CloudFlare 默认 - + # grpc 相关 location ^~ /proto.NezhaService/ { grpc_set_header Host $host; - grpc_set_header nz-realip $http_CF_Connecting_IP; # 替换为你的 CDN 提供的私有 header，此处为 CloudFlare 默认 - grpc_read_timeout 300s; - grpc_send_timeout 300s; + grpc_set_header nz-realip $http_cf_connecting_ip; + grpc_read_timeout 600s; + grpc_send_timeout 600s; grpc_socket_keepalive on; + client_max_body_size 10m; + grpc_buffer_size 4m; grpc_pass grpc://dashboard; } - - location / { + # websocket 相关 + location ~* ^/api/v1/ws/(server|terminal|file)(.*)$ { proxy_set_header Host $host; + proxy_set_header nz-realip $http_cf_connecting_ip; # 替换为你的 CDN 提供的私有 header，此处为 CloudFlare 默认 proxy_set_header Origin https://$host; - proxy_set_header nz-realip $http_CF_Connecting_IP; # 替换为你的 CDN 提供的私有 header，此处为 CloudFlare 默认 - proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection 'upgrade'; + proxy_set_header Connection "upgrade"; + proxy_read_timeout 3600s; + proxy_send_timeout 3600s; + proxy_pass http://dashboard; + } + # web + location / { + proxy_set_header Host $host; + proxy_set_header nz-realip $http_cf_connecting_ip; # 替换为你的 CDN 提供的私有 header，此处为 CloudFlare 默认 proxy_read_timeout 3600s; proxy_send_timeout 3600s; + proxy_buffer_size 128k; + proxy_buffers 4 256k; + proxy_busy_buffers_size 256k; + proxy_max_temp_file_size 0; proxy_pass http://dashboard; } } @@ -90,8 +103,8 @@ } to localhost:8008 } -}

    配置注意事项 ​

    1. 调整 Header
      根据您使用的 CDN 服务商，替换 CF-Connecting-IP 和相关配置为您的 CDN 提供的私有 header。

    2. HTTPS 配置
      确保 SSL 证书路径正确，并已正确配置域名解析。

    3. 负载调整
      根据服务器性能和访问需求，可调整 keepalive 和 buffer 设置。

    - +}

    配置注意事项 ​

    1. 调整 Header
      根据您使用的 CDN 服务商，替换 CF-Connecting-IP 和相关配置为您的 CDN 提供的私有 header。

    2. HTTPS 配置
      确保 SSL 证书路径正确，并已正确配置域名解析。

    3. 负载调整
      根据服务器性能和访问需求，可调整 keepalive 和 buffer 设置。

    + \ No newline at end of file diff --git a/guide/q4.html b/guide/q4.html index c104bf54..dadf79dc 100644 --- a/guide/q4.html +++ b/guide/q4.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    WebSocket 连接中 ​

    • 确认 CDN 设置：
      如果使用了 CDN，请确保 CDN 服务商支持 WebSocket 服务，并已正确启用 WebSocket 功能。

    • 检查反向代理配置：
      确保反向代理规则中已对以下路径进行 WebSocket 特殊配置：

      • /ws
      • /terminal

      具体配置方法可参考：配置反向代理。

    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    WebSocket 连接中 ​

    • 确认 CDN 设置：
      如果使用了 CDN，请确保 CDN 服务商支持 WebSocket 服务，并已正确启用 WebSocket 功能。

    • 检查反向代理配置：
      确保反向代理规则中已对以下路径进行 WebSocket 特殊配置：

      • /ws
      • /terminal

      具体配置方法可参考：配置反向代理。

    + \ No newline at end of file diff --git a/guide/q5.html b/guide/q5.html index 0fe47fed..8211f002 100644 --- a/guide/q5.html +++ b/guide/q5.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    如何进行数据迁移、备份恢复？ ​

    按照以下步骤完成哪吒监控的数据迁移或备份恢复：

    DANGER

    V0 和 V1 的数据库结构不兼容，请勿使用此方法进行 V0 至 V1 的跨版本升级。

    1. 停止面板服务
      在旧服务器中运行一键脚本，选择 停止面板。

    2. 备份数据
      打包旧服务器中的 /opt/nezha 文件夹，并将其复制到新服务器相同位置。

    3. 恢复数据
      在新服务器中解压 /opt/nezha 文件夹至相同路径。

    4. 启动面板服务
      在新服务器中运行一键脚本，选择 启动面板。

    注意事项 ​

    • 确保 /opt/nezha 文件夹及其内容的权限和所有权在新服务器上正确设置。
    • 数据迁移完成后，可以通过访问 Dashboard 界面验证迁移是否成功。
    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    如何进行数据迁移、备份恢复？ ​

    按照以下步骤完成哪吒监控的数据迁移或备份恢复：

    DANGER

    V0 和 V1 的数据库结构不兼容，请勿使用此方法进行 V0 至 V1 的跨版本升级。

    1. 停止面板服务
      在旧服务器中运行一键脚本，选择 停止面板。

    2. 备份数据
      打包旧服务器中的 /opt/nezha 文件夹，并将其复制到新服务器相同位置。

    3. 恢复数据
      在新服务器中解压 /opt/nezha 文件夹至相同路径。

    4. 启动面板服务
      在新服务器中运行一键脚本，选择 启动面板。

    注意事项 ​

    • 确保 /opt/nezha 文件夹及其内容的权限和所有权在新服务器上正确设置。
    • 数据迁移完成后，可以通过访问 Dashboard 界面验证迁移是否成功。
    + \ No newline at end of file diff --git a/guide/q6.html b/guide/q6.html index 5a01b7c5..144cea8a 100644 --- a/guide/q6.html +++ b/guide/q6.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    如何每月重置流量统计？ ​

    主页中的流量统计会在服务器重启时自动重置。如果需要实现每月自动重置流量计数，可以按以下步骤操作：

    1. 进入管理面板
      登录到 Dashboard，进入 通知 页。

    2. 创建月流量告警
      参考 任意周期流量告警文档，创建一个按月统计的流量告警。

    3. 查看月流量统计
      返回主页，点击 服务 按钮，即可查看月流量统计。此统计数据不会因服务器重启而重置。

    TIP

    灵活设置统计周期
    此方法不仅支持每月重置，还可以设置其他周期，例如每小时、每天、每周或每年重置流量统计，非常灵活！

    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    如何每月重置流量统计？ ​

    主页中的流量统计会在服务器重启时自动重置。如果需要实现每月自动重置流量计数，可以按以下步骤操作：

    1. 进入管理面板
      登录到 Dashboard，进入 通知 页。

    2. 创建月流量告警
      参考 任意周期流量告警文档，创建一个按月统计的流量告警。

    3. 查看月流量统计
      返回主页，点击 服务 按钮，即可查看月流量统计。此统计数据不会因服务器重启而重置。

    TIP

    灵活设置统计周期
    此方法不仅支持每月重置，还可以设置其他周期，例如每小时、每天、每周或每年重置流量统计，非常灵活！

    + \ No newline at end of file diff --git a/guide/q7.html b/guide/q7.html index 96f57cf6..598ebbbf 100644 --- a/guide/q7.html +++ b/guide/q7.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    自定义 Agent 监控项目 ​

    通过运行参数的配置，您可以灵活调整 Agent 的功能和行为，满足不同场景的监控需求。

    运行参数 ​

    配置参数 ​

    如果您通过一键脚本安装了 Agent，可以编辑 /opt/nezha/agent/config.yml 文件来添加或修改参数。
    同一台服务器可以运行多个 Agent，每个 Agent 配置文件相互独立。

    运行参数及其作用：

    • debug:

      • 当为 true 时启用调试模式，记录详细日志。

    • disable_auto_update:

      • 当为 true 时禁用 Agent 的自动更新功能，增强系统稳定性和安全性。

    • disable_command_execute:

      • 当为 true 时禁用在线终端、文件管理和定时任务的执行，提升安全性。

    • disable_force_update:

      • 当为 true 时禁用强制更新功能，仅允许手动更新。

    • disable_nat:

      • 当为 true 时禁用内网穿透功能，保护内网数据。

    • disable_send_query:

      • 当为 true 时禁用 Agent 发起的 TCP Ping、ICMP Ping 和 HTTP GET 请求。

    • gpu:

      • 当为 true 时启用 GPU 监控。
      • 注意：启用 GPU 监控可能需要安装额外依赖，详细信息参考：启用 GPU 监控。

    • insecure_tls:

      • 当为 true 时禁用证书检查，适用于使用自签名证书的场景。

    • ip_report_period:

      • 设置本地 IP 更新间隔时间（秒）。默认值为 1800 秒（30 分钟）。
      • 如果该值小于 report_delay 设置值，则以 report_delay 为准。

    • report_delay:

      • 设置系统信息上报的时间间隔（秒）。默认值为 1 秒，建议设置为 3 秒以降低资源占用（有效范围：1-4 秒）。

    • server:

      • 与 Dashboard 通信的域名或 IP 地址，需包括端口号。

    • skip_connection_count:

      • 当为 true 时禁用网络连接数的监控，适用于高连接数或资源受限的环境。

    • skip_procs_count:

      • 当为 true 时禁用进程数的监控，以降低资源占用。

    • temperature:

      • 当为 true 时启用硬件温度监控（仅支持部分硬件，部分 VPS 可能无法获取温度信息）。

    • tls:

      • 当为 true 时启用 Agent 与 Dashboard 间的通信 SSL/TLS 加密。
      • 如果 Agent 使用 Nginx 反向代理且启用了 SSL/TLS 配置，请开启此选项。

    • use_gitee_to_upgrade:

      • 当为 true 时使用 Gitee 仓库作为自动更新源，对中国大陆服务器更为友好。

    • use_ipv6_country_code:

      • 当为 true 时强制使用 IPv6 地址查询国家代码（默认使用 IPv4）。

    • uuid:

      • 当前 Agent 的唯一标识参数，用于 Dashboard 识别数据来源。
      • 若需替换 Dashboard 中已存在的 Agent，可以手动设置此参数。

    保存生效 ​

    在修改配置文件中的参数后，需要重新启动 Agent 服务以使更改生效。具体操作如下：

    1. 重新启动服务
      运行以下命令重新启动默认的第一个 Agent 服务：

      shell
      sudo systemctl restart nezha-agent.service

    2. 多 Agent 服务的情况
      如果同一服务器上运行了多个 Agent 服务，请先列出所有 Agent 服务的名称：

      shell
      sudo systemctl list-units --type=service | grep nezha-agent

      然后分别使用以下命令重新启动对应的 Agent 服务：

      shell
      sudo systemctl restart <service-name>

      将 <service-name> 替换为实际的服务名称，例如 nezha-agent@2.service。

    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    自定义 Agent 监控项目 ​

    通过运行参数的配置，您可以灵活调整 Agent 的功能和行为，满足不同场景的监控需求。

    运行参数 ​

    配置参数 ​

    如果您通过一键脚本安装了 Agent，可以编辑 /opt/nezha/agent/config.yml 文件来添加或修改参数。
    同一台服务器可以运行多个 Agent，每个 Agent 配置文件相互独立。

    运行参数及其作用：

    • debug:

      • 当为 true 时启用调试模式，记录详细日志。

    • disable_auto_update:

      • 当为 true 时禁用 Agent 的自动更新功能，增强系统稳定性和安全性。

    • disable_command_execute:

      • 当为 true 时禁用在线终端、文件管理和定时任务的执行，提升安全性。

    • disable_force_update:

      • 当为 true 时禁用强制更新功能，仅允许手动更新。

    • disable_nat:

      • 当为 true 时禁用内网穿透功能，保护内网数据。

    • disable_send_query:

      • 当为 true 时禁用 Agent 发起的 TCP Ping、ICMP Ping 和 HTTP GET 请求。

    • gpu:

      • 当为 true 时启用 GPU 监控。
      • 注意：启用 GPU 监控可能需要安装额外依赖，详细信息参考：启用 GPU 监控。

    • insecure_tls:

      • 当为 true 时禁用证书检查，适用于使用自签名证书的场景。

    • ip_report_period:

      • 设置本地 IP 更新间隔时间（秒）。默认值为 1800 秒（30 分钟）。
      • 如果该值小于 report_delay 设置值，则以 report_delay 为准。

    • report_delay:

      • 设置系统信息上报的时间间隔（秒）。默认值为 1 秒，建议设置为 3 秒以降低资源占用（有效范围：1-4 秒）。

    • server:

      • 与 Dashboard 通信的域名或 IP 地址，需包括端口号。

    • skip_connection_count:

      • 当为 true 时禁用网络连接数的监控，适用于高连接数或资源受限的环境。

    • skip_procs_count:

      • 当为 true 时禁用进程数的监控，以降低资源占用。

    • temperature:

      • 当为 true 时启用硬件温度监控（仅支持部分硬件，部分 VPS 可能无法获取温度信息）。

    • tls:

      • 当为 true 时启用 Agent 与 Dashboard 间的通信 SSL/TLS 加密。
      • 如果 Agent 使用 Nginx 反向代理且启用了 SSL/TLS 配置，请开启此选项。

    • use_gitee_to_upgrade:

      • 当为 true 时使用 Gitee 仓库作为自动更新源，对中国大陆服务器更为友好。

    • use_ipv6_country_code:

      • 当为 true 时强制使用 IPv6 地址查询国家代码（默认使用 IPv4）。

    • uuid:

      • 当前 Agent 的唯一标识参数，用于 Dashboard 识别数据来源。
      • 若需替换 Dashboard 中已存在的 Agent，可以手动设置此参数。

    保存生效 ​

    在修改配置文件中的参数后，需要重新启动 Agent 服务以使更改生效。具体操作如下：

    1. 重新启动服务
      运行以下命令重新启动默认的第一个 Agent 服务：

      shell
      sudo systemctl restart nezha-agent.service

    2. 多 Agent 服务的情况
      如果同一服务器上运行了多个 Agent 服务，请先列出所有 Agent 服务的名称：

      shell
      sudo systemctl list-units --type=service | grep nezha-agent

      然后分别使用以下命令重新启动对应的 Agent 服务：

      shell
      sudo systemctl restart <service-name>

      将 <service-name> 替换为实际的服务名称，例如 nezha-agent@2.service。

    + \ No newline at end of file diff --git a/guide/q8.html b/guide/q8.html index d37dc51b..366f0e4e 100644 --- a/guide/q8.html +++ b/guide/q8.html @@ -12,7 +12,7 @@ - + @@ -27,8 +27,8 @@ ClientID: 3516291f53eca9b4901a01337e41be7dc52f565c8657d08a3fddb2178d13c5bf ClientSecret: 0568b67c7b6d0ed51c663e2fe935683007c28f947a27b7bd47a5ad3d8b56fb67 Endpoint: "https://xxxxx.cloudflareaccess.com" - Type: cloudflare

    配置说明： ​

    参数获取方式
    AdminMy Team -> Users -> <具体用户> -> User ID
    ClientID/ClientSecretAccess -> Application -> Add an Application
    -> SaaS -> OIDC
    EndpointAccess -> Application -> Application URL -> 只保留协议+域名的部分，路径不需要

    新建 SaaS-OIDC 应用流程 ​

    前往 Zero Trust Dashboard：https://one.dash.cloudflare.com/，选择或新建一个账户（Account），然后按照以下步骤操作：

    1. My Team -> Users -> 点击<具体用户> -> 获取 User ID 并保存 （如果是第一次使用 Zero Trust，Users 列表会为空，可暂时跳过这一步；你需要完成一次验证后，用户才会出现在 Users 列表中）；
    2. Access -> Applications -> Add an Application;
    3. 选择 SaaS，在 Application 字段中输入自定义的应用名称（例如 nezha），选择 OIDC 后点击 Add application;
    4. Scopes 选择 openid, email, profile, groups;
    5. 在 Redirect URLs 中填写你的 Dashboard Callback 地址，例如 https://dashboard.example.com/oauth2/callback;
    6. 分别记录 Client ID、Client Secret 和 Issuer 地址中的协议与域名部分，例如 https://xxxxx.cloudflareaccess.com;
    7. 编辑 Dashboard 配置文件（通常位于 /opt/nezha/dashboard/data/config.yaml），参照示例配置修改 OAuth2 设置，并重启 Dashboard 服务。

    身份验证策略配置 ​

    在完成 Dashboard 设置后，您还需要在 Zero Trust Dashboard 中配置身份验证策略，路径为：Access -> Applications -> <应用名> -> Policies。您可以选择多种 SSO 验证方式，包括邮件 OTP 验证、硬件密钥验证等，详细配置请参考 Cloudflare Zero Trust 文档。

    策略配置示例（One-time PIN） ​

    默认使用邮件 OTP 验证方式：

    1. Access -> Applications -> <应用名> -> Policies -> Add a policy;
    2. 设置一个 Policy Name，例如 OTP，Action 设置为 Allow;
    3. 在 Configure rules 下新增一条 Include 规则，Selector 选择 Emails，在文本框中输入你的邮箱地址；
    4. 点击 Save policy 保存策略。

    测试策略 ​

    1. 在配置正确的情况下，访问 Dashboard 登录界面，会显示为 使用 Cloudflare 账号登录，点击登录会跳转到 Cloudflare Access 登录页面；
    2. 输入前面配置的 Email 地址，点击 Send me a code，输入收到的验证码，即可登录 Dashboard；
    3. 如果在之前的步骤中，未在 Admin 中未填写 User ID，登录后会提示错误信息：“该用户不是本站点管理员，无法登录”。此时需要在 My Team -> Users 中找到对应的用户，点击用户名获取 User ID 并填写到 Dashboard 配置文件里的 Admin 部分，重启 Dashboard 服务后再次尝试登录。
    - + Type: cloudflare

    配置说明： ​

    参数获取方式
    AdminMy Team -> Users -> <具体用户> -> User ID
    ClientID/ClientSecretAccess -> Application -> Add an Application
    -> SaaS -> OIDC
    EndpointAccess -> Application -> Application URL -> 只保留协议+域名的部分，路径不需要

    新建 SaaS-OIDC 应用流程 ​

    前往 Zero Trust Dashboard：https://one.dash.cloudflare.com/，选择或新建一个账户（Account），然后按照以下步骤操作：

    1. My Team -> Users -> 点击<具体用户> -> 获取 User ID 并保存 （如果是第一次使用 Zero Trust，Users 列表会为空，可暂时跳过这一步；你需要完成一次验证后，用户才会出现在 Users 列表中）；
    2. Access -> Applications -> Add an Application;
    3. 选择 SaaS，在 Application 字段中输入自定义的应用名称（例如 nezha），选择 OIDC 后点击 Add application;
    4. Scopes 选择 openid, email, profile, groups;
    5. 在 Redirect URLs 中填写你的 Dashboard Callback 地址，例如 https://dashboard.example.com/oauth2/callback;
    6. 分别记录 Client ID、Client Secret 和 Issuer 地址中的协议与域名部分，例如 https://xxxxx.cloudflareaccess.com;
    7. 编辑 Dashboard 配置文件（通常位于 /opt/nezha/dashboard/data/config.yaml），参照示例配置修改 OAuth2 设置，并重启 Dashboard 服务。

    身份验证策略配置 ​

    在完成 Dashboard 设置后，您还需要在 Zero Trust Dashboard 中配置身份验证策略，路径为：Access -> Applications -> <应用名> -> Policies。您可以选择多种 SSO 验证方式，包括邮件 OTP 验证、硬件密钥验证等，详细配置请参考 Cloudflare Zero Trust 文档。

    策略配置示例（One-time PIN） ​

    默认使用邮件 OTP 验证方式：

    1. Access -> Applications -> <应用名> -> Policies -> Add a policy;
    2. 设置一个 Policy Name，例如 OTP，Action 设置为 Allow;
    3. 在 Configure rules 下新增一条 Include 规则，Selector 选择 Emails，在文本框中输入你的邮箱地址；
    4. 点击 Save policy 保存策略。

    测试策略 ​

    1. 在配置正确的情况下，访问 Dashboard 登录界面，会显示为 使用 Cloudflare 账号登录，点击登录会跳转到 Cloudflare Access 登录页面；
    2. 输入前面配置的 Email 地址，点击 Send me a code，输入收到的验证码，即可登录 Dashboard；
    3. 如果在之前的步骤中，未在 Admin 中未填写 User ID，登录后会提示错误信息：“该用户不是本站点管理员，无法登录”。此时需要在 My Team -> Users 中找到对应的用户，点击用户名获取 User ID 并填写到 Dashboard 配置文件里的 Admin 部分，重启 Dashboard 服务后再次尝试登录。
    + \ No newline at end of file diff --git a/guide/q9.html b/guide/q9.html index 2c505b82..d420fc69 100644 --- a/guide/q9.html +++ b/guide/q9.html @@ -12,7 +12,7 @@ - + @@ -35,8 +35,8 @@ cmake .. make -j $(nproc) # 安装库文件和头文件，默认安装到 /opt/rocm -sudo make install - +sudo make install + \ No newline at end of file diff --git a/guide/servers.html b/guide/servers.html index 875e4c1d..9baf52bc 100644 --- a/guide/servers.html +++ b/guide/servers.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    服务器 ​

    介绍 ​

    服务器区域负责管理 Agent，是哪吒探针最基础的功能模块，同时也是其他功能的核心基础。

    安装命令 ​

    请参考前文 安装 Agent。
    推荐使用一键安装方式，即配置好参数后，在 Dashboard 的服务器页面中点击安装命令图标，复制生成的安装命令并在对应服务器上运行完成安装。

    强制更新 ​

    Agent 的更新行为由以下两个参数控制：

    • --disable-auto-update：关闭自动更新。
    • --disable-force-update：禁用强制更新。

    默认行为 ​

    在默认情况下，Agent 会自动更新，无需手动干预。

    手动强制更新 ​

    如果用户关闭了自动更新功能，可以通过选择指定服务器并执行强制更新操作来更新 Agent。
    注意：当 --disable-force-update 参数启用时，强制更新功能将失效。

    数据列说明 ​

    Dashboard 中服务器页面的数据列字段说明：

    • 版本：显示当前 Agent 的版本号。
    • 启用动态域名解析：为 True 时，Dashboard 会在服务器 IP 变更时自动更新 DNS 记录。
    • 对游客隐藏：为 True 时，此服务器在面板中对游客不可见。
    • 备注：
      • 私有备注：仅通过身份验证的用户可见。
      • 公开备注：所有用户均可见，适合展示通用信息。
      • 用户可根据需要自定义备注内容，具体参考 公开备注示例。
    • 命令行：提供 WebShell 和文件管理器功能。用户可直接通过 Dashboard 远程运行命令、管理文件，并支持文件上传和下载。

    在线终端 ​

    在线终端（WebShell）允许用户通过 Dashboard 远程访问服务器的命令行界面，支持 Linux 和 Windows 系统。

    • 快捷操作：可使用 Ctrl+Shift+V 粘贴命令。
    • 限制说明：当 disable-command-execute 参数启用时，在线终端功能将不可用。
    • 连接问题：若连接失败，请参考 Websocket 连接失败 文档解决。

    公开备注示例 ​

    本节旧内容在 V1 版本后废弃，等待更新

    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    服务器 ​

    介绍 ​

    服务器区域负责管理 Agent，是哪吒探针最基础的功能模块，同时也是其他功能的核心基础。

    安装命令 ​

    请参考前文 安装 Agent。
    推荐使用一键安装方式，即配置好参数后，在 Dashboard 的服务器页面中点击安装命令图标，复制生成的安装命令并在对应服务器上运行完成安装。

    强制更新 ​

    Agent 的更新行为由以下两个参数控制：

    • --disable-auto-update：关闭自动更新。
    • --disable-force-update：禁用强制更新。

    默认行为 ​

    在默认情况下，Agent 会自动更新，无需手动干预。

    手动强制更新 ​

    如果用户关闭了自动更新功能，可以通过选择指定服务器并执行强制更新操作来更新 Agent。
    注意：当 --disable-force-update 参数启用时，强制更新功能将失效。

    数据列说明 ​

    Dashboard 中服务器页面的数据列字段说明：

    • 版本：显示当前 Agent 的版本号。
    • 启用动态域名解析：为 True 时，Dashboard 会在服务器 IP 变更时自动更新 DNS 记录。
    • 对游客隐藏：为 True 时，此服务器在面板中对游客不可见。
    • 备注：
      • 私有备注：仅通过身份验证的用户可见。
      • 公开备注：所有用户均可见，适合展示通用信息。
      • 用户可根据需要自定义备注内容，具体参考 公开备注示例。
    • 命令行：提供 WebShell 和文件管理器功能。用户可直接通过 Dashboard 远程运行命令、管理文件，并支持文件上传和下载。

    在线终端 ​

    在线终端（WebShell）允许用户通过 Dashboard 远程访问服务器的命令行界面，支持 Linux 和 Windows 系统。

    • 快捷操作：可使用 Ctrl+Shift+V 粘贴命令。
    • 限制说明：当 disable-command-execute 参数启用时，在线终端功能将不可用。
    • 连接问题：若连接失败，请参考 Websocket 连接失败 文档解决。

    公开备注示例 ​

    本节旧内容在 V1 版本后废弃，等待更新

    + \ No newline at end of file diff --git a/guide/services.html b/guide/services.html index f3fea6fa..9ec15edc 100644 --- a/guide/services.html +++ b/guide/services.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    服务监控 ​

    服务区域是设置 Agent 监控外部网站或服务器功能的设置区。
    通过已设置的服务监控，你可以在主页中点击 服务 按钮，查看过去 30 天的可用性监控结果。

    使用方法 ​

    新增服务监控 ​

    要新增一个服务监控，请按照以下步骤操作：

    1. 进入管理面板
      转到 服务 页，点击 + 按钮添加新的服务监控。

    2. 配置参数
      在新增监控时，设置以下参数：

      • 名称：为此服务自定义一个名称。
      • 目标：根据监控类型设置目标：
        • HTTP GET：输入完整 URL（需包含 http:// 或 https://），例如：https://example.com。
          注意：如果目标 URL 使用 https://，哪吒监控将同时监控该 URL 的 SSL 证书（如证书到期或变更将触发通知）。
        • ICMP Ping：输入域名或 IP 地址（不含端口号），例如：1.1.1.1 或 example.com。
        • TCP Ping：输入域名或 IP 地址并添加端口号，例如：1.1.1.1:80 或 example.com:22。
      • 类型：选择监控类型（HTTP GET、ICMP Ping 或 TCP Ping）。
      • 服务中显示：选择是否向游客显示此监控（隐私性选项）。
      • 间隔：设置监控间隔时间（单位：秒）。
      • 覆盖范围：选择一条规则来确定哪些 Agent 请求目标。
      • 特定服务器：指定覆盖范围内需要使用的 Agent。
      • 通知组 ID：选择已在 通知 页中配置的通知方式，详见 通知方式配置。
      • 启用失败通知：可选择在目标故障时接收通知（默认为不启用）。

    3. 提交监控
      点击 提交 按钮保存配置，稍等片刻后返回主页查看监控结果。

    延迟变化通知 ​

    哪吒监控会统计并监测 Agent 到目标服务器之间的延迟。当延迟发生显著变化时，可以发送通知帮助你监控线路状态。

    • 启用延迟通知：选择启用后，当延迟超出设置的范围（大于 最高延迟 或小于 最低延迟）时将发送通知。

    通知时触发任务 ​

    如果需要在服务监控触发通知时执行特定任务，可以：

    1. 勾选 启用触发任务。
    2. 配置：
      • 触发警报的任务：选择警报触发时执行的任务。
      • 恢复后要触发的任务：选择服务恢复正常后执行的任务。

    提前在任务页中设置好任务配置后即可使用此功能。

    网络延迟图表 ​

    对于 TCP-Ping 和 ICMP-Ping 类型的监控，Dashboard 会自动生成网络延迟统计图表：

    • 进入对应服务器的详情页，切换到 网络 标签。
    • 查看历史网络延迟变化趋势，数据基于 Agent 到目标服务器的实时延迟统计生成。

    管理监控 ​

    如需编辑或删除已有服务监控：

    1. 进入管理面板中的 服务 页。
    2. 找到目标监控配置。
    3. 点击右侧的编辑或删除图标，进行修改或移除。
    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    服务监控 ​

    服务区域是设置 Agent 监控外部网站或服务器功能的设置区。
    通过已设置的服务监控，你可以在主页中点击 服务 按钮，查看过去 30 天的可用性监控结果。

    使用方法 ​

    新增服务监控 ​

    要新增一个服务监控，请按照以下步骤操作：

    1. 进入管理面板
      转到 服务 页，点击 + 按钮添加新的服务监控。

    2. 配置参数
      在新增监控时，设置以下参数：

      • 名称：为此服务自定义一个名称。
      • 目标：根据监控类型设置目标：
        • HTTP GET：输入完整 URL（需包含 http:// 或 https://），例如：https://example.com。
          注意：如果目标 URL 使用 https://，哪吒监控将同时监控该 URL 的 SSL 证书（如证书到期或变更将触发通知）。
        • ICMP Ping：输入域名或 IP 地址（不含端口号），例如：1.1.1.1 或 example.com。
        • TCP Ping：输入域名或 IP 地址并添加端口号，例如：1.1.1.1:80 或 example.com:22。
      • 类型：选择监控类型（HTTP GET、ICMP Ping 或 TCP Ping）。
      • 服务中显示：选择是否向游客显示此监控（隐私性选项）。
      • 间隔：设置监控间隔时间（单位：秒）。
      • 覆盖范围：选择一条规则来确定哪些 Agent 请求目标。
      • 特定服务器：指定覆盖范围内需要使用的 Agent。
      • 通知组 ID：选择已在 通知 页中配置的通知方式，详见 通知方式配置。
      • 启用失败通知：可选择在目标故障时接收通知（默认为不启用）。

    3. 提交监控
      点击 提交 按钮保存配置，稍等片刻后返回主页查看监控结果。

    延迟变化通知 ​

    哪吒监控会统计并监测 Agent 到目标服务器之间的延迟。当延迟发生显著变化时，可以发送通知帮助你监控线路状态。

    • 启用延迟通知：选择启用后，当延迟超出设置的范围（大于 最高延迟 或小于 最低延迟）时将发送通知。

    通知时触发任务 ​

    如果需要在服务监控触发通知时执行特定任务，可以：

    1. 勾选 启用触发任务。
    2. 配置：
      • 触发警报的任务：选择警报触发时执行的任务。
      • 恢复后要触发的任务：选择服务恢复正常后执行的任务。

    提前在任务页中设置好任务配置后即可使用此功能。

    网络延迟图表 ​

    对于 TCP-Ping 和 ICMP-Ping 类型的监控，Dashboard 会自动生成网络延迟统计图表：

    • 进入对应服务器的详情页，切换到 网络 标签。
    • 查看历史网络延迟变化趋势，数据基于 Agent 到目标服务器的实时延迟统计生成。

    管理监控 ​

    如需编辑或删除已有服务监控：

    1. 进入管理面板中的 服务 页。
    2. 找到目标监控配置。
    3. 点击右侧的编辑或删除图标，进行修改或移除。
    + \ No newline at end of file diff --git a/guide/settings.html b/guide/settings.html index a0cd3a2a..bb6ba973 100644 --- a/guide/settings.html +++ b/guide/settings.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    设置 ​

    登录管理页面后，点击头像 → 系统设置，即可进入设置页面。

    站点名称 ​

    在此项中可以自定义站点标题，便于识别和管理。

    语言设置 ​

    哪吒监控目前支持以下语言：

    • 简体中文
    • 繁體中文
    • English
    • Español

    我们欢迎您对翻译进行勘误，或贡献更多语言支持。

    自定义代码 ​

    此项用于在游客页面中添加自定义样式或脚本代码，例如修改 LOGO、调整色调、添加美化代码或统计代码。

    WARNING

    自定义代码仅在游客首页生效，管理面板中不生效。
    若需要修改管理面板内容，请手动修改 Docker 容器中的主题文件。

    仪表板服务器域名/IP（无 CDN） ​

    • 此项为使用一键脚本安装 Agent 的必要设置。
    • 设置内容需为无 CDN 的域名或 IP，例如：data.example.com。
    • 详情请参考 Agent 安装准备工作。

    前台查看密码 ​

    若不希望游客直接访问 Dashboard，可以在此设置一个查看密码。
    设置完成后，访问主页需要输入密码。

    真实 IP 请求头 ​

    • CF-Connecting-IP 是一个用于获取访问者真实 IP 的请求头字段。
    • 当通过 Cloudflare CDN 代理访问 Dashboard 时，启用此功能可以让源服务器正确识别访问者的真实 IP。
      • 用途：便于进行安全审计、防火墙规则配置和日志记录。

    DANGER

    1. 慎重配置 Header
      真实 IP 请求头的配置涉及内置 WAF（Web 应用防火墙）的正常运作。
      如果您不了解 Header 的传递方式，请勿随意修改。错误配置可能导致 IP 被内置 WAF 封禁。

    2. 防止账户爆破攻击
      内置 WAF 旨在防止本地账户爆破。

      • 如果本地账户未设置任何防护，可能导致高频密码枚举攻击（如每秒尝试 100 个密码）。
      • WAF 的 IP 识别依赖于正确配置的请求头，以有效拦截此类攻击。

    3. 安全建议
      确保您了解 Header 的实际传递机制后再启用此功能，并仔细验证配置结果。

    IP 变更提醒 ​

    此功能允许在服务器 IP 地址变更时发送通知，设置步骤如下：

    配置选项 ​

    1. 覆盖范围
      选择一条规则以确定需要监控哪些服务器。

    2. 特定服务器
      配合覆盖范围设置，可以为选定规则添加排除项。

    3. 提醒发送至通知分组
      选择通知方式（通知方式需提前在“通知”页中设置）。

    4. 启用功能
      设置完成后，勾选 启用 才会使通知生效。

    5. 通知中显示完整 IP 地址
      默认情况下，IP 变更通知会隐藏完整 IP 地址。
      如需显示完整 IP 地址，可勾选此选项。

    用户管理 ​

    此标签页允许为 Dashboard 添加多个用户。

    • 可以添加多个用户，便于多人协作管理。
    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    设置 ​

    登录管理页面后，点击头像 → 系统设置，即可进入设置页面。

    站点名称 ​

    在此项中可以自定义站点标题，便于识别和管理。

    语言设置 ​

    哪吒监控目前支持以下语言：

    • 简体中文
    • 繁體中文
    • English
    • Español

    我们欢迎您对翻译进行勘误，或贡献更多语言支持。

    自定义代码 ​

    此项用于在游客页面中添加自定义样式或脚本代码，例如修改 LOGO、调整色调、添加美化代码或统计代码。

    WARNING

    自定义代码仅在游客首页生效，管理面板中不生效。
    若需要修改管理面板内容，请手动修改 Docker 容器中的主题文件。

    仪表板服务器域名/IP（无 CDN） ​

    • 此项为使用一键脚本安装 Agent 的必要设置。
    • 设置内容需为无 CDN 的域名或 IP，例如：data.example.com。
    • 详情请参考 Agent 安装准备工作。

    前台查看密码 ​

    若不希望游客直接访问 Dashboard，可以在此设置一个查看密码。
    设置完成后，访问主页需要输入密码。

    真实 IP 请求头 ​

    • CF-Connecting-IP 是一个用于获取访问者真实 IP 的请求头字段。
    • 当通过 Cloudflare CDN 代理访问 Dashboard 时，启用此功能可以让源服务器正确识别访问者的真实 IP。
      • 用途：便于进行安全审计、防火墙规则配置和日志记录。

    DANGER

    1. 慎重配置 Header
      真实 IP 请求头的配置涉及内置 WAF（Web 应用防火墙）的正常运作。
      如果您不了解 Header 的传递方式，请勿随意修改。错误配置可能导致 IP 被内置 WAF 封禁。

    2. 防止账户爆破攻击
      内置 WAF 旨在防止本地账户爆破。

      • 如果本地账户未设置任何防护，可能导致高频密码枚举攻击（如每秒尝试 100 个密码）。
      • WAF 的 IP 识别依赖于正确配置的请求头，以有效拦截此类攻击。

    3. 安全建议
      确保您了解 Header 的实际传递机制后再启用此功能，并仔细验证配置结果。

    IP 变更提醒 ​

    此功能允许在服务器 IP 地址变更时发送通知，设置步骤如下：

    配置选项 ​

    1. 覆盖范围
      选择一条规则以确定需要监控哪些服务器。

    2. 特定服务器
      配合覆盖范围设置，可以为选定规则添加排除项。

    3. 提醒发送至通知分组
      选择通知方式（通知方式需提前在“通知”页中设置）。

    4. 启用功能
      设置完成后，勾选 启用 才会使通知生效。

    5. 通知中显示完整 IP 地址
      默认情况下，IP 变更通知会隐藏完整 IP 地址。
      如需显示完整 IP 地址，可勾选此选项。

    用户管理 ​

    此标签页允许为 Dashboard 添加多个用户。

    • 可以添加多个用户，便于多人协作管理。
    + \ No newline at end of file diff --git a/guide/tasks.html b/guide/tasks.html index 058b88b9..e578aad4 100644 --- a/guide/tasks.html +++ b/guide/tasks.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    任务管理 ​

    任务管理区域支持设置计划任务、触发任务以及多服务器批量执行任务。
    哪吒监控允许推送命令到 Agent 执行，支持多种场景，包括且不仅限于：

    • 定期使用 restic、rclone 备份服务器数据。
    • 定期重启服务以重置网络连接。
    • 配合通知规则触发任务，例如在 CPU 长时间高占用时运行某个脚本。

    使用方法 ​

    添加任务 ​

    1. 进入任务页面
      在管理面板中进入 任务 页，点击 + 按钮新增任务。

    2. 填写任务参数
      添加任务时需要配置以下参数：

      • 名称：为任务自定义一个名称，便于管理和识别。
      • 任务类型：
        • 计划任务：按设置的计划时间周期性执行任务。
        • 触发任务：任务仅通过 API 或通知规则触发，每次触发执行一次。
      • 计划：任务执行的时间计划（仅计划任务生效），格式为：秒 分 时 天 月 星期。
        详情参考 计划表达式格式。
        示例：0 0 3 * * * 表示每天凌晨 3 点执行。
      • 命令：需要执行的命令。
        • 命令格式与 Shell/Bat 脚本相同，多个命令可用 &&（Linux）或 &（Windows）连接。
        • 示例：重启服务器输入 reboot。
      • 覆盖范围 和 特定服务器：指定哪些 Agent 执行任务：
        • 可选择规则覆盖范围或特定服务器。
        • 对于触发任务，可选择“在触发通知的服务器上执行”。
      • 通知方式组：选择已在 通知 页配置的通知方式，详见 通知方式配置。

    3. 提交任务
      填写完成后，点击 提交 保存任务。

    管理任务 ​

    如需管理已有任务：

    1. 前往 任务 页，找到目标任务。
    2. 使用右侧的功能图标：
      • 立即执行：忽略计划时间，立即执行任务。
      • 编辑：修改任务配置。
      • 删除：移除该任务。

    常见问题 ​

    1. xxx 命令找不到 ​

    • 运行失败提示 “xxx 命令找不到”，通常是因为 PATH 环境变量未正确加载。
    • 解决方法：
      • 在 Linux 中，可在命令前加 source ~/.bashrc：
        bash
        source ~/.bashrc && your_command
      • 或直接使用绝对路径执行命令（例如 /usr/bin/command）。
    - +
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    任务管理 ​

    任务管理区域支持设置计划任务、触发任务以及多服务器批量执行任务。
    哪吒监控允许推送命令到 Agent 执行，支持多种场景，包括且不仅限于：

    • 定期使用 restic、rclone 备份服务器数据。
    • 定期重启服务以重置网络连接。
    • 配合通知规则触发任务，例如在 CPU 长时间高占用时运行某个脚本。

    使用方法 ​

    添加任务 ​

    1. 进入任务页面
      在管理面板中进入 任务 页，点击 + 按钮新增任务。

    2. 填写任务参数
      添加任务时需要配置以下参数：

      • 名称：为任务自定义一个名称，便于管理和识别。
      • 任务类型：
        • 计划任务：按设置的计划时间周期性执行任务。
        • 触发任务：任务仅通过 API 或通知规则触发，每次触发执行一次。
      • 计划：任务执行的时间计划（仅计划任务生效），格式为：秒 分 时 天 月 星期。
        详情参考 计划表达式格式。
        示例：0 0 3 * * * 表示每天凌晨 3 点执行。
      • 命令：需要执行的命令。
        • 命令格式与 Shell/Bat 脚本相同，多个命令可用 &&（Linux）或 &（Windows）连接。
        • 示例：重启服务器输入 reboot。
      • 覆盖范围 和 特定服务器：指定哪些 Agent 执行任务：
        • 可选择规则覆盖范围或特定服务器。
        • 对于触发任务，可选择“在触发通知的服务器上执行”。
      • 通知方式组：选择已在 通知 页配置的通知方式，详见 通知方式配置。

    3. 提交任务
      填写完成后，点击 提交 保存任务。

    管理任务 ​

    如需管理已有任务：

    1. 前往 任务 页，找到目标任务。
    2. 使用右侧的功能图标：
      • 立即执行：忽略计划时间，立即执行任务。
      • 编辑：修改任务配置。
      • 删除：移除该任务。

    常见问题 ​

    1. xxx 命令找不到 ​

    • 运行失败提示 “xxx 命令找不到”，通常是因为 PATH 环境变量未正确加载。
    • 解决方法：
      • 在 Linux 中，可在命令前加 source ~/.bashrc：
        bash
        source ~/.bashrc && your_command
      • 或直接使用绝对路径执行命令（例如 /usr/bin/command）。
    + \ No newline at end of file diff --git a/hashmap.json b/hashmap.json index 9455e4f0..4d5ec9a9 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"case_case4.md":"CXto-okl","case_case2.md":"BpKrYqP-","en_us_guide_nat.md":"3ipBwYV4","en_us_guide_servers.md":"BqD1VgDn","en_us_guide_dashboard.md":"Bjr4AhFC","en_us_guide_services.md":"ClZ_x92A","case_case3.md":"DuwCIGQb","en_us_guide_ddns.md":"BMnemOVM","en_us_guide_loginq.md":"C99vyzYh","en_us_guide_q10.md":"CzwdIjHC","en_us_guide_q8.md":"DCyIruCu","en_us_case_case3.md":"D_0H_Yfy","en_us_developer_index.md":"Dn9U3265","en_us_case_index.md":"BoiWbPsb","en_us_guide_q5.md":"BLPb-dkk","en_us_guide_q4.md":"BpcOcq-c","en_us_guide_q7.md":"APZnlBuL","en_us_guide_agentq.md":"BkyR0FBx","en_us_guide_q9.md":"CAmgzs00","en_us_guide_api.md":"cXcFxIK9","en_us_case_case1.md":"BWd47m_m","developer_theme.md":"CnqVR0Pr","developer_index.md":"StLfv4EA","en_us_developer_theme.md":"DJoIeh2J","developer_l10n.md":"DWpbCSE2","en_us_case_case2.md":"MEfIUzXU","en_us_guide_q3.md":"CtIAvgB7","case_index.md":"BMcGcKCT","en_us_guide_q6.md":"CqYbiqYp","en_us_case_case6.md":"dZg_cPuX","en_us_guide_q11.md":"B0DZElYz","case_case5.md":"4z-WCS1d","en_us_guide_q2.md":"BHlEQiS_","case_case1.md":"B9poWoiH","en_us_case_case5.md":"C-8AxizL","en_us_guide_agent.md":"FHT_o8SS","en_us_guide_notifications.md":"Bhfh6XwZ","guide_q10.md":"Ixo-DYaa","guide_q2.md":"B82wgSzB","guide_q4.md":"Bz5I84Ti","guide_q1.md":"Mbskxx2B","guide_q11.md":"D96jSESF","guide_q6.md":"D7QPaDgD","guide_q7.md":"BP2RBJET","guide_servers.md":"Bl0Rq6yR","guide_q8.md":"5ESBk7BN","guide_services.md":"C4NYxKIR","guide_q9.md":"DB1LwNtN","guide_tasks.md":"VRbXgI3V","guide_settings.md":"BRUqOnoT","index.md":"BcO2j5Se","en_us_guide_dashboardq.md":"CvqutlhT","en_us_guide_tasks.md":"EjbvucLw","guide_q3.md":"BSrjgNCb","guide_loginq.md":"D_lVzqSk","guide_group.md":"DJ7hI4Nb","en_us_case_case4.md":"BcRIl0yT","case_case7.md":"DJ_vIrr3","guide_q5.md":"BDbPvayS","guide_dashboardq.md":"O8dentOb","guide_nat.md":"p8beQD-y","guide_notifications.md":"CjlnAqA6","en_us_developer_l10n.md":"CwiS7FZZ","en_us_guide_settings.md":"BaoPDnBg","guide_agentq.md":"C76Aq2js","case_case6.md":"CFQ8_6vY","guide_agent.md":"ClraF2r0","guide_api.md":"cRFvi26D","en_us_index.md":"qJ8oWAP5","guide_dashboard.md":"UDWxcaBD","guide_ddns.md":"Dnc04eyv","en_us_case_case7.md":"CqiR3Gyi"} +{"en_us_guide_q10.md":"Ux9pHrep","developer_theme.md":"Ckz8hyyD","en_us_developer_index.md":"B3YfUGsU","case_case6.md":"C_54h5oe","en_us_case_case3.md":"DrOE6o9H","en_us_guide_agentq.md":"CEbylkU1","en_us_guide_settings.md":"CVW2Zp9-","en_us_guide_q3.md":"Dh3mnqfL","en_us_case_case2.md":"9gRKyIdW","en_us_guide_q4.md":"c1Qz7KAv","guide_group.md":"BbROWQSH","guide_dashboardq.md":"BFhtwPZr","case_case2.md":"BViuX1X4","guide_q1.md":"CXzx3Tnf","en_us_guide_nat.md":"CM8Rfh1E","en_us_guide_q7.md":"DCmSH6k4","guide_q11.md":"Cty1fEud","guide_notifications.md":"COjj8Bt_","guide_q10.md":"CVV7XCHw","guide_q4.md":"DZbhDtP8","guide_q2.md":"C9O8k1Zw","guide_q6.md":"BB0f9_9W","guide_q7.md":"C4KjeJJ8","guide_q3.md":"BxszPYJD","guide_settings.md":"BdtvsBbr","guide_tasks.md":"D8u5g2JZ","guide_services.md":"oqYCKLpS","index.md":"BalsgmiL","en_us_developer_theme.md":"D4mBFp1x","en_us_guide_q5.md":"DwTpamMq","en_us_guide_q11.md":"BmUheUV4","en_us_guide_services.md":"Cx7zVVv4","developer_index.md":"CuaVrhgY","en_us_guide_q2.md":"CxDJ0aGD","case_case1.md":"BkOtCvls","developer_l10n.md":"d0vjFxi6","guide_agent.md":"CZh6z3dl","case_index.md":"D98y31Eb","case_case4.md":"Dy49O6NN","en_us_guide_notifications.md":"BOxjPE2Z","en_us_guide_servers.md":"BX5cKzLH","en_us_guide_tasks.md":"BTwz4fmx","case_case5.md":"BKRp8Yf4","en_us_case_case1.md":"C2WqGMx8","guide_q8.md":"N2FEFGQO","en_us_guide_agent.md":"G69D4bG1","en_us_index.md":"DxQHyDKB","en_us_guide_q6.md":"DOaVy26o","guide_agentq.md":"JvObN8Ip","en_us_guide_ddns.md":"Dw1k13mk","en_us_case_case6.md":"D0s7jzQO","guide_api.md":"Cy0K92kx","guide_dashboard.md":"CtQv2zOs","guide_ddns.md":"ByIc9eJ0","en_us_case_case5.md":"Ret5X66G","en_us_guide_dashboard.md":"rLfT63xV","en_us_guide_dashboardq.md":"C9BOMoaE","en_us_case_case4.md":"CNUV74Br","guide_nat.md":"Bh9mhuQ2","en_us_guide_q9.md":"c1L-3_eS","en_us_guide_loginq.md":"CH4756jr","guide_q5.md":"gYPzy780","en_us_developer_l10n.md":"BWjfIUVn","guide_servers.md":"D35_d1jD","en_us_guide_q8.md":"D9GNExaP","en_us_case_index.md":"B9dR1rfW","guide_q9.md":"dfq53_F3","case_case3.md":"BH0S5H4a","en_us_guide_api.md":"ChtD4_vy","case_case7.md":"DnCzHV6b","en_us_case_case7.md":"Du0bNPj-","guide_loginq.md":"Cut2Cgyq"} diff --git a/index.html b/index.html index 23f8a3b6..f4b6cc3f 100644 --- a/index.html +++ b/index.html @@ -12,7 +12,7 @@ - + @@ -23,7 +23,7 @@
    哪吒服务器监控

    简体中文

    English

    简体中文

    English

    Appearance

    哪吒监控

    开源、轻量、易用的服务器监控与运维工具

    预览
    开始使用 →

    一键安装

    支持一键安装面板和监控服务，操作便捷。兼容主流系统，包括 Linux、Windows、macOS、OpenWRT 以及群晖。

    实时监控

    支持同时监控多个服务器的状态，提供历史网络状态和延迟图表，监控网页、端口可用性和 SSL 证书状态。支持故障和流量等状态告警，可通过 Telegram、邮件、微信等多种方式提醒。

    轻松运维

    提供 API 获取服务器状态，支持WebSSH、DDNS 和流量监控。可设置定时和触发任务，并批量执行服务器任务。

    - + \ No newline at end of file