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

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

贡献者:

项目地址:nezha_api_tgbot

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

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

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

贡献者:

项目地址:nezha_api_tgbot

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

',5),_=[o];function i(c,n,p,l,h,d){return a(),t("div",null,_)}const u=e(s,[["render",i]]);export{m as __pageData,u as default}; diff --git a/assets/case_case1.md.Ywu6NP8Q.lean.js b/assets/case_case1.md.CihiTZQ_.lean.js similarity index 85% rename from assets/case_case1.md.Ywu6NP8Q.lean.js rename to assets/case_case1.md.CihiTZQ_.lean.js index ef9f27e83..dc3d66129 100644 --- a/assets/case_case1.md.Ywu6NP8Q.lean.js +++ b/assets/case_case1.md.CihiTZQ_.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1734681474000}'),s={name:"case/case1.md"},o=r("",5),_=[o];function i(c,n,p,l,h,d){return a(),t("div",null,_)}const u=e(s,[["render",i]]);export{m as __pageData,u as default}; +import{_ as e,c as t,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1734688054000}'),s={name:"case/case1.md"},o=r("",5),_=[o];function i(c,n,p,l,h,d){return a(),t("div",null,_)}const u=e(s,[["render",i]]);export{m as __pageData,u as default}; diff --git a/assets/case_case10.md.BXrcze-b.js b/assets/case_case10.md.CJzP9MVm.js similarity index 98% rename from assets/case_case10.md.BXrcze-b.js rename to assets/case_case10.md.CJzP9MVm.js index 0d2a38051..8202d65c5 100644 --- a/assets/case_case10.md.BXrcze-b.js +++ b/assets/case_case10.md.CJzP9MVm.js @@ -1 +1 @@ -import{_ as e,c as a,o as r,a4 as t}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Nezha Telegram Bot - NextGen V1","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case10.md","filePath":"case/case10.md","lastUpdated":1734681474000}'),o={name:"case/case10.md"},n=t('

Nezha Telegram Bot - NextGen V1

Nezha Telegram Bot - NextGen V1 是一个基于 Nezha 监控 API 的 Telegram 机器人,用于监控服务器状态。通过简单的命令,您可以实时查看服务器运行状态、资源使用情况,执行计划任务,并监控服务的可用性。


贡献者


主要特性

  1. 账号绑定
    安全绑定您的 Nezha 账户,确保数据隐私不被泄露。

  2. 多面板支持
    支持同时绑定多个 Dashboard,无缝管理不同面板中的服务器。

  3. 服务器概览
    查看所有服务器的在线状态、内存使用、交换空间、磁盘使用和网络流量等统计信息。

  4. 单服务器状态查询
    获取单个服务器的详细状态,包括负载、CPU 使用率、内存、磁盘、网络流量等。

  5. 计划任务管理
    查看并执行预设的计划任务,实现服务器的自动化管理。

  6. 服务可用性监控
    监控服务的可用性和平均延迟,确保服务稳定运行。

  7. 数据实时刷新
    支持实时刷新数据,确保获取到最新的服务器状态。


项目背景

此项目已由 白歌 捐赠给 NezhaHQ,作为社区项目继续维护和发展。


项目地址

GitHub 仓库:Nezha Telegram Bot - NextGen V1

',14),l=[n];function s(h,i,c,g,p,d){return r(),a("div",null,l)}const m=e(o,[["render",s]]);export{_ as __pageData,m as default}; +import{_ as e,c as a,o as r,a4 as t}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Nezha Telegram Bot - NextGen V1","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case10.md","filePath":"case/case10.md","lastUpdated":1734688054000}'),o={name:"case/case10.md"},n=t('

Nezha Telegram Bot - NextGen V1

Nezha Telegram Bot - NextGen V1 是一个基于 Nezha 监控 API 的 Telegram 机器人,用于监控服务器状态。通过简单的命令,您可以实时查看服务器运行状态、资源使用情况,执行计划任务,并监控服务的可用性。


贡献者


主要特性

  1. 账号绑定
    安全绑定您的 Nezha 账户,确保数据隐私不被泄露。

  2. 多面板支持
    支持同时绑定多个 Dashboard,无缝管理不同面板中的服务器。

  3. 服务器概览
    查看所有服务器的在线状态、内存使用、交换空间、磁盘使用和网络流量等统计信息。

  4. 单服务器状态查询
    获取单个服务器的详细状态,包括负载、CPU 使用率、内存、磁盘、网络流量等。

  5. 计划任务管理
    查看并执行预设的计划任务,实现服务器的自动化管理。

  6. 服务可用性监控
    监控服务的可用性和平均延迟,确保服务稳定运行。

  7. 数据实时刷新
    支持实时刷新数据,确保获取到最新的服务器状态。


项目背景

此项目已由 白歌 捐赠给 NezhaHQ,作为社区项目继续维护和发展。


项目地址

GitHub 仓库:Nezha Telegram Bot - NextGen V1

',14),l=[n];function s(h,i,c,g,p,d){return r(),a("div",null,l)}const m=e(o,[["render",s]]);export{_ as __pageData,m as default}; diff --git a/assets/case_case10.md.BXrcze-b.lean.js b/assets/case_case10.md.CJzP9MVm.lean.js similarity index 85% rename from assets/case_case10.md.BXrcze-b.lean.js rename to assets/case_case10.md.CJzP9MVm.lean.js index 9a2b6a423..7c4c08f61 100644 --- a/assets/case_case10.md.BXrcze-b.lean.js +++ b/assets/case_case10.md.CJzP9MVm.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as r,a4 as t}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Nezha Telegram Bot - NextGen V1","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case10.md","filePath":"case/case10.md","lastUpdated":1734681474000}'),o={name:"case/case10.md"},n=t("",14),l=[n];function s(h,i,c,g,p,d){return r(),a("div",null,l)}const m=e(o,[["render",s]]);export{_ as __pageData,m as default}; +import{_ as e,c as a,o as r,a4 as t}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Nezha Telegram Bot - NextGen V1","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case10.md","filePath":"case/case10.md","lastUpdated":1734688054000}'),o={name:"case/case10.md"},n=t("",14),l=[n];function s(h,i,c,g,p,d){return r(),a("div",null,l)}const m=e(o,[["render",s]]);export{_ as __pageData,m as default}; diff --git a/assets/case_case2.md.ByVgBvY8.js b/assets/case_case2.md.CrjuCbZS.js similarity index 97% rename from assets/case_case2.md.ByVgBvY8.js rename to assets/case_case2.md.CrjuCbZS.js index ddc7a2753..215044995 100644 --- a/assets/case_case2.md.ByVgBvY8.js +++ b/assets/case_case2.md.CrjuCbZS.js @@ -1 +1 @@ -import{_ as a}from"./chunks/qrcode.CZOxHFH-.js";import{_ as e,c as r,o as i,a4 as t}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1734681474000}'),o={name:"case/case2.md"},c=t('

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

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

获取快捷指令

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

coode

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

使用说明

WARNING

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

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

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

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

获取快捷指令

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

coode

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

使用说明

WARNING

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

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

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

贡献者:

项目地址:nezha_telegram_bot

项目特色

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

命令列表

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

效果展示

imageimage

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

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

贡献者:

项目地址:nezha_telegram_bot

项目特色

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

命令列表

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

效果展示

imageimage

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

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

INFO

此项目暂未适配 V1 版本 - 仅作纪念


2

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


今天开始!找回自信!

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


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


男人用了都说好:
6
4



1

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

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

INFO

此项目暂未适配 V1 版本 - 仅作纪念


2

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


今天开始!找回自信!

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


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


男人用了都说好:
6
4



1

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

使用 Argo 隧道的哪吒服务端

INFO

此项目暂未适配 V1 版本

贡献者:

项目地址: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_USERgithub 的用户名,用于面板管理授权
GH_CLIENTID在 github 上申请
GH_CLIENTSECRET在 github 上申请
GH_BACKUP_USER在 github 上备份哪吒服务端数据库的 github 用户名,不填则与面板管理授权的账户 GH_USER 一致
GH_REPO在 github 上备份哪吒服务端数据库文件的 github 库
GH_EMAILgithub 的邮箱,用于备份的 git 推送到远程库
GH_PATgithub 的 PAT
ARGO_AUTHJson: 从 https://fscarmen.cloudflare.now.cc 获取的 Argo Json
Token: 从 Cloudflare 官网获取
ARGO_DOMAINArgo 域名

Koyeb

Deploy to Koyeb

imageimageimageimageimage

VPS 部署方式 1 --- docker

docker 部署

docker run -dit \\
+import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1734688054000}'),n={name:"case/case5.md"},l=t(`

使用 Argo 隧道的哪吒服务端

INFO

此项目暂未适配 V1 版本

贡献者:

项目地址: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_USERgithub 的用户名,用于面板管理授权
GH_CLIENTID在 github 上申请
GH_CLIENTSECRET在 github 上申请
GH_BACKUP_USER在 github 上备份哪吒服务端数据库的 github 用户名,不填则与面板管理授权的账户 GH_USER 一致
GH_REPO在 github 上备份哪吒服务端数据库文件的 github 库
GH_EMAILgithub 的邮箱,用于备份的 git 推送到远程库
GH_PATgithub 的 PAT
ARGO_AUTHJson: 从 https://fscarmen.cloudflare.now.cc 获取的 Argo Json
Token: 从 Cloudflare 官网获取
ARGO_DOMAINArgo 域名

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.Q06oKkpC.lean.js b/assets/case_case5.md.DipT56HK.lean.js
similarity index 85%
rename from assets/case_case5.md.Q06oKkpC.lean.js
rename to assets/case_case5.md.DipT56HK.lean.js
index 9d65509f7..13f3d6509 100644
--- a/assets/case_case5.md.Q06oKkpC.lean.js
+++ b/assets/case_case5.md.DipT56HK.lean.js
@@ -1 +1 @@
-import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1734681474000}'),n={name:"case/case5.md"},l=t("",89),r=[l];function i(o,c,p,h,d,g){return s(),e("div",null,r)}const m=a(n,[["render",i]]);export{u as __pageData,m as default};
+import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1734688054000}'),n={name:"case/case5.md"},l=t("",89),r=[l];function i(o,c,p,h,d,g){return s(),e("div",null,r)}const m=a(n,[["render",i]]);export{u as __pageData,m as default};
diff --git a/assets/case_case6.md.DT9MDQps.js b/assets/case_case6.md.aLtIpBwA.js
similarity index 98%
rename from assets/case_case6.md.DT9MDQps.js
rename to assets/case_case6.md.aLtIpBwA.js
index a6d24c646..877d08aca 100644
--- a/assets/case_case6.md.DT9MDQps.js
+++ b/assets/case_case6.md.aLtIpBwA.js
@@ -1 +1 @@
-import{_ as e,c as a,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const s="/assets/Download_on_the_App_Store_Badge_CNSC_RGB_blk_092917.B6iCCvXs.svg",r="/assets/1.C2skUK08.png",i="/assets/2.BqfHYLGJ.png",l="/assets/3.D4KlWCds.png",k=JSON.parse('{"title":"Nezha Mobile - Nezha Dashboard 的 iOS 客户端","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case6.md","filePath":"case/case6.md","lastUpdated":1734681474000}'),n={name:"case/case6.md"},h=o('

Nezha Mobile - Nezha Dashboard 的 iOS 客户端

贡献者:

为项目作出贡献

项目地址

INFO

我们欢迎对项目的任何贡献,并将积极合并你的修改至下一次的Release,但我们可能会对不符合App Review Guidelines的内容(或潜在内容)进行一些修改。

从 App Store 下载

Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917

WARNING

App Store版本的Nezha Mobile由于ICP备案原因不在中国大陆提供服务。

TestFlight 测试计划

加入 TestFlight 测试

使用说明

  • 首次使用时你需要输入Dashboard链接用户名密码Dashboard链接形如server.hidandelion.com,不要添加协议头和末尾斜杠。 step1

配置小组件(可选)

  • 在Springboard添加小组件,长按后点击编辑小组件step2

  • 在随后的页面中选择一台你需要监控的服务器。你可以为多个小组件配置不同的服务器。 step3

',15),p=[h];function c(d,_,b,g,m,u){return t(),a("div",null,p)}const S=e(n,[["render",c]]);export{k as __pageData,S as default}; +import{_ as e,c as a,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const s="/assets/Download_on_the_App_Store_Badge_CNSC_RGB_blk_092917.B6iCCvXs.svg",r="/assets/1.C2skUK08.png",i="/assets/2.BqfHYLGJ.png",l="/assets/3.D4KlWCds.png",k=JSON.parse('{"title":"Nezha Mobile - Nezha Dashboard 的 iOS 客户端","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case6.md","filePath":"case/case6.md","lastUpdated":1734688054000}'),n={name:"case/case6.md"},h=o('

Nezha Mobile - Nezha Dashboard 的 iOS 客户端

贡献者:

为项目作出贡献

项目地址

INFO

我们欢迎对项目的任何贡献,并将积极合并你的修改至下一次的Release,但我们可能会对不符合App Review Guidelines的内容(或潜在内容)进行一些修改。

从 App Store 下载

Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917

WARNING

App Store版本的Nezha Mobile由于ICP备案原因不在中国大陆提供服务。

TestFlight 测试计划

加入 TestFlight 测试

使用说明

  • 首次使用时你需要输入Dashboard链接用户名密码Dashboard链接形如server.hidandelion.com,不要添加协议头和末尾斜杠。 step1

配置小组件(可选)

  • 在Springboard添加小组件,长按后点击编辑小组件step2

  • 在随后的页面中选择一台你需要监控的服务器。你可以为多个小组件配置不同的服务器。 step3

',15),p=[h];function c(d,_,b,g,m,u){return t(),a("div",null,p)}const S=e(n,[["render",c]]);export{k as __pageData,S as default}; diff --git a/assets/case_case6.md.DT9MDQps.lean.js b/assets/case_case6.md.aLtIpBwA.lean.js similarity index 89% rename from assets/case_case6.md.DT9MDQps.lean.js rename to assets/case_case6.md.aLtIpBwA.lean.js index 112ba0023..3b294487d 100644 --- a/assets/case_case6.md.DT9MDQps.lean.js +++ b/assets/case_case6.md.aLtIpBwA.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const s="/assets/Download_on_the_App_Store_Badge_CNSC_RGB_blk_092917.B6iCCvXs.svg",r="/assets/1.C2skUK08.png",i="/assets/2.BqfHYLGJ.png",l="/assets/3.D4KlWCds.png",k=JSON.parse('{"title":"Nezha Mobile - Nezha Dashboard 的 iOS 客户端","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case6.md","filePath":"case/case6.md","lastUpdated":1734681474000}'),n={name:"case/case6.md"},h=o("",15),p=[h];function c(d,_,b,g,m,u){return t(),a("div",null,p)}const S=e(n,[["render",c]]);export{k as __pageData,S as default}; +import{_ as e,c as a,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const s="/assets/Download_on_the_App_Store_Badge_CNSC_RGB_blk_092917.B6iCCvXs.svg",r="/assets/1.C2skUK08.png",i="/assets/2.BqfHYLGJ.png",l="/assets/3.D4KlWCds.png",k=JSON.parse('{"title":"Nezha Mobile - Nezha Dashboard 的 iOS 客户端","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case6.md","filePath":"case/case6.md","lastUpdated":1734688054000}'),n={name:"case/case6.md"},h=o("",15),p=[h];function c(d,_,b,g,m,u){return t(),a("div",null,p)}const S=e(n,[["render",c]]);export{k as __pageData,S as default}; diff --git a/assets/case_case7.md.Bi7B1OIM.js b/assets/case_case7.md.C8wRtfvt.js similarity index 95% rename from assets/case_case7.md.Bi7B1OIM.js rename to assets/case_case7.md.C8wRtfvt.js index 327d00c1b..15404aee6 100644 --- a/assets/case_case7.md.Bi7B1OIM.js +++ b/assets/case_case7.md.C8wRtfvt.js @@ -1 +1 @@ -import{_ as e,a as r}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as a,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Broker for Nezha - 拓展 Nezha 接入平台","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case7.md","filePath":"case/case7.md","lastUpdated":1734681474000}'),l={name:"case/case7.md"},n=i('

Broker for Nezha - 拓展 Nezha 接入平台

贡献者:

Broker for Nezha 是一个 Nezha Agent 的修改版本,其通过分离 Agent 的数据收集和 gRPC 上报功能,可使小型设备接入 Nezha Dashboard。

项目地址:https://codeberg.org/uubulb/broker

文档:Broker for Nezha

与原项目的不同

  • 使用外置数据源,而不是从本地获取。
  • 多数据源与多面板支持
  • 仅支持部分任务类型,可参考项目 README 获取详细信息。

Broker for Nezha 需要与特定的数据收集软件一同使用。目前提供两种数据获取方式:

  1. HTTP 主动获取(HTTP/1.1)
  2. TCP 被动获取(推荐)

如需获取现有的数据收集软件,可以参考项目 README。

因数据获取方式缺乏安全性,建议仅在信任的网络环境使用。

编写数据收集端

如需自行编写数据收集端,除实现基本 HTTP 服务器或 TCP 客户端外,还需要使用特定的数据格式才可被 Broker 正常接收。具体请参考:数据类型

效果参考

Dashboard
Dashboard

WebSSH
WebSSH
',18),s=[n];function h(c,p,u,f,_,b){return o(),t("div",null,s)}const m=a(l,[["render",h]]);export{k as __pageData,m as default}; +import{_ as e,a as r}from"./chunks/webssh.C2tqG0xr.js";import{_ as a,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Broker for Nezha - 拓展 Nezha 接入平台","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case7.md","filePath":"case/case7.md","lastUpdated":1734688054000}'),l={name:"case/case7.md"},n=i('

Broker for Nezha - 拓展 Nezha 接入平台

贡献者:

Broker for Nezha 是一个 Nezha Agent 的修改版本,其通过分离 Agent 的数据收集和 gRPC 上报功能,可使小型设备接入 Nezha Dashboard。

项目地址:https://codeberg.org/uubulb/broker

文档:Broker for Nezha

与原项目的不同

  • 使用外置数据源,而不是从本地获取。
  • 多数据源与多面板支持
  • 仅支持部分任务类型,可参考项目 README 获取详细信息。

Broker for Nezha 需要与特定的数据收集软件一同使用。目前提供两种数据获取方式:

  1. HTTP 主动获取(HTTP/1.1)
  2. TCP 被动获取(推荐)

如需获取现有的数据收集软件,可以参考项目 README。

因数据获取方式缺乏安全性,建议仅在信任的网络环境使用。

编写数据收集端

如需自行编写数据收集端,除实现基本 HTTP 服务器或 TCP 客户端外,还需要使用特定的数据格式才可被 Broker 正常接收。具体请参考:数据类型

效果参考

Dashboard
Dashboard

WebSSH
WebSSH
',18),s=[n];function h(c,p,u,f,_,b){return o(),t("div",null,s)}const m=a(l,[["render",h]]);export{k as __pageData,m as default}; diff --git a/assets/case_case7.md.Bi7B1OIM.lean.js b/assets/case_case7.md.C8wRtfvt.lean.js similarity index 74% rename from assets/case_case7.md.Bi7B1OIM.lean.js rename to assets/case_case7.md.C8wRtfvt.lean.js index 232989f6e..67f6fd278 100644 --- a/assets/case_case7.md.Bi7B1OIM.lean.js +++ b/assets/case_case7.md.C8wRtfvt.lean.js @@ -1 +1 @@ -import{_ as e,a as r}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as a,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Broker for Nezha - 拓展 Nezha 接入平台","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case7.md","filePath":"case/case7.md","lastUpdated":1734681474000}'),l={name:"case/case7.md"},n=i("",18),s=[n];function h(c,p,u,f,_,b){return o(),t("div",null,s)}const m=a(l,[["render",h]]);export{k as __pageData,m as default}; +import{_ as e,a as r}from"./chunks/webssh.C2tqG0xr.js";import{_ as a,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Broker for Nezha - 拓展 Nezha 接入平台","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case7.md","filePath":"case/case7.md","lastUpdated":1734688054000}'),l={name:"case/case7.md"},n=i("",18),s=[n];function h(c,p,u,f,_,b){return o(),t("div",null,s)}const m=a(l,[["render",h]]);export{k as __pageData,m as default}; diff --git a/assets/case_case8.md.Gqb44HV5.js b/assets/case_case8.md.QybEfBz0.js similarity index 98% rename from assets/case_case8.md.Gqb44HV5.js rename to assets/case_case8.md.QybEfBz0.js index a9e689203..59f4c2317 100644 --- a/assets/case_case8.md.Gqb44HV5.js +++ b/assets/case_case8.md.QybEfBz0.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a4 as l}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Serverless 哪吒 Telegram 机器人","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case8.md","filePath":"case/case8.md","lastUpdated":1734681474000}'),r={name:"case/case8.md"},t=l('

Serverless 哪吒 Telegram 机器人

贡献者:

项目地址:https://github.com/swkisdust/plain-nezha-bot

单用户单面板多语言私聊哪吒 Telegram 机器人,可以在 Cloudflare Workers 上部署。

Inspired by https://github.com/nezhahq/Nezha-Telegram-Bot-V1

部署

  1. Clone 本项目,运行 npm install 安装依赖。
  2. 用你喜欢的方式创建一个 Workers KV 命名空间,保存下 ID。
  3. 修改 wrangler.toml,将 kv_namespaces 字段改为你创建的 KV 信息。
  4. 修改 wrangler.toml 中的 vars
  • NZ_BASEURL:面板地址,例如 https://qio.ng
  • LANG:语言,可选 en zh-CN,默认为 en
  • ENDPOINT_PATH:接收 Telegram Webhook 的路由路径,例如 /endpoint
  1. 创建以下 Secrets:
  • TELEGRAM_BOT_TOKEN:从 BotFather 那里获取的机器人 Token。
  • TELEGRAM_SECRET:Webhook 认证密钥。
  • TELEGRAM_UID:用户 UID,机器人将不会与除此 UID 外的任何人互动。
  • PASSWORD:基本认证密码,用于进行 注册 / 取消注册 / 刷新 Token 操作。
  • NZ_USERNAME:面板用户名,用于初次认证及后续刷新。
  • NZ_PASSWORD:面板密码,用于初次认证及后续刷新。
  1. 输入 npx wrangler deploy 部署项目。

使用

访问 /register 路由注册 Webhook 即可开始使用。

如暂时不需使用,可以访问 /unregister 删除 Webhook。

默认每 30 分钟触发一次 Token 刷新操作,可以在 wrangler.toml 中手动修改,或是访问 /refresh 手动刷新。

',16),c=[t];function d(i,s,n,h,p,_){return a(),o("div",null,c)}const g=e(r,[["render",d]]);export{m as __pageData,g as default}; +import{_ as e,c as o,o as a,a4 as l}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Serverless 哪吒 Telegram 机器人","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case8.md","filePath":"case/case8.md","lastUpdated":1734688054000}'),r={name:"case/case8.md"},t=l('

Serverless 哪吒 Telegram 机器人

贡献者:

项目地址:https://github.com/swkisdust/plain-nezha-bot

单用户单面板多语言私聊哪吒 Telegram 机器人,可以在 Cloudflare Workers 上部署。

Inspired by https://github.com/nezhahq/Nezha-Telegram-Bot-V1

部署

  1. Clone 本项目,运行 npm install 安装依赖。
  2. 用你喜欢的方式创建一个 Workers KV 命名空间,保存下 ID。
  3. 修改 wrangler.toml,将 kv_namespaces 字段改为你创建的 KV 信息。
  4. 修改 wrangler.toml 中的 vars
  • NZ_BASEURL:面板地址,例如 https://qio.ng
  • LANG:语言,可选 en zh-CN,默认为 en
  • ENDPOINT_PATH:接收 Telegram Webhook 的路由路径,例如 /endpoint
  1. 创建以下 Secrets:
  • TELEGRAM_BOT_TOKEN:从 BotFather 那里获取的机器人 Token。
  • TELEGRAM_SECRET:Webhook 认证密钥。
  • TELEGRAM_UID:用户 UID,机器人将不会与除此 UID 外的任何人互动。
  • PASSWORD:基本认证密码,用于进行 注册 / 取消注册 / 刷新 Token 操作。
  • NZ_USERNAME:面板用户名,用于初次认证及后续刷新。
  • NZ_PASSWORD:面板密码,用于初次认证及后续刷新。
  1. 输入 npx wrangler deploy 部署项目。

使用

访问 /register 路由注册 Webhook 即可开始使用。

如暂时不需使用,可以访问 /unregister 删除 Webhook。

默认每 30 分钟触发一次 Token 刷新操作,可以在 wrangler.toml 中手动修改,或是访问 /refresh 手动刷新。

',16),c=[t];function d(i,s,n,h,p,_){return a(),o("div",null,c)}const g=e(r,[["render",d]]);export{m as __pageData,g as default}; diff --git a/assets/case_case8.md.Gqb44HV5.lean.js b/assets/case_case8.md.QybEfBz0.lean.js similarity index 85% rename from assets/case_case8.md.Gqb44HV5.lean.js rename to assets/case_case8.md.QybEfBz0.lean.js index cc5dd5889..148456ece 100644 --- a/assets/case_case8.md.Gqb44HV5.lean.js +++ b/assets/case_case8.md.QybEfBz0.lean.js @@ -1 +1 @@ -import{_ as e,c as o,o as a,a4 as l}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Serverless 哪吒 Telegram 机器人","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case8.md","filePath":"case/case8.md","lastUpdated":1734681474000}'),r={name:"case/case8.md"},t=l("",16),c=[t];function d(i,s,n,h,p,_){return a(),o("div",null,c)}const g=e(r,[["render",d]]);export{m as __pageData,g as default}; +import{_ as e,c as o,o as a,a4 as l}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Serverless 哪吒 Telegram 机器人","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case8.md","filePath":"case/case8.md","lastUpdated":1734688054000}'),r={name:"case/case8.md"},t=l("",16),c=[t];function d(i,s,n,h,p,_){return a(),o("div",null,c)}const g=e(r,[["render",d]]);export{m as __pageData,g as default}; diff --git a/assets/case_case9.md.C4P62Hck.js b/assets/case_case9.md.D54ioPzT.js similarity index 97% rename from assets/case_case9.md.C4P62Hck.js rename to assets/case_case9.md.D54ioPzT.js index 46f45b2f7..1b0001710 100644 --- a/assets/case_case9.md.C4P62Hck.js +++ b/assets/case_case9.md.D54ioPzT.js @@ -1 +1 @@ -import{_ as a,a as e,b as t,c as r}from"./chunks/4.Cnd9Q6Vo.js";import{_ as s,c as i,o as n,a4 as o}from"./chunks/framework.BmdFiWrL.js";const P=JSON.parse('{"title":"MDPings - Nezha Dashboard 的 Android 客户端","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case9.md","filePath":"case/case9.md","lastUpdated":1734681474000}'),l={name:"case/case9.md"},h=o('

MDPings - Nezha Dashboard 的 Android 客户端

MDPings 是一个基于 Nezha 监控 API 开发的 Android 客户端,采用 Material Design 3(MD3)风格,支持多服务器状态监控,提供历史网络状态和延迟图表,并可通过设备终端执行简单的弱交互式命令。


贡献者


主要功能

  1. 多 Dashboard 切换

    • 支持同时连接多个 Nezha Dashboard 面板,自由切换。
  2. 总流量监控

    • 轻松查看所有服务器的总流量统计数据。
  3. SSH 终端支持

    • 通过终端执行简单的命令(需 Nezha Dashboard 启用 SSH 连接功能)。
  4. MD3 风格设计

    • 采用 Material Design 3,自适应多设备布局。

应用界面

Screenshot 1Screenshot 2Screenshot 3Screenshot 4

项目地址

GitHub - MDPings


下载地址

Releases - MDPings

',17),d=[h];function c(g,_,p,u,b,m){return n(),i("div",null,d)}const x=s(l,[["render",c]]);export{P as __pageData,x as default}; +import{_ as a,a as e,b as t,c as r}from"./chunks/4.Cnd9Q6Vo.js";import{_ as s,c as i,o as n,a4 as o}from"./chunks/framework.BmdFiWrL.js";const P=JSON.parse('{"title":"MDPings - Nezha Dashboard 的 Android 客户端","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case9.md","filePath":"case/case9.md","lastUpdated":1734688054000}'),l={name:"case/case9.md"},h=o('

MDPings - Nezha Dashboard 的 Android 客户端

MDPings 是一个基于 Nezha 监控 API 开发的 Android 客户端,采用 Material Design 3(MD3)风格,支持多服务器状态监控,提供历史网络状态和延迟图表,并可通过设备终端执行简单的弱交互式命令。


贡献者


主要功能

  1. 多 Dashboard 切换

    • 支持同时连接多个 Nezha Dashboard 面板,自由切换。
  2. 总流量监控

    • 轻松查看所有服务器的总流量统计数据。
  3. SSH 终端支持

    • 通过终端执行简单的命令(需 Nezha Dashboard 启用 SSH 连接功能)。
  4. MD3 风格设计

    • 采用 Material Design 3,自适应多设备布局。

应用界面

Screenshot 1Screenshot 2Screenshot 3Screenshot 4

项目地址

GitHub - MDPings


下载地址

Releases - MDPings

