diff --git a/404.html b/404.html index ca299cce..57e6620c 100644 --- a/404.html +++ b/404.html @@ -15,8 +15,8 @@
哪吒监控

简体中文

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.9e690123.js b/assets/case_case1.md.b0ffeb45.js similarity index 95% rename from assets/case_case1.md.9e690123.js rename to assets/case_case1.md.b0ffeb45.js index c0c1206d..711a0528 100644 --- a/assets/case_case1.md.9e690123.js +++ b/assets/case_case1.md.b0ffeb45.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,R as r}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1715640788000}'),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.44fd0451.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1715651890000}'),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.9e690123.lean.js b/assets/case_case1.md.b0ffeb45.lean.js similarity index 85% rename from assets/case_case1.md.9e690123.lean.js rename to assets/case_case1.md.b0ffeb45.lean.js index e25d5790..af211e77 100644 --- a/assets/case_case1.md.9e690123.lean.js +++ b/assets/case_case1.md.b0ffeb45.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,R as r}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1715640788000}'),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.44fd0451.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1715651890000}'),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.4fedd3fa.js b/assets/case_case2.md.ed3674ae.js similarity index 97% rename from assets/case_case2.md.4fedd3fa.js rename to assets/case_case2.md.ed3674ae.js index 29342a03..6e0d86c3 100644 --- a/assets/case_case2.md.4fedd3fa.js +++ b/assets/case_case2.md.ed3674ae.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.44fd0451.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1715640788000}'),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.44fd0451.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1715651890000}'),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.4fedd3fa.lean.js b/assets/case_case2.md.ed3674ae.lean.js similarity index 87% rename from assets/case_case2.md.4fedd3fa.lean.js rename to assets/case_case2.md.ed3674ae.lean.js index 310e83cf..a04517b5 100644 --- a/assets/case_case2.md.4fedd3fa.lean.js +++ b/assets/case_case2.md.ed3674ae.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.44fd0451.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1715640788000}'),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.44fd0451.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1715651890000}'),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.52639ba5.js b/assets/case_case3.md.48bb8f95.js similarity index 98% rename from assets/case_case3.md.52639ba5.js rename to assets/case_case3.md.48bb8f95.js index b4d5ea64..dd155005 100644 --- a/assets/case_case3.md.52639ba5.js +++ b/assets/case_case3.md.48bb8f95.js @@ -1 +1 @@ -import{_ as t,o as e,c as a,R as r}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1715640788000}'),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.44fd0451.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1715651890000}'),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.52639ba5.lean.js b/assets/case_case3.md.48bb8f95.lean.js similarity index 86% rename from assets/case_case3.md.52639ba5.lean.js rename to assets/case_case3.md.48bb8f95.lean.js index 99f1a402..2aed04a7 100644 --- a/assets/case_case3.md.52639ba5.lean.js +++ b/assets/case_case3.md.48bb8f95.lean.js @@ -1 +1 @@ -import{_ as t,o as e,c as a,R as r}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1715640788000}'),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.44fd0451.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1715651890000}'),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.4bd8e019.js b/assets/case_case4.md.622962b5.js similarity index 97% rename from assets/case_case4.md.4bd8e019.js rename to assets/case_case4.md.622962b5.js index 11f93bee..1c6fc016 100644 --- a/assets/case_case4.md.4bd8e019.js +++ b/assets/case_case4.md.622962b5.js @@ -1 +1 @@ -import{_ as s,o as t,c as e,R as a}from"./chunks/framework.44fd0451.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":1715640788000}'),_={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.44fd0451.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":1715651890000}'),_={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.4bd8e019.lean.js b/assets/case_case4.md.622962b5.lean.js similarity index 89% rename from assets/case_case4.md.4bd8e019.lean.js rename to assets/case_case4.md.622962b5.lean.js index 4b902d1d..841532d9 100644 --- a/assets/case_case4.md.4bd8e019.lean.js +++ b/assets/case_case4.md.622962b5.lean.js @@ -1 +1 @@ -import{_ as s,o as t,c as e,R as a}from"./chunks/framework.44fd0451.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":1715640788000}'),_={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.44fd0451.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":1715651890000}'),_={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.9d19446c.js b/assets/case_case5.md.c6a30f74.js similarity index 99% rename from assets/case_case5.md.9d19446c.js rename to assets/case_case5.md.c6a30f74.js index adc24134..bd40dc49 100644 --- a/assets/case_case5.md.9d19446c.js +++ b/assets/case_case5.md.c6a30f74.js @@ -1,4 +1,4 @@ -import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1715640788000}'),l={name:"case/case5.md"},n=t(`

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

贡献者:

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

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

目录 ​

项目特点: ​

image

准备需要用的变量 ​

image

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

imageimageimageimageimage

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

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

(方式 1 - Json): ​

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

image

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

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

imageimageimageimageimageimageimage

PaaS 部署实例 ​

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

用到的变量

变量名是否必须备注
GH_USER是github 的用户名，用于面板管理授权
GH_CLIENTID是在 github 上申请
GH_CLIENTSECRET是在 github 上申请
GH_BACKUP_USER否在 github 上备份哪吒服务端数据库的 github 用户名，不填则与面板管理授权的账户 GH_USER 一致
GH_REPO否在 github 上备份哪吒服务端数据库文件的 github 库
GH_EMAIL否github 的邮箱，用于备份的 git 推送到远程库
GH_PAT否github 的 PAT
ARGO_AUTH是Json: 从 https://fscarmen.cloudflare.now.cc 获取的 Argo Json
Token: 从 Cloudflare 官网获取
ARGO_DOMAIN是Argo 域名

Koyeb

Deploy to Koyeb

imageimageimageimageimage

VPS 部署方式 1 --- docker ​

docker 部署 ​

docker run -dit \\
+import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1715651890000}'),l={name:"case/case5.md"},n=t(`
使用 Argo 隧道的哪吒服务端 ​
贡献者:
项目地址：Argo-Nezha-Service-Container
镜像备份（非实时更新）：Argo-Nezha-Service-Container
目录 ​
项目特点: ​
  • 适用范围更广 --- 只要能连通网络，就能安装哪吒服务端，如 LXC, OpenVZ VPS，Nas 虚拟机 , Container PaaS 等
  • Argo 隧道突破需要公网入口的限制 --- 传统的哪吒需要有两个公网端口，一个用于面板的访问，另一个用于客户端上报数据，本项目借用 Cloudflare Argo 隧道，使用内网穿透的办法
  • IPv4 / v6 具备更高的灵活性 --- 传统哪吒需要处理服务端和客户端的 IPv4/v6 兼容性问题，还需要通过 warp 等工具来解决不对应的情况。然而，本项目可以完全不需要考虑这些问题，可以任意对接，更加方便和简便
  • 一条 Argo 隧道分流多个域名和协议 --- 建立一条内网穿透的 Argo 隧道，即可分流三个域名(hostname)和协议(protocal)，分别用于面板的访问(http)，客户端上报数据(tcp)和 ssh（可选）
  • GrpcWebProxy 反向代理的 gRPC 数据端口 --- 配上证书做 tls 终结，然后 Argo 的隧道配置用 https 服务指向这个反向代理，启用http2回源，grpc(nezha)->GrpcWebProxy->h2(argo)->cf cdn edge->agent
  • 每天自动备份 --- 北京时间每天 4 时 0 分自动备份整个哪吒面板文件夹到指定的 github 私库，包括面板主题，面板设置，探针数据和隧道信息，备份保留近 5 天数据；鉴于内容十分重要，必须要放在私库
  • 每天自动更新面板 -- 北京时间每天 4 时 0 分自动检测最新的官方面板版本，有升级时自动更新
  • 手/自一体还原备份 --- 每分钟检测一次在线还原文件的内容，遇到有更新立刻还原
  • 默认内置本机探针 --- 能很方便的监控自身服务器信息
  • 数据更安全 --- Argo 隧道使用TLS加密通信，可以将应用程序流量安全地传输到 Cloudflare 网络，提高了应用程序的安全性和可靠性。此外，Argo Tunnel也可以防止IP泄露和DDoS攻击等网络威胁
image
准备需要用的变量 ​
  • 到 Cloudflare 官网，选择使用的域名，打开 网络 选项将 gRPC 开关打开
image
面板域名加上 https:// 开头，回调地址再加上 /oauth2/callback 结尾
imageimageimageimageimage
Argo 认证的获取方式: json 或 token ​
Argo 隧道认证方式有 json 和 token，使用两个方式其中之一。推荐前者，理由脚本会处理好所有的 Argo 隧道参数和路径，后者需要到 Cloudflare 官网手动设置，容易出错。
(方式 1 - Json): ​
通过 Cloudflare Json 生成网轻松获取 Argo 隧道 json 信息: https://fscarmen.cloudflare.now.cc ​
image
(方式 2 - Token): 通过 Cloudflare 官网，手动生成 Argo 隧道 token 信息 ​
到 cf 官网：https://dash.cloudflare.com/ ​
  • 进入 zero trust 里生成 token 隧道和信息。
  • 其中数据路径 443/https 为 proto.NezhaService
  • ssh 路径 22/ssh 为 < client id >
imageimageimageimageimageimageimage
PaaS 部署实例 ​
镜像 fscarmen/argo-nezha:latest ， 支持 amd64 和 arm64 架构
用到的变量
变量名是否必须备注
GH_USER是github 的用户名，用于面板管理授权
GH_CLIENTID是在 github 上申请
GH_CLIENTSECRET是在 github 上申请
GH_BACKUP_USER否在 github 上备份哪吒服务端数据库的 github 用户名，不填则与面板管理授权的账户 GH_USER 一致
GH_REPO否在 github 上备份哪吒服务端数据库文件的 github 库
GH_EMAIL否github 的邮箱，用于备份的 git 推送到远程库
GH_PAT否github 的 PAT
ARGO_AUTH是Json: 从 https://fscarmen.cloudflare.now.cc 获取的 Argo Json
 Token: 从 Cloudflare 官网获取
ARGO_DOMAIN是Argo 域名
Koyeb
Deploy to Koyeb
imageimageimageimageimage
VPS 部署方式 1 --- docker ​
  • 注意: ARGO_DOMAIN= 后面需要有单引号，不能去掉
  • 如果 VPS 是 IPv6 only 的，请先安装 WARP IPv4 或者双栈: https://gitlab.com/fscarmen/warp
  • 备份目录为当前路径的 dashboard 文件夹
docker 部署 ​
docker run -dit \\
            --name nezha_dashboard \\
            --pull always \\
            --restart always \\
diff --git a/assets/case_case5.md.9d19446c.lean.js b/assets/case_case5.md.c6a30f74.lean.js
similarity index 85%
rename from assets/case_case5.md.9d19446c.lean.js
rename to assets/case_case5.md.c6a30f74.lean.js
index bd53fa6e..d516176b 100644
--- a/assets/case_case5.md.9d19446c.lean.js
+++ b/assets/case_case5.md.c6a30f74.lean.js
@@ -1 +1 @@
-import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1715640788000}'),l={name:"case/case5.md"},n=t("",89),r=[n];function o(c,i,p,h,d,g){return e(),s("div",null,r)}const u=a(l,[["render",o]]);export{m as __pageData,u as default};
+import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1715651890000}'),l={name:"case/case5.md"},n=t("",89),r=[n];function o(c,i,p,h,d,g){return e(),s("div",null,r)}const u=a(l,[["render",o]]);export{m as __pageData,u as default};
diff --git a/assets/case_index.md.34edfc20.js b/assets/case_index.md.73e6bfcc.js
similarity index 88%
rename from assets/case_index.md.34edfc20.js
rename to assets/case_index.md.73e6bfcc.js
index e2997b59..29839bce 100644
--- a/assets/case_index.md.34edfc20.js
+++ b/assets/case_index.md.73e6bfcc.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目，请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献，请您知悉哪吒监控团队无法为社区项目承担包括且不限于：保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1715640788000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目，请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献，请您知悉哪吒监控团队无法为社区项目承担包括且不限于：保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1715651890000}'),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.34edfc20.lean.js b/assets/case_index.md.73e6bfcc.lean.js
similarity index 88%
rename from assets/case_index.md.34edfc20.lean.js
rename to assets/case_index.md.73e6bfcc.lean.js
index e2997b59..29839bce 100644
--- a/assets/case_index.md.34edfc20.lean.js
+++ b/assets/case_index.md.73e6bfcc.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目，请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献，请您知悉哪吒监控团队无法为社区项目承担包括且不限于：保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1715640788000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目，请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献，请您知悉哪吒监控团队无法为社区项目承担包括且不限于：保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1715651890000}'),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.1c7a4f33.js b/assets/developer_index.md.40e8edab.js
similarity index 92%
rename from assets/developer_index.md.1c7a4f33.js
rename to assets/developer_index.md.40e8edab.js
index 5a299001..26ceea93 100644
--- a/assets/developer_index.md.1c7a4f33.js
+++ b/assets/developer_index.md.40e8edab.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request，帮助哪吒监控变得更好！","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1715640788000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request，帮助哪吒监控变得更好！","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1715651890000}'),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.1c7a4f33.lean.js b/assets/developer_index.md.40e8edab.lean.js
similarity index 92%
rename from assets/developer_index.md.1c7a4f33.lean.js
rename to assets/developer_index.md.40e8edab.lean.js
index 5a299001..26ceea93 100644
--- a/assets/developer_index.md.1c7a4f33.lean.js
+++ b/assets/developer_index.md.40e8edab.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request，帮助哪吒监控变得更好！","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1715640788000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request，帮助哪吒监控变得更好！","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1715651890000}'),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.d048d5be.js b/assets/developer_l10n.md.44af3a03.js
similarity index 95%
rename from assets/developer_l10n.md.d048d5be.js
rename to assets/developer_l10n.md.44af3a03.js
index 551b5780..2a154c45 100644
--- a/assets/developer_l10n.md.d048d5be.js
+++ b/assets/developer_l10n.md.44af3a03.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1715640788000}'),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.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1715651890000}'),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.d048d5be.lean.js b/assets/developer_l10n.md.44af3a03.lean.js
similarity index 84%
rename from assets/developer_l10n.md.d048d5be.lean.js
rename to assets/developer_l10n.md.44af3a03.lean.js
index 057daf47..d4e4e8ed 100644
--- a/assets/developer_l10n.md.d048d5be.lean.js
+++ b/assets/developer_l10n.md.44af3a03.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1715640788000}'),l={name:"developer/l10n.md"},r=t("",5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1715651890000}'),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.4bc5b9e8.js b/assets/developer_theme.md.de32339f.js
similarity index 96%
rename from assets/developer_theme.md.4bc5b9e8.js
rename to assets/developer_theme.md.de32339f.js
index 70ef2618..319764bc 100644
--- a/assets/developer_theme.md.4bc5b9e8.js
+++ b/assets/developer_theme.md.de32339f.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1715640788000}'),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.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1715651890000}'),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.4bc5b9e8.lean.js b/assets/developer_theme.md.de32339f.lean.js
similarity index 84%
rename from assets/developer_theme.md.4bc5b9e8.lean.js
rename to assets/developer_theme.md.de32339f.lean.js
index 984fa4df..78e1b40d 100644
--- a/assets/developer_theme.md.4bc5b9e8.lean.js
+++ b/assets/developer_theme.md.de32339f.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1715640788000}'),c={name:"developer/theme.md"},l=t("",7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
+import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1715651890000}'),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.70896d0c.js b/assets/en_US_case_case1.md.68d4b8c0.js
similarity index 95%
rename from assets/en_US_case_case1.md.70896d0c.js
rename to assets/en_US_case_case1.md.68d4b8c0.js
index 379de058..6fe6560c 100644
--- a/assets/en_US_case_case1.md.70896d0c.js
+++ b/assets/en_US_case_case1.md.68d4b8c0.js
@@ -1 +1 @@
-import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1715640788000}'),a={name:"en_US/case/case1.md"},n=o('
Build your own Telegram bot to query server information ​
Contributors:
Project: nezha_api_tgbot (Chinese)
Mirror backup, non-real-time update: nezha_api_tgbot (Chinese)
The bot can request server status information from the Dashboard through the API, and then send the information to the user.
 You can build this bot to easily view the current status of a given server without opening the Dashboard.
',6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
+import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1715651890000}'),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.70896d0c.lean.js b/assets/en_US_case_case1.md.68d4b8c0.lean.js
similarity index 86%
rename from assets/en_US_case_case1.md.70896d0c.lean.js
rename to assets/en_US_case_case1.md.68d4b8c0.lean.js
index ec25ddf5..270c1f35 100644
--- a/assets/en_US_case_case1.md.70896d0c.lean.js
+++ b/assets/en_US_case_case1.md.68d4b8c0.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1715640788000}'),a={name:"en_US/case/case1.md"},n=o("",6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
+import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1715651890000}'),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.fe2b9a39.js b/assets/en_US_case_case2.md.3050bd1d.js
similarity index 97%
rename from assets/en_US_case_case2.md.fe2b9a39.js
rename to assets/en_US_case_case2.md.3050bd1d.js
index 91ac24f3..522f9188 100644
--- a/assets/en_US_case_case2.md.fe2b9a39.js
+++ b/assets/en_US_case_case2.md.3050bd1d.js
@@ -1 +1 @@
-import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1715640788000}'),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.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1715651890000}'),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.fe2b9a39.lean.js b/assets/en_US_case_case2.md.3050bd1d.lean.js
similarity index 87%
rename from assets/en_US_case_case2.md.fe2b9a39.lean.js
rename to assets/en_US_case_case2.md.3050bd1d.lean.js
index 9c0f6a6e..38e34198 100644
--- a/assets/en_US_case_case2.md.fe2b9a39.lean.js
+++ b/assets/en_US_case_case2.md.3050bd1d.lean.js
@@ -1 +1 @@
-import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1715640788000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
+import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1715651890000}'),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.e87df190.js b/assets/en_US_case_case3.md.d6e1e0c9.js
similarity index 98%
rename from assets/en_US_case_case3.md.e87df190.js
rename to assets/en_US_case_case3.md.d6e1e0c9.js
index 26cd29d0..82ae429c 100644
--- a/assets/en_US_case_case3.md.e87df190.js
+++ b/assets/en_US_case_case3.md.d6e1e0c9.js
@@ -1 +1 @@
-import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1715640788000}'),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.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1715651890000}'),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.e87df190.lean.js b/assets/en_US_case_case3.md.d6e1e0c9.lean.js
similarity index 87%
rename from assets/en_US_case_case3.md.e87df190.lean.js
rename to assets/en_US_case_case3.md.d6e1e0c9.lean.js
index a9ba2e67..bb771cb0 100644
--- a/assets/en_US_case_case3.md.e87df190.lean.js
+++ b/assets/en_US_case_case3.md.d6e1e0c9.lean.js
@@ -1 +1 @@
-import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1715640788000}'),d={name:"en_US/case/case3.md"},i=a("",9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default};
+import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1715651890000}'),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.a582cf12.js b/assets/en_US_case_case4.md.5c1a6961.js
similarity index 94%
rename from assets/en_US_case_case4.md.a582cf12.js
rename to assets/en_US_case_case4.md.5c1a6961.js
index 422575d0..5a125e5c 100644
--- a/assets/en_US_case_case4.md.a582cf12.js
+++ b/assets/en_US_case_case4.md.5c1a6961.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1715640788000}'),n={name:"en_US/case/case4.md"},o=r('
Fake-agent, monitoring data cheater ​
Contributor:
GitHub project: fake-nezha-agent（Chinese）
 Mirror backup, non-real-time update ：fake-nezha-agent（Chinese）
You can modify the monitoring data uploaded to Dashboard by the Agent
 Use it for cheating 😈
',5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
+import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1715651890000}'),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.a582cf12.lean.js b/assets/en_US_case_case4.md.5c1a6961.lean.js
similarity index 85%
rename from assets/en_US_case_case4.md.a582cf12.lean.js
rename to assets/en_US_case_case4.md.5c1a6961.lean.js
index 463a4676..09aa679e 100644
--- a/assets/en_US_case_case4.md.a582cf12.lean.js
+++ b/assets/en_US_case_case4.md.5c1a6961.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1715640788000}'),n={name:"en_US/case/case4.md"},o=r("",5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
+import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1715651890000}'),n={name:"en_US/case/case4.md"},o=r("",5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
diff --git a/assets/en_US_case_case5.md.c70d768b.js b/assets/en_US_case_case5.md.0c5c8026.js
similarity index 99%
rename from assets/en_US_case_case5.md.c70d768b.js
rename to assets/en_US_case_case5.md.0c5c8026.js
index ba9c3683..fc437ace 100644
--- a/assets/en_US_case_case5.md.c70d768b.js
+++ b/assets/en_US_case_case5.md.0c5c8026.js
@@ -1,4 +1,4 @@
-import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1715640788000}'),n={name:"en_US/case/case5.md"},o=s(`
Nezha server over Argo tunnel ​
Contributors:
GitHub project: Argo-Nezha-Service-Container
Mirror backup (not live update): Argo-Nezha-Service-Container
Catalog ​
Project Features. ​
  • Wider scope of application --- As long as there is a network connection, Nezha server can be installed, such as LXC, OpenVZ VPS, Nas Virtual Machine, Container PaaS, etc.
  • Argo tunnel breaks through the restriction of requiring a public network portal --- The traditional Nezha requires two public network ports, one for panel visiting and the other for client reporting, this project uses Cloudflare Argo tunnels and uses intranet tunneling.
  • IPv4 / v6 with higher flexibility --- The traditional Nezha needs to deal with IPv4/v6 compatibility between server and client, and also needs to resolve mismatches through tools such as warp. However, this project does not need to consider these issues at all, and can be docked arbitrarily, which is much more convenient and easy!
  • One Argo tunnel for multiple domains and protocols --- Create an intranet-penetrating Argo tunnel for three domains (hostname) and protocols, which can be used for panel access (http), client reporting (tcp) and ssh (optional).
  • GrpcWebProxy reverse proxy gRPC data port --- with a certificate for tls termination, then Argo's tunnel configuration with https service pointing to this reverse proxy, enable http2 back to the source, grpc(nezha)->GrpcWebProxy->h2(argo)->cf cdn edge->agent
  • Daily automatic backup --- every day at 04:00 BST, the entire Nezha panel folder is automatically backed up to a designated private github repository, including panel themes, panel settings, probe data and tunnel information, the backup retains nearly 5 days of data; the content is so important that it must be placed in the private repository.
  • Automatic daily panel update -- the latest official panel version is automatically detected every day at 4:00 BST, and updated when there is an upgrade.
  • Manual/automatic restore backup --- check the content of online restore file once a minute, and restore immediately when there is any update.
  • Default built-in local probes --- can easily monitor their own server information
  • More secure data --- Argo Tunnel uses TLS encrypted communication to securely transmit application traffic to the Cloudflare network, improving application security and reliability. In addition, Argo Tunnel protects against network threats such as IP leaks and DDoS attacks.
image
Prepare variables to be used ​
  • Visit the Cloudflare website, select the domain name you want to use, and turn on the network option to turn the gRPC switch on.
image
Add https:// to the beginning of the panel's domain name and /oauth2/callback to the end of the callback address.
imageimageimageimageimage
How to get Argo authentication: json or token ​
Argo tunnel authentication methods include json and token, use one of the two methods. The former is recommended because the script will handle all the Argo tunnel parameters and paths, while the latter needs to be set manually on the Cloudflare website and is prone to errors.
(Methods 1 - Json): ​
Easily get Argo tunnel json information through Cloudflare Json Generation Network: https://fscarmen.cloudflare.now.cc ​
image
(Methods 2 - Token): Manually generate Argo tunnel token information via Cloudflare website. ​
Go to the cf website: https://dash.cloudflare.com/ ​
  • Go to zero trust and generate token tunnel and message.
  • The data path 443/https is proto.
  • ssh path 22/ssh for < client id >.
