diff --git a/404.html b/404.html index cdd11fc0..9b924270 100644 --- a/404.html +++ b/404.html @@ -11,9 +11,9 @@ -
哪吒监控

简体中文

English

简体中文

English

Appearance

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.
Take me home
- +
哪吒监控

简体中文

English

简体中文

English

Appearance

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.
Take me home
+ \ No newline at end of file diff --git a/assets/case_case1.md.7e8fc212.js b/assets/case_case1.md.375dc3eb.js similarity index 95% rename from assets/case_case1.md.7e8fc212.js rename to assets/case_case1.md.375dc3eb.js index 6286cc8a..cd04a3dc 100644 --- a/assets/case_case1.md.7e8fc212.js +++ b/assets/case_case1.md.375dc3eb.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,R as r}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1687213975000}'),o={name:"case/case1.md"},_=r('

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

贡献者:

项目地址：nezha_api_tgbot

镜像备份（非实时更新）：nezha_api_tgbot
机器人可以通过API向面板请求服务器状态信息，得到信息后发送给用户
你可以搭建此机器人来方便地查看指定服务器的当前状态且不需要打开面板

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

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

贡献者:

项目地址：nezha_api_tgbot

镜像备份（非实时更新）：nezha_api_tgbot
机器人可以通过API向面板请求服务器状态信息，得到信息后发送给用户
你可以搭建此机器人来方便地查看指定服务器的当前状态且不需要打开面板

',5),s=[_];function i(n,c,p,h,l,d){return t(),a("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default}; diff --git a/assets/case_case1.md.7e8fc212.lean.js b/assets/case_case1.md.375dc3eb.lean.js similarity index 85% rename from assets/case_case1.md.7e8fc212.lean.js rename to assets/case_case1.md.375dc3eb.lean.js index d06d1d9d..479bb75c 100644 --- a/assets/case_case1.md.7e8fc212.lean.js +++ b/assets/case_case1.md.375dc3eb.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,R as r}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1687213975000}'),o={name:"case/case1.md"},_=r("",5),s=[_];function i(n,c,p,h,l,d){return t(),a("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default}; +import{_ as e,o as t,c as a,R as r}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1687756292000}'),o={name:"case/case1.md"},_=r("",5),s=[_];function i(n,c,p,h,l,d){return t(),a("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default}; diff --git a/assets/case_case2.md.e0420bb1.js b/assets/case_case2.md.f7e058fc.js similarity index 97% rename from assets/case_case2.md.e0420bb1.js rename to assets/case_case2.md.f7e058fc.js index 572f82ac..24b1c619 100644 --- a/assets/case_case2.md.e0420bb1.js +++ b/assets/case_case2.md.f7e058fc.js @@ -1 +1 @@ -import{_ as a}from"./chunks/qrcode.59c44dde.js";import{_ as e,o as r,c as i,R as t}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1687213975000}'),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 r(),i("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; +import{_ as a}from"./chunks/qrcode.59c44dde.js";import{_ as e,o as r,c as i,R as t}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1687756292000}'),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 r(),i("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; diff --git a/assets/case_case2.md.e0420bb1.lean.js b/assets/case_case2.md.f7e058fc.lean.js similarity index 87% rename from assets/case_case2.md.e0420bb1.lean.js rename to assets/case_case2.md.f7e058fc.lean.js index efffd5cc..fa39332c 100644 --- a/assets/case_case2.md.e0420bb1.lean.js +++ b/assets/case_case2.md.f7e058fc.lean.js @@ -1 +1 @@ -import{_ as a}from"./chunks/qrcode.59c44dde.js";import{_ as e,o as r,c as i,R as t}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1687213975000}'),o={name:"case/case2.md"},c=t("",8),s=[c];function l(d,n,h,_,p,m){return r(),i("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; +import{_ as a}from"./chunks/qrcode.59c44dde.js";import{_ as e,o as r,c as i,R as t}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1687756292000}'),o={name:"case/case2.md"},c=t("",8),s=[c];function l(d,n,h,_,p,m){return r(),i("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; diff --git a/assets/case_case3.md.d58c2842.js b/assets/case_case3.md.3eeabd87.js similarity index 98% rename from assets/case_case3.md.d58c2842.js rename to assets/case_case3.md.3eeabd87.js index 5a0e1fe2..2b1122ec 100644 --- a/assets/case_case3.md.d58c2842.js +++ b/assets/case_case3.md.3eeabd87.js @@ -1 +1 @@ -import{_ as t,o as e,c as a,R as r}from"./chunks/framework.1625126e.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1687213975000}'),d={name:"case/case3.md"},l=r('

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

贡献者:

项目地址：nezha_telegram_bot

镜像备份（非实时更新）：nezha_telegram_bot

项目特色 ​

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

命令列表 ​

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

效果展示 ​

imageimage

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

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

贡献者:

项目地址：nezha_telegram_bot

镜像备份（非实时更新）：nezha_telegram_bot

项目特色 ​

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

命令列表 ​

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

效果展示 ​

imageimage

',12),i=[l];function o(h,n,c,s,_,m){return e(),a("div",null,i)}const b=t(d,[["render",o]]);export{f as __pageData,b as default}; diff --git a/assets/case_case3.md.d58c2842.lean.js b/assets/case_case3.md.3eeabd87.lean.js similarity index 86% rename from assets/case_case3.md.d58c2842.lean.js rename to assets/case_case3.md.3eeabd87.lean.js index b236868a..1a027240 100644 --- a/assets/case_case3.md.d58c2842.lean.js +++ b/assets/case_case3.md.3eeabd87.lean.js @@ -1 +1 @@ -import{_ as t,o as e,c as a,R as r}from"./chunks/framework.1625126e.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1687213975000}'),d={name:"case/case3.md"},l=r("",12),i=[l];function o(h,n,c,s,_,m){return e(),a("div",null,i)}const b=t(d,[["render",o]]);export{f as __pageData,b as default}; +import{_ as t,o as e,c as a,R as r}from"./chunks/framework.1625126e.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1687756292000}'),d={name:"case/case3.md"},l=r("",12),i=[l];function o(h,n,c,s,_,m){return e(),a("div",null,i)}const b=t(d,[["render",o]]);export{f as __pageData,b as default}; diff --git a/assets/case_case4.md.fe463edb.js b/assets/case_case4.md.4cb7b388.js similarity index 94% rename from assets/case_case4.md.fe463edb.js rename to assets/case_case4.md.4cb7b388.js index bbd02cd3..77dc3744 100644 --- a/assets/case_case4.md.fe463edb.js +++ b/assets/case_case4.md.4cb7b388.js @@ -1 +1 @@ -import{_ as s,o as t,c as e,R as a}from"./chunks/framework.1625126e.js";const r="/assets/2.38c2ea56.png",n="/assets/5.23139306.png",o="/assets/6.22a61698.png",p="/assets/4.fe6a4e7a.jpg",c="/assets/1.b4b4591f.jpeg",y=JSON.parse('{"title":"重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1687213975000}'),_={name:"case/case4.md"},i=a('

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


2

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


今天开始！找回自信！

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

镜像备份（非实时更新）：Fake Agent

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


男人用了都说好：
6
4


1

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

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


2

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


今天开始！找回自信！

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

镜像备份（非实时更新）：Fake Agent

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


男人用了都说好：
6
4


1

',12),l=[i];function g(f,b,h,m,d,k){return t(),e("div",null,l)}const z=s(_,[["render",g]]);export{y as __pageData,z as default}; diff --git a/assets/case_case4.md.fe463edb.lean.js b/assets/case_case4.md.4cb7b388.lean.js similarity index 79% rename from assets/case_case4.md.fe463edb.lean.js rename to assets/case_case4.md.4cb7b388.lean.js index 1be9149e..2ae968f2 100644 --- a/assets/case_case4.md.fe463edb.lean.js +++ b/assets/case_case4.md.4cb7b388.lean.js @@ -1 +1 @@ -import{_ as s,o as t,c as e,R as a}from"./chunks/framework.1625126e.js";const r="/assets/2.38c2ea56.png",n="/assets/5.23139306.png",o="/assets/6.22a61698.png",p="/assets/4.fe6a4e7a.jpg",c="/assets/1.b4b4591f.jpeg",y=JSON.parse('{"title":"重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1687213975000}'),_={name:"case/case4.md"},i=a("",12),l=[i];function g(f,b,h,m,d,k){return t(),e("div",null,l)}const z=s(_,[["render",g]]);export{y as __pageData,z as default}; +import{_ as s,o as t,c as e,R as a}from"./chunks/framework.1625126e.js";const r="/assets/2.38c2ea56.png",n="/assets/5.23139306.png",o="/assets/6.22a61698.png",p="/assets/4.fe6a4e7a.jpg",c="/assets/1.b4b4591f.jpeg",y=JSON.parse('{"title":"重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1687756292000}'),_={name:"case/case4.md"},i=a("",12),l=[i];function g(f,b,h,m,d,k){return t(),e("div",null,l)}const z=s(_,[["render",g]]);export{y as __pageData,z as default}; diff --git a/assets/case_case5.md.b8d6ff4d.js b/assets/case_case5.md.4b0d5a6c.js similarity index 99% rename from assets/case_case5.md.b8d6ff4d.js rename to assets/case_case5.md.4b0d5a6c.js index d3877152..60eda2bb 100644 --- a/assets/case_case5.md.b8d6ff4d.js +++ b/assets/case_case5.md.4b0d5a6c.js @@ -1,4 +1,4 @@ -import{_ as a,o as e,c as t,R as s}from"./chunks/framework.1625126e.js";const m=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1687213975000}'),n={name:"case/case5.md"},l=s(`

Nezha server over Argo tunnel ​

使用 Argo 隧道的哪吒服务端 贡献者:

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

镜像备份（非实时更新）：Argo-Nezha-Service-Container

目录 ​

项目特点: ​

image

准备需要用的变量 ​

imageimageimageimage

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

imageimageimageimageimage

PaaS 部署实例 ​

镜像 fscarmen/argo-nezha:latest ， 支持 amd64 和 arm64 架构

用到的变量

变量名是否必须备注
GH_USER是github 的用户名，用于面板管理授权
GH_CLIENTID是在 github 上申请
GH_CLIENTSECRET是在 github 上申请
GH_REPO否在 github 上备份哪吒服务端数据库文件的库
GH_EMAIL否github 的邮箱，用于备份的 git 推送到远程库
GH_PAT否github 的 PAT
ARGO_JSON是从 https://fscarmen.cloudflare.now.cc 获取的 Argo Json
DATA_DOMAIN是客户端与服务端的通信 argo 域名
WEB_DOMAIN是面板 argo 域名
SSH_DOMAIN否ssh 用的 argo 域名
SSH_PASSWORD否ssh 的密码，只有在设置 SSH_JSON 后才生效，默认值 password

1.Koyeb

imageimageimageimageimage

VPS 部署实例 ​

docker 部署 ​

docker run -dit \\
+import{_ as a,o as e,c as t,R as s}from"./chunks/framework.1625126e.js";const m=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1687756292000}'),n={name:"case/case5.md"},l=s(`
Nezha server over Argo tunnel ​
使用 Argo 隧道的哪吒服务端 贡献者:
项目地址：Argo-Nezha-Service-Container
镜像备份（非实时更新）：Argo-Nezha-Service-Container
目录 ​
项目特点: ​
  • 适用范围更广 --- 只要能连通网络，就能安装哪吒服务端，如 Nas 虚拟机 , Container PaaS 等
  • Argo 隧道突破需要公网入口的限制 --- 传统的哪吒需要有两个，一个用于面板的访问，另一个用于客户端上报数据，本项目借用 Cloudflare Argo 隧道，使用内网穿透的办法
  • IPv4 / v6 具备更高的灵活性 --- 传统哪吒需要处理服务端和客户端的 IPv4/v6 兼容性问题，还需要通过 warp 等工具来解决不对应的情况。然而，本项目可以完全不需要考虑这些问题，可以任意对接，更加方便和简便
  • 一条 Argo 隧道分流多个域名和协议 --- 建立一条内网穿透的 Argo 隧道，即可分流三个域名(hostname)和协议(protocal)，分别用于面板的访问(http)，客户端上报数据(tcp)和 ssh（可选）
  • Nginx 反向代理的 gRPC 数据端口 --- 配上证书做 tls 终结，然后 Argo 的隧道配置用 https 服务指向这个反向代理，启用http2回源，grpc(nezha)->h2(nginx)->argo->cf cdn edge->agent
  • 每天自动备份 --- 每天 0 时 0 分自动备份整个哪吒面板文件夹到指定的 github 私库，包括面板主题，面板设置，探针数据和隧道信息，备份保留近 30 天数据；鉴于内容十分重要，必须要放在私库
  • 数据更安全 --- Argo 隧道使用TLS加密通信，可以将应用程序流量安全地传输到 Cloudflare 网络，提高了应用程序的安全性和可靠性。此外，Argo Tunnel也可以防止IP泄露和DDoS攻击等网络威胁
image
准备需要用的变量 ​
image
  • 到 Cloudflare 官方，在相应的域名 DNS 记录里加上客户端上报数据(tcp)和 ssh（可选）的域名，打开橙色云启用 CDN
imageimage
  • 到 Cloudflare 官方，选择使用的域名，打开 网络 选项将 gRPC 开关打开
image
面板域名加上 https:// 开头，回调地址再加上 /oauth2/callback 结尾
imageimageimageimageimage
PaaS 部署实例 ​
镜像 fscarmen/argo-nezha:latest ， 支持 amd64 和 arm64 架构
用到的变量
变量名是否必须备注
GH_USER是github 的用户名，用于面板管理授权
GH_CLIENTID是在 github 上申请
GH_CLIENTSECRET是在 github 上申请
GH_REPO否在 github 上备份哪吒服务端数据库文件的库
GH_EMAIL否github 的邮箱，用于备份的 git 推送到远程库
GH_PAT否github 的 PAT
ARGO_JSON是从 https://fscarmen.cloudflare.now.cc 获取的 Argo Json
DATA_DOMAIN是客户端与服务端的通信 argo 域名
WEB_DOMAIN是面板 argo 域名
SSH_DOMAIN否ssh 用的 argo 域名
SSH_PASSWORD否ssh 的密码，只有在设置 SSH_JSON 后才生效，默认值 password
1.Koyeb
imageimageimageimageimage
VPS 部署实例 ​
docker 部署 ​
docker run -dit \\
            --name nezha_dashboard \\
            --restart always \\
            -v ./dashboard:/dashboard \\
diff --git a/assets/case_case5.md.b8d6ff4d.lean.js b/assets/case_case5.md.4b0d5a6c.lean.js
similarity index 85%
rename from assets/case_case5.md.b8d6ff4d.lean.js
rename to assets/case_case5.md.4b0d5a6c.lean.js
index eecb1e54..ef40b2ce 100644
--- a/assets/case_case5.md.b8d6ff4d.lean.js
+++ b/assets/case_case5.md.4b0d5a6c.lean.js
@@ -1 +1 @@
-import{_ as a,o as e,c as t,R as s}from"./chunks/framework.1625126e.js";const m=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1687213975000}'),n={name:"case/case5.md"},l=s("",59),r=[l];function o(c,i,p,h,d,g){return e(),t("div",null,r)}const b=a(n,[["render",o]]);export{m as __pageData,b as default};
+import{_ as a,o as e,c as t,R as s}from"./chunks/framework.1625126e.js";const m=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1687756292000}'),n={name:"case/case5.md"},l=s("",59),r=[l];function o(c,i,p,h,d,g){return e(),t("div",null,r)}const b=a(n,[["render",o]]);export{m as __pageData,b as default};
diff --git a/assets/case_index.md.76e9f1e0.js b/assets/case_index.md.48107137.js
similarity index 88%
rename from assets/case_index.md.76e9f1e0.js
rename to assets/case_index.md.48107137.js
index 944c5c6f..44224900 100644
--- a/assets/case_index.md.76e9f1e0.js
+++ b/assets/case_index.md.48107137.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.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":1687213975000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.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":1687756292000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
diff --git a/assets/case_index.md.76e9f1e0.lean.js b/assets/case_index.md.48107137.lean.js
similarity index 88%
rename from assets/case_index.md.76e9f1e0.lean.js
rename to assets/case_index.md.48107137.lean.js
index 944c5c6f..44224900 100644
--- a/assets/case_index.md.76e9f1e0.lean.js
+++ b/assets/case_index.md.48107137.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.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":1687213975000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.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":1687756292000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
diff --git a/assets/developer_index.md.21258c2b.js b/assets/developer_index.md.4c46e7be.js
similarity index 92%
rename from assets/developer_index.md.21258c2b.js
rename to assets/developer_index.md.4c46e7be.js
index 83e16517..867db1a7 100644
--- a/assets/developer_index.md.21258c2b.js
+++ b/assets/developer_index.md.4c46e7be.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.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":1687213975000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.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":1687756292000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
diff --git a/assets/developer_index.md.21258c2b.lean.js b/assets/developer_index.md.4c46e7be.lean.js
similarity index 92%
rename from assets/developer_index.md.21258c2b.lean.js
rename to assets/developer_index.md.4c46e7be.lean.js
index 83e16517..867db1a7 100644
--- a/assets/developer_index.md.21258c2b.lean.js
+++ b/assets/developer_index.md.4c46e7be.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.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":1687213975000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.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":1687756292000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
diff --git a/assets/developer_l10n.md.11f5060d.js b/assets/developer_l10n.md.931179ce.js
similarity index 95%
rename from assets/developer_l10n.md.11f5060d.js
rename to assets/developer_l10n.md.931179ce.js
index a961c540..60a65bb7 100644
--- a/assets/developer_l10n.md.11f5060d.js
+++ b/assets/developer_l10n.md.931179ce.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.1625126e.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1687213975000}'),l={name:"developer/l10n.md"},r=t('
哪吒监控的 Dashboard 已经添加本地化，支持多个语言，你可以在开发新功能时遵循以下步骤来支持本地化
介绍 ​
  1. 你可以直接使用 /resource/l10n/zh-CN.toml 中已有的文本配置来替换新功能中的文本
  2. 如果新功能中有新增文本，请参考 zh-CN.toml 的配置文本，将新文本拉取到 zh-CN.toml 等其他语言的配置文件中，并添加翻译
新本地化文本的添加 ​
  1. 在 /resource/l10n/ 中添加新的语言文本配置
  2. 在新的语言文本配置中拉取其他语言已有的文本配置
  3. 为新的语言文本配置添加翻译
',5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.1625126e.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1687756292000}'),l={name:"developer/l10n.md"},r=t('
哪吒监控的 Dashboard 已经添加本地化，支持多个语言，你可以在开发新功能时遵循以下步骤来支持本地化
介绍 ​
  1. 你可以直接使用 /resource/l10n/zh-CN.toml 中已有的文本配置来替换新功能中的文本
  2. 如果新功能中有新增文本，请参考 zh-CN.toml 的配置文本，将新文本拉取到 zh-CN.toml 等其他语言的配置文件中，并添加翻译
新本地化文本的添加 ​
  1. 在 /resource/l10n/ 中添加新的语言文本配置
  2. 在新的语言文本配置中拉取其他语言已有的文本配置
  3. 为新的语言文本配置添加翻译
',5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default};
diff --git a/assets/developer_l10n.md.11f5060d.lean.js b/assets/developer_l10n.md.931179ce.lean.js
similarity index 84%
rename from assets/developer_l10n.md.11f5060d.lean.js
rename to assets/developer_l10n.md.931179ce.lean.js
index 0ceedec3..3f913246 100644
--- a/assets/developer_l10n.md.11f5060d.lean.js
+++ b/assets/developer_l10n.md.931179ce.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.1625126e.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1687213975000}'),l={name:"developer/l10n.md"},r=t("",5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.1625126e.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1687756292000}'),l={name:"developer/l10n.md"},r=t("",5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default};
diff --git a/assets/developer_theme.md.92af267d.js b/assets/developer_theme.md.ee895e3b.js
similarity index 96%
rename from assets/developer_theme.md.92af267d.js
rename to assets/developer_theme.md.ee895e3b.js
index 351fe69a..fd6dd610 100644
--- a/assets/developer_theme.md.92af267d.js
+++ b/assets/developer_theme.md.ee895e3b.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.1625126e.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1687213975000}'),c={name:"developer/theme.md"},l=t('
哪吒主题开发环境 ​
哪吒面板提供了主题开发环境，你可以使用它来创建新的哪吒监控主题
WARNING
请注意： 此开发环境仅支持 dashboard v0.13.16 及更新版本。
使用说明 ​
  1. 克隆此仓库到本地
  2. 修改 data/config.yaml 中的 Oauth2 配置（回调连接可以填 http://localhost）
  3. 运行 docker-compose up
  4. 开始开发
  5. 主题制作完成之后可以将 theme-custom 放置到服务器上的 /opt/nezha/dashboard/theme-custom 位置
FAQ ​
  • 如果不能使用 80 端口，在 docker-compose.yaml 中修改配置。