',17),d=[h];function c(g,_,p,u,b,m){return n(),i("div",null,d)}const x=s(l,[["render",c]]);export{P as __pageData,x as default}; diff --git a/assets/case_case9.md.C4P62Hck.lean.js b/assets/case_case9.md.D54ioPzT.lean.js similarity index 87% rename from assets/case_case9.md.C4P62Hck.lean.js rename to assets/case_case9.md.D54ioPzT.lean.js index bcdc48fb4..076270d3c 100644 --- a/assets/case_case9.md.C4P62Hck.lean.js +++ b/assets/case_case9.md.D54ioPzT.lean.js @@ -1 +1 @@ -import{_ as a,a as e,b as t,c as r}from"./chunks/4.Cnd9Q6Vo.js";import{_ as s,c as i,o as n,a4 as o}from"./chunks/framework.BmdFiWrL.js";const P=JSON.parse('{"title":"MDPings - Nezha Dashboard 的 Android 客户端","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case9.md","filePath":"case/case9.md","lastUpdated":1734681474000}'),l={name:"case/case9.md"},h=o("",17),d=[h];function c(g,_,p,u,b,m){return n(),i("div",null,d)}const x=s(l,[["render",c]]);export{P as __pageData,x as default}; +import{_ as a,a as e,b as t,c as r}from"./chunks/4.Cnd9Q6Vo.js";import{_ as s,c as i,o as n,a4 as o}from"./chunks/framework.BmdFiWrL.js";const P=JSON.parse('{"title":"MDPings - Nezha Dashboard 的 Android 客户端","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"case/case9.md","filePath":"case/case9.md","lastUpdated":1734688054000}'),l={name:"case/case9.md"},h=o("",17),d=[h];function c(g,_,p,u,b,m){return n(),i("div",null,d)}const x=s(l,[["render",c]]);export{P as __pageData,x as default}; diff --git a/assets/case_index.md.DAv4YERW.js b/assets/case_index.md.B1h9EbIM.js similarity index 94% rename from assets/case_index.md.DAv4YERW.js rename to assets/case_index.md.B1h9EbIM.js index 863913f4f..bbccb3347 100644 --- a/assets/case_index.md.DAv4YERW.js +++ b/assets/case_index.md.B1h9EbIM.js @@ -1 +1 @@ -import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1734681474000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return a(),t("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default}; +import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1734688054000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return a(),t("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default}; diff --git a/assets/case_index.md.DAv4YERW.lean.js b/assets/case_index.md.B1h9EbIM.lean.js similarity index 94% rename from assets/case_index.md.DAv4YERW.lean.js rename to assets/case_index.md.B1h9EbIM.lean.js index 863913f4f..bbccb3347 100644 --- a/assets/case_index.md.DAv4YERW.lean.js +++ b/assets/case_index.md.B1h9EbIM.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1734681474000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return a(),t("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default}; +import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1734688054000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return a(),t("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default}; diff --git a/assets/chunks/webssh.C2tqG0xr.js b/assets/chunks/webssh.C2tqG0xr.js new file mode 100644 index 000000000..1bad6c17c --- /dev/null +++ b/assets/chunks/webssh.C2tqG0xr.js @@ -0,0 +1 @@ +const s="/assets/dashboard.BAoU196N.jpg",t="/assets/webssh.FtLRQxTx.jpg";export{s as _,t as a}; diff --git a/assets/chunks/webssh.Cvv4PsOJ.js b/assets/chunks/webssh.Cvv4PsOJ.js deleted file mode 100644 index 0c7f307b5..000000000 --- a/assets/chunks/webssh.Cvv4PsOJ.js +++ /dev/null @@ -1 +0,0 @@ -const s="/assets/dashboard.BtVFv_j9.jpg",t="/assets/webssh.DHR7F3te.jpg";export{s as _,t as a}; diff --git a/assets/dashboard.BAoU196N.jpg b/assets/dashboard.BAoU196N.jpg new file mode 100644 index 000000000..92487399b Binary files /dev/null and b/assets/dashboard.BAoU196N.jpg differ diff --git a/assets/dashboard.BtVFv_j9.jpg b/assets/dashboard.BtVFv_j9.jpg deleted file mode 100644 index e9065eef9..000000000 Binary files a/assets/dashboard.BtVFv_j9.jpg and /dev/null differ diff --git a/assets/developer_api.md.hXENdb8P.js b/assets/developer_api.md.CMPYWCfO.js similarity index 98% rename from assets/developer_api.md.hXENdb8P.js rename to assets/developer_api.md.CMPYWCfO.js index e01ea1848..fab0aa923 100644 --- a/assets/developer_api.md.hXENdb8P.js +++ b/assets/developer_api.md.CMPYWCfO.js @@ -1,2 +1,2 @@ -import{_ as a,c as s,o as i,a4 as e}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"API 文档","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"developer/api.md","filePath":"developer/api.md","lastUpdated":1734681474000}'),t={name:"developer/api.md"},n=e(`

API 文档

Nezha Dashboard 提供了丰富的 API 文档,开发者可以基于这些 API 构建自定义应用,例如自定义前端界面、机器人等。


使用说明