imageimageimageimageimageimageimage
PaaS Deployment Example ​
Image fscarmen/argo-nezha:latest, supports amd64 and arm64 architectures.
Variables used
Variable NameRequiredRemarks
GH_USERYesgithub username for panel admin authorization
GH_CLIENTIDyesapply on github
GH_CLIENTSECRETyesapply on github
GH_BACKUP_USERNoThe github username for backing up Nezha's server-side database on github, if not filled in, it is the same as the account GH_USER for panel management authorization
GH_REPONoThe github repository for backing up Nezha's server-side database files on github
GH_EMAILNogithub's mailbox for git push backups to remote repositories
GH_PATNogithub's PAT
ARGO_AUTHYesArgo Json from https://fscarmen.cloudflare.now.cc
Argo token from Cloudflare official website
ARGO_DOMAINYesArgo domain
Koyeb
Deploy to Koyeb
imageimageimageimageimage
VPS Deployment Method 1 --- docker ​
  • Note: ARGO_DOMAIN= must be followed by single quotes, which cannot be removed.
  • If the VPS is IPv6 only, please install WARP IPv4 or dual-stack first: https://github.com/fscarmen/warp
  • The backup directory is the dashboard folder in the current path.
docker deployment ​
docker run -dit \\
+import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1715651890000}'),n={name:"en_US/case/case5.md"},o=s(`
Nezha server over Argo tunnel ​
Contributors:
GitHub project: Argo-Nezha-Service-Container
Mirror backup (not live update): Argo-Nezha-Service-Container
Catalog ​
Project Features. ​
  • Wider scope of application --- As long as there is a network connection, Nezha server can be installed, such as LXC, OpenVZ VPS, Nas Virtual Machine, Container PaaS, etc.
  • Argo tunnel breaks through the restriction of requiring a public network portal --- The traditional Nezha requires two public network ports, one for panel visiting and the other for client reporting, this project uses Cloudflare Argo tunnels and uses intranet tunneling.
  • IPv4 / v6 with higher flexibility --- The traditional Nezha needs to deal with IPv4/v6 compatibility between server and client, and also needs to resolve mismatches through tools such as warp. However, this project does not need to consider these issues at all, and can be docked arbitrarily, which is much more convenient and easy!
  • One Argo tunnel for multiple domains and protocols --- Create an intranet-penetrating Argo tunnel for three domains (hostname) and protocols, which can be used for panel access (http), client reporting (tcp) and ssh (optional).
  • GrpcWebProxy reverse proxy gRPC data port --- with a certificate for tls termination, then Argo's tunnel configuration with https service pointing to this reverse proxy, enable http2 back to the source, grpc(nezha)->GrpcWebProxy->h2(argo)->cf cdn edge->agent
  • Daily automatic backup --- every day at 04:00 BST, the entire Nezha panel folder is automatically backed up to a designated private github repository, including panel themes, panel settings, probe data and tunnel information, the backup retains nearly 5 days of data; the content is so important that it must be placed in the private repository.
  • Automatic daily panel update -- the latest official panel version is automatically detected every day at 4:00 BST, and updated when there is an upgrade.
  • Manual/automatic restore backup --- check the content of online restore file once a minute, and restore immediately when there is any update.
  • Default built-in local probes --- can easily monitor their own server information
  • More secure data --- Argo Tunnel uses TLS encrypted communication to securely transmit application traffic to the Cloudflare network, improving application security and reliability. In addition, Argo Tunnel protects against network threats such as IP leaks and DDoS attacks.
image
Prepare variables to be used ​
  • Visit the Cloudflare website, select the domain name you want to use, and turn on the network option to turn the gRPC switch on.
image
Add https:// to the beginning of the panel's domain name and /oauth2/callback to the end of the callback address.
imageimageimageimageimage
How to get Argo authentication: json or token ​
Argo tunnel authentication methods include json and token, use one of the two methods. The former is recommended because the script will handle all the Argo tunnel parameters and paths, while the latter needs to be set manually on the Cloudflare website and is prone to errors.
(Methods 1 - Json): ​
Easily get Argo tunnel json information through Cloudflare Json Generation Network: https://fscarmen.cloudflare.now.cc ​
image
(Methods 2 - Token): Manually generate Argo tunnel token information via Cloudflare website. ​
Go to the cf website: https://dash.cloudflare.com/ ​
  • Go to zero trust and generate token tunnel and message.
  • The data path 443/https is proto.
  • ssh path 22/ssh for < client id >.
imageimageimageimageimageimageimage
PaaS Deployment Example ​
Image fscarmen/argo-nezha:latest, supports amd64 and arm64 architectures.
Variables used
Variable NameRequiredRemarks
GH_USERYesgithub username for panel admin authorization
GH_CLIENTIDyesapply on github
GH_CLIENTSECRETyesapply on github
GH_BACKUP_USERNoThe github username for backing up Nezha's server-side database on github, if not filled in, it is the same as the account GH_USER for panel management authorization
GH_REPONoThe github repository for backing up Nezha's server-side database files on github
GH_EMAILNogithub's mailbox for git push backups to remote repositories
GH_PATNogithub's PAT
ARGO_AUTHYesArgo Json from https://fscarmen.cloudflare.now.cc
Argo token from Cloudflare official website
ARGO_DOMAINYesArgo domain
Koyeb
Deploy to Koyeb
imageimageimageimageimage
VPS Deployment Method 1 --- docker ​
  • Note: ARGO_DOMAIN= must be followed by single quotes, which cannot be removed.
  • If the VPS is IPv6 only, please install WARP IPv4 or dual-stack first: https://github.com/fscarmen/warp
  • The backup directory is the dashboard folder in the current path.
docker deployment ​
docker run -dit \\
            --name nezha_dashboard \\
            --pull always \\
            --restart always \\
diff --git a/assets/en_US_case_case5.md.c70d768b.lean.js b/assets/en_US_case_case5.md.0c5c8026.lean.js
similarity index 85%
rename from assets/en_US_case_case5.md.c70d768b.lean.js
rename to assets/en_US_case_case5.md.0c5c8026.lean.js
index b5f6f001..9cf59161 100644
--- a/assets/en_US_case_case5.md.c70d768b.lean.js
+++ b/assets/en_US_case_case5.md.0c5c8026.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1715640788000}'),n={name:"en_US/case/case5.md"},o=s("",89),r=[o];function l(i,c,h,p,d,u){return a(),t("div",null,r)}const f=e(n,[["render",l]]);export{g as __pageData,f as default};
+import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1715651890000}'),n={name:"en_US/case/case5.md"},o=s("",89),r=[o];function l(i,c,h,p,d,u){return a(),t("div",null,r)}const f=e(n,[["render",l]]);export{g as __pageData,f as default};
diff --git a/assets/en_US_case_index.md.084b2a58.js b/assets/en_US_case_index.md.426c1c9c.js
similarity index 95%
rename from assets/en_US_case_index.md.084b2a58.js
rename to assets/en_US_case_index.md.426c1c9c.js
index c73e4b22..cab9ad88 100644
--- a/assets/en_US_case_index.md.084b2a58.js
+++ b/assets/en_US_case_index.md.426c1c9c.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1715640788000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1715651890000}'),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.084b2a58.lean.js b/assets/en_US_case_index.md.426c1c9c.lean.js
similarity index 95%
rename from assets/en_US_case_index.md.084b2a58.lean.js
rename to assets/en_US_case_index.md.426c1c9c.lean.js
index c73e4b22..cab9ad88 100644
--- a/assets/en_US_case_index.md.084b2a58.lean.js
+++ b/assets/en_US_case_index.md.426c1c9c.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1715640788000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1715651890000}'),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.82004e0a.js b/assets/en_US_developer_index.md.9ebb076b.js
similarity index 91%
rename from assets/en_US_developer_index.md.82004e0a.js
rename to assets/en_US_developer_index.md.9ebb076b.js
index 886060e4..aa594563 100644
--- a/assets/en_US_developer_index.md.82004e0a.js
+++ b/assets/en_US_developer_index.md.9ebb076b.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1715640788000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1715651890000}'),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.82004e0a.lean.js b/assets/en_US_developer_index.md.9ebb076b.lean.js
similarity index 91%
rename from assets/en_US_developer_index.md.82004e0a.lean.js
rename to assets/en_US_developer_index.md.9ebb076b.lean.js
index 886060e4..aa594563 100644
--- a/assets/en_US_developer_index.md.82004e0a.lean.js
+++ b/assets/en_US_developer_index.md.9ebb076b.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1715640788000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default};
+import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1715651890000}'),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.5e35de87.js b/assets/en_US_developer_l10n.md.13b00a40.js
similarity index 96%
rename from assets/en_US_developer_l10n.md.5e35de87.js
rename to assets/en_US_developer_l10n.md.13b00a40.js
index 5799698a..93ba5f02 100644
--- a/assets/en_US_developer_l10n.md.5e35de87.js
+++ b/assets/en_US_developer_l10n.md.13b00a40.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1715640788000}'),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.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1715651890000}'),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.5e35de87.lean.js b/assets/en_US_developer_l10n.md.13b00a40.lean.js
similarity index 85%
rename from assets/en_US_developer_l10n.md.5e35de87.lean.js
rename to assets/en_US_developer_l10n.md.13b00a40.lean.js
index d30c08d1..cbd7495d 100644
--- a/assets/en_US_developer_l10n.md.5e35de87.lean.js
+++ b/assets/en_US_developer_l10n.md.13b00a40.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1715640788000}'),o={name:"en_US/developer/l10n.md"},i=n("",5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default};
+import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1715651890000}'),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.083ee7bf.js b/assets/en_US_developer_theme.md.c6c2705e.js
similarity index 96%
rename from assets/en_US_developer_theme.md.083ee7bf.js
rename to assets/en_US_developer_theme.md.c6c2705e.js
index 8322c942..8aaa0208 100644
--- a/assets/en_US_developer_theme.md.083ee7bf.js
+++ b/assets/en_US_developer_theme.md.c6c2705e.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1715640788000}'),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.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1715651890000}'),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.083ee7bf.lean.js b/assets/en_US_developer_theme.md.c6c2705e.lean.js
similarity index 84%
rename from assets/en_US_developer_theme.md.083ee7bf.lean.js
rename to assets/en_US_developer_theme.md.c6c2705e.lean.js
index f410a63d..c9262d0f 100644
--- a/assets/en_US_developer_theme.md.083ee7bf.lean.js
+++ b/assets/en_US_developer_theme.md.c6c2705e.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1715640788000}'),n={name:"en_US/developer/theme.md"},c=a("",7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
+import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1715651890000}'),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.fc9616b9.js b/assets/en_US_guide_agent.md.df49cb2f.js
similarity index 99%
rename from assets/en_US_guide_agent.md.fc9616b9.js
rename to assets/en_US_guide_agent.md.df49cb2f.js
index 7da26cb9..4263b635 100644
--- a/assets/en_US_guide_agent.md.fc9616b9.js
+++ b/assets/en_US_guide_agent.md.df49cb2f.js
@@ -1,4 +1,4 @@
-import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1715640788000}'),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
TIP
Agent binary repository: https://github.com/nezhahq/agent/releases
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.44fd0451.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1715651890000}'),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
TIP
Agent binary repository: https://github.com/nezhahq/agent/releases
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.fc9616b9.lean.js b/assets/en_US_guide_agent.md.df49cb2f.lean.js
similarity index 84%
rename from assets/en_US_guide_agent.md.fc9616b9.lean.js
rename to assets/en_US_guide_agent.md.df49cb2f.lean.js
index 5f1b85b9..d2e617b9 100644
--- a/assets/en_US_guide_agent.md.fc9616b9.lean.js
+++ b/assets/en_US_guide_agent.md.df49cb2f.lean.js
@@ -1 +1 @@
-import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1715640788000}'),o={name:"en_US/guide/agent.md"},e=l("",75),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.44fd0451.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1715651890000}'),o={name:"en_US/guide/agent.md"},e=l("",75),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.ac6bf770.js b/assets/en_US_guide_agentq.md.8b51bd53.js
similarity index 97%
rename from assets/en_US_guide_agentq.md.ac6bf770.js
rename to assets/en_US_guide_agentq.md.8b51bd53.js
index 8c466a10..be27bd1f 100644
--- a/assets/en_US_guide_agentq.md.ac6bf770.js
+++ b/assets/en_US_guide_agentq.md.8b51bd53.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1715640788000}'),i={name:"en_US/guide/agentq.md"},o=n('
The IP Displayed in the Admin Panel is Different from the Actual Agent IP? ​
Please refer to Dashboard Related - Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?. This will not be repeated here.
Errors During One-Click Script Installation ​
curl: Failed to connect to raw.githubusercontent.com...... ​
This mostly occurs on servers in mainland China. Currently, the one-click script fetches the installation script directly from Github. You may try several times, or manually install the Agent. Additionally, you can find third-party Github acceleration services or mirrors and set them in the one-click installation script.
sudo: command not found ​
Please manually install sudo first, for example, in Ubuntu:
shell
apt install sudo
',8),l=[o];function r(s,c,d,h,p,u){return t(),a("div",null,l)}const _=e(i,[["render",r]]);export{f as __pageData,_ as default};
+import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1715651890000}'),i={name:"en_US/guide/agentq.md"},o=n('
The IP Displayed in the Admin Panel is Different from the Actual Agent IP? ​
Please refer to Dashboard Related - Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?. This will not be repeated here.
Errors During One-Click Script Installation ​
curl: Failed to connect to raw.githubusercontent.com...... ​
This mostly occurs on servers in mainland China. Currently, the one-click script fetches the installation script directly from Github. You may try several times, or manually install the Agent. Additionally, you can find third-party Github acceleration services or mirrors and set them in the one-click installation script.
sudo: command not found ​
Please manually install sudo first, for example, in Ubuntu:
shell
apt install sudo
',8),l=[o];function r(s,c,d,h,p,u){return t(),a("div",null,l)}const _=e(i,[["render",r]]);export{f as __pageData,_ as default};
diff --git a/assets/en_US_guide_agentq.md.ac6bf770.lean.js b/assets/en_US_guide_agentq.md.8b51bd53.lean.js
similarity index 85%
rename from assets/en_US_guide_agentq.md.ac6bf770.lean.js
rename to assets/en_US_guide_agentq.md.8b51bd53.lean.js
index 8fdf0733..c2d9185a 100644
--- a/assets/en_US_guide_agentq.md.ac6bf770.lean.js
+++ b/assets/en_US_guide_agentq.md.8b51bd53.lean.js
@@ -1 +1 @@
-import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1715640788000}'),i={name:"en_US/guide/agentq.md"},o=n("",8),l=[o];function r(s,c,d,h,p,u){return t(),a("div",null,l)}const _=e(i,[["render",r]]);export{f as __pageData,_ as default};
+import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1715651890000}'),i={name:"en_US/guide/agentq.md"},o=n("",8),l=[o];function r(s,c,d,h,p,u){return t(),a("div",null,l)}const _=e(i,[["render",r]]);export{f as __pageData,_ as default};
diff --git a/assets/en_US_guide_api.md.131dd0ad.js b/assets/en_US_guide_api.md.131dd0ad.js
deleted file mode 100644
index 57e2061c..00000000
--- a/assets/en_US_guide_api.md.131dd0ad.js
+++ /dev/null
@@ -1,110 +0,0 @@
-import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1715640788000}'),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",
-    "result": [
-        {
-            "id": 1,
-            "name": "Server1",
-            "tag": "Tag1",
-            "last_active": 1653014667,
-            "ipv4": "1.1.1.1",
-            "ipv6": "",
-            "valid_ip": "1.1.1.1"
-        },
-        {
-            "id": 2,
-            "name": "Server2",
-            "tag": "Tag2",
-            "last_active": -62135596800,
-            "ipv4": "",
-            "ipv6": "",
-            "valid_ip": ""
-        }
-    ]
-}
  • Get server details: GET /api/v1/server/details?id=&tag=
     query: id (ServerID. Multiple IDs are separated by commas, provide this value to query the server corresponding to the ID, while ignoring the tag value)
     query: tag (ServerTag, if this value is provided, only the servers in this group are queried)
JSON Return Example:
{
-    "code": 0,
-    "message": "success",
-    "result": [
-        {
-            "id": 1,
-            "name": "Server1",
-            "tag": "Tag1",
-            "last_active": 1653015042,
-            "ipv4": "1.1.1.1",
-            "ipv6": "",
-            "valid_ip": "1.1.1.1",
-            "host": {
-                "Platform": "darwin",
-                "PlatformVersion": "12.3.1",
-                "CPU": [
-                    "Apple M1 Pro 1 Physical Core"
-                ],
-                "MemTotal": 17179869184,
-                "DiskTotal": 2473496842240,
-                "SwapTotal": 0,
-                "Arch": "arm64",
-                "Virtualization": "",
-                "BootTime": 1652683962,
-                "CountryCode": "hk",
-                "Version": ""
-            },
-            "status": {
-                "CPU": 17.330210772540017,
-                "MemUsed": 14013841408,
-                "SwapUsed": 0,
-                "DiskUsed": 2335048912896,
-                "NetInTransfer": 2710273234,
-                "NetOutTransfer": 695454765,
-                "NetInSpeed": 10806,
-                "NetOutSpeed": 5303,
-                "Uptime": 331080,
-                "Load1": 5.23486328125,
-                "Load5": 4.873046875,
-                "Load15": 3.99267578125,
-                "TcpConnCount": 195,
-                "UdpConnCount": 70,
-                "ProcessCount": 437
-            }
-        },
-        {
-            "id": 2,
-            "name": "Server2",
-            "tag": "Tag2",
-            "last_active": -62135596800,
-            "ipv4": "",
-            "ipv6": "",
-            "valid_ip": "",
-            "host": {
-                "Platform": "",
-                "PlatformVersion": "",
-                "CPU": null,
-                "MemTotal": 0,
-                "DiskTotal": 0,
-                "SwapTotal": 0,
-                "Arch": "",
-                "Virtualization": "",
-                "BootTime": 0,
-                "CountryCode": "",
-                "Version": ""
-            },
-            "status": {
-                "CPU": 0,
-                "MemUsed": 0,
-                "SwapUsed": 0,
-                "DiskUsed": 0,
-                "NetInTransfer": 0,
-                "NetOutTransfer": 0,
-                "NetInSpeed": 0,
-                "NetOutSpeed": 0,
-                "Uptime": 0,
-                "Load1": 0,
-                "Load5": 0,
-                "Load15": 0,
-                "TcpConnCount": 0,
-                "UdpConnCount": 0,
-                "ProcessCount": 0
-            }
-        }
-    ]
-}
`,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_api.md.131dd0ad.lean.js b/assets/en_US_guide_api.md.131dd0ad.lean.js
deleted file mode 100644
index 1f3f7939..00000000
--- a/assets/en_US_guide_api.md.131dd0ad.lean.js
+++ /dev/null
@@ -1 +0,0 @@
-import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1715640788000}'),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_api.md.ff18d057.js b/assets/en_US_guide_api.md.ff18d057.js
new file mode 100644
index 00000000..0c3f5f27
--- /dev/null
+++ b/assets/en_US_guide_api.md.ff18d057.js
@@ -0,0 +1,138 @@
+import{_ as s,o as a,c as n,R as o}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1715651890000}'),l={name:"en_US/guide/api.md"},p=o(`
Nezha Monitoring supports querying the status information of Agents using the API interface
Creating a Token ​
Nezha Monitoring's API interface allows for Token authentication and Cookies authentication. To create a new Token, go to the admin panel, click on the avatar in the top right corner, select "API Token," and enter the Token management page. Click "Add Token", add a custom note, and click "Add".
To delete a Token, select the corresponding Token and click the delete icon on the right.
WARNING
Tokens are the authentication credentials for the API interface. They are critical to the security of your Dashboard's information, so do not share your Token with others.
Authentication Method ​
Ensure the request header contains Authorization: Token for authentication.
Token authentication method:
Request Headers:
+Authorization: Token
Usage Instructions ​
WARNING
Negative timestamps in the following examples represent 0000-00-00. This currently indicates that the Agent has never reported since the Dashboard went online, but it is not recommended to use the positive or negative value to determine the status.
TIP
The request method is GET, and the response format is JSON.
Get Server List ​
Request:
GET /api/v1/server/list?tag=
Parameters:
  • tag (optional): ServerTag is the server group. Provide this parameter to query only servers in that group.
Example response:
json
{
+    "code": 0,
+    "message": "success",
+    "result": [
+        {
+            "id": 1,
+            "name": "Server1",
+            "tag": "Tag1",
+            "last_active": 1653014667,
+            "ipv4": "1.1.1.1",
+            "ipv6": "",
+            "valid_ip": "1.1.1.1"
+        },
+        {
+            "id": 2,
+            "name": "Server2",
+            "tag": "Tag2",
+            "last_active": -62135596800,
+            "ipv4": "",
+            "ipv6": "",
+            "valid_ip": ""
+        }
+    ]
+}
Get Server Details ​
Request:
GET /api/v1/server/details?id=&tag=
Parameters:
  • id (optional): ServerID, multiple IDs separated by commas. Provide this parameter to query the server corresponding to that ID and ignore the tag parameter.
  • tag (optional): ServerTag, provide this parameter to query only servers in that group.