',7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.1625126e.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1687756292000}'),c={name:"developer/theme.md"},l=t('
哪吒主题开发环境 ​
哪吒面板提供了主题开发环境，你可以使用它来创建新的哪吒监控主题
WARNING
请注意： 此开发环境仅支持 dashboard v0.13.16 及更新版本。
使用说明 ​
  1. 克隆此仓库到本地
  2. 修改 data/config.yaml 中的 Oauth2 配置（回调连接可以填 http://localhost）
  3. 运行 docker-compose up
  4. 开始开发
  5. 主题制作完成之后可以将 theme-custom 放置到服务器上的 /opt/nezha/dashboard/theme-custom 位置
FAQ ​
  • 如果不能使用 80 端口，在 docker-compose.yaml 中修改配置。
',7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
diff --git a/assets/developer_theme.md.92af267d.lean.js b/assets/developer_theme.md.ee895e3b.lean.js
similarity index 84%
rename from assets/developer_theme.md.92af267d.lean.js
rename to assets/developer_theme.md.ee895e3b.lean.js
index 41e90faa..3e73d3a5 100644
--- a/assets/developer_theme.md.92af267d.lean.js
+++ b/assets/developer_theme.md.ee895e3b.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.1625126e.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1687213975000}'),c={name:"developer/theme.md"},l=t("",7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.1625126e.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1687756292000}'),c={name:"developer/theme.md"},l=t("",7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
diff --git a/assets/en_US_case_case1.md.483ce18b.js b/assets/en_US_case_case1.md.fe44ae32.js
similarity index 95%
rename from assets/en_US_case_case1.md.483ce18b.js
rename to assets/en_US_case_case1.md.fe44ae32.js
index 80bd055c..25041290 100644
--- a/assets/en_US_case_case1.md.483ce18b.js
+++ b/assets/en_US_case_case1.md.fe44ae32.js
@@ -1 +1 @@
-import{_ as e,o as t,c as r,R as o}from"./chunks/framework.1625126e.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1687213975000}'),a={name:"en_US/case/case1.md"},n=o('
Build your own Telegram bot to query server information ​
Contributors:
Project: nezha_api_tgbot (Chinese)
Mirror backup, non-real-time update: nezha_api_tgbot (Chinese)
The bot can request server status information from the Dashboard through the API, and then send the information to the user.
 You can build this bot to easily view the current status of a given server without opening the Dashboard.
',6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
+import{_ as e,o as t,c as r,R as o}from"./chunks/framework.1625126e.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1687756292000}'),a={name:"en_US/case/case1.md"},n=o('
Build your own Telegram bot to query server information ​
Contributors:
Project: nezha_api_tgbot (Chinese)
Mirror backup, non-real-time update: nezha_api_tgbot (Chinese)
The bot can request server status information from the Dashboard through the API, and then send the information to the user.
 You can build this bot to easily view the current status of a given server without opening the Dashboard.
',6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
diff --git a/assets/en_US_case_case1.md.483ce18b.lean.js b/assets/en_US_case_case1.md.fe44ae32.lean.js
similarity index 86%
rename from assets/en_US_case_case1.md.483ce18b.lean.js
rename to assets/en_US_case_case1.md.fe44ae32.lean.js
index d9e5ef53..65417dd7 100644
--- a/assets/en_US_case_case1.md.483ce18b.lean.js
+++ b/assets/en_US_case_case1.md.fe44ae32.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as r,R as o}from"./chunks/framework.1625126e.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1687213975000}'),a={name:"en_US/case/case1.md"},n=o("",6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
+import{_ as e,o as t,c as r,R as o}from"./chunks/framework.1625126e.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1687756292000}'),a={name:"en_US/case/case1.md"},n=o("",6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
diff --git a/assets/en_US_case_case2.md.771489c7.js b/assets/en_US_case_case2.md.83942200.js
similarity index 97%
rename from assets/en_US_case_case2.md.771489c7.js
rename to assets/en_US_case_case2.md.83942200.js
index 0df02a6e..4c2dae61 100644
--- a/assets/en_US_case_case2.md.771489c7.js
+++ b/assets/en_US_case_case2.md.83942200.js
@@ -1 +1 @@
-import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.1625126e.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":1687213975000}'),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 r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
+import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.1625126e.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":1687756292000}'),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 r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
diff --git a/assets/en_US_case_case2.md.771489c7.lean.js b/assets/en_US_case_case2.md.83942200.lean.js
similarity index 87%
rename from assets/en_US_case_case2.md.771489c7.lean.js
rename to assets/en_US_case_case2.md.83942200.lean.js
index ea06a526..1de20ce9 100644
--- a/assets/en_US_case_case2.md.771489c7.lean.js
+++ b/assets/en_US_case_case2.md.83942200.lean.js
@@ -1 +1 @@
-import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.1625126e.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":1687213975000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
+import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.1625126e.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":1687756292000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
diff --git a/assets/en_US_case_case3.md.ef33f53f.js b/assets/en_US_case_case3.md.f03fa8fa.js
similarity index 98%
rename from assets/en_US_case_case3.md.ef33f53f.js
rename to assets/en_US_case_case3.md.f03fa8fa.js
index 34adbfee..22cce409 100644
--- a/assets/en_US_case_case3.md.ef33f53f.js
+++ b/assets/en_US_case_case3.md.f03fa8fa.js
@@ -1 +1 @@
-import{_ as t,o as e,c as r,R as a}from"./chunks/framework.1625126e.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1687213975000}'),d={name:"en_US/case/case3.md"},i=a('
Build your own server status query Telegram bot with multi-language and multi-user support ​
Contributor:
GitHub project: nezha_telegram_bot（English is already supported）
Mirror backup, non-real-time update : nezha_telegram_bot（English is already supported）
Features ​
  • [x] Support Chinese/English multi-language switch
  • [x] Support tag statistics (CPU, disk, memory, upstream and downstream speed, traffic statistics, etc.)
  • [x] Support real-time refresh of single server data
  • [x] Support keyboard interactive query
  • [x] Support query by command
  • [x] Support adding bot to group, privacy protection of bot replies in group chat
  • [x] Support bot messages automatic deletion in group chat within 20 seconds
  • [x] Support docker deployment
Commands list ​
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)❌
',9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default};
+import{_ as t,o as e,c as r,R as a}from"./chunks/framework.1625126e.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1687756292000}'),d={name:"en_US/case/case3.md"},i=a('
Build your own server status query Telegram bot with multi-language and multi-user support ​
Contributor:
GitHub project: nezha_telegram_bot（English is already supported）
Mirror backup, non-real-time update : nezha_telegram_bot（English is already supported）
Features ​
  • [x] Support Chinese/English multi-language switch
  • [x] Support tag statistics (CPU, disk, memory, upstream and downstream speed, traffic statistics, etc.)
  • [x] Support real-time refresh of single server data
  • [x] Support keyboard interactive query
  • [x] Support query by command
  • [x] Support adding bot to group, privacy protection of bot replies in group chat
  • [x] Support bot messages automatic deletion in group chat within 20 seconds
  • [x] Support docker deployment
Commands list ​
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)❌
',9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default};
diff --git a/assets/en_US_case_case3.md.ef33f53f.lean.js b/assets/en_US_case_case3.md.f03fa8fa.lean.js
similarity index 87%
rename from assets/en_US_case_case3.md.ef33f53f.lean.js
rename to assets/en_US_case_case3.md.f03fa8fa.lean.js
index 13985e36..2525b443 100644
--- a/assets/en_US_case_case3.md.ef33f53f.lean.js
+++ b/assets/en_US_case_case3.md.f03fa8fa.lean.js
@@ -1 +1 @@
-import{_ as t,o as e,c as r,R as a}from"./chunks/framework.1625126e.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1687213975000}'),d={name:"en_US/case/case3.md"},i=a("",9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default};
+import{_ as t,o as e,c as r,R as a}from"./chunks/framework.1625126e.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1687756292000}'),d={name:"en_US/case/case3.md"},i=a("",9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default};
diff --git a/assets/en_US_case_case4.md.901a8aac.js b/assets/en_US_case_case4.md.4759869b.js
similarity index 94%
rename from assets/en_US_case_case4.md.901a8aac.js
rename to assets/en_US_case_case4.md.4759869b.js
index 193c6b37..c0337ce6 100644
--- a/assets/en_US_case_case4.md.901a8aac.js
+++ b/assets/en_US_case_case4.md.4759869b.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as r}from"./chunks/framework.1625126e.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1687213975000}'),n={name:"en_US/case/case4.md"},o=r('
Fake-agent, monitoring data cheater ​
Contributor:
GitHub project: fake-nezha-agent（Chinese）
 Mirror backup, non-real-time update ：fake-nezha-agent（Chinese）
You can modify the monitoring data uploaded to Dashboard by the Agent
 Use it for cheating 😈
',5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
+import{_ as e,o as a,c as t,R as r}from"./chunks/framework.1625126e.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1687756292000}'),n={name:"en_US/case/case4.md"},o=r('
Fake-agent, monitoring data cheater ​
Contributor:
GitHub project: fake-nezha-agent（Chinese）
 Mirror backup, non-real-time update ：fake-nezha-agent（Chinese）
You can modify the monitoring data uploaded to Dashboard by the Agent
 Use it for cheating 😈
',5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
diff --git a/assets/en_US_case_case4.md.901a8aac.lean.js b/assets/en_US_case_case4.md.4759869b.lean.js
similarity index 85%
rename from assets/en_US_case_case4.md.901a8aac.lean.js
rename to assets/en_US_case_case4.md.4759869b.lean.js
index 6c4727e3..82b82d68 100644
--- a/assets/en_US_case_case4.md.901a8aac.lean.js
+++ b/assets/en_US_case_case4.md.4759869b.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as r}from"./chunks/framework.1625126e.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1687213975000}'),n={name:"en_US/case/case4.md"},o=r("",5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
+import{_ as e,o as a,c as t,R as r}from"./chunks/framework.1625126e.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1687756292000}'),n={name:"en_US/case/case4.md"},o=r("",5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
diff --git a/assets/en_US_case_index.md.72581bc3.js b/assets/en_US_case_index.md.b5eb623f.js
similarity index 95%
rename from assets/en_US_case_index.md.72581bc3.js
rename to assets/en_US_case_index.md.b5eb623f.js
index c102f480..1da21987 100644
--- a/assets/en_US_case_index.md.72581bc3.js
+++ b/assets/en_US_case_index.md.b5eb623f.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1687213975000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1687756292000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default};
diff --git a/assets/en_US_case_index.md.72581bc3.lean.js b/assets/en_US_case_index.md.b5eb623f.lean.js
similarity index 95%
rename from assets/en_US_case_index.md.72581bc3.lean.js
rename to assets/en_US_case_index.md.b5eb623f.lean.js
index c102f480..1da21987 100644
--- a/assets/en_US_case_index.md.72581bc3.lean.js
+++ b/assets/en_US_case_index.md.b5eb623f.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1687213975000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1687756292000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default};
diff --git a/assets/en_US_developer_index.md.bdd734fe.js b/assets/en_US_developer_index.md.3dff5fe6.js
similarity index 91%
rename from assets/en_US_developer_index.md.bdd734fe.js
rename to assets/en_US_developer_index.md.3dff5fe6.js
index ed6f435a..153136d8 100644
--- a/assets/en_US_developer_index.md.bdd734fe.js
+++ b/assets/en_US_developer_index.md.3dff5fe6.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1687213975000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1687756292000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default};
diff --git a/assets/en_US_developer_index.md.bdd734fe.lean.js b/assets/en_US_developer_index.md.3dff5fe6.lean.js
similarity index 91%
rename from assets/en_US_developer_index.md.bdd734fe.lean.js
rename to assets/en_US_developer_index.md.3dff5fe6.lean.js
index ed6f435a..153136d8 100644
--- a/assets/en_US_developer_index.md.bdd734fe.lean.js
+++ b/assets/en_US_developer_index.md.3dff5fe6.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1687213975000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.1625126e.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1687756292000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default};
diff --git a/assets/en_US_developer_l10n.md.e9e12864.js b/assets/en_US_developer_l10n.md.ead94ca6.js
similarity index 96%
rename from assets/en_US_developer_l10n.md.e9e12864.js
rename to assets/en_US_developer_l10n.md.ead94ca6.js
index cf32cfd8..24c2f00a 100644
--- a/assets/en_US_developer_l10n.md.e9e12864.js
+++ b/assets/en_US_developer_l10n.md.ead94ca6.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as n}from"./chunks/framework.1625126e.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1687213975000}'),o={name:"en_US/developer/l10n.md"},i=n('
Nezha Monitoring's Dashboard has added localization to support multiple languages, and you can follow these steps to support localization when developing new features
Introduction ​
  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.
',5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default};
+import{_ as e,o as t,c as a,R as n}from"./chunks/framework.1625126e.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1687756292000}'),o={name:"en_US/developer/l10n.md"},i=n('
Nezha Monitoring's Dashboard has added localization to support multiple languages, and you can follow these steps to support localization when developing new features
Introduction ​
  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.
',5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default};
diff --git a/assets/en_US_developer_l10n.md.e9e12864.lean.js b/assets/en_US_developer_l10n.md.ead94ca6.lean.js
similarity index 85%
rename from assets/en_US_developer_l10n.md.e9e12864.lean.js
rename to assets/en_US_developer_l10n.md.ead94ca6.lean.js
index da4d6e4a..6522cfb8 100644
--- a/assets/en_US_developer_l10n.md.e9e12864.lean.js
+++ b/assets/en_US_developer_l10n.md.ead94ca6.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as n}from"./chunks/framework.1625126e.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1687213975000}'),o={name:"en_US/developer/l10n.md"},i=n("",5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default};
+import{_ as e,o as t,c as a,R as n}from"./chunks/framework.1625126e.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1687756292000}'),o={name:"en_US/developer/l10n.md"},i=n("",5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default};
diff --git a/assets/en_US_developer_theme.md.705dbaad.js b/assets/en_US_developer_theme.md.a1b900d0.js
similarity index 96%
rename from assets/en_US_developer_theme.md.705dbaad.js
rename to assets/en_US_developer_theme.md.a1b900d0.js
index 2186d112..f86932ad 100644
--- a/assets/en_US_developer_theme.md.705dbaad.js
+++ b/assets/en_US_developer_theme.md.a1b900d0.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.1625126e.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1687213975000}'),n={name:"en_US/developer/theme.md"},c=a('
Nezha Theme Development Environment ​
Nezha Monitoring provides a theme development environment that you can use to create new Nezha Monitoring themes
WARNING
Please note: This development environment only supports dashboard v0.13.16 and newer versions.
How to use ​
  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. Once the theme has been created, you can place theme-custom in /opt/nezha/dashboard/theme-custom on the server
FAQ ​
  • If you can't use port 80, change the configuration in docker-compose.yaml.
',7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
+import{_ as e,o,c as t,R as a}from"./chunks/framework.1625126e.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1687756292000}'),n={name:"en_US/developer/theme.md"},c=a('
Nezha Theme Development Environment ​
Nezha Monitoring provides a theme development environment that you can use to create new Nezha Monitoring themes
WARNING
Please note: This development environment only supports dashboard v0.13.16 and newer versions.
How to use ​
  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. Once the theme has been created, you can place theme-custom in /opt/nezha/dashboard/theme-custom on the server
FAQ ​
  • If you can't use port 80, change the configuration in docker-compose.yaml.
',7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
diff --git a/assets/en_US_developer_theme.md.705dbaad.lean.js b/assets/en_US_developer_theme.md.a1b900d0.lean.js
similarity index 84%
rename from assets/en_US_developer_theme.md.705dbaad.lean.js
rename to assets/en_US_developer_theme.md.a1b900d0.lean.js
index 432157fb..ef00a9f1 100644
--- a/assets/en_US_developer_theme.md.705dbaad.lean.js
+++ b/assets/en_US_developer_theme.md.a1b900d0.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.1625126e.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1687213975000}'),n={name:"en_US/developer/theme.md"},c=a("",7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
+import{_ as e,o,c as t,R as a}from"./chunks/framework.1625126e.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1687756292000}'),n={name:"en_US/developer/theme.md"},c=a("",7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
diff --git a/assets/en_US_guide_agent.md.a9ad9deb.js b/assets/en_US_guide_agent.md.291762ff.js
similarity index 99%
rename from assets/en_US_guide_agent.md.a9ad9deb.js
rename to assets/en_US_guide_agent.md.291762ff.js
index 918d9be4..73983023 100644
--- a/assets/en_US_guide_agent.md.a9ad9deb.js
+++ b/assets/en_US_guide_agent.md.291762ff.js
@@ -1,4 +1,4 @@
-import{_ as s,o as n,c as a,R as l}from"./chunks/framework.1625126e.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1687213975000}'),o={name:"en_US/guide/agent.md"},e=l(`
The service in the monitored server is called Agent. This document will describe how to install the Agent on the monitored server and connect it with Dashboard

Install Agent using one-click script ​
Nezha Monitoring now supports one-click installation of the Agent on Windows and Linux. Follow the steps in this document and you can easily deploy it on your server

Preparation ​
First of all, you need to set up the communication domain name in the settings page of the admin panel, this domain name can not connect to the CDN, here is the sample communication domain name "data.example.com" mentioned earlier for demonstration
 Enter the administration panel, go to the "Settings" page, in the item "CDN Bypassed Domain/IP ", fill in the communication domain name, and then click "Save"

One-click installation on Linux (Ubuntu, Debian, CentOS) ​
  • First add a server in the admin panel
  • Click on the green Linux icon button next to the newly added server and copy the one-click installation command
  • Run the copied one-click installation command on the monitored server, wait for the installation to complete, and then return to the Dashboard home page to see if the server is online.

One-click installation on Windows ​
  • First add a server in the admin panel
  • Click on the green Linux icon button next to the newly added server and copy the one-click installation command
  • Login to Windows Server, open PowerShell, and run the copied installation command in PowerShell
  • If you encounter the prompt "Implement Policy Change" please select Y
  • Wait for the installation to complete and return to the Dashboard home page to see if the server is online



Other ways to install Agent ​

Installing Agent on Linux (Ubuntu, Debian, CentOS) ​
  • First add a server in the admin panel
  • In the monitored server, run the script:
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
  • Select “Install_agent”
  • Input the communication domain name, e.g. "data.example.com"
  • Input RPC port, default is 5555
  • Input the Agent Secret, which is generated when adding a server in the administration panel and can be found in the " Servers " page of the administration panel
  • Wait for the installation to complete and return to the Dashboard home page to see if the server is online

Installing Agent on other Linux (such as alpine use oprec not systemd) ​
Contributed by unknown0054
  • Edit SERVER,SECRET,TLS then run it in Shell
shell
cat >/etc/init.d/nezha-agent<< EOF
+import{_ as s,o as n,c as a,R as l}from"./chunks/framework.1625126e.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1687756292000}'),o={name:"en_US/guide/agent.md"},e=l(`
The service in the monitored server is called Agent. This document will describe how to install the Agent on the monitored server and connect it with Dashboard

Install Agent using one-click script ​
Nezha Monitoring now supports one-click installation of the Agent on Windows and Linux. Follow the steps in this document and you can easily deploy it on your server

Preparation ​
First of all, you need to set up the communication domain name in the settings page of the admin panel, this domain name can not connect to the CDN, here is the sample communication domain name "data.example.com" mentioned earlier for demonstration
 Enter the administration panel, go to the "Settings" page, in the item "CDN Bypassed Domain/IP ", fill in the communication domain name, and then click "Save"

One-click installation on Linux (Ubuntu, Debian, CentOS) ​
  • First add a server in the admin panel
  • Click on the green Linux icon button next to the newly added server and copy the one-click installation command
  • Run the copied one-click installation command on the monitored server, wait for the installation to complete, and then return to the Dashboard home page to see if the server is online.

One-click installation on Windows ​
  • First add a server in the admin panel
  • Click on the green Linux icon button next to the newly added server and copy the one-click installation command
  • Login to Windows Server, open PowerShell, and run the copied installation command in PowerShell
  • If you encounter the prompt "Implement Policy Change" please select Y
  • Wait for the installation to complete and return to the Dashboard home page to see if the server is online



Other ways to install Agent ​

Installing Agent on Linux (Ubuntu, Debian, CentOS) ​
  • First add a server in the admin panel
  • In the monitored server, run the script:
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
  • Select “Install_agent”
  • Input the communication domain name, e.g. "data.example.com"
  • Input RPC port, default is 5555
  • Input the Agent Secret, which is generated when adding a server in the administration panel and can be found in the " Servers " page of the administration panel
  • Wait for the installation to complete and return to the Dashboard home page to see if the server is online

Installing Agent on other Linux (such as alpine use oprec not systemd) ​
Contributed by unknown0054
  • Edit SERVER,SECRET,TLS then run it in Shell
shell
cat >/etc/init.d/nezha-agent<< EOF
 #!/sbin/openrc-run
 SERVER="" #Dashboard address ip:port
 SECRET="" #SECRET
diff --git a/assets/en_US_guide_agent.md.a9ad9deb.lean.js b/assets/en_US_guide_agent.md.291762ff.lean.js
similarity index 84%
rename from assets/en_US_guide_agent.md.a9ad9deb.lean.js
rename to assets/en_US_guide_agent.md.291762ff.lean.js
index 0f95e3e3..e845c6d0 100644
--- a/assets/en_US_guide_agent.md.a9ad9deb.lean.js
+++ b/assets/en_US_guide_agent.md.291762ff.lean.js
@@ -1 +1 @@
-import{_ as s,o as n,c as a,R as l}from"./chunks/framework.1625126e.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1687213975000}'),o={name:"en_US/guide/agent.md"},e=l("",52),p=[e];function t(r,c,i,D,y,C){return n(),a("div",null,p)}const u=s(o,[["render",t]]);export{h as __pageData,u as default};
+import{_ as s,o as n,c as a,R as l}from"./chunks/framework.1625126e.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1687756292000}'),o={name:"en_US/guide/agent.md"},e=l("",52),p=[e];function t(r,c,i,D,y,C){return n(),a("div",null,p)}const u=s(o,[["render",t]]);export{h as __pageData,u as default};
diff --git a/assets/en_US_guide_agentq.md.26a47eb6.js b/assets/en_US_guide_agentq.md.37c15514.js
similarity index 96%
rename from assets/en_US_guide_agentq.md.26a47eb6.js
rename to assets/en_US_guide_agentq.md.37c15514.js
index c2a812ed..f6d9ba09 100644
--- a/assets/en_US_guide_agentq.md.26a47eb6.js
+++ b/assets/en_US_guide_agentq.md.37c15514.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as n}from"./chunks/framework.1625126e.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1687213975000}'),o={name:"en_US/guide/agentq.md"},i=n('
Why the IP displayed in the admin panel and the actual IP of the Agent are not the same? ​
Please check Dashboard - Why the IP displayed in the admin panel and the actual IP of the Agent are not the same?
Error on one-click script installation ​
curl: Failed to connect to raw.githubusercontent.com... ​
Please check if your server can connect to Github, try again, or check Other ways to install Agent
sudo: command not found ​
Please install sudo first
',7),r=[i];function c(h,d,l,s,u,p){return a(),t("div",null,r)}const f=e(o,[["render",c]]);export{_ as __pageData,f as default};
+import{_ as e,o as a,c as t,R as n}from"./chunks/framework.1625126e.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1687756292000}'),o={name:"en_US/guide/agentq.md"},i=n('
Why the IP displayed in the admin panel and the actual IP of the Agent are not the same? ​
Please check Dashboard - Why the IP displayed in the admin panel and the actual IP of the Agent are not the same?
Error on one-click script installation ​
curl: Failed to connect to raw.githubusercontent.com... ​
Please check if your server can connect to Github, try again, or check Other ways to install Agent
sudo: command not found ​
Please install sudo first
',7),r=[i];function c(h,d,l,s,u,p){return a(),t("div",null,r)}const f=e(o,[["render",c]]);export{_ as __pageData,f as default};
diff --git a/assets/en_US_guide_agentq.md.26a47eb6.lean.js b/assets/en_US_guide_agentq.md.37c15514.lean.js
similarity index 84%
rename from assets/en_US_guide_agentq.md.26a47eb6.lean.js
rename to assets/en_US_guide_agentq.md.37c15514.lean.js
index 32a75c9c..e0f7507d 100644
--- a/assets/en_US_guide_agentq.md.26a47eb6.lean.js
+++ b/assets/en_US_guide_agentq.md.37c15514.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as n}from"./chunks/framework.1625126e.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1687213975000}'),o={name:"en_US/guide/agentq.md"},i=n("",7),r=[i];function c(h,d,l,s,u,p){return a(),t("div",null,r)}const f=e(o,[["render",c]]);export{_ as __pageData,f as default};
+import{_ as e,o as a,c as t,R as n}from"./chunks/framework.1625126e.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1687756292000}'),o={name:"en_US/guide/agentq.md"},i=n("",7),r=[i];function c(h,d,l,s,u,p){return a(),t("div",null,r)}const f=e(o,[["render",c]]);export{_ as __pageData,f as default};
diff --git a/assets/en_US_guide_api.md.bd998239.js b/assets/en_US_guide_api.md.64cf9321.js
similarity index 99%
rename from assets/en_US_guide_api.md.bd998239.js
rename to assets/en_US_guide_api.md.64cf9321.js
index 6b1a8bce..483a866d 100644
--- a/assets/en_US_guide_api.md.bd998239.js
+++ b/assets/en_US_guide_api.md.64cf9321.js
@@ -1,4 +1,4 @@
-import{_ as s,o as n,c as a,R as o}from"./chunks/framework.1625126e.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1687213975000}'),t={name:"en_US/guide/api.md"},e=o(`
Nezha Monitoring now supports querying the status information of the Agent in the Dashboard using the API
Create Token ​
API allows Token authentication method and Cookies authentication method
 To create a new Token, after entering the admin panel, click on the avatar in the upper right corner and select "API Token" to enter the Token management page
 Click "Add Token" and after customizing the notes, click "Add"
 To delete a Token, please select the corresponding Token and click the delete icon on the right