获取和生成文档

  1. 克隆代码仓库
    从官方仓库克隆代码:

    bash
    git clone https://github.com/nezhahq/nezha.git
    +import{_ as a,c as s,o as i,a4 as e}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"API 文档","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"developer/api.md","filePath":"developer/api.md","lastUpdated":1734688054000}'),t={name:"developer/api.md"},n=e(`

    API 文档

    Nezha Dashboard 提供了丰富的 API 文档,开发者可以基于这些 API 构建自定义应用,例如自定义前端界面、机器人等。


    使用说明

    获取和生成文档

    1. 克隆代码仓库
      从官方仓库克隆代码:

      bash
      git clone https://github.com/nezhahq/nezha.git
       cd nezha
    2. 运行文档生成脚本
      执行以下脚本以生成 API 文档所需的相关文件:

      bash
      ./script/bootstrap.sh
    3. 编译代码
      如果在编译过程中提示 admin-distuser-dist 文件夹不存在,可以通过创建空文件夹解决:

      bash
      mkdir -p dashboard/admin-dist dashboard/user-dist
    4. 启用 Debug 模式
      修改配置文件,启用 Debug 模式并运行 dashboard
      系统日志会自动输出 API 文档的访问地址。

    `,6),h=[n];function p(l,d,o,r,c,k){return i(),s("div",null,h)}const u=a(t,[["render",p]]);export{b as __pageData,u as default}; diff --git a/assets/developer_api.md.hXENdb8P.lean.js b/assets/developer_api.md.CMPYWCfO.lean.js similarity index 85% rename from assets/developer_api.md.hXENdb8P.lean.js rename to assets/developer_api.md.CMPYWCfO.lean.js index 5769e500f..ee91e4edd 100644 --- a/assets/developer_api.md.hXENdb8P.lean.js +++ b/assets/developer_api.md.CMPYWCfO.lean.js @@ -1 +1 @@ -import{_ as a,c as s,o as i,a4 as e}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"API 文档","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"developer/api.md","filePath":"developer/api.md","lastUpdated":1734681474000}'),t={name:"developer/api.md"},n=e("",6),h=[n];function p(l,d,o,r,c,k){return i(),s("div",null,h)}const u=a(t,[["render",p]]);export{b as __pageData,u as default}; +import{_ as a,c as s,o as i,a4 as e}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"API 文档","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"developer/api.md","filePath":"developer/api.md","lastUpdated":1734688054000}'),t={name:"developer/api.md"},n=e("",6),h=[n];function p(l,d,o,r,c,k){return i(),s("div",null,h)}const u=a(t,[["render",p]]);export{b as __pageData,u as default}; diff --git a/assets/developer_i18n.md.BNsE_8Wh.js b/assets/developer_i18n.md.BhXEaJqR.js similarity index 63% rename from assets/developer_i18n.md.BNsE_8Wh.js rename to assets/developer_i18n.md.BhXEaJqR.js index 05a9b2c5b..26c4e8a6e 100644 --- a/assets/developer_i18n.md.BNsE_8Wh.js +++ b/assets/developer_i18n.md.BhXEaJqR.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a4 as r}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"国际化 (i18n)","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"developer/i18n.md","filePath":"developer/i18n.md","lastUpdated":1734681474000}'),o={name:"developer/i18n.md"},n=r('

    国际化 (i18n)

    简介

    您可以通过 Hosted Weblate 参与 Nezha 的国际化翻译工作。

    支持范围

    目前国际化工作主要覆盖了 管理前端Dashboard 的内容。
    如需对 用户前端 进行国际化,请参考原始代码仓库中提供的相关步骤完成翻译。

    ',5),s=[n];function i(d,l,_,h,c,p){return t(),a("div",null,s)}const u=e(o,[["render",i]]);export{m as __pageData,u as default}; +import{_ as e,c as a,o as t,a4 as r}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"国际化 (i18n)","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"developer/i18n.md","filePath":"developer/i18n.md","lastUpdated":1734688054000}'),o={name:"developer/i18n.md"},n=r('

    国际化 (i18n)

    简介

    您可以通过 Hosted Weblate 参与 Nezha 的国际化翻译工作。

    支持范围

    哪吒面板端所有相关项目,包括 Nezha用户前端管理前端

    ',5),s=[n];function i(d,l,_,h,c,p){return t(),a("div",null,s)}const u=e(o,[["render",i]]);export{m as __pageData,u as default}; diff --git a/assets/developer_i18n.md.BNsE_8Wh.lean.js b/assets/developer_i18n.md.BhXEaJqR.lean.js similarity index 85% rename from assets/developer_i18n.md.BNsE_8Wh.lean.js rename to assets/developer_i18n.md.BhXEaJqR.lean.js index da11e7570..fe523b764 100644 --- a/assets/developer_i18n.md.BNsE_8Wh.lean.js +++ b/assets/developer_i18n.md.BhXEaJqR.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a4 as r}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"国际化 (i18n)","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"developer/i18n.md","filePath":"developer/i18n.md","lastUpdated":1734681474000}'),o={name:"developer/i18n.md"},n=r("",5),s=[n];function i(d,l,_,h,c,p){return t(),a("div",null,s)}const u=e(o,[["render",i]]);export{m as __pageData,u as default}; +import{_ as e,c as a,o as t,a4 as r}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"国际化 (i18n)","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"developer/i18n.md","filePath":"developer/i18n.md","lastUpdated":1734688054000}'),o={name:"developer/i18n.md"},n=r("",5),s=[n];function i(d,l,_,h,c,p){return t(),a("div",null,s)}const u=e(o,[["render",i]]);export{m as __pageData,u as default}; diff --git a/assets/developer_index.md.07Ytp7Q1.js b/assets/developer_index.md.DNkAIAnI.js similarity index 92% rename from assets/developer_index.md.07Ytp7Q1.js rename to assets/developer_index.md.DNkAIAnI.js index 3edea9274..d82e837eb 100644 --- a/assets/developer_index.md.07Ytp7Q1.js +++ b/assets/developer_index.md.DNkAIAnI.js @@ -1 +1 @@ -import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/api"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1734681474000}'),r={name:"developer/index.md"};function n(o,i,s,d,l,c){return a(),t("div")}const _=e(r,[["render",n]]);export{m as __pageData,_ as default}; +import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/api"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1734688054000}'),r={name:"developer/index.md"};function n(o,i,s,d,l,c){return a(),t("div")}const _=e(r,[["render",n]]);export{m as __pageData,_ as default}; diff --git a/assets/developer_index.md.07Ytp7Q1.lean.js b/assets/developer_index.md.DNkAIAnI.lean.js similarity index 92% rename from assets/developer_index.md.07Ytp7Q1.lean.js rename to assets/developer_index.md.DNkAIAnI.lean.js index 3edea9274..d82e837eb 100644 --- a/assets/developer_index.md.07Ytp7Q1.lean.js +++ b/assets/developer_index.md.DNkAIAnI.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/api"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1734681474000}'),r={name:"developer/index.md"};function n(o,i,s,d,l,c){return a(),t("div")}const _=e(r,[["render",n]]);export{m as __pageData,_ as default}; +import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/api"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1734688054000}'),r={name:"developer/index.md"};function n(o,i,s,d,l,c){return a(),t("div")}const _=e(r,[["render",n]]);export{m as __pageData,_ as default}; diff --git a/assets/en_US_case_case1.md.ktD6yK0Q.js b/assets/en_US_case_case1.md.DSw3142l.js similarity index 95% rename from assets/en_US_case_case1.md.ktD6yK0Q.js rename to assets/en_US_case_case1.md.DSw3142l.js index d3cd19a1f..37d8423ff 100644 --- a/assets/en_US_case_case1.md.ktD6yK0Q.js +++ b/assets/en_US_case_case1.md.DSw3142l.js @@ -1 +1 @@ -import{_ as e,c as t,o as r,a4 as o}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1734681474000}'),a={name:"en_US/case/case1.md"},n=o('

    Build your own Telegram bot to query server information

    Contributors:

    Project: nezha_api_tgbot (Chinese)

    The bot can request server status information from the Dashboard through the API, and then send the information to the user.
    You can build this bot to easily view the current status of a given server without opening the Dashboard.

    ',5),i=[n];function s(l,h,u,_,c,p){return r(),t("div",null,i)}const b=e(a,[["render",s]]);export{m as __pageData,b as default}; +import{_ as e,c as t,o as r,a4 as o}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1734688054000}'),a={name:"en_US/case/case1.md"},n=o('

    Build your own Telegram bot to query server information

    Contributors:

    Project: nezha_api_tgbot (Chinese)

    The bot can request server status information from the Dashboard through the API, and then send the information to the user.
    You can build this bot to easily view the current status of a given server without opening the Dashboard.

    ',5),i=[n];function s(l,h,u,_,c,p){return r(),t("div",null,i)}const b=e(a,[["render",s]]);export{m as __pageData,b as default}; diff --git a/assets/en_US_case_case1.md.ktD6yK0Q.lean.js b/assets/en_US_case_case1.md.DSw3142l.lean.js similarity index 86% rename from assets/en_US_case_case1.md.ktD6yK0Q.lean.js rename to assets/en_US_case_case1.md.DSw3142l.lean.js index acfcbf12c..c4404875b 100644 --- a/assets/en_US_case_case1.md.ktD6yK0Q.lean.js +++ b/assets/en_US_case_case1.md.DSw3142l.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as r,a4 as o}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1734681474000}'),a={name:"en_US/case/case1.md"},n=o("",5),i=[n];function s(l,h,u,_,c,p){return r(),t("div",null,i)}const b=e(a,[["render",s]]);export{m as __pageData,b as default}; +import{_ as e,c as t,o as r,a4 as o}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1734688054000}'),a={name:"en_US/case/case1.md"},n=o("",5),i=[n];function s(l,h,u,_,c,p){return r(),t("div",null,i)}const b=e(a,[["render",s]]);export{m as __pageData,b as default}; diff --git a/assets/en_US_case_case10.md.Dh675cr9.js b/assets/en_US_case_case10.md.DwwodtT7.js similarity index 98% rename from assets/en_US_case_case10.md.Dh675cr9.js rename to assets/en_US_case_case10.md.DwwodtT7.js index d5da24638..c2e3a83ed 100644 --- a/assets/en_US_case_case10.md.Dh675cr9.js +++ b/assets/en_US_case_case10.md.DwwodtT7.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Nezha Telegram Bot - NextGen V1","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case10.md","filePath":"en_US/case/case10.md","lastUpdated":1734681474000}'),o={name:"en_US/case/case10.md"},n=r('

    Nezha Telegram Bot - NextGen V1

    Nezha Telegram Bot - NextGen V1 is a Telegram bot built on the Nezha Monitoring API. It enables users to monitor server status, resource utilization, execute scheduled tasks, and track service availability in real-time with simple commands.


    Contributors


    Key Features

    1. Account Binding
      Securely bind your Nezha account to ensure data privacy.

    2. Multi-Dashboard Support
      Manage multiple Nezha Dashboards simultaneously with seamless integration.

    3. Server Overview
      View the online status, memory usage, swap space, disk utilization, and network traffic statistics for all servers.

    4. Single Server Status
      Access detailed information for a single server, including load, CPU usage, memory, disk, and network traffic.

    5. Task Management
      View and execute predefined scheduled tasks for automated server management.

    6. Service Availability Monitoring
      Track the availability and average latency of services to ensure stable operations.

    7. Real-Time Data Refresh
      Refresh data in real-time to access the latest server status updates.


    Project Background

    This project was donated by Cantoblanco to NezhaHQ and is now maintained as a community project.


    Project Repository

    GitHub Repository: Nezha Telegram Bot - NextGen V1

    ',14),s=[n];function i(l,c,h,d,u,g){return a(),t("div",null,s)}const m=e(o,[["render",i]]);export{b as __pageData,m as default}; +import{_ as e,c as t,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Nezha Telegram Bot - NextGen V1","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case10.md","filePath":"en_US/case/case10.md","lastUpdated":1734688054000}'),o={name:"en_US/case/case10.md"},n=r('

    Nezha Telegram Bot - NextGen V1

    Nezha Telegram Bot - NextGen V1 is a Telegram bot built on the Nezha Monitoring API. It enables users to monitor server status, resource utilization, execute scheduled tasks, and track service availability in real-time with simple commands.


    Contributors


    Key Features

    1. Account Binding
      Securely bind your Nezha account to ensure data privacy.

    2. Multi-Dashboard Support
      Manage multiple Nezha Dashboards simultaneously with seamless integration.

    3. Server Overview
      View the online status, memory usage, swap space, disk utilization, and network traffic statistics for all servers.

    4. Single Server Status
      Access detailed information for a single server, including load, CPU usage, memory, disk, and network traffic.

    5. Task Management
      View and execute predefined scheduled tasks for automated server management.

    6. Service Availability Monitoring
      Track the availability and average latency of services to ensure stable operations.

    7. Real-Time Data Refresh
      Refresh data in real-time to access the latest server status updates.


    Project Background

    This project was donated by Cantoblanco to NezhaHQ and is now maintained as a community project.


    Project Repository

    GitHub Repository: Nezha Telegram Bot - NextGen V1

    ',14),s=[n];function i(l,c,h,d,u,g){return a(),t("div",null,s)}const m=e(o,[["render",i]]);export{b as __pageData,m as default}; diff --git a/assets/en_US_case_case10.md.Dh675cr9.lean.js b/assets/en_US_case_case10.md.DwwodtT7.lean.js similarity index 86% rename from assets/en_US_case_case10.md.Dh675cr9.lean.js rename to assets/en_US_case_case10.md.DwwodtT7.lean.js index 04af842e0..85388337e 100644 --- a/assets/en_US_case_case10.md.Dh675cr9.lean.js +++ b/assets/en_US_case_case10.md.DwwodtT7.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Nezha Telegram Bot - NextGen V1","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case10.md","filePath":"en_US/case/case10.md","lastUpdated":1734681474000}'),o={name:"en_US/case/case10.md"},n=r("",14),s=[n];function i(l,c,h,d,u,g){return a(),t("div",null,s)}const m=e(o,[["render",i]]);export{b as __pageData,m as default}; +import{_ as e,c as t,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Nezha Telegram Bot - NextGen V1","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case10.md","filePath":"en_US/case/case10.md","lastUpdated":1734688054000}'),o={name:"en_US/case/case10.md"},n=r("",14),s=[n];function i(l,c,h,d,u,g){return a(),t("div",null,s)}const m=e(o,[["render",i]]);export{b as __pageData,m as default}; diff --git a/assets/en_US_case_case2.md.Cg62bB-q.js b/assets/en_US_case_case2.md.C2ONzimi.js similarity index 97% rename from assets/en_US_case_case2.md.Cg62bB-q.js rename to assets/en_US_case_case2.md.C2ONzimi.js index 6967c8bde..aed693972 100644 --- a/assets/en_US_case_case2.md.Cg62bB-q.js +++ b/assets/en_US_case_case2.md.C2ONzimi.js @@ -1 +1 @@ -import{_ as e}from"./chunks/qrcode.CZOxHFH-.js";import{_ as t,c as r,o,a4 as s}from"./chunks/framework.BmdFiWrL.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1734681474000}'),a={name:"en_US/case/case2.md"},c=s('

    Use Siri to run shortcut to check server status in iOS/MacOS

    Current Version:V1.0 (Chinese)
    Contributor:

    Get shortcut command

    Scan the following QR code with your iPhone or iPad to get the shortcut

    coode


    MacOS users please visit here to get the shortcut

    How to use

    • After getting the shortcut, open and edit the shortcut
    • Fill in Dashboard URL, API Token, Server ID in the three text boxes
    • Save the edit and test run, if you can get the result, the setting is correct.
    • Modify the name of the shortcut, such as: Server Status, then you can use Siri command: "Hey Siri, Server Status" to get the server status.

    WARNING

    Each shortcut can only monitor one server, if you need to monitor more than one server, please copy this shortcut several times and configure them separately, then modify the shortcut name separately, such as; Server 1 Status, Server 2 Status, etc.

    ',8),i=[c];function h(n,u,l,d,m,_){return o(),r("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default}; +import{_ as e}from"./chunks/qrcode.CZOxHFH-.js";import{_ as t,c as r,o,a4 as s}from"./chunks/framework.BmdFiWrL.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1734688054000}'),a={name:"en_US/case/case2.md"},c=s('

    Use Siri to run shortcut to check server status in iOS/MacOS

    Current Version:V1.0 (Chinese)
    Contributor:

    Get shortcut command

    Scan the following QR code with your iPhone or iPad to get the shortcut

    coode


    MacOS users please visit here to get the shortcut

    How to use

    • After getting the shortcut, open and edit the shortcut
    • Fill in Dashboard URL, API Token, Server ID in the three text boxes
    • Save the edit and test run, if you can get the result, the setting is correct.
    • Modify the name of the shortcut, such as: Server Status, then you can use Siri command: "Hey Siri, Server Status" to get the server status.

    WARNING

    Each shortcut can only monitor one server, if you need to monitor more than one server, please copy this shortcut several times and configure them separately, then modify the shortcut name separately, such as; Server 1 Status, Server 2 Status, etc.

    ',8),i=[c];function h(n,u,l,d,m,_){return o(),r("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default}; diff --git a/assets/en_US_case_case2.md.Cg62bB-q.lean.js b/assets/en_US_case_case2.md.C2ONzimi.lean.js similarity index 87% rename from assets/en_US_case_case2.md.Cg62bB-q.lean.js rename to assets/en_US_case_case2.md.C2ONzimi.lean.js index a55c287d5..0c4a273ee 100644 --- a/assets/en_US_case_case2.md.Cg62bB-q.lean.js +++ b/assets/en_US_case_case2.md.C2ONzimi.lean.js @@ -1 +1 @@ -import{_ as e}from"./chunks/qrcode.CZOxHFH-.js";import{_ as t,c as r,o,a4 as s}from"./chunks/framework.BmdFiWrL.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1734681474000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return o(),r("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default}; +import{_ as e}from"./chunks/qrcode.CZOxHFH-.js";import{_ as t,c as r,o,a4 as s}from"./chunks/framework.BmdFiWrL.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1734688054000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return o(),r("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default}; diff --git a/assets/en_US_case_case3.md.CxfX4H9O.js b/assets/en_US_case_case3.md.RYTYnnKO.js similarity index 97% rename from assets/en_US_case_case3.md.CxfX4H9O.js rename to assets/en_US_case_case3.md.RYTYnnKO.js index fabecec08..4dc2a3661 100644 --- a/assets/en_US_case_case3.md.CxfX4H9O.js +++ b/assets/en_US_case_case3.md.RYTYnnKO.js @@ -1 +1 @@ -import{_ as t,c as e,o as r,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Build your own server status query Telegram bot","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1734681474000}'),d={name:"en_US/case/case3.md"},o=a('

    Build your own server status query Telegram bot

    Contributor:

    GitHub project: nezha_telegram_bot(English is already supported)

    Features

    • [x] Support Chinese/English multi-language switch
    • [x] Support tag statistics (CPU, disk, memory, upstream and downstream speed, traffic statistics, etc.)
    • [x] Support real-time refresh of single server data
    • [x] Support keyboard interactive query
    • [x] Support query by command
    • [x] Support adding bot to group, privacy protection of bot replies in group chat
    • [x] Support bot messages automatic deletion in group chat within 20 seconds
    • [x] Support docker deployment

    Commands list

    CommandDescriptionPrivate chat only
    startGetting started with the keyboard main menu✔️
    helphelp message
    addAdd Nezha monitoring url link and token✔️
    urlAdd Nezha monitoring url link✔️
    tokenAdd Nezha monitoring token✔️
    infoGet saved Nezha monitoring url link and token✔️
    deleteDelete saved Nezha monitoring url link and token✔️
    idAdd an integer id after the command to query the information of a single server (refresh button only available in private chat)
    allQuery statistics for all servers
    searchSearch for keywords in server names (multiple keywords supported, split by spaces)
    ',8),i=[o];function s(n,l,u,h,c,m){return r(),e("div",null,i)}const b=t(d,[["render",s]]);export{_ as __pageData,b as default}; +import{_ as t,c as e,o as r,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Build your own server status query Telegram bot","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1734688054000}'),d={name:"en_US/case/case3.md"},o=a('

    Build your own server status query Telegram bot

    Contributor:

    GitHub project: nezha_telegram_bot(English is already supported)

    Features

    • [x] Support Chinese/English multi-language switch
    • [x] Support tag statistics (CPU, disk, memory, upstream and downstream speed, traffic statistics, etc.)
    • [x] Support real-time refresh of single server data
    • [x] Support keyboard interactive query
    • [x] Support query by command
    • [x] Support adding bot to group, privacy protection of bot replies in group chat
    • [x] Support bot messages automatic deletion in group chat within 20 seconds
    • [x] Support docker deployment

    Commands list

    CommandDescriptionPrivate chat only
    startGetting started with the keyboard main menu✔️
    helphelp message
    addAdd Nezha monitoring url link and token✔️
    urlAdd Nezha monitoring url link✔️
    tokenAdd Nezha monitoring token✔️
    infoGet saved Nezha monitoring url link and token✔️
    deleteDelete saved Nezha monitoring url link and token✔️
    idAdd an integer id after the command to query the information of a single server (refresh button only available in private chat)
    allQuery statistics for all servers
    searchSearch for keywords in server names (multiple keywords supported, split by spaces)
    ',8),i=[o];function s(n,l,u,h,c,m){return r(),e("div",null,i)}const b=t(d,[["render",s]]);export{_ as __pageData,b as default}; diff --git a/assets/en_US_case_case3.md.CxfX4H9O.lean.js b/assets/en_US_case_case3.md.RYTYnnKO.lean.js similarity index 86% rename from assets/en_US_case_case3.md.CxfX4H9O.lean.js rename to assets/en_US_case_case3.md.RYTYnnKO.lean.js index 917714e51..e4222d583 100644 --- a/assets/en_US_case_case3.md.CxfX4H9O.lean.js +++ b/assets/en_US_case_case3.md.RYTYnnKO.lean.js @@ -1 +1 @@ -import{_ as t,c as e,o as r,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Build your own server status query Telegram bot","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1734681474000}'),d={name:"en_US/case/case3.md"},o=a("",8),i=[o];function s(n,l,u,h,c,m){return r(),e("div",null,i)}const b=t(d,[["render",s]]);export{_ as __pageData,b as default}; +import{_ as t,c as e,o as r,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Build your own server status query Telegram bot","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1734688054000}'),d={name:"en_US/case/case3.md"},o=a("",8),i=[o];function s(n,l,u,h,c,m){return r(),e("div",null,i)}const b=t(d,[["render",s]]);export{_ as __pageData,b as default}; diff --git a/assets/en_US_case_case4.md.BT7M8x47.js b/assets/en_US_case_case4.md.DL4X1OaX.js similarity index 94% rename from assets/en_US_case_case4.md.BT7M8x47.js rename to assets/en_US_case_case4.md.DL4X1OaX.js index a2b7d8a1b..3ae53e3e0 100644 --- a/assets/en_US_case_case4.md.BT7M8x47.js +++ b/assets/en_US_case_case4.md.DL4X1OaX.js @@ -1 +1 @@ -import{_ as t,c as n,o,j as e,a}from"./chunks/framework.BmdFiWrL.js";const x=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1734681474000}'),r={name:"en_US/case/case4.md"},s=e("h1",{id:"fake-agent-monitoring-data-cheater",tabindex:"-1"},[a("Fake-agent, monitoring data cheater "),e("a",{class:"header-anchor",href:"#fake-agent-monitoring-data-cheater","aria-label":'Permalink to "Fake-agent, monitoring data cheater"'},"​")],-1),c=e("p",null,"Contributor:",-1),i=e("ul",null,[e("li",null,[e("a",{href:"https://github.com/dysf888",target:"_blank",rel:"noreferrer"},"dysf888")])],-1),d=e("p",null,[a("GitHub project: "),e("a",{href:"https://github.com/dysf888/fake-nezha-agent",target:"_blank",rel:"noreferrer"},"fake-nezha-agent"),a("(Chinese)")],-1),h=e("p",null,[a("You can modify the monitoring data uploaded to Dashboard by the Agent"),e("br"),a(" Use it for cheating 😈")],-1),l=[s,c,i,d,h];function _(f,g,m,p,u,k){return o(),n("div",null,l)}const y=t(r,[["render",_]]);export{x as __pageData,y as default}; +import{_ as t,c as n,o,j as e,a}from"./chunks/framework.BmdFiWrL.js";const x=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1734688054000}'),r={name:"en_US/case/case4.md"},s=e("h1",{id:"fake-agent-monitoring-data-cheater",tabindex:"-1"},[a("Fake-agent, monitoring data cheater "),e("a",{class:"header-anchor",href:"#fake-agent-monitoring-data-cheater","aria-label":'Permalink to "Fake-agent, monitoring data cheater"'},"​")],-1),c=e("p",null,"Contributor:",-1),i=e("ul",null,[e("li",null,[e("a",{href:"https://github.com/dysf888",target:"_blank",rel:"noreferrer"},"dysf888")])],-1),d=e("p",null,[a("GitHub project: "),e("a",{href:"https://github.com/dysf888/fake-nezha-agent",target:"_blank",rel:"noreferrer"},"fake-nezha-agent"),a("(Chinese)")],-1),h=e("p",null,[a("You can modify the monitoring data uploaded to Dashboard by the Agent"),e("br"),a(" Use it for cheating 😈")],-1),l=[s,c,i,d,h];function _(f,g,m,p,u,k){return o(),n("div",null,l)}const y=t(r,[["render",_]]);export{x as __pageData,y as default}; diff --git a/assets/en_US_case_case4.md.BT7M8x47.lean.js b/assets/en_US_case_case4.md.DL4X1OaX.lean.js similarity index 94% rename from assets/en_US_case_case4.md.BT7M8x47.lean.js rename to assets/en_US_case_case4.md.DL4X1OaX.lean.js index a2b7d8a1b..3ae53e3e0 100644 --- a/assets/en_US_case_case4.md.BT7M8x47.lean.js +++ b/assets/en_US_case_case4.md.DL4X1OaX.lean.js @@ -1 +1 @@ -import{_ as t,c as n,o,j as e,a}from"./chunks/framework.BmdFiWrL.js";const x=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1734681474000}'),r={name:"en_US/case/case4.md"},s=e("h1",{id:"fake-agent-monitoring-data-cheater",tabindex:"-1"},[a("Fake-agent, monitoring data cheater "),e("a",{class:"header-anchor",href:"#fake-agent-monitoring-data-cheater","aria-label":'Permalink to "Fake-agent, monitoring data cheater"'},"​")],-1),c=e("p",null,"Contributor:",-1),i=e("ul",null,[e("li",null,[e("a",{href:"https://github.com/dysf888",target:"_blank",rel:"noreferrer"},"dysf888")])],-1),d=e("p",null,[a("GitHub project: "),e("a",{href:"https://github.com/dysf888/fake-nezha-agent",target:"_blank",rel:"noreferrer"},"fake-nezha-agent"),a("(Chinese)")],-1),h=e("p",null,[a("You can modify the monitoring data uploaded to Dashboard by the Agent"),e("br"),a(" Use it for cheating 😈")],-1),l=[s,c,i,d,h];function _(f,g,m,p,u,k){return o(),n("div",null,l)}const y=t(r,[["render",_]]);export{x as __pageData,y as default}; +import{_ as t,c as n,o,j as e,a}from"./chunks/framework.BmdFiWrL.js";const x=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1734688054000}'),r={name:"en_US/case/case4.md"},s=e("h1",{id:"fake-agent-monitoring-data-cheater",tabindex:"-1"},[a("Fake-agent, monitoring data cheater "),e("a",{class:"header-anchor",href:"#fake-agent-monitoring-data-cheater","aria-label":'Permalink to "Fake-agent, monitoring data cheater"'},"​")],-1),c=e("p",null,"Contributor:",-1),i=e("ul",null,[e("li",null,[e("a",{href:"https://github.com/dysf888",target:"_blank",rel:"noreferrer"},"dysf888")])],-1),d=e("p",null,[a("GitHub project: "),e("a",{href:"https://github.com/dysf888/fake-nezha-agent",target:"_blank",rel:"noreferrer"},"fake-nezha-agent"),a("(Chinese)")],-1),h=e("p",null,[a("You can modify the monitoring data uploaded to Dashboard by the Agent"),e("br"),a(" Use it for cheating 😈")],-1),l=[s,c,i,d,h];function _(f,g,m,p,u,k){return o(),n("div",null,l)}const y=t(r,[["render",_]]);export{x as __pageData,y as default}; diff --git a/assets/en_US_case_case5.md.CsYCS8Ki.js b/assets/en_US_case_case5.md.u-PXffkj.js similarity index 99% rename from assets/en_US_case_case5.md.CsYCS8Ki.js rename to assets/en_US_case_case5.md.u-PXffkj.js index ee1360715..c62d9692f 100644 --- a/assets/en_US_case_case5.md.CsYCS8Ki.js +++ b/assets/en_US_case_case5.md.u-PXffkj.js @@ -1,4 +1,4 @@ -import{_ as e,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1734681474000}'),s={name:"en_US/case/case5.md"},o=n(`

    Nezha server over Argo tunnel

    INFO

    This project is not yet compatible with the V1 version.

    Contributors:

    GitHub project: Argo-Nezha-Service-Container


    Catalog


    Project Features.

    • Wider scope of application --- As long as there is a network connection, Nezha server can be installed, such as LXC, OpenVZ VPS, Nas Virtual Machine, Container PaaS, etc.
    • Argo tunnel breaks through the restriction of requiring a public network portal --- The traditional Nezha requires two public network ports, one for panel visiting and the other for client reporting, this project uses Cloudflare Argo tunnels and uses intranet tunneling.
    • IPv4 / v6 with higher flexibility --- The traditional Nezha needs to deal with IPv4/v6 compatibility between server and client, and also needs to resolve mismatches through tools such as warp. However, this project does not need to consider these issues at all, and can be docked arbitrarily, which is much more convenient and easy!
    • One Argo tunnel for multiple domains and protocols --- Create an intranet-penetrating Argo tunnel for three domains (hostname) and protocols, which can be used for panel access (http), client reporting (tcp) and ssh (optional).
    • GrpcWebProxy reverse proxy gRPC data port --- with a certificate for tls termination, then Argo's tunnel configuration with https service pointing to this reverse proxy, enable http2 back to the source, grpc(nezha)->GrpcWebProxy->h2(argo)->cf cdn edge->agent
    • Daily automatic backup --- every day at 04:00 BST, the entire Nezha panel folder is automatically backed up to a designated private github repository, including panel themes, panel settings, probe data and tunnel information, the backup retains nearly 5 days of data; the content is so important that it must be placed in the private repository.
    • Automatic daily panel update -- the latest official panel version is automatically detected every day at 4:00 BST, and updated when there is an upgrade.
    • Manual/automatic restore backup --- check the content of online restore file once a minute, and restore immediately when there is any update.
    • Default built-in local probes --- can easily monitor their own server information
    • More secure data --- Argo Tunnel uses TLS encrypted communication to securely transmit application traffic to the Cloudflare network, improving application security and reliability. In addition, Argo Tunnel protects against network threats such as IP leaks and DDoS attacks.
    image

    Prepare variables to be used

    • Visit the Cloudflare website, select the domain name you want to use, and turn on the network option to turn the gRPC switch on.
    image

    Add https:// to the beginning of the panel's domain name and /oauth2/callback to the end of the callback address.

    imageimageimageimageimage

    How to get Argo authentication: json or token

    Argo tunnel authentication methods include json and token, use one of the two methods. The former is recommended because the script will handle all the Argo tunnel parameters and paths, while the latter needs to be set manually on the Cloudflare website and is prone to errors.

    (Methods 1 - Json):

    Easily get Argo tunnel json information through Cloudflare Json Generation Network: https://fscarmen.cloudflare.now.cc

    image

    (Methods 2 - Token): Manually generate Argo tunnel token information via Cloudflare website.

    Go to the cf website: https://dash.cloudflare.com/

    • Go to zero trust and generate token tunnel and message.
    • The data path 443/https is proto.
    • ssh path 22/ssh for < client id >.
    imageimageimageimageimageimageimage

    PaaS Deployment Example

    Image fscarmen/argo-nezha:latest, supports amd64 and arm64 architectures.

    Variables used

    Variable NameRequiredRemarks
    GH_USERYesgithub username for panel admin authorization
    GH_CLIENTIDyesapply on github
    GH_CLIENTSECRETyesapply on github
    GH_BACKUP_USERNoThe github username for backing up Nezha's server-side database on github, if not filled in, it is the same as the account GH_USER for panel management authorization
    GH_REPONoThe github repository for backing up Nezha's server-side database files on github
    GH_EMAILNogithub's mailbox for git push backups to remote repositories
    GH_PATNogithub's PAT
    ARGO_AUTHYesArgo Json from https://fscarmen.cloudflare.now.cc
    Argo token from Cloudflare official website
    ARGO_DOMAINYesArgo domain

    Koyeb

    Deploy to Koyeb

    imageimageimageimageimage

    VPS Deployment Method 1 --- docker

    • Note: ARGO_DOMAIN= must be followed by single quotes, which cannot be removed.
    • If the VPS is IPv6 only, please install WARP IPv4 or dual-stack first: https://github.com/fscarmen/warp
    • The backup directory is the dashboard folder in the current path.

    docker deployment

    docker run -dit \\
    +import{_ as e,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1734688054000}'),s={name:"en_US/case/case5.md"},o=n(`

    Nezha server over Argo tunnel

    INFO

    This project is not yet compatible with the V1 version.

    Contributors:

    GitHub project: Argo-Nezha-Service-Container


    Catalog


    Project Features.

    • Wider scope of application --- As long as there is a network connection, Nezha server can be installed, such as LXC, OpenVZ VPS, Nas Virtual Machine, Container PaaS, etc.
    • Argo tunnel breaks through the restriction of requiring a public network portal --- The traditional Nezha requires two public network ports, one for panel visiting and the other for client reporting, this project uses Cloudflare Argo tunnels and uses intranet tunneling.
    • IPv4 / v6 with higher flexibility --- The traditional Nezha needs to deal with IPv4/v6 compatibility between server and client, and also needs to resolve mismatches through tools such as warp. However, this project does not need to consider these issues at all, and can be docked arbitrarily, which is much more convenient and easy!
    • One Argo tunnel for multiple domains and protocols --- Create an intranet-penetrating Argo tunnel for three domains (hostname) and protocols, which can be used for panel access (http), client reporting (tcp) and ssh (optional).
    • GrpcWebProxy reverse proxy gRPC data port --- with a certificate for tls termination, then Argo's tunnel configuration with https service pointing to this reverse proxy, enable http2 back to the source, grpc(nezha)->GrpcWebProxy->h2(argo)->cf cdn edge->agent
    • Daily automatic backup --- every day at 04:00 BST, the entire Nezha panel folder is automatically backed up to a designated private github repository, including panel themes, panel settings, probe data and tunnel information, the backup retains nearly 5 days of data; the content is so important that it must be placed in the private repository.
    • Automatic daily panel update -- the latest official panel version is automatically detected every day at 4:00 BST, and updated when there is an upgrade.
    • Manual/automatic restore backup --- check the content of online restore file once a minute, and restore immediately when there is any update.
    • Default built-in local probes --- can easily monitor their own server information
    • More secure data --- Argo Tunnel uses TLS encrypted communication to securely transmit application traffic to the Cloudflare network, improving application security and reliability. In addition, Argo Tunnel protects against network threats such as IP leaks and DDoS attacks.
    image

    Prepare variables to be used

    • Visit the Cloudflare website, select the domain name you want to use, and turn on the network option to turn the gRPC switch on.
    image

    Add https:// to the beginning of the panel's domain name and /oauth2/callback to the end of the callback address.

    imageimageimageimageimage

    How to get Argo authentication: json or token

    Argo tunnel authentication methods include json and token, use one of the two methods. The former is recommended because the script will handle all the Argo tunnel parameters and paths, while the latter needs to be set manually on the Cloudflare website and is prone to errors.

    (Methods 1 - Json):

    Easily get Argo tunnel json information through Cloudflare Json Generation Network: https://fscarmen.cloudflare.now.cc

    image

    (Methods 2 - Token): Manually generate Argo tunnel token information via Cloudflare website.

    Go to the cf website: https://dash.cloudflare.com/

    • Go to zero trust and generate token tunnel and message.
    • The data path 443/https is proto.
    • ssh path 22/ssh for < client id >.
    imageimageimageimageimageimageimage

    PaaS Deployment Example

    Image fscarmen/argo-nezha:latest, supports amd64 and arm64 architectures.

    Variables used

    Variable NameRequiredRemarks
    GH_USERYesgithub username for panel admin authorization
    GH_CLIENTIDyesapply on github
    GH_CLIENTSECRETyesapply on github
    GH_BACKUP_USERNoThe github username for backing up Nezha's server-side database on github, if not filled in, it is the same as the account GH_USER for panel management authorization
    GH_REPONoThe github repository for backing up Nezha's server-side database files on github
    GH_EMAILNogithub's mailbox for git push backups to remote repositories
    GH_PATNogithub's PAT
    ARGO_AUTHYesArgo Json from https://fscarmen.cloudflare.now.cc
    Argo token from Cloudflare official website
    ARGO_DOMAINYesArgo domain

    Koyeb

    Deploy to Koyeb

    imageimageimageimageimage

    VPS Deployment Method 1 --- docker

    • Note: ARGO_DOMAIN= must be followed by single quotes, which cannot be removed.
    • If the VPS is IPv6 only, please install WARP IPv4 or dual-stack first: https://github.com/fscarmen/warp
    • The backup directory is the dashboard folder in the current path.

    docker deployment

    docker run -dit \\
                --name nezha_dashboard \\
                --pull always \\
                --restart always \\
    diff --git a/assets/en_US_case_case5.md.CsYCS8Ki.lean.js b/assets/en_US_case_case5.md.u-PXffkj.lean.js
    similarity index 86%
    rename from assets/en_US_case_case5.md.CsYCS8Ki.lean.js
    rename to assets/en_US_case_case5.md.u-PXffkj.lean.js
    index c9c7ec25a..209b4474a 100644
    --- a/assets/en_US_case_case5.md.CsYCS8Ki.lean.js
    +++ b/assets/en_US_case_case5.md.u-PXffkj.lean.js
    @@ -1 +1 @@
    -import{_ as e,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1734681474000}'),s={name:"en_US/case/case5.md"},o=n("",89),r=[o];function i(l,c,h,d,p,u){return t(),a("div",null,r)}const f=e(s,[["render",i]]);export{g as __pageData,f as default};
    +import{_ as e,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1734688054000}'),s={name:"en_US/case/case5.md"},o=n("",89),r=[o];function i(l,c,h,d,p,u){return t(),a("div",null,r)}const f=e(s,[["render",i]]);export{g as __pageData,f as default};
    diff --git a/assets/en_US_case_case6.md.BbHQXrSX.js b/assets/en_US_case_case6.md.B4wHjbcM.js
    similarity index 98%
    rename from assets/en_US_case_case6.md.BbHQXrSX.js
    rename to assets/en_US_case_case6.md.B4wHjbcM.js
    index 621b5ae5f..1ee50e27e 100644
    --- a/assets/en_US_case_case6.md.BbHQXrSX.js
    +++ b/assets/en_US_case_case6.md.B4wHjbcM.js
    @@ -1 +1 @@
    -import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917.CVyK0T4N.svg",n="/assets/1_en_US.BlTFuTPG.png",i="/assets/2_en_US.Dm8rLo_N.png",s="/assets/3_en_US.SUOW4yEM.png",k=JSON.parse('{"title":"Nezha Mobile - An iOS Client For Nezha Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case6.md","filePath":"en_US/case/case6.md","lastUpdated":1734681474000}'),l={name:"en_US/case/case6.md"},h=a('

    Nezha Mobile - An iOS Client For Nezha Dashboard

    Contributor:

    Contribute to the project

    Project Link

    INFO

    We appreciate any contribution to the project, and we will actively merge your commits into next Release. However, we may modify your work in order to comply with App Review Guidelines.

    Download on the App Store

    Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917

    WARNING

    Due to ICP Filing Policy, Nezha Mobile is not available in China mainland.

    TestFlight Testing Program

    Join TestFlight Testing

    Instructions

    • Enter your Dashboard Link, username and password at your first use. Dashboard Link looks like server.hidandelion.com. Do not add a protocol prefix or a trailing slash to the link. API Token can be retrieved from Admin Center of Dashboard. step1

    Configure Widget(Optional)

    • Add a widget on your Springboard. Long-tap the widget and then tap Edit Widget. step2

    • Choose a server you want to monitor on the next view. You can choose different servers for each widget. step3

    ',15),d=[h];function c(p,_,g,u,m,b){return o(),t("div",null,d)}const w=e(l,[["render",c]]);export{k as __pageData,w as default}; +import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917.CVyK0T4N.svg",n="/assets/1_en_US.BlTFuTPG.png",i="/assets/2_en_US.Dm8rLo_N.png",s="/assets/3_en_US.SUOW4yEM.png",k=JSON.parse('{"title":"Nezha Mobile - An iOS Client For Nezha Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case6.md","filePath":"en_US/case/case6.md","lastUpdated":1734688054000}'),l={name:"en_US/case/case6.md"},h=a('

    Nezha Mobile - An iOS Client For Nezha Dashboard

    Contributor:

    Contribute to the project

    Project Link

    INFO

    We appreciate any contribution to the project, and we will actively merge your commits into next Release. However, we may modify your work in order to comply with App Review Guidelines.

    Download on the App Store

    Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917

    WARNING

    Due to ICP Filing Policy, Nezha Mobile is not available in China mainland.

    TestFlight Testing Program

    Join TestFlight Testing

    Instructions

    • Enter your Dashboard Link, username and password at your first use. Dashboard Link looks like server.hidandelion.com. Do not add a protocol prefix or a trailing slash to the link. API Token can be retrieved from Admin Center of Dashboard. step1

    Configure Widget(Optional)

    • Add a widget on your Springboard. Long-tap the widget and then tap Edit Widget. step2

    • Choose a server you want to monitor on the next view. You can choose different servers for each widget. step3

    ',15),d=[h];function c(p,_,g,u,m,b){return o(),t("div",null,d)}const w=e(l,[["render",c]]);export{k as __pageData,w as default}; diff --git a/assets/en_US_case_case6.md.BbHQXrSX.lean.js b/assets/en_US_case_case6.md.B4wHjbcM.lean.js similarity index 90% rename from assets/en_US_case_case6.md.BbHQXrSX.lean.js rename to assets/en_US_case_case6.md.B4wHjbcM.lean.js index b6874bcdf..9bcf3d7b6 100644 --- a/assets/en_US_case_case6.md.BbHQXrSX.lean.js +++ b/assets/en_US_case_case6.md.B4wHjbcM.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917.CVyK0T4N.svg",n="/assets/1_en_US.BlTFuTPG.png",i="/assets/2_en_US.Dm8rLo_N.png",s="/assets/3_en_US.SUOW4yEM.png",k=JSON.parse('{"title":"Nezha Mobile - An iOS Client For Nezha Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case6.md","filePath":"en_US/case/case6.md","lastUpdated":1734681474000}'),l={name:"en_US/case/case6.md"},h=a("",15),d=[h];function c(p,_,g,u,m,b){return o(),t("div",null,d)}const w=e(l,[["render",c]]);export{k as __pageData,w as default}; +import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917.CVyK0T4N.svg",n="/assets/1_en_US.BlTFuTPG.png",i="/assets/2_en_US.Dm8rLo_N.png",s="/assets/3_en_US.SUOW4yEM.png",k=JSON.parse('{"title":"Nezha Mobile - An iOS Client For Nezha Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case6.md","filePath":"en_US/case/case6.md","lastUpdated":1734688054000}'),l={name:"en_US/case/case6.md"},h=a("",15),d=[h];function c(p,_,g,u,m,b){return o(),t("div",null,d)}const w=e(l,[["render",c]]);export{k as __pageData,w as default}; diff --git a/assets/en_US_case_case7.md._4E0p9pQ.js b/assets/en_US_case_case7.md.BtJxmb_L.js similarity index 95% rename from assets/en_US_case_case7.md._4E0p9pQ.js rename to assets/en_US_case_case7.md.BtJxmb_L.js index 2fe0d1c3f..6c8bc5677 100644 --- a/assets/en_US_case_case7.md._4E0p9pQ.js +++ b/assets/en_US_case_case7.md.BtJxmb_L.js @@ -1 +1 @@ -import{_ as e,a as r}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as a,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Broker for Nezha - Advancing on more platforms","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case7.md","filePath":"en_US/case/case7.md","lastUpdated":1734681474000}'),i={name:"en_US/case/case7.md"},l=n('

    Broker for Nezha - Advancing on more platforms

    Contributor:

    Broker for Nezha is a modified version of the Nezha Agent that separates data collection from gRPC reporting, enabling small devices to connect to the Nezha Dashboard.

    Project link: https://codeberg.org/uubulb/broker

    Online Documentation: Broker for Nezha

    Difference from Nezha Agent

    • Utilizes external data sources to report to Nezha Dashboard.
    • Supports configuring multiple sources and connecting to multiple Dashboards.
    • Only has limited task support. For details, view the project README.

    Broker for Nezha needs to be used with specific data collection software. Currently, it provides two data collection methods:

    1. HTTP (HTTP/1.1) - Active polling
    2. TCP - Passive collection (recommended to avoid creating redundant connections)

    For existing data collection software, refer to the project README. Due to security concerns, it's recommended to use this only in a trusted network.

    Writing a Data Collector

    If you need to write your own data collector, you'll need to implement a basic HTTP server or TCP client and use a specific data format that Broker can recognize. For details, see: Data types

    Examples

    Dashboard
    Dashboard

    WebSSH
    WebSSH
    ',17),s=[l];function c(d,f,p,h,u,m){return o(),t("div",null,s)}const k=a(i,[["render",c]]);export{_ as __pageData,k as default}; +import{_ as e,a as r}from"./chunks/webssh.C2tqG0xr.js";import{_ as a,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Broker for Nezha - Advancing on more platforms","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case7.md","filePath":"en_US/case/case7.md","lastUpdated":1734688054000}'),i={name:"en_US/case/case7.md"},l=n('

    Broker for Nezha - Advancing on more platforms

    Contributor:

    Broker for Nezha is a modified version of the Nezha Agent that separates data collection from gRPC reporting, enabling small devices to connect to the Nezha Dashboard.

    Project link: https://codeberg.org/uubulb/broker

    Online Documentation: Broker for Nezha

    Difference from Nezha Agent

    • Utilizes external data sources to report to Nezha Dashboard.
    • Supports configuring multiple sources and connecting to multiple Dashboards.
    • Only has limited task support. For details, view the project README.

    Broker for Nezha needs to be used with specific data collection software. Currently, it provides two data collection methods:

    1. HTTP (HTTP/1.1) - Active polling
    2. TCP - Passive collection (recommended to avoid creating redundant connections)

    For existing data collection software, refer to the project README. Due to security concerns, it's recommended to use this only in a trusted network.

    Writing a Data Collector

    If you need to write your own data collector, you'll need to implement a basic HTTP server or TCP client and use a specific data format that Broker can recognize. For details, see: Data types

    Examples

    Dashboard
    Dashboard

    WebSSH
    WebSSH
    ',17),s=[l];function c(d,f,p,h,u,m){return o(),t("div",null,s)}const k=a(i,[["render",c]]);export{_ as __pageData,k as default}; diff --git a/assets/en_US_case_case7.md._4E0p9pQ.lean.js b/assets/en_US_case_case7.md.BtJxmb_L.lean.js similarity index 75% rename from assets/en_US_case_case7.md._4E0p9pQ.lean.js rename to assets/en_US_case_case7.md.BtJxmb_L.lean.js index 9070a6d6a..7c875d407 100644 --- a/assets/en_US_case_case7.md._4E0p9pQ.lean.js +++ b/assets/en_US_case_case7.md.BtJxmb_L.lean.js @@ -1 +1 @@ -import{_ as e,a as r}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as a,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Broker for Nezha - Advancing on more platforms","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case7.md","filePath":"en_US/case/case7.md","lastUpdated":1734681474000}'),i={name:"en_US/case/case7.md"},l=n("",17),s=[l];function c(d,f,p,h,u,m){return o(),t("div",null,s)}const k=a(i,[["render",c]]);export{_ as __pageData,k as default}; +import{_ as e,a as r}from"./chunks/webssh.C2tqG0xr.js";import{_ as a,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Broker for Nezha - Advancing on more platforms","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case7.md","filePath":"en_US/case/case7.md","lastUpdated":1734688054000}'),i={name:"en_US/case/case7.md"},l=n("",17),s=[l];function c(d,f,p,h,u,m){return o(),t("div",null,s)}const k=a(i,[["render",c]]);export{_ as __pageData,k as default}; diff --git a/assets/en_US_case_case8.md.B1NkMZ1x.js b/assets/en_US_case_case8.md.BVoNi7MT.js similarity index 98% rename from assets/en_US_case_case8.md.B1NkMZ1x.js rename to assets/en_US_case_case8.md.BVoNi7MT.js index 6442e4d10..13d00d249 100644 --- a/assets/en_US_case_case8.md.B1NkMZ1x.js +++ b/assets/en_US_case_case8.md.BVoNi7MT.js @@ -1 +1 @@ -import{_ as e,c as o,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Serverless Telegram Bot for Nezha","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case8.md","filePath":"en_US/case/case8.md","lastUpdated":1734681474000}'),r={name:"en_US/case/case8.md"},l=a('

    Serverless Telegram Bot for Nezha

    Contributor:

    Project URL: https://github.com/swkisdust/plain-nezha-bot

    A single-user, single-instance, multi-language private chat Nezha Telegram bot that can be deployed on Cloudflare Workers.

    Inspired by https://github.com/nezhahq/Nezha-Telegram-Bot-V1

    Deployment

    1. Clone this project and run npm install to install dependencies.
    2. Create a Workers KV namespace using your preferred method and save its ID.
    3. Modify wrangler.toml and update the kv_namespaces field with your KV information.
    4. Modify wrangler.toml under vars:
    • NZ_BASEURL: Panel address, e.g., https://qio.ng.
    • LANG: Language, options are en and zh-CN, default is en.
    • ENDPOINT_PATH: Route path for receiving Telegram Webhook, e.g., /endpoint.
    1. Create the following Secrets:
    • TELEGRAM_BOT_TOKEN: Bot token obtained from BotFather.
    • TELEGRAM_SECRET: Webhook authentication key.
    • TELEGRAM_UID: User UID, the bot will not interact with anyone other than this UID.
    • PASSWORD: Basic authentication password for register/unregister/refresh token operations.
    • NZ_USERNAME: Panel username for initial authentication and subsequent refreshes.
    • NZ_PASSWORD: Panel password for initial authentication and subsequent refreshes.
    1. Run npx wrangler deploy to deploy the project.

    Usage

    Access the /register route to register the Webhook and start using the bot.

    If you do not need the bot temporarily, you can access /unregister to remove the Webhook.

    By default, the token refresh operation is triggered every 30 minutes. You can modify this manually in wrangler.toml or access /refresh to refresh manually.

    ',16),n=[l];function i(s,d,c,h,u,p){return t(),o("div",null,n)}const f=e(r,[["render",i]]);export{m as __pageData,f as default}; +import{_ as e,c as o,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Serverless Telegram Bot for Nezha","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case8.md","filePath":"en_US/case/case8.md","lastUpdated":1734688054000}'),r={name:"en_US/case/case8.md"},l=a('

    Serverless Telegram Bot for Nezha

    Contributor:

    Project URL: https://github.com/swkisdust/plain-nezha-bot

    A single-user, single-instance, multi-language private chat Nezha Telegram bot that can be deployed on Cloudflare Workers.

    Inspired by https://github.com/nezhahq/Nezha-Telegram-Bot-V1

    Deployment

    1. Clone this project and run npm install to install dependencies.
    2. Create a Workers KV namespace using your preferred method and save its ID.
    3. Modify wrangler.toml and update the kv_namespaces field with your KV information.
    4. Modify wrangler.toml under vars:
    • NZ_BASEURL: Panel address, e.g., https://qio.ng.
    • LANG: Language, options are en and zh-CN, default is en.
    • ENDPOINT_PATH: Route path for receiving Telegram Webhook, e.g., /endpoint.
    1. Create the following Secrets:
    • TELEGRAM_BOT_TOKEN: Bot token obtained from BotFather.
    • TELEGRAM_SECRET: Webhook authentication key.
    • TELEGRAM_UID: User UID, the bot will not interact with anyone other than this UID.
    • PASSWORD: Basic authentication password for register/unregister/refresh token operations.
    • NZ_USERNAME: Panel username for initial authentication and subsequent refreshes.
    • NZ_PASSWORD: Panel password for initial authentication and subsequent refreshes.
    1. Run npx wrangler deploy to deploy the project.

    Usage

    Access the /register route to register the Webhook and start using the bot.

    If you do not need the bot temporarily, you can access /unregister to remove the Webhook.

    By default, the token refresh operation is triggered every 30 minutes. You can modify this manually in wrangler.toml or access /refresh to refresh manually.

    ',16),n=[l];function i(s,d,c,h,u,p){return t(),o("div",null,n)}const f=e(r,[["render",i]]);export{m as __pageData,f as default}; diff --git a/assets/en_US_case_case8.md.B1NkMZ1x.lean.js b/assets/en_US_case_case8.md.BVoNi7MT.lean.js similarity index 86% rename from assets/en_US_case_case8.md.B1NkMZ1x.lean.js rename to assets/en_US_case_case8.md.BVoNi7MT.lean.js index 310b7ba2b..36ce6bf36 100644 --- a/assets/en_US_case_case8.md.B1NkMZ1x.lean.js +++ b/assets/en_US_case_case8.md.BVoNi7MT.lean.js @@ -1 +1 @@ -import{_ as e,c as o,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Serverless Telegram Bot for Nezha","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case8.md","filePath":"en_US/case/case8.md","lastUpdated":1734681474000}'),r={name:"en_US/case/case8.md"},l=a("",16),n=[l];function i(s,d,c,h,u,p){return t(),o("div",null,n)}const f=e(r,[["render",i]]);export{m as __pageData,f as default}; +import{_ as e,c as o,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Serverless Telegram Bot for Nezha","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case8.md","filePath":"en_US/case/case8.md","lastUpdated":1734688054000}'),r={name:"en_US/case/case8.md"},l=a("",16),n=[l];function i(s,d,c,h,u,p){return t(),o("div",null,n)}const f=e(r,[["render",i]]);export{m as __pageData,f as default}; diff --git a/assets/en_US_case_case9.md.Voa6Gbdf.js b/assets/en_US_case_case9.md.BvCnNBEa.js similarity index 98% rename from assets/en_US_case_case9.md.Voa6Gbdf.js rename to assets/en_US_case_case9.md.BvCnNBEa.js index acf0e6c6e..0801f18b7 100644 --- a/assets/en_US_case_case9.md.Voa6Gbdf.js +++ b/assets/en_US_case_case9.md.BvCnNBEa.js @@ -1 +1 @@ -import{_ as e,a as t,b as a,c as r}from"./chunks/4.Cnd9Q6Vo.js";import{_ as i,c as o,o as s,a4 as n}from"./chunks/framework.BmdFiWrL.js";const y=JSON.parse('{"title":"MDPings - Android Client for Nezha Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case9.md","filePath":"en_US/case/case9.md","lastUpdated":1734681474000}'),l={name:"en_US/case/case9.md"},c=n('

    MDPings - Android Client for Nezha Dashboard

    MDPings is an Android client designed with Material Design 3 (MD3) style and developed based on the Nezha Monitoring API. It allows users to monitor the status of multiple servers, view historical network statistics and latency charts, and execute simple, low-interaction commands via the device terminal.


    Contributor


    Key Features

    1. Multi-Dashboard Switching

      • Easily connect and switch between multiple Nezha Dashboards.
    2. Total Traffic Monitoring

      • View total traffic statistics across all servers.
    3. SSH Terminal Support

      • Execute simple commands via the terminal (requires SSH connection enabled in Nezha Dashboard).
    4. MD3 Style Design

      • Adopts Material Design 3 for adaptive layouts across devices.

    Application Screenshots

    Screenshot 1Screenshot 2Screenshot 3Screenshot 4

    Project Repository

    GitHub - MDPings


    Releases - MDPings

    ',17),h=[c];function d(p,g,u,m,_,b){return s(),o("div",null,h)}const P=i(l,[["render",d]]);export{y as __pageData,P as default}; +import{_ as e,a as t,b as a,c as r}from"./chunks/4.Cnd9Q6Vo.js";import{_ as i,c as o,o as s,a4 as n}from"./chunks/framework.BmdFiWrL.js";const y=JSON.parse('{"title":"MDPings - Android Client for Nezha Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case9.md","filePath":"en_US/case/case9.md","lastUpdated":1734688054000}'),l={name:"en_US/case/case9.md"},c=n('

    MDPings - Android Client for Nezha Dashboard

    MDPings is an Android client designed with Material Design 3 (MD3) style and developed based on the Nezha Monitoring API. It allows users to monitor the status of multiple servers, view historical network statistics and latency charts, and execute simple, low-interaction commands via the device terminal.


    Contributor


    Key Features

    1. Multi-Dashboard Switching

      • Easily connect and switch between multiple Nezha Dashboards.
    2. Total Traffic Monitoring

      • View total traffic statistics across all servers.
    3. SSH Terminal Support

      • Execute simple commands via the terminal (requires SSH connection enabled in Nezha Dashboard).
    4. MD3 Style Design

      • Adopts Material Design 3 for adaptive layouts across devices.

    Application Screenshots

    Screenshot 1Screenshot 2Screenshot 3Screenshot 4

    Project Repository

    GitHub - MDPings


    Releases - MDPings

    ',17),h=[c];function d(p,g,u,m,_,b){return s(),o("div",null,h)}const P=i(l,[["render",d]]);export{y as __pageData,P as default}; diff --git a/assets/en_US_case_case9.md.Voa6Gbdf.lean.js b/assets/en_US_case_case9.md.BvCnNBEa.lean.js similarity index 88% rename from assets/en_US_case_case9.md.Voa6Gbdf.lean.js rename to assets/en_US_case_case9.md.BvCnNBEa.lean.js index 1b319e56c..ce71fa8b1 100644 --- a/assets/en_US_case_case9.md.Voa6Gbdf.lean.js +++ b/assets/en_US_case_case9.md.BvCnNBEa.lean.js @@ -1 +1 @@ -import{_ as e,a as t,b as a,c as r}from"./chunks/4.Cnd9Q6Vo.js";import{_ as i,c as o,o as s,a4 as n}from"./chunks/framework.BmdFiWrL.js";const y=JSON.parse('{"title":"MDPings - Android Client for Nezha Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case9.md","filePath":"en_US/case/case9.md","lastUpdated":1734681474000}'),l={name:"en_US/case/case9.md"},c=n("",17),h=[c];function d(p,g,u,m,_,b){return s(),o("div",null,h)}const P=i(l,[["render",d]]);export{y as __pageData,P as default}; +import{_ as e,a as t,b as a,c as r}from"./chunks/4.Cnd9Q6Vo.js";import{_ as i,c as o,o as s,a4 as n}from"./chunks/framework.BmdFiWrL.js";const y=JSON.parse('{"title":"MDPings - Android Client for Nezha Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/case/case9.md","filePath":"en_US/case/case9.md","lastUpdated":1734688054000}'),l={name:"en_US/case/case9.md"},c=n("",17),h=[c];function d(p,g,u,m,_,b){return s(),o("div",null,h)}const P=i(l,[["render",d]]);export{y as __pageData,P as default}; diff --git a/assets/en_US_case_index.md.XCD7nYME.js b/assets/en_US_case_index.md.rGbsWNzh.js similarity index 95% rename from assets/en_US_case_index.md.XCD7nYME.js rename to assets/en_US_case_index.md.rGbsWNzh.js index 14288b6e0..f72aedd0a 100644 --- a/assets/en_US_case_index.md.XCD7nYME.js +++ b/assets/en_US_case_index.md.rGbsWNzh.js @@ -1 +1 @@ -import{_ as e,c as t,o}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1734681474000}'),a={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return o(),t("div")}const h=e(a,[["render",i]]);export{u as __pageData,h as default}; +import{_ as e,c as t,o}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1734688054000}'),a={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return o(),t("div")}const h=e(a,[["render",i]]);export{u as __pageData,h as default}; diff --git a/assets/en_US_case_index.md.XCD7nYME.lean.js b/assets/en_US_case_index.md.rGbsWNzh.lean.js similarity index 95% rename from assets/en_US_case_index.md.XCD7nYME.lean.js rename to assets/en_US_case_index.md.rGbsWNzh.lean.js index 14288b6e0..f72aedd0a 100644 --- a/assets/en_US_case_index.md.XCD7nYME.lean.js +++ b/assets/en_US_case_index.md.rGbsWNzh.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1734681474000}'),a={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return o(),t("div")}const h=e(a,[["render",i]]);export{u as __pageData,h as default}; +import{_ as e,c as t,o}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1734688054000}'),a={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return o(),t("div")}const h=e(a,[["render",i]]);export{u as __pageData,h as default}; diff --git a/assets/en_US_developer_api.md.DPjgZE9F.js b/assets/en_US_developer_api.md.DYAZm_L6.js similarity index 98% rename from assets/en_US_developer_api.md.DPjgZE9F.js rename to assets/en_US_developer_api.md.DYAZm_L6.js index e2ad59ae6..02848b381 100644 --- a/assets/en_US_developer_api.md.DPjgZE9F.js +++ b/assets/en_US_developer_api.md.DYAZm_L6.js @@ -1,2 +1,2 @@ -import{_ as e,c as a,o as t,a4 as s}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"API Documentation","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/developer/api.md","filePath":"en_US/developer/api.md","lastUpdated":1734681474000}'),i={name:"en_US/developer/api.md"},n=s(`

    API Documentation

    Nezha Dashboard provides a comprehensive API documentation that allows developers to create custom applications, such as custom frontends or bots, leveraging its APIs.


    Instructions

    Fetching and Generating Documentation

    1. Clone the Repository
      Clone the official repository:

      bash
      git clone https://github.com/nezhahq/nezha.git
      +import{_ as e,c as a,o as t,a4 as s}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"API Documentation","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/developer/api.md","filePath":"en_US/developer/api.md","lastUpdated":1734688054000}'),i={name:"en_US/developer/api.md"},n=s(`

      API Documentation

      Nezha Dashboard provides a comprehensive API documentation that allows developers to create custom applications, such as custom frontends or bots, leveraging its APIs.


      Instructions

      Fetching and Generating Documentation

      1. Clone the Repository
        Clone the official repository:

        bash
        git clone https://github.com/nezhahq/nezha.git
         cd nezha
      2. Run the Bootstrap Script
        Execute the following script to generate files required for API documentation:

        bash
        ./script/bootstrap.sh
      3. Compile the Code
        If the compilation process reports missing admin-dist or user-dist directories, create empty directories as follows:

        bash
        mkdir -p dashboard/admin-dist dashboard/user-dist
      4. Enable Debug Mode
        Update the configuration to enable Debug mode and run dashboard
        The system logs will automatically display the URL for accessing the API documentation.

      `,6),o=[n];function r(l,d,h,p,c,g){return t(),a("div",null,o)}const m=e(i,[["render",r]]);export{k as __pageData,m as default}; diff --git a/assets/en_US_developer_api.md.DPjgZE9F.lean.js b/assets/en_US_developer_api.md.DYAZm_L6.lean.js similarity index 86% rename from assets/en_US_developer_api.md.DPjgZE9F.lean.js rename to assets/en_US_developer_api.md.DYAZm_L6.lean.js index d7c6857cc..34ff74226 100644 --- a/assets/en_US_developer_api.md.DPjgZE9F.lean.js +++ b/assets/en_US_developer_api.md.DYAZm_L6.lean.js @@ -1 +1 @@ -import{_ as e,c as a,o as t,a4 as s}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"API Documentation","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/developer/api.md","filePath":"en_US/developer/api.md","lastUpdated":1734681474000}'),i={name:"en_US/developer/api.md"},n=s("",6),o=[n];function r(l,d,h,p,c,g){return t(),a("div",null,o)}const m=e(i,[["render",r]]);export{k as __pageData,m as default}; +import{_ as e,c as a,o as t,a4 as s}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"API Documentation","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/developer/api.md","filePath":"en_US/developer/api.md","lastUpdated":1734688054000}'),i={name:"en_US/developer/api.md"},n=s("",6),o=[n];function r(l,d,h,p,c,g){return t(),a("div",null,o)}const m=e(i,[["render",r]]);export{k as __pageData,m as default}; diff --git a/assets/en_US_developer_i18n.md.D0XV7oe9.js b/assets/en_US_developer_i18n.md.D0XV7oe9.js deleted file mode 100644 index ed3fb42b3..000000000 --- a/assets/en_US_developer_i18n.md.D0XV7oe9.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Internationalization (i18n)","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/developer/i18n.md","filePath":"en_US/developer/i18n.md","lastUpdated":1734681474000}'),n={name:"en_US/developer/i18n.md"},r=a('

      Internationalization (i18n)

      Introduction

      You can contribute to Nezha’s internationalization efforts through Hosted Weblate.

      Scope of Coverage

      Currently, i18n support mainly covers the admin frontend and the Dashboard.
      For user frontend localization, please follow the steps provided in the original repository.

      ',5),i=[r];function s(l,d,c,h,p,_){return o(),t("div",null,i)}const g=e(n,[["render",s]]);export{u as __pageData,g as default}; diff --git a/assets/en_US_developer_i18n.md.D0XV7oe9.lean.js b/assets/en_US_developer_i18n.md.D0XV7oe9.lean.js deleted file mode 100644 index fd2bdae40..000000000 --- a/assets/en_US_developer_i18n.md.D0XV7oe9.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Internationalization (i18n)","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/developer/i18n.md","filePath":"en_US/developer/i18n.md","lastUpdated":1734681474000}'),n={name:"en_US/developer/i18n.md"},r=a("",5),i=[r];function s(l,d,c,h,p,_){return o(),t("div",null,i)}const g=e(n,[["render",s]]);export{u as __pageData,g as default}; diff --git a/assets/en_US_developer_i18n.md.D2W9RdYE.js b/assets/en_US_developer_i18n.md.D2W9RdYE.js new file mode 100644 index 000000000..209ebd924 --- /dev/null +++ b/assets/en_US_developer_i18n.md.D2W9RdYE.js @@ -0,0 +1 @@ +import{_ as e,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Internationalization (i18n)","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/developer/i18n.md","filePath":"en_US/developer/i18n.md","lastUpdated":1734688054000}'),o={name:"en_US/developer/i18n.md"},i=n('

      Internationalization (i18n)

      Introduction

      You can contribute to Nezha’s internationalization efforts through Hosted Weblate.

      Scope of Coverage

      All Dashboard-side projects, including Nezha itself, the official user frontend and the admin frontend.

      ',5),r=[i];function s(d,l,c,h,_,p){return t(),a("div",null,r)}const g=e(o,[["render",s]]);export{u as __pageData,g as default}; diff --git a/assets/en_US_developer_i18n.md.D2W9RdYE.lean.js b/assets/en_US_developer_i18n.md.D2W9RdYE.lean.js new file mode 100644 index 000000000..a302fc686 --- /dev/null +++ b/assets/en_US_developer_i18n.md.D2W9RdYE.lean.js @@ -0,0 +1 @@ +import{_ as e,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Internationalization (i18n)","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/developer/i18n.md","filePath":"en_US/developer/i18n.md","lastUpdated":1734688054000}'),o={name:"en_US/developer/i18n.md"},i=n("",5),r=[i];function s(d,l,c,h,_,p){return t(),a("div",null,r)}const g=e(o,[["render",s]]);export{u as __pageData,g as default}; diff --git a/assets/en_US_developer_index.md.5ZKnAHy2.js b/assets/en_US_developer_index.md.DhwlpkQp.js similarity index 92% rename from assets/en_US_developer_index.md.5ZKnAHy2.js rename to assets/en_US_developer_index.md.DhwlpkQp.js index 4a52b551d..e3f1df705 100644 --- a/assets/en_US_developer_index.md.5ZKnAHy2.js +++ b/assets/en_US_developer_index.md.DhwlpkQp.js @@ -1 +1 @@ -import{_ as e,c as t,o as n}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/api"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1734681474000}'),a={name:"en_US/developer/index.md"};function o(r,i,l,p,s,m){return n(),t("div")}const _=e(a,[["render",o]]);export{c as __pageData,_ as default}; +import{_ as e,c as t,o as n}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/api"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1734688054000}'),a={name:"en_US/developer/index.md"};function o(r,i,l,p,s,m){return n(),t("div")}const _=e(a,[["render",o]]);export{c as __pageData,_ as default}; diff --git a/assets/en_US_developer_index.md.5ZKnAHy2.lean.js b/assets/en_US_developer_index.md.DhwlpkQp.lean.js similarity index 92% rename from assets/en_US_developer_index.md.5ZKnAHy2.lean.js rename to assets/en_US_developer_index.md.DhwlpkQp.lean.js index 4a52b551d..e3f1df705 100644 --- a/assets/en_US_developer_index.md.5ZKnAHy2.lean.js +++ b/assets/en_US_developer_index.md.DhwlpkQp.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as n}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/api"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1734681474000}'),a={name:"en_US/developer/index.md"};function o(r,i,l,p,s,m){return n(),t("div")}const _=e(a,[["render",o]]);export{c as __pageData,_ as default}; +import{_ as e,c as t,o as n}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/api"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1734688054000}'),a={name:"en_US/developer/index.md"};function o(r,i,l,p,s,m){return n(),t("div")}const _=e(a,[["render",o]]);export{c as __pageData,_ as default}; diff --git a/assets/en_US_guide_agent.md.-aVSue02.js b/assets/en_US_guide_agent.md.BGW-EA-i.js similarity index 99% rename from assets/en_US_guide_agent.md.-aVSue02.js rename to assets/en_US_guide_agent.md.BGW-EA-i.js index 09265ca79..6c2fb1ce1 100644 --- a/assets/en_US_guide_agent.md.-aVSue02.js +++ b/assets/en_US_guide_agent.md.BGW-EA-i.js @@ -1,4 +1,4 @@ -import{_ as s,c as i,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Installing the Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1734681474000}'),n={name:"en_US/guide/agent.md"},t=e(`

      Installing the Agent

      The client-side service of Nezha Monitoring is called the Agent. This document will guide you on how to install the Agent on the client server and connect it to the Dashboard.

      TIP

      The binary repository for the Agent is available at: https://github.com/nezhahq/agent/releases

      One-click Installation of the Agent

      Nezha Monitoring supports one-click installation of the Agent on Windows, macOS, and Linux. By following the steps in this document, you can easily deploy it on your server.

      Prerequisites

      Before installation, you need to set up a communication domain in the Dashboard Admin Panel. It is not recommended to route this domain through a CDN. This document uses the example communication domains "data.example.com".

      1. In the Dashboard Admin Panel, click on your avatar to navigate to the System Settings page.
      2. In the Agent Connection Address [Domain/IP:Port] field, enter the communication domain and port, e.g., data.example.com:8008.
      3. Click Confirm to save the settings.

      One-click Installation Steps

      1. On the Servers page, click Install Command and select your corresponding operating system. The installation command will be automatically copied to your clipboard.
      2. Run the installation command on the client server. After the installation completes, return to the Servers page to check if the Agent has come online.
      3. If the installation is successful, a new server will automatically appear on the page. You can click the Edit button to assign a name to it.

      Platform-specific Instructions

      Windows Specific Instructions

      1. On the Windows server, open PowerShell.
      2. Paste and run the installation command in PowerShell.
      3. If prompted with an "Execution Policy Change" confirmation, type Y and press Enter.

      Alternative Methods to Install the Agent


      Installing the Agent on Synology DSM 7

      Click to Expand/Collapse

      Since Synology NAS devices are based on specific versions of Linux, their shell environments and package managers differ from standard Linux systems, making one-click installation scripts unsupported. Therefore, you need to manually install the Agent by following these steps:


      1. Preparation

      1. Ensure Administrator Privileges

        • Log in to the Synology management interface or SSH into the device using an administrator account.
      2. Install Necessary Dependencies
        Ensure that your Synology device has wget, unzip, or curl installed.

      TIP

      Alternatively, you can download and extract the Nezha Agent binaries in advance and manually upload them via Synology's DSM File Station, bypassing the need to install dependencies.


      2. Download the Nezha Agent

      1. Determine the Synology CPU Architecture
        Use the following command to identify your device's architecture:

        bash
        uname -m

        Common architecture mappings:

        • x86_64 corresponds to amd64
        • armv7l or aarch64 corresponds to arm
      2. Download the Appropriate Nezha Agent Binary
        Select the correct download link based on your device's architecture. For example, for amd64:

        bash
        wget -O nezha-agent.zip https://github.com/nezhahq/agent/releases/latest/download/nezha-agent_linux_amd64.zip
      3. Extract the Files
        Extract the downloaded archive to a specified directory, such as /opt/nezha:

        bash
        mkdir -p /opt/nezha
        +import{_ as s,c as i,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Installing the Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1734688054000}'),n={name:"en_US/guide/agent.md"},t=e(`

        Installing the Agent

        The client-side service of Nezha Monitoring is called the Agent. This document will guide you on how to install the Agent on the client server and connect it to the Dashboard.

        TIP

        The binary repository for the Agent is available at: https://github.com/nezhahq/agent/releases

        One-click Installation of the Agent

        Nezha Monitoring supports one-click installation of the Agent on Windows, macOS, and Linux. By following the steps in this document, you can easily deploy it on your server.

        Prerequisites

        Before installation, you need to set up a communication domain in the Dashboard Admin Panel. It is not recommended to route this domain through a CDN. This document uses the example communication domains "data.example.com".

        1. In the Dashboard Admin Panel, click on your avatar to navigate to the System Settings page.
        2. In the Agent Connection Address [Domain/IP:Port] field, enter the communication domain and port, e.g., data.example.com:8008.
        3. Click Confirm to save the settings.

        One-click Installation Steps

        1. On the Servers page, click Install Command and select your corresponding operating system. The installation command will be automatically copied to your clipboard.
        2. Run the installation command on the client server. After the installation completes, return to the Servers page to check if the Agent has come online.
        3. If the installation is successful, a new server will automatically appear on the page. You can click the Edit button to assign a name to it.

        Platform-specific Instructions

        Windows Specific Instructions

        1. On the Windows server, open PowerShell.
        2. Paste and run the installation command in PowerShell.
        3. If prompted with an "Execution Policy Change" confirmation, type Y and press Enter.

        Alternative Methods to Install the Agent


        Installing the Agent on Synology DSM 7

        Click to Expand/Collapse

        Since Synology NAS devices are based on specific versions of Linux, their shell environments and package managers differ from standard Linux systems, making one-click installation scripts unsupported. Therefore, you need to manually install the Agent by following these steps:


        1. Preparation

        1. Ensure Administrator Privileges

          • Log in to the Synology management interface or SSH into the device using an administrator account.
        2. Install Necessary Dependencies
          Ensure that your Synology device has wget, unzip, or curl installed.

        TIP

        Alternatively, you can download and extract the Nezha Agent binaries in advance and manually upload them via Synology's DSM File Station, bypassing the need to install dependencies.


        2. Download the Nezha Agent

        1. Determine the Synology CPU Architecture
          Use the following command to identify your device's architecture:

          bash
          uname -m

          Common architecture mappings:

          • x86_64 corresponds to amd64
          • armv7l or aarch64 corresponds to arm
        2. Download the Appropriate Nezha Agent Binary
          Select the correct download link based on your device's architecture. For example, for amd64:

          bash
          wget -O nezha-agent.zip https://github.com/nezhahq/agent/releases/latest/download/nezha-agent_linux_amd64.zip
        3. Extract the Files
          Extract the downloaded archive to a specified directory, such as /opt/nezha:

          bash
          mkdir -p /opt/nezha
           unzip nezha-agent.zip -d /opt/nezha
        4. Grant Execute Permissions

          bash
          chmod +x /opt/nezha/nezha-agent

        3. Create the Configuration File

        1. Create and Edit the Configuration File
          In the /opt/nezha directory, create a config.yml file with the following content:
          yaml
          client_secret: your_agent_secret
           debug: false
           disable_auto_update: false
          diff --git a/assets/en_US_guide_agent.md.-aVSue02.lean.js b/assets/en_US_guide_agent.md.BGW-EA-i.lean.js
          similarity index 85%
          rename from assets/en_US_guide_agent.md.-aVSue02.lean.js
          rename to assets/en_US_guide_agent.md.BGW-EA-i.lean.js
          index c0213b0f0..7f7cdddbc 100644
          --- a/assets/en_US_guide_agent.md.-aVSue02.lean.js
          +++ b/assets/en_US_guide_agent.md.BGW-EA-i.lean.js
          @@ -1 +1 @@
          -import{_ as s,c as i,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Installing the Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1734681474000}'),n={name:"en_US/guide/agent.md"},t=e("",28),l=[t];function h(p,o,r,d,k,c){return a(),i("div",null,l)}const y=s(n,[["render",h]]);export{u as __pageData,y as default};
          +import{_ as s,c as i,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Installing the Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1734688054000}'),n={name:"en_US/guide/agent.md"},t=e("",28),l=[t];function h(p,o,r,d,k,c){return a(),i("div",null,l)}const y=s(n,[["render",h]]);export{u as __pageData,y as default};
          diff --git a/assets/en_US_guide_agentq.md.C6CnuAqB.js b/assets/en_US_guide_agentq.md.Wb7wo2WT.js
          similarity index 99%
          rename from assets/en_US_guide_agentq.md.C6CnuAqB.js
          rename to assets/en_US_guide_agentq.md.Wb7wo2WT.js
          index b8430409a..673ccbc86 100644
          --- a/assets/en_US_guide_agentq.md.C6CnuAqB.js
          +++ b/assets/en_US_guide_agentq.md.Wb7wo2WT.js
          @@ -1 +1 @@
          -import{_ as e,c as t,o as a,a4 as i}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Agent FAQ","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1734681474000}'),n={name:"en_US/guide/agentq.md"},s=i('

          Agent FAQ


          Why is the IP displayed in the Dashboard different from the Agent's actual IP?

          If the IP displayed in the Dashboard is inconsistent with the Agent's actual IP, please refer to Dashboard FAQ - Why is the IP shown in the management panel different from the Agent's actual IP?.
          Detailed solutions to this issue are provided in the related document and will not be repeated here.


          Errors During One-Click Script Installation

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

          This issue commonly occurs on servers located in Mainland China due to unstable connections to GitHub. Solutions include:

          1. Retry the script multiple times: Simply rerun the one-click installation script a few more times.
          2. Manual Installation: Follow the guide for manual Agent installation.
          3. Use an acceleration service: Utilize third-party GitHub acceleration services or mirrors. Replace the download URL in the installation script with the accelerated link.

          2. sudo: command not found

          If the error sudo: command not found appears, it means the sudo tool is not installed on the target server. Solutions include:

          1. Install sudo manually:

            • For Ubuntu systems:
              shell
              apt install sudo
            • For CentOS systems:
              shell
              yum install sudo
          2. Verify installation: After installing sudo, rerun the one-click installation script.


          Multiple Configuration Files Appearing in the Agent Installation Directory, and Multiple Agent Services Installed on the System

          This issue occurs because the Agent installation script was run multiple times. The Agent supports installing multiple system services based on different configuration files, so the script does not overwrite the existing installation but instead installs new configurations as separate system services.

          You can use the Agent script's uninstall function to remove all configuration files and their associated services:

          bash
          ./agent.sh uninstall

          Does the Agent Have a Docker Image?

          The Agent currently does not offer a Docker image.
          Unlike the Dashboard, which aims to minimize its impact on the host system, the Agent is designed to deeply integrate with the host to perform monitoring services and command execution tasks.

          Although running the Agent inside a container may still allow monitoring, functionalities like WebShell will not work properly. Therefore, the official project does not provide Docker image support.

          ',22),o=[s];function l(r,h,d,c,p,u){return a(),t("div",null,o)}const f=e(n,[["render",l]]);export{m as __pageData,f as default}; +import{_ as e,c as t,o as a,a4 as i}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Agent FAQ","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1734688054000}'),n={name:"en_US/guide/agentq.md"},s=i('

          Agent FAQ


          Why is the IP displayed in the Dashboard different from the Agent's actual IP?

          If the IP displayed in the Dashboard is inconsistent with the Agent's actual IP, please refer to Dashboard FAQ - Why is the IP shown in the management panel different from the Agent's actual IP?.
          Detailed solutions to this issue are provided in the related document and will not be repeated here.


          Errors During One-Click Script Installation

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

          This issue commonly occurs on servers located in Mainland China due to unstable connections to GitHub. Solutions include:

          1. Retry the script multiple times: Simply rerun the one-click installation script a few more times.
          2. Manual Installation: Follow the guide for manual Agent installation.
          3. Use an acceleration service: Utilize third-party GitHub acceleration services or mirrors. Replace the download URL in the installation script with the accelerated link.

          2. sudo: command not found

          If the error sudo: command not found appears, it means the sudo tool is not installed on the target server. Solutions include:

          1. Install sudo manually:

            • For Ubuntu systems:
              shell
              apt install sudo
            • For CentOS systems:
              shell
              yum install sudo
          2. Verify installation: After installing sudo, rerun the one-click installation script.


          Multiple Configuration Files Appearing in the Agent Installation Directory, and Multiple Agent Services Installed on the System

          This issue occurs because the Agent installation script was run multiple times. The Agent supports installing multiple system services based on different configuration files, so the script does not overwrite the existing installation but instead installs new configurations as separate system services.

          You can use the Agent script's uninstall function to remove all configuration files and their associated services:

          bash
          ./agent.sh uninstall

          Does the Agent Have a Docker Image?

          The Agent currently does not offer a Docker image.
          Unlike the Dashboard, which aims to minimize its impact on the host system, the Agent is designed to deeply integrate with the host to perform monitoring services and command execution tasks.

          Although running the Agent inside a container may still allow monitoring, functionalities like WebShell will not work properly. Therefore, the official project does not provide Docker image support.

          ',22),o=[s];function l(r,h,d,c,p,u){return a(),t("div",null,o)}const f=e(n,[["render",l]]);export{m as __pageData,f as default}; diff --git a/assets/en_US_guide_agentq.md.C6CnuAqB.lean.js b/assets/en_US_guide_agentq.md.Wb7wo2WT.lean.js similarity index 85% rename from assets/en_US_guide_agentq.md.C6CnuAqB.lean.js rename to assets/en_US_guide_agentq.md.Wb7wo2WT.lean.js index e4a118941..61e140623 100644 --- a/assets/en_US_guide_agentq.md.C6CnuAqB.lean.js +++ b/assets/en_US_guide_agentq.md.Wb7wo2WT.lean.js @@ -1 +1 @@ -import{_ as e,c as t,o as a,a4 as i}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Agent FAQ","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1734681474000}'),n={name:"en_US/guide/agentq.md"},s=i("",22),o=[s];function l(r,h,d,c,p,u){return a(),t("div",null,o)}const f=e(n,[["render",l]]);export{m as __pageData,f as default}; +import{_ as e,c as t,o as a,a4 as i}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Agent FAQ","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1734688054000}'),n={name:"en_US/guide/agentq.md"},s=i("",22),o=[s];function l(r,h,d,c,p,u){return a(),t("div",null,o)}const f=e(n,[["render",l]]);export{m as __pageData,f as default}; diff --git a/assets/en_US_guide_api.md.D3oJt-34.js b/assets/en_US_guide_api.md.CvF0Kqpv.js similarity index 99% rename from assets/en_US_guide_api.md.D3oJt-34.js rename to assets/en_US_guide_api.md.CvF0Kqpv.js index c6926ec33..34cc6d63e 100644 --- a/assets/en_US_guide_api.md.D3oJt-34.js +++ b/assets/en_US_guide_api.md.CvF0Kqpv.js @@ -1,4 +1,4 @@ -import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"API Interface","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1734681474000}'),t={name:"en_US/guide/api.md"},h=n(`

          API Interface

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

          Creating a Token

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

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

          WARNING

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

          Authentication Method

          Ensure the request header contains Authorization: Token for authentication.

          Token authentication method:

          Request Headers:
          +import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"API Interface","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1734688054000}'),t={name:"en_US/guide/api.md"},h=n(`

          API Interface

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

          Creating a Token

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

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

          WARNING

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

          Authentication Method

          Ensure the request header contains Authorization: Token for authentication.

          Token authentication method:

          Request Headers:
           Authorization: Token

          Usage Instructions

          WARNING

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

          TIP

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

          Get Server List

          Request:

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

          Parameters:

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

          Example response:

          json
          {
               "code": 0,
               "message": "success",
          diff --git a/assets/en_US_guide_api.md.D3oJt-34.lean.js b/assets/en_US_guide_api.md.CvF0Kqpv.lean.js
          similarity index 85%
          rename from assets/en_US_guide_api.md.D3oJt-34.lean.js
          rename to assets/en_US_guide_api.md.CvF0Kqpv.lean.js
          index 57875b3af..1fbd0247a 100644
          --- a/assets/en_US_guide_api.md.D3oJt-34.lean.js
          +++ b/assets/en_US_guide_api.md.CvF0Kqpv.lean.js
          @@ -1 +1 @@
          -import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"API Interface","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1734681474000}'),t={name:"en_US/guide/api.md"},h=n("",61),k=[h];function l(p,e,E,r,d,o){return a(),i("div",null,k)}const y=s(t,[["render",l]]);export{F as __pageData,y as default};
          +import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"API Interface","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1734688054000}'),t={name:"en_US/guide/api.md"},h=n("",61),k=[h];function l(p,e,E,r,d,o){return a(),i("div",null,k)}const y=s(t,[["render",l]]);export{F as __pageData,y as default};
          diff --git a/assets/en_US_guide_dashboard.md.BE5Z5o_F.js b/assets/en_US_guide_dashboard.md.DzRaNP_Q.js
          similarity index 99%
          rename from assets/en_US_guide_dashboard.md.BE5Z5o_F.js
          rename to assets/en_US_guide_dashboard.md.DzRaNP_Q.js
          index dfcfdb095..4bdf2a2b9 100644
          --- a/assets/en_US_guide_dashboard.md.BE5Z5o_F.js
          +++ b/assets/en_US_guide_dashboard.md.DzRaNP_Q.js
          @@ -1 +1 @@
          -import{_ as a,c as e,o as s,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Installing the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1734681474000}'),t={name:"en_US/guide/dashboard.md"},o=i('

          Installing the Dashboard

          Prerequisites

          To set up the Nezha Monitoring Dashboard, you will need:

          1. A server with public internet access. Ensure that firewall and security policies allow traffic on port 8008; otherwise, access or data reception will fail. A single-core server with 512MB of RAM is sufficient for most use cases.
          2. A domain name with an A record pointing to your Dashboard server's IP address.

          TIP

          If you plan to use a CDN, prepare two domain names:

          • One configured with a CDN for public access. The CDN must support the WebSocket protocol.
          • Another domain without CDN for communication between the Agent and Dashboard.

          Although V1 no longer differentiates between access and communication ports, preparing two domains is recommended to avoid potential issues caused by specific CDN configurations (not mandatory).

          This guide uses "dashboard.example.com" and "data.example.com" as examples.


          Installing the Dashboard on the Server

          Run the following script on your server to install the Dashboard:

          bash
          curl -L https://raw.githubusercontent.com/nezhahq/scripts/refs/heads/main/install_en.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh

          For a Docker installation, after running the script, follow the prompts to input the following details:

          • Enter site title: - Customize your site title.
          • Enter exposed port: - Set the public access port (default is 8008, customizable).
          • Select the language: - Choose your preferred language.

          Once the inputs are complete, the Docker image will be pulled. After the installation is complete and running successfully, you can access the Dashboard via the domain and port, such as:
          http://dashboard.example.com:8008

          To rerun the installation script in the future, use:

          bash
          ./nezha.sh

          This will reopen the management script.


          Logging into the Dashboard Admin Panel

          The Dashboard Admin Panel is available at:
          http://dashboard.example.com:8008/dashboard

          The default username and password for the first login are both admin.

          WARNING

          The default password is weak, which poses a significant security risk for a high-privilege dashboard.
          It is strongly recommended to immediately change the password after installation:
          Navigate to your profile by clicking on the avatar → "Personal Information" → "Update Profile."
          Create a strong password with a minimum of 18 characters, including a mix of uppercase and lowercase letters, numbers, and symbols.


          Configuring Reverse Proxy

          Refer to Dashboard Reverse Proxy Configuration.


          Updating the Dashboard

          To update the Dashboard, run the following script:

          bash
          ./nezha.sh

          Then, select the option to restart and update the Dashboard.

          ',29),n=[o];function r(h,l,d,p,c,u){return s(),e("div",null,n)}const m=a(t,[["render",r]]);export{b as __pageData,m as default}; +import{_ as a,c as e,o as s,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Installing the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1734688054000}'),t={name:"en_US/guide/dashboard.md"},o=i('

          Installing the Dashboard

          Prerequisites

          To set up the Nezha Monitoring Dashboard, you will need:

          1. A server with public internet access. Ensure that firewall and security policies allow traffic on port 8008; otherwise, access or data reception will fail. A single-core server with 512MB of RAM is sufficient for most use cases.
          2. A domain name with an A record pointing to your Dashboard server's IP address.

          TIP

          If you plan to use a CDN, prepare two domain names:

          • One configured with a CDN for public access. The CDN must support the WebSocket protocol.
          • Another domain without CDN for communication between the Agent and Dashboard.

          Although V1 no longer differentiates between access and communication ports, preparing two domains is recommended to avoid potential issues caused by specific CDN configurations (not mandatory).

          This guide uses "dashboard.example.com" and "data.example.com" as examples.


          Installing the Dashboard on the Server

          Run the following script on your server to install the Dashboard:

          bash
          curl -L https://raw.githubusercontent.com/nezhahq/scripts/refs/heads/main/install_en.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh

          For a Docker installation, after running the script, follow the prompts to input the following details:

          • Enter site title: - Customize your site title.
          • Enter exposed port: - Set the public access port (default is 8008, customizable).
          • Select the language: - Choose your preferred language.

          Once the inputs are complete, the Docker image will be pulled. After the installation is complete and running successfully, you can access the Dashboard via the domain and port, such as:
          http://dashboard.example.com:8008

          To rerun the installation script in the future, use:

          bash
          ./nezha.sh

          This will reopen the management script.


          Logging into the Dashboard Admin Panel

          The Dashboard Admin Panel is available at:
          http://dashboard.example.com:8008/dashboard

          The default username and password for the first login are both admin.

          WARNING

          The default password is weak, which poses a significant security risk for a high-privilege dashboard.
          It is strongly recommended to immediately change the password after installation:
          Navigate to your profile by clicking on the avatar → "Personal Information" → "Update Profile."
          Create a strong password with a minimum of 18 characters, including a mix of uppercase and lowercase letters, numbers, and symbols.


          Configuring Reverse Proxy

          Refer to Dashboard Reverse Proxy Configuration.


          Updating the Dashboard

          To update the Dashboard, run the following script:

          bash
          ./nezha.sh

          Then, select the option to restart and update the Dashboard.

          ',29),n=[o];function r(h,l,d,p,c,u){return s(),e("div",null,n)}const m=a(t,[["render",r]]);export{b as __pageData,m as default}; diff --git a/assets/en_US_guide_dashboard.md.BE5Z5o_F.lean.js b/assets/en_US_guide_dashboard.md.DzRaNP_Q.lean.js similarity index 86% rename from assets/en_US_guide_dashboard.md.BE5Z5o_F.lean.js rename to assets/en_US_guide_dashboard.md.DzRaNP_Q.lean.js index 3babade81..3c32e869f 100644 --- a/assets/en_US_guide_dashboard.md.BE5Z5o_F.lean.js +++ b/assets/en_US_guide_dashboard.md.DzRaNP_Q.lean.js @@ -1 +1 @@ -import{_ as a,c as e,o as s,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Installing the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1734681474000}'),t={name:"en_US/guide/dashboard.md"},o=i("",29),n=[o];function r(h,l,d,p,c,u){return s(),e("div",null,n)}const m=a(t,[["render",r]]);export{b as __pageData,m as default}; +import{_ as a,c as e,o as s,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Installing the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1734688054000}'),t={name:"en_US/guide/dashboard.md"},o=i("",29),n=[o];function r(h,l,d,p,c,u){return s(),e("div",null,n)}const m=a(t,[["render",r]]);export{b as __pageData,m as default}; diff --git a/assets/en_US_guide_dashboardq.md.B1U2xENE.js b/assets/en_US_guide_dashboardq.md.BnJfSQtO.js similarity index 99% rename from assets/en_US_guide_dashboardq.md.B1U2xENE.js rename to assets/en_US_guide_dashboardq.md.BnJfSQtO.js index d92255788..ed8abdff1 100644 --- a/assets/en_US_guide_dashboardq.md.B1U2xENE.js +++ b/assets/en_US_guide_dashboardq.md.BnJfSQtO.js @@ -1,4 +1,4 @@ -import{_ as e,c as a,o as s,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Dashboard FAQ","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1734681474000}'),t={name:"en_US/guide/dashboardq.md"},n=i(`

          Dashboard FAQ


          Why is the IP displayed in the Dashboard different from the Agent's actual IP?

          The IP displayed in the Dashboard is the outbound IP detected and reported by the Agent using IP-API.
          If the displayed IP differs from the one provided by your service provider, possible reasons include:

          1. Service Provider Uses an Inbound IP: The IP provided by your service provider might be a high-defense or mapped inbound IP rather than the actual outbound IP.
          2. Multi-line or Dedicated Line Environments: Multi-line servers or IPLC dedicated lines may cause discrepancies in outbound IPs.

          Verify the Outbound IP

          Run the following commands on the Agent server to test the outbound IP:

          shell
          curl https://ipapi.co/ip/
          +import{_ as e,c as a,o as s,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Dashboard FAQ","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1734688054000}'),t={name:"en_US/guide/dashboardq.md"},n=i(`

          Dashboard FAQ


          Why is the IP displayed in the Dashboard different from the Agent's actual IP?

          The IP displayed in the Dashboard is the outbound IP detected and reported by the Agent using IP-API.
          If the displayed IP differs from the one provided by your service provider, possible reasons include:

          1. Service Provider Uses an Inbound IP: The IP provided by your service provider might be a high-defense or mapped inbound IP rather than the actual outbound IP.
          2. Multi-line or Dedicated Line Environments: Multi-line servers or IPLC dedicated lines may cause discrepancies in outbound IPs.

          Verify the Outbound IP

          Run the following commands on the Agent server to test the outbound IP:

          shell
          curl https://ipapi.co/ip/
           curl ip.sb
           curl ip-api.com

          Dashboard Installation/Restart/Update Fails with: iptables ......

          1. Restart Docker
            Run the following commands to restart Docker:

            shell
            systemctl status docker
             systemctl restart docker
            diff --git a/assets/en_US_guide_dashboardq.md.B1U2xENE.lean.js b/assets/en_US_guide_dashboardq.md.BnJfSQtO.lean.js
            similarity index 86%
            rename from assets/en_US_guide_dashboardq.md.B1U2xENE.lean.js
            rename to assets/en_US_guide_dashboardq.md.BnJfSQtO.lean.js
            index 0c21281f5..43e2afbdf 100644
            --- a/assets/en_US_guide_dashboardq.md.B1U2xENE.lean.js
            +++ b/assets/en_US_guide_dashboardq.md.BnJfSQtO.lean.js
            @@ -1 +1 @@
            -import{_ as e,c as a,o as s,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Dashboard FAQ","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1734681474000}'),t={name:"en_US/guide/dashboardq.md"},n=i("",73),o=[n];function r(l,h,d,c,p,g){return s(),a("div",null,o)}const k=e(t,[["render",r]]);export{b as __pageData,k as default};
            +import{_ as e,c as a,o as s,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Dashboard FAQ","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1734688054000}'),t={name:"en_US/guide/dashboardq.md"},n=i("",73),o=[n];function r(l,h,d,c,p,g){return s(),a("div",null,o)}const k=e(t,[["render",r]]);export{b as __pageData,k as default};
            diff --git a/assets/en_US_guide_ddns.md.Cw9Hj6WW.js b/assets/en_US_guide_ddns.md.Da8JgC6E.js
            similarity index 99%
            rename from assets/en_US_guide_ddns.md.Cw9Hj6WW.js
            rename to assets/en_US_guide_ddns.md.Da8JgC6E.js
            index ca81ec8d7..2ed2ff1e8 100644
            --- a/assets/en_US_guide_ddns.md.Cw9Hj6WW.js
            +++ b/assets/en_US_guide_ddns.md.Da8JgC6E.js
            @@ -1,4 +1,4 @@
            -import{_ as e,c as t,o as s,a4 as i}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"DDNS","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/ddns.md","filePath":"en_US/guide/ddns.md","lastUpdated":1734681474000}'),o={name:"en_US/guide/ddns.md"},a=i(`

            DDNS

            The DDNS feature is designed for servers using dynamic IP addresses. When an Agent reports a new IP every 10 minutes, the Dashboard automatically updates the DNS records based on your configuration.

            Why Use Nezha's DDNS Feature?

            • Centralized Management: Conveniently manage DDNS settings in the Dashboard without deploying separate DDNS services on each server.
            • Enhanced Security: Sensitive information is only stored on the Dashboard server, reducing the risk of data leaks.

            Configuration Instructions

            DDNS can be configured directly in the Dashboard's admin panel.

            1. Access the DDNS Configuration Page
              Navigate to the DDNS option in the menu to open the configuration page.

            2. Create a New Configuration
              Click New Configuration and fill in the following details:

              • Name: A unique name for identifying the configuration.
              • DDNS Provider: Select the DNS provider.
              • Domain (comma-separated): Enter the domains to be updated, separated by commas if multiple. Supports IDNs (Internationalized Domain Names).
              • Max Retry Attempts: The maximum number of retries for DDNS updates (default: 3, range: 1–10).
              • DDNS Credential 1 and DDNS Credential 2: Optional credentials depending on the provider (see Provider List).
            3. Webhook-Specific Configuration
              If using the webhook provider, follow the Webhook Configuration Instructions.

            4. Enable Options
              Enable at least one of DDNS for IPv4 or DDNS for IPv6; otherwise, updates will not occur.

            5. Associate with Servers
              After adding a DDNS configuration, modify the server settings to enable DDNS functionality:

              • Enable DDNS: Go to the Servers page and enable DDNS for the target server.
              • DDNS Configuration: Select the appropriate DDNS configuration ID, which can be searched by name.

            Webhook Configuration Instructions

            Webhooks allow you to customize HTTP requests for third-party services or other specialized needs.

            Options

            • Webhook URL: The URL for the HTTP request, supporting placeholder substitution.
            • Webhook Request Method: Choose from GET, POST, PATCH, DELETE, or PUT.
            • Webhook Request Type: The request body format, either JSON or Form.
            • Webhook Request Headers: Input headers in JSON format (nested headers are not supported).
            • Webhook Request Body: Not used for GET and DELETE. For nested formats, use JSON.

            Placeholders

            PlaceholderDescription
            #ip#Host IP address
            #domain#Domain (one domain per request)
            #type#IP type: "ipv4" or "ipv6"
            #record#Record type: "A" or "AAAA"
            #access_id#DDNS Credential 1
            #access_secret#DDNS Credential 2

            Oray Webhook Example

            Click to Expand/Collapse
            - +`-- nezha-agent # Nezha client, used to monitor the localhost.

          Acknowledgements for articles and projects by

          Disclaimer

          • This program is only for learning and understanding, non-profit purposes, please delete within 24 hours after downloading, not for any commercial purposes, text, data and images are copyrighted, if reproduced must indicate the source.
          • Use of this program is subject to the deployment disclaimer. Use of this program must follow the deployment of the server location, the country and the user's country laws and regulations, the author of the program is not responsible for any misconduct of the user.
+ \ No newline at end of file diff --git a/en_US/case/case6.html b/en_US/case/case6.html index e6d21e805..065e50aed 100644 --- a/en_US/case/case6.html +++ b/en_US/case/case6.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
Skip to content

Nezha Mobile - An iOS Client For Nezha Dashboard

Contributor:

Contribute to the project

Project Link

INFO

We appreciate any contribution to the project, and we will actively merge your commits into next Release. However, we may modify your work in order to comply with App Review Guidelines.

Download on the App Store

Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917

WARNING

Due to ICP Filing Policy, Nezha Mobile is not available in China mainland.

TestFlight Testing Program

Join TestFlight Testing

Instructions

  • Enter your Dashboard Link, username and password at your first use. Dashboard Link looks like server.hidandelion.com. Do not add a protocol prefix or a trailing slash to the link. API Token can be retrieved from Admin Center of Dashboard. step1

Configure Widget(Optional)

  • Add a widget on your Springboard. Long-tap the widget and then tap Edit Widget. step2

  • Choose a server you want to monitor on the next view. You can choose different servers for each widget. step3

- +
Skip to content

Nezha Mobile - An iOS Client For Nezha Dashboard

Contributor:

Contribute to the project

Project Link

INFO

We appreciate any contribution to the project, and we will actively merge your commits into next Release. However, we may modify your work in order to comply with App Review Guidelines.

Download on the App Store

Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917

WARNING

Due to ICP Filing Policy, Nezha Mobile is not available in China mainland.

TestFlight Testing Program

Join TestFlight Testing

Instructions

  • Enter your Dashboard Link, username and password at your first use. Dashboard Link looks like server.hidandelion.com. Do not add a protocol prefix or a trailing slash to the link. API Token can be retrieved from Admin Center of Dashboard. step1

Configure Widget(Optional)

  • Add a widget on your Springboard. Long-tap the widget and then tap Edit Widget. step2

  • Choose a server you want to monitor on the next view. You can choose different servers for each widget. step3

+ \ No newline at end of file diff --git a/en_US/case/case7.html b/en_US/case/case7.html index c2ec64423..5cc1cb535 100644 --- a/en_US/case/case7.html +++ b/en_US/case/case7.html @@ -12,8 +12,8 @@ - - + + @@ -23,8 +23,8 @@ -
Skip to content

Broker for Nezha - Advancing on more platforms

Contributor:

Broker for Nezha is a modified version of the Nezha Agent that separates data collection from gRPC reporting, enabling small devices to connect to the Nezha Dashboard.

Project link: https://codeberg.org/uubulb/broker

Online Documentation: Broker for Nezha

Difference from Nezha Agent

  • Utilizes external data sources to report to Nezha Dashboard.
  • Supports configuring multiple sources and connecting to multiple Dashboards.
  • Only has limited task support. For details, view the project README.

Broker for Nezha needs to be used with specific data collection software. Currently, it provides two data collection methods:

  1. HTTP (HTTP/1.1) - Active polling
  2. TCP - Passive collection (recommended to avoid creating redundant connections)

For existing data collection software, refer to the project README. Due to security concerns, it's recommended to use this only in a trusted network.

Writing a Data Collector

If you need to write your own data collector, you'll need to implement a basic HTTP server or TCP client and use a specific data format that Broker can recognize. For details, see: Data types

Examples

Dashboard
Dashboard

WebSSH
WebSSH
- +
Skip to content

Broker for Nezha - Advancing on more platforms

Contributor:

Broker for Nezha is a modified version of the Nezha Agent that separates data collection from gRPC reporting, enabling small devices to connect to the Nezha Dashboard.

Project link: https://codeberg.org/uubulb/broker

Online Documentation: Broker for Nezha

Difference from Nezha Agent

  • Utilizes external data sources to report to Nezha Dashboard.
  • Supports configuring multiple sources and connecting to multiple Dashboards.
  • Only has limited task support. For details, view the project README.

Broker for Nezha needs to be used with specific data collection software. Currently, it provides two data collection methods:

  1. HTTP (HTTP/1.1) - Active polling
  2. TCP - Passive collection (recommended to avoid creating redundant connections)

For existing data collection software, refer to the project README. Due to security concerns, it's recommended to use this only in a trusted network.

Writing a Data Collector

If you need to write your own data collector, you'll need to implement a basic HTTP server or TCP client and use a specific data format that Broker can recognize. For details, see: Data types

Examples

Dashboard
Dashboard

WebSSH
WebSSH
+ \ No newline at end of file diff --git a/en_US/case/case8.html b/en_US/case/case8.html index fc81ac359..d52378790 100644 --- a/en_US/case/case8.html +++ b/en_US/case/case8.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
Skip to content

Serverless Telegram Bot for Nezha

Contributor:

Project URL: https://github.com/swkisdust/plain-nezha-bot

A single-user, single-instance, multi-language private chat Nezha Telegram bot that can be deployed on Cloudflare Workers.

Inspired by https://github.com/nezhahq/Nezha-Telegram-Bot-V1

Deployment

  1. Clone this project and run npm install to install dependencies.
  2. Create a Workers KV namespace using your preferred method and save its ID.
  3. Modify wrangler.toml and update the kv_namespaces field with your KV information.
  4. Modify wrangler.toml under vars:
  • NZ_BASEURL: Panel address, e.g., https://qio.ng.
  • LANG: Language, options are en and zh-CN, default is en.
  • ENDPOINT_PATH: Route path for receiving Telegram Webhook, e.g., /endpoint.
  1. Create the following Secrets:
  • TELEGRAM_BOT_TOKEN: Bot token obtained from BotFather.
  • TELEGRAM_SECRET: Webhook authentication key.
  • TELEGRAM_UID: User UID, the bot will not interact with anyone other than this UID.
  • PASSWORD: Basic authentication password for register/unregister/refresh token operations.
  • NZ_USERNAME: Panel username for initial authentication and subsequent refreshes.
  • NZ_PASSWORD: Panel password for initial authentication and subsequent refreshes.
  1. Run npx wrangler deploy to deploy the project.

Usage

Access the /register route to register the Webhook and start using the bot.

If you do not need the bot temporarily, you can access /unregister to remove the Webhook.

By default, the token refresh operation is triggered every 30 minutes. You can modify this manually in wrangler.toml or access /refresh to refresh manually.

- +
Skip to content

Serverless Telegram Bot for Nezha

Contributor:

Project URL: https://github.com/swkisdust/plain-nezha-bot

A single-user, single-instance, multi-language private chat Nezha Telegram bot that can be deployed on Cloudflare Workers.

Inspired by https://github.com/nezhahq/Nezha-Telegram-Bot-V1

Deployment

  1. Clone this project and run npm install to install dependencies.
  2. Create a Workers KV namespace using your preferred method and save its ID.
  3. Modify wrangler.toml and update the kv_namespaces field with your KV information.
  4. Modify wrangler.toml under vars:
  • NZ_BASEURL: Panel address, e.g., https://qio.ng.
  • LANG: Language, options are en and zh-CN, default is en.
  • ENDPOINT_PATH: Route path for receiving Telegram Webhook, e.g., /endpoint.
  1. Create the following Secrets:
  • TELEGRAM_BOT_TOKEN: Bot token obtained from BotFather.
  • TELEGRAM_SECRET: Webhook authentication key.
  • TELEGRAM_UID: User UID, the bot will not interact with anyone other than this UID.
  • PASSWORD: Basic authentication password for register/unregister/refresh token operations.
  • NZ_USERNAME: Panel username for initial authentication and subsequent refreshes.
  • NZ_PASSWORD: Panel password for initial authentication and subsequent refreshes.
  1. Run npx wrangler deploy to deploy the project.

Usage

Access the /register route to register the Webhook and start using the bot.

If you do not need the bot temporarily, you can access /unregister to remove the Webhook.

By default, the token refresh operation is triggered every 30 minutes. You can modify this manually in wrangler.toml or access /refresh to refresh manually.

+ \ No newline at end of file diff --git a/en_US/case/case9.html b/en_US/case/case9.html index ac789b021..a7022fee0 100644 --- a/en_US/case/case9.html +++ b/en_US/case/case9.html @@ -13,7 +13,7 @@ - + @@ -23,8 +23,8 @@ -
Skip to content

MDPings - Android Client for Nezha Dashboard

MDPings is an Android client designed with Material Design 3 (MD3) style and developed based on the Nezha Monitoring API. It allows users to monitor the status of multiple servers, view historical network statistics and latency charts, and execute simple, low-interaction commands via the device terminal.


Contributor


Key Features

  1. Multi-Dashboard Switching

    • Easily connect and switch between multiple Nezha Dashboards.
  2. Total Traffic Monitoring

    • View total traffic statistics across all servers.
  3. SSH Terminal Support

    • Execute simple commands via the terminal (requires SSH connection enabled in Nezha Dashboard).
  4. MD3 Style Design

    • Adopts Material Design 3 for adaptive layouts across devices.

Application Screenshots

Screenshot 1Screenshot 2Screenshot 3Screenshot 4

Project Repository

GitHub - MDPings


Releases - MDPings

- +
Skip to content

MDPings - Android Client for Nezha Dashboard

MDPings is an Android client designed with Material Design 3 (MD3) style and developed based on the Nezha Monitoring API. It allows users to monitor the status of multiple servers, view historical network statistics and latency charts, and execute simple, low-interaction commands via the device terminal.


Contributor


Key Features

  1. Multi-Dashboard Switching

    • Easily connect and switch between multiple Nezha Dashboards.
  2. Total Traffic Monitoring

    • View total traffic statistics across all servers.
  3. SSH Terminal Support

    • Execute simple commands via the terminal (requires SSH connection enabled in Nezha Dashboard).
  4. MD3 Style Design

    • Adopts Material Design 3 for adaptive layouts across devices.

Application Screenshots

Screenshot 1Screenshot 2Screenshot 3Screenshot 4

Project Repository

GitHub - MDPings


Releases - MDPings

+ \ No newline at end of file diff --git a/en_US/case/index.html b/en_US/case/index.html index 521cd55cb..4433aab05 100644 --- a/en_US/case/index.html +++ b/en_US/case/index.html @@ -12,7 +12,7 @@ - + @@ -23,7 +23,7 @@
Skip to content

Nezha Monitoring

Community Project

Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.

- + \ No newline at end of file diff --git a/en_US/developer/api.html b/en_US/developer/api.html index 552c93aca..a81d38315 100644 --- a/en_US/developer/api.html +++ b/en_US/developer/api.html @@ -12,7 +12,7 @@ - + @@ -23,8 +23,8 @@
Skip to content

API Documentation

Nezha Dashboard provides a comprehensive API documentation that allows developers to create custom applications, such as custom frontends or bots, leveraging its APIs.


Instructions

Fetching and Generating Documentation

  1. Clone the Repository
    Clone the official repository:

    bash
    git clone https://github.com/nezhahq/nezha.git
    -cd nezha
  2. Run the Bootstrap Script
    Execute the following script to generate files required for API documentation:

    bash
    ./script/bootstrap.sh
  3. Compile the Code
    If the compilation process reports missing admin-dist or user-dist directories, create empty directories as follows:

    bash
    mkdir -p dashboard/admin-dist dashboard/user-dist
  4. Enable Debug Mode
    Update the configuration to enable Debug mode and run dashboard
    The system logs will automatically display the URL for accessing the API documentation.

- +cd nezha
  • Run the Bootstrap Script
    Execute the following script to generate files required for API documentation:

    bash
    ./script/bootstrap.sh
  • Compile the Code
    If the compilation process reports missing admin-dist or user-dist directories, create empty directories as follows:

    bash
    mkdir -p dashboard/admin-dist dashboard/user-dist
  • Enable Debug Mode
    Update the configuration to enable Debug mode and run dashboard
    The system logs will automatically display the URL for accessing the API documentation.

  • + \ No newline at end of file diff --git a/en_US/developer/i18n.html b/en_US/developer/i18n.html index 28886f927..b6111a70c 100644 --- a/en_US/developer/i18n.html +++ b/en_US/developer/i18n.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    Internationalization (i18n)

    Introduction

    You can contribute to Nezha’s internationalization efforts through Hosted Weblate.

    Scope of Coverage

    Currently, i18n support mainly covers the admin frontend and the Dashboard.
    For user frontend localization, please follow the steps provided in the original repository.

    - +
    Skip to content

    Internationalization (i18n)

    Introduction

    You can contribute to Nezha’s internationalization efforts through Hosted Weblate.

    Scope of Coverage

    All Dashboard-side projects, including Nezha itself, the official user frontend and the admin frontend.

    + \ No newline at end of file diff --git a/en_US/developer/index.html b/en_US/developer/index.html index c06d43e0c..eeb36edd3 100644 --- a/en_US/developer/index.html +++ b/en_US/developer/index.html @@ -12,7 +12,7 @@ - + @@ -23,7 +23,7 @@
    Skip to content

    Development Manual

    Nezha Monitoring Development Manual.

    - + \ No newline at end of file diff --git a/en_US/guide/agent.html b/en_US/guide/agent.html index f410ae198..ad03e2ee4 100644 --- a/en_US/guide/agent.html +++ b/en_US/guide/agent.html @@ -12,7 +12,7 @@ - + @@ -116,8 +116,8 @@ start }
  • Grant Execute Permissions

    bash
    chmod +x /etc/init.d/nezha-service
  • Enable and Start the Service

    bash
    /etc/init.d/nezha-service enable
     /etc/init.d/nezha-service start
  • Verify Service Status
    Check if the service is running correctly:

    bash
    ps | grep nezha-agent

  • Note

    Uninstalling the Agent

    Uninstalling the Agent involves stopping the service, uninstalling it, and removing related files. Below are the steps for Ubuntu:

    1. Stop and uninstall the service:

      bash
      cd /opt/nezha/agent/
      -./nezha-agent service uninstall
    2. Remove the Agent folder:

      bash
      rm -rf /opt/nezha/agent/

    If multiple services are installed and removing all of them would be necessary, the Agent installation script can be used to simplify the process.

    bash
    ./agent.sh uninstall
    - +./nezha-agent service uninstall
  • Remove the Agent folder:

    bash
    rm -rf /opt/nezha/agent/
  • If multiple services are installed and removing all of them would be necessary, the Agent installation script can be used to simplify the process.

    bash
    ./agent.sh uninstall
    + \ No newline at end of file diff --git a/en_US/guide/agentq.html b/en_US/guide/agentq.html index eccd7cd31..b18af9488 100644 --- a/en_US/guide/agentq.html +++ b/en_US/guide/agentq.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    Agent FAQ


    Why is the IP displayed in the Dashboard different from the Agent's actual IP?

    If the IP displayed in the Dashboard is inconsistent with the Agent's actual IP, please refer to Dashboard FAQ - Why is the IP shown in the management panel different from the Agent's actual IP?.
    Detailed solutions to this issue are provided in the related document and will not be repeated here.


    Errors During One-Click Script Installation

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

    This issue commonly occurs on servers located in Mainland China due to unstable connections to GitHub. Solutions include:

    1. Retry the script multiple times: Simply rerun the one-click installation script a few more times.
    2. Manual Installation: Follow the guide for manual Agent installation.
    3. Use an acceleration service: Utilize third-party GitHub acceleration services or mirrors. Replace the download URL in the installation script with the accelerated link.

    2. sudo: command not found

    If the error sudo: command not found appears, it means the sudo tool is not installed on the target server. Solutions include:

    1. Install sudo manually:

      • For Ubuntu systems:
        shell
        apt install sudo
      • For CentOS systems:
        shell
        yum install sudo
    2. Verify installation: After installing sudo, rerun the one-click installation script.


    Multiple Configuration Files Appearing in the Agent Installation Directory, and Multiple Agent Services Installed on the System

    This issue occurs because the Agent installation script was run multiple times. The Agent supports installing multiple system services based on different configuration files, so the script does not overwrite the existing installation but instead installs new configurations as separate system services.

    You can use the Agent script's uninstall function to remove all configuration files and their associated services:

    bash
    ./agent.sh uninstall

    Does the Agent Have a Docker Image?

    The Agent currently does not offer a Docker image.
    Unlike the Dashboard, which aims to minimize its impact on the host system, the Agent is designed to deeply integrate with the host to perform monitoring services and command execution tasks.

    Although running the Agent inside a container may still allow monitoring, functionalities like WebShell will not work properly. Therefore, the official project does not provide Docker image support.

    - +
    Skip to content

    Agent FAQ


    Why is the IP displayed in the Dashboard different from the Agent's actual IP?

    If the IP displayed in the Dashboard is inconsistent with the Agent's actual IP, please refer to Dashboard FAQ - Why is the IP shown in the management panel different from the Agent's actual IP?.
    Detailed solutions to this issue are provided in the related document and will not be repeated here.


    Errors During One-Click Script Installation

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

    This issue commonly occurs on servers located in Mainland China due to unstable connections to GitHub. Solutions include:

    1. Retry the script multiple times: Simply rerun the one-click installation script a few more times.
    2. Manual Installation: Follow the guide for manual Agent installation.
    3. Use an acceleration service: Utilize third-party GitHub acceleration services or mirrors. Replace the download URL in the installation script with the accelerated link.

    2. sudo: command not found

    If the error sudo: command not found appears, it means the sudo tool is not installed on the target server. Solutions include:

    1. Install sudo manually:

      • For Ubuntu systems:
        shell
        apt install sudo
      • For CentOS systems:
        shell
        yum install sudo
    2. Verify installation: After installing sudo, rerun the one-click installation script.


    Multiple Configuration Files Appearing in the Agent Installation Directory, and Multiple Agent Services Installed on the System

    This issue occurs because the Agent installation script was run multiple times. The Agent supports installing multiple system services based on different configuration files, so the script does not overwrite the existing installation but instead installs new configurations as separate system services.

    You can use the Agent script's uninstall function to remove all configuration files and their associated services:

    bash
    ./agent.sh uninstall

    Does the Agent Have a Docker Image?

    The Agent currently does not offer a Docker image.
    Unlike the Dashboard, which aims to minimize its impact on the host system, the Agent is designed to deeply integrate with the host to perform monitoring services and command execution tasks.

    Although running the Agent inside a container may still allow monitoring, functionalities like WebShell will not work properly. Therefore, the official project does not provide Docker image support.

    + \ No newline at end of file diff --git a/en_US/guide/api.html b/en_US/guide/api.html index 1b35bd1d3..8d66ded3e 100644 --- a/en_US/guide/api.html +++ b/en_US/guide/api.html @@ -12,7 +12,7 @@ - + @@ -261,8 +261,8 @@ eval $CMD
    1. Grant execution permission to the script: chmod +x nezha_register.sh
    2. Get Token from Nezha dashboard, e.g. POXbxorKJBM8wPMKX8r2PdMblyXvpggB
    3. Set Environment Variables
    bash
    export NEZHA_TOKEN="POXbxorKJBM8wPMKX8r2PdMblyXvpggB" # Obtain this token from the dashboard
     export NEZHA_PROBE_ADDRESS="your_probe_address"        # Set your probe address
     export NEZHA_DASHBOARD_URL="https://nezha.example.com" # Replace with your dashboard URL
    -export NEZHA_PROBE_PORT="5555"                         # Modify this port if needed
    1. Run the script to complete node registration and probe installation:
    bash
    ./nezha_register.sh
    1. If the script runs successfully, you will see output like the following:
    bash
    Run command: ./nezha.sh install_agent probe.example.com 5555 YOUR_SECRET --tls
    - +export NEZHA_PROBE_PORT="5555" # Modify this port if needed
    1. Run the script to complete node registration and probe installation:
    bash
    ./nezha_register.sh
    1. If the script runs successfully, you will see output like the following:
    bash
    Run command: ./nezha.sh install_agent probe.example.com 5555 YOUR_SECRET --tls
    + \ No newline at end of file diff --git a/en_US/guide/dashboard.html b/en_US/guide/dashboard.html index 1e2c29ca5..453a5fa79 100644 --- a/en_US/guide/dashboard.html +++ b/en_US/guide/dashboard.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    Installing the Dashboard

    Prerequisites

    To set up the Nezha Monitoring Dashboard, you will need:

    1. A server with public internet access. Ensure that firewall and security policies allow traffic on port 8008; otherwise, access or data reception will fail. A single-core server with 512MB of RAM is sufficient for most use cases.
    2. A domain name with an A record pointing to your Dashboard server's IP address.

    TIP

    If you plan to use a CDN, prepare two domain names:

    • One configured with a CDN for public access. The CDN must support the WebSocket protocol.
    • Another domain without CDN for communication between the Agent and Dashboard.

    Although V1 no longer differentiates between access and communication ports, preparing two domains is recommended to avoid potential issues caused by specific CDN configurations (not mandatory).

    This guide uses "dashboard.example.com" and "data.example.com" as examples.


    Installing the Dashboard on the Server

    Run the following script on your server to install the Dashboard:

    bash
    curl -L https://raw.githubusercontent.com/nezhahq/scripts/refs/heads/main/install_en.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh

    For a Docker installation, after running the script, follow the prompts to input the following details:

    • Enter site title: - Customize your site title.
    • Enter exposed port: - Set the public access port (default is 8008, customizable).
    • Select the language: - Choose your preferred language.

    Once the inputs are complete, the Docker image will be pulled. After the installation is complete and running successfully, you can access the Dashboard via the domain and port, such as:
    http://dashboard.example.com:8008

    To rerun the installation script in the future, use:

    bash
    ./nezha.sh

    This will reopen the management script.


    Logging into the Dashboard Admin Panel

    The Dashboard Admin Panel is available at:
    http://dashboard.example.com:8008/dashboard

    The default username and password for the first login are both admin.

    WARNING

    The default password is weak, which poses a significant security risk for a high-privilege dashboard.
    It is strongly recommended to immediately change the password after installation:
    Navigate to your profile by clicking on the avatar → "Personal Information" → "Update Profile."
    Create a strong password with a minimum of 18 characters, including a mix of uppercase and lowercase letters, numbers, and symbols.


    Configuring Reverse Proxy

    Refer to Dashboard Reverse Proxy Configuration.


    Updating the Dashboard

    To update the Dashboard, run the following script:

    bash
    ./nezha.sh

    Then, select the option to restart and update the Dashboard.

    - +
    Skip to content

    Installing the Dashboard

    Prerequisites

    To set up the Nezha Monitoring Dashboard, you will need:

    1. A server with public internet access. Ensure that firewall and security policies allow traffic on port 8008; otherwise, access or data reception will fail. A single-core server with 512MB of RAM is sufficient for most use cases.
    2. A domain name with an A record pointing to your Dashboard server's IP address.

    TIP

    If you plan to use a CDN, prepare two domain names:

    • One configured with a CDN for public access. The CDN must support the WebSocket protocol.
    • Another domain without CDN for communication between the Agent and Dashboard.

    Although V1 no longer differentiates between access and communication ports, preparing two domains is recommended to avoid potential issues caused by specific CDN configurations (not mandatory).

    This guide uses "dashboard.example.com" and "data.example.com" as examples.


    Installing the Dashboard on the Server

    Run the following script on your server to install the Dashboard:

    bash
    curl -L https://raw.githubusercontent.com/nezhahq/scripts/refs/heads/main/install_en.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh

    For a Docker installation, after running the script, follow the prompts to input the following details:

    • Enter site title: - Customize your site title.
    • Enter exposed port: - Set the public access port (default is 8008, customizable).
    • Select the language: - Choose your preferred language.

    Once the inputs are complete, the Docker image will be pulled. After the installation is complete and running successfully, you can access the Dashboard via the domain and port, such as:
    http://dashboard.example.com:8008

    To rerun the installation script in the future, use:

    bash
    ./nezha.sh

    This will reopen the management script.


    Logging into the Dashboard Admin Panel

    The Dashboard Admin Panel is available at:
    http://dashboard.example.com:8008/dashboard

    The default username and password for the first login are both admin.

    WARNING

    The default password is weak, which poses a significant security risk for a high-privilege dashboard.
    It is strongly recommended to immediately change the password after installation:
    Navigate to your profile by clicking on the avatar → "Personal Information" → "Update Profile."
    Create a strong password with a minimum of 18 characters, including a mix of uppercase and lowercase letters, numbers, and symbols.


    Configuring Reverse Proxy

    Refer to Dashboard Reverse Proxy Configuration.


    Updating the Dashboard

    To update the Dashboard, run the following script:

    bash
    ./nezha.sh

    Then, select the option to restart and update the Dashboard.

    + \ No newline at end of file diff --git a/en_US/guide/dashboardq.html b/en_US/guide/dashboardq.html index 3363d1ec7..b5bb81eef 100644 --- a/en_US/guide/dashboardq.html +++ b/en_US/guide/dashboardq.html @@ -12,7 +12,7 @@ - + @@ -39,8 +39,8 @@ write_buffer 2MB } }

    Restart the Caddy service after saving the configuration.

    2. Direct Connection

    Bypass the CDN and connect directly to the origin server for file transfers. Ensure the connection points directly to the server's IP or domain and is stable.


    Unable to Connect Agent with Nginx Reverse Proxy for gRPC

    Cause

    By default, Nginx does not allow underscores in headers. The Agent uses client_secret and client_uuid headers for authentication.

    Solution

    1. Enable Underscores
      Add the following directive in the server block:

      nginx
      underscores_in_headers on;
    2. Manually Forward Headers
      Include the following configuration in the gRPC reverse proxy setup:

      nginx
      grpc_set_header client_secret $http_client_secret;
      -grpc_set_header client_uuid $http_client_uuid;
    - +grpc_set_header client_uuid $http_client_uuid; + \ No newline at end of file diff --git a/en_US/guide/ddns.html b/en_US/guide/ddns.html index b809e9727..b74ce42fb 100644 --- a/en_US/guide/ddns.html +++ b/en_US/guide/ddns.html @@ -12,7 +12,7 @@ - + @@ -25,8 +25,8 @@
    Skip to content

    DDNS

    The DDNS feature is designed for servers using dynamic IP addresses. When an Agent reports a new IP every 10 minutes, the Dashboard automatically updates the DNS records based on your configuration.

    Why Use Nezha's DDNS Feature?

    • Centralized Management: Conveniently manage DDNS settings in the Dashboard without deploying separate DDNS services on each server.
    • Enhanced Security: Sensitive information is only stored on the Dashboard server, reducing the risk of data leaks.

    Configuration Instructions

    DDNS can be configured directly in the Dashboard's admin panel.

    1. Access the DDNS Configuration Page
      Navigate to the DDNS option in the menu to open the configuration page.

    2. Create a New Configuration
      Click New Configuration and fill in the following details:

      • Name: A unique name for identifying the configuration.
      • DDNS Provider: Select the DNS provider.
      • Domain (comma-separated): Enter the domains to be updated, separated by commas if multiple. Supports IDNs (Internationalized Domain Names).
      • Max Retry Attempts: The maximum number of retries for DDNS updates (default: 3, range: 1–10).
      • DDNS Credential 1 and DDNS Credential 2: Optional credentials depending on the provider (see Provider List).
    3. Webhook-Specific Configuration
      If using the webhook provider, follow the Webhook Configuration Instructions.

    4. Enable Options
      Enable at least one of DDNS for IPv4 or DDNS for IPv6; otherwise, updates will not occur.

    5. Associate with Servers
      After adding a DDNS configuration, modify the server settings to enable DDNS functionality:

      • Enable DDNS: Go to the Servers page and enable DDNS for the target server.
      • DDNS Configuration: Select the appropriate DDNS configuration ID, which can be searched by name.

    Webhook Configuration Instructions

    Webhooks allow you to customize HTTP requests for third-party services or other specialized needs.

    Options

    • Webhook URL: The URL for the HTTP request, supporting placeholder substitution.
    • Webhook Request Method: Choose from GET, POST, PATCH, DELETE, or PUT.
    • Webhook Request Type: The request body format, either JSON or Form.
    • Webhook Request Headers: Input headers in JSON format (nested headers are not supported).
    • Webhook Request Body: Not used for GET and DELETE. For nested formats, use JSON.

    Placeholders

    PlaceholderDescription
    #ip#Host IP address
    #domain#Domain (one domain per request)
    #type#IP type: "ipv4" or "ipv6"
    #record#Record type: "A" or "AAAA"
    #access_id#DDNS Credential 1
    #access_secret#DDNS Credential 2

    Oray Webhook Example

    Click to Expand/Collapse
    • URL: http://ddns.oray.com/ph/update?hostname=#domain#&myip=#ip#
    • Request Method: GET
    • Request Headers:
      json
      {
         "Authorization": "Basic pass"
       }
      Here, pass is the Base64-encoded value of your username:password. For example, user:pass becomes dXNlcjpwYXNzCg==.
    • Notes: Oray only supports A records, so only enable IPv4.

    Provider List

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

    Viewing Logs

    The DDNS logs can be accessed on the Dashboard logs page. If configured correctly, logs will display update statuses. For example:

    shell
    dashboard_1  | 2024/03/16 23:16:25 NEZHA>> Attempting to update domain (ddns.example.com) DDNS (1/3)
    -dashboard_1  | 2024/03/16 23:16:28 NEZHA>> Successfully updated domain (ddns.example.com) DDNS
    - +dashboard_1 | 2024/03/16 23:16:28 NEZHA>> Successfully updated domain (ddns.example.com) DDNS + \ No newline at end of file diff --git a/en_US/guide/group.html b/en_US/guide/group.html index 51b1214d1..6ab8f139c 100644 --- a/en_US/guide/group.html +++ b/en_US/guide/group.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    Group Management

    Group management allows users to organize servers and notifications more efficiently, enhancing Dashboard readability and operational convenience.


    Server Groups

    Overview

    Server grouping is used to categorize and manage servers in the Dashboard. Servers in the same group will be displayed under separate tabs, enabling quick access and distinction.

    Configuration Steps

    1. Access the Server Page
      Navigate to the server page to complete basic server configurations.

    2. Assign Groups
      Assign a group name to servers. Servers with the same group name will be categorized under the same tab.

    Use Cases

    • Geographical Organization: Group servers by location, such as China and Overseas.
    • Purpose-Based Grouping: Group servers by their roles, such as Database or Web Services.
    • Departmental Organization: Group servers by departments, such as R&D or Operations.

    Notification Groups

    Overview

    Notification groups allow users to combine multiple notification methods into a single group. These groups can be used as targets for tasks or alert notifications, enabling simultaneous multi-channel notifications.

    Configuration Steps

    1. Access the Notifications Page
      Configure the desired notification methods (e.g., Telegram, Email, DingTalk) on the notifications page.

    2. Create Notification Groups
      Add one or more notification methods into a notification group and name the group for easy identification.

    3. Apply Notification Groups
      Select the notification group as the target in tasks or alert rules. When triggered, notifications will be sent simultaneously through all methods in the group.

    Use Cases

    • Multi-Channel Notifications: Receive alerts via both Telegram and Email simultaneously.
    • Priority-Based Notifications: Set up different notification groups for various alert types or server groups (e.g., High Priority and Standard Notifications).
    - +
    Skip to content

    Group Management

    Group management allows users to organize servers and notifications more efficiently, enhancing Dashboard readability and operational convenience.


    Server Groups

    Overview

    Server grouping is used to categorize and manage servers in the Dashboard. Servers in the same group will be displayed under separate tabs, enabling quick access and distinction.

    Configuration Steps

    1. Access the Server Page
      Navigate to the server page to complete basic server configurations.

    2. Assign Groups
      Assign a group name to servers. Servers with the same group name will be categorized under the same tab.

    Use Cases

    • Geographical Organization: Group servers by location, such as China and Overseas.
    • Purpose-Based Grouping: Group servers by their roles, such as Database or Web Services.
    • Departmental Organization: Group servers by departments, such as R&D or Operations.

    Notification Groups

    Overview

    Notification groups allow users to combine multiple notification methods into a single group. These groups can be used as targets for tasks or alert notifications, enabling simultaneous multi-channel notifications.

    Configuration Steps

    1. Access the Notifications Page
      Configure the desired notification methods (e.g., Telegram, Email, DingTalk) on the notifications page.

    2. Create Notification Groups
      Add one or more notification methods into a notification group and name the group for easy identification.

    3. Apply Notification Groups
      Select the notification group as the target in tasks or alert rules. When triggered, notifications will be sent simultaneously through all methods in the group.

    Use Cases

    • Multi-Channel Notifications: Receive alerts via both Telegram and Email simultaneously.
    • Priority-Based Notifications: Set up different notification groups for various alert types or server groups (e.g., High Priority and Standard Notifications).
    + \ No newline at end of file diff --git a/en_US/guide/loginq.html b/en_US/guide/loginq.html index 4b36cd56e..cb9be922e 100644 --- a/en_US/guide/loginq.html +++ b/en_US/guide/loginq.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    FAQ about logging into the Dashboard

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

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

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

    TIP

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

    How to Check if My Callback Address is Wrong?

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

    Errors After Logging into the Admin Panel

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

    lookup xxx

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

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

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

    oauth2: server response missing access_token

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

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

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

    dial tcp xxx:443 i/o timeout

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

    net/http: TLS handshake timeout

    Same as above.

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

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

    FAQ about logging into the Dashboard

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

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

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

    TIP

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

    How to Check if My Callback Address is Wrong?

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

    Errors After Logging into the Admin Panel

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

    lookup xxx

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

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

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

    oauth2: server response missing access_token

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

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

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

    dial tcp xxx:443 i/o timeout

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

    net/http: TLS handshake timeout

    Same as above.

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

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

    NAT Traversal Configuration

    Nezha Monitoring provides a built-in NAT traversal feature that allows users to expose internal services (e.g., home OpenWrt routers, NAS devices) running on the Agent to the public network via the Dashboard. Currently, only plaintext HTTP tunneling is supported.


    Prerequisites

    Before configuring NAT traversal, ensure the following:

    1. Install and Run the Agent
      The target device must have the Nezha Agent correctly installed and running, with an active connection to the Dashboard.

    2. Prepare a Public Domain Name
      Use subdomains such as service-1.example.com and ensure they point to the public IP of the Dashboard server.

    3. One-to-One Mapping
      Each domain can map to only one internal service. For multiple services, use separate domains, such as service-2.example.com.

    WARNING

    If using control panels like AApanel or other management tools, ensure the domain (e.g., service-1.example.com) is properly configured to point to the Dashboard service. Otherwise, access may fail.


    Configuration Steps

    1. Access the Dashboard Admin Panel
      Navigate to the NAT Traversal section in the menu.

    2. Add a Tunnel Configuration
      Click the Add button and provide the following details:

      • Name: A custom name for the tunnel, such as OpenWrt Login Page.
      • Server ID: The target Agent's ID.
      • Local Service: The internal service address to expose, in the format IP:port (e.g., 127.0.0.1:80).
      • Bound Domain: The public domain name (e.g., service-1.example.com). If the Dashboard uses a non-standard port (e.g., 8008), include the port in the configuration.
    3. Save the Configuration
      Click Add to save the configuration. Wait for the tunnel to become active.

    4. Verify the Tunnel
      Access http://service-1.example.com in a browser to confirm the internal service is successfully exposed.


    Important Notes

    1. Maintain Connection
      The Agent's connection to the Dashboard is essential for the NAT traversal feature. If the connection is interrupted, the tunnel will become temporarily unavailable.

    2. Security Considerations

      • The tunnel transmits data over plaintext HTTP without encryption.
      • It is strongly recommended to enable TLS/SSL for:
        • Communication between the Agent and Dashboard.
        • Connections between the Dashboard and external clients.

    - +
    Skip to content

    NAT Traversal Configuration

    Nezha Monitoring provides a built-in NAT traversal feature that allows users to expose internal services (e.g., home OpenWrt routers, NAS devices) running on the Agent to the public network via the Dashboard. Currently, only plaintext HTTP tunneling is supported.


    Prerequisites

    Before configuring NAT traversal, ensure the following:

    1. Install and Run the Agent
      The target device must have the Nezha Agent correctly installed and running, with an active connection to the Dashboard.

    2. Prepare a Public Domain Name
      Use subdomains such as service-1.example.com and ensure they point to the public IP of the Dashboard server.

    3. One-to-One Mapping
      Each domain can map to only one internal service. For multiple services, use separate domains, such as service-2.example.com.

    WARNING

    If using control panels like AApanel or other management tools, ensure the domain (e.g., service-1.example.com) is properly configured to point to the Dashboard service. Otherwise, access may fail.


    Configuration Steps

    1. Access the Dashboard Admin Panel
      Navigate to the NAT Traversal section in the menu.

    2. Add a Tunnel Configuration
      Click the Add button and provide the following details:

      • Name: A custom name for the tunnel, such as OpenWrt Login Page.
      • Server ID: The target Agent's ID.
      • Local Service: The internal service address to expose, in the format IP:port (e.g., 127.0.0.1:80).
      • Bound Domain: The public domain name (e.g., service-1.example.com). If the Dashboard uses a non-standard port (e.g., 8008), include the port in the configuration.
    3. Save the Configuration
      Click Add to save the configuration. Wait for the tunnel to become active.

    4. Verify the Tunnel
      Access http://service-1.example.com in a browser to confirm the internal service is successfully exposed.


    Important Notes

    1. Maintain Connection
      The Agent's connection to the Dashboard is essential for the NAT traversal feature. If the connection is interrupted, the tunnel will become temporarily unavailable.

    2. Security Considerations

      • The tunnel transmits data over plaintext HTTP without encryption.
      • It is strongly recommended to enable TLS/SSL for:
        • Communication between the Agent and Dashboard.
        • Connections between the Dashboard and external clients.

    + \ No newline at end of file diff --git a/en_US/guide/notifications.html b/en_US/guide/notifications.html index 5a0420406..6e98b4150 100644 --- a/en_US/guide/notifications.html +++ b/en_US/guide/notifications.html @@ -12,7 +12,7 @@ - + @@ -49,8 +49,8 @@ "Cover": 1, "Ignore": {"3": true, "4": true} } -]
  • Explanation: Sends an alert when the outbound traffic of servers 3 and 4 exceeds 1TB in a monthly cycle starting on the 1st.

  • Notification Trigger Modes


    Execute Tasks on Notification

    To execute tasks when a notification is triggered:

    - +]
  • Explanation: Sends an alert when the outbound traffic of servers 3 and 4 exceeds 1TB in a monthly cycle starting on the 1st.

  • Notification Trigger Modes


    Execute Tasks on Notification

    To execute tasks when a notification is triggered:

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

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

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

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

    shell
    grpcurl -proto ./nezha/proto/nezha.proto -plaintext -H 'client_secret: test' -d '{"ip": "114.5.1.4"}' 127.0.0.1:5555 proto.NezhaService/LookupGeoIP
    + \ No newline at end of file diff --git a/en_US/guide/q12.html b/en_US/guide/q12.html index 31a42e87b..8773284d0 100644 --- a/en_US/guide/q12.html +++ b/en_US/guide/q12.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    Real IP Header Configuration

    With the introduction of local account mechanisms in V1, accurate retrieval of the client’s real IP address is essential to prevent brute-force attacks on login endpoints (Web Application Firewall functionality).
    This feature can be managed via /dashboard/settings/waf.


    Configuration Scenarios

    Depending on how the service is deployed, there are two primary configuration scenarios:

    1. Direct Public Access to the Dashboard

    • Enable Use Direct IP in the settings. No additional configuration is required.

    2. Deployment Behind a Web Proxy or CDN

    • Refer to the Reverse Proxy Configuration documentation.
    • The configuration examples utilize the nz-realip header for transmitting client IP addresses. You can either use this default header or define your own.
    • Ensure the proxy server is correctly set up to include the client IP in the custom header and forward it to the Dashboard.

    Common Issues

    Q1: What if a configuration error causes the Dashboard to be inaccessible or agents to disconnect?

    1. Modify the Dashboard configuration file:
      Locate the configuration file at /data/config.yaml and update the following entry:

      yaml
      realipheader: ""

      Set the realipheader value to an empty string (""), save, and exit.

    2. Restart the Dashboard service.

    3. Access the Dashboard again and verify if the connection is restored.

    - +
    Skip to content

    Real IP Header Configuration

    With the introduction of local account mechanisms in V1, accurate retrieval of the client’s real IP address is essential to prevent brute-force attacks on login endpoints (Web Application Firewall functionality).
    This feature can be managed via /dashboard/settings/waf.


    Configuration Scenarios

    Depending on how the service is deployed, there are two primary configuration scenarios:

    1. Direct Public Access to the Dashboard

    • Enable Use Direct IP in the settings. No additional configuration is required.

    2. Deployment Behind a Web Proxy or CDN

    • Refer to the Reverse Proxy Configuration documentation.
    • The configuration examples utilize the nz-realip header for transmitting client IP addresses. You can either use this default header or define your own.
    • Ensure the proxy server is correctly set up to include the client IP in the custom header and forward it to the Dashboard.

    Common Issues

    Q1: What if a configuration error causes the Dashboard to be inaccessible or agents to disconnect?

    1. Modify the Dashboard configuration file:
      Locate the configuration file at /data/config.yaml and update the following entry:

      yaml
      realipheader: ""

      Set the realipheader value to an empty string (""), save, and exit.

    2. Restart the Dashboard service.

    3. Access the Dashboard again and verify if the connection is restored.

    + \ No newline at end of file diff --git a/en_US/guide/q13.html b/en_US/guide/q13.html index 041b4ba52..68bc3a913 100644 --- a/en_US/guide/q13.html +++ b/en_US/guide/q13.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    Initialize User Password

    If you forget the user password stored in the local database, it cannot be retrieved as it is encrypted using bcrypt. However, you can reset it by creating a default user account and then updating the password to your preference.


    Steps to Reset the Password

    1. Stop the Dashboard Service

    To ensure data consistency and prevent conflicts, it is recommended to stop the Dashboard before modifying the database.


    2. Locate the Database File

    The database file is typically located at:

    plaintext
    /opt/nezha/dashboard/data/sqlite.db

    3. Query and Reset the User Table

    Use the SQLite command-line tool to interact with the database:

    1. Query Existing Users: Run the following command to list all existing users:

      bash
      sqlite3 /opt/nezha/dashboard/data/sqlite.db "SELECT * FROM users;"
    2. Clear the User Table: If you need to reset the user table, run the following command to delete all user records:

      bash
      sqlite3 /opt/nezha/dashboard/data/sqlite.db "DELETE FROM users;"

    4. Restart the Dashboard

    After modifying the database, restart the Dashboard to apply changes.


    5. Login Using the Default Account

    During initialization, the Dashboard checks if the user table is empty. If it is, a default user account is created automatically.
    You can log in with the following credentials:

    • Username: admin
    • Password: admin

    Post-Reset Actions

    Once logged in, it is strongly recommended to change the default password immediately for security reasons:

    1. Go to Profile → Personal Info.
    2. Select Update Profile.
    3. Set a new, secure password.

    Important Notes

    • Backup Before Modifying: Always create a backup of the database before making any changes:
      bash
      cp /opt/nezha/dashboard/data/sqlite.db /opt/nezha/dashboard/data/sqlite.db.bak
    • Caution: Clearing the user table will remove all existing user accounts, including administrators. Proceed only if you are certain about the operation.

    - +
    Skip to content

    Initialize User Password

    If you forget the user password stored in the local database, it cannot be retrieved as it is encrypted using bcrypt. However, you can reset it by creating a default user account and then updating the password to your preference.


    Steps to Reset the Password

    1. Stop the Dashboard Service

    To ensure data consistency and prevent conflicts, it is recommended to stop the Dashboard before modifying the database.


    2. Locate the Database File

    The database file is typically located at:

    plaintext
    /opt/nezha/dashboard/data/sqlite.db

    3. Query and Reset the User Table

    Use the SQLite command-line tool to interact with the database:

    1. Query Existing Users: Run the following command to list all existing users:

      bash
      sqlite3 /opt/nezha/dashboard/data/sqlite.db "SELECT * FROM users;"
    2. Clear the User Table: If you need to reset the user table, run the following command to delete all user records:

      bash
      sqlite3 /opt/nezha/dashboard/data/sqlite.db "DELETE FROM users;"

    4. Restart the Dashboard

    After modifying the database, restart the Dashboard to apply changes.


    5. Login Using the Default Account

    During initialization, the Dashboard checks if the user table is empty. If it is, a default user account is created automatically.
    You can log in with the following credentials:

    • Username: admin
    • Password: admin

    Post-Reset Actions

    Once logged in, it is strongly recommended to change the default password immediately for security reasons:

    1. Go to Profile → Personal Info.
    2. Select Update Profile.
    3. Set a new, secure password.

    Important Notes

    • Backup Before Modifying: Always create a backup of the database before making any changes:
      bash
      cp /opt/nezha/dashboard/data/sqlite.db /opt/nezha/dashboard/data/sqlite.db.bak
    • Caution: Clearing the user table will remove all existing user accounts, including administrators. Proceed only if you are certain about the operation.

    + \ No newline at end of file diff --git a/en_US/guide/q2.html b/en_US/guide/q2.html index 80912d8c9..ef4d78922 100644 --- a/en_US/guide/q2.html +++ b/en_US/guide/q2.html @@ -12,7 +12,7 @@ - + @@ -28,8 +28,8 @@ < content-type: application/grpc < < grpc-message: unknown method for service proto.NezhaService -< grpc-status: 12

    Key Information:

    1. content-type should be application/grpc:
    2. Presence of grpc-message error details:

    If the Check Fails:

    - +< grpc-status: 12

    Key Information:

    1. content-type should be application/grpc:
    2. Presence of grpc-message error details:

    If the Check Fails:

    + \ No newline at end of file diff --git a/en_US/guide/q3.html b/en_US/guide/q3.html index d515f5232..5d4e28948 100644 --- a/en_US/guide/q3.html +++ b/en_US/guide/q3.html @@ -12,7 +12,7 @@ - + @@ -118,8 +118,8 @@ } to localhost:8008 } -}

    Configuration Notes

    1. Adjust Headers
      Replace CF-Connecting-IP and other header configurations based on your CDN provider's requirements.

    2. Enable HTTPS
      Ensure your SSL certificate paths are correct and domain resolution is properly set up.

    3. Optimize Performance
      Adjust keepalive and buffer settings based on your server's performance and traffic requirements.


    - +}

    Configuration Notes

    1. Adjust Headers
      Replace CF-Connecting-IP and other header configurations based on your CDN provider's requirements.

    2. Enable HTTPS
      Ensure your SSL certificate paths are correct and domain resolution is properly set up.

    3. Optimize Performance
      Adjust keepalive and buffer settings based on your server's performance and traffic requirements.


    + \ No newline at end of file diff --git a/en_US/guide/q4.html b/en_US/guide/q4.html index 1e063b254..7c1c96546 100644 --- a/en_US/guide/q4.html +++ b/en_US/guide/q4.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    WebSocket Connection Issues

    • Verify CDN Settings:
      If a CDN is being used, ensure that your CDN provider supports WebSocket services and that WebSocket functionality has been correctly enabled.

    • Check Reverse Proxy Configuration:
      Ensure that the following paths are correctly configured for WebSocket support in your reverse proxy rules:

      • /api/v1/ws/server
      • /api/v1/ws/terminal/:id
      • /api/v1/ws/file/:id

    For detailed configuration instructions, refer to: Configure Reverse Proxy.

    - +
    Skip to content

    WebSocket Connection Issues

    • Verify CDN Settings:
      If a CDN is being used, ensure that your CDN provider supports WebSocket services and that WebSocket functionality has been correctly enabled.

    • Check Reverse Proxy Configuration:
      Ensure that the following paths are correctly configured for WebSocket support in your reverse proxy rules:

      • /api/v1/ws/server
      • /api/v1/ws/terminal/:id
      • /api/v1/ws/file/:id

    For detailed configuration instructions, refer to: Configure Reverse Proxy.

    + \ No newline at end of file diff --git a/en_US/guide/q5.html b/en_US/guide/q5.html index dfd3784da..9603164a1 100644 --- a/en_US/guide/q5.html +++ b/en_US/guide/q5.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    How to Migrate, Backup, and Restore Data?

    Follow these steps to migrate, backup, or restore Nezha Monitoring data:

    DANGER

    The database structure between V0 and V1 is incompatible. Do not use this method for cross-version upgrades from V0 to V1.

    1. Stop the Dashboard Service
      Run the one-click script on the old server and select Stop Dashboard.

    2. Backup Data
      Compress the /opt/nezha folder on the old server and copy it to the same location on the new server.

    3. Restore Data
      Extract the /opt/nezha folder to the same path on the new server.

    4. Start the Dashboard Service
      Run the one-click script on the new server and select Start Dashboard.


    Notes

    • Ensure that the /opt/nezha folder and its contents have the correct permissions and ownership on the new server.
    • After the migration is complete, verify its success by accessing the Dashboard interface.
    - +
    Skip to content

    How to Migrate, Backup, and Restore Data?

    Follow these steps to migrate, backup, or restore Nezha Monitoring data:

    DANGER

    The database structure between V0 and V1 is incompatible. Do not use this method for cross-version upgrades from V0 to V1.

    1. Stop the Dashboard Service
      Run the one-click script on the old server and select Stop Dashboard.

    2. Backup Data
      Compress the /opt/nezha folder on the old server and copy it to the same location on the new server.

    3. Restore Data
      Extract the /opt/nezha folder to the same path on the new server.

    4. Start the Dashboard Service
      Run the one-click script on the new server and select Start Dashboard.


    Notes

    • Ensure that the /opt/nezha folder and its contents have the correct permissions and ownership on the new server.
    • After the migration is complete, verify its success by accessing the Dashboard interface.
    + \ No newline at end of file diff --git a/en_US/guide/q6.html b/en_US/guide/q6.html index fa0d6a5aa..eda4de773 100644 --- a/en_US/guide/q6.html +++ b/en_US/guide/q6.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    How to Reset Traffic Statistics Monthly?

    Traffic statistics on the homepage are automatically reset when the server restarts. To implement an automatic monthly reset of traffic statistics, follow these steps:

    1. Access the Admin Panel
      Log in to the Dashboard and navigate to the Notifications page.

    2. Create a Monthly Traffic Alert
      Refer to the Custom Cycle Traffic Alert Documentation to create a traffic alert configured for monthly tracking.

    3. View Monthly Traffic Statistics
      Go back to the homepage and click the Services button to view the monthly traffic statistics. These statistics will not reset when the server restarts.


    TIP

    Flexible Cycle Settings
    This method supports not only monthly resets but also custom cycles like hourly, daily, weekly, or yearly resets for traffic statistics. It's highly flexible!

    - +
    Skip to content

    How to Reset Traffic Statistics Monthly?

    Traffic statistics on the homepage are automatically reset when the server restarts. To implement an automatic monthly reset of traffic statistics, follow these steps:

    1. Access the Admin Panel
      Log in to the Dashboard and navigate to the Notifications page.

    2. Create a Monthly Traffic Alert
      Refer to the Custom Cycle Traffic Alert Documentation to create a traffic alert configured for monthly tracking.

    3. View Monthly Traffic Statistics
      Go back to the homepage and click the Services button to view the monthly traffic statistics. These statistics will not reset when the server restarts.


    TIP

    Flexible Cycle Settings
    This method supports not only monthly resets but also custom cycles like hourly, daily, weekly, or yearly resets for traffic statistics. It's highly flexible!

    + \ No newline at end of file diff --git a/en_US/guide/q7.html b/en_US/guide/q7.html index 38bc53811..db8d854a4 100644 --- a/en_US/guide/q7.html +++ b/en_US/guide/q7.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    Customizing Agent Monitoring Items

    The Agent's functionality and behavior can be tailored to specific monitoring needs by configuring its runtime parameters.


    Runtime Parameters

    Configuration Parameters

    If you installed the Agent using the one-click script, you can edit the /opt/nezha/agent/config.yml file to add or modify parameters.
    Multiple Agents can run on the same server, and each Agent's configuration file is independent.

    Below is a list of runtime parameters and their functions:

    • client_secret:

      • The client secret used for secure communication with the Dashboard.
      • This parameter must match the configuration in the Dashboard to enable proper communication.
    • debug:

      • When set to true, enables debug mode and logs detailed information.
    • disable_auto_update:

      • When set to true, disables the automatic update feature, enhancing system stability and security.
    • disable_command_execute:

      • When set to true, disables the execution of online terminals, file management, and scheduled tasks for increased security.
    • disable_force_update:

      • When set to true, disables forced updates, allowing only manual updates.
    • disable_nat:

      • When set to true, disables the NAT traversal feature to protect internal network data.
    • disable_send_query:

      • When set to true, prevents the Agent from initiating TCP Ping, ICMP Ping, and HTTP GET requests.
    • gpu:

      • When set to true, enables GPU monitoring.
      • Note: Additional dependencies may be required for GPU monitoring. See the GPU Monitoring Guide for details.
    • insecure_tls:

      • When set to true, disables certificate validation, suitable for scenarios using self-signed certificates.
    • ip_report_period:

      • Sets the interval (in seconds) for local IP updates. The default is 1800 seconds (30 minutes).
      • If this value is less than the report_delay setting, the report_delay value will take precedence.
    • report_delay:

      • Sets the interval (in seconds) for system information reporting. The default is 1 second. To reduce resource usage, a value of 3 seconds is recommended (valid range: 1-4 seconds).
    • server:

      • The domain or IP address of the Dashboard for communication, including the port number.
    • skip_connection_count:

      • When set to true, disables monitoring of network connection counts, suitable for servers with high connection volumes or limited resources.
    • skip_procs_count:

      • When set to true, disables monitoring of process counts to lower resource usage.
    • temperature:

      • When set to true, enables hardware temperature monitoring (only supported for specific hardware; unavailable for some VPS instances).
    • tls:

      • When set to true, enables SSL/TLS encryption for communication between the Agent and the Dashboard.
      • Enable this option if the Agent uses an SSL/TLS-enabled Nginx reverse proxy.
    • hard_drive_partition_allowlist:

      • A string array specifying the list of hard drive partitions to monitor.
      • Monitoring will only include the listed partitions.
    • nic_allowlist:

      • A map[string]bool type whitelist specifying the network interfaces to monitor.
      • The key is the network interface name, and the value is true for monitoring and false for exclusion.
      • If not specified, all available interfaces are monitored by default.
    • use_gitee_to_upgrade:

      • When set to true, uses the Gitee repository as the automatic update source, better suited for servers in mainland China.
    • use_ipv6_country_code:

      • When set to true, forces the use of IPv6 addresses for country code queries (default uses IPv4).
    • uuid:

      • The unique identifier for the current Agent, used by the Dashboard to recognize the data source.
      • To replace an existing Agent in the Dashboard, manually set this parameter.
    • dns:

      • A string array to set custom DNS server lists.
      • When specified, the Agent will prioritize these DNS servers for domain resolution.
    • custom_ip_api:

      • A string array specifying custom IP query API endpoints.
      • The Agent will use these APIs to retrieve the server's public IP information.

    Apply Changes

    After modifying the configuration file, restart the Agent service to apply changes. Follow these steps:

    1. Restart the Service
      Use the following command to restart the default Agent service:

      bash
      sudo systemctl restart nezha-agent.service
    2. For Multiple Agent Services
      If running multiple Agent services on the same server, first list all Agent services:

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

      Then restart each Agent service using the following command:

      bash
      sudo systemctl restart <service-name>

      Replace <service-name> with the actual service name, such as nezha-agent@2.service.

    - +
    Skip to content

    Customizing Agent Monitoring Items

    The Agent's functionality and behavior can be tailored to specific monitoring needs by configuring its runtime parameters.


    Runtime Parameters

    Configuration Parameters

    If you installed the Agent using the one-click script, you can edit the /opt/nezha/agent/config.yml file to add or modify parameters.
    Multiple Agents can run on the same server, and each Agent's configuration file is independent.

    Below is a list of runtime parameters and their functions:

    • client_secret:

      • The client secret used for secure communication with the Dashboard.
      • This parameter must match the configuration in the Dashboard to enable proper communication.
    • debug:

      • When set to true, enables debug mode and logs detailed information.
    • disable_auto_update:

      • When set to true, disables the automatic update feature, enhancing system stability and security.
    • disable_command_execute:

      • When set to true, disables the execution of online terminals, file management, and scheduled tasks for increased security.
    • disable_force_update:

      • When set to true, disables forced updates, allowing only manual updates.
    • disable_nat:

      • When set to true, disables the NAT traversal feature to protect internal network data.
    • disable_send_query:

      • When set to true, prevents the Agent from initiating TCP Ping, ICMP Ping, and HTTP GET requests.
    • gpu:

      • When set to true, enables GPU monitoring.
      • Note: Additional dependencies may be required for GPU monitoring. See the GPU Monitoring Guide for details.
    • insecure_tls:

      • When set to true, disables certificate validation, suitable for scenarios using self-signed certificates.
    • ip_report_period:

      • Sets the interval (in seconds) for local IP updates. The default is 1800 seconds (30 minutes).
      • If this value is less than the report_delay setting, the report_delay value will take precedence.
    • report_delay:

      • Sets the interval (in seconds) for system information reporting. The default is 1 second. To reduce resource usage, a value of 3 seconds is recommended (valid range: 1-4 seconds).
    • server:

      • The domain or IP address of the Dashboard for communication, including the port number.
    • skip_connection_count:

      • When set to true, disables monitoring of network connection counts, suitable for servers with high connection volumes or limited resources.
    • skip_procs_count:

      • When set to true, disables monitoring of process counts to lower resource usage.
    • temperature:

      • When set to true, enables hardware temperature monitoring (only supported for specific hardware; unavailable for some VPS instances).
    • tls:

      • When set to true, enables SSL/TLS encryption for communication between the Agent and the Dashboard.
      • Enable this option if the Agent uses an SSL/TLS-enabled Nginx reverse proxy.
    • hard_drive_partition_allowlist:

      • A string array specifying the list of hard drive partitions to monitor.
      • Monitoring will only include the listed partitions.
    • nic_allowlist:

      • A map[string]bool type whitelist specifying the network interfaces to monitor.
      • The key is the network interface name, and the value is true for monitoring and false for exclusion.
      • If not specified, all available interfaces are monitored by default.
    • use_gitee_to_upgrade:

      • When set to true, uses the Gitee repository as the automatic update source, better suited for servers in mainland China.
    • use_ipv6_country_code:

      • When set to true, forces the use of IPv6 addresses for country code queries (default uses IPv4).
    • uuid:

      • The unique identifier for the current Agent, used by the Dashboard to recognize the data source.
      • To replace an existing Agent in the Dashboard, manually set this parameter.
    • dns:

      • A string array to set custom DNS server lists.
      • When specified, the Agent will prioritize these DNS servers for domain resolution.
    • custom_ip_api:

      • A string array specifying custom IP query API endpoints.
      • The Agent will use these APIs to retrieve the server's public IP information.

    Apply Changes

    After modifying the configuration file, restart the Agent service to apply changes. Follow these steps:

    1. Restart the Service
      Use the following command to restart the default Agent service:

      bash
      sudo systemctl restart nezha-agent.service
    2. For Multiple Agent Services
      If running multiple Agent services on the same server, first list all Agent services:

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

      Then restart each Agent service using the following command:

      bash
      sudo systemctl restart <service-name>

      Replace <service-name> with the actual service name, such as nezha-agent@2.service.

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

    Configuration Description:

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

    Setting Up a New SaaS-OIDC Application

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

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

    Identity Verification Strategy Configuration

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

    Policy Configuration Example (One-time PIN)

    Using email OTP as the default verification method:

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

    Testing the Policy

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

    Configuration Description:

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

    Setting Up a New SaaS-OIDC Application

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

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

    Identity Verification Strategy Configuration

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

    Policy Configuration Example (One-time PIN)

    Using email OTP as the default verification method:

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

    Testing the Policy

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

    Field Descriptions

    1. Billing Information (billingDataMod):

    2. Traffic and Network Configuration (planDataMod):


    TIP

    Use Tools for Easy Configuration
    If you're unfamiliar with JSON configuration, you can use a third-party generator to quickly create public remarks:
    Public Remarks Generator

    Copy the generated JSON into the corresponding public remarks section in the Dashboard and save the changes to display the information on the Dashboard front end.

    - +}

    Field Descriptions

    1. Billing Information (billingDataMod):

    2. Traffic and Network Configuration (planDataMod):


    TIP

    Use Tools for Easy Configuration
    If you're unfamiliar with JSON configuration, you can use a third-party generator to quickly create public remarks:
    Public Remarks Generator

    Copy the generated JSON into the corresponding public remarks section in the Dashboard and save the changes to display the information on the Dashboard front end.

    + \ No newline at end of file diff --git a/en_US/guide/services.html b/en_US/guide/services.html index 9015ac1e6..7d71e0512 100644 --- a/en_US/guide/services.html +++ b/en_US/guide/services.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    Service Monitoring

    The Service section is where you configure Agents to monitor external websites or servers.
    Once a service monitor is set up, you can view the availability results from the past 30 days by clicking the Service icon on the homepage.


    How to Use

    Add a New Service Monitor

    Follow these steps to add a new service monitor:

    1. Access the Admin Panel
      Go to the Services page and click the + button to add a new service monitor.

    2. Configure Parameters
      When adding a monitor, fill in the following details:

      • Name: Give the service a custom name.
      • Target: Set the target based on the monitoring type:
        • HTTP GET: Enter a complete URL (including http:// or https://), e.g., https://example.com.
          Note: If the target URL uses https://, Nezha Monitoring will also monitor its SSL certificate. Notifications will be triggered for certificate expiration or changes.
        • ICMP Ping: Enter a domain or IP address (without a port number), e.g., 1.1.1.1 or example.com.
        • TCP Ping: Enter a domain or IP address with a port number, e.g., 1.1.1.1:80 or example.com:22.
      • Type: Choose the monitoring type (HTTP GET, ICMP Ping, or TCP Ping).
      • Display in Services: Choose whether this monitor is visible to guest users (privacy option).
      • Interval: Set the monitoring interval (in seconds).
      • Coverage Scope: Select a rule to determine which Agents will request the target.
      • Specific Servers: Specify which Agents within the coverage scope will perform the monitoring.
      • Notification Group ID: Choose a pre-configured notification method from the Notifications page. See Notification Configuration for details.
      • Enable Failure Notification: Optionally enable notifications for target failures (disabled by default).
    3. Submit the Monitor
      Click the Submit button to save the configuration. Wait a few moments, then check the homepage for monitoring results.


    Delay Change Notifications

    Nezha Monitoring tracks and records the latency between Agents and target servers. When significant latency changes occur, notifications can be sent to help monitor network conditions.

    • Enable Delay Notification: Once enabled, notifications will be sent when latency exceeds the specified range (Max Latency or Min Latency).

    Trigger Tasks on Notifications

    To execute specific tasks when a service monitor triggers a notification:

    1. Check the Enable Trigger Tasks option.
    2. Configure:
      • Tasks on Alarm Trigger: Select the task to execute when an alarm is triggered.
      • Tasks on Recovery: Select the task to execute when the service returns to normal.

    Tasks must be pre-configured in the Tasks page before using this feature.


    Network Latency Charts

    For TCP-Ping and ICMP-Ping monitoring types, the Dashboard automatically generates network latency charts:

    • Open the details page of the target server and switch to the Network tab.
    • View historical network latency trends. Data is based on real-time latency statistics between the Agent and the target server.

    Manage Monitors

    To edit or delete an existing service monitor:

    1. Go to the Services page in the management panel.
    2. Locate the desired monitor configuration.
    3. Click the edit or delete icon on the right to modify or remove the monitor.
    - +
    Skip to content

    Service Monitoring

    The Service section is where you configure Agents to monitor external websites or servers.
    Once a service monitor is set up, you can view the availability results from the past 30 days by clicking the Service icon on the homepage.


    How to Use

    Add a New Service Monitor

    Follow these steps to add a new service monitor:

    1. Access the Admin Panel
      Go to the Services page and click the + button to add a new service monitor.

    2. Configure Parameters
      When adding a monitor, fill in the following details:

      • Name: Give the service a custom name.
      • Target: Set the target based on the monitoring type:
        • HTTP GET: Enter a complete URL (including http:// or https://), e.g., https://example.com.
          Note: If the target URL uses https://, Nezha Monitoring will also monitor its SSL certificate. Notifications will be triggered for certificate expiration or changes.
        • ICMP Ping: Enter a domain or IP address (without a port number), e.g., 1.1.1.1 or example.com.
        • TCP Ping: Enter a domain or IP address with a port number, e.g., 1.1.1.1:80 or example.com:22.
      • Type: Choose the monitoring type (HTTP GET, ICMP Ping, or TCP Ping).
      • Display in Services: Choose whether this monitor is visible to guest users (privacy option).
      • Interval: Set the monitoring interval (in seconds).
      • Coverage Scope: Select a rule to determine which Agents will request the target.
      • Specific Servers: Specify which Agents within the coverage scope will perform the monitoring.
      • Notification Group ID: Choose a pre-configured notification method from the Notifications page. See Notification Configuration for details.
      • Enable Failure Notification: Optionally enable notifications for target failures (disabled by default).
    3. Submit the Monitor
      Click the Submit button to save the configuration. Wait a few moments, then check the homepage for monitoring results.


    Delay Change Notifications

    Nezha Monitoring tracks and records the latency between Agents and target servers. When significant latency changes occur, notifications can be sent to help monitor network conditions.

    • Enable Delay Notification: Once enabled, notifications will be sent when latency exceeds the specified range (Max Latency or Min Latency).

    Trigger Tasks on Notifications

    To execute specific tasks when a service monitor triggers a notification:

    1. Check the Enable Trigger Tasks option.
    2. Configure:
      • Tasks on Alarm Trigger: Select the task to execute when an alarm is triggered.
      • Tasks on Recovery: Select the task to execute when the service returns to normal.

    Tasks must be pre-configured in the Tasks page before using this feature.


    Network Latency Charts

    For TCP-Ping and ICMP-Ping monitoring types, the Dashboard automatically generates network latency charts:

    • Open the details page of the target server and switch to the Network tab.
    • View historical network latency trends. Data is based on real-time latency statistics between the Agent and the target server.

    Manage Monitors

    To edit or delete an existing service monitor:

    1. Go to the Services page in the management panel.
    2. Locate the desired monitor configuration.
    3. Click the edit or delete icon on the right to modify or remove the monitor.
    + \ No newline at end of file diff --git a/en_US/guide/settings.html b/en_US/guide/settings.html index 252dfc14c..1979d2f1e 100644 --- a/en_US/guide/settings.html +++ b/en_US/guide/settings.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    Settings

    Access the settings page by logging into the Admin panel and clicking on the avatar → System Settings.


    Site Name

    Customize the title of your site for easier identification and management.


    Language Settings

    Nezha Monitoring currently supports the following languages:

    • Simplified Chinese / 简体中文
    • Traditional Chinese / 繁體中文
    • English
    • Spanish / Español

    We welcome contributions to improve translations or add support for more languages.


    Custom Code

    Add custom styles or scripts to the visitor page, such as changing the logo, adjusting colors, applying beautification code, or adding analytics scripts.

    WARNING

    • Custom code is only effective on the visitor homepage and does not apply to the Admin panel.
    • To modify the Admin panel, you must manually edit the theme files inside the Docker container.

    Dashboard Server Domain/IP (Non-CDN)

    • This setting is required for the installation of Agents via the one-click script.
    • The input must be a domain or IP address not behind a CDN, such as data.example.com:8008.
    • For more details, see Agent Installation Preparation.

    Frontend Access Password

    Set a password to restrict visitors from directly accessing the Dashboard.
    After setting, users must enter the password to access the homepage.


    Real IP Request Header

    • CF-Connecting-IP is a header used to identify the visitor's real IP address.
    • When accessing the Dashboard through a Cloudflare CDN proxy, enabling this feature allows the origin server to correctly recognize the visitor's real IP.
      • Purpose: Facilitates security audits, firewall rule configuration, and accurate logging.

    DANGER

    1. Be Careful with Header Configuration
      The Real IP Request Header impacts the proper functioning of the built-in Web Application Firewall (WAF).
      If you are unfamiliar with header handling, avoid modifying this setting. Incorrect configuration may result in the IP being blocked by the WAF.

    2. Prevent Account Brute Force Attacks
      The built-in WAF is designed to prevent brute force attacks on local accounts.

      • Without protective measures, attackers could attempt high-frequency password enumeration (e.g., 100 attempts per second).
      • The WAF relies on accurate IP identification via properly configured headers to block such attacks.
    3. Security Recommendations
      Only enable this feature if you understand the header transmission mechanism. Thoroughly test your configuration after enabling.


    IP Change Notification

    This feature sends a notification when a server's IP address changes. Configure it as follows:

    Configuration Options

    1. Coverage Scope
      Select a rule to determine which servers to monitor for IP changes.

    2. Specific Servers
      Use this setting to exclude specific servers from the selected rule.

    3. Send Notifications to a Group
      Choose a notification group. (Notification methods must be pre-configured in the Notifications page.)

    4. Enable the Feature
      Check the Enable option to activate notifications.

    5. Show Full IP Address in Notifications
      By default, IP change notifications mask full IP addresses.
      To display full IPs, enable this option.


    User Management

    This section allows you to add multiple users to the Dashboard.

    • Adding multiple users facilitates collaborative management.
    - +
    Skip to content

    Settings

    Access the settings page by logging into the Admin panel and clicking on the avatar → System Settings.


    Site Name

    Customize the title of your site for easier identification and management.


    Language Settings

    Nezha Monitoring currently supports the following languages:

    • Simplified Chinese / 简体中文
    • Traditional Chinese / 繁體中文
    • English
    • Spanish / Español

    We welcome contributions to improve translations or add support for more languages.


    Custom Code

    Add custom styles or scripts to the visitor page, such as changing the logo, adjusting colors, applying beautification code, or adding analytics scripts.

    WARNING

    • Custom code is only effective on the visitor homepage and does not apply to the Admin panel.
    • To modify the Admin panel, you must manually edit the theme files inside the Docker container.

    Dashboard Server Domain/IP (Non-CDN)

    • This setting is required for the installation of Agents via the one-click script.
    • The input must be a domain or IP address not behind a CDN, such as data.example.com:8008.
    • For more details, see Agent Installation Preparation.

    Frontend Access Password

    Set a password to restrict visitors from directly accessing the Dashboard.
    After setting, users must enter the password to access the homepage.


    Real IP Request Header

    • CF-Connecting-IP is a header used to identify the visitor's real IP address.
    • When accessing the Dashboard through a Cloudflare CDN proxy, enabling this feature allows the origin server to correctly recognize the visitor's real IP.
      • Purpose: Facilitates security audits, firewall rule configuration, and accurate logging.

    DANGER

    1. Be Careful with Header Configuration
      The Real IP Request Header impacts the proper functioning of the built-in Web Application Firewall (WAF).
      If you are unfamiliar with header handling, avoid modifying this setting. Incorrect configuration may result in the IP being blocked by the WAF.

    2. Prevent Account Brute Force Attacks
      The built-in WAF is designed to prevent brute force attacks on local accounts.

      • Without protective measures, attackers could attempt high-frequency password enumeration (e.g., 100 attempts per second).
      • The WAF relies on accurate IP identification via properly configured headers to block such attacks.
    3. Security Recommendations
      Only enable this feature if you understand the header transmission mechanism. Thoroughly test your configuration after enabling.


    IP Change Notification

    This feature sends a notification when a server's IP address changes. Configure it as follows:

    Configuration Options

    1. Coverage Scope
      Select a rule to determine which servers to monitor for IP changes.

    2. Specific Servers
      Use this setting to exclude specific servers from the selected rule.

    3. Send Notifications to a Group
      Choose a notification group. (Notification methods must be pre-configured in the Notifications page.)

    4. Enable the Feature
      Check the Enable option to activate notifications.

    5. Show Full IP Address in Notifications
      By default, IP change notifications mask full IP addresses.
      To display full IPs, enable this option.


    User Management

    This section allows you to add multiple users to the Dashboard.

    • Adding multiple users facilitates collaborative management.
    + \ No newline at end of file diff --git a/en_US/guide/tasks.html b/en_US/guide/tasks.html index 981b3a40e..81b6e3f90 100644 --- a/en_US/guide/tasks.html +++ b/en_US/guide/tasks.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    Task Management

    The Task Management section supports scheduling tasks, trigger-based tasks, and bulk execution across multiple servers.
    Nezha Monitoring enables pushing commands to Agents for execution, supporting diverse scenarios such as:

    • Periodic backups using restic or rclone.
    • Scheduled service restarts to reset network connections.
    • Triggered tasks based on alert rules, e.g., running a script when CPU usage remains high for an extended period.

    How to Use

    Adding a Task

    1. Access the Task Page
      Navigate to the Tasks page in the management panel and click the + button to add a new task.

    2. Configure Task Parameters
      When adding a task, the following parameters must be configured:

      • Name: Assign a custom name for easy identification and management.
      • Task Type:
        • Scheduled Task: Executes periodically based on the specified schedule.
        • Trigger Task: Executes only when triggered via API or notification rules, running once per trigger.
      • Schedule: Time schedule for task execution (only applies to scheduled tasks).
        Format: second minute hour day month weekday.
        Refer to the CRON Expression Format for details.
        Example: 0 0 3 * * * runs the task daily at 3:00 AM.
      • Command: The command to execute.
        • The command format follows standard Shell/Bat scripting. Use && (Linux) or & (Windows) to chain multiple commands.
        • Example: To reboot the server, enter reboot.
      • Coverage Scope and Specific Servers: Specify which Agents should execute the task:
        • Select coverage rules or specific servers.
        • For trigger tasks, choose "Execute on servers triggering the alert."
      • Notification Group: Select a notification method group configured in the Notifications page. See Notification Configuration for details.
    3. Submit Task
      After completing the configuration, click Submit to save the task.


    Managing Tasks

    To manage existing tasks:

    1. Go to the Tasks page and locate the desired task.
    2. Use the icons on the right:
      • Execute Immediately: Bypasses the schedule and executes the task instantly.
      • Edit: Modify the task configuration.
      • Delete: Remove the task.

    Common Issues

    1. Command Not Found

    • If execution fails with a "command not found" error, it is usually due to the PATH environment variable not being properly loaded.
    • Solution:
      • In Linux, prepend the command with source ~/.bashrc:
        bash
        source ~/.bashrc && your_command
      • Alternatively, use the command's absolute path (e.g., /usr/bin/command).
    - +
    Skip to content

    Task Management

    The Task Management section supports scheduling tasks, trigger-based tasks, and bulk execution across multiple servers.
    Nezha Monitoring enables pushing commands to Agents for execution, supporting diverse scenarios such as:

    • Periodic backups using restic or rclone.
    • Scheduled service restarts to reset network connections.
    • Triggered tasks based on alert rules, e.g., running a script when CPU usage remains high for an extended period.

    How to Use

    Adding a Task

    1. Access the Task Page
      Navigate to the Tasks page in the management panel and click the + button to add a new task.

    2. Configure Task Parameters
      When adding a task, the following parameters must be configured:

      • Name: Assign a custom name for easy identification and management.
      • Task Type:
        • Scheduled Task: Executes periodically based on the specified schedule.
        • Trigger Task: Executes only when triggered via API or notification rules, running once per trigger.
      • Schedule: Time schedule for task execution (only applies to scheduled tasks).
        Format: second minute hour day month weekday.
        Refer to the CRON Expression Format for details.
        Example: 0 0 3 * * * runs the task daily at 3:00 AM.
      • Command: The command to execute.
        • The command format follows standard Shell/Bat scripting. Use && (Linux) or & (Windows) to chain multiple commands.
        • Example: To reboot the server, enter reboot.
      • Coverage Scope and Specific Servers: Specify which Agents should execute the task:
        • Select coverage rules or specific servers.
        • For trigger tasks, choose "Execute on servers triggering the alert."
      • Notification Group: Select a notification method group configured in the Notifications page. See Notification Configuration for details.
    3. Submit Task
      After completing the configuration, click Submit to save the task.


    Managing Tasks

    To manage existing tasks:

    1. Go to the Tasks page and locate the desired task.
    2. Use the icons on the right:
      • Execute Immediately: Bypasses the schedule and executes the task instantly.
      • Edit: Modify the task configuration.
      • Delete: Remove the task.

    Common Issues

    1. Command Not Found

    • If execution fails with a "command not found" error, it is usually due to the PATH environment variable not being properly loaded.
    • Solution:
      • In Linux, prepend the command with source ~/.bashrc:
        bash
        source ~/.bashrc && your_command
      • Alternatively, use the command's absolute path (e.g., /usr/bin/command).
    + \ No newline at end of file diff --git a/en_US/index.html b/en_US/index.html index 95eb281a2..73398d259 100644 --- a/en_US/index.html +++ b/en_US/index.html @@ -12,7 +12,7 @@ - + @@ -23,7 +23,7 @@
    Skip to content

    Nezha Monitoring V1

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

    - + \ No newline at end of file diff --git a/guide/agent.html b/guide/agent.html index a4c169c54..06c0692c2 100644 --- a/guide/agent.html +++ b/guide/agent.html @@ -12,7 +12,7 @@ - + @@ -116,8 +116,8 @@ start }
  • 赋予执行权限
    保存文件后,赋予脚本执行权限:

    bash
    chmod +x /etc/init.d/nezha-service
  • 启用服务
    运行以下命令启用并启动服务:

    bash
    /etc/init.d/nezha-service enable
     /etc/init.d/nezha-service start
  • 验证启动状态
    使用以下命令检查服务是否正常运行:

    bash
    ps | grep nezha-agent

  • 注意事项

    卸载 Agent

    卸载 Agent 包括停止服务、卸载服务,以及删除相关文件。以下是 Ubuntu 系统的卸载步骤:

    1. 停止并卸载服务:

      bash
      cd /opt/nezha/agent/
      -./nezha-agent service uninstall
    2. 删除 Agent 文件夹:

      bash
      rm -rf /opt/nezha/agent/

    如果安装了多个服务并想要全部卸载,可以使用 Agent 安装脚本的卸载功能:

    bash
    ./agent.sh uninstall
    - +./nezha-agent service uninstall
  • 删除 Agent 文件夹:

    bash
    rm -rf /opt/nezha/agent/
  • 如果安装了多个服务并想要全部卸载,可以使用 Agent 安装脚本的卸载功能:

    bash
    ./agent.sh uninstall
    + \ No newline at end of file diff --git a/guide/agentq.html b/guide/agentq.html index 3f09d7765..c67d102a9 100644 --- a/guide/agentq.html +++ b/guide/agentq.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    Agent 常见问题


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

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


    一键脚本安装时出错

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

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

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

    2. sudo: command not found

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

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

    Agent 安装目录出现多个配置文件,系统被安装了多个 Agent 服务

    为重复运行 Agent 安装脚本所致。Agent 支持根据不同的配置文件安装多个系统服务,故脚本不会覆盖安装而是会安装新的配置到系统服务。

    可以使用 Agent 脚本的卸载功能清除所有配置文件和对应的服务:

    bash
    ./agent.sh uninstall

    Agent 有 Docker 镜像吗?

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

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

    - +
    Skip to content

    Agent 常见问题


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

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


    一键脚本安装时出错

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

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

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

    2. sudo: command not found

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

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

    Agent 安装目录出现多个配置文件,系统被安装了多个 Agent 服务

    为重复运行 Agent 安装脚本所致。Agent 支持根据不同的配置文件安装多个系统服务,故脚本不会覆盖安装而是会安装新的配置到系统服务。

    可以使用 Agent 脚本的卸载功能清除所有配置文件和对应的服务:

    bash
    ./agent.sh uninstall

    Agent 有 Docker 镜像吗?

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

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

    + \ No newline at end of file diff --git a/guide/api.html b/guide/api.html index 6760a574a..a6789404e 100644 --- a/guide/api.html +++ b/guide/api.html @@ -12,7 +12,7 @@ - + @@ -263,8 +263,8 @@ eval $CMD
    1. 为脚本赋予可执行权限: chmod +x nezha_register.sh
    2. 从dashboard获取token, 比如为 POXbxorKJBM8wPMKX8r2PdMblyXvpggB
    3. 配置环境变量
    bash
    export NEZHA_TOKEN="POXbxorKJBM8wPMKX8r2PdMblyXvpggB" # 从面板获取
     export NEZHA_PROBE_ADDRESS="your_probe_address"        # 填写探针地址
     export NEZHA_DASHBOARD_URL="https://nezha.example.com" # 修改为你的面板地址
    -export NEZHA_PROBE_PORT="5555"                         # 修改为你的探针端口(如有不同)
    1. 运行注册脚本
    bash
    ./nezha_register.sh
    1. 如果脚本成功运行,你会看到类似以下的日志:
    bash
    Run command: ./nezha.sh install_agent probe.example.com 5555 YOUR_SECRET --tls
    - +export NEZHA_PROBE_PORT="5555" # 修改为你的探针端口(如有不同)
    1. 运行注册脚本
    bash
    ./nezha_register.sh
    1. 如果脚本成功运行,你会看到类似以下的日志:
    bash
    Run command: ./nezha.sh install_agent probe.example.com 5555 YOUR_SECRET --tls
    + \ No newline at end of file diff --git a/guide/dashboard.html b/guide/dashboard.html index 8f8bfc485..3bd09168d 100644 --- a/guide/dashboard.html +++ b/guide/dashboard.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    安装 Dashboard

    准备工作

    搭建哪吒监控的 Dashboard,你需要:

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

    TIP

    如果你想使用 CDN,请准备两个域名:

    • 一个配置好 CDN,用作公开访问,CDN 需支持 WebSocket 协议;
    • 另一个域名不使用 CDN,用作 Agent 与 Dashboard 的通信。

    尽管 V1 版本不再区分访问端口和通信端口,但由于不同厂商的 CDN 配置可能导致通信异常,仅建议按上述方式准备域名(非强制要求)。

    本文档以 "dashboard.example.com" 和 "data.example.com" 为例。

    在服务器中安装 Dashboard

    在面板服务器中,运行以下安装脚本:

    bash
    curl -L https://raw.githubusercontent.com/nezhahq/scripts/refs/heads/main/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh

    如果你的服务器位于中国大陆,可以使用镜像:

    bash
    curl -L https://gitee.com/naibahq/scripts/raw/main/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh

    以 Docker 安装为例,安装完成后按提示输入以下信息:

    • 请输入站点标题: - 自定义站点标题。
    • 请输入暴露端口: - 公开访问端口(默认 8008,可自定义)。
    • 请指定后台语言: - 选择语言偏好。

    输入完成后,等待拉取 Docker 镜像。安装结束后,如果一切正常,你可以通过域名和端口号访问 Dashboard,例如:
    http://dashboard.example.com:8008

    如果需要再次运行安装脚本,可输入以下命令:

    bash
    ./nezha.sh

    打开管理脚本。

    登录到 Dashboard 配置界面

    后台管理界面的路径为 /dashboard,你只需访问:
    http://dashboard.example.com:8008/dashboard

    首次登录的默认用户名和密码均为 admin

    WARNING

    默认密码为弱密码,对于高权限的面板来说,使用弱密码非常危险!
    建议安装后立即进入管理页面:点击头像 → “个人信息” → “更新个人资料”修改密码。
    建议密码长度至少 18 位,并混合大小写字母、数字及符号。

    配置反向代理

    Dashboard 反向代理配置

    更新 Dashboard

    运行脚本:

    bash
    ./nezha.sh

    选择重启面板并更新。

    - +
    Skip to content

    安装 Dashboard

    准备工作

    搭建哪吒监控的 Dashboard,你需要:

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

    TIP

    如果你想使用 CDN,请准备两个域名:

    • 一个配置好 CDN,用作公开访问,CDN 需支持 WebSocket 协议;
    • 另一个域名不使用 CDN,用作 Agent 与 Dashboard 的通信。

    尽管 V1 版本不再区分访问端口和通信端口,但由于不同厂商的 CDN 配置可能导致通信异常,仅建议按上述方式准备域名(非强制要求)。

    本文档以 "dashboard.example.com" 和 "data.example.com" 为例。

    在服务器中安装 Dashboard

    在面板服务器中,运行以下安装脚本:

    bash
    curl -L https://raw.githubusercontent.com/nezhahq/scripts/refs/heads/main/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh

    如果你的服务器位于中国大陆,可以使用镜像:

    bash
    curl -L https://gitee.com/naibahq/scripts/raw/main/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh

    以 Docker 安装为例,安装完成后按提示输入以下信息:

    • 请输入站点标题: - 自定义站点标题。
    • 请输入暴露端口: - 公开访问端口(默认 8008,可自定义)。
    • 请指定后台语言: - 选择语言偏好。

    输入完成后,等待拉取 Docker 镜像。安装结束后,如果一切正常,你可以通过域名和端口号访问 Dashboard,例如:
    http://dashboard.example.com:8008

    如果需要再次运行安装脚本,可输入以下命令:

    bash
    ./nezha.sh

    打开管理脚本。

    登录到 Dashboard 配置界面

    后台管理界面的路径为 /dashboard,你只需访问:
    http://dashboard.example.com:8008/dashboard

    首次登录的默认用户名和密码均为 admin

    WARNING

    默认密码为弱密码,对于高权限的面板来说,使用弱密码非常危险!
    建议安装后立即进入管理页面:点击头像 → “个人信息” → “更新个人资料”修改密码。
    建议密码长度至少 18 位,并混合大小写字母、数字及符号。

    配置反向代理

    Dashboard 反向代理配置

    更新 Dashboard

    运行脚本:

    bash
    ./nezha.sh

    选择重启面板并更新。

    + \ No newline at end of file diff --git a/guide/dashboardq.html b/guide/dashboardq.html index d6a9fc6d1..0202ab8fe 100644 --- a/guide/dashboardq.html +++ b/guide/dashboardq.html @@ -12,7 +12,7 @@ - + @@ -39,8 +39,8 @@ write_buffer 2MB } }

    2. 尝试直接连接

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


    使用 Nginx 反代 gRPC 无法连接 Agent

    问题原因

    Nginx 默认不允许 Header 中含有下划线,而 Agent 使用 client_secretclient_uuid 进行认证。

    解决方法

    1. 允许下划线

    在 server 块中添加 underscores_in_headers on;

    1. 手动发送 Header

    在 server 块中添加 ignore_invalid_headers off;,之后在 gRPC 反代选项中加入:

    nginx
    grpc_set_header client_secret $http_client_secret;
    -grpc_set_header client_uuid $http_client_uuid;
    - +grpc_set_header client_uuid $http_client_uuid; + \ No newline at end of file diff --git a/guide/ddns.html b/guide/ddns.html index 30e8faf36..6e2e7d2f1 100644 --- a/guide/ddns.html +++ b/guide/ddns.html @@ -12,7 +12,7 @@ - + @@ -25,8 +25,8 @@
    Skip to content

    DDNS

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

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

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

    配置说明

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

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

    Webhook 配置说明

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

    选项说明

    • Webhook URL:目标请求的 URL,支持占位符替换。
    • Webhook 请求方式:支持 GETPOSTPATCHDELETEPUT
    • Webhook 请求类型:请求体格式,可选择 JSONForm
    • Webhook 请求头:以 JSON 格式填写请求头,注意不支持嵌套。
    • Webhook 请求体GETDELETE 不使用请求体;如果使用嵌套格式,请选择 JSON 类型。

    占位符说明

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

    花生壳 Webhook 示例

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

    供应商列表

    供应商凭据1(ID)凭据2(Secret)
    dummy❌️❌️
    webhook可选可选
    cloudflare❌️
    tencentcloud

    查看日志

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

    shell
    dashboard_1  | 2024/03/16 23:16:25 NEZHA>> 正在尝试更新域名(ddns.example.com)DDNS(1/3)
    -dashboard_1  | 2024/03/16 23:16:28 NEZHA>> 尝试更新域名(ddns.example.com)DDNS成功
    - +dashboard_1 | 2024/03/16 23:16:28 NEZHA>> 尝试更新域名(ddns.example.com)DDNS成功 + \ No newline at end of file diff --git a/guide/group.html b/guide/group.html index 52583bfa1..36129f497 100644 --- a/guide/group.html +++ b/guide/group.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    分组管理

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


    服务器分组

    功能说明

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

    配置步骤

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

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

    应用场景

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

    通知分组

    功能说明

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

    配置步骤

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

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

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

    应用场景

    • 多渠道通知:通过 Telegram 和邮件同时接收服务器告警。
    • 分级通知:针对不同告警类型或服务器分组,设置不同的通知组(如 高优先级 通知组与 普通通知组)。
    - +
    Skip to content

    分组管理

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


    服务器分组

    功能说明

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

    配置步骤

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

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

    应用场景

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

    通知分组

    功能说明

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

    配置步骤

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

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

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

    应用场景

    • 多渠道通知:通过 Telegram 和邮件同时接收服务器告警。
    • 分级通知:针对不同告警类型或服务器分组,设置不同的通知组(如 高优先级 通知组与 普通通知组)。
    + \ No newline at end of file diff --git a/guide/loginq.html b/guide/loginq.html index ee9a6fbcd..3de17b350 100644 --- a/guide/loginq.html +++ b/guide/loginq.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    登录常见问题

    V0版本,不适用于V1版本

    登录后面板报错

    可能原因及解决方法:

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

    2. lookup xxx

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

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

    3. dial tcp xxx:443 i/o timeout

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

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

    4. net/http: TLS handshake timeout

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

    1. 重启 Docker 服务:
      bash
      sudo systemctl restart docker
    2. 使用脚本重启面板后检查是否正常。
    - +
    Skip to content

    登录常见问题

    V0版本,不适用于V1版本

    登录后面板报错

    可能原因及解决方法:

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

    2. lookup xxx

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

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

    3. dial tcp xxx:443 i/o timeout

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

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

    4. net/http: TLS handshake timeout

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

    1. 重启 Docker 服务:
      bash
      sudo systemctl restart docker
    2. 使用脚本重启面板后检查是否正常。
    + \ No newline at end of file diff --git a/guide/nat.html b/guide/nat.html index c28d33c71..33f9bd53a 100644 --- a/guide/nat.html +++ b/guide/nat.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    内网穿透功能配置

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

    准备工作

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

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

    WARNING

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


    配置步骤

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

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

      • 名称:自定义配置名称,如 OpenWrt 登录页
      • 服务器 ID:填写目标 Agent 的 ID。
      • 本地服务:填写需穿透的内网服务地址,格式为 IP:端口(如 127.0.0.1:80)。
      • 绑定域名:填写公网域名(如 service-1.example.com)。如果 Dashboard 使用非标准端口(如 8008),需手动添加端口。
    3. 保存配置
      点击“新增”按钮,完成配置并等待穿透生效。

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


    使用须知

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

    2. 安全注意事项

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

    - +
    Skip to content

    内网穿透功能配置

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

    准备工作

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

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

    WARNING

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


    配置步骤

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

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

      • 名称:自定义配置名称,如 OpenWrt 登录页
      • 服务器 ID:填写目标 Agent 的 ID。
      • 本地服务:填写需穿透的内网服务地址,格式为 IP:端口(如 127.0.0.1:80)。
      • 绑定域名:填写公网域名(如 service-1.example.com)。如果 Dashboard 使用非标准端口(如 8008),需手动添加端口。
    3. 保存配置
      点击“新增”按钮,完成配置并等待穿透生效。

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


    使用须知

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

    2. 安全注意事项

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

    + \ No newline at end of file diff --git a/guide/notifications.html b/guide/notifications.html index a26ae4985..c15af848f 100644 --- a/guide/notifications.html +++ b/guide/notifications.html @@ -12,7 +12,7 @@ - + @@ -75,8 +75,8 @@ "Cover": 1, "Ignore": {"3": true, "4": true} } -]
  • 说明:服务器 3、4 的出站月流量超过 1TB 时触发通知,统计周期从每月 1 号开始。

  • TIP

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


    通知触发模式


    设置通知时执行任务

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

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

  • TIP

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


    通知触发模式


    设置通知时执行任务

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

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

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

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

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

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

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

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

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

    shell
    grpcurl -proto ./nezha/proto/nezha.proto -plaintext -H 'client_secret: test' -d '{"ip": "114.5.1.4"}' 127.0.0.1:5555 proto.NezhaService/LookupGeoIP
    + \ No newline at end of file diff --git a/guide/q12.html b/guide/q12.html index b3bf52514..2adec41d5 100644 --- a/guide/q12.html +++ b/guide/q12.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    真实 IP 请求头

    由于 V1 版本引入了本地账户机制,为防止外界暴力破解登录接口(Web 应用防火墙功能),程序需要准确获取客户端的真实 IP 地址。
    此功能可通过路径 /dashboard/settings/waf 进行管理配置。


    配置场景

    根据服务部署方式的不同,有以下两种配置场景:

    1. 直接将面板服务映射至公网

    • 勾选 使用直连 IP 即可,无需额外配置。

    2. 使用 Web 容器反向代理或 CDN

    • 参考 反向代理配置 文档。
    • 在示例配置中,使用了 nz-realip 请求头,您可以沿用或修改为其他自定义值。
    • 确保代理服务器正确设置请求头,并将客户端 IP 地址通过自定义头部传递给 Dashboard。

    常见问题

    Q1: 配置错误导致无法访问面板或探针掉线,如何恢复?

    1. 修改面板配置文件:
      文件路径为 /data/config.yaml,找到以下配置项:

      yaml
      realipheader: ""

      realipheader 设置为空值(""),保存并退出。

    2. 重启面板服务。

    3. 重新访问面板并验证连接是否恢复正常。

    - +
    Skip to content

    真实 IP 请求头

    由于 V1 版本引入了本地账户机制,为防止外界暴力破解登录接口(Web 应用防火墙功能),程序需要准确获取客户端的真实 IP 地址。
    此功能可通过路径 /dashboard/settings/waf 进行管理配置。


    配置场景

    根据服务部署方式的不同,有以下两种配置场景:

    1. 直接将面板服务映射至公网

    • 勾选 使用直连 IP 即可,无需额外配置。

    2. 使用 Web 容器反向代理或 CDN

    • 参考 反向代理配置 文档。
    • 在示例配置中,使用了 nz-realip 请求头,您可以沿用或修改为其他自定义值。
    • 确保代理服务器正确设置请求头,并将客户端 IP 地址通过自定义头部传递给 Dashboard。

    常见问题

    Q1: 配置错误导致无法访问面板或探针掉线,如何恢复?

    1. 修改面板配置文件:
      文件路径为 /data/config.yaml,找到以下配置项:

      yaml
      realipheader: ""

      realipheader 设置为空值(""),保存并退出。

    2. 重启面板服务。

    3. 重新访问面板并验证连接是否恢复正常。

    + \ No newline at end of file diff --git a/guide/q13.html b/guide/q13.html index 5ff869920..9c4b19745 100644 --- a/guide/q13.html +++ b/guide/q13.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    初始化用户密码

    当遗忘本地数据库中存储的用户密码时,无法直接找回明文密码,因为它已通过 bcrypt 加密。不过,可以通过重置功能创建一个原始用户,之后再修改密码为所需的密码。


    操作步骤

    1. 停止 Dashboard 服务

    为了确保数据一致性和避免意外冲突,建议在修改数据库前先停止 Dashboard。


    2. 找到数据库路径

    通常,数据库文件存放在以下位置:

    plaintext
    /opt/nezha/dashboard/data/sqlite.db

    3. 查询和清空用户表

    使用 SQLite 命令行工具操作数据库:

    1. 查看现有用户: 运行以下命令查看用户表内容:

      bash
      sqlite3 /opt/nezha/dashboard/data/sqlite.db "SELECT * FROM users;"

      这将列出当前所有用户的记录。

    2. 清空用户表: 如果您确认需要重置用户表,可运行以下命令清空:

      bash
      sqlite3 /opt/nezha/dashboard/data/sqlite.db "DELETE FROM users;"

    4. 重启 Dashboard 服务

    完成数据库操作后,重新启动 Dashboard.


    5. 登录默认账户

    Dashboard 在初始化时会自动检测用户表是否为空。如果为空,将自动插入默认用户。
    您可以使用以下默认账户登录:

    • 用户名admin
    • 密码admin

    后续操作

    登录成功后,建议立即修改默认密码以提高安全性:

    1. 点击 头像 → 个人信息
    2. 选择 更新个人资料
    3. 修改密码,建议设置一个复杂度较高的密码。

    注意事项

    • 修改数据库前,请确保已备份原始数据库文件:
      bash
      cp /opt/nezha/dashboard/data/sqlite.db /opt/nezha/dashboard/data/sqlite.db.bak
    • 谨慎操作:清空用户表将移除所有用户数据,包括管理员用户。确认后再执行。
    - +
    Skip to content

    初始化用户密码

    当遗忘本地数据库中存储的用户密码时,无法直接找回明文密码,因为它已通过 bcrypt 加密。不过,可以通过重置功能创建一个原始用户,之后再修改密码为所需的密码。


    操作步骤

    1. 停止 Dashboard 服务

    为了确保数据一致性和避免意外冲突,建议在修改数据库前先停止 Dashboard。


    2. 找到数据库路径

    通常,数据库文件存放在以下位置:

    plaintext
    /opt/nezha/dashboard/data/sqlite.db

    3. 查询和清空用户表

    使用 SQLite 命令行工具操作数据库:

    1. 查看现有用户: 运行以下命令查看用户表内容:

      bash
      sqlite3 /opt/nezha/dashboard/data/sqlite.db "SELECT * FROM users;"

      这将列出当前所有用户的记录。

    2. 清空用户表: 如果您确认需要重置用户表,可运行以下命令清空:

      bash
      sqlite3 /opt/nezha/dashboard/data/sqlite.db "DELETE FROM users;"

    4. 重启 Dashboard 服务

    完成数据库操作后,重新启动 Dashboard.


    5. 登录默认账户

    Dashboard 在初始化时会自动检测用户表是否为空。如果为空,将自动插入默认用户。
    您可以使用以下默认账户登录:

    • 用户名admin
    • 密码admin

    后续操作

    登录成功后,建议立即修改默认密码以提高安全性:

    1. 点击 头像 → 个人信息
    2. 选择 更新个人资料
    3. 修改密码,建议设置一个复杂度较高的密码。

    注意事项

    • 修改数据库前,请确保已备份原始数据库文件:
      bash
      cp /opt/nezha/dashboard/data/sqlite.db /opt/nezha/dashboard/data/sqlite.db.bak
    • 谨慎操作:清空用户表将移除所有用户数据,包括管理员用户。确认后再执行。
    + \ No newline at end of file diff --git a/guide/q2.html b/guide/q2.html index 3543402ce..4c4091ee5 100644 --- a/guide/q2.html +++ b/guide/q2.html @@ -12,7 +12,7 @@ - + @@ -28,8 +28,8 @@ < content-type: application/grpc < < grpc-message: unknown method for service proto.NezhaService -< grpc-status: 12

    关键信息:

    1. content-type 是否为 application/grpc
    2. 是否有 grpc-message 相关的报错信息

    若检查失败:

    - +< grpc-status: 12

    关键信息:

    1. content-type 是否为 application/grpc
    2. 是否有 grpc-message 相关的报错信息

    若检查失败:

    + \ No newline at end of file diff --git a/guide/q3.html b/guide/q3.html index a0d8533fa..70e21f456 100644 --- a/guide/q3.html +++ b/guide/q3.html @@ -12,7 +12,7 @@ - + @@ -110,8 +110,8 @@ } to localhost:8008 } -}

    配置注意事项

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

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

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


    - +}

    配置注意事项

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

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

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


    + \ No newline at end of file diff --git a/guide/q4.html b/guide/q4.html index 74f2d19ee..8d40e0eaa 100644 --- a/guide/q4.html +++ b/guide/q4.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    WebSocket 连接中

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

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

      • /api/v1/ws/server
      • /api/v1/ws/terminal/:id
      • /api/v1/ws/file/:id

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

    - +
    Skip to content

    WebSocket 连接中

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

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

      • /api/v1/ws/server
      • /api/v1/ws/terminal/:id
      • /api/v1/ws/file/:id

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

    + \ No newline at end of file diff --git a/guide/q5.html b/guide/q5.html index dd4a1579a..0fabd8838 100644 --- a/guide/q5.html +++ b/guide/q5.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

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

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

    DANGER

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

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

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

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

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


    注意事项

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

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

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

    DANGER

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

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

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

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

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


    注意事项

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

    如何每月重置流量统计?

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

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

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

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


    TIP

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

    - +
    Skip to content

    如何每月重置流量统计?

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

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

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

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


    TIP

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

    + \ No newline at end of file diff --git a/guide/q7.html b/guide/q7.html index fe1a15356..e7cff127c 100644 --- a/guide/q7.html +++ b/guide/q7.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    自定义 Agent 监控项目

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


    运行参数

    配置参数

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

    运行参数及其作用:

    • client_secret:

      • 用于与 Dashboard 进行安全通信的客户端密钥。
      • 此参数必须与 Dashboard 中的配置相同,否则 Agent 无法正常与服务器通信。
    • debug:

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

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

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

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

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

      • 当为 true 时禁用 Agent 发起的 TCP PingICMP PingHTTP GET 请求。
    • gpu:

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

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

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

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

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

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

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

      • 当为 true 时启用硬件温度监控(仅支持部分硬件,部分 VPS 可能无法获取温度信息)。
    • tls:

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

      • 一个字符串数组,用于指定需要监控的硬盘分区列表。
      • 若指定此参数,将仅对列出的分区进行监控。
    • nic_allowlist:

      • 一个 map[string]bool 类型的允许列表,用于指定需要监控的网卡。
      • 键为网卡名称,值为 true 表示允许监控,false 表示不监控。
      • 若不指定或为空,则默认监控所有可用网卡。
    • use_gitee_to_upgrade:

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

      • 当为 true 时强制使用 IPv6 地址查询国家代码(默认使用 IPv4)。
    • uuid:

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

      • 一个字符串数组,用于设置自定义 DNS 服务器列表。
      • 指定后,Agent 将优先使用此列表中的 DNS 服务器解析域名。
    • custom_ip_api:

      • 一个字符串数组,用于指定自定义 IP 查询 API 列表。
      • Agent 将通过这些 API 获取服务器的公网 IP 信息。

    保存生效

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

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

      shell
      sudo systemctl restart nezha-agent.service
    2. 多 Agent 服务的情况
      如果同一服务器上运行了多个 Agent 服务,请先列出所有 Agent 服务的名称:

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

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

      shell
      sudo systemctl restart <service-name>

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

    - +
    Skip to content

    自定义 Agent 监控项目

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


    运行参数

    配置参数

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

    运行参数及其作用:

    • client_secret:

      • 用于与 Dashboard 进行安全通信的客户端密钥。
      • 此参数必须与 Dashboard 中的配置相同,否则 Agent 无法正常与服务器通信。
    • debug:

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

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

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

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

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

      • 当为 true 时禁用 Agent 发起的 TCP PingICMP PingHTTP GET 请求。
    • gpu:

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

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

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

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

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

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

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

      • 当为 true 时启用硬件温度监控(仅支持部分硬件,部分 VPS 可能无法获取温度信息)。
    • tls:

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

      • 一个字符串数组,用于指定需要监控的硬盘分区列表。
      • 若指定此参数,将仅对列出的分区进行监控。
    • nic_allowlist:

      • 一个 map[string]bool 类型的允许列表,用于指定需要监控的网卡。
      • 键为网卡名称,值为 true 表示允许监控,false 表示不监控。
      • 若不指定或为空,则默认监控所有可用网卡。
    • use_gitee_to_upgrade:

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

      • 当为 true 时强制使用 IPv6 地址查询国家代码(默认使用 IPv4)。
    • uuid:

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

      • 一个字符串数组,用于设置自定义 DNS 服务器列表。
      • 指定后,Agent 将优先使用此列表中的 DNS 服务器解析域名。
    • custom_ip_api:

      • 一个字符串数组,用于指定自定义 IP 查询 API 列表。
      • Agent 将通过这些 API 获取服务器的公网 IP 信息。

    保存生效

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

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

      shell
      sudo systemctl restart nezha-agent.service
    2. 多 Agent 服务的情况
      如果同一服务器上运行了多个 Agent 服务,请先列出所有 Agent 服务的名称:

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

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

      shell
      sudo systemctl restart <service-name>

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

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

    配置说明:

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

    新建 SaaS-OIDC 应用流程

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

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

    身份验证策略配置

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

    策略配置示例(One-time PIN)

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

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

    测试策略

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

    配置说明:

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

    新建 SaaS-OIDC 应用流程

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

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

    身份验证策略配置

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

    策略配置示例(One-time PIN)

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

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

    测试策略

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

    配置字段说明

    1. 账单信息 billingDataMod

    2. 流量和网络配置 planDataMod


    TIP

    使用工具轻松配置
    如果您不熟悉 JSON 配置规则,可以使用以下第三方公开备注生成器快速生成配置: 公开备注生成器

    将生成的 JSON 复制到 Dashboard 对应的公开备注设置中,保存后即可在面板前台展示相关信息。

    - +}

    配置字段说明

    1. 账单信息 billingDataMod

    2. 流量和网络配置 planDataMod


    TIP

    使用工具轻松配置
    如果您不熟悉 JSON 配置规则,可以使用以下第三方公开备注生成器快速生成配置: 公开备注生成器

    将生成的 JSON 复制到 Dashboard 对应的公开备注设置中,保存后即可在面板前台展示相关信息。

    + \ No newline at end of file diff --git a/guide/services.html b/guide/services.html index 5da8519bd..fe00d7e76 100644 --- a/guide/services.html +++ b/guide/services.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    服务监控

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


    使用方法

    新增服务监控

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

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

    2. 配置参数
      在新增监控时,设置以下参数:

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


    延迟变化通知

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

    • 启用延迟通知:选择启用后,当延迟超出设置的范围(大于 最高延迟 或小于 最低延迟)时将发送通知。

    通知时触发任务

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

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

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


    网络延迟图表

    对于 TCP-PingICMP-Ping 类型的监控,Dashboard 会自动生成网络延迟统计图表:

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

    管理监控

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

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

    服务监控

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


    使用方法

    新增服务监控

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

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

    2. 配置参数
      在新增监控时,设置以下参数:

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


    延迟变化通知

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

    • 启用延迟通知:选择启用后,当延迟超出设置的范围(大于 最高延迟 或小于 最低延迟)时将发送通知。

    通知时触发任务

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

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

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


    网络延迟图表

    对于 TCP-PingICMP-Ping 类型的监控,Dashboard 会自动生成网络延迟统计图表:

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

    管理监控

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

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

    设置

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


    站点名称

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


    语言设置

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

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

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


    自定义代码

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

    WARNING

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


    仪表板服务器域名/IP(无 CDN)

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

    前台查看密码

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


    真实 IP 请求头

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

    DANGER

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

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

      • 如果本地账户未设置任何防护,可能导致高频密码枚举攻击(如每秒尝试 100 个密码)。
      • WAF 的 IP 识别依赖于正确配置的请求头,以有效拦截此类攻击。
    3. 安全建议
      确保您了解 Header 的实际传递机制后再启用此功能,并仔细验证配置结果。


    IP 变更提醒

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

    配置选项

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

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

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

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

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


    用户管理

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

    • 可以添加多个用户,便于多人协作管理。
    - +
    Skip to content

    设置

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


    站点名称

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


    语言设置

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

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

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


    自定义代码

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

    WARNING

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


    仪表板服务器域名/IP(无 CDN)

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

    前台查看密码

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


    真实 IP 请求头

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

    DANGER

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

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

      • 如果本地账户未设置任何防护,可能导致高频密码枚举攻击(如每秒尝试 100 个密码)。
      • WAF 的 IP 识别依赖于正确配置的请求头,以有效拦截此类攻击。
    3. 安全建议
      确保您了解 Header 的实际传递机制后再启用此功能,并仔细验证配置结果。


    IP 变更提醒

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

    配置选项

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

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

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

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

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


    用户管理

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

    • 可以添加多个用户,便于多人协作管理。
    + \ No newline at end of file diff --git a/guide/tasks.html b/guide/tasks.html index cd661ec2b..aac3c62be 100644 --- a/guide/tasks.html +++ b/guide/tasks.html @@ -12,7 +12,7 @@ - + @@ -22,8 +22,8 @@ -
    Skip to content

    任务管理

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

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

    使用方法

    添加任务

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

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

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


    管理任务

    如需管理已有任务:

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

    常见问题

    1. xxx 命令找不到

    • 运行失败提示 “xxx 命令找不到”,通常是因为 PATH 环境变量未正确加载。
    • 解决方法:
      • 在 Linux 中,可在命令前加 source ~/.bashrc
        bash
        source ~/.bashrc && your_command
      • 或直接使用绝对路径执行命令(例如 /usr/bin/command)。
    - +
    Skip to content

    任务管理

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

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

    使用方法

    添加任务

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

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

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


    管理任务

    如需管理已有任务:

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

    常见问题

    1. xxx 命令找不到

    • 运行失败提示 “xxx 命令找不到”,通常是因为 PATH 环境变量未正确加载。
    • 解决方法:
      • 在 Linux 中,可在命令前加 source ~/.bashrc
        bash
        source ~/.bashrc && your_command
      • 或直接使用绝对路径执行命令(例如 /usr/bin/command)。
    + \ No newline at end of file diff --git a/hashmap.json b/hashmap.json index 8c729801f..84e468418 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"case_case2.md":"ByVgBvY8","en_us_developer_i18n.md":"D0XV7oe9","en_us_case_case4.md":"BT7M8x47","guide_dashboardq.md":"B5VlHM2f","guide_q13.md":"C34c3K_G","guide_q4.md":"C8j-4S4s","en_us_case_case10.md":"Dh675cr9","en_us_guide_q2.md":"BqD6wjpX","en_us_guide_notifications.md":"C8ZKo2py","guide_loginq.md":"C2oYZPva","en_us_case_case6.md":"BbHQXrSX","en_us_guide_services.md":"omeXlTZw","en_us_guide_servers.md":"Cd_QyRIJ","en_us_case_case3.md":"CxfX4H9O","guide_q5.md":"CvSjL4Vo","guide_q1.md":"fSbdGvP0","en_us_guide_q9.md":"DolADGmd","guide_q6.md":"BxqUnc3F","guide_group.md":"C391nygy","guide_q7.md":"D_iYM2zI","case_case6.md":"DT9MDQps","en_us_guide_group.md":"BYr_LcTF","en_us_guide_q3.md":"Cl4ptq3A","en_us_guide_q7.md":"CAepD5Z7","guide_q12.md":"oPwAGT36","en_us_guide_agentq.md":"C6CnuAqB","guide_nat.md":"CN9qXU6i","guide_q2.md":"B7oJim4f","en_us_guide_settings.md":"BwO7Dayk","guide_agent.md":"Ch_2s0ip","guide_q3.md":"DHtGrxgG","en_us_case_case2.md":"Cg62bB-q","en_us_guide_ddns.md":"Cw9Hj6WW","en_us_guide_q5.md":"DPH3p_yw","en_us_guide_loginq.md":"Cfx7n2yT","developer_i18n.md":"BNsE_8Wh","guide_q10.md":"HIQGl7gF","en_us_guide_q8.md":"VOpUHWly","case_case8.md":"Gqb44HV5","developer_index.md":"07Ytp7Q1","en_us_guide_api.md":"D3oJt-34","en_us_developer_api.md":"DPjgZE9F","guide_ddns.md":"BXIuWs5P","guide_api.md":"DKZI-KF3","case_case10.md":"BXrcze-b","en_us_guide_agent.md":"-aVSue02","en_us_guide_q6.md":"B-eHux73","guide_dashboard.md":"B54Y1gHD","en_us_guide_q11.md":"Dy6Uvd2J","index.md":"CKgmOy6M","en_us_guide_dashboard.md":"BE5Z5o_F","guide_q9.md":"CE-mJ7TO","en_us_guide_q12.md":"h-BkLECe","guide_tasks.md":"CDCxngXm","case_case9.md":"C4P62Hck","case_index.md":"DAv4YERW","guide_services.md":"3lVlA1re","en_us_guide_nat.md":"CX1AOHPh","en_us_guide_q4.md":"DiNdoORy","case_case7.md":"Bi7B1OIM","case_case1.md":"Ywu6NP8Q","guide_agentq.md":"C9RqfRMH","developer_api.md":"hXENdb8P","en_us_case_case1.md":"ktD6yK0Q","en_us_case_case8.md":"B1NkMZ1x","case_case5.md":"Q06oKkpC","en_us_guide_dashboardq.md":"B1U2xENE","guide_notifications.md":"VYf_TQqp","en_us_case_index.md":"XCD7nYME","en_us_guide_q10.md":"D6v3oRO6","en_us_case_case7.md":"_4E0p9pQ","case_case4.md":"C08M8hDI","guide_settings.md":"xn3Qs_0V","en_us_case_case5.md":"CsYCS8Ki","guide_q11.md":"Chp2KMtC","case_case3.md":"C6gvP_76","en_us_index.md":"D05uJyz5","guide_q8.md":"DI7fH3LZ","en_us_guide_tasks.md":"DMBi1GaZ","en_us_case_case9.md":"Voa6Gbdf","en_us_developer_index.md":"5ZKnAHy2","guide_servers.md":"biB9Zv_p","en_us_guide_q13.md":"CDST9ur4"} +{"en_us_guide_q4.md":"CV6jTF_n","en_us_guide_q10.md":"CHEFAxFD","en_us_guide_q13.md":"o116vQ8X","en_us_guide_nat.md":"DdJAAET4","en_us_guide_ddns.md":"Da8JgC6E","en_us_guide_dashboardq.md":"BnJfSQtO","en_us_guide_q8.md":"Bwkv-0zc","en_us_case_case4.md":"DL4X1OaX","developer_api.md":"CMPYWCfO","case_case1.md":"CihiTZQ_","case_case2.md":"CrjuCbZS","case_case7.md":"C8wRtfvt","en_us_case_case10.md":"DwwodtT7","case_case4.md":"CD4B2QPW","case_case3.md":"DnL6_NP5","developer_i18n.md":"BhXEaJqR","case_case10.md":"CJzP9MVm","en_us_case_case2.md":"C2ONzimi","case_index.md":"B1h9EbIM","case_case8.md":"QybEfBz0","en_us_case_case6.md":"B4wHjbcM","en_us_guide_q11.md":"z31JBxeT","en_us_case_case7.md":"BtJxmb_L","en_us_case_index.md":"rGbsWNzh","en_us_case_case9.md":"BvCnNBEa","en_us_developer_api.md":"DYAZm_L6","en_us_developer_index.md":"DhwlpkQp","en_us_developer_i18n.md":"D2W9RdYE","en_us_guide_agentq.md":"Wb7wo2WT","guide_dashboardq.md":"525v2ENt","en_us_guide_servers.md":"BZU6m6uS","en_us_guide_services.md":"DLnHcL3L","en_us_guide_tasks.md":"BBWIdOSK","en_us_index.md":"DVlf96Xy","en_us_guide_api.md":"CvF0Kqpv","guide_dashboard.md":"gJPSfMZy","guide_services.md":"CqdgaV0h","index.md":"BcfULuUw","guide_q2.md":"BDnlthlX","case_case6.md":"aLtIpBwA","case_case5.md":"DipT56HK","en_us_case_case1.md":"DSw3142l","en_us_case_case3.md":"RYTYnnKO","case_case9.md":"D54ioPzT","en_us_guide_q6.md":"DKuZXJPJ","en_us_guide_q2.md":"B_q5r97G","en_us_guide_q5.md":"DPVjotFJ","en_us_guide_q7.md":"Cpk0BGjq","en_us_guide_notifications.md":"B0YN8l1a","en_us_case_case8.md":"BVoNi7MT","en_us_guide_q3.md":"u_jbqx-R","en_us_guide_q12.md":"CsKsZu_A","en_us_guide_agent.md":"BGW-EA-i","en_us_guide_q9.md":"BlYu4Ux1","guide_q12.md":"GfU-tGMq","guide_q1.md":"DmQbcUlS","guide_q13.md":"COznI_Rv","en_us_guide_group.md":"xLNq0tsu","guide_q3.md":"OB1j5EK4","en_us_guide_loginq.md":"zMWvjKHv","guide_q11.md":"B0uJnJSP","en_us_guide_dashboard.md":"DzRaNP_Q","developer_index.md":"DNkAIAnI","guide_q10.md":"CHXnylvw","guide_q4.md":"vVV_41O5","guide_tasks.md":"QHntpZUZ","en_us_case_case5.md":"u-PXffkj","guide_q8.md":"BhZXWsTp","guide_nat.md":"CxEceMP2","guide_servers.md":"CE2vZNd9","guide_group.md":"CBLUTZxl","guide_q6.md":"yQCB6_Yw","guide_q5.md":"CPZIah3E","guide_settings.md":"C16YRrM-","guide_api.md":"UXeDKrjF","guide_notifications.md":"CBpLxN6U","guide_q9.md":"DBl0W9qo","guide_ddns.md":"1VOz3CtG","guide_loginq.md":"Cbq8fq8A","en_us_guide_settings.md":"CTu06FVk","guide_q7.md":"DD0whRls","guide_agent.md":"hY7zDUcW","guide_agentq.md":"DLY4zn7A"} diff --git a/index.html b/index.html index 2186a89f5..f69b1bd98 100644 --- a/index.html +++ b/index.html @@ -12,7 +12,7 @@ - + @@ -23,7 +23,7 @@
    Skip to content

    哪吒监控 V1

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

    - + \ No newline at end of file