Example response:
json
{
+    "code": 0,
+    "message": "success",
+    "result": [
+        {
+            "id": 1,
+            "name": "Server1",
+            "tag": "Tag1",
+            "last_active": 1653015042,
+            "ipv4": "1.1.1.1",
+            "ipv6": "",
+            "valid_ip": "1.1.1.1",
+            "host": {
+                "Platform": "darwin",
+                "PlatformVersion": "12.3.1",
+                "CPU": [
+                    "Apple M1 Pro 1 Physical Core"
+                ],
+                "MemTotal": 17179869184,
+                "DiskTotal": 2473496842240,
+                "SwapTotal": 0,
+                "Arch": "arm64",
+                "Virtualization": "",
+                "BootTime": 1652683962,
+                "CountryCode": "hk",
+                "Version": ""
+            },
+            "status": {
+                "CPU": 17.33,
+                "MemUsed": 14013841408,
+                "SwapUsed": 0,
+                "DiskUsed": 2335048912896,
+                "NetInTransfer": 2710273234,
+                "NetOutTransfer": 695454765,
+                "NetInSpeed": 10806,
+                "NetOutSpeed": 5303,
+                "Uptime": 331080,
+                "Load1": 5.23,
+                "Load5": 4.87,
+                "Load15": 3.99,
+                "TcpConnCount": 195,
+                "UdpConnCount": 70,
+                "ProcessCount": 437
+            }
+        },
+        {
+            "id": 2,
+            "name": "Server2",
+            "tag": "Tag2",
+            "last_active": -62135596800,
+            "ipv4": "",
+            "ipv6": "",
+            "valid_ip": "",
+            "host": {
+                "Platform": "",
+                "PlatformVersion": "",
+                "CPU": null,
+                "MemTotal": 0,
+                "DiskTotal": 0,
+                "SwapTotal": 0,
+                "Arch": "",
+                "Virtualization": "",
+                "BootTime": 0,
+                "CountryCode": "",
+                "Version": ""
+            },
+            "status": {
+                "CPU": 0,
+                "MemUsed": 0,
+                "SwapUsed": 0,
+                "DiskUsed": 0,
+                "NetInTransfer": 0,
+                "NetOutTransfer": 0,
+                "NetInSpeed": 0,
+                "NetOutSpeed": 0,
+                "Uptime": 0,
+                "Load1": 0,
+                "Load5": 0,
+                "Load15": 0,
+                "TcpConnCount": 0,
+                "UdpConnCount": 0,
+                "ProcessCount": 0
+            }
+        }
+    ]
+}
Usage Examples ​
Get All Server Information ​
python
import requests
+
+url = "http://your-dashboard/api/v1/server/list"
+headers = {
+    "Authorization": "your_token"
+}
+
+response = requests.get(url, headers=headers)
+data = response.json()
+
+for server in data['result']:
+    print(f"Server Name: {server['name']}, Last Active: {server['last_active']}, IP: {server['valid_ip']}")
Get Specific Server Details ​
python
import requests
+
+server_id = 1  # Replace with your server ID
+url = f"http://your-dashboard/api/v1/server/details?id={server_id}"
+headers = {
+    "Authorization": "your_token"
+}
+
+response = requests.get(url, headers=headers)
+data = response.json()
+
+server = data['result'][0]
+print(f"Server Name: {server['name']}")
+print(f"CPU Usage: {server['status']['CPU']}%")
+print(f"Memory Used: {server['status']['MemUsed']} bytes")
+print(f"Disk Used: {server['status']['DiskUsed']} bytes")
+print(f"Network In Speed: {server['status']['NetInSpeed']} bytes/s")
+print(f"Network Out Speed: {server['status']['NetOutSpeed']} bytes/s")
With the above example code, you can easily obtain and process server status information, enabling automated monitoring and management.
`,32),e=[p];function t(D,r,c,F,y,C){return a(),n("div",null,e)}const u=s(l,[["render",t]]);export{i as __pageData,u as default};
diff --git a/assets/en_US_guide_api.md.ff18d057.lean.js b/assets/en_US_guide_api.md.ff18d057.lean.js
new file mode 100644
index 00000000..75dfb5de
--- /dev/null
+++ b/assets/en_US_guide_api.md.ff18d057.lean.js
@@ -0,0 +1 @@
+import{_ as s,o as a,c as n,R as o}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1715651890000}'),l={name:"en_US/guide/api.md"},p=o("",32),e=[p];function t(D,r,c,F,y,C){return a(),n("div",null,e)}const u=s(l,[["render",t]]);export{i as __pageData,u as default};
diff --git a/assets/en_US_guide_dashboard.md.4a0aba5e.js b/assets/en_US_guide_dashboard.md.f5ba44c9.js
similarity index 99%
rename from assets/en_US_guide_dashboard.md.4a0aba5e.js
rename to assets/en_US_guide_dashboard.md.f5ba44c9.js
index 81b7fe8f..361e8fbd 100644
--- a/assets/en_US_guide_dashboard.md.4a0aba5e.js
+++ b/assets/en_US_guide_dashboard.md.f5ba44c9.js
@@ -1,4 +1,4 @@
-import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1715640788000}'),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.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1715651890000}'),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.4a0aba5e.lean.js b/assets/en_US_guide_dashboard.md.f5ba44c9.lean.js
similarity index 85%
rename from assets/en_US_guide_dashboard.md.4a0aba5e.lean.js
rename to assets/en_US_guide_dashboard.md.f5ba44c9.lean.js
index dccd39e7..6bd9e08c 100644
--- a/assets/en_US_guide_dashboard.md.4a0aba5e.lean.js
+++ b/assets/en_US_guide_dashboard.md.f5ba44c9.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1715640788000}'),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.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1715651890000}'),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.23258ad5.js b/assets/en_US_guide_dashboardq.md.1d2992f0.js
similarity index 99%
rename from assets/en_US_guide_dashboardq.md.23258ad5.js
rename to assets/en_US_guide_dashboardq.md.1d2992f0.js
index 2359369a..eae665d5 100644
--- a/assets/en_US_guide_dashboardq.md.23258ad5.js
+++ b/assets/en_US_guide_dashboardq.md.1d2992f0.js
@@ -1,4 +1,4 @@
-import{_ as e,o as a,c as s,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1715640788000}'),t={name:"en_US/guide/dashboardq.md"},n=o(`
Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP? ​
First, let's explain how the IP displayed in the Admin panel is obtained: The Agent periodically requests IP-API to get IP information and reports it to the Dashboard. The currently used IP-API can be viewed here: myip.go.
 If you find that the IP displayed in the Admin panel is different from the IP provided by your service provider, it is most likely that the service provider has given you an entry IP, but the Agent is testing your exit IP. This issue can also occur with multi-line servers and IPLC private lines.
TIP
For example, a common scenario is that the service provider gives you a high-defense server. To meet both high defense and low network interruption rate goals, the IP provided may be a mapped high-defense IP rather than your server's real exit IP.
You can also test the exit IP on the Agent server by running the following commands:
shell
curl https://ipapi.co/ip/
+import{_ as e,o as a,c as s,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1715651890000}'),t={name:"en_US/guide/dashboardq.md"},n=o(`
Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP? ​
First, let's explain how the IP displayed in the Admin panel is obtained: The Agent periodically requests IP-API to get IP information and reports it to the Dashboard. The currently used IP-API can be viewed here: myip.go.
 If you find that the IP displayed in the Admin panel is different from the IP provided by your service provider, it is most likely that the service provider has given you an entry IP, but the Agent is testing your exit IP. This issue can also occur with multi-line servers and IPLC private lines.
TIP
For example, a common scenario is that the service provider gives you a high-defense server. To meet both high defense and low network interruption rate goals, the IP provided may be a mapped high-defense IP rather than your server's real exit IP.
You can also test the exit IP on the Agent server by running the following commands:
shell
curl https://ipapi.co/ip/
 curl ip.sb
 curl ip-api.com
Forgot or Deleted Viewing Password ​
Please view or edit the /opt/nezha/dashboard/data/config.yaml file.
 The password is located under the site-viewpassword item.
Dashboard Installation/Restart/Update Failure: iptables ...... ​
First, try restarting Docker before proceeding:
shell
systemctl status docker
 systemctl restart docker
diff --git a/assets/en_US_guide_dashboardq.md.23258ad5.lean.js b/assets/en_US_guide_dashboardq.md.1d2992f0.lean.js
similarity index 85%
rename from assets/en_US_guide_dashboardq.md.23258ad5.lean.js
rename to assets/en_US_guide_dashboardq.md.1d2992f0.lean.js
index 27864936..77470805 100644
--- a/assets/en_US_guide_dashboardq.md.23258ad5.lean.js
+++ b/assets/en_US_guide_dashboardq.md.1d2992f0.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as s,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1715640788000}'),t={name:"en_US/guide/dashboardq.md"},n=o("",22),r=[n];function i(l,p,d,c,h,u){return a(),s("div",null,r)}const f=e(t,[["render",i]]);export{y as __pageData,f as default};
+import{_ as e,o as a,c as s,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1715651890000}'),t={name:"en_US/guide/dashboardq.md"},n=o("",22),r=[n];function i(l,p,d,c,h,u){return a(),s("div",null,r)}const f=e(t,[["render",i]]);export{y as __pageData,f as default};
diff --git a/assets/en_US_guide_loginq.md.96aba06c.js b/assets/en_US_guide_loginq.md.da359af2.js
similarity index 97%
rename from assets/en_US_guide_loginq.md.96aba06c.js
rename to assets/en_US_guide_loginq.md.da359af2.js
index c65f9a09..b7a41e8a 100644
--- a/assets/en_US_guide_loginq.md.96aba06c.js
+++ b/assets/en_US_guide_loginq.md.da359af2.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1715640788000}'),i={name:"en_US/guide/loginq.md"},r=a('
Stuck Page/Connection Refused/Long Response Time After Login Callback ​
These issues can manifest in various ways, but ultimately the browser cannot display correctly after login.
  1. Your server cannot connect to Github/Gitee, which is most common when configuring Github on servers in mainland China. You may try several times or switch to Cloudflare Access.
  2. You have configured the callback address incorrectly. Ensure that your callback address is correct and that both the port and protocol are accurate!
  3. An unknown error occurred on the Dashboard. You can use a script to check the logs.
TIP
What is a protocol? In the browser, the string that ends your domain with :// is the protocol, usually http or https. Since there may be multiple protocol+domain+port combinations available for accessing the Dashboard in a normal deployment, make sure to choose the most appropriate one as the callback.
How to Check if My Callback Address is Wrong? ​
Ensure that the protocol+domain+port displayed in the browser before login and after the callback are consistent.
 Ensure that your path is /oauth2/callback, all in lowercase.
Errors After Logging into the Admin Panel ​
  1. Clear cookies and log in again, or try a different browser.
  2. Check the callback address to ensure it is correct and that both the port and protocol are accurate! The address initiating the request must be in the same domain as the callback address, with the port, protocol, and domain (or IP) all matching.
lookup xxx ​
The container DNS resolution failed, usually due to modified iptables configurations.
 It is recommended to restart Docker first, sudo systemctl restart docker, then restart the Dashboard using the script.
 If the lookup error persists, check if there are other tools controlling iptables, such as firewall.
 This issue might also be related to the kernel, so try switching to the official kernel.
Invalid authorization method, or the login callback address is invalid, expired, or has been revoked ​
This issue appears only when using Gitee login, and the reason is unclear. Switching to GitHub is recommended.
oauth2: server response missing access_token ​
This could be caused by various factors, most likely a network issue. Check your network and try again.
 If unresolved, switching to Github or another method is recommended.
The user is not an admin of this site and cannot log in ​
You logged in with the wrong account or configured the wrong username. Note that the username is not an email, and you can use a script to modify it.
 For Cloudflare Access users, note that your username is not an email but a User ID.
dial tcp xxx:443 i/o timeout ​
This is a network issue. Try restarting Docker first, sudo systemctl restart docker, then restart the Dashboard using the script.
 If you are configuring Github login on a server in mainland China, switching to Cloudflare Access is recommended to avoid network interference.
net/http: TLS handshake timeout ​
Same as above.
',21),n=[r];function s(l,c,h,d,u,p){return o(),t("div",null,n)}const b=e(i,[["render",s]]);export{g as __pageData,b as default};
+import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1715651890000}'),i={name:"en_US/guide/loginq.md"},r=a('
Stuck Page/Connection Refused/Long Response Time After Login Callback ​
These issues can manifest in various ways, but ultimately the browser cannot display correctly after login.
  1. Your server cannot connect to Github/Gitee, which is most common when configuring Github on servers in mainland China. You may try several times or switch to Cloudflare Access.
  2. You have configured the callback address incorrectly. Ensure that your callback address is correct and that both the port and protocol are accurate!
  3. An unknown error occurred on the Dashboard. You can use a script to check the logs.
TIP
What is a protocol? In the browser, the string that ends your domain with :// is the protocol, usually http or https. Since there may be multiple protocol+domain+port combinations available for accessing the Dashboard in a normal deployment, make sure to choose the most appropriate one as the callback.
How to Check if My Callback Address is Wrong? ​
Ensure that the protocol+domain+port displayed in the browser before login and after the callback are consistent.
 Ensure that your path is /oauth2/callback, all in lowercase.
Errors After Logging into the Admin Panel ​
  1. Clear cookies and log in again, or try a different browser.
  2. Check the callback address to ensure it is correct and that both the port and protocol are accurate! The address initiating the request must be in the same domain as the callback address, with the port, protocol, and domain (or IP) all matching.
lookup xxx ​
The container DNS resolution failed, usually due to modified iptables configurations.
 It is recommended to restart Docker first, sudo systemctl restart docker, then restart the Dashboard using the script.
 If the lookup error persists, check if there are other tools controlling iptables, such as firewall.
 This issue might also be related to the kernel, so try switching to the official kernel.
Invalid authorization method, or the login callback address is invalid, expired, or has been revoked ​
This issue appears only when using Gitee login, and the reason is unclear. Switching to GitHub is recommended.
oauth2: server response missing access_token ​
This could be caused by various factors, most likely a network issue. Check your network and try again.
 If unresolved, switching to Github or another method is recommended.
The user is not an admin of this site and cannot log in ​
You logged in with the wrong account or configured the wrong username. Note that the username is not an email, and you can use a script to modify it.
 For Cloudflare Access users, note that your username is not an email but a User ID.
dial tcp xxx:443 i/o timeout ​
This is a network issue. Try restarting Docker first, sudo systemctl restart docker, then restart the Dashboard using the script.
 If you are configuring Github login on a server in mainland China, switching to Cloudflare Access is recommended to avoid network interference.
net/http: TLS handshake timeout ​
Same as above.
',21),n=[r];function s(l,c,h,d,u,p){return o(),t("div",null,n)}const b=e(i,[["render",s]]);export{g as __pageData,b as default};
diff --git a/assets/en_US_guide_loginq.md.96aba06c.lean.js b/assets/en_US_guide_loginq.md.da359af2.lean.js
similarity index 70%
rename from assets/en_US_guide_loginq.md.96aba06c.lean.js
rename to assets/en_US_guide_loginq.md.da359af2.lean.js
index 9f0fa787..70c97fbc 100644
--- a/assets/en_US_guide_loginq.md.96aba06c.lean.js
+++ b/assets/en_US_guide_loginq.md.da359af2.lean.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1715640788000}'),i={name:"en_US/guide/loginq.md"},r=a("",21),n=[r];function s(l,c,h,d,u,p){return o(),t("div",null,n)}const b=e(i,[["render",s]]);export{g as __pageData,b as default};
+import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1715651890000}'),i={name:"en_US/guide/loginq.md"},r=a("",21),n=[r];function s(l,c,h,d,u,p){return o(),t("div",null,n)}const b=e(i,[["render",s]]);export{g as __pageData,b as default};
diff --git a/assets/en_US_guide_notifications.md.87bdae76.js b/assets/en_US_guide_notifications.md.da167b63.js
similarity index 99%
rename from assets/en_US_guide_notifications.md.87bdae76.js
rename to assets/en_US_guide_notifications.md.da167b63.js
index 0cb6dcb3..fac22922 100644
--- a/assets/en_US_guide_notifications.md.87bdae76.js
+++ b/assets/en_US_guide_notifications.md.da167b63.js
@@ -1,4 +1,4 @@
-import{_ as o,o as s,c as e,R as t}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1715640788000}'),n={name:"en_US/guide/notifications.md"},a=t(`
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 ​
In panel messages, the placeholder #DATETIME# represents the timestamp of when an event occurs. When the notification is triggered, the panel automatically replaces #DATETIME# with the actual time of the event.
#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/case/index.html b/en_US/case/index.html
index fe8a642d..80c964af 100644
--- a/en_US/case/index.html
+++ b/en_US/case/index.html
@@ -10,7 +10,7 @@
     
   
   
-  
+  
   
   
   
@@ -18,8 +18,8 @@
   
   
     
Nezha Monitoring
English
简体中文
English
简体中文
Appearance
Nezha Monitoring
Community Project
Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.
Learn More →
Submit a project
We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information.
Important Notes
All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc.

-    
+    
     
   
 
\ No newline at end of file
diff --git a/en_US/developer/index.html b/en_US/developer/index.html
index 2efecef8..6da855a8 100644
--- a/en_US/developer/index.html
+++ b/en_US/developer/index.html
@@ -10,7 +10,7 @@
     
   
   
-  
+  
   
   
   
@@ -18,8 +18,8 @@
   
   
     
-    
+    
     
   
 
\ No newline at end of file
diff --git a/en_US/developer/l10n.html b/en_US/developer/l10n.html
index 8913863b..a06af0ba 100644
--- a/en_US/developer/l10n.html
+++ b/en_US/developer/l10n.html
@@ -10,16 +10,16 @@
     
   
   
-  
+  
   
   
   
   
   
   
-    
Nezha Monitoring
English
简体中文
English
简体中文
Appearance
On this page
Nezha Monitoring's Dashboard has added localization to support multiple languages, and you can follow these steps to support localization when developing new features
Introduction ​
  1. You can directly use the text configuration already available in /resource/l10n/en-US.toml to replace the text in the new feature.
  2. If there is new text in the new feature, please refer to the configuration text in en-US.toml, pull the new text into the configuration files of other languages such as en-US.toml, and add translations.
Adding a new localized text file ​
  1. Add a new language text configuration in /resource/l10n/.
  2. Pull existing text configurations from other languages in the new language text configuration.
  3. Add translations for the new language text configuration.

-    
+    
Nezha Monitoring
English
简体中文
English
简体中文
Appearance
On this page
Nezha Monitoring's Dashboard has added localization to support multiple languages, and you can follow these steps to support localization when developing new features
Introduction ​
  1. You can directly use the text configuration already available in /resource/l10n/en-US.toml to replace the text in the new feature.
  2. If there is new text in the new feature, please refer to the configuration text in en-US.toml, pull the new text into the configuration files of other languages such as en-US.toml, and add translations.
Adding a new localized text file ​
  1. Add a new language text configuration in /resource/l10n/.
  2. Pull existing text configurations from other languages in the new language text configuration.
  3. Add translations for the new language text configuration.

+    
     
   
 
\ No newline at end of file
diff --git a/en_US/developer/theme.html b/en_US/developer/theme.html
index 482235ee..61729050 100644
--- a/en_US/developer/theme.html
+++ b/en_US/developer/theme.html
@@ -10,16 +10,16 @@
     
   
   
-  
+  
   
   
   
   
   
   
-    
Nezha Monitoring
English
简体中文
English
简体中文
Appearance
On this page
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.

-    
+    
Nezha Monitoring
English
简体中文
English
简体中文
Appearance
On this page
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.

+    
     
   
 
\ No newline at end of file
diff --git a/en_US/guide/agent.html b/en_US/guide/agent.html
index d05afc37..129173ee 100644
--- a/en_US/guide/agent.html
+++ b/en_US/guide/agent.html
@@ -10,7 +10,7 @@
     
   
   
-  
+  
   
   
   
@@ -155,9 +155,9 @@
  stop
  sleep 2
  start
-}
FAQ ​
Is there a Docker image for Agent? ​
There is currently no Docker image for Agent.
 The Agent is designed to be the opposite of the Dashboard, in that the Dashboard is designed to work without affecting the server as much as possible, while the Agent needs to execute monitoring services and run commands in the server.
 Putting the Agent in a container does continue to execute monitoring services, but features such as WebShell do not work, so we do not provide Docker image of the Agent.
- +}

FAQ ​

Is there a Docker image for Agent? ​

There is currently no Docker image for Agent.
The Agent is designed to be the opposite of the Dashboard, in that the Dashboard is designed to work without affecting the server as much as possible, while the Agent needs to execute monitoring services and run commands in the server.
Putting the Agent in a container does continue to execute monitoring services, but features such as WebShell do not work, so we do not provide Docker image of the Agent.

+ \ No newline at end of file diff --git a/en_US/guide/agentq.html b/en_US/guide/agentq.html index e60bf384..3f516070 100644 --- a/en_US/guide/agentq.html +++ b/en_US/guide/agentq.html @@ -10,16 +10,16 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

The IP Displayed in the Admin Panel is Different from the Actual Agent IP? ​

Please refer to Dashboard Related - Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?. This will not be repeated here.

Errors During One-Click Script Installation ​

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

This mostly occurs on servers in mainland China. Currently, the one-click script fetches the installation script directly from Github. You may try several times, or manually install the Agent. Additionally, you can find third-party Github acceleration services or mirrors and set them in the one-click installation script.

sudo: command not found ​

Please manually install sudo first, for example, in Ubuntu:

shell
apt install sudo
- +
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

The IP Displayed in the Admin Panel is Different from the Actual Agent IP? ​

Please refer to Dashboard Related - Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?. This will not be repeated here.

Errors During One-Click Script Installation ​

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

This mostly occurs on servers in mainland China. Currently, the one-click script fetches the installation script directly from Github. You may try several times, or manually install the Agent. Additionally, you can find third-party Github acceleration services or mirrors and set them in the one-click installation script.

sudo: command not found ​

Please manually install sudo first, for example, in Ubuntu:

shell
apt install sudo
+ \ No newline at end of file diff --git a/en_US/guide/api.html b/en_US/guide/api.html index e8754906..a1c4f0db 100644 --- a/en_US/guide/api.html +++ b/en_US/guide/api.html @@ -10,125 +10,153 @@ - + -
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

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",
-    "result": [
-        {
-            "id": 1,
-            "name": "Server1",
-            "tag": "Tag1",
-            "last_active": 1653014667,
-            "ipv4": "1.1.1.1",
-            "ipv6": "",
-            "valid_ip": "1.1.1.1"
-        },
-        {
-            "id": 2,
-            "name": "Server2",
-            "tag": "Tag2",
-            "last_active": -62135596800,
-            "ipv4": "",
-            "ipv6": "",
-            "valid_ip": ""
-        }
-    ]
-}
  • Get server details: GET /api/v1/server/details?id=&tag=
    query: id (ServerID. Multiple IDs are separated by commas, provide this value to query the server corresponding to the ID, while ignoring the tag value)
    query: tag (ServerTag, if this value is provided, only the servers in this group are queried)

JSON Return Example:

{
-    "code": 0,
-    "message": "success",
-    "result": [
-        {
-            "id": 1,
-            "name": "Server1",
-            "tag": "Tag1",
-            "last_active": 1653015042,
-            "ipv4": "1.1.1.1",
-            "ipv6": "",
-            "valid_ip": "1.1.1.1",
-            "host": {
-                "Platform": "darwin",
-                "PlatformVersion": "12.3.1",
-                "CPU": [
-                    "Apple M1 Pro 1 Physical Core"
-                ],
-                "MemTotal": 17179869184,
-                "DiskTotal": 2473496842240,
-                "SwapTotal": 0,
-                "Arch": "arm64",
-                "Virtualization": "",
-                "BootTime": 1652683962,
-                "CountryCode": "hk",
-                "Version": ""
-            },
-            "status": {
-                "CPU": 17.330210772540017,
-                "MemUsed": 14013841408,
-                "SwapUsed": 0,
-                "DiskUsed": 2335048912896,
-                "NetInTransfer": 2710273234,
-                "NetOutTransfer": 695454765,
-                "NetInSpeed": 10806,
-                "NetOutSpeed": 5303,
-                "Uptime": 331080,
-                "Load1": 5.23486328125,
-                "Load5": 4.873046875,
-                "Load15": 3.99267578125,
-                "TcpConnCount": 195,
-                "UdpConnCount": 70,
-                "ProcessCount": 437
-            }
-        },
-        {
-            "id": 2,
-            "name": "Server2",
-            "tag": "Tag2",
-            "last_active": -62135596800,
-            "ipv4": "",
-            "ipv6": "",
-            "valid_ip": "",
-            "host": {
-                "Platform": "",
-                "PlatformVersion": "",
-                "CPU": null,
-                "MemTotal": 0,
-                "DiskTotal": 0,
-                "SwapTotal": 0,
-                "Arch": "",
-                "Virtualization": "",
-                "BootTime": 0,
-                "CountryCode": "",
-                "Version": ""
-            },
-            "status": {
-                "CPU": 0,
-                "MemUsed": 0,
-                "SwapUsed": 0,
-                "DiskUsed": 0,
-                "NetInTransfer": 0,
-                "NetOutTransfer": 0,
-                "NetInSpeed": 0,
-                "NetOutSpeed": 0,
-                "Uptime": 0,
-                "Load1": 0,
-                "Load5": 0,
-                "Load15": 0,
-                "TcpConnCount": 0,
-                "UdpConnCount": 0,
-                "ProcessCount": 0
-            }
-        }
-    ]
-}
- +
Nezha Monitoring

English

简体中文

English

简体中文

Appearance

On this page

Nezha Monitoring supports querying the status information of Agents using the API interface

Creating a Token ​

Nezha Monitoring's API interface allows for Token authentication and Cookies authentication. To create a new Token, go to the admin panel, click on the avatar in the top right corner, select "API Token," and enter the Token management page. Click "Add Token", add a custom note, and click "Add".

To delete a Token, select the corresponding Token and click the delete icon on the right.

WARNING

Tokens are the authentication credentials for the API interface. They are critical to the security of your Dashboard's information, so do not share your Token with others.

Authentication Method ​

Ensure the request header contains Authorization: Token for authentication.

Token authentication method:

Request Headers:
+Authorization: Token

Usage Instructions ​

WARNING

Negative timestamps in the following examples represent 0000-00-00. This currently indicates that the Agent has never reported since the Dashboard went online, but it is not recommended to use the positive or negative value to determine the status.

TIP

The request method is GET, and the response format is JSON.

Get Server List ​

Request:

GET /api/v1/server/list?tag=

Parameters:

  • tag (optional): ServerTag is the server group. Provide this parameter to query only servers in that group.

Example response:

json
{
+    "code": 0,
+    "message": "success",
+    "result": [
+        {
+            "id": 1,
+            "name": "Server1",
+            "tag": "Tag1",
+            "last_active": 1653014667,
+            "ipv4": "1.1.1.1",
+            "ipv6": "",
+            "valid_ip": "1.1.1.1"
+        },
+        {
+            "id": 2,
+            "name": "Server2",
+            "tag": "Tag2",
+            "last_active": -62135596800,
+            "ipv4": "",
+            "ipv6": "",
+            "valid_ip": ""
+        }
+    ]
+}