WARNING
Token is the authentication tool of API, it is very important for your Dashboard's information security, please don't leak your Token to others
Authentication method ​
Token authentication method:
Request Headers:  
+import{_ as s,o as n,c as a,R as o}from"./chunks/framework.1625126e.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1687756292000}'),t={name:"en_US/guide/api.md"},e=o(`
Nezha Monitoring now supports querying the status information of the Agent in the Dashboard using the API
Create Token ​
API allows Token authentication method and Cookies authentication method
 To create a new Token, after entering the admin panel, click on the avatar in the upper right corner and select "API Token" to enter the Token management page
 Click "Add Token" and after customizing the notes, click "Add"
 To delete a Token, please select the corresponding Token and click the delete icon on the right
WARNING
Token is the authentication tool of API, it is very important for your Dashboard's information security, please don't leak your Token to others
Authentication method ​
Token authentication method:
Request Headers:  
 Authorization: Token
How to use ​
WARNING
The negative timestamp in the example below is (0000-00-00)
 It is currently used to indicate that the Agent has never reported since the Dashboard went live
 However, it is not recommended to use positivity or negativity to determine the status
TIP
The request method is Get and the return format is JSON.
  • Get a list of servers: GET /api/v1/server/list?tag=
     query: tag (ServerTag means the group of servers, if this value is provided, only the servers in this group are queried)
JSON Return Example:
{
     "code": 0,
     "message": "success",
diff --git a/assets/en_US_guide_api.md.bd998239.lean.js b/assets/en_US_guide_api.md.64cf9321.lean.js
similarity index 84%
rename from assets/en_US_guide_api.md.bd998239.lean.js
rename to assets/en_US_guide_api.md.64cf9321.lean.js
index 9be3d8f9..72e7a0ed 100644
--- a/assets/en_US_guide_api.md.bd998239.lean.js
+++ b/assets/en_US_guide_api.md.64cf9321.lean.js
@@ -1 +1 @@
-import{_ as s,o as n,c as a,R as o}from"./chunks/framework.1625126e.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1687213975000}'),t={name:"en_US/guide/api.md"},e=o("",16),l=[e];function p(u,c,i,r,q,C){return n(),a("div",null,l)}const d=s(t,[["render",p]]);export{y as __pageData,d as default};
+import{_ as s,o as n,c as a,R as o}from"./chunks/framework.1625126e.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1687756292000}'),t={name:"en_US/guide/api.md"},e=o("",16),l=[e];function p(u,c,i,r,q,C){return n(),a("div",null,l)}const d=s(t,[["render",p]]);export{y as __pageData,d as default};
diff --git a/assets/en_US_guide_dashboard.md.72b99217.js b/assets/en_US_guide_dashboard.md.502d67af.js
similarity index 99%
rename from assets/en_US_guide_dashboard.md.72b99217.js
rename to assets/en_US_guide_dashboard.md.502d67af.js
index 7b2c598e..3fbda541 100644
--- a/assets/en_US_guide_dashboard.md.72b99217.js
+++ b/assets/en_US_guide_dashboard.md.502d67af.js
@@ -1,4 +1,4 @@
-import{_ as e,o as a,c as t,R as o}from"./chunks/framework.1625126e.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1687213975000}'),s={name:"en_US/guide/dashboard.md"},n=o(`
Preparations ​
To setup a Nezha monitorning Dashboard, you need these things:
  1. A VPS that can connect to the Internet, firewall and security policies need to open ports 8008 and 5555, otherwise it will be inaccessible and unable to receive data. A 1 core 512MB RAM server is sufficient for most usage scenarios
  2. A domain name that has been set up with an A record that resolves to the Dashboard server IP
TIP
If you want to use CDN, please prepare two domains, one connect to CDN for public access, CDN needs to support WebSocket protocol; the other domain should not connect to CDN, use it as Agent to send data to Dashboard.
 This document uses "cdn.example.com" and "data.example.com" domains to demonstrate respectively
  1. A Github or Gitlab account
This document will use the aaPanel as an example, with future versions of the changes, some of the features may change, this document is for reference only
WARNING
This project does not rely on aaPanel, you can choose to use any server panel you like, and if you are capable enough, you can manually install NginX or Caddy to configure SSL and reverse proxy.
 If you don't think it's necessary to use port 80 or 443 to access Dashboard, you don't even need to install NginX and you can just use the install script.


Get the Client ID and Client Secret on Github/Gitlab ​
Nezha Monitor uses a Github account as the login account for the admin panel
  • First we need to create a new authentication application, after logging into Github, open https://github.com/settings/developers and select "OAuth Apps" - "New OAuth App "
    Application name - Fill in as you like
    Homepage URL - Fill in the panel's access domain name, such as: "http://cdn.example.com"
    Authorization callback URL - Fill in the callback address, e.g., "http://cdn.example.com/oauth2/callback"
  • Click on "Registration Application"
  • Remember the Client ID in the page, then click "Generate a new client secret" to create a new Client Secret, the new secret will be displayed only once, please save it properly 

  • If you're using Gitlab, you'll need to go to https://gitlab.com/-/profile/applications to create a new application
  • Fill in Redirect URL with the callback address
  • In Scopes, select read_user and read_api
  • Once created, save the Application ID and Secret
Installing Dashboard on the server ​
  • In the panel server, run the installation script:
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
  • After waiting for the Docker installation to complete, input the following settings:
    OAuth2 provider - Github or Gitlab
    Client ID - Previously saved Client ID
    Client Secret - Previously saved secret
    GitHub/Gitee login name - Github o Gitlab username
    Site title - Custom site title
    Site access port - Public access port, customizable, default 8008
    RPC port - The communication port between Agent and Dashboard, default 5555
  • After the input is complete, wait to pull the mirror
     After the installation, if everything is fine, you can visit the domain + port number, such as "http://cdn.example.com:8008" to view the Dashboard
  • In the future, if you need to run the script again, you can run:
bash
./nezha.sh
to open the management script


Configure reverse proxy ​
  • Create a new site in the aaPanel, fill in the public access domain name, such as "http://cdn.example.com", then click "Settings" to enter the site settings option, select " Reverse proxy" - "New reverse proxy"
  • Customize a proxy name, fill in http://127.0.0.1 in the "Target URL" and click "Save"
  • Open the " configuration" to the right of the new reverse proxy you just created and replace the configuration file with the following:
nginx
#PROXY-START/
+import{_ as e,o as a,c as t,R as o}from"./chunks/framework.1625126e.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1687756292000}'),s={name:"en_US/guide/dashboard.md"},n=o(`
Preparations ​
To setup a Nezha monitorning Dashboard, you need these things:
  1. A VPS that can connect to the Internet, firewall and security policies need to open ports 8008 and 5555, otherwise it will be inaccessible and unable to receive data. A 1 core 512MB RAM server is sufficient for most usage scenarios
  2. A domain name that has been set up with an A record that resolves to the Dashboard server IP
TIP
If you want to use CDN, please prepare two domains, one connect to CDN for public access, CDN needs to support WebSocket protocol; the other domain should not connect to CDN, use it as Agent to send data to Dashboard.
 This document uses "cdn.example.com" and "data.example.com" domains to demonstrate respectively
  1. A Github or Gitlab account
This document will use the aaPanel as an example, with future versions of the changes, some of the features may change, this document is for reference only
WARNING
This project does not rely on aaPanel, you can choose to use any server panel you like, and if you are capable enough, you can manually install NginX or Caddy to configure SSL and reverse proxy.
 If you don't think it's necessary to use port 80 or 443 to access Dashboard, you don't even need to install NginX and you can just use the install script.


Get the Client ID and Client Secret on Github/Gitlab ​
Nezha Monitor uses a Github account as the login account for the admin panel
  • First we need to create a new authentication application, after logging into Github, open https://github.com/settings/developers and select "OAuth Apps" - "New OAuth App "
    Application name - Fill in as you like
    Homepage URL - Fill in the panel's access domain name, such as: "http://cdn.example.com"
    Authorization callback URL - Fill in the callback address, e.g., "http://cdn.example.com/oauth2/callback"
  • Click on "Registration Application"
  • Remember the Client ID in the page, then click "Generate a new client secret" to create a new Client Secret, the new secret will be displayed only once, please save it properly 

  • If you're using Gitlab, you'll need to go to https://gitlab.com/-/profile/applications to create a new application
  • Fill in Redirect URL with the callback address
  • In Scopes, select read_user and read_api
  • Once created, save the Application ID and Secret
Installing Dashboard on the server ​
  • In the panel server, run the installation script:
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
  • After waiting for the Docker installation to complete, input the following settings:
    OAuth2 provider - Github or Gitlab
    Client ID - Previously saved Client ID
    Client Secret - Previously saved secret
    GitHub/Gitee login name - Github o Gitlab username
    Site title - Custom site title
    Site access port - Public access port, customizable, default 8008
    RPC port - The communication port between Agent and Dashboard, default 5555
  • After the input is complete, wait to pull the mirror
     After the installation, if everything is fine, you can visit the domain + port number, such as "http://cdn.example.com:8008" to view the Dashboard
  • In the future, if you need to run the script again, you can run:
bash
./nezha.sh
to open the management script


Configure reverse proxy ​
  • Create a new site in the aaPanel, fill in the public access domain name, such as "http://cdn.example.com", then click "Settings" to enter the site settings option, select " Reverse proxy" - "New reverse proxy"
  • Customize a proxy name, fill in http://127.0.0.1 in the "Target URL" and click "Save"
  • Open the " configuration" to the right of the new reverse proxy you just created and replace the configuration file with the following:
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.72b99217.lean.js b/assets/en_US_guide_dashboard.md.502d67af.lean.js
similarity index 85%
rename from assets/en_US_guide_dashboard.md.72b99217.lean.js
rename to assets/en_US_guide_dashboard.md.502d67af.lean.js
index 2044ddb1..96decd7a 100644
--- a/assets/en_US_guide_dashboard.md.72b99217.lean.js
+++ b/assets/en_US_guide_dashboard.md.502d67af.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as o}from"./chunks/framework.1625126e.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1687213975000}'),s={name:"en_US/guide/dashboard.md"},n=o("",41),l=[n];function r(i,p,c,d,h,u){return a(),t("div",null,l)}const m=e(s,[["render",r]]);export{y as __pageData,m as default};
+import{_ as e,o as a,c as t,R as o}from"./chunks/framework.1625126e.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1687756292000}'),s={name:"en_US/guide/dashboard.md"},n=o("",41),l=[n];function r(i,p,c,d,h,u){return a(),t("div",null,l)}const m=e(s,[["render",r]]);export{y as __pageData,m as default};
diff --git a/assets/en_US_guide_dashboardq.md.d010cee9.js b/assets/en_US_guide_dashboardq.md.79d7db76.js
similarity index 98%
rename from assets/en_US_guide_dashboardq.md.d010cee9.js
rename to assets/en_US_guide_dashboardq.md.79d7db76.js
index b6d53126..f406fac4 100644
--- a/assets/en_US_guide_dashboardq.md.d010cee9.js
+++ b/assets/en_US_guide_dashboardq.md.79d7db76.js
@@ -1,4 +1,4 @@
-import{_ as e,o as a,c as s,R as t}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1687213975000}'),o={name:"en_US/guide/dashboardq.md"},n=t(`
Why the IP displayed in the admin panel and the actual IP of the Agent are not the same? ​
First of all, explain how the IP displayed in the admin panel is gotten: the Agent will request the IP-API every once in a while, get the IP information and report it to the Dashboard, the IP-API currently used can be viewed here: myip.go
 If you find that the IP displayed in the admin panel is not the same as the IP provided to you by the service provider, the biggest possibility is that the service provider gave you the entry IP, but the Agent tested out your exit IP. This problem may also occur in BGP servers and Leased line.
TIP
To take a simple and very common example, the service provider to provide you a anti-DDoS server, in order to meet the goals of both DDoS protection and low network disruption rate, the IP provided to you may be the mapped anti-DDoS IP and not the real exit IP of your server
You can also test the exit IP by running the following command in the Agent server:
shell
curl api.myip.la
+import{_ as e,o as a,c as s,R as t}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1687756292000}'),o={name:"en_US/guide/dashboardq.md"},n=t(`
Why the IP displayed in the admin panel and the actual IP of the Agent are not the same? ​
First of all, explain how the IP displayed in the admin panel is gotten: the Agent will request the IP-API every once in a while, get the IP information and report it to the Dashboard, the IP-API currently used can be viewed here: myip.go
 If you find that the IP displayed in the admin panel is not the same as the IP provided to you by the service provider, the biggest possibility is that the service provider gave you the entry IP, but the Agent tested out your exit IP. This problem may also occur in BGP servers and Leased line.
TIP
To take a simple and very common example, the service provider to provide you a anti-DDoS server, in order to meet the goals of both DDoS protection and low network disruption rate, the IP provided to you may be the mapped anti-DDoS IP and not the real exit IP of your server
You can also test the exit IP by running the following command in the Agent server:
shell
curl api.myip.la
 curl ip.sb
 curl ip-api.com
Forgot your access password or deleted your access password ​
Please view or edit the /opt/nezha/dashboard/data/config.yaml file.
 The password is located in the site-viewpassword item.
Dashboard install/restart/update failed: iptables ...... ​
First, try restarting docker and retrying again
shell
systemctl status docker
 systemctl restart docker
diff --git a/assets/en_US_guide_dashboardq.md.d010cee9.lean.js b/assets/en_US_guide_dashboardq.md.79d7db76.lean.js
similarity index 70%
rename from assets/en_US_guide_dashboardq.md.d010cee9.lean.js
rename to assets/en_US_guide_dashboardq.md.79d7db76.lean.js
index 0893c14a..a821425f 100644
--- a/assets/en_US_guide_dashboardq.md.d010cee9.lean.js
+++ b/assets/en_US_guide_dashboardq.md.79d7db76.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as s,R as t}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1687213975000}'),o={name:"en_US/guide/dashboardq.md"},n=t("",18),l=[n];function r(i,p,c,d,h,y){return a(),s("div",null,l)}const g=e(o,[["render",r]]);export{b as __pageData,g as default};
+import{_ as e,o as a,c as s,R as t}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1687756292000}'),o={name:"en_US/guide/dashboardq.md"},n=t("",18),l=[n];function r(i,p,c,d,h,y){return a(),s("div",null,l)}const g=e(o,[["render",r]]);export{b as __pageData,g as default};
diff --git a/assets/en_US_guide_loginq.md.4cfb240f.js b/assets/en_US_guide_loginq.md.f5a90bf0.js
similarity index 98%
rename from assets/en_US_guide_loginq.md.4cfb240f.js
rename to assets/en_US_guide_loginq.md.f5a90bf0.js
index 833144fb..e0f42638 100644
--- a/assets/en_US_guide_loginq.md.4cfb240f.js
+++ b/assets/en_US_guide_loginq.md.f5a90bf0.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1687213975000}'),r={name:"en_US/guide/loginq.md"},i=a('
Page refuses to connect or timeout after login callback ​
  1. Your server cannot connect to Github, consider trying several times or switching to Gitlab.
  2. You have configured the wrong callback URL, make sure your callback URL is correct and port and protocol are correct!
  3. An unknown error occurred in Dashboard, you can use the script to check the logs.
TIP
What is a protocol?
 In the browser, your domain name ending with :// is the protocol, usually http and https. Since the Dashboard may be accessible by multiple protocols + domain + port combinations under normal deployment, please make sure to choose the most appropriate one as the callback.
How do I check if my callback URL is wrong? ​
Please make sure the protocol+domain+port displayed by your browser before login and the protocol+domain+port you jump to after login are the same.
 Please make sure your path is /oauth2/callback, all lowercase.
Dashboard errors after login ​
Clear your browser cookies and log in again, or change your browser.
lookup xxx ​
DNS resolution failure, in most cases, is due to iptables-related configuration changes.
 It is recommended to restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
 If the lookup error still occurs, it is recommended to check whether there are other tools to control iptables, such as Aapanel Firewall.
 This problem may also be related to the kernel, please try to change the official kernel.
The authorization method is invalid, or the login callback URL is invalid, expired, or has been revoked ​
Suggest changing the authentication method to Github/Gitlab.
oauth2: server response missing access_token ​
It may be caused by a number of factors, the most likely is a network problem, we suggest to check the network and retry.
 If you can't solve it, we suggest changing the authentication method to Github/Gitlab.
This user is not the administrator or cannot login ​
You have logged into the wrong account or configured the wrong username, note that username is not email, you can use a script to modify it.
dial tcp xxx:443 i/o timeout ​
If the server has network problems, you can restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
 You can also change to another OAuth method if necessary.
net/http: TLS handshake timeout ​
Same as above.
',20),n=[i];function s(l,c,h,d,u,p){return o(),t("div",null,n)}const k=e(r,[["render",s]]);export{b as __pageData,k as default};
+import{_ as e,o,c as t,R as a}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1687756292000}'),r={name:"en_US/guide/loginq.md"},i=a('
Page refuses to connect or timeout after login callback ​
  1. Your server cannot connect to Github, consider trying several times or switching to Gitlab.
  2. You have configured the wrong callback URL, make sure your callback URL is correct and port and protocol are correct!
  3. An unknown error occurred in Dashboard, you can use the script to check the logs.
TIP
What is a protocol?
 In the browser, your domain name ending with :// is the protocol, usually http and https. Since the Dashboard may be accessible by multiple protocols + domain + port combinations under normal deployment, please make sure to choose the most appropriate one as the callback.
How do I check if my callback URL is wrong? ​
Please make sure the protocol+domain+port displayed by your browser before login and the protocol+domain+port you jump to after login are the same.
 Please make sure your path is /oauth2/callback, all lowercase.
Dashboard errors after login ​
Clear your browser cookies and log in again, or change your browser.
lookup xxx ​
DNS resolution failure, in most cases, is due to iptables-related configuration changes.
 It is recommended to restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
 If the lookup error still occurs, it is recommended to check whether there are other tools to control iptables, such as Aapanel Firewall.
 This problem may also be related to the kernel, please try to change the official kernel.
The authorization method is invalid, or the login callback URL is invalid, expired, or has been revoked ​
Suggest changing the authentication method to Github/Gitlab.
oauth2: server response missing access_token ​
It may be caused by a number of factors, the most likely is a network problem, we suggest to check the network and retry.
 If you can't solve it, we suggest changing the authentication method to Github/Gitlab.
This user is not the administrator or cannot login ​
You have logged into the wrong account or configured the wrong username, note that username is not email, you can use a script to modify it.
dial tcp xxx:443 i/o timeout ​
If the server has network problems, you can restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
 You can also change to another OAuth method if necessary.
net/http: TLS handshake timeout ​
Same as above.
',20),n=[i];function s(l,c,h,d,u,p){return o(),t("div",null,n)}const k=e(r,[["render",s]]);export{b as __pageData,k as default};
diff --git a/assets/en_US_guide_loginq.md.4cfb240f.lean.js b/assets/en_US_guide_loginq.md.f5a90bf0.lean.js
similarity index 84%
rename from assets/en_US_guide_loginq.md.4cfb240f.lean.js
rename to assets/en_US_guide_loginq.md.f5a90bf0.lean.js
index d659daeb..85fbcfe5 100644
--- a/assets/en_US_guide_loginq.md.4cfb240f.lean.js
+++ b/assets/en_US_guide_loginq.md.f5a90bf0.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1687213975000}'),r={name:"en_US/guide/loginq.md"},i=a("",20),n=[i];function s(l,c,h,d,u,p){return o(),t("div",null,n)}const k=e(r,[["render",s]]);export{b as __pageData,k as default};
+import{_ as e,o,c as t,R as a}from"./chunks/framework.1625126e.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1687756292000}'),r={name:"en_US/guide/loginq.md"},i=a("",20),n=[i];function s(l,c,h,d,u,p){return o(),t("div",null,n)}const k=e(r,[["render",s]]);export{b as __pageData,k as default};
diff --git a/assets/en_US_guide_notifications.md.4be039d9.js b/assets/en_US_guide_notifications.md.40ad278b.js
similarity index 99%
rename from assets/en_US_guide_notifications.md.4be039d9.js
rename to assets/en_US_guide_notifications.md.40ad278b.js
index a60cc890..f149a222 100644
--- a/assets/en_US_guide_notifications.md.4be039d9.js
+++ b/assets/en_US_guide_notifications.md.40ad278b.js
@@ -1,4 +1,4 @@
-import{_ as o,o as s,c as e,R as n}from"./chunks/framework.1625126e.js";const F=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1687213975000}'),t={name:"en_US/guide/notifications.md"},a=n(`
Nezha Monitoring supports monitoring of server load, CPU, memory, hard disk, data transfer, monthly data transfer, number of processes, number of connections, and sends alarm notifications when one of these items reaches a user-set limit.


Flexible notification methods ​
#NEZHA# is the panel message placeholder, the panel will automatically replace the placeholder with the actual message when it triggers the notification
The content of Body is in JSON format：When the request type is FORM，the value is in the form of key:value，value can contain placeholders that will be automatically replaced when notified. When the request type is JSON It will only do string substitution and submit to the URL directly.
Placeholders can also be placed inside the URL, and it will perform a simple string substitution when requested.
Refer to the example below, it is very flexible.

+    
     
   
 
\ No newline at end of file
diff --git a/en_US/guide/dashboardq.html b/en_US/guide/dashboardq.html
index 00088ae8..30127cd5 100644
--- a/en_US/guide/dashboardq.html
+++ b/en_US/guide/dashboardq.html
@@ -10,11 +10,11 @@
     
   
   