Get Server Details ​

Request:

GET /api/v1/server/details?id=&tag=

Parameters:

  • id (optional): ServerID, multiple IDs separated by commas. Provide this parameter to query the server corresponding to that ID and ignore the tag parameter.
  • tag (optional): ServerTag, provide this parameter to query only servers in that group.

Example response:

json
{
+    "code": 0,
+    "message": "success",
+    "result": [
+        {
+            "id": 1,
+            "name": "Server1",
+            "tag": "Tag1",
+            "last_active": 1653015042,
+            "ipv4": "1.1.1.1",
+            "ipv6": "",
+            "valid_ip": "1.1.1.1",
+            "host": {
+                "Platform": "darwin",
+                "PlatformVersion": "12.3.1",
+                "CPU": [
+                    "Apple M1 Pro 1 Physical Core"
+                ],
+                "MemTotal": 17179869184,
+                "DiskTotal": 2473496842240,
+                "SwapTotal": 0,
+                "Arch": "arm64",
+                "Virtualization": "",
+                "BootTime": 1652683962,
+                "CountryCode": "hk",
+                "Version": ""
+            },
+            "status": {
+                "CPU": 17.33,
+                "MemUsed": 14013841408,
+                "SwapUsed": 0,
+                "DiskUsed": 2335048912896,
+                "NetInTransfer": 2710273234,
+                "NetOutTransfer": 695454765,
+                "NetInSpeed": 10806,
+                "NetOutSpeed": 5303,
+                "Uptime": 331080,
+                "Load1": 5.23,
+                "Load5": 4.87,
+                "Load15": 3.99,
+                "TcpConnCount": 195,
+                "UdpConnCount": 70,
+                "ProcessCount": 437
+            }
+        },
+        {
+            "id": 2,
+            "name": "Server2",
+            "tag": "Tag2",
+            "last_active": -62135596800,
+            "ipv4": "",
+            "ipv6": "",
+            "valid_ip": "",
+            "host": {
+                "Platform": "",
+                "PlatformVersion": "",
+                "CPU": null,
+                "MemTotal": 0,
+                "DiskTotal": 0,
+                "SwapTotal": 0,
+                "Arch": "",
+                "Virtualization": "",
+                "BootTime": 0,
+                "CountryCode": "",
+                "Version": ""
+            },
+            "status": {
+                "CPU": 0,
+                "MemUsed": 0,
+                "SwapUsed": 0,
+                "DiskUsed": 0,
+                "NetInTransfer": 0,
+                "NetOutTransfer": 0,
+                "NetInSpeed": 0,
+                "NetOutSpeed": 0,
+                "Uptime": 0,
+                "Load1": 0,
+                "Load5": 0,
+                "Load15": 0,
+                "TcpConnCount": 0,
+                "UdpConnCount": 0,
+                "ProcessCount": 0
+            }
+        }
+    ]
+}

Usage Examples ​

Get All Server Information ​

python
import requests
+
+url = "http://your-dashboard/api/v1/server/list"
+headers = {
+    "Authorization": "your_token"
+}
+
+response = requests.get(url, headers=headers)
+data = response.json()
+
+for server in data['result']:
+    print(f"Server Name: {server['name']}, Last Active: {server['last_active']}, IP: {server['valid_ip']}")

Get Specific Server Details ​

python
import requests
+
+server_id = 1  # Replace with your server ID
+url = f"http://your-dashboard/api/v1/server/details?id={server_id}"
+headers = {
+    "Authorization": "your_token"
+}
+
+response = requests.get(url, headers=headers)
+data = response.json()
+
+server = data['result'][0]
+print(f"Server Name: {server['name']}")
+print(f"CPU Usage: {server['status']['CPU']}%")
+print(f"Memory Used: {server['status']['MemUsed']} bytes")
+print(f"Disk Used: {server['status']['DiskUsed']} bytes")
+print(f"Network In Speed: {server['status']['NetInSpeed']} bytes/s")
+print(f"Network Out Speed: {server['status']['NetOutSpeed']} bytes/s")

With the above example code, you can easily obtain and process server status information, enabling automated monitoring and management.