-  
+  
   
   
   
-    
Nezha Monitoring
English
简体中文
English
简体中文
Appearance
On this page
Why the IP displayed in the admin panel and the actual IP of the Agent are not the same? ​
First of all, explain how the IP displayed in the admin panel is gotten: the Agent will request the IP-API every once in a while, get the IP information and report it to the Dashboard, the IP-API currently used can be viewed here: myip.go
 If you find that the IP displayed in the admin panel is not the same as the IP provided to you by the service provider, the biggest possibility is that the service provider gave you the entry IP, but the Agent tested out your exit IP. This problem may also occur in BGP servers and Leased line.
TIP
To take a simple and very common example, the service provider to provide you a anti-DDoS server, in order to meet the goals of both DDoS protection and low network disruption rate, the IP provided to you may be the mapped anti-DDoS IP and not the real exit IP of your server
You can also test the exit IP by running the following command in the Agent server:
shell
curl api.myip.la
+    
Nezha Monitoring
English
简体中文
English
简体中文
Appearance
On this page
Why the IP displayed in the admin panel and the actual IP of the Agent are not the same? ​
First of all, explain how the IP displayed in the admin panel is gotten: the Agent will request the IP-API every once in a while, get the IP information and report it to the Dashboard, the IP-API currently used can be viewed here: myip.go
 If you find that the IP displayed in the admin panel is not the same as the IP provided to you by the service provider, the biggest possibility is that the service provider gave you the entry IP, but the Agent tested out your exit IP. This problem may also occur in BGP servers and Leased line.
TIP
To take a simple and very common example, the service provider to provide you a anti-DDoS server, in order to meet the goals of both DDoS protection and low network disruption rate, the IP provided to you may be the mapped anti-DDoS IP and not the real exit IP of your server
You can also test the exit IP by running the following command in the Agent server:
shell
curl api.myip.la
 curl ip.sb
 curl ip-api.com
Forgot your access password or deleted your access password ​
Please view or edit the /opt/nezha/dashboard/data/config.yaml file.
 The password is located in the site-viewpassword item.
Dashboard install/restart/update failed: iptables ...... ​
First, try restarting docker and retrying again
shell
systemctl status docker
 systemctl restart docker
@@ -23,9 +23,9 @@
         expires      12h;
         error_log /dev/null;
         access_log /dev/null;
-    }
  1. Save the configuration and clear the cache in the browser, NginX, and CDN, then refresh the page and it should return to normal.

-    
+    }
  1. Save the configuration and clear the cache in the browser, NginX, and CDN, then refresh the page and it should return to normal.

+    
     
   
 
\ No newline at end of file
diff --git a/en_US/guide/loginq.html b/en_US/guide/loginq.html
index e43ca109..c93c0a24 100644
--- a/en_US/guide/loginq.html
+++ b/en_US/guide/loginq.html
@@ -10,13 +10,13 @@
     
   
   
-  
+  
   
   
   
-    
Nezha Monitoring
English
简体中文
English
简体中文
Appearance
On this page
Page refuses to connect or timeout after login callback ​
  1. Your server cannot connect to Github, consider trying several times or switching to Gitlab.
  2. You have configured the wrong callback URL, make sure your callback URL is correct and port and protocol are correct!
  3. An unknown error occurred in Dashboard, you can use the script to check the logs.
TIP
What is a protocol?
 In the browser, your domain name ending with :// is the protocol, usually http and https. Since the Dashboard may be accessible by multiple protocols + domain + port combinations under normal deployment, please make sure to choose the most appropriate one as the callback.
How do I check if my callback URL is wrong? ​
Please make sure the protocol+domain+port displayed by your browser before login and the protocol+domain+port you jump to after login are the same.
 Please make sure your path is /oauth2/callback, all lowercase.
Dashboard errors after login ​
Clear your browser cookies and log in again, or change your browser.
lookup xxx ​
DNS resolution failure, in most cases, is due to iptables-related configuration changes.
 It is recommended to restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
 If the lookup error still occurs, it is recommended to check whether there are other tools to control iptables, such as Aapanel Firewall.
 This problem may also be related to the kernel, please try to change the official kernel.
The authorization method is invalid, or the login callback URL is invalid, expired, or has been revoked ​
Suggest changing the authentication method to Github/Gitlab.
oauth2: server response missing access_token ​
It may be caused by a number of factors, the most likely is a network problem, we suggest to check the network and retry.
 If you can't solve it, we suggest changing the authentication method to Github/Gitlab.
This user is not the administrator or cannot login ​
You have logged into the wrong account or configured the wrong username, note that username is not email, you can use a script to modify it.
dial tcp xxx:443 i/o timeout ​
If the server has network problems, you can restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
 You can also change to another OAuth method if necessary.
net/http: TLS handshake timeout ​
Same as above.

-    
+    
Nezha Monitoring
English
简体中文
English
简体中文
Appearance
On this page
Page refuses to connect or timeout after login callback ​
  1. Your server cannot connect to Github, consider trying several times or switching to Gitlab.
  2. You have configured the wrong callback URL, make sure your callback URL is correct and port and protocol are correct!
  3. An unknown error occurred in Dashboard, you can use the script to check the logs.
TIP
What is a protocol?
 In the browser, your domain name ending with :// is the protocol, usually http and https. Since the Dashboard may be accessible by multiple protocols + domain + port combinations under normal deployment, please make sure to choose the most appropriate one as the callback.
How do I check if my callback URL is wrong? ​
Please make sure the protocol+domain+port displayed by your browser before login and the protocol+domain+port you jump to after login are the same.
 Please make sure your path is /oauth2/callback, all lowercase.
Dashboard errors after login ​
Clear your browser cookies and log in again, or change your browser.
lookup xxx ​
DNS resolution failure, in most cases, is due to iptables-related configuration changes.
 It is recommended to restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
 If the lookup error still occurs, it is recommended to check whether there are other tools to control iptables, such as Aapanel Firewall.
 This problem may also be related to the kernel, please try to change the official kernel.
The authorization method is invalid, or the login callback URL is invalid, expired, or has been revoked ​
Suggest changing the authentication method to Github/Gitlab.
oauth2: server response missing access_token ​
It may be caused by a number of factors, the most likely is a network problem, we suggest to check the network and retry.
 If you can't solve it, we suggest changing the authentication method to Github/Gitlab.
This user is not the administrator or cannot login ​
You have logged into the wrong account or configured the wrong username, note that username is not email, you can use a script to modify it.
dial tcp xxx:443 i/o timeout ​
If the server has network problems, you can restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
 You can also change to another OAuth method if necessary.
net/http: TLS handshake timeout ​
Same as above.

+    
     
   
 
\ No newline at end of file
diff --git a/en_US/guide/notifications.html b/en_US/guide/notifications.html
index ef6c0817..41ee7379 100644
--- a/en_US/guide/notifications.html
+++ b/en_US/guide/notifications.html
@@ -10,11 +10,11 @@
     
   
   
-  
+  
   
   
   
-    
Nezha Monitoring
English
简体中文
English
简体中文
Appearance
On this page
Nezha Monitoring supports monitoring of server load, CPU, memory, hard disk, data transfer, monthly data transfer, number of processes, number of connections, and sends alarm notifications when one of these items reaches a user-set limit.


Flexible notification methods ​
#NEZHA# is the panel message placeholder, the panel will automatically replace the placeholder with the actual message when it triggers the notification
The content of Body is in JSON format：When the request type is FORM，the value is in the form of key:value，value can contain placeholders that will be automatically replaced when notified. When the request type is JSON It will only do string substitution and submit to the URL directly.
Placeholders can also be placed inside the URL, and it will perform a simple string substitution when requested.
Refer to the example below, it is very flexible.
  • Bark Example
    • Name: Bark
    • URL: The first part is the key, followed by three matches/: key/: body or/: key/: title/: body or/: key/: category/: title/: body
    • Request method: GET
    • Request Type: Default
    • Body: null
    • Name: Bark
    • URL:/push
    • Request method: POST
    • Request type: FORM
    • Body: {"title": "#SERVER.NAME#","device_key":"xxxxxxxxx","body":"#NEZHA#","icon":" https://xxxxxxxx/nz.png "}
  • Telegram Example, contributed by @haitau
    • Name：Telegram Robot message notification
    • URL：https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&text=#NEZHA#
    • Request method: GET
    • Request type: default
    • Body: null
    • Notes for this method：The XXXXXX in botXXXXXX is the token provided when you follow the official @Botfather in Telegram and enter /newbot to create a new bot. (In the line after Use this token to access the HTTP API). The 'bot' are essential. After creating a bot, you need to talk to the BOT in Telegram (send a random message) before you can send a message by using API. YYYYYY is Telegram user's ID, you can get it by talking to the bot @userinfobot.
  • Email notification example - Outlook
    json
    {
+    
    Nezha Monitoring
    English
    简体中文
    English
    简体中文
    Appearance
    On this page
    Nezha Monitoring supports monitoring of server load, CPU, memory, hard disk, data transfer, monthly data transfer, number of processes, number of connections, and sends alarm notifications when one of these items reaches a user-set limit.


    Flexible notification methods ​
    #NEZHA# is the panel message placeholder, the panel will automatically replace the placeholder with the actual message when it triggers the notification
    The content of Body is in JSON format：When the request type is FORM，the value is in the form of key:value，value can contain placeholders that will be automatically replaced when notified. When the request type is JSON It will only do string substitution and submit to the URL directly.
    Placeholders can also be placed inside the URL, and it will perform a simple string substitution when requested.
    Refer to the example below, it is very flexible.
    • Bark Example
      • Name: Bark
      • URL: The first part is the key, followed by three matches/: key/: body or/: key/: title/: body or/: key/: category/: title/: body
      • Request method: GET
      • Request Type: Default
      • Body: null
      • Name: Bark
      • URL:/push
      • Request method: POST
      • Request type: FORM
      • Body: {"title": "#SERVER.NAME#","device_key":"xxxxxxxxx","body":"#NEZHA#","icon":" https://xxxxxxxx/nz.png "}
    • Telegram Example, contributed by @haitau
      • Name：Telegram Robot message notification
      • URL：https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&text=#NEZHA#
      • Request method: GET
      • Request type: default
      • Body: null
      • Notes for this method：The XXXXXX in botXXXXXX is the token provided when you follow the official @Botfather in Telegram and enter /newbot to create a new bot. (In the line after Use this token to access the HTTP API). The 'bot' are essential. After creating a bot, you need to talk to the BOT in Telegram (send a random message) before you can send a message by using API. YYYYYY is Telegram user's ID, you can get it by talking to the bot @userinfobot.
    • Email notification example - Outlook
      json
      {
     "message": {
         "subject": "Server Status Notification",
         "body": {
@@ -53,9 +53,9 @@
     "markdown": {
         "content": "# Nezha Notification\n\n\"#NEZHA#\"\n\n> ServerName: \"#SERVER.NAME#\"\n> IP: \"#SERVER.IP#\"\n> IPv4: \"#SERVER.IPV4#\"\n> IPv6: \"#SERVER.IPV6#\"\n> CPU: \"#SERVER.CPU#\"\n> Memory: \"#SERVER.MEM#\"\n> SWAP: \"#SERVER.SWAP#\"\n> Storage: \"#SERVER.DISK#\"\n> Real-time Upload: \"#SERVER.NETINSPEED#\"\n> Real-time Download: \"#SERVER.NETOUTSPEED#\"\n> Total Upload: \"#SERVER.TRANSFERIN#\"\n> Total Download: \"#SERVER.TRANSFEROUT#\"\n> 1m Load: \"#SERVER.LOAD1#\"\n> 5m Load: \"#SERVER.LOAD5#\"\n> 15m Load: \"#SERVER.LOAD15#\"\n> TCP Connections: \"#SERVER.TCPCONNCOUNT\"\n> UDP Connections: \"#SERVER.UDPCONNCOUNT\"\n\n"
     }
-}
      Delete relevant content information as needed
      Notice Picture


Description of notification rules ​
Basic Rules ​
  • Type: one or more types can be selected, such as in a rule to select more than one type, you need to meet all the selected types at the same time to trigger the notification (see the example later) 
    • cpu、memory、swap、disk
    • net_in_speed Inbound speed, net_out_speed Outbound speed, net_all_speed Inbound + Outbound speed, transfer_in Inbound Transfer, transfer_out Outbound Transfer, transfer_all Total Transfer
    • offline Offline monitoring
    • load1、load5、load15 Load
    • process_count Number of processes Currently, counting the number of processes takes up too many resources and is not supported at the moment
    • tcp_conn_count、udp_conn_count Number of connections
  • duration：Lasting for a few seconds, the notification will only be triggered when the sampling record reaches 30% or more within a few seconds
  • min/max 
    • Transfer, network speed, and other values of the same type. Unit is byte (1KB=1024B，1MB = 1024*1024B)
    • Memory, hard disk, CPU. units are usage percentages
    • No setup required for offline monitoring
  • cover [{"type":"offline","duration":10, "cover":0, "ignore":{"5": true}}]
    • 0 Cover all, use ignore to ignore specific servers
    • 1 Ignore all, use ignore to monitoring specific servers
       For example: [{"type":"offline","duration":10, "cover":0, "ignore":{"5": true}}]
  • ignore: Select to ignore specific servers, use with cover with server id and boolean, e.g.: {"1": true, "2":false}
Complete examples:
Add an offline notification
  • Name: Offline notification
  • Rules: [{"Type":"offline","Duration":10}]
  • Enable: √
Add an notification when the CPU exceeds 50% for 10s but the memory usage is below 20% for 20s
  • Name: CPU and RAM
  • Rules: [{"Type":"cpu","Min":0,"Max":50,"Duration":10},{"Type":"memory","Min":20,"Max":0,"Duration":20}]
  • Enable: √
Send specific server notifications to specific notification groups
Case:
 You have four servers, 1, 2, 3, 4, and two different notification groups, A and B
 1, 2 The two servers are down for 10 minutes and send a notification to Notification Group A
 3, 4 These two servers are down for ten minutes and then send a notification to Notification Group B
First you need to set up two notification groups, A and B, and then add two alarm rules:
Rule I:
  • Name: 1, 2 Off-line, send notification to group A
  • Rules:[{"type":"offline","duration":600,"cover":1,"ignore":{"1":true,"2":true}}]
  • Notification group: A
  • Enable: √
Rule II:
  • Name: 3, 4 Off-line, send notification to group B
  • Rules:[{"type":"offline","duration":600,"cover":1,"ignore":{"3":true,"4":true}}]
  • Notification group: B
  • Enable: √
Using these rules flexibly will help you to make full use of the notification function

Special: Any-cycle transfer notification ​
Can be used as monthly transfer notificatin
  • type
    • transfer_in_cycle Inbound transfer during the cycle
    • transfer_out_cycle Outbound transfer during the cycle
    • transfer_all_cycle The sum of inbound and outbound transfer during the cycle
  • cycle_start Start date of the statistical cycle (can be the start date of your server's billing cycle), the time format is RFC3339, for example, the format in Beijing time zone is 2022-01-11T08:00:00.00+08:00
  • cycle_interval Interval time cycle (For example, if the cycle is in days and the value is 7, it means that the statistics are counted every 7 days)
  • cycle_unit Statistics cycle unit, default hour, optional (hour, day, week, month, year)
  • min/max, cover, ignore Please refer to the basic rules to configure
Example:
The servers with ID 3 and 4 (defined in the ignore) are counted on the 1st of each month, and a notification is triggered when the monthly outbound transfer reaches 1TB during the cycle.
[{"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}}]
Description of mode of triggering notification ​
  • Always triggered: A notification is triggered each time the status reported by the Agent matches the rules of the notification
  • Triggered only once: only one notification is triggered when the state changes, such as changing from normal state to abnormal state or abnormal state back to normal state
Set the task to be executed when notification ​
If you need to perform a task while sending a notification message, you can set those items
  • Tasks to be triggered in case of failure The task to be executed when the notification status matches the change from "normal" to "failure", the task should be set in advance in the tasks page
  • Tasks to be triggered after fault recovery The task to be executed when the notification status matches the change from " failure " to " normal ", the task should be set in advance in the tasks page

-    
+}
Delete relevant content information as needed
Notice Picture


Description of notification rules ​
Basic Rules ​
  • Type: one or more types can be selected, such as in a rule to select more than one type, you need to meet all the selected types at the same time to trigger the notification (see the example later) 
    • cpu、memory、swap、disk
    • net_in_speed Inbound speed, net_out_speed Outbound speed, net_all_speed Inbound + Outbound speed, transfer_in Inbound Transfer, transfer_out Outbound Transfer, transfer_all Total Transfer
    • offline Offline monitoring
    • load1、load5、load15 Load
    • process_count Number of processes Currently, counting the number of processes takes up too many resources and is not supported at the moment
    • tcp_conn_count、udp_conn_count Number of connections
  • duration：Lasting for a few seconds, the notification will only be triggered when the sampling record reaches 30% or more within a few seconds
  • min/max 
    • Transfer, network speed, and other values of the same type. Unit is byte (1KB=1024B，1MB = 1024*1024B)
    • Memory, hard disk, CPU. units are usage percentages
    • No setup required for offline monitoring
  • cover [{"type":"offline","duration":10, "cover":0, "ignore":{"5": true}}]
    • 0 Cover all, use ignore to ignore specific servers
    • 1 Ignore all, use ignore to monitoring specific servers
       For example: [{"type":"offline","duration":10, "cover":0, "ignore":{"5": true}}]
  • ignore: Select to ignore specific servers, use with cover with server id and boolean, e.g.: {"1": true, "2":false}
Complete examples:
Add an offline notification
  • Name: Offline notification
  • Rules: [{"Type":"offline","Duration":10}]
  • Enable: √
Add an notification when the CPU exceeds 50% for 10s but the memory usage is below 20% for 20s
  • Name: CPU and RAM
  • Rules: [{"Type":"cpu","Min":0,"Max":50,"Duration":10},{"Type":"memory","Min":20,"Max":0,"Duration":20}]
  • Enable: √
Send specific server notifications to specific notification groups
Case:
 You have four servers, 1, 2, 3, 4, and two different notification groups, A and B
 1, 2 The two servers are down for 10 minutes and send a notification to Notification Group A
 3, 4 These two servers are down for ten minutes and then send a notification to Notification Group B
First you need to set up two notification groups, A and B, and then add two alarm rules:
Rule I:
  • Name: 1, 2 Off-line, send notification to group A
  • Rules:[{"type":"offline","duration":600,"cover":1,"ignore":{"1":true,"2":true}}]
  • Notification group: A
  • Enable: √
Rule II:
  • Name: 3, 4 Off-line, send notification to group B
  • Rules:[{"type":"offline","duration":600,"cover":1,"ignore":{"3":true,"4":true}}]
  • Notification group: B
  • Enable: √
Using these rules flexibly will help you to make full use of the notification function

Special: Any-cycle transfer notification ​
Can be used as monthly transfer notificatin
  • type
    • transfer_in_cycle Inbound transfer during the cycle
    • transfer_out_cycle Outbound transfer during the cycle
    • transfer_all_cycle The sum of inbound and outbound transfer during the cycle
  • cycle_start Start date of the statistical cycle (can be the start date of your server's billing cycle), the time format is RFC3339, for example, the format in Beijing time zone is 2022-01-11T08:00:00.00+08:00
  • cycle_interval Interval time cycle (For example, if the cycle is in days and the value is 7, it means that the statistics are counted every 7 days)
  • cycle_unit Statistics cycle unit, default hour, optional (hour, day, week, month, year)
  • min/max, cover, ignore Please refer to the basic rules to configure
Example:
The servers with ID 3 and 4 (defined in the ignore) are counted on the 1st of each month, and a notification is triggered when the monthly outbound transfer reaches 1TB during the cycle.
[{"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}}]
Description of mode of triggering notification ​
  • Always triggered: A notification is triggered each time the status reported by the Agent matches the rules of the notification
  • Triggered only once: only one notification is triggered when the state changes, such as changing from normal state to abnormal state or abnormal state back to normal state
Set the task to be executed when notification ​
If you need to perform a task while sending a notification message, you can set those items
  • Tasks to be triggered in case of failure The task to be executed when the notification status matches the change from "normal" to "failure", the task should be set in advance in the tasks page
  • Tasks to be triggered after fault recovery The task to be executed when the notification status matches the change from " failure " to " normal ", the task should be set in advance in the tasks page
+ \ No newline at end of file diff --git a/en_US/guide/q2.html b/en_US/guide/q2.html index b1a4510a..97bbd807 100644 --- a/en_US/guide/q2.html +++ b/en_US/guide/q2.html @@ -10,13 +10,13 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Let the Agent start/on-line, and the self-test process of the problem ​

  1. Run //opt/nezha/agent/nezha-agent -s IP/Domin(Panel IP or Domain not connected to CDN):port(Panel RPC port) -p secret(Agent Secret) -d Check the logs to see if the timeout is due to a DNS problem or poor network
  2. nc -v domain/IP port(Panel RPC port) or telnet domain/IP port(Panel RPC port) to check if it' s a network problem, check the inbound and outbound firewall between the local machine and the panel server, if you can' t determine the problem you can check it with the port checking tool provided by https://port.ping.pe/
  3. If the above steps work and the Agent is online, please try to turn off SELinux on the panel server. How to close SELinux？
- +
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Let the Agent start/on-line, and the self-test process of the problem ​

  1. Run //opt/nezha/agent/nezha-agent -s IP/Domin(Panel IP or Domain not connected to CDN):port(Panel RPC port) -p secret(Agent Secret) -d Check the logs to see if the timeout is due to a DNS problem or poor network
  2. nc -v domain/IP port(Panel RPC port) or telnet domain/IP port(Panel RPC port) to check if it' s a network problem, check the inbound and outbound firewall between the local machine and the panel server, if you can' t determine the problem you can check it with the port checking tool provided by https://port.ping.pe/
  3. If the above steps work and the Agent is online, please try to turn off SELinux on the panel server. How to close SELinux？
+ \ No newline at end of file diff --git a/en_US/guide/q3.html b/en_US/guide/q3.html index 0ab00393..e5a81a9a 100644 --- a/en_US/guide/q3.html +++ b/en_US/guide/q3.html @@ -10,11 +10,11 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Reverse Proxy gRPC Port (support Cloudflare CDN) ​

Use Nginx or Caddy to reverse proxy gRPC

  • Nginx configuration files
nginx
server {
+    
Nezha Monitoring
English
简体中文
English
简体中文
Appearance
On this page
Reverse Proxy gRPC Port (support Cloudflare CDN) ​
Use Nginx or Caddy to reverse proxy gRPC
  • Nginx configuration files
nginx
server {
     listen 443 ssl http2;
     listen [::]:443 ssl http2;
     server_name data.example.com; # The domain name where the Agent connects to Dashboard
@@ -42,9 +42,9 @@
             versions h2c 2
         }
     }
-}
Dashboard Configuration
  • First login to the Dashboard and enter the admin panel, go to the settings page, fill in the CDN Bypassed Domain/IP with the domain name you configured in Nginx or Caddy, for example data.example.com, and save it.
  • Then open the /opt/nezha/dashboard/data/config.yaml file in the panel server and change proxygrpcport to the port that Nginx or Caddy is listening on, such as 443 as set in the previous step. Since we have SSL/TLS enabled in Nginx or Caddy, we need to set tls to true, restart the panel when you are done.
Agent Configuration
  • Log in to the admin panel, copy the one-click install command, and run the one-click install command on the corresponding server to reinstall the agent.
Enable Cloudflare CDN (optional)
According to Cloudflare gRPC requirements: gRPC services must listen on port 443 and must support TLS and HTTP/2. So if you need to enable CDN, you must use port 443 when configuring Nginx or Caddy reverse proxy gRPC and configure the certificate (Caddy will automatically apply and configure the certificate).
  • Log in to Cloudflare and select the domain you are using. Go to the Network page and turn on the gRPC switch, then go to the DNS page, find the resolution record of the domain with gRPC configuration, and turn on the orange cloud icon to enable CDN.

-    
+}

Dashboard Configuration

Agent Configuration

Enable Cloudflare CDN (optional)

According to Cloudflare gRPC requirements: gRPC services must listen on port 443 and must support TLS and HTTP/2. So if you need to enable CDN, you must use port 443 when configuring Nginx or Caddy reverse proxy gRPC and configure the certificate (Caddy will automatically apply and configure the certificate).

+ \ No newline at end of file diff --git a/en_US/guide/q4.html b/en_US/guide/q4.html index 2643eedb..9a4db887 100644 --- a/en_US/guide/q4.html +++ b/en_US/guide/q4.html @@ -10,13 +10,13 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Real-time channel disconnection/online terminal connection failure ​

  • If you are using a CDN, please make sure that the CDN provider provides WebSocket service and that WebSocket is enabled
  • Confirm that you are using a reverse proxy requires special configuration of the WebSocket for the /ws and /terminal paths, you can click here to see the reverse proxy configuration
- +
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Real-time channel disconnection/online terminal connection failure ​

  • If you are using a CDN, please make sure that the CDN provider provides WebSocket service and that WebSocket is enabled
  • Confirm that you are using a reverse proxy requires special configuration of the WebSocket for the /ws and /terminal paths, you can click here to see 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 59131e30..bd4cf7ae 100644 --- a/en_US/guide/q5.html +++ b/en_US/guide/q5.html @@ -10,13 +10,13 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

How do I migrate my data to the new server and restore my backups? ​

  1. First use the one-click script and select Stop Panel
  2. Compress the /opt/nezha folder to the same path as the new server
  3. Run the one-click script in the new server, select Launch Panel
- +
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

How do I migrate my data to the new server and restore my backups? ​

  1. First use the one-click script and select Stop Panel
  2. Compress the /opt/nezha folder to the same path as the new server
  3. Run the one-click script in the new server, select Launch Panel
+ \ No newline at end of file diff --git a/en_US/guide/q6.html b/en_US/guide/q6.html index a41aa985..8b584ec8 100644 --- a/en_US/guide/q6.html +++ b/en_US/guide/q6.html @@ -10,13 +10,13 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

How to set up a monthly reset of transfer statistics? ​

In the home page, the traffic statistics will be reset when the server is restarted.
If you want to set the traffic statistics to be reset once a month, you can do it like this:

  1. Go to the Notification page of the admin panel
  2. Refer to this document to create a monthly transfer statistics notification
  3. Return to the home page and you can see the monthly transfer statistics in the Service page, where the statistics will not be reset when the server is restarted

TIP

This method can be set to any period, including and not limited to hourly/daily/weekly/monthly/yearly reset transfer statistics, very flexible!

- +
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

How to set up a monthly reset of transfer statistics? ​

In the home page, the traffic statistics will be reset when the server is restarted.
If you want to set the traffic statistics to be reset once a month, you can do it like this:

  1. Go to the Notification page of the admin panel
  2. Refer to this document to create a monthly transfer statistics notification
  3. Return to the home page and you can see the monthly transfer statistics in the Service page, where the statistics will not be reset when the server is restarted

TIP

This method can be set to any period, including and not limited to hourly/daily/weekly/monthly/yearly reset transfer statistics, very flexible!

+ \ No newline at end of file diff --git a/en_US/guide/q7.html b/en_US/guide/q7.html index 21bdf9d4..a5b86017 100644 --- a/en_US/guide/q7.html +++ b/en_US/guide/q7.html @@ -10,13 +10,13 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Customize Agent ​

Customize the NIC and hard drive partitions to be monitored ​

  • Run /opt/nezha/agent/nezha-agent --edit-agent-config to select a custom NIC and partition, and then restart Agent

Other Flags ​

Run ./nezha-agent --help to view supported flags，if you are already using the one-click script, you can edit /etc/systemd/system/nezha-agent.service，at the end of this line ExecStart= add:

  • --report-delay System information reporting interval, default is 1 second, can be set to 3 to reduce the system resource usage on the agent side (configuration range 1-4)
  • --skip-conn Not monitoring the number of connections, if it is a server with a large number of connections, the CPU usage will be high. It is recommended to set this to reduce CPU usage
  • --skip-procs Disable monitoring the number of processes can also reduce CPU and memory usage
  • --disable-auto-update Disable Automatic Update Agent (security feature)
  • --disable-force-update Disable Forced Update Agent (security feature)
  • --disable-command-execute Disable execution of scheduled tasks, disallow WebShell (security feature)
  • --tls Enable SSL/TLS encryption (If you are using nginx to reverse proxy Agent´s grpc connections, and if nginx has SSL/TLS enabled, you need to enable this configuration)
- +
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Customize Agent ​

Customize the NIC and hard drive partitions to be monitored ​

  • Run /opt/nezha/agent/nezha-agent --edit-agent-config to select a custom NIC and partition, and then restart Agent

Other Flags ​

Run ./nezha-agent --help to view supported flags，if you are already using the one-click script, you can edit /etc/systemd/system/nezha-agent.service，at the end of this line ExecStart= add:

  • --report-delay System information reporting interval, default is 1 second, can be set to 3 to reduce the system resource usage on the agent side (configuration range 1-4)
  • --skip-conn Not monitoring the number of connections, if it is a server with a large number of connections, the CPU usage will be high. It is recommended to set this to reduce CPU usage
  • --skip-procs Disable monitoring the number of processes can also reduce CPU and memory usage
  • --disable-auto-update Disable Automatic Update Agent (security feature)
  • --disable-force-update Disable Forced Update Agent (security feature)
  • --disable-command-execute Disable execution of scheduled tasks, disallow WebShell (security feature)
  • --tls Enable SSL/TLS encryption (If you are using nginx to reverse proxy Agent´s grpc connections, and if nginx has SSL/TLS enabled, you need to enable this configuration)
+ \ No newline at end of file diff --git a/en_US/guide/servers.html b/en_US/guide/servers.html index 03f336d7..d20eeb84 100644 --- a/en_US/guide/servers.html +++ b/en_US/guide/servers.html @@ -10,13 +10,13 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Servers ​

Introduction ​

The Servers area is responsible for managing the Agent, the most basic area in Nezha Monitoring, and the basis for other functions.

Add a server ​

The first step is to add a servers, which can be customized with names, groups, display index and notes.
Servers in the same group will be displayed in groups in supported themes, and notes will only be displayed in the admin panel, no need to worry about leaking information.

Install Agent ​

Please refer to the previous article: Install Agent
We recommend using one-click installation, that is, after configuring the communication domain name, click the button on the column one-click installation and copy it to the monitored servers for installation.

Forced Updates ​

The flags related to the update of the Agent are: --disable-auto-update and --disable-force-update. Please refer to Customize Agent
By default, the Agent is updated automatically, but when the user turns off automatic updates, the specified servers can also be selected for forced updates.
This feature does not take effect when -disable-force-update is turned on.

Data List ​

  • Version number: Record the current version of Agent
  • Secret: Used when configuring the Agent
  • One-Click Installation: A more convenient way to install Agent
  • Manage: WebShell on the left, Edit in the middle, Delete on the right

Webshell ​

This feature does not take effect when disable-command-execute is turned on.
Both Linux and Windows are available and can be pasted using Ctrl+Shift+V.
For connection failure, please refer to Real-time channel disconnection/online terminal connection failure.
Note that in theWebShell function, the Agent also connects to the Domain names for public access via WebSocket, not via grpc.

- +
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Servers ​

Introduction ​

The Servers area is responsible for managing the Agent, the most basic area in Nezha Monitoring, and the basis for other functions.

Add a server ​

The first step is to add a servers, which can be customized with names, groups, display index and notes.
Servers in the same group will be displayed in groups in supported themes, and notes will only be displayed in the admin panel, no need to worry about leaking information.

Install Agent ​

Please refer to the previous article: Install Agent
We recommend using one-click installation, that is, after configuring the communication domain name, click the button on the column one-click installation and copy it to the monitored servers for installation.

Forced Updates ​

The flags related to the update of the Agent are: --disable-auto-update and --disable-force-update. Please refer to Customize Agent
By default, the Agent is updated automatically, but when the user turns off automatic updates, the specified servers can also be selected for forced updates.
This feature does not take effect when -disable-force-update is turned on.

Data List ​

  • Version number: Record the current version of Agent
  • Secret: Used when configuring the Agent
  • One-Click Installation: A more convenient way to install Agent
  • Manage: WebShell on the left, Edit in the middle, Delete on the right

Webshell ​

This feature does not take effect when disable-command-execute is turned on.
Both Linux and Windows are available and can be pasted using Ctrl+Shift+V.
For connection failure, please refer to Real-time channel disconnection/online terminal connection failure.
Note that in theWebShell function, the Agent also connects to the Domain names for public access via WebSocket, not via grpc.

+ \ No newline at end of file diff --git a/en_US/guide/services.html b/en_US/guide/services.html index 3348dadd..0412e75d 100644 --- a/en_US/guide/services.html +++ b/en_US/guide/services.html @@ -10,13 +10,13 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Service area is a function setting area for setting up Agents to monitor external websites or servers
The monitoring results can be viewed on the "Services" page in the home page

How to use ​

To add a new monitor, you can go to the "Services" page in the administration panel and click "Add Service Monitor".

To add a service monitor, you need to complete the following settings:

  • Name - Customize a name

  • Type - Select a monitoring type. Nezha currently supports three monitoring types: "HTTP-GET", "ICMP-Ping" and "TCP-Ping".

  • Target - Depending on the type you choose, the target is set in different ways

  • HTTP-GET: Selecting this type, you should enter a URL as the target, the URL should be added with http:// or https:// If your target URL is https://, it will also monitor the SSL certificate of that URL and trigger a notification when the SSL certificate expires or changes.
    For example: https://example.com
  • ICMP-Ping: When selecting this type, you should enter a domain name or IP without a port number
    For example: 1.1.1.1 or example.com
  • TCP-Ping: When selecting this type, you should enter a domain name or IP and include the port number
    For example: 1.1.1.1:80 or example.com:22

  • Interval： Sets the time interval in seconds between each time Agent sends requests to the target

  • Coverage： Select a rule to determine which Agents to use to send requests to the target

  • Specific Servers： Use with coverage to select the Agent to be excluded from the rule

  • Notification Group： Select the notification method you have set up on the "Notification" page. Click here for more information

  • Enable Failure Notification： Select whether to receive target failure notifications as needed, default is inactive

After setting, click "Add" and you are done.
Wait for a moment to go to the "Services" page on the home page to view the monitoring results

Notification of delay changes ​

Nezha Monitoring monitors and statistics the delay between the Agent and the target server, and sends notifications in case of significant changes
Use this feature to help you monitor your server's routes for changes

  • Enable delay notifications：When enabled, notifications will be sent when the Agent to target server delay is higher than the Max delay or lower than the Min delay

Management Monitor ​

To manage existing service monitoring, you can go to the "Services" page in the administration panel
Select a monitoring configuration and click the icon on the right to edit or delete it

- +
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Service area is a function setting area for setting up Agents to monitor external websites or servers
The monitoring results can be viewed on the "Services" page in the home page

How to use ​

To add a new monitor, you can go to the "Services" page in the administration panel and click "Add Service Monitor".

To add a service monitor, you need to complete the following settings:

  • Name - Customize a name

  • Type - Select a monitoring type. Nezha currently supports three monitoring types: "HTTP-GET", "ICMP-Ping" and "TCP-Ping".

  • Target - Depending on the type you choose, the target is set in different ways

  • HTTP-GET: Selecting this type, you should enter a URL as the target, the URL should be added with http:// or https:// If your target URL is https://, it will also monitor the SSL certificate of that URL and trigger a notification when the SSL certificate expires or changes.
    For example: https://example.com
  • ICMP-Ping: When selecting this type, you should enter a domain name or IP without a port number
    For example: 1.1.1.1 or example.com
  • TCP-Ping: When selecting this type, you should enter a domain name or IP and include the port number
    For example: 1.1.1.1:80 or example.com:22

  • Interval： Sets the time interval in seconds between each time Agent sends requests to the target

  • Coverage： Select a rule to determine which Agents to use to send requests to the target

  • Specific Servers： Use with coverage to select the Agent to be excluded from the rule

  • Notification Group： Select the notification method you have set up on the "Notification" page. Click here for more information

  • Enable Failure Notification： Select whether to receive target failure notifications as needed, default is inactive

After setting, click "Add" and you are done.
Wait for a moment to go to the "Services" page on the home page to view the monitoring results

Notification of delay changes ​

Nezha Monitoring monitors and statistics the delay between the Agent and the target server, and sends notifications in case of significant changes
Use this feature to help you monitor your server's routes for changes

  • Enable delay notifications：When enabled, notifications will be sent when the Agent to target server delay is higher than the Max delay or lower than the Min delay

Management Monitor ​

To manage existing service monitoring, you can go to the "Services" page in the administration panel
Select a monitoring configuration and click the icon 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 15743477..ffcc3844 100644 --- a/en_US/guide/settings.html +++ b/en_US/guide/settings.html @@ -10,11 +10,11 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Site Title ​

You can customize your site title here

Admin List ​

  • If you have changed your Github, Gitlab, Jihulab, Gitee username, you can change it in this item, otherwise you can't log in, please separate multiple users with commas: user1,user2

  • To change your administrator account, please go to /opt/nezha/dashboard/data/config.yaml to set the new administrator Client ID and Client Secret.

Theme ​

Select the home page theme here, and update the panel if there is not an existing theme in the options

Language ​

Nezha Monitoring currently supports the following languages:

  • 简体中文
  • English
  • Español

Crowdin
We welcome corrections to translations and contributions of additional languages

Custom code (style, script) ​

Change logo, change color tone, add statistics code, etc.

WARNING

The custom code only takes effect in the visitor's home page, not in the admin panel.
Since the code of different themes is different, if you really need to modify the content of the admin panel, please enter Docker to changes it by yourself.


Example of changing the default theme progress bar color ​

html
<style>
+    
Nezha Monitoring
English
简体中文
English
简体中文
Appearance
On this page
Site Title ​
You can customize your site title here

Admin List ​
  • If you have changed your Github, Gitlab, Jihulab, Gitee username, you can change it in this item, otherwise you can't log in, please separate multiple users with commas: user1,user2
  • To change your administrator account, please go to /opt/nezha/dashboard/data/config.yaml to set the new administrator Client ID and Client Secret.

Theme ​
Select the home page theme here, and update the panel if there is not an existing theme in the options

Language ​
Nezha Monitoring currently supports the following languages:
  • 简体中文
  • English
  • Español
Crowdin
 We welcome corrections to translations and contributions of additional languages

Custom code (style, script) ​
Change logo, change color tone, add statistics code, etc.
WARNING
The custom code only takes effect in the visitor's home page, not in the admin panel.
 Since the code of different themes is different, if you really need to modify the content of the admin panel, please enter Docker to changes it by yourself.

Example of changing the default theme progress bar color ​
html
<style>
 .ui.fine.progress> .bar {
     background-color: pink !important;
 }
@@ -57,9 +57,9 @@
 .hotaru-cover {
    background: url(https://s3.ax1x.com/2020/12/08/DzHv6A.jpg) center;
 }
-</style>
Access Password ​
If you don't want to show your homepage directly, you can set a access password here
 After setting the password, you need to enter the password to access the homepage

CDN Bypassed Domain/IP ​
This setting is a prerequisite for using the one-click script to install the Agent, see here for details 
IP Change Alert ​
If you want to be notified when a server's ip changes, you can set it up here
Coverage ​
Select a rule here to determine which servers need to be monitored, and you can choose according to your needs
Specific Servers ​
In conjunction with the coverage settings, set the exclusions for the selected rule here
Send Notification To Specific Notification Group ​
Select the notification method, please set the notification method in the "Notifications" page

WARNING
When the settings are completed, the notification takes effect when enabled is activated

WARNING
IP Change Alert does not show ip by default, if you don't want to hide it, you can activate "Do NOT desensitize Server IP In Notification Messages"

-    
+</style>

Access Password ​

If you don't want to show your homepage directly, you can set a access password here
After setting the password, you need to enter the password to access the homepage

CDN Bypassed Domain/IP ​

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

IP Change Alert ​

If you want to be notified when a server's ip changes, you can set it up here

Coverage ​

Select a rule here to determine which servers need to be monitored, and you can choose according to your needs

Specific Servers ​

In conjunction with the coverage settings, set the exclusions for the selected rule here

Send Notification To Specific Notification Group ​

Select the notification method, please set the notification method in the "Notifications" page

WARNING

When the settings are completed, the notification takes effect when enabled is activated


WARNING

IP Change Alert does not show ip by default, if you don't want to hide it, you can activate "Do NOT desensitize Server IP In Notification Messages"

+ \ No newline at end of file diff --git a/en_US/guide/tasks.html b/en_US/guide/tasks.html index 961b4fc4..3474a640 100644 --- a/en_US/guide/tasks.html +++ b/en_US/guide/tasks.html @@ -10,13 +10,13 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

In the task area, you can set up scheduled tasks, Trigger tasks, and multi-server batch execution tasks

Nezha monitoring supports pushing commands to the Agent for execution, so this feature is very flexible and can be used to periodically back up the server in conjunction with restic, rclone. Periodically restart a service to reset the network connection. It can also be used with notifications to perform a task when a notification is triggered, such as running a script when the CPU is at high occupancy for a long period of time.

How to use ​

Go to the "Tasks" page of the admin panel and click "Add Scheduled Task"
To add a scheduled task you need to make the following settings:

  • Name - Customize a task name

  • Task Type - select the type of task
    Scheduled Tasks - Tasks are executed periodically at the scheduled time set below
    Trigger Tasks - Tasks that are triggered only by API or notification rules and are executed once per trigger

  • Cron Expression - (Not valid when using the trigger task type) Set schedule time, the Cron Expression is like:： * * * * * * sec min hour day month week, see details in CRON Expression Format
    For example: 0 0 3 * * * is Every day at 3 o'clock

  • Command - Just like writing shell/bat scripts, but line wrap is not recommended, Multiple Commands should be connected with &&/&
    For example, to execute a periodic reboot command, you can type reboot here

  • Coverage and Specific Servers - Similar to the settings on the Services page, select rules to determine which Agents need to execute scheduled tasks
    When using the trigger task type, you can select Only servers that are included in the notification rule

  • Notification Group - Select the notification method you have set up on the "Notification" page. Click here for more information

  • Send Success Notification - When this item is activated, a message notification will be triggered when the task is successfully executed

Manage tasks ​

To manage existing scheduled tasks, you can go to the "Tasks" page in the administration panel
Select a task configuration and the three icons on the right, which are:

  • Execute Now - When clicked, the scheduled time will be ignored and the task will be executed immediately
  • Edit - Click to modify the task configuration
  • Delete - Delete this scheduled task

FAQ ​

  1. Command not found
    Command not found may cause by missing PATH environment variable, for Linux Server, you may try adding source ~/.bashrc at beginning of your command or execute by absolute path.
- +
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

In the task area, you can set up scheduled tasks, Trigger tasks, and multi-server batch execution tasks

Nezha monitoring supports pushing commands to the Agent for execution, so this feature is very flexible and can be used to periodically back up the server in conjunction with restic, rclone. Periodically restart a service to reset the network connection. It can also be used with notifications to perform a task when a notification is triggered, such as running a script when the CPU is at high occupancy for a long period of time.

How to use ​

Go to the "Tasks" page of the admin panel and click "Add Scheduled Task"
To add a scheduled task you need to make the following settings:

  • Name - Customize a task name

  • Task Type - select the type of task
    Scheduled Tasks - Tasks are executed periodically at the scheduled time set below
    Trigger Tasks - Tasks that are triggered only by API or notification rules and are executed once per trigger

  • Cron Expression - (Not valid when using the trigger task type) Set schedule time, the Cron Expression is like:： * * * * * * sec min hour day month week, see details in CRON Expression Format
    For example: 0 0 3 * * * is Every day at 3 o'clock

  • Command - Just like writing shell/bat scripts, but line wrap is not recommended, Multiple Commands should be connected with &&/&
    For example, to execute a periodic reboot command, you can type reboot here

  • Coverage and Specific Servers - Similar to the settings on the Services page, select rules to determine which Agents need to execute scheduled tasks
    When using the trigger task type, you can select Only servers that are included in the notification rule

  • Notification Group - Select the notification method you have set up on the "Notification" page. Click here for more information

  • Send Success Notification - When this item is activated, a message notification will be triggered when the task is successfully executed

Manage tasks ​

To manage existing scheduled tasks, you can go to the "Tasks" page in the administration panel
Select a task configuration and the three icons on the right, which are:

  • Execute Now - When clicked, the scheduled time will be ignored and the task will be executed immediately
  • Edit - Click to modify the task configuration
  • Delete - Delete this scheduled task

FAQ ​

  1. Command not found
    Command not found may cause by missing PATH environment variable, for Linux Server, you may try adding source ~/.bashrc at beginning of your command or execute by absolute path.
+ \ No newline at end of file diff --git a/en_US/index.html b/en_US/index.html index 50b16330..3aa63629 100644 --- a/en_US/index.html +++ b/en_US/index.html @@ -10,13 +10,13 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

Nezha Monitoring

A open source, lightweight server and website monitoring and O&M tool

Learn More →

One-Click Installation

Support one-click script installation Dashboard and Agent services for easy use; mainstream systems such as Linux, Windows, MacOS, OpenWRT, etc. are all supported.

Real-time monitoring

Supports monitoring the system status of multiple servers simultaneously, including monitoring the status of web pages, ports, and SSL certificates. It also supports sending notifications when there are failures or when data reaches the limit. Multiple notification methods are supported, such as Telegram, email, and WeChat.

Easy O&M

Support WebSSH, support data monitoring, support setting scheduled tasks, and support batch execution of tasks on servers.

- +
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

Nezha Monitoring

A open source, lightweight server and website monitoring and O&M tool

Learn More →

One-Click Installation

Support one-click script installation Dashboard and Agent services for easy use; mainstream systems such as Linux, Windows, MacOS, OpenWRT, etc. are all supported.

Real-time monitoring

Supports monitoring the system status of multiple servers simultaneously, including monitoring the status of web pages, ports, and SSL certificates. It also supports sending notifications when there are failures or when data reaches the limit. Multiple notification methods are supported, such as Telegram, email, and WeChat.

Easy O&M

Support WebSSH, support data monitoring, support setting scheduled tasks, and support batch execution of tasks on servers.

+ \ No newline at end of file diff --git a/guide/agent.html b/guide/agent.html index ea7fec1f..8d2ab3e0 100644 --- a/guide/agent.html +++ b/guide/agent.html @@ -10,11 +10,11 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

哪吒监控的被控端服务被称为 Agent，本文档将介绍如何在被控端服务器上安装 Agent，并与 Dashboard 连接

一键安装 Agent ​

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

准备工作 ​

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

在 Linux 中一键安装 (Ubuntu、Debian、CentOS) ​

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

在 Windows 中一键安装 ​

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



其他方式安装 Agent ​

在 Linux 中安装 Agent (Ubuntu、Debian、CentOS) ​

  • 首先在管理面板中添加一台服务器
  • 在被控服务器中，运行脚本（位于中国大陆的服务器请使用镜像）：
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh

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

bash
curl -L https://cdn.jsdelivr.net/gh/naiba/nezha@master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh
  • 选择“安装监控 Agent”
  • 输入通信域名，如：”data.example.com“
  • 输入面板通信端口（RPC端口），默认为 5555
  • 输入 Agent 密钥，Agent 密钥在管理面板中添加服务器时生成，可以在管理面板中的“主机”页中找到
  • 等待安装完成后返回 Dashboard 主页查看服务器是否上线

在 其他 Linux 如 Alpine 使用 Openrc 的发行版 安装 Agent ​

本节内容由 unknown0054 贡献

  • 修改 SERVER、SECRET、TLS 然后在 shell 中执行
shell
cat >/etc/init.d/nezha-agent<< EOF
+    
哪吒监控
简体中文
English
简体中文
English
Appearance
On this page
哪吒监控的被控端服务被称为 Agent，本文档将介绍如何在被控端服务器上安装 Agent，并与 Dashboard 连接

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

准备工作 ​
你需要提前在管理面板中设置好通信域名，此域名不可以接入CDN，这里以前面提到过的示例通信域名 “data.example.com” 来做演示
 进入后台管理面板，转到“设置”页，在“未接入 CDN 的面板服务器域名/IP”项中填入通信域名，然后点击"保存"

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

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



其他方式安装 Agent ​
在 Linux 中安装 Agent (Ubuntu、Debian、CentOS) ​
  • 首先在管理面板中添加一台服务器
  • 在被控服务器中，运行脚本（位于中国大陆的服务器请使用镜像）：
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
如果你的被控服务器位于中国大陆，可以使用镜像：
bash
curl -L https://cdn.jsdelivr.net/gh/naiba/nezha@master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh
  • 选择“安装监控 Agent”
  • 输入通信域名，如：”data.example.com“
  • 输入面板通信端口（RPC端口），默认为 5555
  • 输入 Agent 密钥，Agent 密钥在管理面板中添加服务器时生成，可以在管理面板中的“主机”页中找到
  • 等待安装完成后返回 Dashboard 主页查看服务器是否上线

在 其他 Linux 如 Alpine 使用 Openrc 的发行版 安装 Agent ​
本节内容由 unknown0054 贡献
  • 修改 SERVER、SECRET、TLS 然后在 shell 中执行
shell
cat >/etc/init.d/nezha-agent<< EOF
 #!/sbin/openrc-run
 SERVER="" #Dashboard 地址 ip:port
 SECRET="" #SECRET
@@ -151,9 +151,9 @@
  stop
  sleep 2
  start
-}
  • 运行 chmod +x /etc/init.d/nezha-service 赋予执行权限
  • 启动服务： /etc/init.d/nezha-service enable && /etc/init.d/nezha-service start



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

-    
+}

FAQ ​

Agent 有 Docker 镜像吗？ ​

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

+ \ No newline at end of file diff --git a/guide/agentq.html b/guide/agentq.html index 4023125a..463e081b 100644 --- a/guide/agentq.html +++ b/guide/agentq.html @@ -10,13 +10,13 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

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

请查看 Dashboard 相关-为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？
在此不再赘述。

一键脚本安装时出错 ​

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

多出现在国内主机中，目前一键脚本只从 Github 直接获取安装脚本，您可以多尝试几次，或者手动安装 Agent，别忘了使用镜像。

sudo: command not found ​

请先手动安装 sudo。

- +
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

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

请查看 Dashboard 相关-为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？
在此不再赘述。

一键脚本安装时出错 ​

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

多出现在国内主机中，目前一键脚本只从 Github 直接获取安装脚本，您可以多尝试几次，或者手动安装 Agent，别忘了使用镜像。

sudo: command not found ​

请先手动安装 sudo。

+ \ No newline at end of file diff --git a/guide/api.html b/guide/api.html index 64ade102..42a06a3f 100644 --- a/guide/api.html +++ b/guide/api.html @@ -10,11 +10,11 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

哪吒面板现在已经支持使用 API 接口查询面板中 Agent 的状态信息

创建 Token ​

哪吒面板的 API 接口允许使用 Token 认证与 Cookies 认证
要新建一个 Token，在进入管理面板后，点击右上角的头像，选择 “API Token”，进入 Token 管理页面
点击 “添加 Token”，自定义备注后，点击 “添加”
如需删除一个 Token，请选择相应的 Token，点击右侧的删除图标

WARNING

Token 是 API 接口的鉴权工具，它对你的面板的信息安全非常重要，请不要泄漏你的 Token 给他人

认证方式 ​

Token 认证方式：

Request Headers:  
+    
哪吒监控
简体中文
English
简体中文
English
Appearance
On this page
哪吒面板现在已经支持使用 API 接口查询面板中 Agent 的状态信息
创建 Token ​
哪吒面板的 API 接口允许使用 Token 认证与 Cookies 认证
 要新建一个 Token，在进入管理面板后，点击右上角的头像，选择 “API Token”，进入 Token 管理页面
 点击 “添加 Token”，自定义备注后，点击 “添加”
 如需删除一个 Token，请选择相应的 Token，点击右侧的删除图标
WARNING
Token 是 API 接口的鉴权工具，它对你的面板的信息安全非常重要，请不要泄漏你的 Token 给他人
认证方式 ​
Token 认证方式：
Request Headers:  
 Authorization: Token
使用说明 ​
WARNING
下面示例中的负数时间戳为（0000-00-00）
 目前表示 Dashboard 上线后该 Agent 从未汇报过
 但不建议用正负性判断状态
TIP
请求方式为 Get，返回格式为 JSON
  • 获取服务器列表：GET /api/v1/server/list?tag=
     query: tag (ServerTag 是服务器的分组，提供此参数则仅查询该分组中的服务器)
JSON 返回示例：
{
     "code": 0,
     "message": "success",
@@ -123,9 +123,9 @@
             }
         }
     ]
-}

-    
+}
+ \ No newline at end of file diff --git a/guide/dashboard.html b/guide/dashboard.html index 4b40bd09..b04dc852 100644 --- a/guide/dashboard.html +++ b/guide/dashboard.html @@ -10,11 +10,11 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

准备工作 ​

搭建一个哪吒监控，你需要：

  1. 一台可以连接公网的 VPS，防火墙和安全策略需要放行 8008 和 5555 端口，否则会无法访问和无法接收数据。单核 512MB 内存的服务器配置就足以满足大多数使用场景
  2. 一个已经设置好 A 记录，指向 Dashboard 服务器 ip 的域名

TIP

如果你想使用 CDN，请准备两个域名，一个配置好 CDN 用作公开访问，CDN 需要支持WebSocket 协议；另一个域名不要使用 CDN，用作 Agent 端与 Dashboard 的通信
本文档分别以 "cdn.example.com" 和 "data.example.com" 两个域名来演示

  1. 一个 Github 账号（或：Gitlab、Jihulab、Gitee）

TIP

如果您位于中国大陆，访问 Github 有困难，我们建议您选择 Jihulab 作为 OAuth 提供商

本文档将以宝塔面板反代面板的过程作为范例，随着未来版本的变化，部分功能的入口可能会发生改变，本文档仅供参考

WARNING

本项目并不依赖宝塔，你可以选择使用你喜欢的任何服务器面板，如果你能力足够，可以手动安装 NginX 或 Caddy 来配置 SSL 和反代。
如果你认为没有必要使用 80、443 端口来访问 Dashboard，你甚至不需要安装 NginX 就可以直接使用安装脚本。



获取 Github/Jihulab 的 Client ID 和密钥 ​

哪吒监控接入 Github、Gitlab、Jihulab、Gitee 作为后台管理员账号

  • 首先我们需要新建一个验证应用，以 Github 为例，登录 Github 后，打开 https://github.com/settings/developers ，依次选择“OAuth Apps” - “New OAuth App”
    Application name - 随意填写
    Homepage URL - 填写面板的访问域名，如："http://cdn.example.com"
    Authorization callback URL - 填写回调地址，如："http://cdn.example.com/oauth2/callback"
  • 点击 “Register application”
  • 保存页面中的 Client ID，然后点击 “Generate a new client secret“，创建一个新的 Client Secret，新建的密钥仅会显示一次，请妥善保存

  • JihuLab 的应用创建入口为：https://jihulab.com/-/profile/applications
  • Redirect URL 中应填入回调地址
  • 在下方范围中勾选 read_user 和 read_api
  • 创建完成后，保存好应用程序 ID 和密码

在服务器中安装 Dashboard ​

  • 在面板服务器中，运行安装脚本：
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh

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

bash
curl -L https://cdn.jsdelivr.net/gh/naiba/nezha@master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh

  • 等待Docker安装完毕后，分别输入以下值：
    OAuth提供商 - Github，Gitlab，Jihulab，Gitee 中选择一个
    Client ID - 之前保存的 Client ID
    Client Secret - 之前保存的密钥
    用户名 - OAuth 提供商中的用户名
    站点标题 - 自定义站点标题
    访问端口 - 公开访问端口，可自定义，默认 8008
    Agent的通信端口 - Agent与Dashboard的通信端口，默认 5555

  • 输入完成后，等待拉取镜像
    安装结束后，如果一切正常，此时你可以访问域名+端口号，如 “http://cdn.example.com:8008” 来查看面板

  • 将来如果需要再次运行脚本，可以运行：

bash
./nezha.sh

来打开管理脚本


配置反向代理 ​

  • 在宝塔面板中新建一个站点，域名填写公开访问域名，如 “http://cdn.example.com“ ，然后点击“设置”进入站点设置选项，选择“反向代理” - “新建反向代理”

  • 自定义一个代理名称，在下方“目标 URL”中填入 http://127.0.0.1 然后点击“保存”

  • 打开刚刚新建的反向代理右边的“配置文件”，将配置文件替换为以下内容：

nginx
#PROXY-START/
+    
哪吒监控
简体中文
English
简体中文
English
Appearance
On this page
准备工作 ​
搭建一个哪吒监控，你需要：
  1. 一台可以连接公网的 VPS，防火墙和安全策略需要放行 8008 和 5555 端口，否则会无法访问和无法接收数据。单核 512MB 内存的服务器配置就足以满足大多数使用场景
  2. 一个已经设置好 A 记录，指向 Dashboard 服务器 ip 的域名
TIP
如果你想使用 CDN，请准备两个域名，一个配置好 CDN 用作公开访问，CDN 需要支持WebSocket 协议；另一个域名不要使用 CDN，用作 Agent 端与 Dashboard 的通信
 本文档分别以 "cdn.example.com" 和 "data.example.com" 两个域名来演示
  1. 一个 Github 账号（或：Gitlab、Jihulab、Gitee）
TIP
如果您位于中国大陆，访问 Github 有困难，我们建议您选择 Jihulab 作为 OAuth 提供商
本文档将以宝塔面板反代面板的过程作为范例，随着未来版本的变化，部分功能的入口可能会发生改变，本文档仅供参考
WARNING
本项目并不依赖宝塔，你可以选择使用你喜欢的任何服务器面板，如果你能力足够，可以手动安装 NginX 或 Caddy 来配置 SSL 和反代。
 如果你认为没有必要使用 80、443 端口来访问 Dashboard，你甚至不需要安装 NginX 就可以直接使用安装脚本。


获取 Github/Jihulab 的 Client ID 和密钥 ​
哪吒监控接入 Github、Gitlab、Jihulab、Gitee 作为后台管理员账号
  • 首先我们需要新建一个验证应用，以 Github 为例，登录 Github 后，打开 https://github.com/settings/developers ，依次选择“OAuth Apps” - “New OAuth App”
    Application name - 随意填写
    Homepage URL - 填写面板的访问域名，如："http://cdn.example.com"
    Authorization callback URL - 填写回调地址，如："http://cdn.example.com/oauth2/callback"
  • 点击 “Register application”
  • 保存页面中的 Client ID，然后点击 “Generate a new client secret“，创建一个新的 Client Secret，新建的密钥仅会显示一次，请妥善保存 

  • JihuLab 的应用创建入口为：https://jihulab.com/-/profile/applications
  • Redirect URL 中应填入回调地址
  • 在下方范围中勾选 read_user 和 read_api
  • 创建完成后，保存好应用程序 ID 和密码
在服务器中安装 Dashboard ​
  • 在面板服务器中，运行安装脚本：
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
如果你的面板服务器位于中国大陆，可以使用镜像：
bash
curl -L https://cdn.jsdelivr.net/gh/naiba/nezha@master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh
  • 等待Docker安装完毕后，分别输入以下值：
    OAuth提供商 - Github，Gitlab，Jihulab，Gitee 中选择一个
    Client ID - 之前保存的 Client ID
    Client Secret - 之前保存的密钥
    用户名 - OAuth 提供商中的用户名
    站点标题 - 自定义站点标题
    访问端口 - 公开访问端口，可自定义，默认 8008
    Agent的通信端口 - Agent与Dashboard的通信端口，默认 5555
  • 输入完成后，等待拉取镜像
     安装结束后，如果一切正常，此时你可以访问域名+端口号，如 “http://cdn.example.com:8008” 来查看面板
  • 将来如果需要再次运行脚本，可以运行：
bash
./nezha.sh
来打开管理脚本


配置反向代理 ​
  • 在宝塔面板中新建一个站点，域名填写公开访问域名，如 “http://cdn.example.com“ ，然后点击“设置”进入站点设置选项，选择“反向代理” - “新建反向代理”
  • 自定义一个代理名称，在下方“目标 URL”中填入 http://127.0.0.1 然后点击“保存”
  • 打开刚刚新建的反向代理右边的“配置文件”，将配置文件替换为以下内容：
nginx
#PROXY-START/
 location / {
     proxy_pass http://127.0.0.1:8008;
     proxy_set_header Host $http_host;
@@ -34,9 +34,9 @@
 proxy /terminal/* http://ip:8008 {
     websocket
     header_upstream -Origin
-}


在宝塔面板中配置 SSL ​
首先，先暂时关闭反向代理
 正如在其他网站中配置 SSL 证书一样，进入站点设置中的 “SSL”，你可以选择自动申请 Let´s Encrypt 证书或手动配置已有的证书
 完成 SSL 的设置后，你需要回到 https://github.com/settings/developers ，编辑之前创建的验证应用程序，将之前我们填入的 "Homepage URL" 和 "Authorization callback URL" 中的域名全部从http改为https，如："https://cdn.example.com" 和 "https://cdn.example.com/oauth2/callback" ，不更改此项可能会导致你无法登录面板后台
FAQ ​
启用HTTPS后/terminal或/ws不能正常连接怎么办? ​
常常是由于证书不完整造成的，请在agent运行参数中添加-d，若log中有x509:certificate signed by unknown authority,更换完整证书则可100%解决该问题。
我对面板提供的数据修改/增加功能不满意，我想要自己修改/增加数据怎么办？ ​
常见于批量插入 Agent 等需求中，可以直接修改数据库。
 请注意，数据库中并非什么都可以修改，错误的修改会导致数据混乱无法启动 Dashboard，请勿随意修改数据库！
DANGER
再重复一遍，请勿随意修改数据库！
如需要在数据库中修改数据，请先停止面板容器再修改。
 数据库类型是 sqlite3，位于 /opt/nezha/dashboard/data/sqlite.db，修改前请备份
数据库中各表/列是什么意思？ ​
文档不提供数据库解释，有能力修改数据库的稍加分析应该就足以看懂。
Dashboard 会自动更新吗？ ​
Agent通常情况下会自动更新，但Dashboard并不会，需要手动更新。
如何更新 Dashboard？ ​
运行脚本 ./nezha.sh ，选择重启面板并更新

-    
+}


在宝塔面板中配置 SSL ​

首先，先暂时关闭反向代理
正如在其他网站中配置 SSL 证书一样，进入站点设置中的 “SSL”，你可以选择自动申请 Let´s Encrypt 证书或手动配置已有的证书
完成 SSL 的设置后，你需要回到 https://github.com/settings/developers ，编辑之前创建的验证应用程序，将之前我们填入的 "Homepage URL" 和 "Authorization callback URL" 中的域名全部从http改为https，如："https://cdn.example.com" 和 "https://cdn.example.com/oauth2/callback" ，不更改此项可能会导致你无法登录面板后台

FAQ ​

启用HTTPS后/terminal或/ws不能正常连接怎么办? ​

常常是由于证书不完整造成的，请在agent运行参数中添加-d，若log中有x509:certificate signed by unknown authority,更换完整证书则可100%解决该问题。

我对面板提供的数据修改/增加功能不满意，我想要自己修改/增加数据怎么办？ ​

常见于批量插入 Agent 等需求中，可以直接修改数据库。
请注意，数据库中并非什么都可以修改，错误的修改会导致数据混乱无法启动 Dashboard，请勿随意修改数据库！

DANGER

再重复一遍，请勿随意修改数据库！

如需要在数据库中修改数据，请先停止面板容器再修改。
数据库类型是 sqlite3，位于 /opt/nezha/dashboard/data/sqlite.db，修改前请备份

数据库中各表/列是什么意思？ ​

文档不提供数据库解释，有能力修改数据库的稍加分析应该就足以看懂。

Dashboard 会自动更新吗？ ​

Agent通常情况下会自动更新，但Dashboard并不会，需要手动更新。

如何更新 Dashboard？ ​

运行脚本 ./nezha.sh ，选择重启面板并更新

+ \ No newline at end of file diff --git a/guide/dashboardq.html b/guide/dashboardq.html index f688d12a..af2aac86 100644 --- a/guide/dashboardq.html +++ b/guide/dashboardq.html @@ -10,11 +10,11 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？ ​

首先解释管理面板中显示的IP是怎么得到的：Agent 会每隔一段时间请求一遍 IP-API，获取到 IP 信息后上报到 Dashboard，目前使用的 IP-API 可在此查看：myip.go。
如您发现管理面板中显示的 IP 和服务商提供给您的 IP 不一致，最大的可能是服务商给您的是入口 IP，但Agent测试的是您的出口 IP。这个问题也可能会出现在多线服务器和 IPLC 专线中。

TIP

举个简单也十分常见的例子，服务商给您提供的是一台高防服务器，为了同时满足高防和低网络中断率的目标，提供给您的 IP 可能是经过映射后的高防 IP 而并非您服务器的真实出口 IP

您也可以在 Agent 服务器中运行以下命令测试出口IP:

shell
curl api.myip.la
+    
哪吒监控
简体中文
English
简体中文
English
Appearance
On this page
为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？ ​
首先解释管理面板中显示的IP是怎么得到的：Agent 会每隔一段时间请求一遍 IP-API，获取到 IP 信息后上报到 Dashboard，目前使用的 IP-API 可在此查看：myip.go。
 如您发现管理面板中显示的 IP 和服务商提供给您的 IP 不一致，最大的可能是服务商给您的是入口 IP，但Agent测试的是您的出口 IP。这个问题也可能会出现在多线服务器和 IPLC 专线中。
TIP
举个简单也十分常见的例子，服务商给您提供的是一台高防服务器，为了同时满足高防和低网络中断率的目标，提供给您的 IP 可能是经过映射后的高防 IP 而并非您服务器的真实出口 IP
您也可以在 Agent 服务器中运行以下命令测试出口IP:
shell
curl api.myip.la
 curl ip.sb
 curl ip-api.com
忘记查看密码\删除查看密码 ​
请查看或编辑 /opt/nezha/dashboard/data/config.yaml 文件。
 密码位于 site-viewpassword 项中。
面板安装/重启/更新失败: iptables ...... ​
首先尝试重启 Docker 再操作
shell
systemctl status docker
 systemctl restart docker
@@ -23,9 +23,9 @@
         expires      12h;
         error_log /dev/null;
         access_log /dev/null;
-    }
  1. 保存配置，并清空浏览器、NginX、CDN 中的缓存，此时刷新页面应恢复正常

-    
+    }
  1. 保存配置，并清空浏览器、NginX、CDN 中的缓存，此时刷新页面应恢复正常
+ \ No newline at end of file diff --git a/guide/loginq.html b/guide/loginq.html index c3b56f49..b8a3cf95 100644 --- a/guide/loginq.html +++ b/guide/loginq.html @@ -10,13 +10,13 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

登录回调后页面卡住\拒绝连接\响应时间过长 ​

还有其他一些表现形式，总之登录后浏览器无法正常显示。

  1. 您的服务器无法连接到 Github/Gitee，最常见于国内服务器配置 Github 情况下，可以考虑多尝试几次或者切换到 Jihulab/Gitee。
  2. 您配置错了回调地址，确保您的回调地址正确且端口与协议均正确！
  3. Dashboard 发生未知错误，您可以使用脚本查看日志，但此项可能性较低。

TIP

什么是协议？
在浏览器中，您的域名以://结尾的字符串即为协议，通常为 http 和 https 两种。由于正常部署情况下面板可能有多种协议+域名+端口组合均可访问，请务必选一个最合适的作为回调。

如何检查我的回调地址是否错误？ ​

请确保登录前浏览器显示的协议+域名+端口和登录后跳转到的协议+域名+端口一致。
请确保您的路径为/oauth2/callback，全部小写

登录后面板报错 ​

清理cookies后重新登录，或换个浏览器

lookup xxx ​

容器DNS解析失败，多数情况下为修改了iptables相关配置。
建议先重启docker，sudo systemctl restart docker，再使用脚本重启面板。
仍然出现lookup错误建议查看是否有其他控制iptables的工具，如宝塔防火墙等。
这个问题也可能与内核有关系，请尝试更换官方内核。

授权方式无效，或者登录回调地址无效、过期或已被撤销 ​

只出现在 Gitee 登录方式中，原因不明，建议更换到 Jihulab。

oauth2: server response missing access_token ​

可能由多种因素引起，最大可能性是网络问题，建议检查网络后重试。
无法解决的话建议更换 Github/Jihulab 等。

该用户不是本站点管理员，无法登录 ​

您登陆错了账号或者配置错了用户名，注意用户名不是邮箱，可使用脚本修改。

dial tcp xxx:443 i/o timeout ​

网络问题，可先重启 Docker，sudo systemctl restart docker，再使用脚本重启面板。
如为国内服务器配置 Github 登陆方式，则建议切换到Jihulab以避免网络干扰。

net/http: TLS handshake timeout ​

同上。

- +
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

登录回调后页面卡住\拒绝连接\响应时间过长 ​

还有其他一些表现形式，总之登录后浏览器无法正常显示。

  1. 您的服务器无法连接到 Github/Gitee，最常见于国内服务器配置 Github 情况下，可以考虑多尝试几次或者切换到 Jihulab/Gitee。
  2. 您配置错了回调地址，确保您的回调地址正确且端口与协议均正确！
  3. Dashboard 发生未知错误，您可以使用脚本查看日志，但此项可能性较低。

TIP

什么是协议？
在浏览器中，您的域名以://结尾的字符串即为协议，通常为 http 和 https 两种。由于正常部署情况下面板可能有多种协议+域名+端口组合均可访问，请务必选一个最合适的作为回调。

如何检查我的回调地址是否错误？ ​

请确保登录前浏览器显示的协议+域名+端口和登录后跳转到的协议+域名+端口一致。
请确保您的路径为/oauth2/callback，全部小写

登录后面板报错 ​

清理cookies后重新登录，或换个浏览器

lookup xxx ​

容器DNS解析失败，多数情况下为修改了iptables相关配置。
建议先重启docker，sudo systemctl restart docker，再使用脚本重启面板。
仍然出现lookup错误建议查看是否有其他控制iptables的工具，如宝塔防火墙等。
这个问题也可能与内核有关系，请尝试更换官方内核。

授权方式无效，或者登录回调地址无效、过期或已被撤销 ​

只出现在 Gitee 登录方式中，原因不明，建议更换到 Jihulab。

oauth2: server response missing access_token ​

可能由多种因素引起，最大可能性是网络问题，建议检查网络后重试。
无法解决的话建议更换 Github/Jihulab 等。

该用户不是本站点管理员，无法登录 ​

您登陆错了账号或者配置错了用户名，注意用户名不是邮箱，可使用脚本修改。

dial tcp xxx:443 i/o timeout ​

网络问题，可先重启 Docker，sudo systemctl restart docker，再使用脚本重启面板。
如为国内服务器配置 Github 登陆方式，则建议切换到Jihulab以避免网络干扰。

net/http: TLS handshake timeout ​

同上。

+ \ No newline at end of file diff --git a/guide/notifications.html b/guide/notifications.html index a27a984b..aaf5bd5f 100644 --- a/guide/notifications.html +++ b/guide/notifications.html @@ -10,11 +10,11 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

哪吒监控支持对服务器的负载、CPU、内存、硬盘、流量、月流量、进程数、连接数进行监控，并在其中某项达到用户设定值时发送报警通知

灵活的通知方式 ​

#NEZHA# 是面板消息占位符，面板触发通知时会自动用实际消息替换占位符

Body 内容是JSON 格式的：当请求类型为 FORM 时，值为 key:value 的形式，value 里面可放置占位符，通知时会自动替换。当请求类型为 JSON 时 只会简单进行字符串替换后直接提交到URL。

URL 里面也可放置占位符，请求时会进行简单的字符串替换。

你可以参考以下的通知方式示例，也可以根据自己的需求灵活设置推送方式

  • Bark 示例

    • 名称：Bark
    • URL 组成: 第一个部分是 key,之后有三个匹配 /:key/:body or /:key/:title/:body or /:key/:category/:title/:body
    • 请求方式: GET
    • 请求类型: 默认
    • Body: 空
    • 名称：Bark
    • URL 组成: /push
    • 请求方式: POST
    • 请求类型: form
    • Body: {"title": "#SERVER.NAME#","device_key":"xxxxxxxxx","body":"#NEZHA#","icon":"https://xxxxxxxx/nz.png"}

  • Server 酱示例

  • Server 酱进阶

    json
    {
+    
    哪吒监控
    简体中文
    English
    简体中文
    English
    Appearance
    On this page
    哪吒监控支持对服务器的负载、CPU、内存、硬盘、流量、月流量、进程数、连接数进行监控，并在其中某项达到用户设定值时发送报警通知 

    灵活的通知方式 ​
    #NEZHA# 是面板消息占位符，面板触发通知时会自动用实际消息替换占位符
    Body 内容是JSON 格式的：当请求类型为 FORM 时，值为 key:value 的形式，value 里面可放置占位符，通知时会自动替换。当请求类型为 JSON 时 只会简单进行字符串替换后直接提交到URL。
    URL 里面也可放置占位符，请求时会进行简单的字符串替换。
    你可以参考以下的通知方式示例，也可以根据自己的需求灵活设置推送方式
    • Bark 示例
      • 名称：Bark
      • URL 组成: 第一个部分是 key,之后有三个匹配 /:key/:body or /:key/:title/:body or /:key/:category/:title/:body
      • 请求方式: GET
      • 请求类型: 默认
      • Body: 空
      • 名称：Bark
      • URL 组成: /push
      • 请求方式: POST
      • 请求类型: form
      • Body: {"title": "#SERVER.NAME#","device_key":"xxxxxxxxx","body":"#NEZHA#","icon":"https://xxxxxxxx/nz.png"}
    • Server 酱示例
    • Server 酱进阶
      json
      {
  "title": "#SERVER.NAME#",
  "desp":"**#NEZHA#\n\n
  平均负载: \"#SERVER.LOAD1#\",\"#SERVER.LOAD5#\",\"#SERVER.LOAD15#\"\n\n
@@ -44,9 +44,9 @@
     "markdown": {
         "content": "# 哪吒通知消息\n\n\"#NEZHA#\"\n\n> 名称: \"#SERVER.NAME#\"\n> IP: \"#SERVER.IP#\"\n> IPv4: \"#SERVER.IPV4#\"\n> IPv6: \"#SERVER.IPV6#\"\n> CPU: \"#SERVER.CPU#\"\n> 内存: \"#SERVER.MEM#\"\n> 交换分区: \"#SERVER.SWAP#\"\n> 存储: \"#SERVER.DISK#\"\n> 实时上传速度: \"#SERVER.NETINSPEED#\"\n> 实时下载速度: \"#SERVER.NETOUTSPEED#\"\n> 总上传: \"#SERVER.TRANSFERIN#\"\n> 总下载: \"#SERVER.TRANSFEROUT#\"\n> 1分钟内负载: \"#SERVER.LOAD1#\"\n> 5分钟内负载: \"#SERVER.LOAD5#\"\n> 15分钟内负载: \"#SERVER.LOAD15#\"\n> TCP连接数: \"#SERVER.TCPCONNCOUNT\"\n> UDP连接数: \"#SERVER.UDPCONNCOUNT\"\n\n"
     }
-}
      根据需求删减相关内容信息即可
    通知效果


报警规则说明 ​

基本规则 ​

  • type：可选取一个或多个类型，如在一个规则中选择了多个类型，需要同时满足所有选择的类型才会触发通知（可参考后面的示例）
    • cpu、memory、swap、disk
    • net_in_speed 入站网速、net_out_speed 出站网速、net_all_speed 双向网速、transfer_in 入站流量、transfer_out 出站流量、transfer_all 双向流量
    • offline 离线监控
    • load1、load5、load15 负载
    • process_count 进程数 目前取线程数占用资源太多，暂时不支持
    • tcp_conn_count、udp_conn_count 连接数
  • duration：持续数秒，数秒内采样记录 30% 以上触发阈值才会报警（防数据插针）
  • min 或 max：
    • 流量、网速类数值 为字节（1KB=1024B，1MB = 1024*1024B）
    • 内存、硬盘、CPU 以占用百分比计数
    • 离线监控无需设置此项
  • cover：
    • 0 监控所有，通过 ignore 忽略特定服务器
    • 1 忽略所有，通过 ignore 监控特定服务器
      例如：[{"type":"offline","duration":10, "cover":0, "ignore":{"5": true}}]
  • ignore: 选择忽略特定服务器，搭配 cover 使用，内容为服务器 id 和布尔值，例如：{"1": true, "2":false}

完整示例:

添加一个离线报警

  • 名称：离线通知
  • 规则：[{"Type":"offline","Duration":10}]
  • 启用：√

添加一个监控 CPU 持续 10s 超过 50% 且 内存持续 20s 占用低于 20% 的报警

  • 名称：CPU+内存
  • 规则：[{"Type":"cpu","Min":0,"Max":50,"Duration":10},{"Type":"memory","Min":20,"Max":0,"Duration":20}]
  • 启用：√

将特定的服务器通知发送到特定的通知分组

示例场景：
你有 1、2、3、4 四台服务器和 A、B 两个不同的通知组
1、2 这两台服务器掉线十分钟后给通知组 A 发送通知
3、4 这两台服务器掉线十分钟后给通知组 B 发送通知

首先你需要先设置好 A、B 两个通知组，然后添加两条报警规则：

规则一：

  • 名称：1、2 离线，发送给通知组 A
  • 规则：[{"type":"offline","duration":600,"cover":1,"ignore":{"1":true,"2":true}}]
  • 通知方式组： A
  • 启用：√

规则二：

  • 名称：3、4 离线，发送给通知组 B
  • 规则：[{"type":"offline","duration":600,"cover":1,"ignore":{"3":true,"4":true}}]
  • 通知方式组： B
  • 启用：√

灵活使用参数可以让你的通知功能被充分使用


特殊：任意周期流量报警 ​

可以用作月流量报警

  • type:
    • transfer_in_cycle 周期内的入站流量
    • transfer_out_cycle 周期内的出站流量
    • transfer_all_cycle 周期内双向流量和
  • cycle_start： 统计周期开始日期（可以是你机器计费周期的开始日期），时间格式为RFC3339，例如北京时间为2022-01-11T08:00:00.00+08:00
  • cycle_interval：每隔多少个周期单位（例如，周期单位为天，该值为 7，则代表每隔 7 天统计一次）
  • cycle_unit 统计周期单位，默认hour,可选(hour, day, week, month, year)
  • min/max、cover、ignore 参考基本规则配置

示例:

ID 为 3 和 4 的服务器（ignore 里面定义），以每月 1 号为统计周期，周期内统计的出站月流量达到 1TB 时报警

[{"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}}]

通知触发模式说明 ​

  • 始终触发：每当 Agent 上报的状态符合报警的规则时，都会触发一次通知
  • 单次触发：仅状态改变时触发一次通知，如从正常状态改变为异常状态，或异常状态恢复为正常状态

设置报警时执行任务 ​

如果你需要在发出报警消息的同时执行某项任务，可以设置此项目

  • 故障时触发任务 当报警状态符合从“正常”变更为“故障”时，所要执行的任务，任务应提前在任务页设置
  • 恢复时触发任务 当报警状态符合从“故障”恢复为“正常”时，所要执行的任务，任务应提前在任务页设置
- +}

根据需求删减相关内容信息即可

通知效果



报警规则说明 ​

基本规则 ​

完整示例:

添加一个离线报警

添加一个监控 CPU 持续 10s 超过 50% 且 内存持续 20s 占用低于 20% 的报警

将特定的服务器通知发送到特定的通知分组

示例场景：
你有 1、2、3、4 四台服务器和 A、B 两个不同的通知组
1、2 这两台服务器掉线十分钟后给通知组 A 发送通知
3、4 这两台服务器掉线十分钟后给通知组 B 发送通知

首先你需要先设置好 A、B 两个通知组，然后添加两条报警规则：

规则一：

规则二：

灵活使用参数可以让你的通知功能被充分使用


特殊：任意周期流量报警 ​

可以用作月流量报警

示例:

ID 为 3 和 4 的服务器（ignore 里面定义），以每月 1 号为统计周期，周期内统计的出站月流量达到 1TB 时报警

[{"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}}]

通知触发模式说明 ​

设置报警时执行任务 ​

如果你需要在发出报警消息的同时执行某项任务，可以设置此项目

+ \ No newline at end of file diff --git a/guide/q1.html b/guide/q1.html index 49c02ebd..be5335b7 100644 --- a/guide/q1.html +++ b/guide/q1.html @@ -10,11 +10,11 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

准备工作 ​

你可以选择 CloudFlare 的 workers 进行反代，但大陆的网络你懂的，这里介绍用你自己服务器反代方式
搭建一个 TGbot api 反代，你需要：
1.一个不受 GFW 封锁的服务器(且安装好 Nginx)
2.一个域名(提前申请 SSL 证书)

NGINX 配置 ​

编辑你 Nginx 的配置文件,在 http{} 中加上如下配置

nginx
# http强制跳转到htpps
+    
哪吒监控
简体中文
English
简体中文
English
Appearance
On this page
准备工作 ​
你可以选择 CloudFlare 的 workers 进行反代，但大陆的网络你懂的，这里介绍用你自己服务器反代方式
 搭建一个 TGbot api 反代，你需要：
 1.一个不受 GFW 封锁的服务器(且安装好 Nginx)
 2.一个域名(提前申请 SSL 证书) 
NGINX 配置 ​
编辑你 Nginx 的配置文件,在 http{} 中加上如下配置
nginx
# http强制跳转到htpps
 server {
     listen 80;
     listen [::]:80;
@@ -58,9 +58,9 @@
 ufw allow proto tcp from serverIp to any port 443
 #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/q2.html b/guide/q2.html index 084f7f29..c16c6bb5 100644 --- a/guide/q2.html +++ b/guide/q2.html @@ -10,13 +10,13 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

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

  1. 直接执行 /opt/nezha/agent/nezha-agent -s 面板IP或非CDN域名:面板RPC端口 -p Agent密钥 -d 查看日志是否是因为 DNS、网络不佳导致超时（timeout）
  2. nc -v 域名/IP 面板RPC端口 或者 telnet 域名/IP 面板RPC端口 来检验是否是网络问题，检查本机与面板服务器的出入站防火墙，如果无法判断问题可借助 https://port.ping.pe/ 提供的端口检查工具进行检测。
  3. 如果上面步骤检测正常，Agent 正常上线，尝试关闭 SELinux，如何关闭 SELinux？
- +
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

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

  1. 直接执行 /opt/nezha/agent/nezha-agent -s 面板IP或非CDN域名:面板RPC端口 -p Agent密钥 -d 查看日志是否是因为 DNS、网络不佳导致超时（timeout）
  2. nc -v 域名/IP 面板RPC端口 或者 telnet 域名/IP 面板RPC端口 来检验是否是网络问题，检查本机与面板服务器的出入站防火墙，如果无法判断问题可借助 https://port.ping.pe/ 提供的端口检查工具进行检测。
  3. 如果上面步骤检测正常，Agent 正常上线，尝试关闭 SELinux，如何关闭 SELinux？
+ \ No newline at end of file diff --git a/guide/q3.html b/guide/q3.html index 878db6ff..d3748de0 100644 --- a/guide/q3.html +++ b/guide/q3.html @@ -10,11 +10,11 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

反向代理 gRPC 端口（支持 Cloudflare CDN） ​

使用 Nginx 或者 Caddy 反向代理 gRPC

  • Nginx 配置
nginx
server {
+    
哪吒监控
简体中文
English
简体中文
English
Appearance
On this page
反向代理 gRPC 端口（支持 Cloudflare CDN） ​
使用 Nginx 或者 Caddy 反向代理 gRPC
  • Nginx 配置
nginx
server {
     listen 443 ssl http2;
     listen [::]:443 ssl http2;
     server_name data.example.com; # 你的 Agent 连接 Dashboard 的域名
@@ -42,9 +42,9 @@
             versions h2c 2
         }
     }
-}
Dashboard 面板端配置
  • 首先登录面板进入管理后台 打开设置页面，在 未接入CDN的面板服务器域名/IP 中填入上一步在 Nginx 或 Caddy 中配置的域名 比如 data.example.com ，并保存。
  • 然后在面板服务器中，打开 /opt/nezha/dashboard/data/config.yaml 文件，将 proxygrpcport 修改为 Nginx 或 Caddy 监听的端口，比如上一步设置的 443 ；因为我们在 Nginx 或 Caddy 中开启了 SSL/TLS，所以需要将 tls 设置为 true ；修改完成后重启面板。
Agent 端配置
  • 登录面板管理后台，复制一键安装命令，在对应的服务器上面执行一键安装命令重新安装 agent 端即可。
开启 Cloudflare CDN（可选）
根据 Cloudflare gRPC 的要求：gRPC 服务必须侦听 443 端口 且必须支持 TLS 和 HTTP/2。 所以如果需要开启 CDN，必须在配置 Nginx 或者 Caddy 反向代理 gRPC 时使用 443 端口，并配置证书（Caddy 会自动申请并配置证书）。
  • 登录 Cloudflare，选择使用的域名。打开 网络 选项将 gRPC 开关打开，打开 DNS 选项，找到 Nginx 或 Caddy 反代 gRPC 配置的域名的解析记录，打开橙色云启用 CDN。

-    
+}

Dashboard 面板端配置

Agent 端配置

开启 Cloudflare CDN（可选）

根据 Cloudflare gRPC 的要求：gRPC 服务必须侦听 443 端口 且必须支持 TLS 和 HTTP/2。 所以如果需要开启 CDN，必须在配置 Nginx 或者 Caddy 反向代理 gRPC 时使用 443 端口，并配置证书（Caddy 会自动申请并配置证书）。

+ \ No newline at end of file diff --git a/guide/q4.html b/guide/q4.html index 5ae5205a..569e1c32 100644 --- a/guide/q4.html +++ b/guide/q4.html @@ -10,13 +10,13 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

实时通道断开/在线终端连接失败 ​

  • 如果你使用了 CDN，请确认 CDN 服务商提供 WebSocket 服务，并且已开启 WebSocket
  • 确认你的反代规则中针对 /ws,/terminal 路径的 WebSocket 进行了特别配置，你可以 点击这里 查看反向代理配置
- +
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

实时通道断开/在线终端连接失败 ​

  • 如果你使用了 CDN，请确认 CDN 服务商提供 WebSocket 服务，并且已开启 WebSocket
  • 确认你的反代规则中针对 /ws,/terminal 路径的 WebSocket 进行了特别配置，你可以 点击这里 查看反向代理配置
+ \ No newline at end of file diff --git a/guide/q5.html b/guide/q5.html index 41161907..60d2d03d 100644 --- a/guide/q5.html +++ b/guide/q5.html @@ -10,13 +10,13 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

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

  1. 先运行一键脚本，选择 停止面板
  2. 在旧服务器中打包 /opt/nezha 文件夹，复制到新环境相同位置解压
  3. 在新环境中运行一键脚本，选择 启动面板
- +
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

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

  1. 先运行一键脚本，选择 停止面板
  2. 在旧服务器中打包 /opt/nezha 文件夹，复制到新环境相同位置解压
  3. 在新环境中运行一键脚本，选择 启动面板
+ \ No newline at end of file diff --git a/guide/q6.html b/guide/q6.html index 25c0d4e8..55b8faca 100644 --- a/guide/q6.html +++ b/guide/q6.html @@ -10,13 +10,13 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

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

主页中的流量统计每次服务器重启时都会重置，如果要实现每月重置一次流量计数，可以这样实现：

  1. 进入管理面板的 报警通知 页
  2. 参考这篇文档，创建一个月流量报警
  3. 返回主页，在 服务 页中就可以看到月流量统计了，这里的统计数据不会因为服务器重启而重置

TIP

此方式可以设置任何周期，包括且不限于每小时/每天/每周/每月/每年重置流量统计，非常灵活！

- +
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

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

主页中的流量统计每次服务器重启时都会重置，如果要实现每月重置一次流量计数，可以这样实现：

  1. 进入管理面板的 报警通知 页
  2. 参考这篇文档，创建一个月流量报警
  3. 返回主页，在 服务 页中就可以看到月流量统计了，这里的统计数据不会因为服务器重启而重置

TIP

此方式可以设置任何周期，包括且不限于每小时/每天/每周/每月/每年重置流量统计，非常灵活！

+ \ No newline at end of file diff --git a/guide/q7.html b/guide/q7.html index af721e20..ee79b851 100644 --- a/guide/q7.html +++ b/guide/q7.html @@ -10,13 +10,13 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

自定义 Agent 监控项目 ​

自定义监控的网卡和硬盘分区 ​

  • 执行 /opt/nezha/agent/nezha-agent --edit-agent-config 来选择自定义的网卡和分区，然后重启 Agent 即可生效

其他运行参数 ​

通过执行 ./nezha-agent --help 查看支持的参数，如果你使用了一键脚本安装Agent，可以编辑 /etc/systemd/system/nezha-agent.service，在 ExecStart= 这一行的末尾加上以下参数

  • --report-delay 控制系统信息上报的间隔，默认为 1 秒，可以设置为 3 来进一步降低 agent 端系统资源占用（配置区间 1-4）
  • --skip-conn 不监控连接数，推荐 机场/连接密集型 服务器或CPU占用较高的服务器设置
  • --skip-procs 不监控进程数，也可以降低 Agent 占用
  • --disable-auto-update 禁止 自动更新 Agent（安全特性）
  • --disable-force-update 禁止 强制更新 Agent（安全特性）
  • --disable-command-execute 禁止在 Agent 上执行定时任务、打开在线终端（安全特性）
  • --tls 启用 SSL/TLS 加密（使用 nginx 反向代理 Agent 的 grpc 连接，并且 nginx 开启 SSL/TLS 时，需要启用该项配置）
- +
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

自定义 Agent 监控项目 ​

自定义监控的网卡和硬盘分区 ​

  • 执行 /opt/nezha/agent/nezha-agent --edit-agent-config 来选择自定义的网卡和分区，然后重启 Agent 即可生效

其他运行参数 ​

通过执行 ./nezha-agent --help 查看支持的参数，如果你使用了一键脚本安装Agent，可以编辑 /etc/systemd/system/nezha-agent.service，在 ExecStart= 这一行的末尾加上以下参数

  • --report-delay 控制系统信息上报的间隔，默认为 1 秒，可以设置为 3 来进一步降低 agent 端系统资源占用（配置区间 1-4）
  • --skip-conn 不监控连接数，推荐 机场/连接密集型 服务器或CPU占用较高的服务器设置
  • --skip-procs 不监控进程数，也可以降低 Agent 占用
  • --disable-auto-update 禁止 自动更新 Agent（安全特性）
  • --disable-force-update 禁止 强制更新 Agent（安全特性）
  • --disable-command-execute 禁止在 Agent 上执行定时任务、打开在线终端（安全特性）
  • --tls 启用 SSL/TLS 加密（使用 nginx 反向代理 Agent 的 grpc 连接，并且 nginx 开启 SSL/TLS 时，需要启用该项配置）
+ \ No newline at end of file diff --git a/guide/servers.html b/guide/servers.html index cfcf42ae..cea258d8 100644 --- a/guide/servers.html +++ b/guide/servers.html @@ -10,13 +10,13 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

主机 ​

介绍 ​

主机区域负责管理Agent，是哪吒探针中最基础的区域，也是其他功能的基础。

添加服务器 ​

第一步是添加主机，可以自定义名称、分组、排序和备注。
拥有相同分组的主机会在受支持的主题中划分到一起进行显示，备注仅会在后台显示，无需担心泄露信息。

安装Agent ​

请参考前文安装Agent
推荐使用一键安装，即配置好参数后，点击主机一键安装列上的按钮，复制到相应主机进行安装。

强制更新 ​

Agent更新相关的参数是 自定义agent监控项目 中的 --disable-auto-update 和 --disable-force-update。
默认情况下，Agent会自动更新，无需干预。但当用户关闭自动更新后，也可以选中指定主机进行强制更新。
disable-force-update开启时此功能不生效。

数据列 ​

  • 版本号: 记录Agent当前版本
  • 密钥: 即secret\key，配置Agent时会用到
  • 一键安装: 较为便捷的Agent安装方式
  • 管理: 左为WebShell，中为编辑，右为删除

在线终端 ​

即WebShell，disable-command-execute 开启时此功能不生效。
Linux和Windows均可用，可使用Ctrl+Shift+V粘贴。
连接失败请参考实时通道断开/在线终端连接失败。
注意在线终端功能中，Agent也是通过WebSocket连接到公开访问域名，而非通过grpc交互。

- +
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

主机 ​

介绍 ​

主机区域负责管理Agent，是哪吒探针中最基础的区域，也是其他功能的基础。

添加服务器 ​

第一步是添加主机，可以自定义名称、分组、排序和备注。
拥有相同分组的主机会在受支持的主题中划分到一起进行显示，备注仅会在后台显示，无需担心泄露信息。

安装Agent ​

请参考前文安装Agent
推荐使用一键安装，即配置好参数后，点击主机一键安装列上的按钮，复制到相应主机进行安装。

强制更新 ​

Agent更新相关的参数是 自定义agent监控项目 中的 --disable-auto-update 和 --disable-force-update。
默认情况下，Agent会自动更新，无需干预。但当用户关闭自动更新后，也可以选中指定主机进行强制更新。
disable-force-update开启时此功能不生效。

数据列 ​

  • 版本号: 记录Agent当前版本
  • 密钥: 即secret\key，配置Agent时会用到
  • 一键安装: 较为便捷的Agent安装方式
  • 管理: 左为WebShell，中为编辑，右为删除

在线终端 ​

即WebShell，disable-command-execute 开启时此功能不生效。
Linux和Windows均可用，可使用Ctrl+Shift+V粘贴。
连接失败请参考实时通道断开/在线终端连接失败。
注意在线终端功能中，Agent也是通过WebSocket连接到公开访问域名，而非通过grpc交互。

+ \ No newline at end of file diff --git a/guide/services.html b/guide/services.html index 54b0eb96..299e3ac7 100644 --- a/guide/services.html +++ b/guide/services.html @@ -10,13 +10,13 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

服务区域是设置 Agent 监控外部网站或服务器的功能设置区
设置好的服务监控可以在主页中的 “服务” 页查看监控结果

使用方法 ​

如需新增一个监控，可以进入管理面板中的 “服务” 页，点击“添加监控”

新增一个服务监控，你需要设置以下参数：

  • 名称 - 自定义一个名称

  • 类型 - 选择一个监控类型，目前哪吒监控支持三种监控类型，分别是 “HTTP-GET”、“ICMP-Ping” 和 “TCP-Ping”

  • 目标 - 根据你选择的类型不同，目标的设置方法也不同

  • HTTP-GET: 选择此类型，你应该输入一个URL作为目标，URL需添加 http:// 或 https:// 如果你的目标URL是 https:// ,将会同时监控该URL的SSL证书，当SSL证书到期或发生变更，会触发提醒
    例如： https://example.com
  • ICMP-Ping: 选择此类型时，你应该输入一个域名或IP，不含端口号
    例如：1.1.1.1 或 example.com
  • TCP-Ping: 选择此类型时，你应该输入一个域名或IP并包含端口号
    例如：1.1.1.1:80 或 example.com:22

  • 请求间隔： 设定 Agent 每次请求目标的时间间隔，以秒为单位

  • 覆盖范围： 选择一条规则来确定要使用哪些 Agent 来请求目标

  • 特定服务器： 配合覆盖范围使用，选择规则内需要排除的 Agent

  • 通知方式组： 选择你已经在 “报警” 页设置好的通知方式，点击这里了解详情

  • 启用故障通知： 根据需要选择是否接收目标故障通知，默认为不勾选

设置完成后，点击 “添加” 即可
稍等片刻前往主页的 “服务” 页，查看监控结果

延迟变化报警 ​

哪吒监控可以监测并统计 Agent 到目标服务器之间的延迟，在发生较大变化的情况下发送通知
利用此功能可以帮助你监控服务器的线路是否发生了变化

  • 启用延迟通知： 开启时，当 Agent 至目标服务器的延迟大于最高延迟或小于最低延迟时，将会发送报警通知

管理监控 ​

如需对已有的服务监控进行管理，可以前往管理面板中的 “服务” 页
选择一条监控配置，点击右侧的图标进行编辑或删除

- +
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

服务区域是设置 Agent 监控外部网站或服务器的功能设置区
设置好的服务监控可以在主页中的 “服务” 页查看监控结果

使用方法 ​

如需新增一个监控，可以进入管理面板中的 “服务” 页，点击“添加监控”

新增一个服务监控，你需要设置以下参数：

  • 名称 - 自定义一个名称

  • 类型 - 选择一个监控类型，目前哪吒监控支持三种监控类型，分别是 “HTTP-GET”、“ICMP-Ping” 和 “TCP-Ping”

  • 目标 - 根据你选择的类型不同，目标的设置方法也不同

  • HTTP-GET: 选择此类型，你应该输入一个URL作为目标，URL需添加 http:// 或 https:// 如果你的目标URL是 https:// ,将会同时监控该URL的SSL证书，当SSL证书到期或发生变更，会触发提醒
    例如： https://example.com
  • ICMP-Ping: 选择此类型时，你应该输入一个域名或IP，不含端口号
    例如：1.1.1.1 或 example.com
  • TCP-Ping: 选择此类型时，你应该输入一个域名或IP并包含端口号
    例如：1.1.1.1:80 或 example.com:22

  • 请求间隔： 设定 Agent 每次请求目标的时间间隔，以秒为单位

  • 覆盖范围： 选择一条规则来确定要使用哪些 Agent 来请求目标

  • 特定服务器： 配合覆盖范围使用，选择规则内需要排除的 Agent

  • 通知方式组： 选择你已经在 “报警” 页设置好的通知方式，点击这里了解详情

  • 启用故障通知： 根据需要选择是否接收目标故障通知，默认为不勾选

设置完成后，点击 “添加” 即可
稍等片刻前往主页的 “服务” 页，查看监控结果

延迟变化报警 ​

哪吒监控可以监测并统计 Agent 到目标服务器之间的延迟，在发生较大变化的情况下发送通知
利用此功能可以帮助你监控服务器的线路是否发生了变化

  • 启用延迟通知： 开启时，当 Agent 至目标服务器的延迟大于最高延迟或小于最低延迟时，将会发送报警通知

管理监控 ​

如需对已有的服务监控进行管理，可以前往管理面板中的 “服务” 页
选择一条监控配置，点击右侧的图标进行编辑或删除

+ \ No newline at end of file diff --git a/guide/settings.html b/guide/settings.html index 6f7c21ed..4f559309 100644 --- a/guide/settings.html +++ b/guide/settings.html @@ -10,11 +10,11 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

站点标题 ​

你可以在此项中自定义你的站点标题

管理员列表 ​

  • 如果你修改了自己的 Github, Gitlab, Jihulab 或 Gitee 的用户名，可以在此项中同步修改，否则无法登录，多个用户请用逗号隔开: user1,user2

  • 如需更改管理员账户，请前往 /opt/nezha/dashboard/data/config.yaml ，重新设置新的管理员 Client ID 和 Client Secret

主题 ​

在这里选择主页主题，如果选项中没有某个已存在的主题，请更新面板

Language ​

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

  • 简体中文
  • English
  • Español

Crowdin
我们欢迎您对翻译进行勘误和贡献更多语言

自定义代码 ​

改 LOGO、改色调、加统计代码等。

WARNING

自定义代码仅在游客首页生效，管理面板不生效
由于不同主题的代码不同，如确需修改管理面板中的内容，请自行前往 Docker 中研究修改


默认主题更改进度条颜色示例 ​

html
<style>
+    
哪吒监控
简体中文
English
简体中文
English
Appearance
On this page
站点标题 ​
你可以在此项中自定义你的站点标题 
管理员列表 ​
  • 如果你修改了自己的 Github, Gitlab, Jihulab 或 Gitee 的用户名，可以在此项中同步修改，否则无法登录，多个用户请用逗号隔开: user1,user2
  • 如需更改管理员账户，请前往 /opt/nezha/dashboard/data/config.yaml ，重新设置新的管理员 Client ID 和 Client Secret
主题 ​
在这里选择主页主题，如果选项中没有某个已存在的主题，请更新面板 
Language ​
哪吒监控目前支持以下语言：
  • 简体中文
  • English
  • Español
Crowdin
 我们欢迎您对翻译进行勘误和贡献更多语言 
自定义代码 ​
改 LOGO、改色调、加统计代码等。
WARNING
自定义代码仅在游客首页生效，管理面板不生效
 由于不同主题的代码不同，如确需修改管理面板中的内容，请自行前往 Docker 中研究修改

默认主题更改进度条颜色示例 ​
html
<style>
 .ui.fine.progress> .bar {
     background-color: pink !important;
 }
@@ -57,9 +57,9 @@
 .hotaru-cover {
    background: url(https://s3.ax1x.com/2020/12/08/DzHv6A.jpg) center;
 }
-</style>
前台查看密码 ​
如果你不想直接展示你的主页，你可以在这里设置一个查看密码
 设置密码后，需要输入密码才可以访问主页

未接入 CDN 的面板服务器域名/IP ​
此项设置是使用一键脚本安装 Agent 的前提，详情请查看这里
IP 变更提醒 ​
如果你希望当某个服务器的ip发生变更时收到通知，可以在这里进行设置
覆盖范围 ​
在这里选择一条规则，来确定需要监控哪些服务器，可以根据自己的需求进行选择
特定服务器 ​
配合覆盖范围的设置，在这里设置选定规则的排除项
提醒发送至指定的通知分组 ​
选择通知方式，通知方式请提前在 “报警” 页内设置

WARNING
设置完成后，勾选启用时，通知生效

WARNING
IP变更通知默认打码，如果你不希望打码，可以勾选 “通知信息IP不打码”

-    
+</style>

前台查看密码 ​

如果你不想直接展示你的主页，你可以在这里设置一个查看密码
设置密码后，需要输入密码才可以访问主页

未接入 CDN 的面板服务器域名/IP ​

此项设置是使用一键脚本安装 Agent 的前提，详情请查看这里

IP 变更提醒 ​

如果你希望当某个服务器的ip发生变更时收到通知，可以在这里进行设置

覆盖范围 ​

在这里选择一条规则，来确定需要监控哪些服务器，可以根据自己的需求进行选择

特定服务器 ​

配合覆盖范围的设置，在这里设置选定规则的排除项

提醒发送至指定的通知分组 ​

选择通知方式，通知方式请提前在 “报警” 页内设置

WARNING

设置完成后，勾选启用时，通知生效


WARNING

IP变更通知默认打码，如果你不希望打码，可以勾选 “通知信息IP不打码”

+ \ No newline at end of file diff --git a/guide/tasks.html b/guide/tasks.html index dd351033..ece65838 100644 --- a/guide/tasks.html +++ b/guide/tasks.html @@ -10,13 +10,13 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

在任务区域中，可以设置计划任务，触发任务，多服务器批量执行任务

哪吒监控支持推送命令到 Agent 执行，因此此功能非常灵活，使用此功能可以定期结合 restic、rclone 给服务器备份，定期重启某项服务来重置网络连接。也可以配合报警通知，在触发报警时执行某项任务，如 CPU 在长时期处于高占用的情况下运行某个脚本。

使用方法 ​

进入管理面板的 “任务” 页，点击 “添加计划任务”
添加计划任务你需要填入以下参数：

  • 名称 - 自定义一个任务名称

  • 任务类型 - 选择任务的类型
    计划任务 - 按下方设置的计划时间，周期性执行任务
    触发任务 - 仅被 API 或报警规则触发的任务，每次触发执行一次

  • 计划 - （使用触发任务类型时不生效）设置计划时间，时间的格式为： * * * * * * 分别对应 秒 分 时 天 月 星期，详情见计划表达式格式
    如：0 0 3 * * * 对应为 每天3点

  • 命令 - 你可以在这里设置需要执行的命令，就像写 Shell/Bat 脚本一样，但是不推荐换行，多个命令使用 &&/& 连接
    例如执行定期重启命令，可以在这里输入 reboot

  • 覆盖范围 和 特定服务器 - 跟“服务”页中的设置类似，选择规则来确定哪些 Agent 执行计划任务
    使用触发任务类型时，可选择由触发的服务器执行

  • 通知方式组 - 选择你已经在 “报警” 页设置好的通知方式，点击这里了解详情

  • 推送成功的消息 - 勾选此项，任务执行成功后会触发消息通知

管理任务 ​

如需对已有的计划任务进行管理，可以前往管理面板中的 “任务” 页
选择一条任务配置，右侧的三个图标，分别是：

  • 立即执行 - 点击后将忽略计划时间，立刻执行任务
  • 编辑 - 点击可以修改任务配置
  • 删除 - 删除这条计划任务

常见问题 ​

  1. xxx 命令找不到
    如果运行失败，提示 xxx 命令找不到，可能是 PATH 环境变量的问题，Linux 服务器在命令开头加入 source ~/.bashrc 或者使用绝对路径执行
- +
哪吒监控

简体中文

English

简体中文

English

Appearance

On this page

在任务区域中，可以设置计划任务，触发任务，多服务器批量执行任务

哪吒监控支持推送命令到 Agent 执行，因此此功能非常灵活，使用此功能可以定期结合 restic、rclone 给服务器备份，定期重启某项服务来重置网络连接。也可以配合报警通知，在触发报警时执行某项任务，如 CPU 在长时期处于高占用的情况下运行某个脚本。

使用方法 ​

进入管理面板的 “任务” 页，点击 “添加计划任务”
添加计划任务你需要填入以下参数：

  • 名称 - 自定义一个任务名称

  • 任务类型 - 选择任务的类型
    计划任务 - 按下方设置的计划时间，周期性执行任务
    触发任务 - 仅被 API 或报警规则触发的任务，每次触发执行一次

  • 计划 - （使用触发任务类型时不生效）设置计划时间，时间的格式为： * * * * * * 分别对应 秒 分 时 天 月 星期，详情见计划表达式格式
    如：0 0 3 * * * 对应为 每天3点

  • 命令 - 你可以在这里设置需要执行的命令，就像写 Shell/Bat 脚本一样，但是不推荐换行，多个命令使用 &&/& 连接
    例如执行定期重启命令，可以在这里输入 reboot

  • 覆盖范围 和 特定服务器 - 跟“服务”页中的设置类似，选择规则来确定哪些 Agent 执行计划任务
    使用触发任务类型时，可选择由触发的服务器执行

  • 通知方式组 - 选择你已经在 “报警” 页设置好的通知方式，点击这里了解详情

  • 推送成功的消息 - 勾选此项，任务执行成功后会触发消息通知

管理任务 ​

如需对已有的计划任务进行管理，可以前往管理面板中的 “任务” 页
选择一条任务配置，右侧的三个图标，分别是：

  • 立即执行 - 点击后将忽略计划时间，立刻执行任务
  • 编辑 - 点击可以修改任务配置
  • 删除 - 删除这条计划任务

常见问题 ​

  1. xxx 命令找不到
    如果运行失败，提示 xxx 命令找不到，可能是 PATH 环境变量的问题，Linux 服务器在命令开头加入 source ~/.bashrc 或者使用绝对路径执行
+ \ No newline at end of file diff --git a/hashmap.json b/hashmap.json index fae36c51..208dfeaf 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"case_case5.md":"b8d6ff4d","en_us_guide_q4.md":"96de9450","en_us_case_case3.md":"ef33f53f","en_us_case_case4.md":"901a8aac","en_us_case_index.md":"72581bc3","en_us_guide_api.md":"bd998239","en_us_guide_q5.md":"8f36c745","en_us_guide_servers.md":"820c5100","en_us_guide_tasks.md":"72dc15df","guide_servers.md":"a95cdd04","guide_tasks.md":"a3b4b9af","en_us_guide_dashboard.md":"72b99217","en_us_guide_q3.md":"bf0af1ab","guide_dashboardq.md":"228a3a2a","guide_q5.md":"514e5257","guide_q3.md":"366010c1","en_us_guide_q2.md":"4590de90","en_us_guide_q7.md":"f435a554","en_us_developer_index.md":"bdd734fe","guide_agent.md":"c2886979","en_us_guide_settings.md":"7552ec7e","guide_api.md":"032caa3a","guide_dashboard.md":"093cd8d7","guide_notifications.md":"61c0ca0a","guide_q1.md":"b3559631","en_us_developer_theme.md":"705dbaad","en_us_developer_l10n.md":"e9e12864","en_us_guide_agent.md":"a9ad9deb","guide_agentq.md":"7e0470a4","guide_q2.md":"28537929","case_case2.md":"e0420bb1","developer_index.md":"21258c2b","en_us_case_case2.md":"771489c7","en_us_case_case1.md":"483ce18b","developer_l10n.md":"11f5060d","case_case3.md":"d58c2842","case_case4.md":"fe463edb","en_us_guide_dashboardq.md":"d010cee9","developer_theme.md":"92af267d","en_us_guide_loginq.md":"4cfb240f","en_us_guide_services.md":"a497c256","guide_loginq.md":"4ea1b144","guide_services.md":"8dabb27d","guide_q4.md":"85bcc5aa","guide_q6.md":"a33af035","guide_q7.md":"5cd0307b","index.md":"09760cbf","case_case1.md":"7e8fc212","en_us_guide_notifications.md":"4be039d9","case_index.md":"76e9f1e0","en_us_guide_agentq.md":"26a47eb6","en_us_guide_q6.md":"1eedb072","en_us_index.md":"daba93a5","guide_settings.md":"97e0da03"} +{"case_case2.md":"f7e058fc","developer_l10n.md":"931179ce","developer_theme.md":"ee895e3b","en_us_case_case1.md":"fe44ae32","case_case3.md":"3eeabd87","case_case4.md":"4cb7b388","developer_index.md":"4c46e7be","case_case1.md":"375dc3eb","en_us_case_case2.md":"83942200","en_us_guide_agent.md":"291762ff","en_us_case_case3.md":"f03fa8fa","en_us_case_case4.md":"4759869b","en_us_case_index.md":"b5eb623f","en_us_developer_theme.md":"a1b900d0","en_us_guide_q3.md":"cff7f553","en_us_guide_q4.md":"c898f6a5","en_us_guide_q5.md":"40a51ed3","en_us_guide_q6.md":"5dd62d76","en_us_developer_index.md":"3dff5fe6","en_us_guide_servers.md":"567d4d52","en_us_guide_services.md":"54d4fb7e","en_us_guide_settings.md":"a7d9321c","en_us_guide_q7.md":"cc5ff1b3","case_index.md":"48107137","en_us_guide_q2.md":"dc6deeb9","case_case5.md":"4b0d5a6c","guide_q5.md":"a351a6b4","guide_q6.md":"05f47fe9","guide_q7.md":"a0d4add7","guide_servers.md":"b8f0a7f9","guide_services.md":"e18c18ee","guide_settings.md":"2f7428da","guide_q3.md":"b99bb223","en_us_guide_api.md":"64cf9321","en_us_guide_tasks.md":"d9baafd1","en_us_developer_l10n.md":"ead94ca6","en_us_guide_dashboardq.md":"79d7db76","guide_agent.md":"538a8828","guide_q4.md":"608b8424","guide_agentq.md":"034d1254","en_us_guide_loginq.md":"f5a90bf0","en_us_guide_notifications.md":"40ad278b","en_us_guide_agentq.md":"37c15514","en_us_index.md":"43052451","guide_tasks.md":"9ed3e0b3","index.md":"e6790386","guide_api.md":"6b26afde","guide_dashboard.md":"c00e9f1b","guide_dashboardq.md":"0d8a74c7","guide_loginq.md":"dd12f064","guide_q2.md":"975e74da","en_us_guide_dashboard.md":"502d67af","guide_q1.md":"551d93fb","guide_notifications.md":"81d19261"} diff --git a/index.html b/index.html index 8a0303fc..0435ede6 100644 --- a/index.html +++ b/index.html @@ -10,13 +10,13 @@ - + -
哪吒监控

简体中文

English

简体中文

English

Appearance

哪吒监控

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

开始使用 →

一键安装

支持一键脚本安装面板和监控服务，轻松使用；Linux、Windows、MacOS、OpenWRT等主流系统均受支持

实时监控

支持同时监控多个服务器的系统状态，支持监控网页、端口、SSL证书状态；支持故障、流量等状态报警，支持多种通知方式（Telegram、邮件、微信等）

轻松运维

支持WebSSH，支持流量循环监控，支持设置定时任务、服务器批量执行任务

- +
哪吒监控

简体中文

English

简体中文

English

Appearance

哪吒监控

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

开始使用 →

一键安装

支持一键脚本安装面板和监控服务，轻松使用；Linux、Windows、MacOS、OpenWRT等主流系统均受支持

实时监控

支持同时监控多个服务器的系统状态，支持监控网页、端口、SSL证书状态；支持故障、流量等状态报警，支持多种通知方式（Telegram、邮件、微信等）

轻松运维

支持WebSSH，支持流量循环监控，支持设置定时任务、服务器批量执行任务

+ \ No newline at end of file