+ \ No newline at end of file diff --git a/en_US/guide/dashboard.html b/en_US/guide/dashboard.html index 3f6ddc03..bcf86253 100644 --- a/en_US/guide/dashboard.html +++ b/en_US/guide/dashboard.html @@ -10,7 +10,7 @@ - + @@ -37,9 +37,9 @@ proxy /terminal/* http://ip:8008 { websocket header_upstream -Origin -}

Configuring SSL in the aaPanel ​

First, temporarily disable the reverse proxy
As with other websites, you can choose to automatically apply for a Let´s Encrypt certificate or manually configure an existing certificate by going to "SSL" in the site settings
After you finish setting up SSL, you need to go back to https://github.com/settings/developers and edit the authentication application you created before, change all the domain names in the "Homepage URL" and "Authorization callback URL" you filled in before from http to https, such as: "https://cdn.example.com" and "https://cdn.example.com/oauth2/callback", If you don't change these links, you may not be able to log into the admin panel

FAQ ​

What should I do if /terminal or /ws cannot be connected after HTTPS is enabled? ​

It is often caused by incomplete certificates. Please add -d to the agent running parameters. If there is x509: certificate signed by unknown authority in the log, replacing the complete certificate can solve the problem 100%.

I am not satisfied with the data modification or addition function provided by the Dashboard, what if I want to modify or add data myself? ​

Commonly used in requirements such as batch installation of Agents, where you can modify the database directly.
Please note that not everything can be modified in the database, wrong modification will lead to data confusion and failure to start Dashboard, please do not modify the database at will!

DANGER

Again, please do not modify the database at will!

If you need to modify the data in the database, please stop the Dashboard container before modifying it.
The database type is sqlite3, located in /opt/nezha/dashboard/data/sqlite.db, please backup before modifying the data

What are each table or column in the database? ​

The documentation does not provide an explanation of the database. If you have the ability to modify the database, you should be able to read it with a little thinking.

Does Dashboard update automatically? ​

The Agent normally updates automatically, but the Dashboard does not and needs to be updated manually.

How do I update the Dashboard? ​

Run the script . /nezha.sh and select restart Dashboard and update

- +}

Configuring SSL in the aaPanel ​

First, temporarily disable the reverse proxy
As with other websites, you can choose to automatically apply for a Let´s Encrypt certificate or manually configure an existing certificate by going to "SSL" in the site settings
After you finish setting up SSL, you need to go back to https://github.com/settings/developers and edit the authentication application you created before, change all the domain names in the "Homepage URL" and "Authorization callback URL" you filled in before from http to https, such as: "https://cdn.example.com" and "https://cdn.example.com/oauth2/callback", If you don't change these links, you may not be able to log into the admin panel

FAQ ​

What should I do if /terminal or /ws cannot be connected after HTTPS is enabled? ​

It is often caused by incomplete certificates. Please add -d to the agent running parameters. If there is x509: certificate signed by unknown authority in the log, replacing the complete certificate can solve the problem 100%.

I am not satisfied with the data modification or addition function provided by the Dashboard, what if I want to modify or add data myself? ​

Commonly used in requirements such as batch installation of Agents, where you can modify the database directly.
Please note that not everything can be modified in the database, wrong modification will lead to data confusion and failure to start Dashboard, please do not modify the database at will!

DANGER

Again, please do not modify the database at will!

If you need to modify the data in the database, please stop the Dashboard container before modifying it.
The database type is sqlite3, located in /opt/nezha/dashboard/data/sqlite.db, please backup before modifying the data

What are each table or column in the database? ​

The documentation does not provide an explanation of the database. If you have the ability to modify the database, you should be able to read it with a little thinking.

Does Dashboard update automatically? ​

The Agent normally updates automatically, but the Dashboard does not and needs to be updated manually.

How do I update the Dashboard? ​

Run the script . /nezha.sh and select restart Dashboard and update

+ \ No newline at end of file diff --git a/en_US/guide/dashboardq.html b/en_US/guide/dashboardq.html index 7be3d988..3278fa0d 100644 --- a/en_US/guide/dashboardq.html +++ b/en_US/guide/dashboardq.html @@ -10,7 +10,7 @@ - + @@ -26,9 +26,9 @@ expires 12h; error_log /dev/null; access_log /dev/null; - }

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

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

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

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

    The entered DDNS AccessID or AccessSecret is incorrect.

    Network Monitoring Page Shows: server monitor history not found ​

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

    - + }

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

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

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

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

    The entered DDNS AccessID or AccessSecret is incorrect.

    Network Monitoring Page Shows: server monitor history not found ​

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

    + \ No newline at end of file diff --git a/en_US/guide/loginq.html b/en_US/guide/loginq.html index 73c61489..f263ae29 100644 --- a/en_US/guide/loginq.html +++ b/en_US/guide/loginq.html @@ -10,16 +10,16 @@ - + -
    Nezha Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    On this page

    Stuck Page/Connection Refused/Long Response Time After Login Callback ​

    These issues can manifest in various ways, but ultimately the browser cannot display correctly after login.

    1. Your server cannot connect to Github/Gitee, which is most common when configuring Github on servers in mainland China. You may try several times or switch to Cloudflare Access.
    2. You have configured the callback address incorrectly. Ensure that your callback address is correct and that both the port and protocol are accurate!
    3. An unknown error occurred on the Dashboard. You can use a script to check the logs.

    TIP

    What is a protocol? In the browser, the string that ends your domain with :// is the protocol, usually http or https. Since there may be multiple protocol+domain+port combinations available for accessing the Dashboard in a normal deployment, make sure to choose the most appropriate one as the callback.

    How to Check if My Callback Address is Wrong? ​

    Ensure that the protocol+domain+port displayed in the browser before login and after the callback are consistent.
    Ensure that your path is /oauth2/callback, all in lowercase.

    Errors After Logging into the Admin Panel ​

    1. Clear cookies and log in again, or try a different browser.
    2. Check the callback address to ensure it is correct and that both the port and protocol are accurate! The address initiating the request must be in the same domain as the callback address, with the port, protocol, and domain (or IP) all matching.

    lookup xxx ​

    The container DNS resolution failed, usually due to modified iptables configurations.
    It is recommended to restart Docker first, sudo systemctl restart docker, then restart the Dashboard using the script.
    If the lookup error persists, check if there are other tools controlling iptables, such as firewall.
    This issue might also be related to the kernel, so try switching to the official kernel.

    Invalid authorization method, or the login callback address is invalid, expired, or has been revoked ​

    This issue appears only when using Gitee login, and the reason is unclear. Switching to GitHub is recommended.

    oauth2: server response missing access_token ​

    This could be caused by various factors, most likely a network issue. Check your network and try again.
    If unresolved, switching to Github or another method is recommended.

    The user is not an admin of this site and cannot log in ​

    You logged in with the wrong account or configured the wrong username. Note that the username is not an email, and you can use a script to modify it.
    For Cloudflare Access users, note that your username is not an email but a User ID.

    dial tcp xxx:443 i/o timeout ​

    This is a network issue. Try restarting Docker first, sudo systemctl restart docker, then restart the Dashboard using the script.
    If you are configuring Github login on a server in mainland China, switching to Cloudflare Access is recommended to avoid network interference.

    net/http: TLS handshake timeout ​

    Same as above.

    - +
    Nezha Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    On this page

    Stuck Page/Connection Refused/Long Response Time After Login Callback ​

    These issues can manifest in various ways, but ultimately the browser cannot display correctly after login.

    1. Your server cannot connect to Github/Gitee, which is most common when configuring Github on servers in mainland China. You may try several times or switch to Cloudflare Access.
    2. You have configured the callback address incorrectly. Ensure that your callback address is correct and that both the port and protocol are accurate!
    3. An unknown error occurred on the Dashboard. You can use a script to check the logs.

    TIP

    What is a protocol? In the browser, the string that ends your domain with :// is the protocol, usually http or https. Since there may be multiple protocol+domain+port combinations available for accessing the Dashboard in a normal deployment, make sure to choose the most appropriate one as the callback.

    How to Check if My Callback Address is Wrong? ​

    Ensure that the protocol+domain+port displayed in the browser before login and after the callback are consistent.
    Ensure that your path is /oauth2/callback, all in lowercase.

    Errors After Logging into the Admin Panel ​

    1. Clear cookies and log in again, or try a different browser.
    2. Check the callback address to ensure it is correct and that both the port and protocol are accurate! The address initiating the request must be in the same domain as the callback address, with the port, protocol, and domain (or IP) all matching.

    lookup xxx ​

    The container DNS resolution failed, usually due to modified iptables configurations.
    It is recommended to restart Docker first, sudo systemctl restart docker, then restart the Dashboard using the script.
    If the lookup error persists, check if there are other tools controlling iptables, such as firewall.
    This issue might also be related to the kernel, so try switching to the official kernel.

    Invalid authorization method, or the login callback address is invalid, expired, or has been revoked ​

    This issue appears only when using Gitee login, and the reason is unclear. Switching to GitHub is recommended.

    oauth2: server response missing access_token ​

    This could be caused by various factors, most likely a network issue. Check your network and try again.
    If unresolved, switching to Github or another method is recommended.

    The user is not an admin of this site and cannot log in ​

    You logged in with the wrong account or configured the wrong username. Note that the username is not an email, and you can use a script to modify it.
    For Cloudflare Access users, note that your username is not an email but a User ID.

    dial tcp xxx:443 i/o timeout ​

    This is a network issue. Try restarting Docker first, sudo systemctl restart docker, then restart the Dashboard using the script.
    If you are configuring Github login on a server in mainland China, switching to Cloudflare Access is recommended to avoid network interference.

    net/http: TLS handshake timeout ​

    Same as above.

    + \ No newline at end of file diff --git a/en_US/guide/notifications.html b/en_US/guide/notifications.html index b45c6651..63b618d9 100644 --- a/en_US/guide/notifications.html +++ b/en_US/guide/notifications.html @@ -10,7 +10,7 @@ - + @@ -56,9 +56,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 ​

    Complete examples:

    Add an offline notification

    Add an notification when the CPU exceeds 50% for 10s but the memory usage is below 20% for 20s

    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:

    Rule II:

    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

    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 ​

    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

    - +}

    Delete relevant content information as needed

    Notice Picture



    Description of notification rules ​

    Basic Rules ​

    Complete examples:

    Add an offline notification

    Add an notification when the CPU exceeds 50% for 10s but the memory usage is below 20% for 20s

    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:

    Rule II:

    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

    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 ​

    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

    + \ No newline at end of file diff --git a/en_US/guide/q2.html b/en_US/guide/q2.html index d5214d4b..890bb0ee 100644 --- a/en_US/guide/q2.html +++ b/en_US/guide/q2.html @@ -10,16 +10,16 @@ - + -
    Nezha Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    On this page

    Agent Startup/Online Troubleshooting Process ​

    1. Directly execute /opt/nezha/agent/nezha-agent -s DashboardIP or non-CDN domain:RPCPort -p AgentKey -d to check if the logs indicate timeouts due to DNS or poor network conditions.
    2. Use nc -v Domain/IP RPCPort or telnet Domain/IP RPCPort to check for network issues, inspect the inbound and outbound firewalls of the local machine and the panel server. If you cannot determine the issue, you can use the port checking tool provided by https://port.ping.pe/.
    3. If the above steps indicate no issues but the Agent still does not go online correctly, try disabling SELinux. How to disable SELinux?
    - +
    Nezha Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    On this page

    Agent Startup/Online Troubleshooting Process ​

    1. Directly execute /opt/nezha/agent/nezha-agent -s DashboardIP or non-CDN domain:RPCPort -p AgentKey -d to check if the logs indicate timeouts due to DNS or poor network conditions.
    2. Use nc -v Domain/IP RPCPort or telnet Domain/IP RPCPort to check for network issues, inspect the inbound and outbound firewalls of the local machine and the panel server. If you cannot determine the issue, you can use the port checking tool provided by https://port.ping.pe/.
    3. If the above steps indicate no issues but the Agent still does not go online correctly, try disabling SELinux. How to disable SELinux?
    + \ No newline at end of file diff --git a/en_US/guide/q3.html b/en_US/guide/q3.html index c20605ad..fd83732e 100644 --- a/en_US/guide/q3.html +++ b/en_US/guide/q3.html @@ -10,7 +10,7 @@ - + @@ -90,9 +90,9 @@ localhost:~/agent# /opt/nezha/agent/nezha-agent -s nezha.xxx.xxx:443 -p YOUR_KEY --tls -d NEZHA@2023-12-20 05:14:00>> 检查更新： 0.15.14 NEZHA@2023-12-20 05:14:01>> 上报系统信息失败： rpc error: code = Unknown desc = EOF # You need to modify the GRPCHost and TLS options in the Dashboard /opt/nezha/dashboard/data/config.yaml -NEZHA@2023-12-20 05:14:01>> Error to close connection ... - +NEZHA@2023-12-20 05:14:01>> Error to close connection ... + \ No newline at end of file diff --git a/en_US/guide/q4.html b/en_US/guide/q4.html index 39ab37f3..5b4df069 100644 --- a/en_US/guide/q4.html +++ b/en_US/guide/q4.html @@ -10,16 +10,16 @@ - + -
    Nezha Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    On this page

    Real-Time Channel Disconnection/Online Terminal Connection Failure ​

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

    English

    简体中文

    English

    简体中文

    Appearance

    On this page

    Real-Time Channel Disconnection/Online Terminal Connection Failure ​

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

    English

    简体中文

    English

    简体中文

    Appearance

    On this page

    How to Perform Data Migration and Backup Recovery? ​

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

    English

    简体中文

    English

    简体中文

    Appearance

    On this page

    How to Perform Data Migration and Backup Recovery? ​

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

    English

    简体中文

    English

    简体中文

    Appearance

    On this page

    How to Reset Traffic Statistics Monthly? ​

    The traffic statistics on the homepage reset every time the server restarts. To achieve a monthly reset of the traffic counter, you can do the following:

    1. Go to the Notification page in the management panel.
    2. Refer to this document to create a monthly traffic notification.
    3. Return to the homepage and go to the Services page, where you can see the monthly traffic statistics. The statistics here will not reset when the server restarts.

    TIP

    This method allows you to set any period, including but not limited to hourly, daily, weekly, monthly, or yearly traffic statistics reset, offering great flexibility!

    - +
    Nezha Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    On this page

    How to Reset Traffic Statistics Monthly? ​

    The traffic statistics on the homepage reset every time the server restarts. To achieve a monthly reset of the traffic counter, you can do the following:

    1. Go to the Notification page in the management panel.
    2. Refer to this document to create a monthly traffic notification.
    3. Return to the homepage and go to the Services page, where you can see the monthly traffic statistics. The statistics here will not reset when the server restarts.

    TIP

    This method allows you to set any period, including but not limited to hourly, daily, weekly, monthly, or yearly traffic statistics reset, offering great flexibility!

    + \ No newline at end of file diff --git a/en_US/guide/q7.html b/en_US/guide/q7.html index b56556a4..9af0965e 100644 --- a/en_US/guide/q7.html +++ b/en_US/guide/q7.html @@ -10,16 +10,16 @@ - + -
    Nezha Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    On this page

    Custom Agent Monitoring Projects ​

    Customizing Monitored Network Interfaces and Disk Partitions ​

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

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

    Other Runtime Parameters ​

    To view the supported parameters, execute:

    bash
    ./nezha-agent --help

    If you installed the Agent using the one-click script, you can edit /etc/systemd/system/nezha-agent.service and add the following parameters at the end of the ExecStart= line:

    • --report-delay: Controls the interval for reporting system information. The default is 1 second. You can set it to 3 to further reduce the agent's system resource usage (configuration range: 1-4).
    • --skip-conn: Does not monitor connection counts. Recommended for servers with high connection density or high CPU usage.
    • --skip-procs: Does not monitor process counts, which can also reduce Agent resource usage.
    • --disable-auto-update: Disables automatic updates for the Agent (security feature).
    • --disable-force-update: Disables forced updates for the Agent (security feature).
    • --disable-command-execute: Disables the execution of scheduled tasks and the opening of the online terminal on the Agent (security feature).
    • --tls: Enables SSL/TLS encryption (required if you use nginx to reverse proxy the Agent's gRPC connection and nginx has SSL/TLS enabled).
    - +
    Nezha Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    On this page

    Custom Agent Monitoring Projects ​

    Customizing Monitored Network Interfaces and Disk Partitions ​

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

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

    Other Runtime Parameters ​

    To view the supported parameters, execute:

    bash
    ./nezha-agent --help

    If you installed the Agent using the one-click script, you can edit /etc/systemd/system/nezha-agent.service and add the following parameters at the end of the ExecStart= line:

    • --report-delay: Controls the interval for reporting system information. The default is 1 second. You can set it to 3 to further reduce the agent's system resource usage (configuration range: 1-4).
    • --skip-conn: Does not monitor connection counts. Recommended for servers with high connection density or high CPU usage.
    • --skip-procs: Does not monitor process counts, which can also reduce Agent resource usage.
    • --disable-auto-update: Disables automatic updates for the Agent (security feature).
    • --disable-force-update: Disables forced updates for the Agent (security feature).
    • --disable-command-execute: Disables the execution of scheduled tasks and the opening of the online terminal on the Agent (security feature).
    • --tls: Enables SSL/TLS encryption (required if you use nginx to reverse proxy the Agent's gRPC connection and nginx has SSL/TLS enabled).
    + \ No newline at end of file diff --git a/en_US/guide/q8.html b/en_US/guide/q8.html index 33a6d9a1..5782ab21 100644 --- a/en_US/guide/q8.html +++ b/en_US/guide/q8.html @@ -10,7 +10,7 @@ - + @@ -22,9 +22,9 @@ ClientID: 3516291f53eca9b4901a01337e41be7dc52f565c8657d08a3fddb2178d13c5bf ClientSecret: 0568b67c7b6d0ed51c663e2fe935683007c28f947a27b7bd47a5ad3d8b56fb67 Endpoint: "https://xxxxx.cloudflareaccess.com" - Type: cloudflare

    Configuration Description: ​

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

    Creating a SaaS-OIDC Application ​

    Go to Zero Trust Dashboard: https://one.dash.cloudflare.com

    1. My Team -> Users -> <specific user> -> Get User ID and save it;
    2. Access -> Application -> Add an Application;
    3. Select SaaS, enter a custom application name (e.g., nezha) in Application, select OIDC, and click Add application;
    4. In Scopes, select openid, email, profile, groups;
    5. Fill in your CallBack URL in Redirect URLs, such as https://dashboard.example.com/oauth2/callback;
    6. Record the Client ID, Client Secret, and the protocol and domain part of the Issuer URL, such as https://xxxxx.cloudflareaccess.com;
    7. Edit the Dashboard configuration file (usually located at /opt/nezha/dashboard/data/config.yaml), modify the Oauth2 configuration according to the example configuration, and restart the Dashboard service.

    Authentication Policy Configuration ​

    After completing the Dashboard setup, you also need to configure the authentication policy in the Zero Trust Dashboard: Access -> Applications -> <application name> -> Policies. You can choose from over ten SSO authentication methods, including email OTP verification, hardware key verification, etc. For detailed configuration, please refer to the Cloudflare Zero Trust documentation.

    - + Type: cloudflare

    Configuration Description: ​

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

    Creating a SaaS-OIDC Application ​

    Go to Zero Trust Dashboard: https://one.dash.cloudflare.com

    1. My Team -> Users -> <specific user> -> Get User ID and save it;
    2. Access -> Application -> Add an Application;
    3. Select SaaS, enter a custom application name (e.g., nezha) in Application, select OIDC, and click Add application;
    4. In Scopes, select openid, email, profile, groups;
    5. Fill in your CallBack URL in Redirect URLs, such as https://dashboard.example.com/oauth2/callback;
    6. Record the Client ID, Client Secret, and the protocol and domain part of the Issuer URL, such as https://xxxxx.cloudflareaccess.com;
    7. Edit the Dashboard configuration file (usually located at /opt/nezha/dashboard/data/config.yaml), modify the Oauth2 configuration according to the example configuration, and restart the Dashboard service.

    Authentication Policy Configuration ​

    After completing the Dashboard setup, you also need to configure the authentication policy in the Zero Trust Dashboard: Access -> Applications -> <application name> -> Policies. You can choose from over ten SSO authentication methods, including email OTP verification, hardware key verification, etc. For detailed configuration, please refer to the Cloudflare Zero Trust documentation.

    + \ No newline at end of file diff --git a/en_US/guide/servers.html b/en_US/guide/servers.html index b40f5fde..682db3c8 100644 --- a/en_US/guide/servers.html +++ b/en_US/guide/servers.html @@ -3,21 +3,21 @@ - Servers | Nezha Monitoring + Server | Nezha Monitoring - + -
    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.

    DDNS ​

    DDNS feature is suitable for servers that have dynamic IP addresses. When a different IP is reported by Agent, Dashboard will update DNS record automatically using configured settings.

    Why choose Nezha's DDNS feature ​

    • Manage your DDNS configuration centrally, without deploying a single service on every server.
    • Save your credentials only on the Dashboard server to prevent data leaks.

    Configuration description ​

    Currently, DDNS supports two types of configurations: Single and Multiple. If Single is chosen, all Agent servers will use the same configuration to update DNS records, whereas selecting Multiple allows each server to use a specified configuration.

    Single ​

    yaml
    DDNS:
+    
    Nezha Monitoring
    English
    简体中文
    English
    简体中文
    Appearance
    On this page
    Server ​
    Introduction ​
    The server section is responsible for managing Agents, forming the most fundamental part of Nezha monitoring and serving as the basis for other functionalities.
    Adding a Server ​
    The first step is to add a server, where you can customize the name, group, sorting, and notes.
     Servers in the same group will be displayed together in supported themes. Notes will only be visible in the Admin Panel, so there's no need to worry about leaking information.
    Installing the Agent ​
    Please refer to the previous section on installing the Agent.
     It is recommended to use the one-click installation. After configuring the parameters, click the corresponding system icon in the one-click installation column of the server to copy the installation command and execute it on the respective server.
    Forced Update ​
    Agent update-related parameters include --disable-auto-update and --disable-force-update as described in Custom Agent Monitoring Projects.
     By default, the Agent will update automatically without intervention. However, if the user disables automatic updates, you can select specific servers for a forced update.
     The forced update will not work if disable-force-update is enabled.
    Data Columns ​
    • Version: Records the current version of the Agent.
    • Hide from Guests: When true, guests cannot see this server in the Dashboard.
    • Enable DDNS: When true, if the server IP changes, the Dashboard will automatically update the DNS records.
    • DDNS Domain: The DDNS domain configured for this server.
    • Secret: The secret/key used for configuring the Agent, which is used to verify communication between the Agent and the Dashboard.
    • One-Click Install: Click the corresponding system button to copy the command and execute it on the server for a one-click installation.
    • Management: Connects to WebShell, modifies server configuration, or deletes the server.
    WebSSH Terminal ​
    This is WebShell; the feature will not work if disable-command-execute is enabled.
     It is available for both Linux and Windows and supports Ctrl+Shift+V for pasting.
     If the connection fails, refer to Real-Time Channel Disconnection/Online Terminal Connection Failure.
     Note that in the WebSSH terminal function, the Agent connects to the public access domain via WebSocket, not through gRPC.
    DDNS Functionality ​
    The DDNS functionality is suitable for servers with dynamic IPs. When the Agent reports a new IP, the Dashboard will automatically update the DNS records based on the configuration.
    Why Use Nezha Monitoring's DDNS Functionality? ​
    • Centralized management of DDNS settings instead of deploying a DDNS service on each server.
    • Confidential information is only stored on the Dashboard server, preventing leakage.
    Configuration Instructions ​
    Currently, the DDNS functionality supports two configuration forms: single configuration and multiple configurations. If single configuration is used, all Agent servers will use the same configuration to update DDNS. If multiple configurations are used, each server can be assigned a specific configuration to update DDNS, offering greater flexibility.
    Single Configuration ​
    yaml
    DDNS:
   Enable: true
   Provider: "webhook"
   AccessID: ""
@@ -27,24 +27,24 @@
   WebhookRequestBody: ""
   WebhookHeaders: ""
   MaxRetries: 3
-  Profiles: null
    Enable ​
    Boolean value indicating whether the DDNS function is enabled.
    Provider ​
    Name of the DDNS provider, currently support webhook, cloudflare and tencentcloud.
    AccessID ​
    Secret ID associated with DDNS provider.
    Only applied to tencentcloud.
    AccessSecret ​
    Secret key associated with DDNS provider.
    Only applied to cloudflare and tencentcloud.
    WebhookMethod ​
    Request method of Webhook. For example, GET and POST.
    Only applied to webhook.
    WebhookURL ​
    Request URL of Webhook.
    Only applied to webhook.
    WebhookRequestBody ​
    Request body of Webhook.
    Only applied to webhook.
    WebhookHeaders ​
    Request headers of Webhook.
    Only applied to webhook.
    MaxRetries ​
    The number of retry attempts after an update request has failed.
    Profiles ​
    Multiple configuration setting. Will be ignored in Single configuration setting.
    TIP
    WebhookURL, WebhookRequestBody and WebhookHeaders can use additional params：
    {ip} - Host IP
    {domain} - DDNS domain
    {type} - Your IP type, possibly "ipv4" or "ipv6"
    {access_id} - Credential #1
    {access_secret} - Credential #2
    Example:
    WebhookHeaders: |
-    a:{access_id}
-    b:{access_secret}
-WebhookRequestBody: '{"domain": "{domain}", "ip": "{ip}", "type": "{type}"}'
    Multiple ​
    Please leave DDNS.Provider field blank while using Multiple configuration. If not, the Multiple configuration will be ignored.
    yaml
    DDNS:
+  Profiles: null
    • Enable: Boolean value to enable or disable the DDNS functionality.
    • Provider: The name of the DDNS provider; currently supports webhook, cloudflare, and tencentcloud.
    • AccessID: Token ID for the DDNS provider; only applicable to the tencentcloud provider.
    • AccessSecret: Token Secret for the DDNS provider; only applicable to the cloudflare and tencentcloud providers.
    • WebhookMethod: The request method for the webhook, such as GET or POST; only applicable to the webhook provider.
    • WebhookURL: The request URL for the webhook; only applicable to the webhook provider.
    • WebhookRequestBody: The request body for the webhook; only applicable to the webhook provider.
    • WebhookHeaders: The request headers for the webhook; only applicable to the webhook provider.
    • MaxRetries: The number of retry attempts when a request fails.
    • Profiles: Multi-configuration settings; ignored in single configuration settings.
    The WebhookURL, WebhookRequestBody, and WebhookHeaders can include the following parameters:
    • {ip}: The current IP of the server.
    • {domain}: The DDNS domain.
    • {type}: The IP type, which could be "ipv4" or "ipv6".
    • {access_id}: Credential 1.
    • {access_secret}: Credential 2.
    Example Configuration:
    yaml
    WebhookHeaders: |
+    a:{access_id}
+    b:{access_secret}
+WebhookRequestBody: '{"domain": "{domain}", "ip": "{ip}", "type": "{type}"}'
    Multiple Configurations ​
    When using multiple configurations, leave the DDNS.Provider value empty. If DDNS.Provider is not empty, the multiple configuration settings will be ignored.
    yaml
    DDNS:
   Enable: true
   MaxRetries: 3
   Profiles:
-   example:
+    example:
       Provider: ""
       AccessID: ""
       AccessSecret: ""
       WebhookMethod: ""
       WebhookURL: ""
       WebhookRequestBody: ""
-      WebhookHeaders: ""
    Profiles ​
    Multiple configuration setting.
    example ​
    Name of DDNS configuration, can be any string.
    For other options, view Single.
    Dashboard configuration ​
    After configuring config.yaml, you will need to modify server settings in Dashboard to make DDNS function effective.
    Explanation of DDNS-related options:
    • Enable DDNS Enable the DDNS functionality for this server.
    • Enable DDNS IPv4 Enable IPv4 resolution when updating DDNS records.
    • Enable DDNS IPv6 Enable IPv6 resolution when updating DDNS records.
    • DDNS Domain The domain name the record points to.
    • DDNS Configuration The DDNS configuration to use in case of multiple configurations.
    TIP
    When modifying settings in the Dashboard and saving them, default configuration options will be filled into the config.yaml file. At this time, in the DDNS field, there will be both single configuration and multiple configurations options available.
    If you need to use a single configuration, please ignore the content related to the Profiles option.
    Please leave DDNS.Provider field blank while using Multiple configuration. If not, the Multiple configuration will be ignored.
    View log ​
    In the Dashboard's logs, you can view the relevant logs for the DDNS. When configured correctly, there will be corresponding log entries when the DNS records are updated.
    shell
    dashboard_1  | 2024/03/16 23:16:25 NEZHA>> 正在尝试更新域名(ddns.example.com)DDNS(1/3)
-dashboard_1  | 2024/03/16 23:16:28 NEZHA>> 尝试更新域名(ddns.example.com)DDNS成功
    
-    
+      WebhookHeaders: ""

    Other options can be referenced from the Single Configuration section.

    Dashboard Configuration ​

    After modifying the configuration file, you also need to modify the server settings in the Dashboard for the DDNS to take effect.

    DDNS related options:

    • Enable DDNS: Enable the DDNS functionality for this server.
    • Enable DDNS IPv4: Enable IPv4 parsing when updating DDNS records.
    • Enable DDNS IPv6: Enable IPv6 parsing when updating DDNS records.
    • DDNS Domain: The domain the record points to.
    • DDNS Configuration: The DDNS configuration name to use in multiple configurations.

    WARNING

    When you modify the configuration and save it in the Dashboard settings, it will populate the default configuration options in config.yaml, and both single and multiple configurations will exist in the DDNS section.

    • To use single configuration, configure DDNS.Provider and ignore the Profiles options.
    • To use multiple configurations, leave DDNS.Provider empty. If DDNS.Provider is not empty, the multiple configuration settings will be ignored.

    Viewing Logs ​

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

    shell
    dashboard_1  | 2024/03/16 23:16:25 NEZHA>> 正在尝试更新域名(ddns.example.com)DDNS(1/3) # Attempting to update domain (ddns.example.com) DDNS (1/3)
+dashboard_1  | 2024/03/16 23:16:28 NEZHA>> 尝试更新域名(ddns.example.com)DDNS成功 # Successfully updated domain (ddns.example.com) DDNS
    + \ No newline at end of file diff --git a/en_US/guide/services.html b/en_US/guide/services.html index 696e5440..37573f62 100644 --- a/en_US/guide/services.html +++ b/en_US/guide/services.html @@ -10,16 +10,16 @@ - + -
    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

    The Services section is where you set up monitoring for external websites or servers using Agents.
    Configured service monitors can be viewed on the "Services" page of the homepage, displaying the availability monitoring results for the past 30 days.

    How to Use ​

    To add a new monitor, go to the "Services" page in the Admin Panel and click "Add Monitor."

    When adding a new service monitor, you need to set the following parameters:

    • Name: Customize a name.

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

    • Target: Depending on the type you choose, the method for setting the target differs:

      • HTTP-GET: For this type, you should enter a URL as the target, including http:// or https://. If your target URL is https://, the SSL certificate of that URL will also be monitored. Notifications will be triggered when the SSL certificate expires or changes. Example: https://example.com.
      • ICMP-Ping: For this type, you should enter a domain name or IP without a port number. Example: 1.1.1.1 or example.com.
      • TCP-Ping: For this type, you should enter a domain name or IP with a port number. Example: 1.1.1.1:80 or example.com:22.

    • Request Interval: Set the interval in seconds at which the Agent requests the target.

    • Coverage: Select a rule to determine which Agents will request the target.

    • Specific Servers: Used in conjunction with the coverage scope, select Agents within the rule to exclude.

    • Notification Group: Choose the notification methods you have already set up on the "Notification" page. Click here for more details.

    • Enable Fault Notification: Choose whether to receive fault notifications for the target as needed. The default is unchecked.

    After setting it up, click "Add." Wait a moment and go to the "Services" page on the homepage to view the monitoring results.

    Latency Change Notification ​

    Nezha Monitoring can monitor and record the latency between the Agent and the target server, sending notifications when there are significant changes. This feature helps you monitor if the server's network route has changed.

    • Enable Latency Notifications: When enabled, Notification will be sent if the latency from the Agent to the target server is greater than the Maximum Latency or less than the Minimum Latency.

    Trigger Tasks on Notification ​

    If you need to execute tasks when service monitoring Notification are triggered, you can check "Enable Trigger Tasks" and select the pre-configured trigger tasks in "Task on Notification" and "Task on Recovery."

    Network Latency Chart ​

    The TCP-Ping and ICMP-Ping monitoring types set in the Services page will automatically enable the monitoring chart feature. On the "Network" page of the homepage, you can view historical network latency charts. The data in the charts is based on the latency from the Agent to the target server. You can click the Agent's name to toggle the chart display. In the chart, you can uncheck the target server's name to hide or show the corresponding data.

    Managing Monitors ​

    To manage existing service monitors, go to the "Services" page in the Admin Panel. Select a monitor configuration and click the icons on the right to edit or delete it.

    + \ No newline at end of file diff --git a/en_US/guide/settings.html b/en_US/guide/settings.html index 08bfdeeb..acbafe1f 100644 --- a/en_US/guide/settings.html +++ b/en_US/guide/settings.html @@ -10,18 +10,285 @@ - + -
    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;
+    
    Nezha Monitoring
    English
    简体中文
    English
    简体中文
    Appearance
    On this page
    Site Title ​
    You can customize the site title in this section.
    Administrator List ​
    • If you have changed your Github, Gitlab, or Gitee username, you need to update it here to avoid login issues. Separate multiple usernames with commas: user1,user2.
    • To change the administrator account, go to /opt/nezha/dashboard/data/config.yaml and reset the new administrator Client ID and Client Secret.
    Theme ​
    Select the theme for the homepage and admin panel here. If a theme that already exists is not in the options, update the Dashboard.
     Before enabling the Custom theme, ensure you have installed the custom theme; otherwise, the Dashboard will not display correctly after enabling this option.
    Language ​
    Nezha Monitoring currently supports the following languages:
    • Simplified Chinese (简体中文)
    • Traditional Chinese (繁體中文)
    • English
    • Spanish (Español)
    We welcome corrections to translations or contributions of more languages.
    Custom Code (style, script) ​
    You can modify the LOGO, adjust colors, add beautification code, and add statistical code here.
    WARNING
    Custom code only affects the visitor homepage, not the admin panel. Due to differences in code between themes, if you need to modify the content in the admin panel, please modify the theme files in Docker.
    Example of Changing Progress Bar Color, Background Image, Navigation Bar, etc., in the Default Theme ​
    Click to expand/collapse
    html
    <style>
+/* Screen adaptation */
+@media only screen and (min-width: 1200px) {
+    .ui.container {
+    width: 80% !important;
 }
-</style>
    html
    <style>
+}
+
+@media only screen and (max-width: 767px) {
+    .ui.card>.content>.header:not(.ui), .ui.cards>.card>.content>.header:not(.ui) {
+        margin-top: 0.4em !important;
+    }
+}
+
+/* Overall icons */
+i.icon {
+    color: #000;
+    width: 1.2em !important;
+}
+
+/* Background image */
+body {
+    content: " " !important;
+    background: fixed !important;
+    z-index: -1 !important;
+    top: 0 !important;
+    right: 0 !important;
+    bottom: 0 !important;
+    left: 0 !important;
+    background-position: top !important;
+    background-repeat: no-repeat !important;
+    background-size: cover !important;
+    background-image: url(https://backgroud.img) !important;
+    font-family: Arial,Helvetica,sans-serif !important;
+}
+
+/* Navigation bar */
+.ui.large.menu {
+    border: 0 !important;
+    border-radius: 0px !important;
+    background-color: rgba(255, 255, 255, 55%) !important;
+}
+
+/* Homepage buttons */
+.ui.menu .active.item {
+    background-color: transparent !important;
+}
+
+/* Navigation bar dropdown */
+.ui.dropdown .menu {
+    border: 0 !important;
+    border-radius: 0 !important;
+    background-color: rgba(255, 255, 255, 80%) !important;
+}
+
+/* Login button */
+.nezha-primary-btn {
+    background-color: transparent !important;
+    color: #000 !important;
+}
+
+/* Large card */
+#app .ui.fluid.accordion {
+    background-color: #fbfbfb26 !important;
+    border-radius: 0.4rem !important;
+}
+
+/* Small card */
+.ui.four.cards>.card {
+    border-radius: 0.6rem !important;
+    background-color: #fafafaa3 !important;
+}
+
+.status.cards .wide.column {
+    padding-top: 0 !important;
+    padding-bottom: 0 !important;
+    height: 3.3rem !important;
+}
+
+.status.cards .three.wide.column {
+    padding-right: 0rem !important;
+}
+
+.status.cards .wide.column:nth-child(1) {
+    margin-top: 2rem !important;
+}
+
+.status.cards .wide.column:nth-child(2) {
+    margin-top: 2rem !important;
+}
+
+.status.cards .description {
+    padding-bottom: 0 !important;
+}
+
+/* Server name */
+.status.cards .flag {
+    margin-right: 0.5rem !important;
+}
+
+/* Popup card icon */
+.status.cards .header > .info.icon {
+    margin-right: 0 !important;
+}
+
+.nezha-secondary-font {
+    color: #2175ba !important;
+}
+
+/* Upload/download */
+.status.cards .outline.icon {
+    margin-right: 1px !important;
+}
+
+i.arrow.alternate.circle.down.outline.icon {
+    color: #2175ba !important;
+}
+
+i.arrow.alternate.circle.up.outline.icon {
+    color: red !important;
+}
+
+/* Popup card small arrow */
+.ui.right.center.popup {
+    margin: -3px 0 0 0.914286em !important;
+    -webkit-transform-origin: left 50% !important;
+    transform-origin: left 50% !important;
+}
+
+.ui.bottom.left.popup {
+    margin-left: 1px !important;
+    margin-top: 3px !important;
+}
+
+.ui.top.left.popup {
+    margin-left: 0 !important;
+    margin-bottom: 10px !important;
+}
+
+.ui.top.right.popup {
+    margin-right: 0 !important;
+    margin-bottom: 8px !important;
+}
+
+.ui.left.center.popup {
+    margin: -3px .91428571em 0 0 !important;
+    -webkit-transform-origin: right 50% !important;
+    transform-origin: right 50% !important;
+}
+
+.ui.right.center.popup:before,
+.ui.left.center.popup:before {
+    border: 0px solid #fafafaeb !important;
+    background: #fafafaeb !important;
+}
+
+.ui.top.popup:before {
+    border-color: #fafafaeb transparent transparent !important;
+}
+
+.ui.popup:before {
+    border-color: #fafafaeb transparent transparent !important;
+}
+
+.ui.bottom.left.popup:before {
+    border-radius: 0 !important;
+    border: 1px solid transparent !important;
+    border-color: #fafafaeb transparent transparent !important;
+    background: #fafafaeb !important;
+    -webkit-box-shadow: 0px 0px 0 0 #fafafaeb !important;
+    box-shadow: 0px 0px 0 0 #fafafaeb !important;
+    -webkit-tap-highlight-color: rgba(0,0,0,0) !important;
+}
+
+.ui.bottom.right.popup:before {
+    border-radius: 0 !important;
+    border: 1px solid transparent !important;
+    border-color: #fafafaeb transparent transparent !重要;
+    background: #fafafaeb !重要
+    -webkit-box-shadow: 0px 0px 0 0 #fafafaeb !重要;
+    box-shadow: 0px 0px 0 0 #fafafaeb !重要;
+    -webkit-tap-highlight-color: rgba(0,0,0,0) !重要;
+}
+
+.ui.top.left.popup:before {
+    border-radius: 0 !重要;
+    border: 1px solid transparent !重要;
+    border-color: #fafafaeb transparent transparent !重要;
+    background: #fafafaeb !重要;
+    -webkit-box-shadow: 0px 0px 0 0 #fafafaeb !重要;
+    box-shadow: 0px 0px 0 0 #fafafaeb !重要;
+    -webkit-tap-highlight-color: rgba(0,0,0,0) !重要;
+}
+
+.ui.top.right.popup:before {
+    border-radius: 0 !重要;
+    border: 1px solid transparent !重要;
+    border-color: #fafafaeb transparent transparent !重要;
+    background: #fafafaeb !重要;
+    -webkit-box-shadow: 0px 0px 0 0 #fafafaeb !重要;
+    box-shadow: 0px 0px 0 0 #fafafaeb !重要;
+    -webkit-tap-highlight-color: rgba(0,0,0,0) !重要;
+}
+
+.ui.left.center.popup:before {
+    border-radius: 0 !重要;
+    border: 1px solid transparent !重要;
+    border-color: #fafafaeb transparent transparent !重要;
+    background: #fafafaeb !重要;
+    -webkit-box-shadow: 0px 0px 0 0 #fafafaeb !重要;
+    box-shadow: 0px 0px 0 0 #fafafaeb !重要;
+    -webkit-tap-highlight-color: rgba(0,0,0,0) !重要;
+}
+
+/* Popup card */
+.status.cards .ui.content.popup {
+    min-width: 20rem !重要;
+    line-height: 2rem !重要;
+    border-radius: 5px !重要;
+    border: 1px solid transparent !重要;
+    background-color: #fafafaeb !重要;
+    font-family: Arial,Helvetica,sans-serif !重要;
+}
+
+.ui.content {
+    margin: 0 !重要;
+    padding: 1em !重要;
+}
+
+/* Service page */
+.ui
+
+.table {
+    background: RGB(225,225,225,0.6) !重要;
+}
+
+.ui.table thead th {
+    background: transparent !重要;
+}
+
+/* Service page progress bar */
+.service-status .good {
+    background-color: #2175ba !重要;
+}
+
+.service-status .danger {
+    background-color: red !重要;
+}
+
+.service-status .warning {
+    background-color: orange !重要;
+}
+
+/* Copyright */
+.ui.inverted.segment, .ui.primary.inverted.segment {
+    color: #000 !重要;
+    font-weight: bold !重要;
+    background-color: #fafafaa3 !重要;
+}
+</style>
+
+<!--Logo and Copyright-->
+<script>
+window.onload = function(){
+var avatar=document.querySelector(".item img")
+var footer=document.querySelector("div.is-size-7")
+footer.innerHTML="Copyright info"
+footer.style.visibility="visible"
+avatar.src="https:/img.src"
+avatar.style.visibility="visible"
+}
+</script>
    Click to expand/collapse
    html
    <style>
 .ui.fine.progress> .progress-bar {
   background-color: #00a7d0 !important;
 }
@@ -29,40 +296,40 @@
 
 <script>
 window.onload = function(){
-var avatar=document.querySelector("img")
-var footer=document.querySelector("div.footer-container")
-footer.innerHTML="©2021 YourName & Powered by YourName"
-footer.style.visibility="visible"
-avatar.src="Logo URL"
-avatar.style.visibility="visible"
+  var avatar = document.querySelector("img");
+  var footer = document.querySelector("div.footer-container");
+  footer.innerHTML = "©2021 Your Name & Powered by Your Name";
+  footer.style.visibility = "visible";
+  avatar.src = "Your Image URL";
+  avatar.style.visibility = "visible";
 }
-</script>
    html
    <style>
-.right.menu>a{
-visibility: hidden;
+</script>
    Click to expand/collapse
    html
    <style>
+.right.menu>a {
+  visibility: hidden;
 }
-.footer .is-size-7{
-visibility: hidden;
+.footer .is-size-7 {
+  visibility: hidden;
 }
-.item img{
-visibility: hidden;
+.item img {
+  visibility: hidden;
 }
 </style>
 <script>
-window.onload = function(){
-var avatar=document.querySelector(".item img")
-var footer=document.querySelector("div.is-size-7")
-footer.innerHTML="Powered by YOUR NAME"
-footer.style.visibility="visible"
-avatar.src="Your square logo link"
-avatar.style.visibility="visible"
+window.onload = function() {
+  var avatar = document.querySelector(".item img");
+  var footer = document.querySelector("div.is-size-7");
+  footer.innerHTML = "Powered by Your Name";
+  footer.style.visibility = "visible";
+  avatar.src = "Your Square Logo URL";
+  avatar.style.visibility = "visible";
 }
-</script>
    Example of modifying the background image of hotaru theme ​
    html
    <style>
+</script>
    Example of Changing Background Image in Hotaru Theme ​
    Click to expand/collapse
    html
    <style>
 .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>

    View Password ​

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

    Non-CDN Dashboard Server Domain/IP ​

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

    IP Change Notifications ​

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

    Coverage ​

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

    Specific Servers ​

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

    Send Notifications to a Specific Notification Group ​

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

    WARNING

    Notifications take effect after enabling this setting.

    Show Full IP Address in Notifications ​

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

    Disable Homepage Theme Switching ​

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

    + \ No newline at end of file diff --git a/en_US/guide/tasks.html b/en_US/guide/tasks.html index 66955bd3..2deeb10c 100644 --- a/en_US/guide/tasks.html +++ b/en_US/guide/tasks.html @@ -10,16 +10,16 @@ - + -
    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 Tasks section, you can set up scheduled tasks, trigger tasks, and batch execute tasks on multiple servers.

    Nezha Monitoring supports pushing commands to Agents for execution. This feature is highly flexible and can be used for regular backups using tools like restic or rclone, periodically restarting a service to reset network connections, or executing a task when an notification is triggered, such as running a script when CPU usage is high for an extended period.

    How to Use ​

    Go to the "Tasks" page in the admin panel and click "Add Scheduled Task." When adding a scheduled task, you need to fill in the following parameters:

    • Name: Customize a task name.

    • Task Type: Choose the type of task.

      • Scheduled Task: Executes periodically according to the schedule set below.
      • Trigger Task: Only executed when triggered by an API call or notification rule, runs once per trigger.

    • Schedule: Set the schedule time (not enable when using trigger task type). The time format is * * * * * *, corresponding to second minute hour day month weekday. For more details, see Cron Expression Format.
      For example: 0 0 3 * * * means "3 AM every day."

    • Command: Set the command to execute, similar to writing Shell/Bat scripts, but it's recommended not to use new lines; connect multiple commands with && or &.
      For example, to schedule a reboot, you can enter reboot here.

    • Coverage and Specific Servers: Select rules to determine which Agents execute the scheduled task, similar to the settings on the "Services" page. When using the trigger task type, you can choose "executed by the triggered server."

    • Notification Group: Choose the notification methods you have set up on the "Notifications" page. Click here for more details.

    • Send Success Notification: Check this option to trigger a notification upon successful task execution.

    Managing Tasks ​

    To manage existing scheduled tasks, go to the "Tasks" page in the admin panel. For each task configuration, the three icons on the right are:

    • Execute Immediately: Click to ignore the scheduled time and execute the task immediately.
    • Edit: Click to modify the task configuration.
    • Delete: Delete the scheduled task.

    Frequently Asked Questions ​

    1. Command not found error
      If a command fails to run with a "command not found" error, it may be a PATH environment variable issue. On Linux servers, you can add source ~/.bashrc at the beginning of the command or use the absolute path to execute the command.
    + \ No newline at end of file diff --git a/en_US/index.html b/en_US/index.html index 6b1c3187..8d965c13 100644 --- a/en_US/index.html +++ b/en_US/index.html @@ -10,16 +10,16 @@ - + -
    Nezha Monitoring

    English

    简体中文

    English

    简体中文

    Appearance

    Nezha Monitoring

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

    Preview
    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

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

    Preview
    Get Started →

    One-Click Installation

    Supports one-click installation of the Dashboard and Agent services, making it easy to operate. Compatible with mainstream systems, including Linux, Windows, macOS, OpenWRT, and Synology.

    Real-Time Monitoring

    Supports monitoring the status of multiple servers simultaneously, providing historical network status and latency charts, monitoring webpage and port availability, and SSL certificate status. Supports alerts for status such as faults and traffic, with notifications via Telegram, email, Slack, and more.

    Easy Operations

    Provides an API to get server status, supports WebSSH, DDNS, and traffic monitoring. Allows setting up scheduled and triggered tasks and executing server tasks in batches.

    + \ No newline at end of file diff --git a/guide/agent.html b/guide/agent.html index f810d53a..3674fb04 100644 --- a/guide/agent.html +++ b/guide/agent.html @@ -10,14 +10,14 @@ - + -
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

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

    TIP

    Agent 二进制文件仓库地址为：https://github.com/nezhahq/agent/releases

    一键安装 Agent ​

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

    准备工作 ​

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

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

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

    在 Windows 中一键安装 ​

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

    WARNING

    如果在 Powershell 中运行一键安装命令时遇到错误，请尝试下方的在 Windows 中手动安装 Agent


    其他方式安装 Agent ​

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

    点击展开/收起
    • 首先在管理面板中添加一台服务器
    • 在被控服务器中，运行脚本（位于中国大陆的服务器请使用镜像）：
    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://gitee.com/naibahq/nezha/raw/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh
    • 选择“安装监控 Agent”
    • 输入通信域名，如：”data.example.com“
    • 输入面板通信端口（gRPC 端口），默认为 5555
    • 输入 Agent 密钥，Agent 密钥在管理面板中添加服务器时生成，可以在管理面板中的“服务器”页中找到
    • 等待安装完成后返回 Dashboard 主页查看服务器是否上线

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

    点击展开/收起

    本节内容由 unknown0054 贡献

    • 修改 SERVER、SECRET、TLS 然后在 shell 中执行
    shell
    cat >/etc/init.d/nezha-agent<< EOF
+    
    哪吒监控
    简体中文
    English
    简体中文
    English
    Appearance
    On this page
    哪吒监控的被控端服务被称为 Agent，本文档将介绍如何在被控端服务器上安装 Agent，并与 Dashboard 连接
    TIP
    Agent 二进制文件仓库地址为：https://github.com/nezhahq/agent/releases
    一键安装 Agent ​
    目前哪吒监控已支持在 Windows 和 Linux上一键安装 Agent，遵循本文档的步骤，你可以很轻松的在服务器上部署它

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

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

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

    WARNING
    如果在 Powershell 中运行一键安装命令时遇到错误，请尝试下方的在 Windows 中手动安装 Agent

    其他方式安装 Agent ​
    在 Linux 中安装 Agent (Ubuntu、Debian、CentOS) ​
    点击展开/收起
    • 首先在管理面板中添加一台服务器
    • 在被控服务器中，运行脚本（位于中国大陆的服务器请使用镜像）：
    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://gitee.com/naibahq/nezha/raw/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh
    • 选择“安装监控 Agent”
    • 输入通信域名，如：”data.example.com“
    • 输入面板通信端口（gRPC 端口），默认为 5555
    • 输入 Agent 密钥，Agent 密钥在管理面板中添加服务器时生成，可以在管理面板中的“服务器”页中找到
    • 等待安装完成后返回 Dashboard 主页查看服务器是否上线

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

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

    常见问题 ​

    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 c23264b1..fec86c26 100644 --- a/guide/agentq.html +++ b/guide/agentq.html @@ -10,16 +10,16 @@ - + -
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

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

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

    一键脚本安装时出错 ​

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

    多出现在中国大陆的服务器中，目前一键脚本只从 Github 直接获取安装脚本，您可以多尝试几次，或者手动安装 Agent。另外，也可以自行寻找第三方 Github 加速服务或者镜像，并在一键安装脚本中设置。

    sudo: command not found ​

    请先手动安装 sudo，例如在 Ubuntu 中：

    shell
    apt install sudo
    - +
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

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

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

    一键脚本安装时出错 ​

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

    多出现在中国大陆的服务器中，目前一键脚本只从 Github 直接获取安装脚本，您可以多尝试几次，或者手动安装 Agent。另外，也可以自行寻找第三方 Github 加速服务或者镜像，并在一键安装脚本中设置。

    sudo: command not found ​

    请先手动安装 sudo，例如在 Ubuntu 中：

    shell
    apt install sudo
    + \ No newline at end of file diff --git a/guide/api.html b/guide/api.html index b18c1602..8bbac56f 100644 --- a/guide/api.html +++ b/guide/api.html @@ -10,125 +10,153 @@ - + -
    哪吒监控

    简体中文

    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",
-    "result": [
-        {
-            "id": 1,
-            "name": "Server1",
-            "tag": "Tag1",
-            "last_active": 1653014667,
-            "ipv4": "1.1.1.1",
-            "ipv6": "",
-            "valid_ip": "1.1.1.1"
-        },
-        {
-            "id": 2,
-            "name": "Server2",
-            "tag": "Tag2",
-            "last_active": -62135596800,
-            "ipv4": "",
-            "ipv6": "",
-            "valid_ip": ""
-        }
-    ]
-}
    • 获取服务器详情：GET /api/v1/server/details?id=&tag=
      query: id (ServerID 多个 ID 以逗号分隔，提供此参数则查询该 ID 对应的服务器，同时无视tag参数)
      query: tag (ServerTag 提供此参数则仅查询该分组下的服务器)

    JSON 返回示例：

    {
-    "code": 0,
-    "message": "success",
-    "result": [
-        {
-            "id": 1,
-            "name": "Server1",
-            "tag": "Tag1",
-            "last_active": 1653015042,
-            "ipv4": "1.1.1.1",
-            "ipv6": "",
-            "valid_ip": "1.1.1.1",
-            "host": {
-                "Platform": "darwin",
-                "PlatformVersion": "12.3.1",
-                "CPU": [
-                    "Apple M1 Pro 1 Physical Core"
-                ],
-                "MemTotal": 17179869184,
-                "DiskTotal": 2473496842240,
-                "SwapTotal": 0,
-                "Arch": "arm64",
-                "Virtualization": "",
-                "BootTime": 1652683962,
-                "CountryCode": "hk",
-                "Version": ""
-            },
-            "status": {
-                "CPU": 17.330210772540017,
-                "MemUsed": 14013841408,
-                "SwapUsed": 0,
-                "DiskUsed": 2335048912896,
-                "NetInTransfer": 2710273234,
-                "NetOutTransfer": 695454765,
-                "NetInSpeed": 10806,
-                "NetOutSpeed": 5303,
-                "Uptime": 331080,
-                "Load1": 5.23486328125,
-                "Load5": 4.873046875,
-                "Load15": 3.99267578125,
-                "TcpConnCount": 195,
-                "UdpConnCount": 70,
-                "ProcessCount": 437
-            }
-        },
-        {
-            "id": 2,
-            "name": "Server2",
-            "tag": "Tag2",
-            "last_active": -62135596800,
-            "ipv4": "",
-            "ipv6": "",
-            "valid_ip": "",
-            "host": {
-                "Platform": "",
-                "PlatformVersion": "",
-                "CPU": null,
-                "MemTotal": 0,
-                "DiskTotal": 0,
-                "SwapTotal": 0,
-                "Arch": "",
-                "Virtualization": "",
-                "BootTime": 0,
-                "CountryCode": "",
-                "Version": ""
-            },
-            "status": {
-                "CPU": 0,
-                "MemUsed": 0,
-                "SwapUsed": 0,
-                "DiskUsed": 0,
-                "NetInTransfer": 0,
-                "NetOutTransfer": 0,
-                "NetInSpeed": 0,
-                "NetOutSpeed": 0,
-                "Uptime": 0,
-                "Load1": 0,
-                "Load5": 0,
-                "Load15": 0,
-                "TcpConnCount": 0,
-                "UdpConnCount": 0,
-                "ProcessCount": 0
-            }
-        }
-    ]
-}
    - +
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

    哪吒监控支持使用 API 接口查询面板中 Agent 的状态信息

    创建 Token ​

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

    如需删除一个 Token，请选择相应的 Token，点击右侧的删除图标。

    WARNING

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

    认证方式 ​

    确保在请求头中包含 Authorization: Token 进行身份认证。

    Token 认证方式：

    Request Headers:
+Authorization: Token

    使用说明 ​

    WARNING

    下面示例中的负数时间戳为（0000-00-00），目前表示 Dashboard 上线后该 Agent 从未汇报过，但不建议用正负性判断状态。

    TIP

    请求方式为 GET，返回格式为 JSON

    获取服务器列表 ​

    请求：

    GET /api/v1/server/list?tag=

    参数：

    • tag（可选）：ServerTag 是服务器的分组，提供此参数则仅查询该分组中的服务器。

    返回示例：

    json
    {
+    "code": 0,
+    "message": "success",
+    "result": [
+        {
+            "id": 1,
+            "name": "Server1",
+            "tag": "Tag1",
+            "last_active": 1653014667,
+            "ipv4": "1.1.1.1",
+            "ipv6": "",
+            "valid_ip": "1.1.1.1"
+        },
+        {
+            "id": 2,
+            "name": "Server2",
+            "tag": "Tag2",
+            "last_active": -62135596800,
+            "ipv4": "",
+            "ipv6": "",
+            "valid_ip": ""
+        }
+    ]
+}

    获取服务器详情 ​

    请求：

    GET /api/v1/server/details?id=&tag=

    参数：

    • id（可选）：ServerID，多个 ID 以逗号分隔，提供此参数则查询该 ID 对应的服务器，同时无视 tag 参数。
    • tag（可选）：ServerTag，提供此参数则仅查询该分组下的服务器。

    返回示例：

    json
    {
+    "code": 0,
+    "message": "success",
+    "result": [
+        {
+            "id": 1,
+            "name": "Server1",
+            "tag": "Tag1",
+            "last_active": 1653015042,
+            "ipv4": "1.1.1.1",
+            "ipv6": "",
+            "valid_ip": "1.1.1.1",
+            "host": {
+                "Platform": "darwin",
+                "PlatformVersion": "12.3.1",
+                "CPU": [
+                    "Apple M1 Pro 1 Physical Core"
+                ],
+                "MemTotal": 17179869184,
+                "DiskTotal": 2473496842240,
+                "SwapTotal": 0,
+                "Arch": "arm64",
+                "Virtualization": "",
+                "BootTime": 1652683962,
+                "CountryCode": "hk",
+                "Version": ""
+            },
+            "status": {
+                "CPU": 17.33,
+                "MemUsed": 14013841408,
+                "SwapUsed": 0,
+                "DiskUsed": 2335048912896,
+                "NetInTransfer": 2710273234,
+                "NetOutTransfer": 695454765,
+                "NetInSpeed": 10806,
+                "NetOutSpeed": 5303,
+                "Uptime": 331080,
+                "Load1": 5.23,
+                "Load5": 4.87,
+                "Load15": 3.99,
+                "TcpConnCount": 195,
+                "UdpConnCount": 70,
+                "ProcessCount": 437
+            }
+        },
+        {
+            "id": 2,
+            "name": "Server2",
+            "tag": "Tag2",
+            "last_active": -62135596800,
+            "ipv4": "",
+            "ipv6": "",
+            "valid_ip": "",
+            "host": {
+                "Platform": "",
+                "PlatformVersion": "",
+                "CPU": null,
+                "MemTotal": 0,
+                "DiskTotal": 0,
+                "SwapTotal": 0,
+                "Arch": "",
+                "Virtualization": "",
+                "BootTime": 0,
+                "CountryCode": "",
+                "Version": ""
+            },
+            "status": {
+                "CPU": 0,
+                "MemUsed": 0,
+                "SwapUsed": 0,
+                "DiskUsed": 0,
+                "NetInTransfer": 0,
+                "NetOutTransfer": 0,
+                "NetInSpeed": 0,
+                "NetOutSpeed": 0,
+                "Uptime": 0,
+                "Load1": 0,
+                "Load5": 0,
+                "Load15": 0,
+                "TcpConnCount": 0,
+                "UdpConnCount": 0,
+                "ProcessCount": 0
+            }
+        }
+    ]
+}

    使用案例 ​

    获取所有服务器信息 ​

    python
    import requests
+
+url = "http://your-dashboard/api/v1/server/list"
+headers = {
+    "Authorization": "your_token"
+}
+
+response = requests.get(url, headers=headers)
+data = response.json()
+
+for server in data['result']:
+    print(f"Server Name: {server['name']}, Last Active: {server['last_active']}, IP: {server['valid_ip']}")

    获取特定服务器详情 ​

    python
    import requests
+
+server_id = 1  # 替换为你的服务器ID
+url = f"http://your-dashboard/api/v1/server/details?id={server_id}"
+headers = {
+    "Authorization": "your_token"
+}
+
+response = requests.get(url, headers=headers)
+data = response.json()
+
+server = data['result'][0]
+print(f"Server Name: {server['name']}")
+print(f"CPU Usage: {server['status']['CPU']}%")
+print(f"Memory Used: {server['status']['MemUsed']} bytes")
+print(f"Disk Used: {server['status']['DiskUsed']} bytes")
+print(f"Network In Speed: {server['status']['NetInSpeed']} bytes/s")
+print(f"Network Out Speed: {server['status']['NetOutSpeed']} bytes/s")

    通过以上示例代码，可以轻松获取和处理服务器的状态信息，从而实现自动化监控和管理。

    + \ No newline at end of file diff --git a/guide/dashboard.html b/guide/dashboard.html index c01dcacd..9f3ff6cb 100644 --- a/guide/dashboard.html +++ b/guide/dashboard.html @@ -10,14 +10,14 @@ - + -
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

    准备工作 ​

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

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

    TIP

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

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

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

    WARNING

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



    获取 Github 的 Client ID 和密钥 ​

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

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

    获取 Cloudflare Access 作为 OAuth2 提供方 ​

    位于中国大陆的用户可能无法直接连接 Github，如您在使用 Github、Gitlab、Gitee 作为管理员账户登录时遇到问题，您可以优先考虑切换 使用 Cloudflare Access 作为 OAuth2 提供方作为登录方式

    新建 SaaS-OIDC 应用流程

    1. 前往 Zero Trust Dashboard，使用 Cloudflare 账号登录；
    2. My Team -> Users -> <具体用户> -> 获取 User ID 并保存；
    3. Access -> Application -> Add an Application；
    4. 选择 SaaS，在 Application 中输入自定义的应用名称（例如 nezha），选择 OIDC 后点击 Add application；
    5. Scopes 选择 openid, email, profile, groups；
    6. Redirect URLs 填写你的 callback 地址，例如 https://dashboard.example.com/oauth2/callback；
    7. 保存 Client ID、Client Secret、Issuer 地址中协议与域名的部分，例如 https://xxxxx.cloudflareaccess.com

    如使用此方式，安装 Dashboard 完成后，需要修改配置文件 /opt/nezha/dashboard/data/config.yaml，将 Endpoint 配置修改为之前保存的Issuer地址，例如 https://xxxxx.cloudflareaccess.com，保存后需重启 Dashboard

    在服务器中安装 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://gitee.com/naibahq/nezha/raw/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh

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

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

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

    bash
    ./nezha.sh

    来打开管理脚本


    配置反向代理 ​

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

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

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

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


    获取 Github 的 Client ID 和密钥 ​
    哪吒监控接入 Github、Gitlab、Gitee 作为后台管理员账号
    1. 首先我们需要新建一个验证应用，以 Github 为例，登录 Github 后，打开 https://github.com/settings/developers ，依次选择“OAuth Apps” - “New OAuth App”
      Application name - 随意填写
      Homepage URL - 填写面板的访问域名，如："http://dashboard.example.com" （你的域名）
      Authorization callback URL - 填写回调地址，如："http://dashboard.example.com/oauth2/callback" （不要忘记/oauth2/callback）
    2. 点击 “Register application”
    3. 保存页面中的 Client ID，然后点击 “Generate a new client secret“，创建一个新的 Client Secret，新建的密钥仅会显示一次，请妥善保存
    获取 Cloudflare Access 作为 OAuth2 提供方 ​
    位于中国大陆的用户可能无法直接连接 Github，如您在使用 Github、Gitlab、Gitee 作为管理员账户登录时遇到问题，您可以优先考虑切换 使用 Cloudflare Access 作为 OAuth2 提供方作为登录方式
    新建 SaaS-OIDC 应用流程
    1. 前往 Zero Trust Dashboard，使用 Cloudflare 账号登录；
    2. My Team -> Users -> <具体用户> -> 获取 User ID 并保存；
    3. Access -> Application -> Add an Application；
    4. 选择 SaaS，在 Application 中输入自定义的应用名称（例如 nezha），选择 OIDC 后点击 Add application；
    5. Scopes 选择 openid, email, profile, groups；
    6. Redirect URLs 填写你的 callback 地址，例如 https://dashboard.example.com/oauth2/callback；
    7. 保存 Client ID、Client Secret、Issuer 地址中协议与域名的部分，例如 https://xxxxx.cloudflareaccess.com
    如使用此方式，安装 Dashboard 完成后，需要修改配置文件 /opt/nezha/dashboard/data/config.yaml，将 Endpoint 配置修改为之前保存的Issuer地址，例如 https://xxxxx.cloudflareaccess.com，保存后需重启 Dashboard

    在服务器中安装 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://gitee.com/naibahq/nezha/raw/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh
    • 等待 Docker 安装完毕后，分别输入以下值：
      OAuth提供商 - github，cloudflare，gitlab，gitee 中选择一个
      Client ID - 之前保存的 Client ID
      Client Secret - 之前保存的 Client Secret
      用户名 - OAuth 提供商中的用户名/User ID
      站点标题 - 自定义站点标题
      访问端口 - 公开访问端口，可自定义，默认 8008
      Agent的通信端口 - Agent 与 Dashboard 的通信端口，默认 5555
    • 输入完成后，等待拉取镜像
       安装结束后，如果一切正常，此时你可以访问域名+端口号，如 “http://dashboard.example.com:8008” 来查看面板
    • 将来如果需要再次运行脚本，可以运行：
    bash
    ./nezha.sh
    来打开管理脚本


    配置反向代理 ​
    • 在宝塔面板中新建一个站点，域名填写公开访问域名，如 “http://dashboard.example.com“ ，然后点击“设置”进入站点设置选项，选择“反向代理” - “新建反向代理”
    • 自定义一个代理名称，在下方“目标 URL”中填入 http://127.0.0.1 然后点击“保存”
    • 打开刚刚新建的反向代理右边的“配置文件”，将配置文件替换为以下内容：
    nginx
    #PROXY-START/
 location / {
     proxy_pass http://127.0.0.1:8008;
     proxy_set_header Host $http_host;
@@ -37,9 +37,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://dashboard.example.com" 和 "https://dashboard.example.com/oauth2/callback" ，不更改此项可能会导致你无法登录面板后台
    常见问题 ​
    启用 HTTPS 后 /terminal 或 /ws 不能正常连接怎么办? ​
    常常是由于证书不完整造成的，请在 agent 运行参数中添加 -d，若 log 中有 x509:certificate signed by unknown authority,更换完整证书则可解决该问题。
    我对面板提供的数据修改/增加功能不满意，我想要自己修改/增加数据怎么办？ ​
    常见于批量插入 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://dashboard.example.com" 和 "https://dashboard.example.com/oauth2/callback" ，不更改此项可能会导致你无法登录面板后台

    常见问题 ​

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

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

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

    常见于批量插入 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 7cf13d64..6dcf028a 100644 --- a/guide/dashboardq.html +++ b/guide/dashboardq.html @@ -10,14 +10,14 @@ - + -
    哪吒监控

    简体中文

    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 https://ipapi.co/ip/
+    
    哪吒监控
    简体中文
    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 https://ipapi.co/ip/
 curl ip.sb
 curl ip-api.com
    忘记查看密码\删除查看密码 ​
    请查看或编辑 /opt/nezha/dashboard/data/config.yaml 文件。
     密码位于 site-viewpassword 项中。
    面板安装/重启/更新失败: iptables ...... ​
    首先尝试重启 Docker 再操作：
    shell
    systemctl status docker
 systemctl restart docker
@@ -26,9 +26,9 @@
         expires      12h;
         error_log /dev/null;
         access_log /dev/null;
-    }
  • 保存配置，并清空浏览器、Nginx、CDN 中的缓存，此时刷新页面应恢复正常。
    • 面板无法启动：panic: 无法找到配置的 DDNS 提供者... ​
    填入的 DDNS provider 的值有误，目前仅支持 webhook、cloudflare、tencentcloud 和 dummy。
    面板更新 DDNS 崩溃：panic: interface conversion: interface {} is nil, not []interface {} ​
    填入的 DDNS AccessID 或 AccessSecret 有误。
    打开网络监控页显示：server monitor history not found ​
    出现此错误说明没有在服务页中设置 TCP-Ping 和 ICMP-Ping 类型的监控或者监控数据还未生成。
     如已经设置完毕，可以等待一段时间后再查看。
    
-    
+    }

  • 保存配置，并清空浏览器、Nginx、CDN 中的缓存，此时刷新页面应恢复正常。

    • 面板无法启动：panic: 无法找到配置的 DDNS 提供者... ​

    填入的 DDNS provider 的值有误，目前仅支持 webhook、cloudflare、tencentcloud 和 dummy。

    面板更新 DDNS 崩溃：panic: interface conversion: interface {} is nil, not []interface {} ​

    填入的 DDNS AccessID 或 AccessSecret 有误。

    打开网络监控页显示：server monitor history not found ​

    出现此错误说明没有在服务页中设置 TCP-Ping 和 ICMP-Ping 类型的监控或者监控数据还未生成。
    如已经设置完毕，可以等待一段时间后再查看。

    + \ No newline at end of file diff --git a/guide/loginq.html b/guide/loginq.html index fbb23b32..8217fe9d 100644 --- a/guide/loginq.html +++ b/guide/loginq.html @@ -10,16 +10,16 @@ - + -
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

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

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

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

    TIP

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

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

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

    登录后面板报错 ​

    1. 清理 cookies 后重新登录，或换个浏览器。
    2. 检查回调地址，确保您的回调地址正确且端口与协议均正确！发起请求的地址需要和回调地址处于同域，端口、协议和域名(或IP)都需要一致。

    lookup xxx ​

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

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

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

    oauth2: server response missing access_token ​

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

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

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

    dial tcp xxx:443 i/o timeout ​

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

    net/http: TLS handshake timeout ​

    同上。

    - +
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

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

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

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

    TIP

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

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

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

    登录后面板报错 ​

    1. 清理 cookies 后重新登录，或换个浏览器。
    2. 检查回调地址，确保您的回调地址正确且端口与协议均正确！发起请求的地址需要和回调地址处于同域，端口、协议和域名(或IP)都需要一致。

    lookup xxx ​

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

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

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

    oauth2: server response missing access_token ​

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

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

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

    dial tcp xxx:443 i/o timeout ​

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

    net/http: TLS handshake timeout ​

    同上。

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

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

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

    灵活的通知方式 ​

    • 在面板消息中，占位符 #DATETIME# 代表事件发生的时间戳。当通知被触发时，面板会自动将 #DATETIME# 替换为事件的实际时间。
    • #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、内存、硬盘、流量、月流量、进程数、连接数进行监控，并在其中某项达到用户设定值时发送告警通知 

    灵活的通知方式 ​
    • 在面板消息中，占位符 #DATETIME# 代表事件发生的时间戳。当通知被触发时，面板会自动将 #DATETIME# 替换为事件的实际时间。
    • #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
@@ -52,9 +52,9 @@
 ```
 
 根据需求删减相关内容信息即可
-
    通知效果
    飞书群机器人配置 示例 贡献者：@eya46 ​
    点击展开/收起
    • 名称: 哪吒面板Bot
    • URL：https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxx
    • 请求方式: POST
    • 请求类型: JSON
    • Body: {"content":{"text":"#NEZHA#\n#DATETIME#"},"msg_type":"text"}
    • URL 参数获取说明：机器人URL通过飞书群-群机器人-添加机器人-自定义机器人(webhook)创建后获取


    告警规则说明 ​
    基本规则 ​
    • 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 上报的状态符合告警的规则时，都会触发一次通知
    • 单次触发：仅状态改变时触发一次通知，如从正常状态改变为异常状态，或异常状态恢复为正常状态
    设置告警时执行任务 ​
    如果你需要在发出告警消息的同时执行某项任务，可以设置此项目
    • 告警时触发任务 当告警状态符合从“正常”变更为“事件”时，所要执行的任务，任务应提前在任务页设置
    • 恢复时触发任务 当告警状态符合从“事件”恢复为“正常”时，所要执行的任务，任务应提前在任务页设置
    
-    
+

    通知效果

    飞书群机器人配置 示例 贡献者：@eya46 ​

    点击展开/收起
    • 名称: 哪吒面板Bot
    • URL：https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxx
    • 请求方式: POST
    • 请求类型: JSON
    • Body: {"content":{"text":"#NEZHA#\n#DATETIME#"},"msg_type":"text"}
    • URL 参数获取说明：机器人URL通过飞书群-群机器人-添加机器人-自定义机器人(webhook)创建后获取


    告警规则说明 ​

    基本规则 ​

    • 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 上报的状态符合告警的规则时，都会触发一次通知
    • 单次触发：仅状态改变时触发一次通知，如从正常状态改变为异常状态，或异常状态恢复为正常状态

    设置告警时执行任务 ​

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

    • 告警时触发任务 当告警状态符合从“正常”变更为“事件”时，所要执行的任务，任务应提前在任务页设置
    • 恢复时触发任务 当告警状态符合从“事件”恢复为“正常”时，所要执行的任务，任务应提前在任务页设置
    + \ No newline at end of file diff --git a/guide/q1.html b/guide/q1.html index 0b3d8b8f..e94db312 100644 --- a/guide/q1.html +++ b/guide/q1.html @@ -10,60 +10,61 @@ - + -
    哪吒监控

    简体中文

    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
    准备工作 ​
    如果你的 Dashboard 服务器无法访问 Telegram Bot API，但你依然想使用 Telegram 来推送通知，你可以尝试使用反向代理的方式解决这个问题。
    这里介绍使用你自己的服务器进行反代的方法。你也可以选择使用 Cloudflare 的 Workers 进行反代，但可能对于中国大陆的用户来说网络连通性依然不佳。
    要搭建一个 Telegram Bot API 反代，你需要准备以下内容：
    1. 一个可以连接 Telegram Bot API 服务器（并安装好 Nginx）。
    2. 一个域名（提前申请 SSL 证书）。
    NGINX 配置 ​
    编辑 Nginx 配置文件，在 http{} 中添加如下配置：
    nginx
    # HTTP 强制跳转到 HTTPS
 server {
     listen 80;
     listen [::]:80;
-    server_name yourDomainName;
+    server_name <yourDomainName>;
 
-    # Enforce HTTPS
+    # 强制 HTTPS
     return 301 https://$server_name$request_uri;
 }
-## https
+
+# HTTPS 配置
 server {
-        listen 443 ssl;
-        listen [::]:443 ssl;
+    listen 443 ssl;
+    listen [::]:443 ssl;
+    server_name <yourDomainName>;
 
-    server_name yourDomainName;
+    # SSL 证书路径
+    ssl_certificate </path/to/your/server.pem>;
+    ssl_certificate_key </path/to/your/server.key>;
 
-        ## ssl密钥路径自己改改
-	ssl_certificate server.pem;
-	ssl_certificate_key server.key;
+    # Root 非必要
+    root /var/www/tgbot/;
 
-        ## root非必要
-	root /var/www/tgbot/;
+    # 必须配置 DNS，否则会报 502 错误
+    resolver 8.8.8.8;
 
-        ## dns必须写，不然会报502错误
-        resolver 8.8.8.8;
+    # 以 /bot 开头的请求会被正则匹配
+    location ~* ^/bot {
+        proxy_buffering off;
+        proxy_pass  https://api.telegram.org$request_uri;
+        proxy_http_version 1.1;
+    }
 
-        ## 以bot开头的请求都会被正则匹配到
-        location ~* ^/bot {
-		proxy_buffering off;
-                proxy_pass  https://api.telegram.org$request_uri;
-                proxy_http_version 1.1;
-        }
+    # Root 非必要，主要用于确认服务器状态。也可以改为 return 403
+    location / {
+        try_files $uri $uri /index.html;
+    }
 
-        ## 和上面root一样非必要，这个主要是用来确认服务器状态的。也可以改成return 403
-	location /{ 
-		try_files /$uri $uri /index.html;
-	}
+    # 错误日志
+    error_log /var/log/tg.log error;
+}
    • yourDomainName：你准备的域名
    • ssl_certificate：SSL 证书路径
    • ssl_certificate_key：SSL 证书路径
    使用方式 ​
    执行 systemctl restart nginx 重启 Nginx。然后在 Nezha 中将原来的 https://api.telegram.org/ 替换为 https://<yourDomainName>/，即可正常推送消息。
    防止盗用 ​
    配置防火墙以防止他人盗用你的反代服务：
    • serverIp：Agent 的 IP 地址。根据你的系统选择适用的命令，ufw 或 iptables 均可。
    bash
    # Ubuntu
+ufw allow proto tcp from <serverIp> to any port 443
 
-        ## no log no fix
-        error_log    /var/log/tg.log  error;
-}
    yourDomainName - 你准备的域名
    ssl_certificate - SSL 证书路径
    ssl_certificate_key - SSL 证书路径

    使用方式 ​
    🎉然后执行 systemctl restart nginx 回到 Nezha 将原来的https://api.telegram.org/ 替换为 https://yourDomainName/ ,即可正常推送消息 
    防止盗用 ​
    serverIp - Agent 的 ip 地址,你系统安装的哪个就用哪个命令,ufw iptables 都可.
    bash
    #ubuntu
-ufw allow proto tcp from serverIp to any port 443
-#centos
+# 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 ba3a1c28..144a031b 100644 --- a/guide/q2.html +++ b/guide/q2.html @@ -10,16 +10,16 @@ - + -
    哪吒监控

    简体中文

    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 757faf98..8a8dfc53 100644 --- a/guide/q3.html +++ b/guide/q3.html @@ -10,14 +10,14 @@ - + -
    哪吒监控

    简体中文

    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 的域名
@@ -90,9 +90,9 @@
 localhost:~/agent# /opt/nezha/agent/nezha-agent -s nezha.xxx.xxx:443 -p YOUR_KEY --tls -d
 NEZHA@2023-12-20 05:14:00>> 检查更新： 0.15.14
 NEZHA@2023-12-20 05:14:01>> 上报系统信息失败： rpc error: code = Unknown desc = EOF # 需要修改主控端 /opt/nezha/dashboard/data/config.yaml的 GRPCHost 和 TLS 选项
-NEZHA@2023-12-20 05:14:01>> Error to close connection ...
    
-    
+NEZHA@2023-12-20 05:14:01>> Error to close connection ...
    + \ No newline at end of file diff --git a/guide/q4.html b/guide/q4.html index c37440af..79e3d6d8 100644 --- a/guide/q4.html +++ b/guide/q4.html @@ -10,16 +10,16 @@ - + -
    哪吒监控

    简体中文

    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 8a2697d2..0ed19814 100644 --- a/guide/q5.html +++ b/guide/q5.html @@ -10,16 +10,16 @@ - + -
    哪吒监控

    简体中文

    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 bee54c75..1e28c323 100644 --- a/guide/q6.html +++ b/guide/q6.html @@ -10,16 +10,16 @@ - + -
    哪吒监控

    简体中文

    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 18d5b0d4..c104d6ea 100644 --- a/guide/q7.html +++ b/guide/q7.html @@ -10,16 +10,16 @@ - + -
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

    自定义 Agent 监控项目 ​

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

    执行以下命令来选择自定义的网卡和分区，然后重启 Agent 即可生效：

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

    其他运行参数 ​

    通过执行以下命令查看支持的参数：

    bash
    ./nezha-agent --help

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

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

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

    自定义 Agent 监控项目 ​

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

    执行以下命令来选择自定义的网卡和分区，然后重启 Agent 即可生效：

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

    其他运行参数 ​

    通过执行以下命令查看支持的参数：

    bash
    ./nezha-agent --help

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

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

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

    相较于 Github，Cloudflare Access 对于中国大陆用户更加友好。如您当前使用 Github、Gitlab、Gitee 作为管理员账户登录时遇到问题，您可以考虑切换 Cloudflare Access 作为 OAuth2 提供方

    示例配置： ​

    yaml
    Oauth2:
+    
    哪吒监控
    简体中文
    English
    简体中文
    English
    Appearance
    On this page
    相较于 Github，Cloudflare Access 对于中国大陆用户更加友好。如您当前使用 Github、Gitlab、Gitee 作为管理员账户登录时遇到问题，您可以考虑切换 Cloudflare Access 作为 OAuth2 提供方
    示例配置： ​
    yaml
    Oauth2:
   Admin: 701b9ea6-9f56-48cd-af3e-cbb4bfc1475c
   ClientID: 3516291f53eca9b4901a01337e41be7dc52f565c8657d08a3fddb2178d13c5bf
   ClientSecret: 0568b67c7b6d0ed51c663e2fe935683007c28f947a27b7bd47a5ad3d8b56fb67
   Endpoint: "https://xxxxx.cloudflareaccess.com"
-  Type: cloudflare
    配置说明： ​
    参数获取方式
    AdminMy Team -> Users -> <具体用户> -> User ID
    ClientID/ClientSecretAccess -> Application -> Add an Application 
     -> SaaS -> OIDC
    EndpointAccess -> Application -> Application URL -> 只保留协议+域名的部分，路径不需要
    新建 SaaS-OIDC 应用流程 ​
    前往 Zero Trust Dashboard: https://one.dash.cloudflare.com
    1. My Team -> Users -> <具体用户> -> 获取 User ID 并保存；
    2. Access -> Application -> Add an Application;
    3. 选择 SaaS，在 Application 中输入自定义的应用名称（例如 nezha），选择 OIDC后点击 Add application;
    4. Scopes 选择 openid, email, profile, groups;
    5. Redirect URLs 填写你的 CallBack 地址，例如 https://dashboard.example.com/oauth2/callback;
    6. 记录 Client ID、Client Secret、Issuer 地址中协议与域名的部分，例如 https://xxxxx.cloudflareaccess.com
    7. 编辑 Dashboard 配置文件(通常在/opt/nezha/dashboard/data/config.yaml)，参考示例配置修改 Oauth2 配置，并重启 Dashboard 服务 
    身份验证策略配置 ​
    在完成 Dashboard 的设置后，您还需要在 Zero Trust Dashboard 中 Access-> Applications -> <应用名> -> Policies 配置验证策略。您可以选择包括邮件OTP验证、硬件密钥验证、等十多种 SSO 验证方式，详细配置请参考 Cloudflare Zero Trust 文档
    
-    
+  Type: cloudflare

    配置说明： ​

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

    新建 SaaS-OIDC 应用流程 ​

    前往 Zero Trust Dashboard: https://one.dash.cloudflare.com

    1. My Team -> Users -> <具体用户> -> 获取 User ID 并保存；
    2. Access -> Application -> Add an Application;
    3. 选择 SaaS，在 Application 中输入自定义的应用名称（例如 nezha），选择 OIDC后点击 Add application;
    4. Scopes 选择 openid, email, profile, groups;
    5. Redirect URLs 填写你的 CallBack 地址，例如 https://dashboard.example.com/oauth2/callback;
    6. 记录 Client ID、Client Secret、Issuer 地址中协议与域名的部分，例如 https://xxxxx.cloudflareaccess.com
    7. 编辑 Dashboard 配置文件(通常在/opt/nezha/dashboard/data/config.yaml)，参考示例配置修改 Oauth2 配置，并重启 Dashboard 服务

    身份验证策略配置 ​

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

    + \ No newline at end of file diff --git a/guide/servers.html b/guide/servers.html index b8610651..2016f3ec 100644 --- a/guide/servers.html +++ b/guide/servers.html @@ -10,14 +10,14 @@ - + -
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

    服务器 ​

    介绍 ​

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

    新增服务器 ​

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

    安装 Agent ​

    请参考前文安装 Agent
    推荐使用一键安装，即配置好参数后，点击服务器一键安装列上的对应的系统图标即可复制安装命令，在相应服务器上进行安装。

    强制更新 ​

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

    数据列 ​

    • 版本号: 记录 Agent 当前版本
    • 对游客隐藏： 为 True 时，游客在面板中无法查看到此服务器
    • 启用DDNS: 为 True 时，当该服务器IP发生变化，Dashboard 会自动更新 DNS 记录
    • DDNS域名：为该服务器配置的 DDNS 域名
    • 密钥: 即 secret\key，配置 Agent 时会用到，用于验证 Agent 与 Dashboard 的通信
    • 一键安装: 点击相应的系统按钮，复制命令到服务器执行即可一键安装
    • 管理: 分别为连接 WebShell，修改服务器配置，删除服务器

    在线终端 ​

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

    DDNS 功能 ​

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

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

    • 方便集中管理 DDNS 设置，而不是在每台机器上都部署一个 DDNS 服务
    • 仅在面板机上保存您的机密信息，防止外泄

    配置说明 ​

    目前 DDNS 功能支持两种形式的配置：单配置和多配置。如使用单配置，则所有 Agent 服务器都使用相同的配置更新 DDNS；如使用多配置，则可为每台服务器指定一个配置更新 DDNS，灵活性更强

    单配置 ​

    yaml
    DDNS:
+    
    哪吒监控
    简体中文
    English
    简体中文
    English
    Appearance
    On this page
    服务器 ​
    介绍 ​
    服务器区域负责管理 Agent，是哪吒探针中最基础的区域，也是其他功能的基础。
    新增服务器 ​
    第一步是新增服务器，可以自定义名称、分组、排序和备注。
     拥有相同分组的服务器会在受支持的主题中划分到一起进行显示，备注仅会在后台显示，无需担心泄露信息。
    安装 Agent ​
    请参考前文安装 Agent。
     推荐使用一键安装，即配置好参数后，点击服务器一键安装列上的对应的系统图标即可复制安装命令，在相应服务器上进行安装。
    强制更新 ​
    Agent 更新相关的参数是 自定义 Agent 监控项目 中的 --disable-auto-update 和 --disable-force-update。
     默认情况下，Agent 会自动更新，无需干预。但当用户关闭自动更新后，也可以选中指定服务器进行强制更新。
    disable-force-update 开启时此功能不生效。
    数据列 ​
    • 版本号：记录 Agent 当前版本。
    • 对游客隐藏：为 True 时，游客在面板中无法查看到此服务器。
    • 启用 DDNS：为 True 时，当该服务器 IP 发生变化，Dashboard 会自动更新 DNS 记录。
    • DDNS 域名：为该服务器配置的 DDNS 域名。
    • 密钥：即 secret/key，配置 Agent 时会用到，用于验证 Agent 与 Dashboard 的通信。
    • 一键安装：点击相应的系统按钮，复制命令到服务器执行即可一键安装。
    • 管理：分别为连接 WebShell，修改服务器配置，删除服务器。
    在线终端 ​
    即 WebShell，disable-command-execute 开启时此功能不生效。
     Linux 和 Windows 均可用，可使用 Ctrl+Shift+V 粘贴。
     连接失败请参考实时通道断开/在线终端连接失败。
     注意在线终端功能中，Agent 也是通过 WebSocket 连接到公开访问域名，而非通过 gRPC 交互。
    DDNS 功能 ​
    DDNS 功能适用于使用动态 IP 的服务器，当 Agent 上报了一个新的 IP，Dashboard 会根据配置自动更新 DNS 记录。
    为什么我要使用哪吒监控的 DDNS 功能？ ​
    • 方便集中管理 DDNS 设置，而不是在每台服务器上都部署一个 DDNS 服务。
    • 仅在面板服务器上保存您的机密信息，防止外泄。
    配置说明 ​
    目前 DDNS 功能支持两种形式的配置：单配置和多配置。如使用单配置，则所有 Agent 服务器都使用相同的配置更新 DDNS；如使用多配置，则可为每台服务器指定一个配置更新 DDNS，灵活性更强。
    单配置 ​
    yaml
    DDNS:
   Enable: true
   Provider: "webhook"
   AccessID: ""
@@ -27,24 +27,24 @@
   WebhookRequestBody: ""
   WebhookHeaders: ""
   MaxRetries: 3
-  Profiles: null
    • Enable 布尔值，选择是否开启 DDNS 功能
    • Provider DDNS 供应商的名称；目前支持 webhook、cloudflare 以及 tencentcloud
    • AccessID DDNS 供应商的令牌 ID；仅适用于供应商 tencentcloud
    • AccessSecret DDNS 供应商的令牌 Secret；仅适用于供应商 cloudflare 及 tencentcloud
    • WebhookMethod Webhook 的请求方法。例如 GET、POST等；仅适用于供应商 webhook
    • WebhookURL Webhook 的请求地址；仅适用于供应商 webhook
    • WebhookRequestBody Webhook 的请求体；仅适用于供应商 webhook
    • WebhookHeaders Webhook 的请求头；仅适用于供应商 webhook
    • MaxRetries当请求失败时，重试请求的次数
    • Profiles 多配置设定；在单配置设定中，此项忽略
    WebhookURL、WebhookRequestBody 以及WebhookHeaders可以包含以下参数：
    • {ip} - 主机当前IP
    • {domain} - ddns域名
    • {type} - IP类型，可能为"ipv4"和"ipv6"
    • {access_id} - 凭据1
    • {access_secret} - 凭据2
    配置示例：
    WebhookHeaders: |
-    a:{access_id}
-    b:{access_secret}
-WebhookRequestBody: '{"domain": "{domain}", "ip": "{ip}", "type": "{type}"}'

    多配置 ​
    当使用多配置时，请将 DDNS.Provider 留空。如 DDNS.Provider 的值不为空，多配置设定将被忽略
    yaml
    DDNS:
+  Profiles: null
    • Enable：布尔值，选择是否开启 DDNS 功能。
    • Provider：DDNS 供应商的名称；目前支持 webhook、cloudflare 以及 tencentcloud。
    • AccessID：DDNS 供应商的令牌 ID；仅适用于供应商 tencentcloud。
    • AccessSecret：DDNS 供应商的令牌 Secret；仅适用于供应商 cloudflare 及 tencentcloud。
    • WebhookMethod：Webhook 的请求方法。例如 GET、POST 等；仅适用于供应商 webhook。
    • WebhookURL：Webhook 的请求地址；仅适用于供应商 webhook。
    • WebhookRequestBody：Webhook 的请求体；仅适用于供应商 webhook。
    • WebhookHeaders：Webhook 的请求头；仅适用于供应商 webhook。
    • MaxRetries：当请求失败时，重试请求的次数。
    • Profiles：多配置设定；在单配置设定中，此项忽略。
    WebhookURL、WebhookRequestBody 以及 WebhookHeaders 可以包含以下参数：
    • {ip}：主机当前 IP。
    • {domain}：ddns 域名。
    • {type}：IP 类型，可能为 "ipv4" 和 "ipv6"。
    • {access_id}：凭据 1。
    • {access_secret}：凭据 2。
    配置示例：
    yaml
    WebhookHeaders: |
+    a:{access_id}
+    b:{access_secret}
+WebhookRequestBody: '{"domain": "{domain}", "ip": "{ip}", "type": "{type}"}'
    多配置 ​
    当使用多配置时，请将 DDNS.Provider 留空。如 DDNS.Provider 的值不为空，多配置设定将被忽略。
    yaml
    DDNS:
   Enable: true
   MaxRetries: 3
   Profiles:
-   example:
+    example:
       Provider: ""
       AccessID: ""
       AccessSecret: ""
       WebhookMethod: ""
       WebhookURL: ""
       WebhookRequestBody: ""
-      WebhookHeaders: ""
    • Profiles 多配置设定
    • example 可替换为 DDNS 配置名，可填任意字符串
    其它选项请参考单配置段。

    Dashboard 配置 ​
    修改配置文件后，还需要在 Dashboard 中修改服务器设置才能使 DDNS 生效


     DDNS 相关选项说明：
    • 启用DDNS 为此服务器启用 DDNS 功能
    • 启用DDNS IPv4 更新 DDNS 记录时，启用 IPv4 解析
    • 启用DDNS IPv6 更新 DDNS 记录时，启用 IPv6 解析
    • DDNS域名 记录指向的域名
    • DDNS配置 在多配置情况下，要使用的 DDNS 配置名
    WARNING
    在 Dashboard 设置中修改配置并保存时，会在 config.yaml 中填入默认配置选项，此时 DDNS 段中会同时存在单配置和多配置
    • 如需使用单配置，请配置DDNS.Provider，并忽略 Profiles 选项相关内容。
    • 如需使用多配置，请将 DDNS.Provider 留空。如 DDNS.Provider 的值不为空，多配置设定将被忽略。

    查看日志 ​
    在 Dashboard 的日志中，可以看到 DDNS 功能的相关日志，配置正确时，更新 DNS 记录时会有相应的日志记录。
    shell
    dashboard_1  | 2024/03/16 23:16:25 NEZHA>> 正在尝试更新域名(ddns.example.com)DDNS(1/3)
-dashboard_1  | 2024/03/16 23:16:28 NEZHA>> 尝试更新域名(ddns.example.com)DDNS成功
    
-    
+      WebhookHeaders: ""

    其它选项请参考单配置段。

    Dashboard 配置 ​

    修改配置文件后，还需要在 Dashboard 中修改服务器设置才能使 DDNS 生效。

    DDNS 相关选项说明：

    • 启用 DDNS：为此服务器启用 DDNS 功能。
    • 启用 DDNS IPv4：更新 DDNS 记录时，启用 IPv4 解析。
    • 启用 DDNS IPv6：更新 DDNS 记录时，启用 IPv6 解析。
    • DDNS 域名：记录指向的域名。
    • DDNS 配置：在多配置情况下，要使用的 DDNS 配置名。

    WARNING

    在 Dashboard 设置中修改配置并保存时，会在 config.yaml 中填入默认配置选项，此时 DDNS 段中会同时存在单配置和多配置。

    • 如需使用单配置，请配置 DDNS.Provider，并忽略 Profiles 选项相关内容。
    • 如需使用多配置，请将 DDNS.Provider 留空。如 DDNS.Provider 的值不为空，多配置设定将被忽略。

    查看日志 ​

    在 Dashboard 的日志中，可以看到 DDNS 功能的相关日志，配置正确时，更新 DNS 记录时会有相应的日志记录。

    shell
    dashboard_1  | 2024/03/16 23:16:25 NEZHA>> 正在尝试更新域名(ddns.example.com)DDNS(1/3)
+dashboard_1  | 2024/03/16 23:16:28 NEZHA>> 尝试更新域名(ddns.example.com)DDNS成功
    + \ No newline at end of file diff --git a/guide/services.html b/guide/services.html index 19d14896..01acc8e2 100644 --- a/guide/services.html +++ b/guide/services.html @@ -10,16 +10,16 @@ - + -
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

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

    使用方法 ​

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

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

    • 名称 - 自定义一个名称

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

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

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

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

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

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

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

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

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

    延迟变化告警 ​

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

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

    告警时触发任务 ​

    如果你需要在服务监控告警触发时执行一些任务，可以勾选 “启用触发任务” 并在“告警时触发任务”和“恢复时触发任务”中选择你已经提前设置好的触发任务

    网络延迟图表 ​

    在服务页中设置的 TCP-Ping 和 ICMP-Ping 类型的监控都会自动启用监控图表功能
    在主页的 “网络” 页中，你可以查看历史网络延迟监控图表
    图表中的数据是根据 Agent 到目标服务器的延迟统计而来，你可以点击 Agent 的名称来切换图表
    在图表中，可以取消勾选目标服务器的名称来隐藏或显示对应的数据

    管理监控 ​

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

    - +
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

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

    使用方法 ​

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

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

    • 名称：自定义一个名称。

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

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

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

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

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

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

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

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

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

    延迟变化告警 ​

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

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

    告警时触发任务 ​

    如果你需要在服务监控告警触发时执行一些任务，可以勾选“启用触发任务”，并在“告警时触发任务”和“恢复时触发任务”中选择你已经提前设置好的触发任务。

    网络延迟图表 ​

    在服务页中设置的 TCP-Ping 和 ICMP-Ping 类型的监控都会自动启用监控图表功能。在主页的“网络”页中，你可以查看历史网络延迟监控图表。图表中的数据是根据 Agent 到目标服务器的延迟统计而来，你可以点击 Agent 的名称来切换图表。在图表中，可以取消勾选目标服务器的名称来隐藏或显示对应的数据。

    管理监控 ​

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

    + \ No newline at end of file diff --git a/guide/settings.html b/guide/settings.html index 5ee79ca2..1aca7802 100644 --- a/guide/settings.html +++ b/guide/settings.html @@ -10,18 +10,283 @@ - + -
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    On this page

    站点标题 ​

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

    管理员列表 ​

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

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

    界面主题 ​

    在这里选择前台和后台界面主题，如果选项中没有某个已存在的主题，请更新面板
    启用 Custom 主题前，你需要在提前安装自定义主题，否则启用该项后，面板将无法正常显示

    Language ​

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

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

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

    自定义代码 ​

    可以在此修改 LOGO、修改色调、添加美化代码和统计代码等。

    WARNING

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


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

    html
    <style>
-.ui.fine.progress> .bar {
-    background-color: pink !important;
+    
    哪吒监控
    简体中文
    English
    简体中文
    English
    Appearance
    On this page
    站点标题 ​
    你可以在此项中自定义站点标题。
    管理员列表 ​
    • 如果你修改了自己的 Github、Gitlab 或 Gitee 的用户名，需要在此项中同步修改，否则无法登录。多个用户请用逗号隔开：user1,user2。
    • 如需更改管理员账户，请前往 /opt/nezha/dashboard/data/config.yaml，重新设置新的管理员 Client ID 和 Client Secret。
    界面主题 ​
    在这里选择主页和管理界面主题，如果选项中没有某个已存在的主题，请更新面板。
     启用 Custom 主题前，你需要提前安装自定义主题，否则启用该项后，面板将无法正常显示。
    Language ​
    哪吒监控目前支持以下语言：
    • 简体中文
    • 繁體中文
    • English
    • Español
    我们欢迎您对翻译进行勘误或贡献更多语言。
    自定义代码 (style, script) ​
    可以在此修改 LOGO、修改色调、添加美化代码和统计代码等。
    WARNING
    自定义代码仅在游客首页生效，管理面板不生效。由于不同主题的代码不同，如确需修改管理面板中的内容，请修改 Docker 中的主题文件。
    默认主题更改进度条颜色、背景图片、导航栏等效果示例 ​
    点击展开/收起
    html
    <style>
+/* 屏幕适配 */
+@media only screen and (min-width: 1200px) {
+    .ui.container {
+    width: 80% !important;
 }
-</style>
    DayNight 主题更改进度条颜色、修改页脚示例（来自 @hyt-allen-xu @tech-fever） ​
    html
    <style>
+}
+
+@media only screen and (max-width: 767px) {
+    .ui.card>.content>.header:not(.ui), .ui.cards>.card>.content>.header:not(.ui) {
+        margin-top: 0.4em !important;
+    }
+}
+
+/* 整体图标 */
+i.icon {
+    color: #000;
+    width: 1.2em !important;
+}
+
+/* 背景图片 */
+body {
+    content: " " !important;
+    background: fixed !important;
+    z-index: -1 !important;
+    top: 0 !important;
+    right: 0 !important;
+    bottom: 0 !important;
+    left: 0 !important;
+    background-position: top !important;
+    background-repeat: no-repeat !important;
+    background-size: cover !important;
+    background-image: url(https://backgroud.img) !important;
+    font-family: Arial,Helvetica,sans-serif !important;
+}
+
+/* 导航栏 */
+.ui.large.menu {
+    border: 0 !important;
+    border-radius: 0px !important;
+    background-color: rgba(255, 255, 255, 55%) !important;
+}
+
+/* 首页按钮 */
+.ui.menu .active.item {
+    background-color: transparent !important;
+}
+
+/* 导航栏下拉框 */
+.ui.dropdown .menu {
+    border: 0 !important;
+    border-radius: 0 !important;
+    background-color: rgba(255, 255, 255, 80%) !important;
+}
+
+/* 登录按钮 */
+.nezha-primary-btn {
+    background-color: transparent !important;
+    color: #000 !important;
+}
+
+/* 大卡片 */
+#app .ui.fluid.accordion {
+    background-color: #fbfbfb26 !important;
+    border-radius: 0.4rem !important;
+}
+
+/* 小卡片 */
+.ui.four.cards>.card {
+    border-radius: 0.6rem !important;
+    background-color: #fafafaa3 !important;
+}
+
+.status.cards .wide.column {
+    padding-top: 0 !important;
+    padding-bottom: 0 !important;
+    height: 3.3rem !important;
+}
+
+.status.cards .three.wide.column {
+    padding-right: 0rem !important;
+}
+
+.status.cards .wide.column:nth-child(1) {
+    margin-top: 2rem !important;
+}
+
+.status.cards .wide.column:nth-child(2) {
+    margin-top: 2rem !important;
+}
+
+.status.cards .description {
+    padding-bottom: 0 !important;
+}
+
+/* 服务器名 */
+.status.cards .flag {
+    margin-right: 0.5rem !important;
+}
+
+/* 弹出卡片图标 */
+.status.cards .header > .info.icon {
+    margin-right: 0 !important;
+}
+
+.nezha-secondary-font {
+    color: #2175ba !important;
+}
+
+/* 上传下载 */
+.status.cards .outline.icon {
+    margin-right: 1px !important;
+}
+
+i.arrow.alternate.circle.down.outline.icon {
+    color: #2175ba !important;
+}
+
+i.arrow.alternate.circle.up.outline.icon {
+    color: red !important;
+}
+
+/* 弹出卡片小箭头 */
+.ui.right.center.popup {
+    margin: -3px 0 0 0.914286em !important;
+    -webkit-transform-origin: left 50% !important;
+    transform-origin: left 50% !important;
+}
+
+.ui.bottom.left.popup {
+    margin-left: 1px !important;
+    margin-top: 3px !important;
+}
+
+.ui.top.left.popup {
+    margin-left: 0 !important;
+    margin-bottom: 10px !important;
+}
+
+.ui.top.right.popup {
+    margin-right: 0 !important;
+    margin-bottom: 8px !important;
+}
+
+.ui.left.center.popup {
+    margin: -3px .91428571em 0 0 !important;
+    -webkit-transform-origin: right 50% !important;
+    transform-origin: right 50% !important;
+}
+
+.ui.right.center.popup:before,
+.ui.left.center.popup:before {
+    border: 0px solid #fafafaeb !important;
+    background: #fafafaeb !important;
+}
+
+.ui.top.popup:before {
+    border-color: #fafafaeb transparent transparent !important;
+}
+
+.ui.popup:before {
+    border-color: #fafafaeb transparent transparent !important;
+}
+
+.ui.bottom.left.popup:before {
+    border-radius: 0 !important;
+    border: 1px solid transparent !important;
+    border-color: #fafafaeb transparent transparent !important;
+    background: #fafafaeb !important;
+    -webkit-box-shadow: 0px 0px 0 0 #fafafaeb !important;
+    box-shadow: 0px 0px 0 0 #fafafaeb !important;
+    -webkit-tap-highlight-color: rgba(0,0,0,0) !important;
+}
+
+.ui.bottom.right.popup:before {
+    border-radius: 0 !important;
+    border: 1px solid transparent !important;
+    border-color: #fafafaeb transparent transparent !important;
+    background: #fafafaeb !important
+    -webkit-box-shadow: 0px 0px 0 0 #fafafaeb !important;
+    box-shadow: 0px 0px 0 0 #fafafaeb !important;
+    -webkit-tap-highlight-color: rgba(0,0,0,0) !important;
+}
+
+.ui.top.left.popup:before {
+    border-radius: 0 !important;
+    border: 1px solid transparent !important;
+    border-color: #fafafaeb transparent transparent !important;
+    background: #fafafaeb !important;
+    -webkit-box-shadow: 0px 0px 0 0 #fafafaeb !important;
+    box-shadow: 0px 0px 0 0 #fafafaeb !important;
+    -webkit-tap-highlight-color: rgba(0,0,0,0) !important;
+}
+
+.ui.top.right.popup:before {
+    border-radius: 0 !important;
+    border: 1px solid transparent !important;
+    border-color: #fafafaeb transparent transparent !important;
+    background: #fafafaeb !important;
+    -webkit-box-shadow: 0px 0px 0 0 #fafafaeb !important;
+    box-shadow: 0px 0px 0 0 #fafafaeb !important;
+    -webkit-tap-highlight-color: rgba(0,0,0,0) !important;
+}
+
+.ui.left.center.popup:before {
+    border-radius: 0 !important;
+    border: 1px solid transparent !important;
+    border-color: #fafafaeb transparent transparent !important;
+    background: #fafafaeb !important;
+    -webkit-box-shadow: 0px 0px 0 0 #fafafaeb !important;
+    box-shadow: 0px 0px 0 0 #fafafaeb !important;
+    -webkit-tap-highlight-color: rgba(0,0,0,0) !important;
+}
+
+/* 弹出卡片 */
+.status.cards .ui.content.popup {
+    min-width: 20rem !important;
+    line-height: 2rem !important;
+    border-radius: 5px !important;
+    border: 1px solid transparent !important;
+    background-color: #fafafaeb !important;
+    font-family: Arial,Helvetica,sans-serif !important;
+}
+
+.ui.content {
+    margin: 0 !important;
+    padding: 1em !important;
+}
+
+/* 服务页 */
+.ui.table {
+    background: RGB(225,225,225,0.6) !important;
+}
+
+.ui.table thead th {
+    background: transparent !important;
+}
+
+/* 服务页进度条 */
+.service-status .good {
+    background-color: #2175ba !important;
+}
+
+.service-status .danger {
+    background-color: red !important;
+}
+
+.service-status .warning {
+    background-color: orange !important;
+}
+
+/* 版权 */
+.ui.inverted.segment, .ui.primary.inverted.segment {
+    color: #000 !important;
+    font-weight: bold !important;
+    background-color: #fafafaa3 !important;
+}
+</style>
+
+<!--Logo和版权-->
+<script>
+window.onload = function(){
+var avatar=document.querySelector(".item img")
+var footer=document.querySelector("div.is-size-7")
+footer.innerHTML="Copyright info"
+footer.style.visibility="visible"
+avatar.src="https:/img.src"
+avatar.style.visibility="visible"
+}
+</script>
    DayNight 主题更改进度条颜色、修改页脚示例（来自 @hyt-allen-xu @tech-fever） ​
    点击展开/收起
    html
    <style>
 .ui.fine.progress> .progress-bar {
   background-color: #00a7d0 !important;
 }
@@ -29,40 +294,40 @@
 
 <script>
 window.onload = function(){
-var avatar=document.querySelector("img")
-var footer=document.querySelector("div.footer-container")
-footer.innerHTML="©2021 你的名字 & Powered by 你的名字"
-footer.style.visibility="visible"
-avatar.src="你的图片连接"
-avatar.style.visibility="visible"
+  var avatar = document.querySelector("img");
+  var footer = document.querySelector("div.footer-container");
+  footer.innerHTML = "©2021 你的名字 & Powered by 你的名字";
+  footer.style.visibility = "visible";
+  avatar.src = "你的图片连接";
+  avatar.style.visibility = "visible";
 }
-</script>
    默认主题修改 LOGO、修改页脚示例（来自 @iLay1678） ​
    html
    <style>
-.right.menu>a{
-visibility: hidden;
+</script>
    默认主题修改 LOGO、修改页脚示例（来自 @iLay1678） ​
    点击展开/收起
    html
    <style>
+.right.menu>a {
+  visibility: hidden;
 }
-.footer .is-size-7{
-visibility: hidden;
+.footer .is-size-7 {
+  visibility: hidden;
 }
-.item img{
-visibility: hidden;
+.item img {
+  visibility: hidden;
 }
 </style>
 <script>
-window.onload = function(){
-var avatar=document.querySelector(".item img")
-var footer=document.querySelector("div.is-size-7")
-footer.innerHTML="Powered by 你的名字"
-footer.style.visibility="visible"
-avatar.src="你的方形logo地址"
-avatar.style.visibility="visible"
+window.onload = function() {
+  var avatar = document.querySelector(".item img");
+  var footer = document.querySelector("div.is-size-7");
+  footer.innerHTML = "Powered by 你的名字";
+  footer.style.visibility = "visible";
+  avatar.src = "你的方形 logo 地址";
+  avatar.style.visibility = "visible";
 }
-</script>
    hotaru 主题更改背景图片示例 ​
    html
    <style>
+</script>
    hotaru 主题更改背景图片示例 ​
    点击展开/收起
    html
    <style>
 .hotaru-cover {
    background: url(https://s3.ax1x.com/2020/12/08/DzHv6A.jpg) center;
 }
-</style>
    前台查看密码 ​
    如果你不想向游客直接展示你的主页，你可以在这里设置一个查看密码
     设置密码后，需要输入密码才可以访问主页

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

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

    通知中显示完整 IP 地址 ​
    IP 变更通知默认隐藏完整 IP，如果你不希望隐藏，可以勾选 “通知信息中显示完整 IP 地址”
    禁止前台切换模版 ​
    主页允许修改显示主题的功能默认启用，此功能只会影响单一用户，不会影响管理员在后台设置的启用主题 如果你不希望前台用户切换主题，可以勾选此项
    
-    
+</style>

    前台查看密码 ​

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

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

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

    IP 变更提醒 ​

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

    覆盖范围 ​

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

    特定服务器 ​

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

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

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

    WARNING

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

    通知中显示完整 IP 地址 ​

    IP 变更通知默认隐藏完整 IP，如果你不希望隐藏，可以勾选“通知信息中显示完整 IP 地址”。

    禁止主页切换主题 ​

    Dashboard 默认启用允许访客修改显示主题的功能，此功能只会影响单一访客，不会影响管理员在后台设置的启用主题。如果你不希望访客切换主题，可以勾选此项。

    + \ No newline at end of file diff --git a/guide/tasks.html b/guide/tasks.html index 06a83b45..d116445e 100644 --- a/guide/tasks.html +++ b/guide/tasks.html @@ -10,16 +10,16 @@ - + -
    哪吒监控

    简体中文

    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 5083d8d8..299005c8 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"en_us_guide_services.md":"3b071742","en_us_guide_q3.md":"03f3947b","guide_q5.md":"a1771b0d","case_index.md":"34edfc20","en_us_guide_q4.md":"00106501","en_us_guide_q5.md":"643849d0","developer_theme.md":"4bc5b9e8","en_us_case_case2.md":"fe2b9a39","en_us_case_case1.md":"70896d0c","en_us_case_case3.md":"e87df190","en_us_case_case4.md":"a582cf12","en_us_case_index.md":"084b2a58","en_us_guide_dashboard.md":"4a0aba5e","en_us_developer_l10n.md":"5e35de87","en_us_case_case5.md":"c70d768b","en_us_developer_index.md":"82004e0a","en_us_developer_theme.md":"083ee7bf","case_case2.md":"4fedd3fa","en_us_guide_tasks.md":"7814293d","en_us_index.md":"c6052ba8","en_us_guide_settings.md":"249d2b04","case_case5.md":"9d19446c","guide_agentq.md":"f47c5f1f","guide_api.md":"0c7cb75d","guide_q6.md":"174bc422","guide_loginq.md":"f2605818","guide_tasks.md":"e001ba83","developer_index.md":"1c7a4f33","guide_settings.md":"b188b382","en_us_guide_q6.md":"d5ec3148","guide_notifications.md":"14e27283","en_us_guide_servers.md":"37138307","case_case1.md":"9e690123","guide_dashboard.md":"2c916e4e","guide_dashboardq.md":"cf3e2a39","guide_q2.md":"0ca4adf1","index.md":"a459df05","guide_q7.md":"141de5f4","guide_q1.md":"ae8fc8b4","en_us_guide_q2.md":"aac93c3e","developer_l10n.md":"d048d5be","guide_q8.md":"617b79f1","guide_servers.md":"4770b6d0","en_us_guide_notifications.md":"87bdae76","en_us_guide_api.md":"131dd0ad","en_us_guide_dashboardq.md":"23258ad5","case_case4.md":"4bd8e019","case_case3.md":"52639ba5","en_us_guide_agentq.md":"ac6bf770","en_us_guide_loginq.md":"96aba06c","guide_q3.md":"858c21ef","en_us_guide_agent.md":"fc9616b9","en_us_guide_q7.md":"97f48840","guide_agent.md":"5eff83cf","guide_q4.md":"74288f11","guide_services.md":"ce9a07c0","en_us_guide_q8.md":"4a00dca6"} +{"case_index.md":"73e6bfcc","case_case1.md":"b0ffeb45","case_case3.md":"48bb8f95","case_case2.md":"ed3674ae","developer_l10n.md":"44af3a03","developer_index.md":"40e8edab","case_case5.md":"c6a30f74","case_case4.md":"622962b5","en_us_case_case3.md":"d6e1e0c9","en_us_case_case2.md":"3050bd1d","en_us_guide_dashboardq.md":"1d2992f0","en_us_guide_agentq.md":"8b51bd53","en_us_guide_dashboard.md":"f5ba44c9","en_us_developer_theme.md":"c6c2705e","en_us_case_case1.md":"68d4b8c0","en_us_guide_api.md":"ff18d057","en_us_case_index.md":"426c1c9c","developer_theme.md":"de32339f","en_us_guide_q4.md":"34457c09","en_us_guide_notifications.md":"da167b63","guide_agent.md":"c5504e5b","guide_q3.md":"ccf3ac7d","guide_agentq.md":"a7cf9dc4","guide_q6.md":"ddbb7fcc","guide_q4.md":"20d0f5c4","guide_q5.md":"4a1bad66","en_us_developer_index.md":"9ebb076b","guide_dashboardq.md":"5f436dce","en_us_developer_l10n.md":"13b00a40","en_us_guide_q7.md":"32e7f672","guide_q1.md":"9b7b06a4","en_us_case_case5.md":"0c5c8026","guide_q8.md":"d9f62b2a","en_us_case_case4.md":"5c1a6961","en_us_guide_q6.md":"b458d2f7","en_us_index.md":"1aa6edfc","en_us_guide_loginq.md":"da359af2","guide_loginq.md":"6ab914ff","en_us_guide_q8.md":"156ed04a","guide_dashboard.md":"224f2444","en_us_guide_q2.md":"890a5b8b","guide_tasks.md":"9d198fac","index.md":"c76cb732","guide_q7.md":"cba664b5","en_us_guide_tasks.md":"7f2837a8","en_us_guide_services.md":"522160e5","en_us_guide_q5.md":"b118b88f","guide_notifications.md":"1e97e129","en_us_guide_servers.md":"89212d49","guide_api.md":"4a4d6c33","guide_services.md":"1ae95d3e","en_us_guide_agent.md":"df49cb2f","guide_q2.md":"f3513918","en_us_guide_q3.md":"5dfcdcea","guide_servers.md":"9dbc33a5","en_us_guide_settings.md":"786426d1","guide_settings.md":"2309481e"} diff --git a/index.html b/index.html index 758f5cfc..0b812258 100644 --- a/index.html +++ b/index.html @@ -10,16 +10,16 @@ - + -
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    哪吒监控

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

    预览
    开始使用 →

    一键安装

    支持一键安装面板和监控服务，使用方便。主流系统包括Linux、Windows、MacOS、OpenWRT以及群晖均受支持

    实时监控

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

    轻松运维

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

    - +
    哪吒监控

    简体中文

    English

    简体中文

    English

    Appearance

    哪吒监控

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

    预览
    开始使用 →

    一键安装

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

    实时监控

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

    轻松运维

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

    + \ No newline at end of file