deploy: 26cb183d68

assets/case_case1.md.Cy-fj0KG.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":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1725160726000}'),o={name:"case/case1.md"},_=r('<h1 id="自建一个tg机器人来查询服务器信息" tabindex="-1">自建一个TG机器人来查询服务器信息 <a class="header-anchor" href="#自建一个tg机器人来查询服务器信息" aria-label="Permalink to &quot;自建一个TG机器人来查询服务器信息&quot;">​</a></h1><p>贡献者:</p><ul><li><a href="https://github.com/spiritLHLS" target="_blank" rel="noreferrer">spiritLHLS</a></li><li><a href="https://github.com/Erope/" target="_blank" rel="noreferrer">Erope</a></li></ul><p>项目地址：<a href="https://github.com/spiritLHLS/nezha_api_tgbot" target="_blank" rel="noreferrer">nezha_api_tgbot</a></p><p>镜像备份（非实时更新）：<a href="https://github.com/nezhahq/nezha_api_tgbot" target="_blank" rel="noreferrer">nezha_api_tgbot</a><br> 机器人可以通过API向面板请求服务器状态信息，得到信息后发送给用户<br> 你可以搭建此机器人来方便地查看指定服务器的当前状态且不需要打开面板</p>',5),s=[_];function i(n,c,p,h,l,d){return a(),t("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default};
+import{_ as e,c as t,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1728186808000}'),o={name:"case/case1.md"},_=r('<h1 id="自建一个tg机器人来查询服务器信息" tabindex="-1">自建一个TG机器人来查询服务器信息 <a class="header-anchor" href="#自建一个tg机器人来查询服务器信息" aria-label="Permalink to &quot;自建一个TG机器人来查询服务器信息&quot;">​</a></h1><p>贡献者:</p><ul><li><a href="https://github.com/spiritLHLS" target="_blank" rel="noreferrer">spiritLHLS</a></li><li><a href="https://github.com/Erope/" target="_blank" rel="noreferrer">Erope</a></li></ul><p>项目地址：<a href="https://github.com/spiritLHLS/nezha_api_tgbot" target="_blank" rel="noreferrer">nezha_api_tgbot</a></p><p>镜像备份（非实时更新）：<a href="https://github.com/nezhahq/nezha_api_tgbot" target="_blank" rel="noreferrer">nezha_api_tgbot</a><br> 机器人可以通过API向面板请求服务器状态信息，得到信息后发送给用户<br> 你可以搭建此机器人来方便地查看指定服务器的当前状态且不需要打开面板</p>',5),s=[_];function i(n,c,p,h,l,d){return a(),t("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default};

assets/case_case1.md.Cy-fj0KG.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":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1725160726000}'),o={name:"case/case1.md"},_=r("",5),s=[_];function i(n,c,p,h,l,d){return a(),t("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default};
+import{_ as e,c as t,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1728186808000}'),o={name:"case/case1.md"},_=r("",5),s=[_];function i(n,c,p,h,l,d){return a(),t("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default};

assets/case_case2.md.uWaImfP5.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":1725160726000}'),o={name:"case/case2.md"},c=t('<h1 id="在ios-macos中使用siri运行快捷指令查询服务器状态" tabindex="-1">在iOS/MacOS中使用Siri运行快捷指令查询服务器状态 <a class="header-anchor" href="#在ios-macos中使用siri运行快捷指令查询服务器状态" aria-label="Permalink to &quot;在iOS/MacOS中使用Siri运行快捷指令查询服务器状态&quot;">​</a></h1><p>当前版本：V1.0<br> 贡献者：</p><ul><li>白歌 <a href="https://github.com/hhhkkk520" target="_blank" rel="noreferrer">hhhkkk520</a></li></ul><h2 id="获取快捷指令" tabindex="-1">获取快捷指令 <a class="header-anchor" href="#获取快捷指令" aria-label="Permalink to &quot;获取快捷指令&quot;">​</a></h2><p>使用iPhone或iPad扫描以下二维码，获取快捷指令<br><br><img src="'+a+'" alt="coode"><br><br> MacOS用户请访问<a href="https://www.icloud.com/shortcuts/312005bf5ffd4387ac92a84056db9f09" target="_blank" rel="noreferrer">这里</a>，获取快捷指令</p><h2 id="使用说明" tabindex="-1">使用说明 <a class="header-anchor" href="#使用说明" aria-label="Permalink to &quot;使用说明&quot;">​</a></h2><ul><li>获取快捷指令后，打开并编辑快捷指令</li><li>分别在三个文本框中填入 <code>面板URL</code>、<code>API Token</code>、<code>服务器ID</code></li><li>保存编辑并测试运行，能获取结果则表示设置正确</li><li>修改快捷指令的名称，如修改为：“一号服务器状态”，保存后便可使用Siri指令：“嘿Siri，一号服务器状态”来获取服务器状态</li></ul><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>每个快捷指令只能监控一台服务器，如需要监控多个服务器，请多次复制此快捷指令并分别配置，然后分别修改快捷指令名称，如；一号服务器状态、二号服务器状态等</p></div>',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":1728186808000}'),o={name:"case/case2.md"},c=t('<h1 id="在ios-macos中使用siri运行快捷指令查询服务器状态" tabindex="-1">在iOS/MacOS中使用Siri运行快捷指令查询服务器状态 <a class="header-anchor" href="#在ios-macos中使用siri运行快捷指令查询服务器状态" aria-label="Permalink to &quot;在iOS/MacOS中使用Siri运行快捷指令查询服务器状态&quot;">​</a></h1><p>当前版本：V1.0<br> 贡献者：</p><ul><li>白歌 <a href="https://github.com/hhhkkk520" target="_blank" rel="noreferrer">hhhkkk520</a></li></ul><h2 id="获取快捷指令" tabindex="-1">获取快捷指令 <a class="header-anchor" href="#获取快捷指令" aria-label="Permalink to &quot;获取快捷指令&quot;">​</a></h2><p>使用iPhone或iPad扫描以下二维码，获取快捷指令<br><br><img src="'+a+'" alt="coode"><br><br> MacOS用户请访问<a href="https://www.icloud.com/shortcuts/312005bf5ffd4387ac92a84056db9f09" target="_blank" rel="noreferrer">这里</a>，获取快捷指令</p><h2 id="使用说明" tabindex="-1">使用说明 <a class="header-anchor" href="#使用说明" aria-label="Permalink to &quot;使用说明&quot;">​</a></h2><ul><li>获取快捷指令后，打开并编辑快捷指令</li><li>分别在三个文本框中填入 <code>面板URL</code>、<code>API Token</code>、<code>服务器ID</code></li><li>保存编辑并测试运行，能获取结果则表示设置正确</li><li>修改快捷指令的名称，如修改为：“一号服务器状态”，保存后便可使用Siri指令：“嘿Siri，一号服务器状态”来获取服务器状态</li></ul><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>每个快捷指令只能监控一台服务器，如需要监控多个服务器，请多次复制此快捷指令并分别配置，然后分别修改快捷指令名称，如；一号服务器状态、二号服务器状态等</p></div>',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};

assets/case_case2.md.uWaImfP5.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":1725160726000}'),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":1728186808000}'),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};

assets/case_case3.md.jjw6EPXz.js

@@ -1 +1 @@
-import{_ as t,c as e,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1725160726000}'),d={name:"case/case3.md"},l=r('<h1 id="自建使用-api-来进行查询-且支持多语言的-telegram-查询机器人" tabindex="-1">自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人 <a class="header-anchor" href="#自建使用-api-来进行查询-且支持多语言的-telegram-查询机器人" aria-label="Permalink to &quot;自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人&quot;">​</a></h1><p>贡献者:</p><ul><li><a href="https://github.com/tech-fever" target="_blank" rel="noreferrer">tech-fever</a></li></ul><p>项目地址：<a href="https://github.com/tech-fever/nezha_telegram_bot" target="_blank" rel="noreferrer">nezha_telegram_bot</a></p><p>镜像备份（非实时更新）：<a href="https://github.com/nezhahq/nezha_telegram_bot" target="_blank" rel="noreferrer">nezha_telegram_bot</a></p><h2 id="项目特色" tabindex="-1">项目特色 <a class="header-anchor" href="#项目特色" aria-label="Permalink to &quot;项目特色&quot;">​</a></h2><p>开源Telegram机器人项目，可以基于API实时查询哪吒面板的服务器信息。</p><ul><li>[x] 支持中/英多语言切换</li><li>[x] 支持分组统计(CPU、磁盘、内存、上下行速度、流量统计等)</li><li>[x] 支持实时刷新单个服务器数据</li><li>[x] 支持键盘互动查询</li><li>[x] 支持命令直接查询</li><li>[x] 增加群聊判断，限制群聊可发送命令</li><li>[x] 增加群聊内5秒自动删除信息</li><li>[x] 支持docker部署</li></ul><h2 id="命令列表" tabindex="-1">命令列表 <a class="header-anchor" href="#命令列表" aria-label="Permalink to &quot;命令列表&quot;">​</a></h2><table tabindex="0"><thead><tr><th>命令</th><th>功能</th><th>仅私聊</th></tr></thead><tbody><tr><td>start</td><td>开始使用键盘主菜单</td><td>✔️</td></tr><tr><td>help</td><td>帮助列表</td><td>❌</td></tr><tr><td>add</td><td>添加面板链接和token</td><td>✔️</td></tr><tr><td>url</td><td>添加面板链接</td><td>✔️</td></tr><tr><td>token</td><td>添加面板token</td><td>✔️</td></tr><tr><td>info</td><td>获取保存的面板链接和token</td><td>✔️</td></tr><tr><td>delete</td><td>删除保存的面板链接和token</td><td>✔️</td></tr><tr><td>id</td><td>命令后面添加整数id，来进行单个服务器信息查询（私聊带刷新按钮，群聊不带）</td><td>❌</td></tr><tr><td>all</td><td>查询所有服务器的统计信息</td><td>❌</td></tr><tr><td>search</td><td>在服务器名字中搜索关键字（支持多个，用空格分开）</td><td>❌</td></tr></tbody></table><h2 id="效果展示" tabindex="-1">效果展示 <a class="header-anchor" href="#效果展示" aria-label="Permalink to &quot;效果展示&quot;">​</a></h2><p><img src="https://user-images.githubusercontent.com/105153585/175813727-bef77a8e-ff46-4fd4-b41b-43902abf6159.png#pic_left" alt="image"><img src="https://user-images.githubusercontent.com/105153585/175813645-4df4f4c7-2591-4133-9645-21c7db2f62ab.png#pic_right" alt="image"></p>',12),i=[l];function o(h,n,c,s,_,m){return a(),e("div",null,i)}const f=t(d,[["render",o]]);export{b as __pageData,f as default};
+import{_ as t,c as e,o as a,a4 as r}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1728186808000}'),d={name:"case/case3.md"},l=r('<h1 id="自建使用-api-来进行查询-且支持多语言的-telegram-查询机器人" tabindex="-1">自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人 <a class="header-anchor" href="#自建使用-api-来进行查询-且支持多语言的-telegram-查询机器人" aria-label="Permalink to &quot;自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人&quot;">​</a></h1><p>贡献者:</p><ul><li><a href="https://github.com/tech-fever" target="_blank" rel="noreferrer">tech-fever</a></li></ul><p>项目地址：<a href="https://github.com/tech-fever/nezha_telegram_bot" target="_blank" rel="noreferrer">nezha_telegram_bot</a></p><p>镜像备份（非实时更新）：<a href="https://github.com/nezhahq/nezha_telegram_bot" target="_blank" rel="noreferrer">nezha_telegram_bot</a></p><h2 id="项目特色" tabindex="-1">项目特色 <a class="header-anchor" href="#项目特色" aria-label="Permalink to &quot;项目特色&quot;">​</a></h2><p>开源Telegram机器人项目，可以基于API实时查询哪吒面板的服务器信息。</p><ul><li>[x] 支持中/英多语言切换</li><li>[x] 支持分组统计(CPU、磁盘、内存、上下行速度、流量统计等)</li><li>[x] 支持实时刷新单个服务器数据</li><li>[x] 支持键盘互动查询</li><li>[x] 支持命令直接查询</li><li>[x] 增加群聊判断，限制群聊可发送命令</li><li>[x] 增加群聊内5秒自动删除信息</li><li>[x] 支持docker部署</li></ul><h2 id="命令列表" tabindex="-1">命令列表 <a class="header-anchor" href="#命令列表" aria-label="Permalink to &quot;命令列表&quot;">​</a></h2><table tabindex="0"><thead><tr><th>命令</th><th>功能</th><th>仅私聊</th></tr></thead><tbody><tr><td>start</td><td>开始使用键盘主菜单</td><td>✔️</td></tr><tr><td>help</td><td>帮助列表</td><td>❌</td></tr><tr><td>add</td><td>添加面板链接和token</td><td>✔️</td></tr><tr><td>url</td><td>添加面板链接</td><td>✔️</td></tr><tr><td>token</td><td>添加面板token</td><td>✔️</td></tr><tr><td>info</td><td>获取保存的面板链接和token</td><td>✔️</td></tr><tr><td>delete</td><td>删除保存的面板链接和token</td><td>✔️</td></tr><tr><td>id</td><td>命令后面添加整数id，来进行单个服务器信息查询（私聊带刷新按钮，群聊不带）</td><td>❌</td></tr><tr><td>all</td><td>查询所有服务器的统计信息</td><td>❌</td></tr><tr><td>search</td><td>在服务器名字中搜索关键字（支持多个，用空格分开）</td><td>❌</td></tr></tbody></table><h2 id="效果展示" tabindex="-1">效果展示 <a class="header-anchor" href="#效果展示" aria-label="Permalink to &quot;效果展示&quot;">​</a></h2><p><img src="https://user-images.githubusercontent.com/105153585/175813727-bef77a8e-ff46-4fd4-b41b-43902abf6159.png#pic_left" alt="image"><img src="https://user-images.githubusercontent.com/105153585/175813645-4df4f4c7-2591-4133-9645-21c7db2f62ab.png#pic_right" alt="image"></p>',12),i=[l];function o(h,n,c,s,_,m){return a(),e("div",null,i)}const f=t(d,[["render",o]]);export{b as __pageData,f as default};

assets/case_case3.md.jjw6EPXz.lean.js

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

assets/case_case4.md.D3OIw7rR.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",u=JSON.parse('{"title":"重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1725160726000}'),_={name:"case/case4.md"},i=a('<h1 id="重磅推荐-一秒拥有宇宙级算力-让你在人前-不-再-自-卑" tabindex="-1">重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑 <a class="header-anchor" href="#重磅推荐-一秒拥有宇宙级算力-让你在人前-不-再-自-卑" aria-label="Permalink to &quot;重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑&quot;">​</a></h1><br><hr><p><img src="'+r+'" alt="2"><br><br><span style="font-size:5;">还在因为自己的小鸡配置太差被朋友嘲笑吗？ </span><br><span style="font-size:5;">还在想参加以针会友活动却因为小鸡不够排面而觉得羞耻吗？ </span><br><span style="font-size:5;">还在因为在哪吒TG群里机器人排名太低而觉得自己低人一等吗？ </span><br><br><br><span style="font-size:6;"><strong>今天开始！找回自信！</strong></span><br></p><p>来自南京的名老中医 <a href="https://github.com/dysf888" target="_blank" rel="noreferrer">dysf888</a> 独家秘方！让你<strong>找回男人本色，激情畅享！</strong><br> 安装 <a href="https://github.com/dysf888/fake-nezha-agent" target="_blank" rel="noreferrer">Fake Agent</a>，可随意修改服务器监测数据的倍数上传到 Dashboard，让你的小鸡 <strong>脱！胎！换！骨！</strong> 让你在 MJJ 面前<span style="font-size:5;">硬</span>起来！</p><p>镜像备份（非实时更新）：<a href="https://github.com/nezhahq/fake-nezha-agent" target="_blank" rel="noreferrer">Fake Agent</a><br><br></p><p><span style="font-size:4;"><strong>哪吒监控创始人奶爸也在用：</strong></span><br><img src="'+n+'" alt="5"></p><br><p><span style="font-size:4;"><strong>男人用了都说好：</strong></span><br><img src="'+o+'" alt="6"><br><img src="'+p+'" alt="4"></p><br><hr><p><img src="'+c+'" alt="1"></p>',12),l=[i];function g(b,f,h,m,d,k){return e(),t("div",null,l)}const y=s(_,[["render",g]]);export{u as __pageData,y 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",u=JSON.parse('{"title":"重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1728186808000}'),_={name:"case/case4.md"},i=a('<h1 id="重磅推荐-一秒拥有宇宙级算力-让你在人前-不-再-自-卑" tabindex="-1">重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑 <a class="header-anchor" href="#重磅推荐-一秒拥有宇宙级算力-让你在人前-不-再-自-卑" aria-label="Permalink to &quot;重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑&quot;">​</a></h1><br><hr><p><img src="'+r+'" alt="2"><br><br><span style="font-size:5;">还在因为自己的小鸡配置太差被朋友嘲笑吗？ </span><br><span style="font-size:5;">还在想参加以针会友活动却因为小鸡不够排面而觉得羞耻吗？ </span><br><span style="font-size:5;">还在因为在哪吒TG群里机器人排名太低而觉得自己低人一等吗？ </span><br><br><br><span style="font-size:6;"><strong>今天开始！找回自信！</strong></span><br></p><p>来自南京的名老中医 <a href="https://github.com/dysf888" target="_blank" rel="noreferrer">dysf888</a> 独家秘方！让你<strong>找回男人本色，激情畅享！</strong><br> 安装 <a href="https://github.com/dysf888/fake-nezha-agent" target="_blank" rel="noreferrer">Fake Agent</a>，可随意修改服务器监测数据的倍数上传到 Dashboard，让你的小鸡 <strong>脱！胎！换！骨！</strong> 让你在 MJJ 面前<span style="font-size:5;">硬</span>起来！</p><p>镜像备份（非实时更新）：<a href="https://github.com/nezhahq/fake-nezha-agent" target="_blank" rel="noreferrer">Fake Agent</a><br><br></p><p><span style="font-size:4;"><strong>哪吒监控创始人奶爸也在用：</strong></span><br><img src="'+n+'" alt="5"></p><br><p><span style="font-size:4;"><strong>男人用了都说好：</strong></span><br><img src="'+o+'" alt="6"><br><img src="'+p+'" alt="4"></p><br><hr><p><img src="'+c+'" alt="1"></p>',12),l=[i];function g(b,f,h,m,d,k){return e(),t("div",null,l)}const y=s(_,[["render",g]]);export{u as __pageData,y as default};

assets/case_case4.md.D3OIw7rR.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",u=JSON.parse('{"title":"重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1725160726000}'),_={name:"case/case4.md"},i=a("",12),l=[i];function g(b,f,h,m,d,k){return e(),t("div",null,l)}const y=s(_,[["render",g]]);export{u as __pageData,y 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",u=JSON.parse('{"title":"重磅推荐！一秒拥有宇宙级算力！让你在人前，不！再！自！卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1728186808000}'),_={name:"case/case4.md"},i=a("",12),l=[i];function g(b,f,h,m,d,k){return e(),t("div",null,l)}const y=s(_,[["render",g]]);export{u as __pageData,y as default};

assets/case_case5.md.CR61PZ8I.js

@@ -1,4 +1,4 @@
-import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1725160726000}'),n={name:"case/case5.md"},r=t(`<h1 id="使用-argo-隧道的哪吒服务端" tabindex="-1">使用 Argo 隧道的哪吒服务端 <a class="header-anchor" href="#使用-argo-隧道的哪吒服务端" aria-label="Permalink to &quot;使用 Argo 隧道的哪吒服务端&quot;">​</a></h1><p>贡献者:</p><ul><li><a href="https://github.com/fscarmen2" target="_blank" rel="noreferrer">fscarmen</a></li></ul><p>项目地址：<a href="https://github.com/fscarmen2/Argo-Nezha-Service-Container" target="_blank" rel="noreferrer">Argo-Nezha-Service-Container</a></p><p>镜像备份（非实时更新）：<a href="https://github.com/nezhahq/Argo-Nezha-Service-Container" target="_blank" rel="noreferrer">Argo-Nezha-Service-Container</a></p><hr><h2 id="目录" tabindex="-1">目录 <a class="header-anchor" href="#目录" aria-label="Permalink to &quot;目录&quot;">​</a></h2><ul><li><a href="./case5.html#项目特点">项目特点</a></li><li><a href="./case5.html#准备需要用的变量">准备需要用的变量</a></li><li><a href="./case5.html#argo-认证的获取方式-json-或-token">Argo 认证的获取方式: json 或 token</a></li><li><a href="./case5.html#PaaS-部署实例">PaaS 部署实例</a></li><li><a href="./case5.html#vps-部署方式-1-----docker">VPS 部署方式 1 --- docker</a></li><li><a href="./case5.html#vps-部署方式-2-----宿主机">VPS 部署方式 2 --- 宿主机</a></li><li><a href="./case5.html#客户端接入">客户端接入</a></li><li><a href="./case5.html#ssh-接入">SSH 接入</a></li><li><a href="./case5.html#手动备份数据">手动备份数据</a></li><li><a href="./case5.html#自动还原备份">自动还原备份</a></li><li><a href="./case5.html#手动还原备份">手动还原备份</a></li><li><a href="./case5.html#完美搬家">完美搬家</a></li><li><a href="./case5.html#主体目录文件及说明">主体目录文件及说明</a></li><li><a href="./case5.html#鸣谢下列作者的文章和项目">鸣谢下列作者的文章和项目</a></li><li><a href="./case5.html#免责声明">免责声明</a></li></ul><hr><h2 id="项目特点" tabindex="-1">项目特点: <a class="header-anchor" href="#项目特点" aria-label="Permalink to &quot;项目特点:&quot;">​</a></h2><ul><li>适用范围更广 --- 只要能连通网络，就能安装哪吒服务端，如 LXC, OpenVZ VPS，Nas 虚拟机 , Container PaaS 等</li><li>Argo 隧道突破需要公网入口的限制 --- 传统的哪吒需要有两个公网端口，一个用于面板的访问，另一个用于客户端上报数据，本项目借用 Cloudflare Argo 隧道，使用内网穿透的办法</li><li>IPv4 / v6 具备更高的灵活性 --- 传统哪吒需要处理服务端和客户端的 IPv4/v6 兼容性问题，还需要通过 warp 等工具来解决不对应的情况。然而，本项目可以完全不需要考虑这些问题，可以任意对接，更加方便和简便</li><li>一条 Argo 隧道分流多个域名和协议 --- 建立一条内网穿透的 Argo 隧道，即可分流三个域名(hostname)和协议(protocal)，分别用于面板的访问(http)，客户端上报数据(tcp)和 ssh（可选）</li><li>GrpcWebProxy 反向代理的 gRPC 数据端口 --- 配上证书做 tls 终结，然后 Argo 的隧道配置用 https 服务指向这个反向代理，启用http2回源，grpc(nezha)-&gt;GrpcWebProxy-&gt;h2(argo)-&gt;cf cdn edge-&gt;agent</li><li>每天自动备份 --- 北京时间每天 4 时 0 分自动备份整个哪吒面板文件夹到指定的 github 私库，包括面板主题，面板设置，探针数据和隧道信息，备份保留近 5 天数据；鉴于内容十分重要，必须要放在私库</li><li>每天自动更新面板 -- 北京时间每天 4 时 0 分自动检测最新的官方面板版本，有升级时自动更新</li><li>手/自一体还原备份 --- 每分钟检测一次在线还原文件的内容，遇到有更新立刻还原</li><li>默认内置本机探针 --- 能很方便的监控自身服务器信息</li><li>数据更安全 --- Argo 隧道使用TLS加密通信，可以将应用程序流量安全地传输到 Cloudflare 网络，提高了应用程序的安全性和可靠性。此外，Argo Tunnel也可以防止IP泄露和DDoS攻击等网络威胁</li></ul><img width="1609" alt="image" src="https://github.com/fscarmen2/Argo-Nezha-Service-Container/assets/92626977/4893c3cd-5055-468f-8138-6c5460bdd1e4"><h2 id="准备需要用的变量" tabindex="-1">准备需要用的变量 <a class="header-anchor" href="#准备需要用的变量" aria-label="Permalink to &quot;准备需要用的变量&quot;">​</a></h2><ul><li>到 Cloudflare 官网，选择使用的域名，打开 <code>网络</code> 选项将 <code>gRPC</code> 开
Line truncated
+import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1728186808000}'),n={name:"case/case5.md"},r=t(`<h1 id="使用-argo-隧道的哪吒服务端" tabindex="-1">使用 Argo 隧道的哪吒服务端 <a class="header-anchor" href="#使用-argo-隧道的哪吒服务端" aria-label="Permalink to &quot;使用 Argo 隧道的哪吒服务端&quot;">​</a></h1><p>贡献者:</p><ul><li><a href="https://github.com/fscarmen2" target="_blank" rel="noreferrer">fscarmen</a></li></ul><p>项目地址：<a href="https://github.com/fscarmen2/Argo-Nezha-Service-Container" target="_blank" rel="noreferrer">Argo-Nezha-Service-Container</a></p><p>镜像备份（非实时更新）：<a href="https://github.com/nezhahq/Argo-Nezha-Service-Container" target="_blank" rel="noreferrer">Argo-Nezha-Service-Container</a></p><hr><h2 id="目录" tabindex="-1">目录 <a class="header-anchor" href="#目录" aria-label="Permalink to &quot;目录&quot;">​</a></h2><ul><li><a href="./case5.html#项目特点">项目特点</a></li><li><a href="./case5.html#准备需要用的变量">准备需要用的变量</a></li><li><a href="./case5.html#argo-认证的获取方式-json-或-token">Argo 认证的获取方式: json 或 token</a></li><li><a href="./case5.html#PaaS-部署实例">PaaS 部署实例</a></li><li><a href="./case5.html#vps-部署方式-1-----docker">VPS 部署方式 1 --- docker</a></li><li><a href="./case5.html#vps-部署方式-2-----宿主机">VPS 部署方式 2 --- 宿主机</a></li><li><a href="./case5.html#客户端接入">客户端接入</a></li><li><a href="./case5.html#ssh-接入">SSH 接入</a></li><li><a href="./case5.html#手动备份数据">手动备份数据</a></li><li><a href="./case5.html#自动还原备份">自动还原备份</a></li><li><a href="./case5.html#手动还原备份">手动还原备份</a></li><li><a href="./case5.html#完美搬家">完美搬家</a></li><li><a href="./case5.html#主体目录文件及说明">主体目录文件及说明</a></li><li><a href="./case5.html#鸣谢下列作者的文章和项目">鸣谢下列作者的文章和项目</a></li><li><a href="./case5.html#免责声明">免责声明</a></li></ul><hr><h2 id="项目特点" tabindex="-1">项目特点: <a class="header-anchor" href="#项目特点" aria-label="Permalink to &quot;项目特点:&quot;">​</a></h2><ul><li>适用范围更广 --- 只要能连通网络，就能安装哪吒服务端，如 LXC, OpenVZ VPS，Nas 虚拟机 , Container PaaS 等</li><li>Argo 隧道突破需要公网入口的限制 --- 传统的哪吒需要有两个公网端口，一个用于面板的访问，另一个用于客户端上报数据，本项目借用 Cloudflare Argo 隧道，使用内网穿透的办法</li><li>IPv4 / v6 具备更高的灵活性 --- 传统哪吒需要处理服务端和客户端的 IPv4/v6 兼容性问题，还需要通过 warp 等工具来解决不对应的情况。然而，本项目可以完全不需要考虑这些问题，可以任意对接，更加方便和简便</li><li>一条 Argo 隧道分流多个域名和协议 --- 建立一条内网穿透的 Argo 隧道，即可分流三个域名(hostname)和协议(protocal)，分别用于面板的访问(http)，客户端上报数据(tcp)和 ssh（可选）</li><li>GrpcWebProxy 反向代理的 gRPC 数据端口 --- 配上证书做 tls 终结，然后 Argo 的隧道配置用 https 服务指向这个反向代理，启用http2回源，grpc(nezha)-&gt;GrpcWebProxy-&gt;h2(argo)-&gt;cf cdn edge-&gt;agent</li><li>每天自动备份 --- 北京时间每天 4 时 0 分自动备份整个哪吒面板文件夹到指定的 github 私库，包括面板主题，面板设置，探针数据和隧道信息，备份保留近 5 天数据；鉴于内容十分重要，必须要放在私库</li><li>每天自动更新面板 -- 北京时间每天 4 时 0 分自动检测最新的官方面板版本，有升级时自动更新</li><li>手/自一体还原备份 --- 每分钟检测一次在线还原文件的内容，遇到有更新立刻还原</li><li>默认内置本机探针 --- 能很方便的监控自身服务器信息</li><li>数据更安全 --- Argo 隧道使用TLS加密通信，可以将应用程序流量安全地传输到 Cloudflare 网络，提高了应用程序的安全性和可靠性。此外，Argo Tunnel也可以防止IP泄露和DDoS攻击等网络威胁</li></ul><img width="1609" alt="image" src="https://github.com/fscarmen2/Argo-Nezha-Service-Container/assets/92626977/4893c3cd-5055-468f-8138-6c5460bdd1e4"><h2 id="准备需要用的变量" tabindex="-1">准备需要用的变量 <a class="header-anchor" href="#准备需要用的变量" aria-label="Permalink to &quot;准备需要用的变量&quot;">​</a></h2><ul><li>到 Cloudflare 官网，选择使用的域名，打开 <code>网络</code> 选项将 <code>gRPC</code> 开
Line truncated
 <span class="line"><span>           --name nezha_dashboard \\</span></span>
 <span class="line"><span>           --pull always \\</span></span>
 <span class="line"><span>           --restart always \\</span></span>

assets/case_case5.md.CR61PZ8I.lean.js

@@ -1 +1 @@
-import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1725160726000}'),n={name:"case/case5.md"},r=t("",89),l=[r];function i(o,c,h,p,d,g){return s(),e("div",null,l)}const m=a(n,[["render",i]]);export{u as __pageData,m as default};
+import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1728186808000}'),n={name:"case/case5.md"},r=t("",89),l=[r];function i(o,c,h,p,d,g){return s(),e("div",null,l)}const m=a(n,[["render",i]]);export{u as __pageData,m as default};

assets/case_case6.md.DdQSHal4.js

@@ -1 +1 @@
-import{_ as a,c as e,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const s="/assets/Download_on_the_App_Store_Badge_CNSC_RGB_blk_092917.B6iCCvXs.svg",r="/assets/1.BL34OYdd.png",i="/assets/2.BqfHYLGJ.png",l="/assets/3.D4KlWCds.png",k=JSON.parse('{"title":"Nezha Mobile - Nezha Dashboard 的 iOS 客户端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case6.md","filePath":"case/case6.md","lastUpdated":1725160726000}'),n={name:"case/case6.md"},h=o('<h1 id="nezha-mobile-nezha-dashboard-的-ios-客户端" tabindex="-1">Nezha Mobile - Nezha Dashboard 的 iOS 客户端 <a class="header-anchor" href="#nezha-mobile-nezha-dashboard-的-ios-客户端" aria-label="Permalink to &quot;Nezha Mobile - Nezha Dashboard 的 iOS 客户端&quot;">​</a></h1><p>贡献者：</p><ul><li><a href="https://github.com/hiDandelion" target="_blank" rel="noreferrer">hiDandelion</a></li></ul><h2 id="为项目作出贡献" tabindex="-1">为项目作出贡献 <a class="header-anchor" href="#为项目作出贡献" aria-label="Permalink to &quot;为项目作出贡献&quot;">​</a></h2><p><a href="https://github.com/hiDandelion/Nezha-Mobile" target="_blank" rel="noreferrer">项目地址</a></p><div class="info custom-block"><p class="custom-block-title">INFO</p><p>我们欢迎对项目的任何贡献，并将积极合并你的修改至下一次的Release，但我们可能会对不符合App Review Guidelines的内容（或潜在内容）进行一些修改。</p></div><h2 id="从-app-store-下载" tabindex="-1">从 App Store 下载 <a class="header-anchor" href="#从-app-store-下载" aria-label="Permalink to &quot;从 App Store 下载&quot;">​</a></h2><p><a href="https://apps.apple.com/us/app/nezha-mobile/id6596729064" target="_blank" rel="noreferrer"><img src="'+s+'" alt="Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917"></a></p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>App Store版本的Nezha Mobile由于<strong>ICP备案</strong>原因不在<strong>中国大陆</strong>提供服务。</p></div><h2 id="testflight-测试计划" tabindex="-1">TestFlight 测试计划 <a class="header-anchor" href="#testflight-测试计划" aria-label="Permalink to &quot;TestFlight 测试计划&quot;">​</a></h2><p><a href="https://testflight.apple.com/join/C6vTc2dN" target="_blank" rel="noreferrer">加入 TestFlight 测试</a></p><h2 id="使用说明" tabindex="-1">使用说明 <a class="header-anchor" href="#使用说明" aria-label="Permalink to &quot;使用说明&quot;">​</a></h2><ul><li>首次使用时你需要输入<strong>Dashboard链接</strong>和<strong>API Token</strong>。<strong>Dashboard链接</strong>形如<code>server.hidandelion.com</code>，不要添加协议头和末尾斜杠。<strong>API Token</strong>可通过Dashboard管理后台获取。 <img src="'+r+'" alt="step1" width="200"></li></ul><h2 id="配置小组件-可选" tabindex="-1">配置小组件（可选） <a class="header-anchor" href="#配置小组件-可选" aria-label="Permalink to &quot;配置小组件（可选）&quot;">​</a></h2><ul><li><p>在Springboard添加小组件，长按后点击<strong>编辑小组件</strong>。 <img src="'+i+'" alt="step2" width="200"></p></li><li><p>在随后的页面中选择一台你需要监控的服务器。你可以为多个小组件配置不同的服务器。 <img src="'+l+'" alt="step3" width="200"></p></li></ul>',15),p=[h];function d(c,_,b,g,m,u){return t(),e("div",null,p)}const N=a(n,[["render",d]]);export{k as __pageData,N as default};
+import{_ as a,c as e,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const s="/assets/Download_on_the_App_Store_Badge_CNSC_RGB_blk_092917.B6iCCvXs.svg",r="/assets/1.BL34OYdd.png",i="/assets/2.BqfHYLGJ.png",l="/assets/3.D4KlWCds.png",k=JSON.parse('{"title":"Nezha Mobile - Nezha Dashboard 的 iOS 客户端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case6.md","filePath":"case/case6.md","lastUpdated":1728186808000}'),n={name:"case/case6.md"},h=o('<h1 id="nezha-mobile-nezha-dashboard-的-ios-客户端" tabindex="-1">Nezha Mobile - Nezha Dashboard 的 iOS 客户端 <a class="header-anchor" href="#nezha-mobile-nezha-dashboard-的-ios-客户端" aria-label="Permalink to &quot;Nezha Mobile - Nezha Dashboard 的 iOS 客户端&quot;">​</a></h1><p>贡献者：</p><ul><li><a href="https://github.com/hiDandelion" target="_blank" rel="noreferrer">hiDandelion</a></li></ul><h2 id="为项目作出贡献" tabindex="-1">为项目作出贡献 <a class="header-anchor" href="#为项目作出贡献" aria-label="Permalink to &quot;为项目作出贡献&quot;">​</a></h2><p><a href="https://github.com/hiDandelion/Nezha-Mobile" target="_blank" rel="noreferrer">项目地址</a></p><div class="info custom-block"><p class="custom-block-title">INFO</p><p>我们欢迎对项目的任何贡献，并将积极合并你的修改至下一次的Release，但我们可能会对不符合App Review Guidelines的内容（或潜在内容）进行一些修改。</p></div><h2 id="从-app-store-下载" tabindex="-1">从 App Store 下载 <a class="header-anchor" href="#从-app-store-下载" aria-label="Permalink to &quot;从 App Store 下载&quot;">​</a></h2><p><a href="https://apps.apple.com/us/app/nezha-mobile/id6596729064" target="_blank" rel="noreferrer"><img src="'+s+'" alt="Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917"></a></p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>App Store版本的Nezha Mobile由于<strong>ICP备案</strong>原因不在<strong>中国大陆</strong>提供服务。</p></div><h2 id="testflight-测试计划" tabindex="-1">TestFlight 测试计划 <a class="header-anchor" href="#testflight-测试计划" aria-label="Permalink to &quot;TestFlight 测试计划&quot;">​</a></h2><p><a href="https://testflight.apple.com/join/C6vTc2dN" target="_blank" rel="noreferrer">加入 TestFlight 测试</a></p><h2 id="使用说明" tabindex="-1">使用说明 <a class="header-anchor" href="#使用说明" aria-label="Permalink to &quot;使用说明&quot;">​</a></h2><ul><li>首次使用时你需要输入<strong>Dashboard链接</strong>和<strong>API Token</strong>。<strong>Dashboard链接</strong>形如<code>server.hidandelion.com</code>，不要添加协议头和末尾斜杠。<strong>API Token</strong>可通过Dashboard管理后台获取。 <img src="'+r+'" alt="step1" width="200"></li></ul><h2 id="配置小组件-可选" tabindex="-1">配置小组件（可选） <a class="header-anchor" href="#配置小组件-可选" aria-label="Permalink to &quot;配置小组件（可选）&quot;">​</a></h2><ul><li><p>在Springboard添加小组件，长按后点击<strong>编辑小组件</strong>。 <img src="'+i+'" alt="step2" width="200"></p></li><li><p>在随后的页面中选择一台你需要监控的服务器。你可以为多个小组件配置不同的服务器。 <img src="'+l+'" alt="step3" width="200"></p></li></ul>',15),p=[h];function d(c,_,b,g,m,u){return t(),e("div",null,p)}const N=a(n,[["render",d]]);export{k as __pageData,N as default};

assets/case_case6.md.DdQSHal4.lean.js

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

assets/case_case7.md.DBKz_Vxe.js

@@ -1 +1 @@
-import{_ as e,a}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as r,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Broker for Nezha - 拓展 Nezha 接入平台","description":"","frontmatter":{},"headers":[],"relativePath":"case/case7.md","filePath":"case/case7.md","lastUpdated":1725160726000}'),l={name:"case/case7.md"},h=i('<h1 id="broker-for-nezha-拓展-nezha-接入平台" tabindex="-1">Broker for Nezha - 拓展 Nezha 接入平台 <a class="header-anchor" href="#broker-for-nezha-拓展-nezha-接入平台" aria-label="Permalink to &quot;Broker for Nezha - 拓展 Nezha 接入平台&quot;">​</a></h1><p>贡献者:</p><ul><li><a href="https://github.com/uubulb" target="_blank" rel="noreferrer">uubulb</a></li></ul><p>Broker for Nezha 是一个 Nezha Agent 的修改版本，其通过分离 Agent 的数据收集和 gRPC 上报功能，可使小型设备接入 Nezha Dashboard。</p><p>项目地址：<a href="https://github.com/uubulb/broker" target="_blank" rel="noreferrer">https://github.com/uubulb/broker</a></p><p>文档：<a href="https://broker.kuzu.uk/" target="_blank" rel="noreferrer">Broker for Nezha</a></p><h2 id="与原项目的不同" tabindex="-1">与原项目的不同 <a class="header-anchor" href="#与原项目的不同" aria-label="Permalink to &quot;与原项目的不同&quot;">​</a></h2><ul><li>使用外置数据源，而不是从本地获取。</li><li>多数据源与多面板支持</li><li>仅支持部分任务类型，可参考项目 README 获取详细信息。</li></ul><p>Broker for Nezha 需要与特定的数据收集软件一同使用。目前提供两种数据获取方式：</p><ol><li>HTTP 主动获取（HTTP/1.1）</li><li>TCP 被动获取（推荐，可避免创建额外连接）</li></ol><p>如需获取现有的数据收集软件，可以参考项目 README。</p><p>因数据获取方式缺乏安全性，建议仅在信任的网络环境使用。</p><h2 id="编写数据收集端" tabindex="-1">编写数据收集端 <a class="header-anchor" href="#编写数据收集端" aria-label="Permalink to &quot;编写数据收集端&quot;">​</a></h2><p>如需自行编写数据收集端，除实现基本 HTTP 服务器或 TCP 客户端外，还需要使用特定的数据格式才可被 Broker 正常接收。具体请参考：<a href="https://broker.kuzu.uk/configuration/type/" target="_blank" rel="noreferrer">数据类型</a></p><h2 id="效果参考" tabindex="-1">效果参考 <a class="header-anchor" href="#效果参考" aria-label="Permalink to &quot;效果参考&quot;">​</a></h2><figure><img src="'+e+'" alt="Dashboard"><figcaption style="font-size:0.9em;color:gray;text-align:center;"> Dashboard </figcaption></figure><br><figure><img src="'+a+'" alt="WebSSH"><figcaption style="font-size:0.9em;color:gray;text-align:center;"> WebSSH </figcaption></figure>',18),n=[h];function s(c,u,p,f,_,b){return o(),t("div",null,n)}const m=r(l,[["render",s]]);export{g as __pageData,m as default};
+import{_ as e,a}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as r,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Broker for Nezha - 拓展 Nezha 接入平台","description":"","frontmatter":{},"headers":[],"relativePath":"case/case7.md","filePath":"case/case7.md","lastUpdated":1728186808000}'),l={name:"case/case7.md"},h=i('<h1 id="broker-for-nezha-拓展-nezha-接入平台" tabindex="-1">Broker for Nezha - 拓展 Nezha 接入平台 <a class="header-anchor" href="#broker-for-nezha-拓展-nezha-接入平台" aria-label="Permalink to &quot;Broker for Nezha - 拓展 Nezha 接入平台&quot;">​</a></h1><p>贡献者:</p><ul><li><a href="https://github.com/uubulb" target="_blank" rel="noreferrer">uubulb</a></li></ul><p>Broker for Nezha 是一个 Nezha Agent 的修改版本，其通过分离 Agent 的数据收集和 gRPC 上报功能，可使小型设备接入 Nezha Dashboard。</p><p>项目地址：<a href="https://github.com/uubulb/broker" target="_blank" rel="noreferrer">https://github.com/uubulb/broker</a></p><p>文档：<a href="https://broker.kuzu.uk/" target="_blank" rel="noreferrer">Broker for Nezha</a></p><h2 id="与原项目的不同" tabindex="-1">与原项目的不同 <a class="header-anchor" href="#与原项目的不同" aria-label="Permalink to &quot;与原项目的不同&quot;">​</a></h2><ul><li>使用外置数据源，而不是从本地获取。</li><li>多数据源与多面板支持</li><li>仅支持部分任务类型，可参考项目 README 获取详细信息。</li></ul><p>Broker for Nezha 需要与特定的数据收集软件一同使用。目前提供两种数据获取方式：</p><ol><li>HTTP 主动获取（HTTP/1.1）</li><li>TCP 被动获取（推荐，可避免创建额外连接）</li></ol><p>如需获取现有的数据收集软件，可以参考项目 README。</p><p>因数据获取方式缺乏安全性，建议仅在信任的网络环境使用。</p><h2 id="编写数据收集端" tabindex="-1">编写数据收集端 <a class="header-anchor" href="#编写数据收集端" aria-label="Permalink to &quot;编写数据收集端&quot;">​</a></h2><p>如需自行编写数据收集端，除实现基本 HTTP 服务器或 TCP 客户端外，还需要使用特定的数据格式才可被 Broker 正常接收。具体请参考：<a href="https://broker.kuzu.uk/configuration/type/" target="_blank" rel="noreferrer">数据类型</a></p><h2 id="效果参考" tabindex="-1">效果参考 <a class="header-anchor" href="#效果参考" aria-label="Permalink to &quot;效果参考&quot;">​</a></h2><figure><img src="'+e+'" alt="Dashboard"><figcaption style="font-size:0.9em;color:gray;text-align:center;"> Dashboard </figcaption></figure><br><figure><img src="'+a+'" alt="WebSSH"><figcaption style="font-size:0.9em;color:gray;text-align:center;"> WebSSH </figcaption></figure>',18),n=[h];function s(c,u,p,f,_,b){return o(),t("div",null,n)}const m=r(l,[["render",s]]);export{g as __pageData,m as default};

assets/case_case7.md.DBKz_Vxe.lean.js

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

assets/case_index.md.DSeyDNXF.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":1725160726000}'),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":1728186808000}'),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};

assets/case_index.md.DSeyDNXF.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":1725160726000}'),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":1728186808000}'),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};

assets/developer_index.md.BxHPGI4D.js

@@ -1 +1 @@
-import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request，帮助哪吒监控变得更好！","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1725160726000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return a(),t("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
+import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request，帮助哪吒监控变得更好！","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1728186808000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return a(),t("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};

assets/developer_index.md.BxHPGI4D.lean.js

@@ -1 +1 @@
-import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request，帮助哪吒监控变得更好！","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1725160726000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return a(),t("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
+import{_ as e,c as t,o as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控 - 服务器监控与运维工具","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request，帮助哪吒监控变得更好！","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1728186808000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return a(),t("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};

assets/developer_l10n.md.BXKiVAed.js

@@ -1 +1 @@
-import{_ as e,c as a,o,a4 as l}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"l10n 本地化开发指南","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1725160726000}'),t={name:"developer/l10n.md"},r=l('<h1 id="l10n-本地化开发指南" tabindex="-1">l10n 本地化开发指南 <a class="header-anchor" href="#l10n-本地化开发指南" aria-label="Permalink to &quot;l10n 本地化开发指南&quot;">​</a></h1><p><strong>哪吒监控的 Dashboard 已经添加本地化，支持多个语言，你可以在开发新功能时遵循以下步骤来支持本地化</strong></p><h2 id="介绍" tabindex="-1">介绍 <a class="header-anchor" href="#介绍" aria-label="Permalink to &quot;介绍&quot;">​</a></h2><ol><li>你可以直接使用 <code>/resource/l10n/zh-CN.toml</code> 中已有的文本配置来替换新功能中的文本</li><li>如果新功能中有新增文本，请参考 <code>zh-CN.toml</code> 的配置文本，将新文本拉取到 <code>zh-CN.toml</code> 等其他语言的配置文件中，并添加翻译</li></ol><h2 id="新本地化文本的添加" tabindex="-1">新本地化文本的添加 <a class="header-anchor" href="#新本地化文本的添加" aria-label="Permalink to &quot;新本地化文本的添加&quot;">​</a></h2><ol><li>在 <code>/resource/l10n/</code> 中添加新的语言文本配置</li><li>在新的语言文本配置中拉取其他语言已有的文本配置</li><li>为新的语言文本配置添加翻译</li></ol>',6),n=[r];function d(c,i,s,_,h,p){return o(),a("div",null,n)}const f=e(t,[["render",d]]);export{u as __pageData,f as default};
+import{_ as e,c as a,o,a4 as l}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"l10n 本地化开发指南","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1728186808000}'),t={name:"developer/l10n.md"},r=l('<h1 id="l10n-本地化开发指南" tabindex="-1">l10n 本地化开发指南 <a class="header-anchor" href="#l10n-本地化开发指南" aria-label="Permalink to &quot;l10n 本地化开发指南&quot;">​</a></h1><p><strong>哪吒监控的 Dashboard 已经添加本地化，支持多个语言，你可以在开发新功能时遵循以下步骤来支持本地化</strong></p><h2 id="介绍" tabindex="-1">介绍 <a class="header-anchor" href="#介绍" aria-label="Permalink to &quot;介绍&quot;">​</a></h2><ol><li>你可以直接使用 <code>/resource/l10n/zh-CN.toml</code> 中已有的文本配置来替换新功能中的文本</li><li>如果新功能中有新增文本，请参考 <code>zh-CN.toml</code> 的配置文本，将新文本拉取到 <code>zh-CN.toml</code> 等其他语言的配置文件中，并添加翻译</li></ol><h2 id="新本地化文本的添加" tabindex="-1">新本地化文本的添加 <a class="header-anchor" href="#新本地化文本的添加" aria-label="Permalink to &quot;新本地化文本的添加&quot;">​</a></h2><ol><li>在 <code>/resource/l10n/</code> 中添加新的语言文本配置</li><li>在新的语言文本配置中拉取其他语言已有的文本配置</li><li>为新的语言文本配置添加翻译</li></ol>',6),n=[r];function d(c,i,s,_,h,p){return o(),a("div",null,n)}const f=e(t,[["render",d]]);export{u as __pageData,f as default};

assets/developer_l10n.md.BXKiVAed.lean.js

@@ -1 +1 @@
-import{_ as e,c as a,o,a4 as l}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"l10n 本地化开发指南","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1725160726000}'),t={name:"developer/l10n.md"},r=l("",6),n=[r];function d(c,i,s,_,h,p){return o(),a("div",null,n)}const f=e(t,[["render",d]]);export{u as __pageData,f as default};
+import{_ as e,c as a,o,a4 as l}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"l10n 本地化开发指南","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1728186808000}'),t={name:"developer/l10n.md"},r=l("",6),n=[r];function d(c,i,s,_,h,p){return o(),a("div",null,n)}const f=e(t,[["render",d]]);export{u as __pageData,f as default};

assets/developer_theme.md.CBNDJrhp.js

@@ -1 +1 @@
-import{_ as e,c as a,o,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"哪吒主题开发环境","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1725160726000}'),c={name:"developer/theme.md"},l=t('<h1 id="哪吒主题开发环境" tabindex="-1">哪吒主题开发环境 <a class="header-anchor" href="#哪吒主题开发环境" aria-label="Permalink to &quot;哪吒主题开发环境&quot;">​</a></h1><p>哪吒面板提供了主题开发环境，你可以使用它来创建新的哪吒监控主题</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>请注意： 此开发环境仅支持 <code>dashboard v0.13.16</code> 及更新版本。</p></div><h2 id="使用说明" tabindex="-1">使用说明 <a class="header-anchor" href="#使用说明" aria-label="Permalink to &quot;使用说明&quot;">​</a></h2><ol><li>克隆<a href="https://github.com/nezhahq/skeleton-custom-theme" target="_blank" rel="noreferrer">此仓库</a>到本地</li><li>修改 <code>data/config.yaml</code> 中的 Oauth2 配置（回调连接可以填 <code>http://localhost</code>）</li><li>运行 <code>docker-compose up</code></li><li>开始开发</li><li>主题制作完成之后可以将 <code>theme-custom</code> 放置到服务器上的 <code>/opt/nezha/dashboard/theme-custom</code> 位置</li></ol><h2 id="faq" tabindex="-1">FAQ <a class="header-anchor" href="#faq" aria-label="Permalink to &quot;FAQ&quot;">​</a></h2><ul><li>如果不能使用 <code>80</code> 端口，在 <code>docker-compose.yaml</code> 中修改配置。</li></ul>',7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
+import{_ as e,c as a,o,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"哪吒主题开发环境","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1728186808000}'),c={name:"developer/theme.md"},l=t('<h1 id="哪吒主题开发环境" tabindex="-1">哪吒主题开发环境 <a class="header-anchor" href="#哪吒主题开发环境" aria-label="Permalink to &quot;哪吒主题开发环境&quot;">​</a></h1><p>哪吒面板提供了主题开发环境，你可以使用它来创建新的哪吒监控主题</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>请注意： 此开发环境仅支持 <code>dashboard v0.13.16</code> 及更新版本。</p></div><h2 id="使用说明" tabindex="-1">使用说明 <a class="header-anchor" href="#使用说明" aria-label="Permalink to &quot;使用说明&quot;">​</a></h2><ol><li>克隆<a href="https://github.com/nezhahq/skeleton-custom-theme" target="_blank" rel="noreferrer">此仓库</a>到本地</li><li>修改 <code>data/config.yaml</code> 中的 Oauth2 配置（回调连接可以填 <code>http://localhost</code>）</li><li>运行 <code>docker-compose up</code></li><li>开始开发</li><li>主题制作完成之后可以将 <code>theme-custom</code> 放置到服务器上的 <code>/opt/nezha/dashboard/theme-custom</code> 位置</li></ol><h2 id="faq" tabindex="-1">FAQ <a class="header-anchor" href="#faq" aria-label="Permalink to &quot;FAQ&quot;">​</a></h2><ul><li>如果不能使用 <code>80</code> 端口，在 <code>docker-compose.yaml</code> 中修改配置。</li></ul>',7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};

assets/developer_theme.md.CBNDJrhp.lean.js

@@ -1 +1 @@
-import{_ as e,c as a,o,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"哪吒主题开发环境","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1725160726000}'),c={name:"developer/theme.md"},l=t("",7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};
+import{_ as e,c as a,o,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"哪吒主题开发环境","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1728186808000}'),c={name:"developer/theme.md"},l=t("",7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default};

assets/en_US_case_case1.md.Dh22iL0h.js

@@ -1 +1 @@
-import{_ as e,c as t,o as r,a4 as o}from"./chunks/framework.BmdFiWrL.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1725160726000}'),a={name:"en_US/case/case1.md"},n=o('<h1 id="build-your-own-telegram-bot-to-query-server-information" tabindex="-1">Build your own Telegram bot to query server information <a class="header-anchor" href="#build-your-own-telegram-bot-to-query-server-information" aria-label="Permalink to &quot;Build your own Telegram bot to query server information&quot;">​</a></h1><p>Contributors:</p><ul><li><a href="https://github.com/spiritLHLS" target="_blank" rel="noreferrer">spiritLHLS</a></li><li><a href="https://github.com/Erope/" target="_blank" rel="noreferrer">Erope</a></li></ul><p><strong>Project</strong>: <a href="https://github.com/spiritLHLS/nezha_api_tgbot" target="_blank" rel="noreferrer">nezha_api_tgbot</a> (Chinese)</p><p><strong>Mirror backup, non-real-time update</strong>: <a href="https://github.com/nezhahq/nezha_api_tgbot" target="_blank" rel="noreferrer">nezha_api_tgbot</a> (Chinese)</p><p>The bot can request server status information from the Dashboard through the API, and then send the information to the user.<br> You can build this bot to easily view the current status of a given server without opening the Dashboard.</p>',6),i=[n];function s(h,_,l,u,c,p){return r(),t("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
+import{_ as e,c as t,o as r,a4 as o}from"./chunks/framework.BmdFiWrL.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1728186808000}'),a={name:"en_US/case/case1.md"},n=o('<h1 id="build-your-own-telegram-bot-to-query-server-information" tabindex="-1">Build your own Telegram bot to query server information <a class="header-anchor" href="#build-your-own-telegram-bot-to-query-server-information" aria-label="Permalink to &quot;Build your own Telegram bot to query server information&quot;">​</a></h1><p>Contributors:</p><ul><li><a href="https://github.com/spiritLHLS" target="_blank" rel="noreferrer">spiritLHLS</a></li><li><a href="https://github.com/Erope/" target="_blank" rel="noreferrer">Erope</a></li></ul><p><strong>Project</strong>: <a href="https://github.com/spiritLHLS/nezha_api_tgbot" target="_blank" rel="noreferrer">nezha_api_tgbot</a> (Chinese)</p><p><strong>Mirror backup, non-real-time update</strong>: <a href="https://github.com/nezhahq/nezha_api_tgbot" target="_blank" rel="noreferrer">nezha_api_tgbot</a> (Chinese)</p><p>The bot can request server status information from the Dashboard through the API, and then send the information to the user.<br> You can build this bot to easily view the current status of a given server without opening the Dashboard.</p>',6),i=[n];function s(h,_,l,u,c,p){return r(),t("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};

assets/en_US_case_case1.md.Dh22iL0h.lean.js

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

assets/en_US_case_case2.md.B5ew0MAj.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":1725160726000}'),a={name:"en_US/case/case2.md"},c=s('<h1 id="use-siri-to-run-shortcut-to-check-server-status-in-ios-macos" tabindex="-1">Use Siri to run shortcut to check server status in iOS/MacOS <a class="header-anchor" href="#use-siri-to-run-shortcut-to-check-server-status-in-ios-macos" aria-label="Permalink to &quot;Use Siri to run shortcut to check server status in iOS/MacOS&quot;">​</a></h1><p>Current Version：V1.0 (Chinese)<br> Contributor:</p><ul><li>白歌 <a href="https://github.com/hhhkkk520" target="_blank" rel="noreferrer">hhhkkk520</a></li></ul><h2 id="get-shortcut-command" tabindex="-1">Get shortcut command <a class="header-anchor" href="#get-shortcut-command" aria-label="Permalink to &quot;Get shortcut command&quot;">​</a></h2><p>Scan the following QR code with your iPhone or iPad to get the shortcut<br><br><img src="'+e+'" alt="coode"><br><br><br> MacOS users please visit <a href="https://www.icloud.com/shortcuts/312005bf5ffd4387ac92a84056db9f09" target="_blank" rel="noreferrer">here</a> to get the shortcut</p><h2 id="how-to-use" tabindex="-1">How to use <a class="header-anchor" href="#how-to-use" aria-label="Permalink to &quot;How to use&quot;">​</a></h2><ul><li>After getting the shortcut, open and edit the shortcut</li><li>Fill in <code>Dashboard URL</code>, <code>API Token</code>, <code>Server ID</code> in the three text boxes</li><li>Save the edit and test run, if you can get the result, the setting is correct.</li><li>Modify the name of the shortcut, such as: Server Status, then you can use Siri command: &quot;Hey Siri, Server Status&quot; to get the server status.</li></ul><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>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.</p></div>',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":1728186808000}'),a={name:"en_US/case/case2.md"},c=s('<h1 id="use-siri-to-run-shortcut-to-check-server-status-in-ios-macos" tabindex="-1">Use Siri to run shortcut to check server status in iOS/MacOS <a class="header-anchor" href="#use-siri-to-run-shortcut-to-check-server-status-in-ios-macos" aria-label="Permalink to &quot;Use Siri to run shortcut to check server status in iOS/MacOS&quot;">​</a></h1><p>Current Version：V1.0 (Chinese)<br> Contributor:</p><ul><li>白歌 <a href="https://github.com/hhhkkk520" target="_blank" rel="noreferrer">hhhkkk520</a></li></ul><h2 id="get-shortcut-command" tabindex="-1">Get shortcut command <a class="header-anchor" href="#get-shortcut-command" aria-label="Permalink to &quot;Get shortcut command&quot;">​</a></h2><p>Scan the following QR code with your iPhone or iPad to get the shortcut<br><br><img src="'+e+'" alt="coode"><br><br><br> MacOS users please visit <a href="https://www.icloud.com/shortcuts/312005bf5ffd4387ac92a84056db9f09" target="_blank" rel="noreferrer">here</a> to get the shortcut</p><h2 id="how-to-use" tabindex="-1">How to use <a class="header-anchor" href="#how-to-use" aria-label="Permalink to &quot;How to use&quot;">​</a></h2><ul><li>After getting the shortcut, open and edit the shortcut</li><li>Fill in <code>Dashboard URL</code>, <code>API Token</code>, <code>Server ID</code> in the three text boxes</li><li>Save the edit and test run, if you can get the result, the setting is correct.</li><li>Modify the name of the shortcut, such as: Server Status, then you can use Siri command: &quot;Hey Siri, Server Status&quot; to get the server status.</li></ul><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>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.</p></div>',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};

assets/en_US_case_case2.md.B5ew0MAj.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":1725160726000}'),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":1728186808000}'),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};

assets/en_US_case_case3.md.i5w3qiCe.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":1725160726000}'),d={name:"en_US/case/case3.md"},o=a('<h1 id="build-your-own-server-status-query-telegram-bot" tabindex="-1">Build your own server status query Telegram bot <a class="header-anchor" href="#build-your-own-server-status-query-telegram-bot" aria-label="Permalink to &quot;Build your own server status query Telegram bot&quot;">​</a></h1><p>Contributor:</p><ul><li><a href="https://github.com/tech-fever" target="_blank" rel="noreferrer">tech-fever</a></li></ul><p>GitHub project: <a href="https://github.com/tech-fever/nezha_telegram_bot" target="_blank" rel="noreferrer">nezha_telegram_bot</a>（English is already supported）</p><p>Mirror backup, non-real-time update : <a href="https://github.com/nezhahq/nezha_telegram_bot" target="_blank" rel="noreferrer">nezha_telegram_bot</a>（English is already supported）</p><h2 id="features" tabindex="-1">Features <a class="header-anchor" href="#features" aria-label="Permalink to &quot;Features&quot;">​</a></h2><ul><li>[x] Support Chinese/English multi-language switch</li><li>[x] Support tag statistics (CPU, disk, memory, upstream and downstream speed, traffic statistics, etc.)</li><li>[x] Support real-time refresh of single server data</li><li>[x] Support keyboard interactive query</li><li>[x] Support query by command</li><li>[x] Support adding bot to group, privacy protection of bot replies in group chat</li><li>[x] Support bot messages automatic deletion in group chat within 20 seconds</li><li>[x] Support docker deployment</li></ul><h2 id="commands-list" tabindex="-1">Commands list <a class="header-anchor" href="#commands-list" aria-label="Permalink to &quot;Commands list&quot;">​</a></h2><table tabindex="0"><thead><tr><th>Command</th><th>Description</th><th>Private chat only</th></tr></thead><tbody><tr><td>start</td><td>Getting started with the keyboard main menu</td><td>✔️</td></tr><tr><td>help</td><td>help message</td><td>❌</td></tr><tr><td>add</td><td>Add Nezha monitoring url link and token</td><td>✔️</td></tr><tr><td>url</td><td>Add Nezha monitoring url link</td><td>✔️</td></tr><tr><td>token</td><td>Add Nezha monitoring token</td><td>✔️</td></tr><tr><td>info</td><td>Get saved Nezha monitoring url link and token</td><td>✔️</td></tr><tr><td>delete</td><td>Delete saved Nezha monitoring url link and token</td><td>✔️</td></tr><tr><td>id</td><td>Add an integer id after the command to query the information of a single server (refresh button only available in private chat)</td><td>❌</td></tr><tr><td>all</td><td>Query statistics for all servers</td><td>❌</td></tr><tr><td>search</td><td>Search for keywords in server names (multiple keywords supported, split by spaces)</td><td>❌</td></tr></tbody></table>',9),i=[o];function s(n,l,u,h,c,p){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":1728186808000}'),d={name:"en_US/case/case3.md"},o=a('<h1 id="build-your-own-server-status-query-telegram-bot" tabindex="-1">Build your own server status query Telegram bot <a class="header-anchor" href="#build-your-own-server-status-query-telegram-bot" aria-label="Permalink to &quot;Build your own server status query Telegram bot&quot;">​</a></h1><p>Contributor:</p><ul><li><a href="https://github.com/tech-fever" target="_blank" rel="noreferrer">tech-fever</a></li></ul><p>GitHub project: <a href="https://github.com/tech-fever/nezha_telegram_bot" target="_blank" rel="noreferrer">nezha_telegram_bot</a>（English is already supported）</p><p>Mirror backup, non-real-time update : <a href="https://github.com/nezhahq/nezha_telegram_bot" target="_blank" rel="noreferrer">nezha_telegram_bot</a>（English is already supported）</p><h2 id="features" tabindex="-1">Features <a class="header-anchor" href="#features" aria-label="Permalink to &quot;Features&quot;">​</a></h2><ul><li>[x] Support Chinese/English multi-language switch</li><li>[x] Support tag statistics (CPU, disk, memory, upstream and downstream speed, traffic statistics, etc.)</li><li>[x] Support real-time refresh of single server data</li><li>[x] Support keyboard interactive query</li><li>[x] Support query by command</li><li>[x] Support adding bot to group, privacy protection of bot replies in group chat</li><li>[x] Support bot messages automatic deletion in group chat within 20 seconds</li><li>[x] Support docker deployment</li></ul><h2 id="commands-list" tabindex="-1">Commands list <a class="header-anchor" href="#commands-list" aria-label="Permalink to &quot;Commands list&quot;">​</a></h2><table tabindex="0"><thead><tr><th>Command</th><th>Description</th><th>Private chat only</th></tr></thead><tbody><tr><td>start</td><td>Getting started with the keyboard main menu</td><td>✔️</td></tr><tr><td>help</td><td>help message</td><td>❌</td></tr><tr><td>add</td><td>Add Nezha monitoring url link and token</td><td>✔️</td></tr><tr><td>url</td><td>Add Nezha monitoring url link</td><td>✔️</td></tr><tr><td>token</td><td>Add Nezha monitoring token</td><td>✔️</td></tr><tr><td>info</td><td>Get saved Nezha monitoring url link and token</td><td>✔️</td></tr><tr><td>delete</td><td>Delete saved Nezha monitoring url link and token</td><td>✔️</td></tr><tr><td>id</td><td>Add an integer id after the command to query the information of a single server (refresh button only available in private chat)</td><td>❌</td></tr><tr><td>all</td><td>Query statistics for all servers</td><td>❌</td></tr><tr><td>search</td><td>Search for keywords in server names (multiple keywords supported, split by spaces)</td><td>❌</td></tr></tbody></table>',9),i=[o];function s(n,l,u,h,c,p){return r(),e("div",null,i)}const b=t(d,[["render",s]]);export{_ as __pageData,b as default};

assets/en_US_case_case3.md.i5w3qiCe.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":1725160726000}'),d={name:"en_US/case/case3.md"},o=a("",9),i=[o];function s(n,l,u,h,c,p){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":1728186808000}'),d={name:"en_US/case/case3.md"},o=a("",9),i=[o];function s(n,l,u,h,c,p){return r(),e("div",null,i)}const b=t(d,[["render",s]]);export{_ as __pageData,b as default};

assets/en_US_case_case4.md.BitHPJB9.js

@@ -1 +1 @@
-import{_ as e,c as a,o as t,a4 as r}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1725160726000}'),n={name:"en_US/case/case4.md"},o=r('<h1 id="fake-agent-monitoring-data-cheater" tabindex="-1">Fake-agent, monitoring data cheater <a class="header-anchor" href="#fake-agent-monitoring-data-cheater" aria-label="Permalink to &quot;Fake-agent, monitoring data cheater&quot;">​</a></h1><p>Contributor:</p><ul><li><a href="https://github.com/dysf888" target="_blank" rel="noreferrer">dysf888</a></li></ul><p>GitHub project: <a href="https://github.com/dysf888/fake-nezha-agent" target="_blank" rel="noreferrer">fake-nezha-agent</a>（Chinese）<br> Mirror backup, non-real-time update ：<a href="https://github.com/nezhahq/fake-nezha-agent" target="_blank" rel="noreferrer">fake-nezha-agent</a>（Chinese）</p><p>You can modify the monitoring data uploaded to Dashboard by the Agent<br> Use it for cheating 😈</p>',5),i=[o];function s(c,h,_,d,f,l){return t(),a("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
+import{_ as e,c as a,o as t,a4 as r}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1728186808000}'),n={name:"en_US/case/case4.md"},o=r('<h1 id="fake-agent-monitoring-data-cheater" tabindex="-1">Fake-agent, monitoring data cheater <a class="header-anchor" href="#fake-agent-monitoring-data-cheater" aria-label="Permalink to &quot;Fake-agent, monitoring data cheater&quot;">​</a></h1><p>Contributor:</p><ul><li><a href="https://github.com/dysf888" target="_blank" rel="noreferrer">dysf888</a></li></ul><p>GitHub project: <a href="https://github.com/dysf888/fake-nezha-agent" target="_blank" rel="noreferrer">fake-nezha-agent</a>（Chinese）<br> Mirror backup, non-real-time update ：<a href="https://github.com/nezhahq/fake-nezha-agent" target="_blank" rel="noreferrer">fake-nezha-agent</a>（Chinese）</p><p>You can modify the monitoring data uploaded to Dashboard by the Agent<br> Use it for cheating 😈</p>',5),i=[o];function s(c,h,_,d,f,l){return t(),a("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};

assets/en_US_case_case4.md.BitHPJB9.lean.js

@@ -1 +1 @@
-import{_ as e,c as a,o as t,a4 as r}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1725160726000}'),n={name:"en_US/case/case4.md"},o=r("",5),i=[o];function s(c,h,_,d,f,l){return t(),a("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
+import{_ as e,c as a,o as t,a4 as r}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1728186808000}'),n={name:"en_US/case/case4.md"},o=r("",5),i=[o];function s(c,h,_,d,f,l){return t(),a("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};

assets/en_US_case_case5.md.DGiMAHZr.js

@@ -1,4 +1,4 @@
-import{_ as e,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1725160726000}'),s={name:"en_US/case/case5.md"},o=n(`<h1 id="nezha-server-over-argo-tunnel" tabindex="-1">Nezha server over Argo tunnel <a class="header-anchor" href="#nezha-server-over-argo-tunnel" aria-label="Permalink to &quot;Nezha server over Argo tunnel&quot;">​</a></h1><p>Contributors:</p><ul><li><a href="https://github.com/fscarmen2" target="_blank" rel="noreferrer">fscarmen</a></li></ul><p>GitHub project: <a href="https://github.com/fscarmen2/Argo-Nezha-Service-Container" target="_blank" rel="noreferrer">Argo-Nezha-Service-Container</a></p><p>Mirror backup (not live update): <a href="https://github.com/nezhahq/Argo-Nezha-Service-Container" target="_blank" rel="noreferrer">Argo-Nezha-Service-Container</a></p><hr><h2 id="catalog" tabindex="-1">Catalog <a class="header-anchor" href="#catalog" aria-label="Permalink to &quot;Catalog&quot;">​</a></h2><ul><li><a href="./case5.html#project-features">Project Features</a></li><li><a href="./case5.html#How-to-get-Argo-authentication-json-or-token">How to get Argo authentication: json or token</a></li><li><a href="./case5.html#prepare-variables-to-be-used">Variables to be used</a></li><li><a href="./case5.html#paas-deployment-example">PaaS Deployment Example</a></li><li><a href="./case5.html#vps-deployment-method-1-----docker">VPS Deployment Method 1 --- docker</a></li><li><a href="./case5.html#vps-deployment-method-2-----hosts">VPS Deployment Method 2 --- hosts</a></li><li><a href="./case5.html#client-access">Client Access</a></li><li><a href="./case5.html#ssh-access">SSH Access</a></li><li><a href="./case5.html#manual-backup-data">Manual Backup data</a></li><li><a href="./case5.html#automatically-restore-backups">Auto Restore Backup</a></li><li><a href="./case5.html#manually-restore-the-backup">Manual Restore Backup</a></li><li><a href="./case5.html#migrating-data">Migrating data</a></li><li><a href="./case5.html#main-catalog-files-and-descriptions">Main Directory Files and Descriptions</a></li><li><a href="./case5.html#acknowledgements-for-articles-and-projects-by">Acknowledgment of articles and projects by the following authors</a></li><li><a href="./case5.html#disclaimer">Disclaimer</a></li></ul><hr><h2 id="project-features" tabindex="-1">Project Features. <a class="header-anchor" href="#project-features" aria-label="Permalink to &quot;Project Features.&quot;">​</a></h2><ul><li>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.</li><li>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.</li><li>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!</li><li>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).</li><li>GrpcWebProxy reverse proxy gRPC data port --- with a certificate for tls termination, then Argo&#39;s tunnel configuration with https service pointing to this reverse proxy, enable http2 back to the source, grpc(nezha)-&gt;GrpcWebProxy-&gt;h2(argo)-&gt;cf cdn edge-&gt;agent</li><li>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.</li><li>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.</li><li>Manual/automatic restore backup --- check the content of online restore file once a minute, and restore immediately when there is any update.</li><li>Default built-in local probes --- can easily monitor their own server information</li><li>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.</li></ul
Line truncated
+import{_ as e,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1728186808000}'),s={name:"en_US/case/case5.md"},o=n(`<h1 id="nezha-server-over-argo-tunnel" tabindex="-1">Nezha server over Argo tunnel <a class="header-anchor" href="#nezha-server-over-argo-tunnel" aria-label="Permalink to &quot;Nezha server over Argo tunnel&quot;">​</a></h1><p>Contributors:</p><ul><li><a href="https://github.com/fscarmen2" target="_blank" rel="noreferrer">fscarmen</a></li></ul><p>GitHub project: <a href="https://github.com/fscarmen2/Argo-Nezha-Service-Container" target="_blank" rel="noreferrer">Argo-Nezha-Service-Container</a></p><p>Mirror backup (not live update): <a href="https://github.com/nezhahq/Argo-Nezha-Service-Container" target="_blank" rel="noreferrer">Argo-Nezha-Service-Container</a></p><hr><h2 id="catalog" tabindex="-1">Catalog <a class="header-anchor" href="#catalog" aria-label="Permalink to &quot;Catalog&quot;">​</a></h2><ul><li><a href="./case5.html#project-features">Project Features</a></li><li><a href="./case5.html#How-to-get-Argo-authentication-json-or-token">How to get Argo authentication: json or token</a></li><li><a href="./case5.html#prepare-variables-to-be-used">Variables to be used</a></li><li><a href="./case5.html#paas-deployment-example">PaaS Deployment Example</a></li><li><a href="./case5.html#vps-deployment-method-1-----docker">VPS Deployment Method 1 --- docker</a></li><li><a href="./case5.html#vps-deployment-method-2-----hosts">VPS Deployment Method 2 --- hosts</a></li><li><a href="./case5.html#client-access">Client Access</a></li><li><a href="./case5.html#ssh-access">SSH Access</a></li><li><a href="./case5.html#manual-backup-data">Manual Backup data</a></li><li><a href="./case5.html#automatically-restore-backups">Auto Restore Backup</a></li><li><a href="./case5.html#manually-restore-the-backup">Manual Restore Backup</a></li><li><a href="./case5.html#migrating-data">Migrating data</a></li><li><a href="./case5.html#main-catalog-files-and-descriptions">Main Directory Files and Descriptions</a></li><li><a href="./case5.html#acknowledgements-for-articles-and-projects-by">Acknowledgment of articles and projects by the following authors</a></li><li><a href="./case5.html#disclaimer">Disclaimer</a></li></ul><hr><h2 id="project-features" tabindex="-1">Project Features. <a class="header-anchor" href="#project-features" aria-label="Permalink to &quot;Project Features.&quot;">​</a></h2><ul><li>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.</li><li>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.</li><li>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!</li><li>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).</li><li>GrpcWebProxy reverse proxy gRPC data port --- with a certificate for tls termination, then Argo&#39;s tunnel configuration with https service pointing to this reverse proxy, enable http2 back to the source, grpc(nezha)-&gt;GrpcWebProxy-&gt;h2(argo)-&gt;cf cdn edge-&gt;agent</li><li>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.</li><li>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.</li><li>Manual/automatic restore backup --- check the content of online restore file once a minute, and restore immediately when there is any update.</li><li>Default built-in local probes --- can easily monitor their own server information</li><li>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.</li></ul
Line truncated
 <span class="line"><span>           --name nezha_dashboard \\</span></span>
 <span class="line"><span>           --pull always \\</span></span>
 <span class="line"><span>           --restart always \\</span></span>

assets/en_US_case_case5.md.DGiMAHZr.lean.js

@@ -1 +1 @@
-import{_ as e,c as a,o as t,a4 as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1725160726000}'),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":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1728186808000}'),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};

assets/en_US_case_case6.md.i9Dyurwq.js

@@ -1 +1 @@
-import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917.CVyK0T4N.svg",i="/assets/1_en_US.CE_aSW8N.png",n="/assets/2_en_US.Dm8rLo_N.png",s="/assets/3_en_US.SUOW4yEM.png",k=JSON.parse('{"title":"Nezha Mobile - An iOS Client For Nezha Dashboard","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case6.md","filePath":"en_US/case/case6.md","lastUpdated":1725160726000}'),l={name:"en_US/case/case6.md"},h=a('<h1 id="nezha-mobile-an-ios-client-for-nezha-dashboard" tabindex="-1">Nezha Mobile - An iOS Client For Nezha Dashboard <a class="header-anchor" href="#nezha-mobile-an-ios-client-for-nezha-dashboard" aria-label="Permalink to &quot;Nezha Mobile - An iOS Client For Nezha Dashboard&quot;">​</a></h1><p>Contributor:</p><ul><li><a href="https://github.com/hiDandelion" target="_blank" rel="noreferrer">hiDandelion</a></li></ul><h2 id="contribute-to-the-project" tabindex="-1">Contribute to the project <a class="header-anchor" href="#contribute-to-the-project" aria-label="Permalink to &quot;Contribute to the project&quot;">​</a></h2><p><a href="https://github.com/hiDandelion/Nezha-Mobile" target="_blank" rel="noreferrer">Project Link</a></p><div class="info custom-block"><p class="custom-block-title">INFO</p><p>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.</p></div><h2 id="download-on-the-app-store" tabindex="-1">Download on the App Store <a class="header-anchor" href="#download-on-the-app-store" aria-label="Permalink to &quot;Download on the App Store&quot;">​</a></h2><p><a href="https://apps.apple.com/us/app/nezha-mobile/id6596729064" target="_blank" rel="noreferrer"><img src="'+r+'" alt="Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917"></a></p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Due to <strong>ICP Filing Policy</strong>, Nezha Mobile is not available in <strong>China mainland</strong>.</p></div><h2 id="testflight-testing-program" tabindex="-1">TestFlight Testing Program <a class="header-anchor" href="#testflight-testing-program" aria-label="Permalink to &quot;TestFlight Testing Program&quot;">​</a></h2><p><a href="https://testflight.apple.com/join/C6vTc2dN" target="_blank" rel="noreferrer">Join TestFlight Testing</a></p><h2 id="instructions" tabindex="-1">Instructions <a class="header-anchor" href="#instructions" aria-label="Permalink to &quot;Instructions&quot;">​</a></h2><ul><li>Enter your Dashboard link like <code>server.hidandelion.com</code> and API token on your first use. Do not add a protocol prefix or a trailing slash to the link. API Token can be retrieved from Admin Center of Dashboard. <img src="'+i+'" alt="step1" width="200"></li></ul><h2 id="configure-widget-optional" tabindex="-1">Configure Widget(Optional) <a class="header-anchor" href="#configure-widget-optional" aria-label="Permalink to &quot;Configure Widget(Optional)&quot;">​</a></h2><ul><li><p>Add a widget on your Springboard. Long-tap the widget and then tap <strong>Edit Widget</strong>. <img src="'+n+'" alt="step2" width="200"></p></li><li><p>Choose a server you want to monitor on the next view. You can choose different servers for each widget. <img src="'+s+'" alt="step3" width="200"></p></li></ul>',15),c=[h];function d(p,_,g,u,m,b){return o(),t("div",null,c)}const w=e(l,[["render",d]]);export{k as __pageData,w as default};
+import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const r="/assets/Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917.CVyK0T4N.svg",i="/assets/1_en_US.CE_aSW8N.png",n="/assets/2_en_US.Dm8rLo_N.png",s="/assets/3_en_US.SUOW4yEM.png",k=JSON.parse('{"title":"Nezha Mobile - An iOS Client For Nezha Dashboard","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case6.md","filePath":"en_US/case/case6.md","lastUpdated":1728186808000}'),l={name:"en_US/case/case6.md"},h=a('<h1 id="nezha-mobile-an-ios-client-for-nezha-dashboard" tabindex="-1">Nezha Mobile - An iOS Client For Nezha Dashboard <a class="header-anchor" href="#nezha-mobile-an-ios-client-for-nezha-dashboard" aria-label="Permalink to &quot;Nezha Mobile - An iOS Client For Nezha Dashboard&quot;">​</a></h1><p>Contributor:</p><ul><li><a href="https://github.com/hiDandelion" target="_blank" rel="noreferrer">hiDandelion</a></li></ul><h2 id="contribute-to-the-project" tabindex="-1">Contribute to the project <a class="header-anchor" href="#contribute-to-the-project" aria-label="Permalink to &quot;Contribute to the project&quot;">​</a></h2><p><a href="https://github.com/hiDandelion/Nezha-Mobile" target="_blank" rel="noreferrer">Project Link</a></p><div class="info custom-block"><p class="custom-block-title">INFO</p><p>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.</p></div><h2 id="download-on-the-app-store" tabindex="-1">Download on the App Store <a class="header-anchor" href="#download-on-the-app-store" aria-label="Permalink to &quot;Download on the App Store&quot;">​</a></h2><p><a href="https://apps.apple.com/us/app/nezha-mobile/id6596729064" target="_blank" rel="noreferrer"><img src="'+r+'" alt="Download_on_the_App_Store_Badge_US-UK_RGB_blk_092917"></a></p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Due to <strong>ICP Filing Policy</strong>, Nezha Mobile is not available in <strong>China mainland</strong>.</p></div><h2 id="testflight-testing-program" tabindex="-1">TestFlight Testing Program <a class="header-anchor" href="#testflight-testing-program" aria-label="Permalink to &quot;TestFlight Testing Program&quot;">​</a></h2><p><a href="https://testflight.apple.com/join/C6vTc2dN" target="_blank" rel="noreferrer">Join TestFlight Testing</a></p><h2 id="instructions" tabindex="-1">Instructions <a class="header-anchor" href="#instructions" aria-label="Permalink to &quot;Instructions&quot;">​</a></h2><ul><li>Enter your Dashboard link like <code>server.hidandelion.com</code> and API token on your first use. Do not add a protocol prefix or a trailing slash to the link. API Token can be retrieved from Admin Center of Dashboard. <img src="'+i+'" alt="step1" width="200"></li></ul><h2 id="configure-widget-optional" tabindex="-1">Configure Widget(Optional) <a class="header-anchor" href="#configure-widget-optional" aria-label="Permalink to &quot;Configure Widget(Optional)&quot;">​</a></h2><ul><li><p>Add a widget on your Springboard. Long-tap the widget and then tap <strong>Edit Widget</strong>. <img src="'+n+'" alt="step2" width="200"></p></li><li><p>Choose a server you want to monitor on the next view. You can choose different servers for each widget. <img src="'+s+'" alt="step3" width="200"></p></li></ul>',15),c=[h];function d(p,_,g,u,m,b){return o(),t("div",null,c)}const w=e(l,[["render",d]]);export{k as __pageData,w as default};

assets/en_US_case_case6.md.i9Dyurwq.lean.js

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

assets/en_US_case_case7.md.COy08vvv.js

@@ -1 +1 @@
-import{_ as e,a}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as r,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Broker for Nezha - Advancing on more platforms","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case7.md","filePath":"en_US/case/case7.md","lastUpdated":1725160726000}'),i={name:"en_US/case/case7.md"},l=n('<h1 id="broker-for-nezha-advancing-on-more-platforms" tabindex="-1">Broker for Nezha - Advancing on more platforms <a class="header-anchor" href="#broker-for-nezha-advancing-on-more-platforms" aria-label="Permalink to &quot;Broker for Nezha - Advancing on more platforms&quot;">​</a></h1><p>Contributor:</p><ul><li><a href="https://github.com/uubulb" target="_blank" rel="noreferrer">uubulb</a></li></ul><p>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.</p><p>Project link: <a href="https://github.com/uubulb/broker" target="_blank" rel="noreferrer">https://github.com/uubulb/broker</a></p><p>Online Documentation: <a href="https://broker.kuzu.uk/" target="_blank" rel="noreferrer">Broker for Nezha</a></p><h2 id="difference-from-nezha-agent" tabindex="-1">Difference from Nezha Agent <a class="header-anchor" href="#difference-from-nezha-agent" aria-label="Permalink to &quot;Difference from Nezha Agent&quot;">​</a></h2><ul><li>Utilizes external data sources to report to <strong>Nezha Dashboard</strong>.</li><li>Supports configuring multiple sources and connecting to multiple Dashboards.</li><li>Only has limited task support. For details, view the project README.</li></ul><p>Broker for Nezha needs to be used with specific data collection software. Currently, it provides two data collection methods:</p><ol><li>HTTP (HTTP/1.1) - Active polling</li><li>TCP - Passive collection (recommended to avoid creating redundant connections)</li></ol><p>For existing data collection software, refer to the project README. Due to security concerns, it&#39;s recommended to use this only in a trusted network.</p><h2 id="writing-a-data-collector" tabindex="-1">Writing a Data Collector <a class="header-anchor" href="#writing-a-data-collector" aria-label="Permalink to &quot;Writing a Data Collector&quot;">​</a></h2><p>If you need to write your own data collector, you&#39;ll need to implement a basic HTTP server or TCP client and use a specific data format that Broker can recognize. For details, see: <a href="https://broker.kuzu.uk/en/configuration/type/" target="_blank" rel="noreferrer">Data types</a></p><h2 id="examples" tabindex="-1">Examples <a class="header-anchor" href="#examples" aria-label="Permalink to &quot;Examples&quot;">​</a></h2><figure><img src="'+e+'" alt="Dashboard"><figcaption style="font-size:0.9em;color:gray;text-align:center;"> Dashboard </figcaption></figure><br><figure><img src="'+a+'" alt="WebSSH"><figcaption style="font-size:0.9em;color:gray;text-align:center;"> WebSSH </figcaption></figure>',17),s=[l];function c(d,f,h,p,u,m){return o(),t("div",null,s)}const k=r(i,[["render",c]]);export{_ as __pageData,k as default};
+import{_ as e,a}from"./chunks/webssh.Cvv4PsOJ.js";import{_ as r,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Broker for Nezha - Advancing on more platforms","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case7.md","filePath":"en_US/case/case7.md","lastUpdated":1728186808000}'),i={name:"en_US/case/case7.md"},l=n('<h1 id="broker-for-nezha-advancing-on-more-platforms" tabindex="-1">Broker for Nezha - Advancing on more platforms <a class="header-anchor" href="#broker-for-nezha-advancing-on-more-platforms" aria-label="Permalink to &quot;Broker for Nezha - Advancing on more platforms&quot;">​</a></h1><p>Contributor:</p><ul><li><a href="https://github.com/uubulb" target="_blank" rel="noreferrer">uubulb</a></li></ul><p>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.</p><p>Project link: <a href="https://github.com/uubulb/broker" target="_blank" rel="noreferrer">https://github.com/uubulb/broker</a></p><p>Online Documentation: <a href="https://broker.kuzu.uk/" target="_blank" rel="noreferrer">Broker for Nezha</a></p><h2 id="difference-from-nezha-agent" tabindex="-1">Difference from Nezha Agent <a class="header-anchor" href="#difference-from-nezha-agent" aria-label="Permalink to &quot;Difference from Nezha Agent&quot;">​</a></h2><ul><li>Utilizes external data sources to report to <strong>Nezha Dashboard</strong>.</li><li>Supports configuring multiple sources and connecting to multiple Dashboards.</li><li>Only has limited task support. For details, view the project README.</li></ul><p>Broker for Nezha needs to be used with specific data collection software. Currently, it provides two data collection methods:</p><ol><li>HTTP (HTTP/1.1) - Active polling</li><li>TCP - Passive collection (recommended to avoid creating redundant connections)</li></ol><p>For existing data collection software, refer to the project README. Due to security concerns, it&#39;s recommended to use this only in a trusted network.</p><h2 id="writing-a-data-collector" tabindex="-1">Writing a Data Collector <a class="header-anchor" href="#writing-a-data-collector" aria-label="Permalink to &quot;Writing a Data Collector&quot;">​</a></h2><p>If you need to write your own data collector, you&#39;ll need to implement a basic HTTP server or TCP client and use a specific data format that Broker can recognize. For details, see: <a href="https://broker.kuzu.uk/en/configuration/type/" target="_blank" rel="noreferrer">Data types</a></p><h2 id="examples" tabindex="-1">Examples <a class="header-anchor" href="#examples" aria-label="Permalink to &quot;Examples&quot;">​</a></h2><figure><img src="'+e+'" alt="Dashboard"><figcaption style="font-size:0.9em;color:gray;text-align:center;"> Dashboard </figcaption></figure><br><figure><img src="'+a+'" alt="WebSSH"><figcaption style="font-size:0.9em;color:gray;text-align:center;"> WebSSH </figcaption></figure>',17),s=[l];function c(d,f,h,p,u,m){return o(),t("div",null,s)}const k=r(i,[["render",c]]);export{_ as __pageData,k as default};

assets/en_US_case_case7.md.COy08vvv.lean.js

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

assets/en_US_case_index.md.BQhUGfPN.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":1725160726000}'),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":1728186808000}'),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};

assets/en_US_case_index.md.BQhUGfPN.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":1725160726000}'),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":1728186808000}'),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};

assets/en_US_developer_index.md.CKNI60FK.js

@@ -1 +1 @@
-import{_ as e,c as t,o as n}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1725160726000}'),a={name:"en_US/developer/index.md"};function o(r,i,l,m,s,p){return n(),t("div")}const _=e(a,[["render",o]]);export{c as __pageData,_ as default};
+import{_ as e,c as t,o as n}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1728186808000}'),a={name:"en_US/developer/index.md"};function o(r,i,l,m,s,p){return n(),t("div")}const _=e(a,[["render",o]]);export{c as __pageData,_ as default};

assets/en_US_developer_index.md.CKNI60FK.lean.js

@@ -1 +1 @@
-import{_ as e,c as t,o as n}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1725160726000}'),a={name:"en_US/developer/index.md"};function o(r,i,l,m,s,p){return n(),t("div")}const _=e(a,[["render",o]]);export{c as __pageData,_ as default};
+import{_ as e,c as t,o as n}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1728186808000}'),a={name:"en_US/developer/index.md"};function o(r,i,l,m,s,p){return n(),t("div")}const _=e(a,[["render",o]]);export{c as __pageData,_ as default};

assets/en_US_developer_l10n.md.B4KyXnVw.js

@@ -1 +1 @@
-import{_ as e,c as t,o as a,a4 as o}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Localization","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1725160726000}'),n={name:"en_US/developer/l10n.md"},i=o('<h1 id="localization" tabindex="-1">Localization <a class="header-anchor" href="#localization" aria-label="Permalink to &quot;Localization&quot;">​</a></h1><p><strong>Nezha Monitoring&#39;s Dashboard has added localization to support multiple languages, and you can follow these steps to support localization when developing new features</strong></p><h2 id="introduction" tabindex="-1">Introduction <a class="header-anchor" href="#introduction" aria-label="Permalink to &quot;Introduction&quot;">​</a></h2><ol><li>You can directly use the text configuration already available in <code>/resource/l10n/en-US.toml</code> to replace the text in the new feature.</li><li>If there is new text in the new feature, please refer to the configuration text in <code>en-US.toml</code>, pull the new text into the configuration files of other languages such as <code>en-US.toml</code>, and add translations.</li></ol><h2 id="adding-a-new-localized-text-file" tabindex="-1">Adding a new localized text file <a class="header-anchor" href="#adding-a-new-localized-text-file" aria-label="Permalink to &quot;Adding a new localized text file&quot;">​</a></h2><ol><li>Add a new language text configuration in <code>/resource/l10n/</code>.</li><li>Pull existing text configurations from other languages in the new language text configuration.</li><li>Add translations for the new language text configuration.</li></ol>',6),l=[i];function r(d,c,s,u,h,f){return a(),t("div",null,l)}const p=e(n,[["render",r]]);export{g as __pageData,p as default};
+import{_ as e,c as t,o as a,a4 as o}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Localization","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1728186808000}'),n={name:"en_US/developer/l10n.md"},i=o('<h1 id="localization" tabindex="-1">Localization <a class="header-anchor" href="#localization" aria-label="Permalink to &quot;Localization&quot;">​</a></h1><p><strong>Nezha Monitoring&#39;s Dashboard has added localization to support multiple languages, and you can follow these steps to support localization when developing new features</strong></p><h2 id="introduction" tabindex="-1">Introduction <a class="header-anchor" href="#introduction" aria-label="Permalink to &quot;Introduction&quot;">​</a></h2><ol><li>You can directly use the text configuration already available in <code>/resource/l10n/en-US.toml</code> to replace the text in the new feature.</li><li>If there is new text in the new feature, please refer to the configuration text in <code>en-US.toml</code>, pull the new text into the configuration files of other languages such as <code>en-US.toml</code>, and add translations.</li></ol><h2 id="adding-a-new-localized-text-file" tabindex="-1">Adding a new localized text file <a class="header-anchor" href="#adding-a-new-localized-text-file" aria-label="Permalink to &quot;Adding a new localized text file&quot;">​</a></h2><ol><li>Add a new language text configuration in <code>/resource/l10n/</code>.</li><li>Pull existing text configurations from other languages in the new language text configuration.</li><li>Add translations for the new language text configuration.</li></ol>',6),l=[i];function r(d,c,s,u,h,f){return a(),t("div",null,l)}const p=e(n,[["render",r]]);export{g as __pageData,p as default};

assets/en_US_developer_l10n.md.B4KyXnVw.lean.js

@@ -1 +1 @@
-import{_ as e,c as t,o as a,a4 as o}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Localization","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1725160726000}'),n={name:"en_US/developer/l10n.md"},i=o("",6),l=[i];function r(d,c,s,u,h,f){return a(),t("div",null,l)}const p=e(n,[["render",r]]);export{g as __pageData,p as default};
+import{_ as e,c as t,o as a,a4 as o}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Localization","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1728186808000}'),n={name:"en_US/developer/l10n.md"},i=o("",6),l=[i];function r(d,c,s,u,h,f){return a(),t("div",null,l)}const p=e(n,[["render",r]]);export{g as __pageData,p as default};

assets/en_US_developer_theme.md.BTp8bKqD.js

@@ -1 +1 @@
-import{_ as e,c as o,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Nezha Theme Development Environment","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1725160726000}'),n={name:"en_US/developer/theme.md"},c=a('<h1 id="nezha-theme-development-environment" tabindex="-1">Nezha Theme Development Environment <a class="header-anchor" href="#nezha-theme-development-environment" aria-label="Permalink to &quot;Nezha Theme Development Environment&quot;">​</a></h1><p>Nezha Monitoring provides a theme development environment that you can use to create new Nezha Monitoring themes</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Please note: This development environment only supports <code>dashboard v0.13.16</code> and newer versions.</p></div><h2 id="how-to-use" tabindex="-1">How to use <a class="header-anchor" href="#how-to-use" aria-label="Permalink to &quot;How to use&quot;">​</a></h2><ol><li>Clone <a href="https://github.com/nezhahq/skeleton-custom-theme" target="_blank" rel="noreferrer">this repository</a> to local</li><li>Modify the Oauth2 configuration in <code>data/config.yaml</code>（The callback connection can be filled with <code>http://localhost</code>）</li><li>Run <code>docker-compose up</code></li><li>Start development</li><li>Once the theme has been created, you can place <code>theme-custom</code> in <code>/opt/nezha/dashboard/theme-custom</code> on the server</li></ol><h2 id="faq" tabindex="-1">FAQ <a class="header-anchor" href="#faq" aria-label="Permalink to &quot;FAQ&quot;">​</a></h2><ul><li>If you can&#39;t use port <code>80</code>, change the configuration in <code>docker-compose.yaml</code>.</li></ul>',7),r=[c];function l(i,h,d,s,m,p){return t(),o("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
+import{_ as e,c as o,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Nezha Theme Development Environment","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1728186808000}'),n={name:"en_US/developer/theme.md"},c=a('<h1 id="nezha-theme-development-environment" tabindex="-1">Nezha Theme Development Environment <a class="header-anchor" href="#nezha-theme-development-environment" aria-label="Permalink to &quot;Nezha Theme Development Environment&quot;">​</a></h1><p>Nezha Monitoring provides a theme development environment that you can use to create new Nezha Monitoring themes</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Please note: This development environment only supports <code>dashboard v0.13.16</code> and newer versions.</p></div><h2 id="how-to-use" tabindex="-1">How to use <a class="header-anchor" href="#how-to-use" aria-label="Permalink to &quot;How to use&quot;">​</a></h2><ol><li>Clone <a href="https://github.com/nezhahq/skeleton-custom-theme" target="_blank" rel="noreferrer">this repository</a> to local</li><li>Modify the Oauth2 configuration in <code>data/config.yaml</code>（The callback connection can be filled with <code>http://localhost</code>）</li><li>Run <code>docker-compose up</code></li><li>Start development</li><li>Once the theme has been created, you can place <code>theme-custom</code> in <code>/opt/nezha/dashboard/theme-custom</code> on the server</li></ol><h2 id="faq" tabindex="-1">FAQ <a class="header-anchor" href="#faq" aria-label="Permalink to &quot;FAQ&quot;">​</a></h2><ul><li>If you can&#39;t use port <code>80</code>, change the configuration in <code>docker-compose.yaml</code>.</li></ul>',7),r=[c];function l(i,h,d,s,m,p){return t(),o("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};

assets/en_US_developer_theme.md.BTp8bKqD.lean.js

@@ -1 +1 @@
-import{_ as e,c as o,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Nezha Theme Development Environment","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1725160726000}'),n={name:"en_US/developer/theme.md"},c=a("",7),r=[c];function l(i,h,d,s,m,p){return t(),o("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
+import{_ as e,c as o,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const _=JSON.parse('{"title":"Nezha Theme Development Environment","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1728186808000}'),n={name:"en_US/developer/theme.md"},c=a("",7),r=[c];function l(i,h,d,s,m,p){return t(),o("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};

assets/en_US_guide_agent.md.eLGrY1b1.js

@@ -1,4 +1,4 @@
-import{_ as s,c as i,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"Install Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1725160726000}'),n={name:"en_US/guide/agent.md"},t=e(`<h1 id="install-agent" tabindex="-1">Install Agent <a class="header-anchor" href="#install-agent" aria-label="Permalink to &quot;Install Agent&quot;">​</a></h1><p><strong>This document will introduce how to install the Agent on the monitored server and connect it to the Dashboard.</strong></p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>The repository for Agent binaries can be found at: <a href="https://github.com/nezhahq/agent/releases" target="_blank" rel="noreferrer">https://github.com/nezhahq/agent/releases</a></p></div><h2 id="one-click-installation-of-the-agent" tabindex="-1">One-Click Installation of the Agent <a class="header-anchor" href="#one-click-installation-of-the-agent" aria-label="Permalink to &quot;One-Click Installation of the Agent&quot;">​</a></h2><p>Nezha Monitoring supports one-click installation of the Agent on both Windows and Linux. By following the steps in this document, you can easily deploy it on your server.</p><h3 id="preparation" tabindex="-1">Preparation <a class="header-anchor" href="#preparation" aria-label="Permalink to &quot;Preparation&quot;">​</a></h3><p>You need to set up a communication domain in the admin panel in advance, and this domain should not be connected to a CDN. This document uses the example communication domain “data.example.com”.<br> Go to the settings page in the admin panel, fill in the communication domain in the “Non-CDN Dashboard Server Domain/IP” field, and click &quot;Save&quot;.</p><h3 id="one-click-installation-on-linux" tabindex="-1">One-Click Installation on Linux <a class="header-anchor" href="#one-click-installation-on-linux" aria-label="Permalink to &quot;One-Click Installation on Linux&quot;">​</a></h3><ol><li>First, add a server in the admin panel.</li><li>Click the green Linux icon button next to the newly added server and copy the one-click installation command.</li><li>Run the copied installation command on the monitored server, and wait for the installation to complete. Then, check if the server is online in the Dashboard home page.</li></ol><h3 id="one-click-installation-on-macos" tabindex="-1">One-Click Installation on macOS <a class="header-anchor" href="#one-click-installation-on-macos" aria-label="Permalink to &quot;One-Click Installation on macOS&quot;">​</a></h3><ol><li>First, add a server in the admin panel.</li><li>Click the green Apple icon button next to the newly added server and copy the one-click installation command.</li><li>Run the copied installation command on the monitored server, and wait for the installation to complete. Then, check if the server is online in the Dashboard home page.</li></ol><h3 id="one-click-installation-on-windows" tabindex="-1">One-Click Installation on Windows <a class="header-anchor" href="#one-click-installation-on-windows" aria-label="Permalink to &quot;One-Click Installation on Windows&quot;">​</a></h3><ol><li>First, add a server in the admin panel.</li><li>Click the green Windows icon button next to the newly added server and copy the one-click installation command.</li><li>Go to the Windows server, run PowerShell, and execute the copied installation command in PowerShell.</li><li>If you encounter a prompt to &quot;change execution policy,&quot; choose Y.</li><li>Wait for the installation to complete, then check if the server is online in the Dashboard home page.</li></ol><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>If you encounter errors when running the one-click installation command in PowerShell, try the <strong>Manual Installation of the Agent on Windows</strong> below.</p></div><h2 id="other-ways-to-install-the-agent" tabindex="-1">Other Ways to Install the Agent <a class="header-anchor" href="#other-ways-to-install-the-agent" aria-label="Permalink to &quot;Other Ways to Install the Agent&quot;">​</a></h2><h3 id="installing-the-agent-on-linux-support-most-distros" tabindex="-1">Installing the Agent on Linux (Support most distros) <a class="header-anchor" href="#installing-the-agent-on-linux-support-most-distros" aria-label="Permalink to &quot;Installing the Agent on Linux (Support most distros)&quot;">​</a></h3><details><summary>Click to expand/collapse</summary><ol><li>First, add a server in the admin panel.</li><li>Run the script on the monitored server:</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#0
Line truncated
+import{_ as s,c as i,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"Install Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1728186808000}'),n={name:"en_US/guide/agent.md"},t=e(`<h1 id="install-agent" tabindex="-1">Install Agent <a class="header-anchor" href="#install-agent" aria-label="Permalink to &quot;Install Agent&quot;">​</a></h1><p><strong>This document will introduce how to install the Agent on the monitored server and connect it to the Dashboard.</strong></p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>The repository for Agent binaries can be found at: <a href="https://github.com/nezhahq/agent/releases" target="_blank" rel="noreferrer">https://github.com/nezhahq/agent/releases</a></p></div><h2 id="one-click-installation-of-the-agent" tabindex="-1">One-Click Installation of the Agent <a class="header-anchor" href="#one-click-installation-of-the-agent" aria-label="Permalink to &quot;One-Click Installation of the Agent&quot;">​</a></h2><p>Nezha Monitoring supports one-click installation of the Agent on both Windows and Linux. By following the steps in this document, you can easily deploy it on your server.</p><h3 id="preparation" tabindex="-1">Preparation <a class="header-anchor" href="#preparation" aria-label="Permalink to &quot;Preparation&quot;">​</a></h3><p>You need to set up a communication domain in the admin panel in advance, and this domain should not be connected to a CDN. This document uses the example communication domain “data.example.com”.<br> Go to the settings page in the admin panel, fill in the communication domain in the “Non-CDN Dashboard Server Domain/IP” field, and click &quot;Save&quot;.</p><h3 id="one-click-installation-on-linux" tabindex="-1">One-Click Installation on Linux <a class="header-anchor" href="#one-click-installation-on-linux" aria-label="Permalink to &quot;One-Click Installation on Linux&quot;">​</a></h3><ol><li>First, add a server in the admin panel.</li><li>Click the green Linux icon button next to the newly added server and copy the one-click installation command.</li><li>Run the copied installation command on the monitored server, and wait for the installation to complete. Then, check if the server is online in the Dashboard home page.</li></ol><h3 id="one-click-installation-on-macos" tabindex="-1">One-Click Installation on macOS <a class="header-anchor" href="#one-click-installation-on-macos" aria-label="Permalink to &quot;One-Click Installation on macOS&quot;">​</a></h3><ol><li>First, add a server in the admin panel.</li><li>Click the green Apple icon button next to the newly added server and copy the one-click installation command.</li><li>Run the copied installation command on the monitored server, and wait for the installation to complete. Then, check if the server is online in the Dashboard home page.</li></ol><h3 id="one-click-installation-on-windows" tabindex="-1">One-Click Installation on Windows <a class="header-anchor" href="#one-click-installation-on-windows" aria-label="Permalink to &quot;One-Click Installation on Windows&quot;">​</a></h3><ol><li>First, add a server in the admin panel.</li><li>Click the green Windows icon button next to the newly added server and copy the one-click installation command.</li><li>Go to the Windows server, run PowerShell, and execute the copied installation command in PowerShell.</li><li>If you encounter a prompt to &quot;change execution policy,&quot; choose Y.</li><li>Wait for the installation to complete, then check if the server is online in the Dashboard home page.</li></ol><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>If you encounter errors when running the one-click installation command in PowerShell, try the <strong>Manual Installation of the Agent on Windows</strong> below.</p></div><h2 id="other-ways-to-install-the-agent" tabindex="-1">Other Ways to Install the Agent <a class="header-anchor" href="#other-ways-to-install-the-agent" aria-label="Permalink to &quot;Other Ways to Install the Agent&quot;">​</a></h2><h3 id="installing-the-agent-on-linux-support-most-distros" tabindex="-1">Installing the Agent on Linux (Support most distros) <a class="header-anchor" href="#installing-the-agent-on-linux-support-most-distros" aria-label="Permalink to &quot;Installing the Agent on Linux (Support most distros)&quot;">​</a></h3><details><summary>Click to expand/collapse</summary><ol><li>First, add a server in the admin panel.</li><li>Run the script on the monitored server:</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#0
Line truncated
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">exec</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> 2&gt;&amp;1</span></span>
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">exec</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> /opt/nezha/agent/nezha-agent</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -s</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> server_name:port</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -p</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> password</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> 2&gt;&amp;1</span></span></code></pre></div><p>You can add other arguments here as well.</p><ol start="3"><li>Create logging service file <code>/etc/sv/nezha-agent/log/run</code>:</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">#!/bin/sh</span></span>
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">exec</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> vlogger</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -t</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> nezha-agent</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -p</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> daemon</span></span></code></pre></div><ol start="4"><li>Enable the service:</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">sudo</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> ln</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -s</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> /etc/sv/nezha-agent/</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> /var/service</span></span></code></pre></div><p>Use the <code>sv</code> command to manage the service.</p><p>How to view logs:</p><ol><li>Install <code>socklog</code> and enable it:</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">sudo</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> xbps-install</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -S</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> socklog-void</span></span>

assets/en_US_guide_agent.md.eLGrY1b1.lean.js

@@ -1 +1 @@
-import{_ as s,c as i,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"Install Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1725160726000}'),n={name:"en_US/guide/agent.md"},t=e("",31),l=[t];function h(p,o,r,k,d,c){return a(),i("div",null,l)}const u=s(n,[["render",h]]);export{F as __pageData,u as default};
+import{_ as s,c as i,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"Install Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1728186808000}'),n={name:"en_US/guide/agent.md"},t=e("",31),l=[t];function h(p,o,r,k,d,c){return a(),i("div",null,l)}const u=s(n,[["render",h]]);export{F as __pageData,u as default};

assets/en_US_guide_agentq.md.XAZgZFB0.js

@@ -1 +1 @@
-import{_ as e,c as t,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const f=JSON.parse('{"title":"Frequently Asked Questions about the Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1725160726000}'),i={name:"en_US/guide/agentq.md"},s=n('<h1 id="frequently-asked-questions-about-the-agent" tabindex="-1">Frequently Asked Questions about the Agent <a class="header-anchor" href="#frequently-asked-questions-about-the-agent" aria-label="Permalink to &quot;Frequently Asked Questions about the Agent&quot;">​</a></h1><h2 id="the-ip-displayed-in-the-admin-panel-is-different-from-the-actual-agent-ip" tabindex="-1">The IP Displayed in the Admin Panel is Different from the Actual Agent IP? <a class="header-anchor" href="#the-ip-displayed-in-the-admin-panel-is-different-from-the-actual-agent-ip" aria-label="Permalink to &quot;The IP Displayed in the Admin Panel is Different from the Actual Agent IP?&quot;">​</a></h2><p>Please refer to <a href="/en_US/guide/dashboardq.html#why-is-the-ip-displayed-in-the-admin-panel-different-from-the-actual-agent-ip">Dashboard Related - Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?</a>. This will not be repeated here.</p><h2 id="errors-during-one-click-script-installation" tabindex="-1">Errors During One-Click Script Installation <a class="header-anchor" href="#errors-during-one-click-script-installation" aria-label="Permalink to &quot;Errors During One-Click Script Installation&quot;">​</a></h2><h3 id="curl-failed-to-connect-to-raw-githubusercontent-com" tabindex="-1">curl: Failed to connect to raw.githubusercontent.com...... <a class="header-anchor" href="#curl-failed-to-connect-to-raw-githubusercontent-com" aria-label="Permalink to &quot;curl: Failed to connect to raw.githubusercontent.com......&quot;">​</a></h3><p>This mostly occurs on servers in mainland China. Currently, the one-click script fetches the installation script directly from Github. You may try several times, or <a href="/en_US/guide/agent.html#other-ways-to-install-agent">manually install the Agent</a>. Additionally, you can find third-party Github acceleration services or mirrors and set them in the one-click installation script.</p><h3 id="sudo-command-not-found" tabindex="-1">sudo: command not found <a class="header-anchor" href="#sudo-command-not-found" aria-label="Permalink to &quot;sudo: command not found&quot;">​</a></h3><p>Please manually install sudo first, for example, in Ubuntu:</p><div class="language-shell vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">apt</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> install</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> sudo</span></span></code></pre></div>',9),o=[s];function r(l,d,h,c,u,p){return a(),t("div",null,o)}const g=e(i,[["render",r]]);export{f as __pageData,g as default};
+import{_ as e,c as t,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const f=JSON.parse('{"title":"Frequently Asked Questions about the Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1728186808000}'),i={name:"en_US/guide/agentq.md"},s=n('<h1 id="frequently-asked-questions-about-the-agent" tabindex="-1">Frequently Asked Questions about the Agent <a class="header-anchor" href="#frequently-asked-questions-about-the-agent" aria-label="Permalink to &quot;Frequently Asked Questions about the Agent&quot;">​</a></h1><h2 id="the-ip-displayed-in-the-admin-panel-is-different-from-the-actual-agent-ip" tabindex="-1">The IP Displayed in the Admin Panel is Different from the Actual Agent IP? <a class="header-anchor" href="#the-ip-displayed-in-the-admin-panel-is-different-from-the-actual-agent-ip" aria-label="Permalink to &quot;The IP Displayed in the Admin Panel is Different from the Actual Agent IP?&quot;">​</a></h2><p>Please refer to <a href="/en_US/guide/dashboardq.html#why-is-the-ip-displayed-in-the-admin-panel-different-from-the-actual-agent-ip">Dashboard Related - Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?</a>. This will not be repeated here.</p><h2 id="errors-during-one-click-script-installation" tabindex="-1">Errors During One-Click Script Installation <a class="header-anchor" href="#errors-during-one-click-script-installation" aria-label="Permalink to &quot;Errors During One-Click Script Installation&quot;">​</a></h2><h3 id="curl-failed-to-connect-to-raw-githubusercontent-com" tabindex="-1">curl: Failed to connect to raw.githubusercontent.com...... <a class="header-anchor" href="#curl-failed-to-connect-to-raw-githubusercontent-com" aria-label="Permalink to &quot;curl: Failed to connect to raw.githubusercontent.com......&quot;">​</a></h3><p>This mostly occurs on servers in mainland China. Currently, the one-click script fetches the installation script directly from Github. You may try several times, or <a href="/en_US/guide/agent.html#other-ways-to-install-agent">manually install the Agent</a>. Additionally, you can find third-party Github acceleration services or mirrors and set them in the one-click installation script.</p><h3 id="sudo-command-not-found" tabindex="-1">sudo: command not found <a class="header-anchor" href="#sudo-command-not-found" aria-label="Permalink to &quot;sudo: command not found&quot;">​</a></h3><p>Please manually install sudo first, for example, in Ubuntu:</p><div class="language-shell vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">apt</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> install</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> sudo</span></span></code></pre></div>',9),o=[s];function r(l,d,h,c,u,p){return a(),t("div",null,o)}const g=e(i,[["render",r]]);export{f as __pageData,g as default};

assets/en_US_guide_agentq.md.XAZgZFB0.lean.js

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

assets/en_US_guide_api.md.nmBhgcw3.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":1725160726000}'),t={name:"en_US/guide/api.md"},h=n(`<h1 id="api-interface" tabindex="-1">API Interface <a class="header-anchor" href="#api-interface" aria-label="Permalink to &quot;API Interface&quot;">​</a></h1><p><strong>Nezha Monitoring supports querying the status information of Agents using the API interface</strong></p><h2 id="creating-a-token" tabindex="-1">Creating a Token <a class="header-anchor" href="#creating-a-token" aria-label="Permalink to &quot;Creating a Token&quot;">​</a></h2><p>Nezha Monitoring&#39;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 &quot;API Token,&quot; and enter the Token management page. Click &quot;Add Token&quot;, add a custom note, and click &quot;Add&quot;.</p><p>To delete a Token, select the corresponding Token and click the delete icon on the right.</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Tokens are the authentication credentials for the API interface. They are critical to the security of your Dashboard&#39;s information, so do not share your Token with others.</p></div><h2 id="authentication-method" tabindex="-1">Authentication Method <a class="header-anchor" href="#authentication-method" aria-label="Permalink to &quot;Authentication Method&quot;">​</a></h2><p>Ensure the request header contains <code>Authorization: Token</code> for authentication.</p><p>Token authentication method:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>Request Headers:</span></span>
+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":1728186808000}'),t={name:"en_US/guide/api.md"},h=n(`<h1 id="api-interface" tabindex="-1">API Interface <a class="header-anchor" href="#api-interface" aria-label="Permalink to &quot;API Interface&quot;">​</a></h1><p><strong>Nezha Monitoring supports querying the status information of Agents using the API interface</strong></p><h2 id="creating-a-token" tabindex="-1">Creating a Token <a class="header-anchor" href="#creating-a-token" aria-label="Permalink to &quot;Creating a Token&quot;">​</a></h2><p>Nezha Monitoring&#39;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 &quot;API Token,&quot; and enter the Token management page. Click &quot;Add Token&quot;, add a custom note, and click &quot;Add&quot;.</p><p>To delete a Token, select the corresponding Token and click the delete icon on the right.</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Tokens are the authentication credentials for the API interface. They are critical to the security of your Dashboard&#39;s information, so do not share your Token with others.</p></div><h2 id="authentication-method" tabindex="-1">Authentication Method <a class="header-anchor" href="#authentication-method" aria-label="Permalink to &quot;Authentication Method&quot;">​</a></h2><p>Ensure the request header contains <code>Authorization: Token</code> for authentication.</p><p>Token authentication method:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>Request Headers:</span></span>
 <span class="line"><span>Authorization: Token</span></span></code></pre></div><h2 id="usage-instructions" tabindex="-1">Usage Instructions <a class="header-anchor" href="#usage-instructions" aria-label="Permalink to &quot;Usage Instructions&quot;">​</a></h2><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Negative timestamps in the following examples represent <code>0000-00-00</code>. 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.</p></div><div class="tip custom-block"><p class="custom-block-title">TIP</p><p><strong>The request method is <code>GET</code>, and the response format is <code>JSON</code>.</strong></p></div><h3 id="get-server-list" tabindex="-1">Get Server List <a class="header-anchor" href="#get-server-list" aria-label="Permalink to &quot;Get Server List&quot;">​</a></h3><p>Request:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>GET /api/v1/server/list?tag=</span></span></code></pre></div><p>Parameters:</p><ul><li><code>tag</code> (optional): ServerTag is the server group. Provide this parameter to query only servers in that group.</li></ul><p>Example response:</p><div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">    &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">    &quot;message&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;success&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>

assets/en_US_guide_api.md.nmBhgcw3.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":1725160726000}'),t={name:"en_US/guide/api.md"},h=n("",42),k=[h];function p(l,e,E,r,d,o){return a(),i("div",null,k)}const y=s(t,[["render",p]]);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":1728186808000}'),t={name:"en_US/guide/api.md"},h=n("",42),k=[h];function p(l,e,E,r,d,o){return a(),i("div",null,k)}const y=s(t,[["render",p]]);export{F as __pageData,y as default};

assets/en_US_guide_dashboard.md.B7jTJxeS.js

@@ -1,4 +1,4 @@
-import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Install Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1725160726000}'),i={name:"en_US/guide/dashboard.md"},n=t(`<h1 id="install-dashboard" tabindex="-1">Install Dashboard <a class="header-anchor" href="#install-dashboard" aria-label="Permalink to &quot;Install Dashboard&quot;">​</a></h1><h2 id="preparation" tabindex="-1">Preparation <a class="header-anchor" href="#preparation" aria-label="Permalink to &quot;Preparation&quot;">​</a></h2><p>To set up Nezha Monitoring, you need:</p><ol><li>A server with public internet access, with firewall and security policies allowing traffic on ports 8008 and 5555. These ports are necessary for accessing and receiving data. A server with a single core and 512MB of RAM is sufficient for most use cases.</li><li>A domain with an A record set to point to your Dashboard server IP.</li></ol><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>If you want to use a CDN, prepare two domains: one configured with CDN for public access (CDN must support WebSocket protocol), and another domain not using CDN for communication between the Agent and Dashboard.</p><p>This document uses &quot;dashboard.example.com&quot; and &quot;data.example.com&quot; as example domains.</p></div><ol start="3"><li>A Github account (or Gitlab, Gitee).</li></ol><p><strong>This document uses the aaPanel for reverse proxying the Dashboard as an example. As future versions change, some features may change their entry points. This document is for reference only.</strong></p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>This project does not depend on the aaPanel; you can choose any server panel you prefer or manually install Nginx or Caddy to configure SSL and reverse proxy.<br> If you do not need to use ports 80 and 443 to access the Dashboard, you can directly use the installation script to install and run Nezha Monitoring without installing Nginx.</p></div><h2 id="obtaining-github-client-id-and-secret" tabindex="-1">Obtaining Github Client ID and Secret <a class="header-anchor" href="#obtaining-github-client-id-and-secret" aria-label="Permalink to &quot;Obtaining Github Client ID and Secret&quot;">​</a></h2><p>Nezha Monitoring uses Github, Gitlab, or Gitee as admin accounts.</p><ol><li>First, create an OAuth application. For Github, log in to Github, open <a href="https://github.com/settings/developers" target="_blank" rel="noreferrer">Github OAuth Apps</a>, and select &quot;OAuth Apps&quot; -&gt; &quot;New OAuth App&quot;.<br><code>Application name</code> - Fill in as you like.<br><code>Homepage URL</code> - Fill in with the domain for accessing the dashboard, such as &quot;<a href="http://dashboard.example.com" target="_blank" rel="noreferrer">http://dashboard.example.com</a>&quot; (your domain).<br><code>Authorization callback URL</code> - Fill in with the callback address, such as &quot;<a href="http://dashboard.example.com/oauth2/callback" target="_blank" rel="noreferrer">http://dashboard.example.com/oauth2/callback</a>&quot; (don&#39;t forget <code>/oauth2/callback</code>).</li><li>Click “Register application”.</li><li>Save the Client ID on the page, then click “Generate a new client secret” to create a new Client Secret, which will be displayed only once, <strong>please keep it safe</strong>.</li></ol><h2 id="using-cloudflare-access-as-an-oauth2-provider" tabindex="-1">Using Cloudflare Access as an OAuth2 Provider <a class="header-anchor" href="#using-cloudflare-access-as-an-oauth2-provider" aria-label="Permalink to &quot;Using Cloudflare Access as an OAuth2 Provider&quot;">​</a></h2><p>If you encounter issues using GitHub, GitLab, or Gitee for admin account logins, consider switching to <a href="/en_US/guide/q8.html">Cloudflare Access as your OAuth2 provider</a> for authentication.</p><h3 id="setting-up-a-new-saas-oidc-application" tabindex="-1">Setting Up a New SaaS-OIDC Application <a class="header-anchor" href="#setting-up-a-new-saas-oidc-application" aria-label="Permalink to &quot;Setting Up a New SaaS-OIDC Application&quot;">​</a></h3><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>The following steps are for users who have already started using Zero Trust. If you have not previously used Cloudflare Zero Trust, we strongly recommend that you first read the <a href="/en_US/guide/q8.html">Guide on Using Cloudflare Access as an OAuth2 Provider</a> to understand the configuration examples and setup process.</p></div><ol><li>Go to <a href="https://one.dash.cloudflare.com" target="_blank" rel="noreferrer">Zero Trust Dashboard</a> and log in with your Cloudflare account.</li><li><code>My Team</code> -&gt; <code>Users</code> -&gt; <code>&lt;specific user&gt;</code> -&gt; Get <code>User I
Line truncated
+import{_ as a,c as e,o as s,a4 as t}from"./chunks/framework.BmdFiWrL.js";const k=JSON.parse('{"title":"Install Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1728186808000}'),i={name:"en_US/guide/dashboard.md"},n=t(`<h1 id="install-dashboard" tabindex="-1">Install Dashboard <a class="header-anchor" href="#install-dashboard" aria-label="Permalink to &quot;Install Dashboard&quot;">​</a></h1><h2 id="preparation" tabindex="-1">Preparation <a class="header-anchor" href="#preparation" aria-label="Permalink to &quot;Preparation&quot;">​</a></h2><p>To set up Nezha Monitoring, you need:</p><ol><li>A server with public internet access, with firewall and security policies allowing traffic on ports 8008 and 5555. These ports are necessary for accessing and receiving data. A server with a single core and 512MB of RAM is sufficient for most use cases.</li><li>A domain with an A record set to point to your Dashboard server IP.</li></ol><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>If you want to use a CDN, prepare two domains: one configured with CDN for public access (CDN must support WebSocket protocol), and another domain not using CDN for communication between the Agent and Dashboard.</p><p>This document uses &quot;dashboard.example.com&quot; and &quot;data.example.com&quot; as example domains.</p></div><ol start="3"><li>A Github account (or Gitlab, Gitee).</li></ol><p><strong>This document uses the aaPanel for reverse proxying the Dashboard as an example. As future versions change, some features may change their entry points. This document is for reference only.</strong></p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>This project does not depend on the aaPanel; you can choose any server panel you prefer or manually install Nginx or Caddy to configure SSL and reverse proxy.<br> If you do not need to use ports 80 and 443 to access the Dashboard, you can directly use the installation script to install and run Nezha Monitoring without installing Nginx.</p></div><h2 id="obtaining-github-client-id-and-secret" tabindex="-1">Obtaining Github Client ID and Secret <a class="header-anchor" href="#obtaining-github-client-id-and-secret" aria-label="Permalink to &quot;Obtaining Github Client ID and Secret&quot;">​</a></h2><p>Nezha Monitoring uses Github, Gitlab, or Gitee as admin accounts.</p><ol><li>First, create an OAuth application. For Github, log in to Github, open <a href="https://github.com/settings/developers" target="_blank" rel="noreferrer">Github OAuth Apps</a>, and select &quot;OAuth Apps&quot; -&gt; &quot;New OAuth App&quot;.<br><code>Application name</code> - Fill in as you like.<br><code>Homepage URL</code> - Fill in with the domain for accessing the dashboard, such as &quot;<a href="http://dashboard.example.com" target="_blank" rel="noreferrer">http://dashboard.example.com</a>&quot; (your domain).<br><code>Authorization callback URL</code> - Fill in with the callback address, such as &quot;<a href="http://dashboard.example.com/oauth2/callback" target="_blank" rel="noreferrer">http://dashboard.example.com/oauth2/callback</a>&quot; (don&#39;t forget <code>/oauth2/callback</code>).</li><li>Click “Register application”.</li><li>Save the Client ID on the page, then click “Generate a new client secret” to create a new Client Secret, which will be displayed only once, <strong>please keep it safe</strong>.</li></ol><h2 id="using-cloudflare-access-as-an-oauth2-provider" tabindex="-1">Using Cloudflare Access as an OAuth2 Provider <a class="header-anchor" href="#using-cloudflare-access-as-an-oauth2-provider" aria-label="Permalink to &quot;Using Cloudflare Access as an OAuth2 Provider&quot;">​</a></h2><p>If you encounter issues using GitHub, GitLab, or Gitee for admin account logins, consider switching to <a href="/en_US/guide/q8.html">Cloudflare Access as your OAuth2 provider</a> for authentication.</p><h3 id="setting-up-a-new-saas-oidc-application" tabindex="-1">Setting Up a New SaaS-OIDC Application <a class="header-anchor" href="#setting-up-a-new-saas-oidc-application" aria-label="Permalink to &quot;Setting Up a New SaaS-OIDC Application&quot;">​</a></h3><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>The following steps are for users who have already started using Zero Trust. If you have not previously used Cloudflare Zero Trust, we strongly recommend that you first read the <a href="/en_US/guide/q8.html">Guide on Using Cloudflare Access as an OAuth2 Provider</a> to understand the configuration examples and setup process.</p></div><ol><li>Go to <a href="https://one.dash.cloudflare.com" target="_blank" rel="noreferrer">Zero Trust Dashboard</a> and log in with your Cloudflare account.</li><li><code>My Team</code> -&gt; <code>Users</code> -&gt; <code>&lt;specific user&gt;</code> -&gt; Get <code>User I
Line truncated
 <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">location</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> / </span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
 <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">    proxy_pass </span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">http://127.0.0.1:8008;</span></span>
 <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">    proxy_set_header </span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">Host $http_host;</span></span>

assets/en_US_guide_dashboard.md.B7jTJxeS.lean.js

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

assets/en_US_guide_dashboardq.md.BqoM5H4p.js

@@ -1,4 +1,4 @@
-import{_ as e,c as a,o as t,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Frequently Asked Questions about the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1725160726000}'),s={name:"en_US/guide/dashboardq.md"},n=i(`<h1 id="frequently-asked-questions-about-the-dashboard" tabindex="-1">Frequently Asked Questions about the Dashboard <a class="header-anchor" href="#frequently-asked-questions-about-the-dashboard" aria-label="Permalink to &quot;Frequently Asked Questions about the Dashboard&quot;">​</a></h1><h2 id="why-is-the-ip-displayed-in-the-admin-panel-different-from-the-actual-agent-ip" tabindex="-1">Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP? <a class="header-anchor" href="#why-is-the-ip-displayed-in-the-admin-panel-different-from-the-actual-agent-ip" aria-label="Permalink to &quot;Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?&quot;">​</a></h2><p>First, let&#39;s explain how the IP displayed in the Admin panel is obtained: The Agent periodically requests IP-API to get IP information and reports it to the Dashboard. The currently used IP-API can be viewed here: <a href="https://github.com/nezhahq/agent/blob/main/pkg/monitor/myip.go" target="_blank" rel="noreferrer">myip.go</a>.<br> If you find that the IP displayed in the Admin panel is different from the IP provided by your service provider, it is most likely that the service provider has given you an <strong>entry IP</strong>, but the Agent is testing your <strong>exit IP</strong>. This issue can also occur with multi-line servers and IPLC private lines.</p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>For example, a common scenario is that the service provider gives you a high-defense server. To meet both high defense and low network interruption rate goals, the IP provided may be a mapped high-defense IP rather than your server&#39;s real exit IP.</p></div><p>You can also test the exit IP on the Agent server by running the following commands:</p><div class="language-shell vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> https://ipapi.co/ip/</span></span>
+import{_ as e,c as a,o as t,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Frequently Asked Questions about the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1728186808000}'),s={name:"en_US/guide/dashboardq.md"},n=i(`<h1 id="frequently-asked-questions-about-the-dashboard" tabindex="-1">Frequently Asked Questions about the Dashboard <a class="header-anchor" href="#frequently-asked-questions-about-the-dashboard" aria-label="Permalink to &quot;Frequently Asked Questions about the Dashboard&quot;">​</a></h1><h2 id="why-is-the-ip-displayed-in-the-admin-panel-different-from-the-actual-agent-ip" tabindex="-1">Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP? <a class="header-anchor" href="#why-is-the-ip-displayed-in-the-admin-panel-different-from-the-actual-agent-ip" aria-label="Permalink to &quot;Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?&quot;">​</a></h2><p>First, let&#39;s explain how the IP displayed in the Admin panel is obtained: The Agent periodically requests IP-API to get IP information and reports it to the Dashboard. The currently used IP-API can be viewed here: <a href="https://github.com/nezhahq/agent/blob/main/pkg/monitor/myip.go" target="_blank" rel="noreferrer">myip.go</a>.<br> If you find that the IP displayed in the Admin panel is different from the IP provided by your service provider, it is most likely that the service provider has given you an <strong>entry IP</strong>, but the Agent is testing your <strong>exit IP</strong>. This issue can also occur with multi-line servers and IPLC private lines.</p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>For example, a common scenario is that the service provider gives you a high-defense server. To meet both high defense and low network interruption rate goals, the IP provided may be a mapped high-defense IP rather than your server&#39;s real exit IP.</p></div><p>You can also test the exit IP on the Agent server by running the following commands:</p><div class="language-shell vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> https://ipapi.co/ip/</span></span>
 <span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> ip.sb</span></span>
 <span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> ip-api.com</span></span></code></pre></div><h2 id="forgot-or-deleted-viewing-password" tabindex="-1">Forgot or Deleted Viewing Password <a class="header-anchor" href="#forgot-or-deleted-viewing-password" aria-label="Permalink to &quot;Forgot or Deleted Viewing Password&quot;">​</a></h2><p>Please view or edit the <code>/opt/nezha/dashboard/data/config.yaml</code> file.<br> The password is located under the <code>site-viewpassword</code> item.</p><h2 id="dashboard-installation-restart-update-failure-iptables" tabindex="-1">Dashboard Installation/Restart/Update Failure: iptables ...... <a class="header-anchor" href="#dashboard-installation-restart-update-failure-iptables" aria-label="Permalink to &quot;Dashboard Installation/Restart/Update Failure: iptables ......&quot;">​</a></h2><p>First, try restarting Docker before proceeding:</p><div class="language-shell vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">systemctl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> status</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> docker</span></span>
 <span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">systemctl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> restart</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> docker</span></span>

assets/en_US_guide_dashboardq.md.BqoM5H4p.lean.js

@@ -1 +1 @@
-import{_ as e,c as a,o as t,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Frequently Asked Questions about the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1725160726000}'),s={name:"en_US/guide/dashboardq.md"},n=i("",37),o=[n];function r(d,l,h,c,p,u){return t(),a("div",null,o)}const f=e(s,[["render",r]]);export{b as __pageData,f as default};
+import{_ as e,c as a,o as t,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Frequently Asked Questions about the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1728186808000}'),s={name:"en_US/guide/dashboardq.md"},n=i("",37),o=[n];function r(d,l,h,c,p,u){return t(),a("div",null,o)}const f=e(s,[["render",r]]);export{b as __pageData,f as default};

assets/en_US_guide_loginq.md.gjVvg0fB.js

@@ -1 +1 @@
-import{_ as e,c as a,o,a4 as t}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"FAQ about logging into the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1725160726000}'),i={name:"en_US/guide/loginq.md"},r=t('<h1 id="faq-about-logging-into-the-dashboard" tabindex="-1">FAQ about logging into the Dashboard <a class="header-anchor" href="#faq-about-logging-into-the-dashboard" aria-label="Permalink to &quot;FAQ about logging into the Dashboard&quot;">​</a></h1><h2 id="stuck-page-connection-refused-long-response-time-after-login-callback" tabindex="-1">Stuck Page/Connection Refused/Long Response Time After Login Callback <a class="header-anchor" href="#stuck-page-connection-refused-long-response-time-after-login-callback" aria-label="Permalink to &quot;Stuck Page/Connection Refused/Long Response Time After Login Callback&quot;">​</a></h2><p>These issues can manifest in various ways, but ultimately the browser cannot display correctly after login.</p><ol><li>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.</li><li>You have configured the callback address incorrectly. Ensure that your callback address is correct and that both the <strong>port and protocol</strong> are accurate!</li><li>An unknown error occurred on the Dashboard. You can use a script to check the logs.</li></ol><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>What is a protocol? In the browser, the string that ends your domain with <code>://</code> is the protocol, usually <code>http</code> or <code>https</code>. 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.</p></div><h3 id="how-to-check-if-my-callback-address-is-wrong" tabindex="-1">How to Check if My Callback Address is Wrong? <a class="header-anchor" href="#how-to-check-if-my-callback-address-is-wrong" aria-label="Permalink to &quot;How to Check if My Callback Address is Wrong?&quot;">​</a></h3><p>Ensure that the protocol+domain+port displayed in the browser before login and after the callback are consistent.<br> Ensure that your path is <code>/oauth2/callback</code>, <strong>all in lowercase</strong>.</p><h2 id="errors-after-logging-into-the-admin-panel" tabindex="-1">Errors After Logging into the Admin Panel <a class="header-anchor" href="#errors-after-logging-into-the-admin-panel" aria-label="Permalink to &quot;Errors After Logging into the Admin Panel&quot;">​</a></h2><h3 id="http-named-cookie-not-present" tabindex="-1">http: named cookie not present <a class="header-anchor" href="#http-named-cookie-not-present" aria-label="Permalink to &quot;http: named cookie not present&quot;">​</a></h3><ol><li>Clear cookies and log in again, or try a different browser.</li><li>Check the callback address to ensure it is correct and that both the <strong>port and protocol</strong> 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.</li></ol><h3 id="lookup-xxx" tabindex="-1">lookup xxx <a class="header-anchor" href="#lookup-xxx" aria-label="Permalink to &quot;lookup xxx&quot;">​</a></h3><p>The container DNS resolution failed, usually due to modified iptables configurations.<br> It is recommended to restart Docker first, <code>sudo systemctl restart docker</code>, then restart the Dashboard using the script.<br> If the lookup error persists, check if there are other tools controlling iptables, such as firewall.<br> This issue might also be related to the kernel, so try switching to the official kernel.</p><h3 id="invalid-authorization-method-or-the-login-callback-address-is-invalid-expired-or-has-been-revoked" tabindex="-1">Invalid authorization method, or the login callback address is invalid, expired, or has been revoked <a class="header-anchor" href="#invalid-authorization-method-or-the-login-callback-address-is-invalid-expired-or-has-been-revoked" aria-label="Permalink to &quot;Invalid authorization method, or the login callback address is invalid, expired, or has been revoked&quot;">​</a></h3><p>This issue appears only when using Gitee login, and the reason is unclear. Switching to GitHub is recommended.</p><h3 id="oauth2-server-response-missing-access-token" tabindex="-1">oauth2: server response missing access_token <a class="header-anchor" href="#oauth2-server-response-missing-access-token" aria-label="Permalink to &quot;oauth2: server response missing access_token&quot;">​</a></h3><p>This could be caused by various factors, most likely a network issue. Check your network and try again.<br> If unresolved, switching to Github or another method is recommended.</p><h3 Line truncated
+import{_ as e,c as a,o,a4 as t}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"FAQ about logging into the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1728186808000}'),i={name:"en_US/guide/loginq.md"},r=t('<h1 id="faq-about-logging-into-the-dashboard" tabindex="-1">FAQ about logging into the Dashboard <a class="header-anchor" href="#faq-about-logging-into-the-dashboard" aria-label="Permalink to &quot;FAQ about logging into the Dashboard&quot;">​</a></h1><h2 id="stuck-page-connection-refused-long-response-time-after-login-callback" tabindex="-1">Stuck Page/Connection Refused/Long Response Time After Login Callback <a class="header-anchor" href="#stuck-page-connection-refused-long-response-time-after-login-callback" aria-label="Permalink to &quot;Stuck Page/Connection Refused/Long Response Time After Login Callback&quot;">​</a></h2><p>These issues can manifest in various ways, but ultimately the browser cannot display correctly after login.</p><ol><li>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.</li><li>You have configured the callback address incorrectly. Ensure that your callback address is correct and that both the <strong>port and protocol</strong> are accurate!</li><li>An unknown error occurred on the Dashboard. You can use a script to check the logs.</li></ol><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>What is a protocol? In the browser, the string that ends your domain with <code>://</code> is the protocol, usually <code>http</code> or <code>https</code>. 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.</p></div><h3 id="how-to-check-if-my-callback-address-is-wrong" tabindex="-1">How to Check if My Callback Address is Wrong? <a class="header-anchor" href="#how-to-check-if-my-callback-address-is-wrong" aria-label="Permalink to &quot;How to Check if My Callback Address is Wrong?&quot;">​</a></h3><p>Ensure that the protocol+domain+port displayed in the browser before login and after the callback are consistent.<br> Ensure that your path is <code>/oauth2/callback</code>, <strong>all in lowercase</strong>.</p><h2 id="errors-after-logging-into-the-admin-panel" tabindex="-1">Errors After Logging into the Admin Panel <a class="header-anchor" href="#errors-after-logging-into-the-admin-panel" aria-label="Permalink to &quot;Errors After Logging into the Admin Panel&quot;">​</a></h2><h3 id="http-named-cookie-not-present" tabindex="-1">http: named cookie not present <a class="header-anchor" href="#http-named-cookie-not-present" aria-label="Permalink to &quot;http: named cookie not present&quot;">​</a></h3><ol><li>Clear cookies and log in again, or try a different browser.</li><li>Check the callback address to ensure it is correct and that both the <strong>port and protocol</strong> 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.</li></ol><h3 id="lookup-xxx" tabindex="-1">lookup xxx <a class="header-anchor" href="#lookup-xxx" aria-label="Permalink to &quot;lookup xxx&quot;">​</a></h3><p>The container DNS resolution failed, usually due to modified iptables configurations.<br> It is recommended to restart Docker first, <code>sudo systemctl restart docker</code>, then restart the Dashboard using the script.<br> If the lookup error persists, check if there are other tools controlling iptables, such as firewall.<br> This issue might also be related to the kernel, so try switching to the official kernel.</p><h3 id="invalid-authorization-method-or-the-login-callback-address-is-invalid-expired-or-has-been-revoked" tabindex="-1">Invalid authorization method, or the login callback address is invalid, expired, or has been revoked <a class="header-anchor" href="#invalid-authorization-method-or-the-login-callback-address-is-invalid-expired-or-has-been-revoked" aria-label="Permalink to &quot;Invalid authorization method, or the login callback address is invalid, expired, or has been revoked&quot;">​</a></h3><p>This issue appears only when using Gitee login, and the reason is unclear. Switching to GitHub is recommended.</p><h3 id="oauth2-server-response-missing-access-token" tabindex="-1">oauth2: server response missing access_token <a class="header-anchor" href="#oauth2-server-response-missing-access-token" aria-label="Permalink to &quot;oauth2: server response missing access_token&quot;">​</a></h3><p>This could be caused by various factors, most likely a network issue. Check your network and try again.<br> If unresolved, switching to Github or another method is recommended.</p><h3 Line truncated

assets/en_US_guide_loginq.md.gjVvg0fB.lean.js

@@ -1 +1 @@
-import{_ as e,c as a,o,a4 as t}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"FAQ about logging into the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1725160726000}'),i={name:"en_US/guide/loginq.md"},r=t("",24),n=[r];function s(l,c,h,d,u,g){return o(),a("div",null,n)}const b=e(i,[["render",s]]);export{p as __pageData,b as default};
+import{_ as e,c as a,o,a4 as t}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"FAQ about logging into the Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1728186808000}'),i={name:"en_US/guide/loginq.md"},r=t("",24),n=[r];function s(l,c,h,d,u,g){return o(),a("div",null,n)}const b=e(i,[["render",s]]);export{p as __pageData,b as default};

assets/en_US_guide_nat.md.CaHPz97h.js

@@ -1 +1 @@
-import{_ as e,c as t,o as a,a4 as i}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"NAT Traversal Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/nat.md","filePath":"en_US/guide/nat.md","lastUpdated":1725160726000}'),o={name:"en_US/guide/nat.md"},n=i('<h1 id="nat-traversal-configuration" tabindex="-1">NAT Traversal Configuration <a class="header-anchor" href="#nat-traversal-configuration" aria-label="Permalink to &quot;NAT Traversal Configuration&quot;">​</a></h1><p>Nezha Server Monitoring includes built-in NAT traversal capabilities, allowing users to expose internal services running on an Agent (such as home OpenWrt routers or NAS devices) to the public internet. This functionality facilitates remote access and is currently limited to supporting HTTP protocol traversal.</p><h2 id="preparation" tabindex="-1">Preparation <a class="header-anchor" href="#preparation" aria-label="Permalink to &quot;Preparation&quot;">​</a></h2><p>Prior to configuring NAT traversal, please ensure the following preparatory steps are completed:</p><ul><li>Verify that the Nezha Monitoring Agent is installed and actively running on your device and maintains a stable connection with the Dashboard.</li><li>Acquire a public domain name, ideally using a subdomain configuration, such as <code>service-1.example.com</code>. Point this domain name to the public IP address of your Dashboard server.</li><li>It is important to note that each domain name can only map to the service of one Agent. For mapping services from multiple Agents, distinct domain names should be used, such as <code>service-2.example.com</code>.</li></ul><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>If your Dashboard server uses tools like the aaPanel or similar management platforms, ensure that your domain (e.g., <code>service-1.example.com</code>) is correctly linked to the Dashboard site within these tools to avoid access issues.</p></div><h2 id="nat-traversal-configuration-steps" tabindex="-1">NAT Traversal Configuration Steps <a class="header-anchor" href="#nat-traversal-configuration-steps" aria-label="Permalink to &quot;NAT Traversal Configuration Steps&quot;">​</a></h2><ol><li>Log into the Dashboard Admin Panel and navigate to the &quot;NAT Traversal&quot; section in the menu.</li><li>Click the &quot;Add&quot; button and provide the following required details: <ul><li><strong>Name</strong>: Assign a custom name to this traversal setup, for example, <code>OpenWrt Login Page</code>.</li><li><strong>Agent ID</strong>: Input the ID of the Agent for which traversal is needed.</li><li><strong>Internal Service Address</strong>: Specify the internal service address that requires traversal, in the <code>IP:port</code> format, such as <code>127.0.0.1:80</code>.</li><li><strong>Domain Name</strong>: Enter the previously configured public domain name, like <code>service-1.example.com</code>.</li></ul></li><li>After filling in the details, click the &quot;Add&quot; button and wait for the traversal setup to activate.</li><li>Test the configuration by accessing <code>http://service-1.example.com</code> to ensure the internal service on the Agent is successfully accessible.</li></ol><h2 id="usage-notes" tabindex="-1">Usage Notes <a class="header-anchor" href="#usage-notes" aria-label="Permalink to &quot;Usage Notes&quot;">​</a></h2><ul><li>Continuous connectivity between the Agent and the Dashboard is crucial for the NAT traversal functionality to operate correctly. If the connection to the Agent is lost, the traversal setup will temporarily cease to function.</li><li>Given that the NAT traversal does not encrypt traffic by itself, it is recommended to secure data transmissions by employing TLS/SSL between the Agent and the Dashboard, as well as between the Dashboard and the client browser, to ensure data security during transmission.</li></ul>',10),r=[n];function s(l,c,d,u,h,p){return a(),t("div",null,r)}const f=e(o,[["render",s]]);export{g as __pageData,f as default};
+import{_ as e,c as t,o as a,a4 as i}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"NAT Traversal Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/nat.md","filePath":"en_US/guide/nat.md","lastUpdated":1728186808000}'),o={name:"en_US/guide/nat.md"},n=i('<h1 id="nat-traversal-configuration" tabindex="-1">NAT Traversal Configuration <a class="header-anchor" href="#nat-traversal-configuration" aria-label="Permalink to &quot;NAT Traversal Configuration&quot;">​</a></h1><p>Nezha Server Monitoring includes built-in NAT traversal capabilities, allowing users to expose internal services running on an Agent (such as home OpenWrt routers or NAS devices) to the public internet. This functionality facilitates remote access and is currently limited to supporting HTTP protocol traversal.</p><h2 id="preparation" tabindex="-1">Preparation <a class="header-anchor" href="#preparation" aria-label="Permalink to &quot;Preparation&quot;">​</a></h2><p>Prior to configuring NAT traversal, please ensure the following preparatory steps are completed:</p><ul><li>Verify that the Nezha Monitoring Agent is installed and actively running on your device and maintains a stable connection with the Dashboard.</li><li>Acquire a public domain name, ideally using a subdomain configuration, such as <code>service-1.example.com</code>. Point this domain name to the public IP address of your Dashboard server.</li><li>It is important to note that each domain name can only map to the service of one Agent. For mapping services from multiple Agents, distinct domain names should be used, such as <code>service-2.example.com</code>.</li></ul><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>If your Dashboard server uses tools like the aaPanel or similar management platforms, ensure that your domain (e.g., <code>service-1.example.com</code>) is correctly linked to the Dashboard site within these tools to avoid access issues.</p></div><h2 id="nat-traversal-configuration-steps" tabindex="-1">NAT Traversal Configuration Steps <a class="header-anchor" href="#nat-traversal-configuration-steps" aria-label="Permalink to &quot;NAT Traversal Configuration Steps&quot;">​</a></h2><ol><li>Log into the Dashboard Admin Panel and navigate to the &quot;NAT Traversal&quot; section in the menu.</li><li>Click the &quot;Add&quot; button and provide the following required details: <ul><li><strong>Name</strong>: Assign a custom name to this traversal setup, for example, <code>OpenWrt Login Page</code>.</li><li><strong>Agent ID</strong>: Input the ID of the Agent for which traversal is needed.</li><li><strong>Internal Service Address</strong>: Specify the internal service address that requires traversal, in the <code>IP:port</code> format, such as <code>127.0.0.1:80</code>.</li><li><strong>Domain Name</strong>: Enter the previously configured public domain name, like <code>service-1.example.com</code>.</li></ul></li><li>After filling in the details, click the &quot;Add&quot; button and wait for the traversal setup to activate.</li><li>Test the configuration by accessing <code>http://service-1.example.com</code> to ensure the internal service on the Agent is successfully accessible.</li></ol><h2 id="usage-notes" tabindex="-1">Usage Notes <a class="header-anchor" href="#usage-notes" aria-label="Permalink to &quot;Usage Notes&quot;">​</a></h2><ul><li>Continuous connectivity between the Agent and the Dashboard is crucial for the NAT traversal functionality to operate correctly. If the connection to the Agent is lost, the traversal setup will temporarily cease to function.</li><li>Given that the NAT traversal does not encrypt traffic by itself, it is recommended to secure data transmissions by employing TLS/SSL between the Agent and the Dashboard, as well as between the Dashboard and the client browser, to ensure data security during transmission.</li></ul>',10),r=[n];function s(l,c,d,u,h,p){return a(),t("div",null,r)}const f=e(o,[["render",s]]);export{g as __pageData,f as default};

assets/en_US_guide_nat.md.CaHPz97h.lean.js

@@ -1 +1 @@
-import{_ as e,c as t,o as a,a4 as i}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"NAT Traversal Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/nat.md","filePath":"en_US/guide/nat.md","lastUpdated":1725160726000}'),o={name:"en_US/guide/nat.md"},n=i("",10),r=[n];function s(l,c,d,u,h,p){return a(),t("div",null,r)}const f=e(o,[["render",s]]);export{g as __pageData,f as default};
+import{_ as e,c as t,o as a,a4 as i}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"NAT Traversal Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/nat.md","filePath":"en_US/guide/nat.md","lastUpdated":1728186808000}'),o={name:"en_US/guide/nat.md"},n=i("",10),r=[n];function s(l,c,d,u,h,p){return a(),t("div",null,r)}const f=e(o,[["render",s]]);export{g as __pageData,f as default};

assets/en_US_guide_notifications.md.DzEMZ4fM.js

@@ -1,4 +1,4 @@
-import{_ as i,c as s,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const E=JSON.parse('{"title":"Notification Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1725160726000}'),e={name:"en_US/guide/notifications.md"},n=a(`<h1 id="notification-configuration" tabindex="-1">Notification Configuration <a class="header-anchor" href="#notification-configuration" aria-label="Permalink to &quot;Notification Configuration&quot;">​</a></h1><p>Nezha Monitoring supports monitoring server load, CPU, memory, disk, traffic, monthly traffic, process count, and connection count, and sending notifications when user-defined thresholds are reached.</p><h2 id="flexible-notification-methods" tabindex="-1">Flexible Notification Methods <a class="header-anchor" href="#flexible-notification-methods" aria-label="Permalink to &quot;Flexible Notification Methods&quot;">​</a></h2><ul><li>In Dashboard messages, the placeholder <code>#DATETIME#</code> represents the timestamp of the event. When the notification is triggered, the Dashboard automatically replaces <code>#DATETIME#</code> with the actual event time.</li><li><code>#NEZHA#</code> is a placeholder for Dashboard messages, and the Dashboard automatically replaces the placeholder with the actual message when the notification is triggered.</li><li>The body content is in <code>JSON</code> format: <strong>When the request type is FORM</strong>, the value is in <code>key:value</code> form, and placeholders can be placed inside <code>value</code>. The placeholders will be automatically replaced during notification. <strong>When the request type is JSON</strong>, only simple string replacement is performed before being submitted to the <code>URL</code>.</li><li>Placeholders can also be placed inside the URL, and simple string replacement will be performed during the request.</li></ul><p><strong>Refer to the following notification method examples, and you can also flexibly set the push method according to your needs.</strong></p><h3 id="bark-example" tabindex="-1">Bark Example <a class="header-anchor" href="#bark-example" aria-label="Permalink to &quot;Bark Example&quot;">​</a></h3><details><summary>Click to expand/collapse</summary><ul><li><p>Name: Bark</p></li><li><p>URL structure: /:key/:body or /:key/:title/:body or /:key/:category/:title/:body</p></li><li><p>Request Method: GET</p></li><li><p>Request Type: Default</p></li><li><p>Body: Empty</p></li><li><p>Name: Bark</p></li><li><p>URL structure: /push</p></li><li><p>Request Method: POST</p></li><li><p>Request Type: form</p></li><li><p>Body: <code>{&quot;title&quot;: &quot;#SERVER.NAME#&quot;,&quot;device_key&quot;:&quot;xxxxxxxxx&quot;,&quot;body&quot;:&quot;#NEZHA#&quot;,&quot;icon&quot;:&quot;https://xxxxxxxx/nz.png&quot;}</code></p></li></ul></details><h3 id="slack-example-contributor-白歌" tabindex="-1">Slack Example Contributor: <a href="https://github.com/cantoblanco" target="_blank" rel="noreferrer">@白歌</a> <a class="header-anchor" href="#slack-example-contributor-白歌" aria-label="Permalink to &quot;Slack Example Contributor: [@白歌](https://github.com/cantoblanco)&quot;">​</a></h3><details><summary>Click to expand/collapse</summary><h4 id="url-parameter-acquisition-instructions" tabindex="-1">URL Parameter Acquisition Instructions <a class="header-anchor" href="#url-parameter-acquisition-instructions" aria-label="Permalink to &quot;URL Parameter Acquisition Instructions&quot;">​</a></h4><p>Prepare your Slack Workspace in advance and create an App for this Workspace. If you have not created one, you can create an App at <a href="https://api.slack.com/apps" target="_blank" rel="noreferrer">Slack API</a>.</p><p>After creating the App, you need to add an Incoming Webhook to the App. In the App&#39;s settings page, find Incoming Webhooks, enable Activate Incoming Webhooks, and at the bottom of the page, find and click Add New Webhook to Workspace, choose a Channel, and click Allow. After creating, you will get a Webhook URL, which you will use to replace the example URL below.</p><ul><li>Name: Slack</li><li>URL: <a href="https://hooks.slack.com/services/xxxxxxxxx/xxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx" target="_blank" rel="noreferrer">https://hooks.slack.com/services/xxxxxxxxx/xxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx</a></li><li>Request Method: POST</li><li>Request Type: JSON</li><li>Body: <code>{&quot;text&quot;:&quot;#NEZHA#&quot;}</code></li></ul></details><h3 id="telegram-example-contributor-白歌" tabindex="-1">Telegram Example Contributor: <a href="https://github.com/cantoblanco" target="_blank" rel="noreferrer">@白歌</a> <a class="header-anchor" href="#telegram-example-contributor-白歌" aria-label="Permalink to &quot;Telegram Example Contributor: [@白歌](https://github.com/cantoblanco)&quot;">​</a></h3><details><summary>Click to expand/collapse</summary><h4 id="url-par
Line truncated
+import{_ as i,c as s,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const E=JSON.parse('{"title":"Notification Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1728186808000}'),e={name:"en_US/guide/notifications.md"},n=a(`<h1 id="notification-configuration" tabindex="-1">Notification Configuration <a class="header-anchor" href="#notification-configuration" aria-label="Permalink to &quot;Notification Configuration&quot;">​</a></h1><p>Nezha Monitoring supports monitoring server load, CPU, memory, disk, traffic, monthly traffic, process count, and connection count, and sending notifications when user-defined thresholds are reached.</p><h2 id="flexible-notification-methods" tabindex="-1">Flexible Notification Methods <a class="header-anchor" href="#flexible-notification-methods" aria-label="Permalink to &quot;Flexible Notification Methods&quot;">​</a></h2><ul><li>In Dashboard messages, the placeholder <code>#DATETIME#</code> represents the timestamp of the event. When the notification is triggered, the Dashboard automatically replaces <code>#DATETIME#</code> with the actual event time.</li><li><code>#NEZHA#</code> is a placeholder for Dashboard messages, and the Dashboard automatically replaces the placeholder with the actual message when the notification is triggered.</li><li>The body content is in <code>JSON</code> format: <strong>When the request type is FORM</strong>, the value is in <code>key:value</code> form, and placeholders can be placed inside <code>value</code>. The placeholders will be automatically replaced during notification. <strong>When the request type is JSON</strong>, only simple string replacement is performed before being submitted to the <code>URL</code>.</li><li>Placeholders can also be placed inside the URL, and simple string replacement will be performed during the request.</li></ul><p><strong>Refer to the following notification method examples, and you can also flexibly set the push method according to your needs.</strong></p><h3 id="bark-example" tabindex="-1">Bark Example <a class="header-anchor" href="#bark-example" aria-label="Permalink to &quot;Bark Example&quot;">​</a></h3><details><summary>Click to expand/collapse</summary><ul><li><p>Name: Bark</p></li><li><p>URL structure: /:key/:body or /:key/:title/:body or /:key/:category/:title/:body</p></li><li><p>Request Method: GET</p></li><li><p>Request Type: Default</p></li><li><p>Body: Empty</p></li><li><p>Name: Bark</p></li><li><p>URL structure: /push</p></li><li><p>Request Method: POST</p></li><li><p>Request Type: form</p></li><li><p>Body: <code>{&quot;title&quot;: &quot;#SERVER.NAME#&quot;,&quot;device_key&quot;:&quot;xxxxxxxxx&quot;,&quot;body&quot;:&quot;#NEZHA#&quot;,&quot;icon&quot;:&quot;https://xxxxxxxx/nz.png&quot;}</code></p></li></ul></details><h3 id="slack-example-contributor-白歌" tabindex="-1">Slack Example Contributor: <a href="https://github.com/cantoblanco" target="_blank" rel="noreferrer">@白歌</a> <a class="header-anchor" href="#slack-example-contributor-白歌" aria-label="Permalink to &quot;Slack Example Contributor: [@白歌](https://github.com/cantoblanco)&quot;">​</a></h3><details><summary>Click to expand/collapse</summary><h4 id="url-parameter-acquisition-instructions" tabindex="-1">URL Parameter Acquisition Instructions <a class="header-anchor" href="#url-parameter-acquisition-instructions" aria-label="Permalink to &quot;URL Parameter Acquisition Instructions&quot;">​</a></h4><p>Prepare your Slack Workspace in advance and create an App for this Workspace. If you have not created one, you can create an App at <a href="https://api.slack.com/apps" target="_blank" rel="noreferrer">Slack API</a>.</p><p>After creating the App, you need to add an Incoming Webhook to the App. In the App&#39;s settings page, find Incoming Webhooks, enable Activate Incoming Webhooks, and at the bottom of the page, find and click Add New Webhook to Workspace, choose a Channel, and click Allow. After creating, you will get a Webhook URL, which you will use to replace the example URL below.</p><ul><li>Name: Slack</li><li>URL: <a href="https://hooks.slack.com/services/xxxxxxxxx/xxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx" target="_blank" rel="noreferrer">https://hooks.slack.com/services/xxxxxxxxx/xxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx</a></li><li>Request Method: POST</li><li>Request Type: JSON</li><li>Body: <code>{&quot;text&quot;:&quot;#NEZHA#&quot;}</code></li></ul></details><h3 id="telegram-example-contributor-白歌" tabindex="-1">Telegram Example Contributor: <a href="https://github.com/cantoblanco" target="_blank" rel="noreferrer">@白歌</a> <a class="header-anchor" href="#telegram-example-contributor-白歌" aria-label="Permalink to &quot;Telegram Example Contributor: [@白歌](https://github.com/cantoblanco)&quot;">​</a></h3><details><summary>Click to expand/collapse</summary><h4 id="url-par
Line truncated
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">  &quot;message&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span></span>
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">      &quot;subject&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;Server Status Notification&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">      &quot;body&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span></span>
@@ -37,4 +37,11 @@ import{_ as i,c as s,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const E
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">    &quot;markdown&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span></span>
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">        &quot;content&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;# Nezha Notification</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\n\\n\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#NEZHA#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; Name: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.NAME#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; IP: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.IP#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; IPv4: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.IPV4#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">IPv6: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.IPV6#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; CPU: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.CPU#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; Memory: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.MEM#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; Swap: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.SWAP#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; Disk: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.DISK#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; Upload Speed: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.NETINSPEED#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; Download Speed: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.NETOUTSPEED#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; Total Upload: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.TRANSFERIN#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; Total Download: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.TRANSFEROUT#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; Load1: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.LOAD1#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; Load5: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">#SERVER.LOAD5#</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;\\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt; Load15: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ELine truncated
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">    }</span></span>
-<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></li></ul><p>You can remove or add relevant information as needed.</p></details><h2 id="notification-rule-explanation" tabindex="-1">Notification Rule Explanation <a class="header-anchor" href="#notification-rule-explanation" aria-label="Permalink to &quot;Notification Rule Explanation&quot;">​</a></h2><h3 id="basic-rules" tabindex="-1">Basic Rules <a class="header-anchor" href="#basic-rules" aria-label="Permalink to &quot;Basic Rules&quot;">​</a></h3><ul><li><code>type</code>: You can choose one or more types. If multiple types are selected in one rule, <strong>all selected types must be satisfied</strong> to trigger a notification (refer to the examples below) <ul><li><code>cpu</code>, <code>gpu</code>, <code>memory</code>, <code>swap</code>, <code>disk</code></li><li><code>net_in_speed</code> inbound network speed, <code>net_out_speed</code> outbound network speed, <code>net_all_speed</code> total network speed, <code>transfer_in</code> inbound traffic, <code>transfer_out</code> outbound traffic, <code>transfer_all</code> total traffic</li><li><code>offline</code> offline monitoring</li><li><code>load1</code>, <code>load5</code>, <code>load15</code> load</li><li><code>process_count</code> process count (currently resource-intensive due to thread count, not supported temporarily)</li><li><code>tcp_conn_count</code>, <code>udp_conn_count</code> connection count</li><li><code>temperature_max</code> maximum temperature</li></ul></li><li><code>duration</code>: Duration in seconds. An notification is triggered if 30% or more of the samples exceed the threshold within this duration (to prevent data spikes).</li><li><code>min</code> or <code>max</code>: <ul><li>For traffic and network speed, the unit is bytes (1KB = 1024B, 1MB = 1024 * 1024B)</li><li>For memory, disk, and CPU, the unit is percentage</li><li>No need to set this for offline monitoring</li></ul></li><li><code>cover</code>: <ul><li><code>0</code> monitors all servers, use <code>ignore</code> to exclude specific servers</li><li><code>1</code> ignores all servers, use <code>ignore</code> to monitor specific servers<br> Example: <code>[{&quot;type&quot;:&quot;offline&quot;,&quot;duration&quot;:10, &quot;cover&quot;:0, &quot;ignore&quot;:{&quot;5&quot;: true}}]</code></li></ul></li><li><code>ignore</code>: Select specific servers to exclude, used with <code>cover</code>, content is server ID and boolean value, e.g., <code>{&quot;1&quot;: true, &quot;2&quot;: false}</code></li></ul><p><strong>Complete Examples:</strong></p><p>Add an offline notification:</p><ul><li>Name: Offline Notification</li><li>Rule: <code>[{&quot;Type&quot;:&quot;offline&quot;,&quot;Duration&quot;:10}]</code></li><li>Enabled: √</li></ul><p>Add an notification for CPU usage exceeding 50% for 10 seconds <strong>and</strong> memory usage below 20% for 20 seconds:</p><ul><li>Name: CPU+Memory</li><li>Rule: <code>[{&quot;Type&quot;:&quot;cpu&quot;,&quot;Min&quot;:0,&quot;Max&quot;:50,&quot;Duration&quot;:10},{&quot;Type&quot;:&quot;memory&quot;,&quot;Min&quot;:20,&quot;Max&quot;:0,&quot;Duration&quot;:20}]</code></li><li>Enabled: √</li></ul><p>Send notifications for specific servers to specific notification groups:</p><p>Scenario example:<br> There are 4 servers (1, 2, 3, 4) and two notification groups (A, B).<br> Notify group A if servers 1 and 2 are offline for 10 minutes.<br> Notify group B if servers 3 and 4 are offline for 10 minutes.</p><p>First, set up notification groups A and B, then add two notification rules:</p><p><strong>Rule 1:</strong></p><ul><li>Name: 1, 2 Offline, Send to Notification Group A</li><li>Rule: <code>[{&quot;type&quot;:&quot;offline&quot;,&quot;duration&quot;:600,&quot;cover&quot;:1,&quot;ignore&quot;:{&quot;1&quot;:true,&quot;2&quot;:true}}]</code></li><li>Notification Group: A</li><li>Enabled: √</li></ul><p><strong>Rule 2:</strong></p><ul><li>Name: 3, 4 Offline, Send to Notification Group B</li><li>Rule: <code>[{&quot;type&quot;:&quot;offline&quot;,&quot;duration&quot;:600,&quot;cover&quot;:1,&quot;ignore&quot;:{&quot;3&quot;:true,&quot;4&quot;:true}}]</code></li><li>Notification Group: B</li><li>Enabled: √</li></ul><p><strong>Flexibly using parameters can make your notification function fully utilized</strong></p><h3 id="special-any-cycle-traffic-notification" tabindex="-1">Special: Any Cycle Traffic notification <a class="header-anchor" href="#special-any-cycle-traffic-notification" aria-label="Permalink to &quot;Special: Any Cycle Traffic notification&quot;">​</a></h3><p>Can be used for monthly traffic monitoring</p><ul><li><code>type</code>: <ul><li><code>transfer_in_cycle</code> inbound traffic during the cycle</li><li><code>transfer_out_cycle</code> outbound traffic during the cycle</li><li><code>transfer_all_cycle</code> total traffic during the cycle</li></ul></li><li><code>cycle_start</code>: The start date of the statisticaLine truncated
+<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></li></ul><p>You can remove or add relevant information as needed.</p></details><h3 id="matrix-notification-example" tabindex="-1">Matrix Notification Example <a class="header-anchor" href="#matrix-notification-example" aria-label="Permalink to &quot;Matrix Notification Example&quot;">​</a></h3><details><summary>Click to expand/collapse</summary><h4 id="parameter-explanation" tabindex="-1">Parameter Explanation <a class="header-anchor" href="#parameter-explanation" aria-label="Permalink to &quot;Parameter Explanation&quot;">​</a></h4><ul><li>All variables starting with <code>$</code> need to be replaced with your actual values. <ul><li><strong><code>YOUR_HOME_SERVER</code></strong>: The address of your Matrix server.</li><li><strong><code>YOUR_NEZHA_URL</code></strong>: The URL of your Nezha dashboard.</li><li><strong><code>YOUR_MATRIX_USERNAME</code></strong> and <strong><code>YOUR_MATRIX_PASSWD</code></strong>: Your Matrix username and password.</li><li><strong><code>YOUR_MATRIX_TOKEN</code></strong> retrieval method:<div class="language-sh vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">sh</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -XPOST</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -d</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &#39;{&quot;type&quot;: &quot;m.login.password&quot;, &quot;identifier&quot;: {&quot;user&quot;: &quot;$YOUR_MATRIX_USERNAME&quot;, &quot;type&quot;: &quot;m.id.user&quot;}, &quot;password&quot;: &quot;$YOUR_MATRIX_PASSWD&quot;}&#39;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;https://</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">$YOUR_HOME_SERVER</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">/_matrix/client/r0/login&quot;</span></span></code></pre></div></li></ul></li></ul><h4 id="request-configuration" tabindex="-1">Request Configuration <a class="header-anchor" href="#request-configuration" aria-label="Permalink to &quot;Request Configuration&quot;">​</a></h4><ul><li><strong>Name</strong>: Matrix</li><li><strong>URL</strong>: <code>https://$YOUR_HOME_SERVER/_matrix/client/r0/rooms/$ROOM_ID/send/m.room.message</code></li><li><strong>Request Method</strong>: <code>POST</code></li><li><strong>Request Type</strong>: <code>JSON</code></li><li><strong>Header</strong>:<div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
+<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">  &quot;Authorization&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;Bearer $YOUR_MATRIX_TOKEN&quot;</span></span>
+<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></li><li><strong>Body</strong>:<div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
+<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">  &quot;msgtype&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;m.text&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
+<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">  &quot;format&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;org.matrix.custom.html&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
+<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">  &quot;formatted_body&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;&lt;html&gt;&lt;head&gt;&lt;title&gt;Nezha Dashboard&lt;/title&gt;&lt;/head&gt;&lt;body&gt;&lt;h1&gt;&lt;a href=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">$YOUR_NEZHA_URL</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> target=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">_blank</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\\&quot;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&gt;Nezha Dashboard&lt;/a&gt;&lt;/h1&gt;&lt;ul&gt;&lt;li&gt;datetime: #DATETIME#&lt;/li&gt;&lt;li&gt;Message: #NEZHA#&lt;/li&gt;&lt;/ul&gt;&lt;/body&gt;&lt;/html&gt;&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
+<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">  &quot;body&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;#NEZHA#&quot;</span></span>
+<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></li></ul><h4 id="usage-steps" tabindex="-1">Usage Steps <a class="header-anchor" href="#usage-steps" aria-label="Permalink to &quot;Usage Steps&quot;">​</a></h4><ol><li><strong>Replace Variables</strong>: Replace <code>$YOUR_HOME_SERVER</code>, <code>$YOUR_NEZHA_URL</code>, <code>$YOUR_MATRIX_USERNAME</code>, <code>$YOUR_MATRIX_PASSWD</code>, and <code>$YOUR_MATRIX_TOKEN</code> with your own values.</li><li><strong>Retrieve Token</strong>: Use the <code>curl</code> command provided above to get <code>YOUR_MATRIX_TOKEN</code>, making sure to replace all relevant variables.</li><li><strong>Configure Request</strong>: Set up your request using the configuration provided above, ensuring the correct URL, headers, and body are used.</li><li><strong>Send Notification</strong>: Send the Matrix message using the configured request to integrate Nezha monitoring notifications into your Matrix room.</li></ol><p>Once configured, you will receive formatted Nezha dashboard information in your Matrix room whenever a notification is triggered.</p></details><h2 id="notification-rule-explanation" tabindex="-1">Notification Rule Explanation <a class="header-anchor" href="#notification-rule-explanation" aria-label="Permalink to &quot;Notification Rule Explanation&quot;">​</a></h2><h3 id="basic-rules" tabindex="-1">Basic Rules <a class="header-anchor" href="#basic-rules" aria-label="Permalink to &quot;Basic Rules&quot;">​</a></h3><ul><li><code>type</code>: You can choose one or more types. If multiple types are selected in one rule, <strong>all selected types must be satisfied</strong> to trigger a notification (refer to the examples below) <ul><li><code>cpu</code>, <code>gpu</code>, <code>memory</code>, <code>swap</code>, <code>disk</code></li><li><code>net_in_speed</code> inbound network speed, <code>net_out_speed</code> outbound network speed, <code>net_all_speed</code> total network speed, <code>transfer_in</code> inbound traffic, <code>transfer_out</code> outbound traffic, <code>transfer_all</code> total traffic</li><li><code>offline</code> offline monitoring</li><li><code>load1</code>, <code>load5</code>, <code>load15</code> load</li><li><code>process_count</code> process count (currently resource-intensive due to thread count, not supported temporarily)</li><li><code>tcp_conn_count</code>, <code>udp_conn_count</code> connection count</li><li><code>temperature_max</code> maximum temperature</li></ul></li><li><code>duration</code>: Duration in seconds. An notification is triggered if 30% or more of the samples exceed the threshold within this duration (to prevent data spikes).</li><li><code>min</code> or <code>max</code>: <ul><li>For traffic and network speed, the unit is bytes (1KB = 1024B, 1MB = 1024 * 1024B)</li><li>For memory, disk, and CPU, the unit is percentage</li><li>No need to set this for offline monitoring</li></ul></li><li><code>cover</code>: <ul><li><code>0</code> monitors all servers, use <code>ignore</code> to exclude specific servers</li><li><code>1</code> ignores all servers, use <code>ignore</code> to monitor specific servers<br> Example: <code>[{&quot;type&quot;:&quot;offline&quot;,&quot;duration&quot;:10, &quot;cover&quot;:0, &quot;ignore&quot;:{&quot;5&quot;: true}}]</code></li></ul></li><li><code>ignore</code>: Select specific servers to exclude, used with <code>cover</code>, content is server ID and boolean value, e.g., <code>{&quot;1&quot;: true, &quot;2&quot;: false}</code></li></ul><p><strong>Complete Examples:</strong></p><p>Add an offline notification:</p><ul><li>Name: Offline Notification</li><li>Rule: <code>[{&quot;Type&quot;:&quot;offline&quot;,&quot;Duration&quot;:10}]</code></li><li>Enabled: √</li></ul><p>Add an notification for CPU usage exceeding 50% for 10 seconds <strong>and</strong> memory usage below 20% for 20 seconds:</p><ul><li>Name: CPU+Memory</li><li>Rule: <code>[{&quot;Type&quot;:&quot;cpu&quot;,&quot;Min&quot;:0,&quot;Max&quot;:50,&quot;Duration&quot;:10},{&quot;Type&quot;:&quot;memory&quot;,&quot;Min&quot;:20,&quot;Max&quot;:0,&quot;Duration&quot;:20}]</code></li><li>Enabled: √</li></ul><p>Send notifications for specific servers to specific notification groups:</p><p>Scenario example:<br> There are 4 servers (1, 2, 3, 4) and two notification groups (A, B).<br> Notify group A if servers 1 and 2 are offline for 10 minutes.<br> Notify group B if servers 3 and 4 are offline for 10 minutes.</p><p>First, set up notification groups A and B, then add two notification rules:</p><p><strong>Rule 1:</strong></p><ul><li>Name: 1, 2 Offline, Send to Notification Group A</li><li>Rule: <code>[{&quot;type&quot;:&quot;offline&quot;,&quot;duration&quot;:600,&quot;cover&quot;:1,&quot;ignore&quot;:{&quot;1&quot;:true,&quot;2&quot;:true}}]</code></li><li>Notification Group: A</li><li>Enabled: √</li></ul><p><strong>Rule 2:</strong></p><ul><li>Name: 3, 4 Offline, Send to NotificLine truncated

assets/en_US_guide_notifications.md.DzEMZ4fM.lean.js

@@ -1 +1 @@
-import{_ as i,c as s,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const E=JSON.parse('{"title":"Notification Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1725160726000}'),e={name:"en_US/guide/notifications.md"},n=a("",45),o=[n];function l(h,r,p,k,d,u){return t(),s("div",null,o)}const g=i(e,[["render",l]]);export{E as __pageData,g as default};
+import{_ as i,c as s,o as t,a4 as a}from"./chunks/framework.BmdFiWrL.js";const E=JSON.parse('{"title":"Notification Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1728186808000}'),e={name:"en_US/guide/notifications.md"},n=a("",47),o=[n];function l(h,r,p,k,d,u){return t(),s("div",null,o)}const g=i(e,[["render",l]]);export{E as __pageData,g as default};

assets/en_US_guide_q10.md.CwW53nPW.js

@@ -1,4 +1,4 @@
-import{_ as i,c as s,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Configuring OIDC Authentication","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q10.md","filePath":"en_US/guide/q10.md","lastUpdated":1725160726000}'),n={name:"en_US/guide/q10.md"},t=e(`<h1 id="configuring-oidc-authentication" tabindex="-1">Configuring OIDC Authentication <a class="header-anchor" href="#configuring-oidc-authentication" aria-label="Permalink to &quot;Configuring OIDC Authentication&quot;">​</a></h1><p>Modify the contents of <code>config.yaml</code> to configure OIDC (OpenID Connect) authentication. OIDC is an authentication layer on top of the OAuth 2.0 protocol, which allows applications to verify the identity of users based on the authentication performed by an Authorization Server. This method is widely used to implement single sign-on for modern applications.</p><h2 id="configuration-details" tabindex="-1">Configuration Details <a class="header-anchor" href="#configuration-details" aria-label="Permalink to &quot;Configuration Details&quot;">​</a></h2><p>Here is a step-by-step guide to configuring the OIDC settings in your <code>config.yaml</code>:</p><div class="language-yaml vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">yaml</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">oauth2</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
+import{_ as i,c as s,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Configuring OIDC Authentication","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q10.md","filePath":"en_US/guide/q10.md","lastUpdated":1728186808000}'),n={name:"en_US/guide/q10.md"},t=e(`<h1 id="configuring-oidc-authentication" tabindex="-1">Configuring OIDC Authentication <a class="header-anchor" href="#configuring-oidc-authentication" aria-label="Permalink to &quot;Configuring OIDC Authentication&quot;">​</a></h1><p>Modify the contents of <code>config.yaml</code> to configure OIDC (OpenID Connect) authentication. OIDC is an authentication layer on top of the OAuth 2.0 protocol, which allows applications to verify the identity of users based on the authentication performed by an Authorization Server. This method is widely used to implement single sign-on for modern applications.</p><h2 id="configuration-details" tabindex="-1">Configuration Details <a class="header-anchor" href="#configuration-details" aria-label="Permalink to &quot;Configuration Details&quot;">​</a></h2><p>Here is a step-by-step guide to configuring the OIDC settings in your <code>config.yaml</code>:</p><div class="language-yaml vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">yaml</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">oauth2</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
 <span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">  type</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">oidc</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">  # (Required) Specifies the authentication type as OIDC</span></span>
 <span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">  oidcDisplayName</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">OIDC</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">  # (Optional, default: OIDC) The name displayed on the login page</span></span>
 <span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">  admin</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;&quot;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">  # (Fill at least one of admin or adminGroups; default: empty) Admin usernames, separated by commas. Users listed here are considered administrators</span></span>

assets/en_US_guide_q10.md.CwW53nPW.lean.js

@@ -1 +1 @@
-import{_ as i,c as s,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Configuring OIDC Authentication","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q10.md","filePath":"en_US/guide/q10.md","lastUpdated":1725160726000}'),n={name:"en_US/guide/q10.md"},t=e("",5),l=[t];function h(p,o,r,d,k,c){return a(),s("div",null,l)}const y=i(n,[["render",h]]);export{u as __pageData,y as default};
+import{_ as i,c as s,o as a,a4 as e}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Configuring OIDC Authentication","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q10.md","filePath":"en_US/guide/q10.md","lastUpdated":1728186808000}'),n={name:"en_US/guide/q10.md"},t=e("",5),l=[t];function h(p,o,r,d,k,c){return a(),s("div",null,l)}const y=i(n,[["render",h]]);export{u as __pageData,y as default};

assets/en_US_guide_q11.md.C4WENyG_.js

@@ -1,4 +1,4 @@
-import{_ as s,c as i,o as a,a4 as t}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Customize GeoIP database","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q11.md","filePath":"en_US/guide/q11.md","lastUpdated":1725160726000}'),n={name:"en_US/guide/q11.md"},e=t(`<h1 id="customize-geoip-database" tabindex="-1">Customize GeoIP database <a class="header-anchor" href="#customize-geoip-database" aria-label="Permalink to &quot;Customize GeoIP database&quot;">​</a></h1><p>Dashboard v0.18.3+ uses an embedded GeoIP database to query IP locations. An IPinfo format mmdb database is required to be placed at <code>pkg/geoip/geoip.db</code> to compile the Dashboard with working GeoIP queries.</p><p>An IPinfo format mmdb is constructed by those fields:</p><ul><li>An IP subnet as an entry</li><li><code>continent</code>：Continent code</li><li><code>continent_name</code>：Continent name</li><li><code>country</code>：Country code</li><li><code>country_name</code>：Country name</li></ul><p>Dashboard only requires the <code>country</code> field, and other fields can be left empty.</p><h2 id="editing-database" tabindex="-1">Editing database <a class="header-anchor" href="#editing-database" aria-label="Permalink to &quot;Editing database&quot;">​</a></h2><p>It is recommended to use <code>mmdbwriter</code> and <code>maxminddb-golang</code> libraries for editing mmdb databases as of now.</p><p>If your goal is to correct geographic information, it is recommended to modify directly based on the original IPinfo database. For similar operations, you can refer to the <a href="https://github.com/SagerNet/sing-geoip" target="_blank" rel="noreferrer">sing-geoip</a> project.</p><p>Using the correction of IPinfo data as an example, you need to use the <code>ReplaceWith</code> inserter (which is the default value) and write the <code>mmdbtype.Map</code> information:</p><div class="language-go vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">go</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">subnet </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:=</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> &amp;</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">net</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">IPNet</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
+import{_ as s,c as i,o as a,a4 as t}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Customize GeoIP database","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q11.md","filePath":"en_US/guide/q11.md","lastUpdated":1728186808000}'),n={name:"en_US/guide/q11.md"},e=t(`<h1 id="customize-geoip-database" tabindex="-1">Customize GeoIP database <a class="header-anchor" href="#customize-geoip-database" aria-label="Permalink to &quot;Customize GeoIP database&quot;">​</a></h1><p>Dashboard v0.18.3+ uses an embedded GeoIP database to query IP locations. An IPinfo format mmdb database is required to be placed at <code>pkg/geoip/geoip.db</code> to compile the Dashboard with working GeoIP queries.</p><p>An IPinfo format mmdb is constructed by those fields:</p><ul><li>An IP subnet as an entry</li><li><code>continent</code>：Continent code</li><li><code>continent_name</code>：Continent name</li><li><code>country</code>：Country code</li><li><code>country_name</code>：Country name</li></ul><p>Dashboard only requires the <code>country</code> field, and other fields can be left empty.</p><h2 id="editing-database" tabindex="-1">Editing database <a class="header-anchor" href="#editing-database" aria-label="Permalink to &quot;Editing database&quot;">​</a></h2><p>It is recommended to use <code>mmdbwriter</code> and <code>maxminddb-golang</code> libraries for editing mmdb databases as of now.</p><p>If your goal is to correct geographic information, it is recommended to modify directly based on the original IPinfo database. For similar operations, you can refer to the <a href="https://github.com/SagerNet/sing-geoip" target="_blank" rel="noreferrer">sing-geoip</a> project.</p><p>Using the correction of IPinfo data as an example, you need to use the <code>ReplaceWith</code> inserter (which is the default value) and write the <code>mmdbtype.Map</code> information:</p><div class="language-go vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">go</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">subnet </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:=</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> &amp;</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">net</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">IPNet</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">    IP:   net.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">ParseIP</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;114.5.1.4&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">    Mask: net.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">CIDRMask</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">32</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">32</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
 <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span>

assets/en_US_guide_q11.md.C4WENyG_.lean.js

@@ -1 +1 @@
-import{_ as s,c as i,o as a,a4 as t}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Customize GeoIP database","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q11.md","filePath":"en_US/guide/q11.md","lastUpdated":1725160726000}'),n={name:"en_US/guide/q11.md"},e=t("",15),h=[e];function p(l,k,d,r,o,E){return a(),i("div",null,h)}const y=s(n,[["render",p]]);export{c as __pageData,y as default};
+import{_ as s,c as i,o as a,a4 as t}from"./chunks/framework.BmdFiWrL.js";const c=JSON.parse('{"title":"Customize GeoIP database","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q11.md","filePath":"en_US/guide/q11.md","lastUpdated":1728186808000}'),n={name:"en_US/guide/q11.md"},e=t("",15),h=[e];function p(l,k,d,r,o,E){return a(),i("div",null,h)}const y=s(n,[["render",p]]);export{c as __pageData,y as default};

assets/en_US_guide_q2.md.Bjwldk7H.js

@@ -1 +1 @@
-import{_ as e,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Agent Startup/Online Troubleshooting Process","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q2.md","filePath":"en_US/guide/q2.md","lastUpdated":1725160726000}'),r={name:"en_US/guide/q2.md"},a=n('<h1 id="agent-startup-online-troubleshooting-process" tabindex="-1">Agent Startup/Online Troubleshooting Process <a class="header-anchor" href="#agent-startup-online-troubleshooting-process" aria-label="Permalink to &quot;Agent Startup/Online Troubleshooting Process&quot;">​</a></h1><ol><li>Directly execute <code>/opt/nezha/agent/nezha-agent -s DashboardIP or non-CDN domain:RPCPort -p AgentKey -d</code> to check if the logs indicate timeouts due to DNS or poor network conditions.</li><li>Use <code>nc -v Domain/IP RPCPort</code> or <code>telnet Domain/IP RPCPort</code> to check for network issues, inspect the inbound and outbound firewalls of the local machine and the panel server. If you cannot determine the issue, you can use the port checking tool provided by <a href="https://port.ping.pe/" target="_blank" rel="noreferrer">https://port.ping.pe/</a>.</li><li>If the above steps indicate no issues but the Agent still does not go online correctly, try disabling SELinux. <a href="https://www.google.com/search?q=disable+SELINUX" target="_blank" rel="noreferrer">How to disable SELinux?</a></li></ol>',2),s=[a];function i(c,l,d,h,p,u){return o(),t("div",null,s)}const f=e(r,[["render",i]]);export{g as __pageData,f as default};
+import{_ as e,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Agent Startup/Online Troubleshooting Process","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q2.md","filePath":"en_US/guide/q2.md","lastUpdated":1728186808000}'),r={name:"en_US/guide/q2.md"},a=n('<h1 id="agent-startup-online-troubleshooting-process" tabindex="-1">Agent Startup/Online Troubleshooting Process <a class="header-anchor" href="#agent-startup-online-troubleshooting-process" aria-label="Permalink to &quot;Agent Startup/Online Troubleshooting Process&quot;">​</a></h1><ol><li>Directly execute <code>/opt/nezha/agent/nezha-agent -s DashboardIP or non-CDN domain:RPCPort -p AgentKey -d</code> to check if the logs indicate timeouts due to DNS or poor network conditions.</li><li>Use <code>nc -v Domain/IP RPCPort</code> or <code>telnet Domain/IP RPCPort</code> to check for network issues, inspect the inbound and outbound firewalls of the local machine and the panel server. If you cannot determine the issue, you can use the port checking tool provided by <a href="https://port.ping.pe/" target="_blank" rel="noreferrer">https://port.ping.pe/</a>.</li><li>If the above steps indicate no issues but the Agent still does not go online correctly, try disabling SELinux. <a href="https://www.google.com/search?q=disable+SELINUX" target="_blank" rel="noreferrer">How to disable SELinux?</a></li></ol>',2),s=[a];function i(c,l,d,h,p,u){return o(),t("div",null,s)}const f=e(r,[["render",i]]);export{g as __pageData,f as default};

assets/en_US_guide_q2.md.Bjwldk7H.lean.js

@@ -1 +1 @@
-import{_ as e,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Agent Startup/Online Troubleshooting Process","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q2.md","filePath":"en_US/guide/q2.md","lastUpdated":1725160726000}'),r={name:"en_US/guide/q2.md"},a=n("",2),s=[a];function i(c,l,d,h,p,u){return o(),t("div",null,s)}const f=e(r,[["render",i]]);export{g as __pageData,f as default};
+import{_ as e,c as t,o,a4 as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Agent Startup/Online Troubleshooting Process","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q2.md","filePath":"en_US/guide/q2.md","lastUpdated":1728186808000}'),r={name:"en_US/guide/q2.md"},a=n("",2),s=[a];function i(c,l,d,h,p,u){return o(),t("div",null,s)}const f=e(r,[["render",i]]);export{g as __pageData,f as default};

assets/en_US_guide_q3.md.NNjIgGbh.js

@@ -1,4 +1,4 @@
-import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const E=JSON.parse('{"title":"Reverse Proxy gRPC Port (Supports Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q3.md","filePath":"en_US/guide/q3.md","lastUpdated":1725160726000}'),t={name:"en_US/guide/q3.md"},l=n(`<h1 id="reverse-proxy-grpc-port-supports-cloudflare-cdn" tabindex="-1">Reverse Proxy gRPC Port (Supports Cloudflare CDN) <a class="header-anchor" href="#reverse-proxy-grpc-port-supports-cloudflare-cdn" aria-label="Permalink to &quot;Reverse Proxy gRPC Port (Supports Cloudflare CDN)&quot;">​</a></h1><p>Using Nginx or Caddy to reverse proxy gRPC</p><ul><li>Nginx Configuration</li></ul><div class="language-nginx vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">nginx</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">server</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
+import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const E=JSON.parse('{"title":"Reverse Proxy gRPC Port (Supports Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q3.md","filePath":"en_US/guide/q3.md","lastUpdated":1728186808000}'),t={name:"en_US/guide/q3.md"},l=n(`<h1 id="reverse-proxy-grpc-port-supports-cloudflare-cdn" tabindex="-1">Reverse Proxy gRPC Port (Supports Cloudflare CDN) <a class="header-anchor" href="#reverse-proxy-grpc-port-supports-cloudflare-cdn" aria-label="Permalink to &quot;Reverse Proxy gRPC Port (Supports Cloudflare CDN)&quot;">​</a></h1><p>Using Nginx or Caddy to reverse proxy gRPC</p><ul><li>Nginx Configuration</li></ul><div class="language-nginx vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">nginx</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">server</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
 <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">    listen </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">443</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ssl http2;</span></span>
 <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">    listen </span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[::]:443 ssl http2;</span></span>
 <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">    server_name </span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">data.example.com; </span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Your domain that the Agent uses to connect to the Dashboard</span></span>

assets/en_US_guide_q3.md.NNjIgGbh.lean.js

@@ -1 +1 @@
-import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const E=JSON.parse('{"title":"Reverse Proxy gRPC Port (Supports Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q3.md","filePath":"en_US/guide/q3.md","lastUpdated":1725160726000}'),t={name:"en_US/guide/q3.md"},l=n("",15),p=[l];function e(h,k,r,d,o,g){return a(),i("div",null,p)}const y=s(t,[["render",e]]);export{E as __pageData,y as default};
+import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const E=JSON.parse('{"title":"Reverse Proxy gRPC Port (Supports Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q3.md","filePath":"en_US/guide/q3.md","lastUpdated":1728186808000}'),t={name:"en_US/guide/q3.md"},l=n("",15),p=[l];function e(h,k,r,d,o,g){return a(),i("div",null,p)}const y=s(t,[["render",e]]);export{E as __pageData,y as default};

assets/en_US_guide_q4.md.DdZdNi_N.js

@@ -1 +1 @@
-import{_ as a,c as t,o,j as e,a as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Real-Time Channel Disconnection","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md","filePath":"en_US/guide/q4.md","lastUpdated":1725160726000}'),r={name:"en_US/guide/q4.md"},i=e("h1",{id:"real-time-channel-disconnection",tabindex:"-1"},[n("Real-Time Channel Disconnection "),e("a",{class:"header-anchor",href:"#real-time-channel-disconnection","aria-label":'Permalink to "Real-Time Channel Disconnection"'},"​")],-1),s=e("ul",null,[e("li",null,"If you are using a CDN, ensure that the CDN provider offers WebSocket services and that WebSocket is enabled."),e("li",null,[n("Confirm that your reverse proxy rules have special configurations for the "),e("code",null,"/ws"),n(" and "),e("code",null,"/terminal"),n(" paths. You can "),e("a",{href:"/en_US/guide/dashboard.html#configure-reverse-proxy"},"click here"),n(" to view the reverse proxy configuration.")])],-1),c=[i,s];function l(d,h,u,_,f,m){return o(),t("div",null,c)}const v=a(r,[["render",l]]);export{g as __pageData,v as default};
+import{_ as a,c as t,o,j as e,a as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Real-Time Channel Disconnection","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md","filePath":"en_US/guide/q4.md","lastUpdated":1728186808000}'),r={name:"en_US/guide/q4.md"},i=e("h1",{id:"real-time-channel-disconnection",tabindex:"-1"},[n("Real-Time Channel Disconnection "),e("a",{class:"header-anchor",href:"#real-time-channel-disconnection","aria-label":'Permalink to "Real-Time Channel Disconnection"'},"​")],-1),s=e("ul",null,[e("li",null,"If you are using a CDN, ensure that the CDN provider offers WebSocket services and that WebSocket is enabled."),e("li",null,[n("Confirm that your reverse proxy rules have special configurations for the "),e("code",null,"/ws"),n(" and "),e("code",null,"/terminal"),n(" paths. You can "),e("a",{href:"/en_US/guide/dashboard.html#configure-reverse-proxy"},"click here"),n(" to view the reverse proxy configuration.")])],-1),c=[i,s];function l(d,h,u,_,f,m){return o(),t("div",null,c)}const v=a(r,[["render",l]]);export{g as __pageData,v as default};

assets/en_US_guide_q4.md.DdZdNi_N.lean.js

@@ -1 +1 @@
-import{_ as a,c as t,o,j as e,a as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Real-Time Channel Disconnection","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md","filePath":"en_US/guide/q4.md","lastUpdated":1725160726000}'),r={name:"en_US/guide/q4.md"},i=e("h1",{id:"real-time-channel-disconnection",tabindex:"-1"},[n("Real-Time Channel Disconnection "),e("a",{class:"header-anchor",href:"#real-time-channel-disconnection","aria-label":'Permalink to "Real-Time Channel Disconnection"'},"​")],-1),s=e("ul",null,[e("li",null,"If you are using a CDN, ensure that the CDN provider offers WebSocket services and that WebSocket is enabled."),e("li",null,[n("Confirm that your reverse proxy rules have special configurations for the "),e("code",null,"/ws"),n(" and "),e("code",null,"/terminal"),n(" paths. You can "),e("a",{href:"/en_US/guide/dashboard.html#configure-reverse-proxy"},"click here"),n(" to view the reverse proxy configuration.")])],-1),c=[i,s];function l(d,h,u,_,f,m){return o(),t("div",null,c)}const v=a(r,[["render",l]]);export{g as __pageData,v as default};
+import{_ as a,c as t,o,j as e,a as n}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Real-Time Channel Disconnection","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md","filePath":"en_US/guide/q4.md","lastUpdated":1728186808000}'),r={name:"en_US/guide/q4.md"},i=e("h1",{id:"real-time-channel-disconnection",tabindex:"-1"},[n("Real-Time Channel Disconnection "),e("a",{class:"header-anchor",href:"#real-time-channel-disconnection","aria-label":'Permalink to "Real-Time Channel Disconnection"'},"​")],-1),s=e("ul",null,[e("li",null,"If you are using a CDN, ensure that the CDN provider offers WebSocket services and that WebSocket is enabled."),e("li",null,[n("Confirm that your reverse proxy rules have special configurations for the "),e("code",null,"/ws"),n(" and "),e("code",null,"/terminal"),n(" paths. You can "),e("a",{href:"/en_US/guide/dashboard.html#configure-reverse-proxy"},"click here"),n(" to view the reverse proxy configuration.")])],-1),c=[i,s];function l(d,h,u,_,f,m){return o(),t("div",null,c)}const v=a(r,[["render",l]]);export{g as __pageData,v as default};

assets/en_US_guide_q5.md.ChJ6wB6R.js

@@ -1 +1 @@
-import{_ as e,c as o,o as a,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"How to Perform Data Migration and Backup Recovery?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q5.md","filePath":"en_US/guide/q5.md","lastUpdated":1725160726000}'),r={name:"en_US/guide/q5.md"},n=t('<h1 id="how-to-perform-data-migration-and-backup-recovery" tabindex="-1">How to Perform Data Migration and Backup Recovery? <a class="header-anchor" href="#how-to-perform-data-migration-and-backup-recovery" aria-label="Permalink to &quot;How to Perform Data Migration and Backup Recovery?&quot;">​</a></h1><ol><li>Run the one-click script and choose <code>Stop Dashboard</code>.</li><li>On the old server, package the <code>/opt/nezha</code> folder, copy it to the same location in the new environment, and extract it.</li><li>In the new server, run the one-click script and choose <code>Start Dashboard</code>.</li></ol>',2),c=[n];function i(d,s,_,l,h,p){return a(),o("div",null,c)}const f=e(r,[["render",i]]);export{u as __pageData,f as default};
+import{_ as e,c as o,o as a,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"How to Perform Data Migration and Backup Recovery?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q5.md","filePath":"en_US/guide/q5.md","lastUpdated":1728186808000}'),r={name:"en_US/guide/q5.md"},n=t('<h1 id="how-to-perform-data-migration-and-backup-recovery" tabindex="-1">How to Perform Data Migration and Backup Recovery? <a class="header-anchor" href="#how-to-perform-data-migration-and-backup-recovery" aria-label="Permalink to &quot;How to Perform Data Migration and Backup Recovery?&quot;">​</a></h1><ol><li>Run the one-click script and choose <code>Stop Dashboard</code>.</li><li>On the old server, package the <code>/opt/nezha</code> folder, copy it to the same location in the new environment, and extract it.</li><li>In the new server, run the one-click script and choose <code>Start Dashboard</code>.</li></ol>',2),c=[n];function i(d,s,_,l,h,p){return a(),o("div",null,c)}const f=e(r,[["render",i]]);export{u as __pageData,f as default};

assets/en_US_guide_q5.md.ChJ6wB6R.lean.js

@@ -1 +1 @@
-import{_ as e,c as o,o as a,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"How to Perform Data Migration and Backup Recovery?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q5.md","filePath":"en_US/guide/q5.md","lastUpdated":1725160726000}'),r={name:"en_US/guide/q5.md"},n=t("",2),c=[n];function i(d,s,_,l,h,p){return a(),o("div",null,c)}const f=e(r,[["render",i]]);export{u as __pageData,f as default};
+import{_ as e,c as o,o as a,a4 as t}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"How to Perform Data Migration and Backup Recovery?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q5.md","filePath":"en_US/guide/q5.md","lastUpdated":1728186808000}'),r={name:"en_US/guide/q5.md"},n=t("",2),c=[n];function i(d,s,_,l,h,p){return a(),o("div",null,c)}const f=e(r,[["render",i]]);export{u as __pageData,f as default};

assets/en_US_guide_q6.md.DgNrOFKS.js

@@ -1 +1 @@
-import{_ as t,c as e,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"How to Reset Traffic Statistics Monthly?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q6.md","filePath":"en_US/guide/q6.md","lastUpdated":1725160726000}'),a={name:"en_US/guide/q6.md"},s=i('<h1 id="how-to-reset-traffic-statistics-monthly" tabindex="-1">How to Reset Traffic Statistics Monthly? <a class="header-anchor" href="#how-to-reset-traffic-statistics-monthly" aria-label="Permalink to &quot;How to Reset Traffic Statistics Monthly?&quot;">​</a></h1><p>The traffic statistics on the homepage reset every time the server restarts. To achieve a monthly reset of the traffic counter, you can do the following:</p><ol><li>Go to the <code>Notification</code> page in the management panel.</li><li>Refer to <a href="/en_US/guide/notifications.html#special-any-cycle-transfer-notification">this document</a> to create a monthly traffic notification.</li><li>Return to the homepage and go to the <code>Services</code> page, where you can see the monthly traffic statistics. The statistics here will not reset when the server restarts.</li></ol><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>This method allows you to set any period, including but not limited to hourly, daily, weekly, monthly, or yearly traffic statistics reset, offering great flexibility!</p></div>',4),c=[s];function r(n,l,h,f,d,_){return o(),e("div",null,c)}const u=t(a,[["render",r]]);export{p as __pageData,u as default};
+import{_ as t,c as e,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"How to Reset Traffic Statistics Monthly?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q6.md","filePath":"en_US/guide/q6.md","lastUpdated":1728186808000}'),a={name:"en_US/guide/q6.md"},s=i('<h1 id="how-to-reset-traffic-statistics-monthly" tabindex="-1">How to Reset Traffic Statistics Monthly? <a class="header-anchor" href="#how-to-reset-traffic-statistics-monthly" aria-label="Permalink to &quot;How to Reset Traffic Statistics Monthly?&quot;">​</a></h1><p>The traffic statistics on the homepage reset every time the server restarts. To achieve a monthly reset of the traffic counter, you can do the following:</p><ol><li>Go to the <code>Notification</code> page in the management panel.</li><li>Refer to <a href="/en_US/guide/notifications.html#special-any-cycle-transfer-notification">this document</a> to create a monthly traffic notification.</li><li>Return to the homepage and go to the <code>Services</code> page, where you can see the monthly traffic statistics. The statistics here will not reset when the server restarts.</li></ol><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>This method allows you to set any period, including but not limited to hourly, daily, weekly, monthly, or yearly traffic statistics reset, offering great flexibility!</p></div>',4),c=[s];function r(n,l,h,f,d,_){return o(),e("div",null,c)}const u=t(a,[["render",r]]);export{p as __pageData,u as default};

assets/en_US_guide_q6.md.DgNrOFKS.lean.js

@@ -1 +1 @@
-import{_ as t,c as e,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"How to Reset Traffic Statistics Monthly?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q6.md","filePath":"en_US/guide/q6.md","lastUpdated":1725160726000}'),a={name:"en_US/guide/q6.md"},s=i("",4),c=[s];function r(n,l,h,f,d,_){return o(),e("div",null,c)}const u=t(a,[["render",r]]);export{p as __pageData,u as default};
+import{_ as t,c as e,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"How to Reset Traffic Statistics Monthly?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q6.md","filePath":"en_US/guide/q6.md","lastUpdated":1728186808000}'),a={name:"en_US/guide/q6.md"},s=i("",4),c=[s];function r(n,l,h,f,d,_){return o(),e("div",null,c)}const u=t(a,[["render",r]]);export{p as __pageData,u as default};

assets/en_US_guide_q7.md.APtby8ZA.js

@@ -1 +1 @@
-import{_ as e,c as t,o as i,a4 as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Customizing Agent Monitoring Items","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q7.md","filePath":"en_US/guide/q7.md","lastUpdated":1725160726000}'),o={name:"en_US/guide/q7.md"},n=a('<h1 id="customizing-agent-monitoring-items" tabindex="-1">Customizing Agent Monitoring Items <a class="header-anchor" href="#customizing-agent-monitoring-items" aria-label="Permalink to &quot;Customizing Agent Monitoring Items&quot;">​</a></h1><h2 id="customize-monitoring-for-network-interfaces-and-disk-partitions" tabindex="-1">Customize Monitoring for Network Interfaces and Disk Partitions <a class="header-anchor" href="#customize-monitoring-for-network-interfaces-and-disk-partitions" aria-label="Permalink to &quot;Customize Monitoring for Network Interfaces and Disk Partitions&quot;">​</a></h2><p>Execute the following command to select network interfaces and partitions, then restart the Agent for changes to take effect:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">/opt/nezha/agent/nezha-agent</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> edit</span></span></code></pre></div><h2 id="additional-runtime-parameters" tabindex="-1">Additional Runtime Parameters <a class="header-anchor" href="#additional-runtime-parameters" aria-label="Permalink to &quot;Additional Runtime Parameters&quot;">​</a></h2><h3 id="viewing-supported-parameters" tabindex="-1">Viewing Supported Parameters <a class="header-anchor" href="#viewing-supported-parameters" aria-label="Permalink to &quot;Viewing Supported Parameters&quot;">​</a></h3><p>To view the supported runtime parameters, please execute the following command:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">./nezha-agent</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --help</span></span></code></pre></div><h3 id="configuring-parameters" tabindex="-1">Configuring Parameters <a class="header-anchor" href="#configuring-parameters" aria-label="Permalink to &quot;Configuring Parameters&quot;">​</a></h3><p>If you installed the Agent using a one-click script, you can add or modify parameters by editing the system service configuration. Edit the file <code>/etc/systemd/system/nezha-agent.service</code> and append your desired parameters at the end of the <code>ExecStart=</code> line:</p><ul><li><code>--report-delay</code>: Sets the interval for reporting system information. The default is 1 second. To reduce system resource usage, you can set this to 3 (valid range: 1-4 seconds).</li><li><code>--skip-conn</code>: Disables monitoring of network connections. Recommended for servers with high numbers of connections or high CPU usage.</li><li><code>--skip-procs</code>: Disables monitoring of process counts, helping to reduce resource usage of the Agent.</li><li><code>--disable-auto-update</code>: Disables the <strong>automatic update</strong> feature of the Agent, enhancing security.</li><li><code>--disable-force-update</code>: Disables the <strong>forced update</strong> feature of the Agent, enhancing security.</li><li><code>--disable-command-execute</code>: Prevents execution of any scheduled tasks or use of the WebSSH on the Agent, enhancing security.</li><li><code>--tls</code>: Enables SSL/TLS encryption. This should be enabled when you are using nginx to reverse proxy the Agent&#39;s gRPC connections and nginx is configured with SSL/TLS.</li><li><code>--use-ipv6-countrycode</code>: Forces the use of IPv6 addresses to query country codes. By default, the Agent uses IPv4 addresses to query country codes. If server supports IPv6 and the country code of the IPv4 address is different, can use this parameter.</li><li><code>--gpu</code>: Enables GPU monitoring. Note: Monitoring GPU usage may require installation of additional dependencies. For more details, refer to the documentation: <a href="/en_US/guide/q9.html">Enable GPU Monitoring</a>.</li><li><code>--temperature</code>: Enables hardware temperature monitoring. Only effective on supported hardware, some VPS may not be able to retrieve temperature information.</li><li><code>-d</code> <code>--debug</code>: Enables debug mode.</li><li><code>-u</code> <code>--ip-report-period</code>: Set IP update interval. Is only effective when the set value is higher than <code>--report-delay</code>. The default is 1800 seconds.</li><li><code>-k</code> <code>--insecure</code>: Disable TLS certificate intLine truncated
+import{_ as e,c as t,o as i,a4 as a}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Customizing Agent Monitoring Items","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q7.md","filePath":"en_US/guide/q7.md","lastUpdated":1728186808000}'),o={name:"en_US/guide/q7.md"},n=a('<h1 id="customizing-agent-monitoring-items" tabindex="-1">Customizing Agent Monitoring Items <a class="header-anchor" href="#customizing-agent-monitoring-items" aria-label="Permalink to &quot;Customizing Agent Monitoring Items&quot;">​</a></h1><h2 id="customize-monitoring-for-network-interfaces-and-disk-partitions" tabindex="-1">Customize Monitoring for Network Interfaces and Disk Partitions <a class="header-anchor" href="#customize-monitoring-for-network-interfaces-and-disk-partitions" aria-label="Permalink to &quot;Customize Monitoring for Network Interfaces and Disk Partitions&quot;">​</a></h2><p>Execute the following command to select network interfaces and partitions, then restart the Agent for changes to take effect:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">/opt/nezha/agent/nezha-agent</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> edit</span></span></code></pre></div><h2 id="additional-runtime-parameters" tabindex="-1">Additional Runtime Parameters <a class="header-anchor" href="#additional-runtime-parameters" aria-label="Permalink to &quot;Additional Runtime Parameters&quot;">​</a></h2><h3 id="viewing-supported-parameters" tabindex="-1">Viewing Supported Parameters <a class="header-anchor" href="#viewing-supported-parameters" aria-label="Permalink to &quot;Viewing Supported Parameters&quot;">​</a></h3><p>To view the supported runtime parameters, please execute the following command:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">./nezha-agent</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --help</span></span></code></pre></div><h3 id="configuring-parameters" tabindex="-1">Configuring Parameters <a class="header-anchor" href="#configuring-parameters" aria-label="Permalink to &quot;Configuring Parameters&quot;">​</a></h3><p>If you installed the Agent using a one-click script, you can add or modify parameters by editing the system service configuration. Edit the file <code>/etc/systemd/system/nezha-agent.service</code> and append your desired parameters at the end of the <code>ExecStart=</code> line:</p><ul><li><code>--report-delay</code>: Sets the interval for reporting system information. The default is 1 second. To reduce system resource usage, you can set this to 3 (valid range: 1-4 seconds).</li><li><code>--skip-conn</code>: Disables monitoring of network connections. Recommended for servers with high numbers of connections or high CPU usage.</li><li><code>--skip-procs</code>: Disables monitoring of process counts, helping to reduce resource usage of the Agent.</li><li><code>--disable-auto-update</code>: Disables the <strong>automatic update</strong> feature of the Agent, enhancing security.</li><li><code>--disable-force-update</code>: Disables the <strong>forced update</strong> feature of the Agent, enhancing security.</li><li><code>--disable-command-execute</code>: Prevents execution of any scheduled tasks or use of the WebSSH on the Agent, enhancing security.</li><li><code>--tls</code>: Enables SSL/TLS encryption. This should be enabled when you are using nginx to reverse proxy the Agent&#39;s gRPC connections and nginx is configured with SSL/TLS.</li><li><code>--use-ipv6-countrycode</code>: Forces the use of IPv6 addresses to query country codes. By default, the Agent uses IPv4 addresses to query country codes. If server supports IPv6 and the country code of the IPv4 address is different, can use this parameter.</li><li><code>--gpu</code>: Enables GPU monitoring. Note: Monitoring GPU usage may require installation of additional dependencies. For more details, refer to the documentation: <a href="/en_US/guide/q9.html">Enable GPU Monitoring</a>.</li><li><code>--temperature</code>: Enables hardware temperature monitoring. Only effective on supported hardware, some VPS may not be able to retrieve temperature information.</li><li><code>-d</code> <code>--debug</code>: Enables debug mode.</li><li><code>-u</code> <code>--ip-report-period</code>: Set IP update interval. Is only effective when the set value is higher than <code>--report-delay</code>. The default is 1800 seconds.</li><li><code>-k</code> <code>--insecure</code>: Disable TLS certificate intLine truncated

assets/en_US_guide_q7.md.APtby8ZA.lean.js

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

assets/en_US_guide_q8.md.mEJq9arg.js

@@ -1,4 +1,4 @@
-import{_ as e,c as i,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const f=JSON.parse('{"title":"Cloudflare Access OAuth2 Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q8.md","filePath":"en_US/guide/q8.md","lastUpdated":1725160726000}'),a={name:"en_US/guide/q8.md"},c=o(`<h1 id="cloudflare-access-oauth2-configuration" tabindex="-1">Cloudflare Access OAuth2 Configuration <a class="header-anchor" href="#cloudflare-access-oauth2-configuration" aria-label="Permalink to &quot;Cloudflare Access OAuth2 Configuration&quot;">​</a></h1><p>If you encounter issues logging in as an administrator using Github, Gitlab, or Gitee, you may consider switching to Cloudflare Access as the OAuth2 provider.</p><h2 id="example-configuration" tabindex="-1">Example Configuration: <a class="header-anchor" href="#example-configuration" aria-label="Permalink to &quot;Example Configuration:&quot;">​</a></h2><div class="language-yaml vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">yaml</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">Oauth2</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
+import{_ as e,c as i,o as t,a4 as o}from"./chunks/framework.BmdFiWrL.js";const f=JSON.parse('{"title":"Cloudflare Access OAuth2 Configuration","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q8.md","filePath":"en_US/guide/q8.md","lastUpdated":1728186808000}'),a={name:"en_US/guide/q8.md"},c=o(`<h1 id="cloudflare-access-oauth2-configuration" tabindex="-1">Cloudflare Access OAuth2 Configuration <a class="header-anchor" href="#cloudflare-access-oauth2-configuration" aria-label="Permalink to &quot;Cloudflare Access OAuth2 Configuration&quot;">​</a></h1><p>If you encounter issues logging in as an administrator using Github, Gitlab, or Gitee, you may consider switching to Cloudflare Access as the OAuth2 provider.</p><h2 id="example-configuration" tabindex="-1">Example Configuration: <a class="header-anchor" href="#example-configuration" aria-label="Permalink to &quot;Example Configuration:&quot;">​</a></h2><div class="language-yaml vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">yaml</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">Oauth2</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
 <span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">  Admin</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">701b9ea6-9f56-48cd-af3e-cbb4bfc1475c</span></span>
 <span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">  ClientID</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">3516291f53eca9b4901a01337e41be7dc52f565c8657d08a3fddb2178d13c5bf</span></span>
 <span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">  ClientSecret</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">0568b67c7b6d0ed51c663e2fe935683007c28f947a27b7bd47a5ad3d8b56fb67</span></span>

assets/en_US_guide_q8.md.mEJq9arg.lean.js

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

assets/en_US_guide_q9.md.ChDyXv2S.js

@@ -1,4 +1,4 @@
-import{_ as i,c as a,o as s,a4 as e}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Enable GPU monitoring","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q9.md","filePath":"en_US/guide/q9.md","lastUpdated":1725160726000}'),n={name:"en_US/guide/q9.md"},t=e(`<h1 id="enable-gpu-monitoring" tabindex="-1">Enable GPU monitoring <a class="header-anchor" href="#enable-gpu-monitoring" aria-label="Permalink to &quot;Enable GPU monitoring&quot;">​</a></h1><p>GPU monitoring is a new feature implemented in Nezha Monitoring v0.17.x. Before using the feature, please ensure your Dashboard version is higher than v0.17.2 and Agent version is higher than v0.17.0.</p><h2 id="enable" tabindex="-1">Enable <a class="header-anchor" href="#enable" aria-label="Permalink to &quot;Enable&quot;">​</a></h2><h3 id="from-command-line-flag" tabindex="-1">From Command-Line Flag <a class="header-anchor" href="#from-command-line-flag" aria-label="Permalink to &quot;From Command-Line Flag&quot;">​</a></h3><p>Append the <code>--gpu</code> flag to the Agent argument. For example:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">/opt/nezha/agent/nezha-agent</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -s</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> example.com:5555</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -p</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> example</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --gpu</span></span></code></pre></div><h3 id="from-configuration-file" tabindex="-1">From configuration file <a class="header-anchor" href="#from-configuration-file" aria-label="Permalink to &quot;From configuration file&quot;">​</a></h3><p>Execute the following command to modify Agent configuration to enable GPU monitoring.</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">/opt/nezha/agent/nezha-agent</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> edit</span></span></code></pre></div><p>In the interactive menu returned, choose to enable GPU monitoring.</p><h2 id="enable-gpu-utilization-monitoring" tabindex="-1">Enable GPU utilization monitoring <a class="header-anchor" href="#enable-gpu-utilization-monitoring" aria-label="Permalink to &quot;Enable GPU utilization monitoring&quot;">​</a></h2><p>GPU model and GPU utilization are two different monitor items, which uses different approaches to obtain their value.</p><p>Windows and macOS supports getting GPU utilization without extra dependencies, and support multiple graphics card brands.</p><p>Linux distros support only NVIDIA and AMD cards and need to install extra dependencies.</p><p>Below are the instructions on how to enable GPU utilization monitoring on Linux for NVIDIA / AMD graphics cards.</p><h3 id="nvidia" tabindex="-1">NVIDIA <a class="header-anchor" href="#nvidia" aria-label="Permalink to &quot;NVIDIA&quot;">​</a></h3><p>NVIDIA cards need the <code>nvidia-smi</code> utility to get GPU utilization. This utility is included in the official driver by default.</p><p>If you use unofficial drivers like <code>nouveau</code>, then it&#39;s not possible to get GPU utilization.</p><h3 id="amd" tabindex="-1">AMD <a class="header-anchor" href="#amd" aria-label="Permalink to &quot;AMD&quot;">​</a></h3><p>AMD cards need to install the open source <code>amdgpu</code> driver and the <code>rocm-smi</code> utility.</p><p>Mainstream distros have already packaged <code>rocm-smi</code>, below are commands to install the utility on these distros:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Arch Linux</span></span>
+import{_ as i,c as a,o as s,a4 as e}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Enable GPU monitoring","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q9.md","filePath":"en_US/guide/q9.md","lastUpdated":1728186808000}'),n={name:"en_US/guide/q9.md"},t=e(`<h1 id="enable-gpu-monitoring" tabindex="-1">Enable GPU monitoring <a class="header-anchor" href="#enable-gpu-monitoring" aria-label="Permalink to &quot;Enable GPU monitoring&quot;">​</a></h1><p>GPU monitoring is a new feature implemented in Nezha Monitoring v0.17.x. Before using the feature, please ensure your Dashboard version is higher than v0.17.2 and Agent version is higher than v0.17.0.</p><h2 id="enable" tabindex="-1">Enable <a class="header-anchor" href="#enable" aria-label="Permalink to &quot;Enable&quot;">​</a></h2><h3 id="from-command-line-flag" tabindex="-1">From Command-Line Flag <a class="header-anchor" href="#from-command-line-flag" aria-label="Permalink to &quot;From Command-Line Flag&quot;">​</a></h3><p>Append the <code>--gpu</code> flag to the Agent argument. For example:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">/opt/nezha/agent/nezha-agent</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -s</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> example.com:5555</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -p</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> example</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --gpu</span></span></code></pre></div><h3 id="from-configuration-file" tabindex="-1">From configuration file <a class="header-anchor" href="#from-configuration-file" aria-label="Permalink to &quot;From configuration file&quot;">​</a></h3><p>Execute the following command to modify Agent configuration to enable GPU monitoring.</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">/opt/nezha/agent/nezha-agent</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> edit</span></span></code></pre></div><p>In the interactive menu returned, choose to enable GPU monitoring.</p><h2 id="enable-gpu-utilization-monitoring" tabindex="-1">Enable GPU utilization monitoring <a class="header-anchor" href="#enable-gpu-utilization-monitoring" aria-label="Permalink to &quot;Enable GPU utilization monitoring&quot;">​</a></h2><p>GPU model and GPU utilization are two different monitor items, which uses different approaches to obtain their value.</p><p>Windows and macOS supports getting GPU utilization without extra dependencies, and support multiple graphics card brands.</p><p>Linux distros support only NVIDIA and AMD cards and need to install extra dependencies.</p><p>Below are the instructions on how to enable GPU utilization monitoring on Linux for NVIDIA / AMD graphics cards.</p><h3 id="nvidia" tabindex="-1">NVIDIA <a class="header-anchor" href="#nvidia" aria-label="Permalink to &quot;NVIDIA&quot;">​</a></h3><p>NVIDIA cards need the <code>nvidia-smi</code> utility to get GPU utilization. This utility is included in the official driver by default.</p><p>If you use unofficial drivers like <code>nouveau</code>, then it&#39;s not possible to get GPU utilization.</p><h3 id="amd" tabindex="-1">AMD <a class="header-anchor" href="#amd" aria-label="Permalink to &quot;AMD&quot;">​</a></h3><p>AMD cards need to install the open source <code>amdgpu</code> driver and the <code>rocm-smi</code> utility.</p><p>Mainstream distros have already packaged <code>rocm-smi</code>, below are commands to install the utility on these distros:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Arch Linux</span></span>
 <span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pacman</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -Sy</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> rocm-smi-lib</span></span>
 <span class="line"></span>
 <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Debian / Ubuntu</span></span>

assets/en_US_guide_q9.md.ChDyXv2S.lean.js

@@ -1 +1 @@
-import{_ as i,c as a,o as s,a4 as e}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Enable GPU monitoring","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q9.md","filePath":"en_US/guide/q9.md","lastUpdated":1725160726000}'),n={name:"en_US/guide/q9.md"},t=e("",28),l=[t];function o(h,p,d,r,c,k){return s(),a("div",null,l)}const m=i(n,[["render",o]]);export{u as __pageData,m as default};
+import{_ as i,c as a,o as s,a4 as e}from"./chunks/framework.BmdFiWrL.js";const u=JSON.parse('{"title":"Enable GPU monitoring","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/q9.md","filePath":"en_US/guide/q9.md","lastUpdated":1728186808000}'),n={name:"en_US/guide/q9.md"},t=e("",28),l=[t];function o(h,p,d,r,c,k){return s(),a("div",null,l)}const m=i(n,[["render",o]]);export{u as __pageData,m as default};

assets/en_US_guide_servers.md.ttsfzdCS.js

@@ -1,4 +1,4 @@
-import{_ as i,c as e,o as s,a4 as a}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Server Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/servers.md","filePath":"en_US/guide/servers.md","lastUpdated":1725160726000}'),t={name:"en_US/guide/servers.md"},n=a(`<h1 id="server-management" tabindex="-1">Server Management <a class="header-anchor" href="#server-management" aria-label="Permalink to &quot;Server Management&quot;">​</a></h1><h2 id="introduction" tabindex="-1">Introduction <a class="header-anchor" href="#introduction" aria-label="Permalink to &quot;Introduction&quot;">​</a></h2><p>The server section is responsible for managing Agents, forming the most fundamental part of Nezha monitoring and serving as the basis for other functionalities.</p><h2 id="adding-a-server" tabindex="-1">Adding a Server <a class="header-anchor" href="#adding-a-server" aria-label="Permalink to &quot;Adding a Server&quot;">​</a></h2><p>The first step is to add a server, where you can customize the name, group, sorting, and notes.<br> Servers in the same group will be displayed together in supported themes. Notes will only be visible in the Admin Panel, so there&#39;s no need to worry about leaking information.</p><h2 id="installing-the-agent" tabindex="-1">Installing the Agent <a class="header-anchor" href="#installing-the-agent" aria-label="Permalink to &quot;Installing the Agent&quot;">​</a></h2><p>Please refer to the previous section on <a href="/en_US/guide/agent.html">installing the Agent</a>.<br> It is recommended to use the one-click installation. After configuring the parameters, click the corresponding system icon in the <strong>one-click installation</strong> column of the server to copy the installation command and execute it on the respective server.</p><h2 id="forced-update" tabindex="-1">Forced Update <a class="header-anchor" href="#forced-update" aria-label="Permalink to &quot;Forced Update&quot;">​</a></h2><p>Agent update-related parameters include <code>--disable-auto-update</code> and <code>--disable-force-update</code> as described in <a href="/en_US/guide/q7.html">Custom Agent Monitoring Projects</a>.<br> By default, the Agent will update automatically without intervention. However, if the user disables automatic updates, you can select specific servers for a forced update.<br> The forced update will not work if <code>disable-force-update</code> is enabled.</p><h2 id="data-columns" tabindex="-1">Data Columns <a class="header-anchor" href="#data-columns" aria-label="Permalink to &quot;Data Columns&quot;">​</a></h2><ul><li>Version: Records the current version of the Agent.</li><li>Hide from Guests: When true, guests cannot see this server in the Dashboard.</li><li>Enable DDNS: When true, if the server IP changes, the Dashboard will automatically update the DNS records.</li><li>DDNS Domain: The DDNS domain configured for this server.</li><li>Secret: The secret/key used for configuring the Agent, which is used to verify communication between the Agent and the Dashboard.</li><li>One-Click Install: Click the corresponding system button to copy the command and execute it on the server for a one-click installation.</li><li>Management: Connects to WebShell, modifies server configuration, or deletes the server.</li></ul><h2 id="webssh-terminal" tabindex="-1">WebSSH Terminal <a class="header-anchor" href="#webssh-terminal" aria-label="Permalink to &quot;WebSSH Terminal&quot;">​</a></h2><p>This is WebShell; the feature will not work if <code>disable-command-execute</code> is enabled.<br> It is available for both Linux and Windows and supports Ctrl+Shift+V for pasting.<br> If the connection fails, refer to <a href="/en_US/guide/q4.html">Real-Time Channel Disconnection/Online Terminal Connection Failure</a>.</p><h2 id="fm" tabindex="-1">FM <a class="header-anchor" href="#fm" aria-label="Permalink to &quot;FM&quot;">​</a></h2><p>Added in Dashboard v0.19.1 / Agent v0.19.0. A pseudo file manager embedded in WebShell, supports file download/upload, directory navigation and copying current path. Access it by clicking the blue button in the bottom-right corner of the WebShell.</p><h2 id="ddns-functionality" tabindex="-1">DDNS Functionality <a class="header-anchor" href="#ddns-functionality" aria-label="Permalink to &quot;DDNS Functionality&quot;">​</a></h2><p>The DDNS functionality is suitable for servers with dynamic IPs. When the Agent reports a new IP, the Dashboard will automatically update the DNS records based on the configuration.</p><h3 id="why-use-nezha-monitoring-s-ddns-functionality" tabindex="-1">Why Use Nezha Monitoring&#39;s DDNS Functionality? <a class="header-anchor" href="#why-use-nezha-monitoring-s-ddns-functionality" aria-label="Permalink to &quot;Why Use Nezha Monitoring&#39;s DDNS Functionality?&quot;">​</a></h3><ul><li>Centralized management of DDNS settings instead of deploying a DDNS service on each server.</li><
Line truncated
+import{_ as i,c as e,o as s,a4 as a}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Server Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/servers.md","filePath":"en_US/guide/servers.md","lastUpdated":1728186808000}'),t={name:"en_US/guide/servers.md"},n=a(`<h1 id="server-management" tabindex="-1">Server Management <a class="header-anchor" href="#server-management" aria-label="Permalink to &quot;Server Management&quot;">​</a></h1><h2 id="introduction" tabindex="-1">Introduction <a class="header-anchor" href="#introduction" aria-label="Permalink to &quot;Introduction&quot;">​</a></h2><p>The server section is responsible for managing Agents, forming the most fundamental part of Nezha monitoring and serving as the basis for other functionalities.</p><h2 id="adding-a-server" tabindex="-1">Adding a Server <a class="header-anchor" href="#adding-a-server" aria-label="Permalink to &quot;Adding a Server&quot;">​</a></h2><p>The first step is to add a server, where you can customize the name, group, sorting, and notes.<br> Servers in the same group will be displayed together in supported themes. Notes will only be visible in the Admin Panel, so there&#39;s no need to worry about leaking information.</p><h2 id="installing-the-agent" tabindex="-1">Installing the Agent <a class="header-anchor" href="#installing-the-agent" aria-label="Permalink to &quot;Installing the Agent&quot;">​</a></h2><p>Please refer to the previous section on <a href="/en_US/guide/agent.html">installing the Agent</a>.<br> It is recommended to use the one-click installation. After configuring the parameters, click the corresponding system icon in the <strong>one-click installation</strong> column of the server to copy the installation command and execute it on the respective server.</p><h2 id="forced-update" tabindex="-1">Forced Update <a class="header-anchor" href="#forced-update" aria-label="Permalink to &quot;Forced Update&quot;">​</a></h2><p>Agent update-related parameters include <code>--disable-auto-update</code> and <code>--disable-force-update</code> as described in <a href="/en_US/guide/q7.html">Custom Agent Monitoring Projects</a>.<br> By default, the Agent will update automatically without intervention. However, if the user disables automatic updates, you can select specific servers for a forced update.<br> The forced update will not work if <code>disable-force-update</code> is enabled.</p><h2 id="data-columns" tabindex="-1">Data Columns <a class="header-anchor" href="#data-columns" aria-label="Permalink to &quot;Data Columns&quot;">​</a></h2><ul><li>Version: Records the current version of the Agent.</li><li>Hide from Guests: When true, guests cannot see this server in the Dashboard.</li><li>Enable DDNS: When true, if the server IP changes, the Dashboard will automatically update the DNS records.</li><li>DDNS Domain: The DDNS domain configured for this server.</li><li>Secret: The secret/key used for configuring the Agent, which is used to verify communication between the Agent and the Dashboard.</li><li>One-Click Install: Click the corresponding system button to copy the command and execute it on the server for a one-click installation.</li><li>Management: Connects to WebShell, modifies server configuration, or deletes the server.</li></ul><h2 id="webssh-terminal" tabindex="-1">WebSSH Terminal <a class="header-anchor" href="#webssh-terminal" aria-label="Permalink to &quot;WebSSH Terminal&quot;">​</a></h2><p>This is WebShell; the feature will not work if <code>disable-command-execute</code> is enabled.<br> It is available for both Linux and Windows and supports Ctrl+Shift+V for pasting.<br> If the connection fails, refer to <a href="/en_US/guide/q4.html">Real-Time Channel Disconnection/Online Terminal Connection Failure</a>.</p><h2 id="fm" tabindex="-1">FM <a class="header-anchor" href="#fm" aria-label="Permalink to &quot;FM&quot;">​</a></h2><p>Added in Dashboard v0.19.1 / Agent v0.19.0. A pseudo file manager embedded in WebShell, supports file download/upload, directory navigation and copying current path. Access it by clicking the blue button in the bottom-right corner of the WebShell.</p><h2 id="ddns-functionality" tabindex="-1">DDNS Functionality <a class="header-anchor" href="#ddns-functionality" aria-label="Permalink to &quot;DDNS Functionality&quot;">​</a></h2><p>The DDNS functionality is suitable for servers with dynamic IPs. When the Agent reports a new IP, the Dashboard will automatically update the DNS records based on the configuration.</p><h3 id="why-use-nezha-monitoring-s-ddns-functionality" tabindex="-1">Why Use Nezha Monitoring&#39;s DDNS Functionality? <a class="header-anchor" href="#why-use-nezha-monitoring-s-ddns-functionality" aria-label="Permalink to &quot;Why Use Nezha Monitoring&#39;s DDNS Functionality?&quot;">​</a></h3><ul><li>Centralized management of DDNS settings instead of deploying a DDNS service on each server.</li><
Line truncated
 <span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">  Enable</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">true</span></span>
 <span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">  Provider</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;webhook&quot;</span></span>
 <span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">  AccessID</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;&quot;</span></span>

assets/en_US_guide_servers.md.ttsfzdCS.lean.js

@@ -1 +1 @@
-import{_ as i,c as e,o as s,a4 as a}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Server Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/servers.md","filePath":"en_US/guide/servers.md","lastUpdated":1725160726000}'),t={name:"en_US/guide/servers.md"},n=a("",42),o=[n];function l(h,r,d,p,c,k){return s(),e("div",null,o)}const E=i(t,[["render",l]]);export{g as __pageData,E as default};
+import{_ as i,c as e,o as s,a4 as a}from"./chunks/framework.BmdFiWrL.js";const g=JSON.parse('{"title":"Server Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/servers.md","filePath":"en_US/guide/servers.md","lastUpdated":1728186808000}'),t={name:"en_US/guide/servers.md"},n=a("",42),o=[n];function l(h,r,d,p,c,k){return s(),e("div",null,o)}const E=i(t,[["render",l]]);export{g as __pageData,E as default};

assets/en_US_guide_services.md.UdqHU2eY.js

@@ -1 +1 @@
-import{_ as e,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Service Monitoring","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/services.md","filePath":"en_US/guide/services.md","lastUpdated":1725160726000}'),n={name:"en_US/guide/services.md"},a=i('<h1 id="service-monitoring" tabindex="-1">Service Monitoring <a class="header-anchor" href="#service-monitoring" aria-label="Permalink to &quot;Service Monitoring&quot;">​</a></h1><p><strong>The Services section is where you set up monitoring for external websites or servers using Agents.</strong><br><strong>Configured service monitors can be viewed on the &quot;Services&quot; page of the homepage, displaying the availability monitoring results for the past 30 days.</strong></p><h2 id="how-to-use" tabindex="-1">How to Use <a class="header-anchor" href="#how-to-use" aria-label="Permalink to &quot;How to Use&quot;">​</a></h2><p>To add a new monitor, go to the &quot;Services&quot; page in the Admin dashboard and click &quot;Add Monitor.&quot;</p><p>When adding a new service monitor, you need to set the following parameters:</p><ul><li><p><strong>Name</strong>: Customize a name.</p></li><li><p><strong>Type</strong>: Select a monitor type. Nezha Monitoring currently supports three types: &quot;HTTP-GET,&quot; &quot;ICMP-Ping,&quot; and &quot;TCP-Ping.&quot;</p></li><li><p><strong>Target</strong>: Depending on the type you choose, the method for setting the target differs:</p><ul><li><code>HTTP-GET</code>: For this type, you should enter a URL as the target, including <code>http://</code> or <code>https://</code>. <strong>If your target URL is <code>https://</code>, the SSL certificate of that URL will also be monitored. Notifications will be triggered when the SSL certificate expires or changes.</strong> Example: <a href="https://example.com" target="_blank" rel="noreferrer">https://example.com</a>.</li><li><code>ICMP-Ping</code>: For this type, you should enter a domain name or IP without a port number. Example: 1.1.1.1 or example.com.</li><li><code>TCP-Ping</code>: For this type, you should enter a domain name or IP with a port number. Example: 1.1.1.1:80 or example.com:22.</li></ul></li><li><p><strong>Request Interval</strong>: Set the interval in seconds at which the Agent requests the target.</p></li><li><p><strong>Coverage</strong>: Select a rule to determine which Agents will request the target.</p></li><li><p><strong>Specific Servers</strong>: Used in conjunction with the coverage scope, select Agents within the rule to exclude.</p></li><li><p><strong>Notification Group</strong>: Choose the notification methods you have already set up on the &quot;Notification&quot; page. <a href="/en_US/guide/notifications.html#flexible-notification-methods">Click here</a> for more details.</p></li><li><p><strong>Enable Fault Notification</strong>: Choose whether to receive fault notifications for the target as needed. The default is unchecked.</p></li></ul><p>After setting it up, click &quot;Add.&quot; Wait a moment and go to the &quot;Services&quot; page on the homepage to view the monitoring results.</p><h2 id="latency-change-notification" tabindex="-1">Latency Change Notification <a class="header-anchor" href="#latency-change-notification" aria-label="Permalink to &quot;Latency Change Notification&quot;">​</a></h2><p>Nezha Monitoring can monitor and record the latency between the Agent and the target server, sending notifications when there are significant changes. This feature helps you monitor if the server&#39;s network route has changed.</p><ul><li><strong>Enable Latency Notifications</strong>: When enabled, Notification will be sent if the latency from the Agent to the target server is greater than the <code>Maximum Latency</code> or less than the <code>Minimum Latency</code>.</li></ul><h2 id="trigger-tasks-on-notification" tabindex="-1">Trigger Tasks on Notification <a class="header-anchor" href="#trigger-tasks-on-notification" aria-label="Permalink to &quot;Trigger Tasks on Notification&quot;">​</a></h2><p>If you need to execute tasks when service monitoring Notification are triggered, you can check &quot;Enable Trigger Tasks&quot; and select the pre-configured trigger tasks in &quot;Task on Notification&quot; and &quot;Task on Recovery.&quot;</p><h2 id="network-latency-chart" tabindex="-1">Network Latency Chart <a class="header-anchor" href="#network-latency-chart" aria-label="Permalink to &quot;Network Latency Chart&quot;">​</a></h2><p>The TCP-Ping and ICMP-Ping monitoring types set in the Services page will automatically enable the monitoring chart feature. On the &quot;Network&quot; page of the homepage, you can view historical network latency charts. The data in the charts is based on the latency from the Agent to the target server. You can click the Agent&#39;s name to toggle the chart display. In the chart, you can uncheck the target server&#39;s name to hide or show Line truncated
+import{_ as e,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Service Monitoring","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/services.md","filePath":"en_US/guide/services.md","lastUpdated":1728186808000}'),n={name:"en_US/guide/services.md"},a=i('<h1 id="service-monitoring" tabindex="-1">Service Monitoring <a class="header-anchor" href="#service-monitoring" aria-label="Permalink to &quot;Service Monitoring&quot;">​</a></h1><p><strong>The Services section is where you set up monitoring for external websites or servers using Agents.</strong><br><strong>Configured service monitors can be viewed on the &quot;Services&quot; page of the homepage, displaying the availability monitoring results for the past 30 days.</strong></p><h2 id="how-to-use" tabindex="-1">How to Use <a class="header-anchor" href="#how-to-use" aria-label="Permalink to &quot;How to Use&quot;">​</a></h2><p>To add a new monitor, go to the &quot;Services&quot; page in the Admin dashboard and click &quot;Add Monitor.&quot;</p><p>When adding a new service monitor, you need to set the following parameters:</p><ul><li><p><strong>Name</strong>: Customize a name.</p></li><li><p><strong>Type</strong>: Select a monitor type. Nezha Monitoring currently supports three types: &quot;HTTP-GET,&quot; &quot;ICMP-Ping,&quot; and &quot;TCP-Ping.&quot;</p></li><li><p><strong>Target</strong>: Depending on the type you choose, the method for setting the target differs:</p><ul><li><code>HTTP-GET</code>: For this type, you should enter a URL as the target, including <code>http://</code> or <code>https://</code>. <strong>If your target URL is <code>https://</code>, the SSL certificate of that URL will also be monitored. Notifications will be triggered when the SSL certificate expires or changes.</strong> Example: <a href="https://example.com" target="_blank" rel="noreferrer">https://example.com</a>.</li><li><code>ICMP-Ping</code>: For this type, you should enter a domain name or IP without a port number. Example: 1.1.1.1 or example.com.</li><li><code>TCP-Ping</code>: For this type, you should enter a domain name or IP with a port number. Example: 1.1.1.1:80 or example.com:22.</li></ul></li><li><p><strong>Request Interval</strong>: Set the interval in seconds at which the Agent requests the target.</p></li><li><p><strong>Coverage</strong>: Select a rule to determine which Agents will request the target.</p></li><li><p><strong>Specific Servers</strong>: Used in conjunction with the coverage scope, select Agents within the rule to exclude.</p></li><li><p><strong>Notification Group</strong>: Choose the notification methods you have already set up on the &quot;Notification&quot; page. <a href="/en_US/guide/notifications.html#flexible-notification-methods">Click here</a> for more details.</p></li><li><p><strong>Enable Fault Notification</strong>: Choose whether to receive fault notifications for the target as needed. The default is unchecked.</p></li></ul><p>After setting it up, click &quot;Add.&quot; Wait a moment and go to the &quot;Services&quot; page on the homepage to view the monitoring results.</p><h2 id="latency-change-notification" tabindex="-1">Latency Change Notification <a class="header-anchor" href="#latency-change-notification" aria-label="Permalink to &quot;Latency Change Notification&quot;">​</a></h2><p>Nezha Monitoring can monitor and record the latency between the Agent and the target server, sending notifications when there are significant changes. This feature helps you monitor if the server&#39;s network route has changed.</p><ul><li><strong>Enable Latency Notifications</strong>: When enabled, Notification will be sent if the latency from the Agent to the target server is greater than the <code>Maximum Latency</code> or less than the <code>Minimum Latency</code>.</li></ul><h2 id="trigger-tasks-on-notification" tabindex="-1">Trigger Tasks on Notification <a class="header-anchor" href="#trigger-tasks-on-notification" aria-label="Permalink to &quot;Trigger Tasks on Notification&quot;">​</a></h2><p>If you need to execute tasks when service monitoring Notification are triggered, you can check &quot;Enable Trigger Tasks&quot; and select the pre-configured trigger tasks in &quot;Task on Notification&quot; and &quot;Task on Recovery.&quot;</p><h2 id="network-latency-chart" tabindex="-1">Network Latency Chart <a class="header-anchor" href="#network-latency-chart" aria-label="Permalink to &quot;Network Latency Chart&quot;">​</a></h2><p>The TCP-Ping and ICMP-Ping monitoring types set in the Services page will automatically enable the monitoring chart feature. On the &quot;Network&quot; page of the homepage, you can view historical network latency charts. The data in the charts is based on the latency from the Agent to the target server. You can click the Agent&#39;s name to toggle the chart display. In the chart, you can uncheck the target server&#39;s name to hide or show Line truncated

assets/en_US_guide_services.md.UdqHU2eY.lean.js

@@ -1 +1 @@
-import{_ as e,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Service Monitoring","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/services.md","filePath":"en_US/guide/services.md","lastUpdated":1725160726000}'),n={name:"en_US/guide/services.md"},a=i("",16),r=[a];function s(c,h,l,g,d,u){return o(),t("div",null,r)}const f=e(n,[["render",s]]);export{m as __pageData,f as default};
+import{_ as e,c as t,o,a4 as i}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Service Monitoring","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/services.md","filePath":"en_US/guide/services.md","lastUpdated":1728186808000}'),n={name:"en_US/guide/services.md"},a=i("",16),r=[a];function s(c,h,l,g,d,u){return o(),t("div",null,r)}const f=e(n,[["render",s]]);export{m as __pageData,f as default};

assets/en_US_guide_settings.md.B9nzENlN.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":"Settings","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/settings.md","filePath":"en_US/guide/settings.md","lastUpdated":1725160726000}'),h={name:"en_US/guide/settings.md"},k=n(`<h1 id="settings" tabindex="-1">Settings <a class="header-anchor" href="#settings" aria-label="Permalink to &quot;Settings&quot;">​</a></h1><h2 id="site-title" tabindex="-1">Site Title <a class="header-anchor" href="#site-title" aria-label="Permalink to &quot;Site Title&quot;">​</a></h2><p>You can customize the site title in this section.</p><h2 id="administrator-list" tabindex="-1">Administrator List <a class="header-anchor" href="#administrator-list" aria-label="Permalink to &quot;Administrator List&quot;">​</a></h2><ul><li>If you have changed your Github, Gitlab, or Gitee username, you need to update it here to avoid login issues. Separate multiple usernames with commas: <code>user1,user2</code>.</li><li>To change the administrator account, go to <code>/opt/nezha/dashboard/data/config.yaml</code> and reset the new administrator <code>Client ID</code> and <code>Client Secret</code>.</li></ul><h2 id="theme" tabindex="-1">Theme <a class="header-anchor" href="#theme" aria-label="Permalink to &quot;Theme&quot;">​</a></h2><p>Select the theme for the homepage and admin panel here. If a theme that already exists is not in the options, update the Dashboard.<br> Before enabling the Custom theme, ensure you have installed the custom theme; otherwise, the Dashboard will not display correctly after enabling this option.</p><h2 id="language" tabindex="-1">Language <a class="header-anchor" href="#language" aria-label="Permalink to &quot;Language&quot;">​</a></h2><p>Nezha Monitoring currently supports the following languages:</p><ul><li>Simplified Chinese (简体中文)</li><li>Traditional Chinese (繁體中文)</li><li>English</li><li>Spanish (Español)</li></ul><p>We welcome corrections to translations or contributions of more languages.</p><h2 id="custom-code-style-script" tabindex="-1">Custom Code (style, script) <a class="header-anchor" href="#custom-code-style-script" aria-label="Permalink to &quot;Custom Code (style, script)&quot;">​</a></h2><p>You can modify the LOGO, adjust colors, add beautification code, and add statistical code here.</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Custom code only affects the visitor homepage, not the admin panel. Due to differences in code between themes, if you need to modify the content in the admin panel, please modify the theme files in Docker.</p></div><h4 id="example-of-changing-progress-bar-color-background-image-navigation-bar-etc-in-the-default-theme" tabindex="-1">Example of Changing Progress Bar Color, Background Image, Navigation Bar, etc., in the Default Theme <a class="header-anchor" href="#example-of-changing-progress-bar-color-background-image-navigation-bar-etc-in-the-default-theme" aria-label="Permalink to &quot;Example of Changing Progress Bar Color, Background Image, Navigation Bar, etc., in the Default Theme&quot;">​</a></h4><details><summary>Click to expand/collapse</summary><div class="language-html vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">html</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&lt;</span><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">style</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;</span></span>
+import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"Settings","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/settings.md","filePath":"en_US/guide/settings.md","lastUpdated":1728186808000}'),h={name:"en_US/guide/settings.md"},k=n(`<h1 id="settings" tabindex="-1">Settings <a class="header-anchor" href="#settings" aria-label="Permalink to &quot;Settings&quot;">​</a></h1><h2 id="site-title" tabindex="-1">Site Title <a class="header-anchor" href="#site-title" aria-label="Permalink to &quot;Site Title&quot;">​</a></h2><p>You can customize the site title in this section.</p><h2 id="administrator-list" tabindex="-1">Administrator List <a class="header-anchor" href="#administrator-list" aria-label="Permalink to &quot;Administrator List&quot;">​</a></h2><ul><li>If you have changed your Github, Gitlab, or Gitee username, you need to update it here to avoid login issues. Separate multiple usernames with commas: <code>user1,user2</code>.</li><li>To change the administrator account, go to <code>/opt/nezha/dashboard/data/config.yaml</code> and reset the new administrator <code>Client ID</code> and <code>Client Secret</code>.</li></ul><h2 id="theme" tabindex="-1">Theme <a class="header-anchor" href="#theme" aria-label="Permalink to &quot;Theme&quot;">​</a></h2><p>Select the theme for the homepage and admin panel here. If a theme that already exists is not in the options, update the Dashboard.<br> Before enabling the Custom theme, ensure you have installed the custom theme; otherwise, the Dashboard will not display correctly after enabling this option.</p><h2 id="language" tabindex="-1">Language <a class="header-anchor" href="#language" aria-label="Permalink to &quot;Language&quot;">​</a></h2><p>Nezha Monitoring currently supports the following languages:</p><ul><li>Simplified Chinese (简体中文)</li><li>Traditional Chinese (繁體中文)</li><li>English</li><li>Spanish (Español)</li></ul><p>We welcome corrections to translations or contributions of more languages.</p><h2 id="custom-code-style-script" tabindex="-1">Custom Code (style, script) <a class="header-anchor" href="#custom-code-style-script" aria-label="Permalink to &quot;Custom Code (style, script)&quot;">​</a></h2><p>You can modify the LOGO, adjust colors, add beautification code, and add statistical code here.</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Custom code only affects the visitor homepage, not the admin panel. Due to differences in code between themes, if you need to modify the content in the admin panel, please modify the theme files in Docker.</p></div><h4 id="example-of-changing-progress-bar-color-background-image-navigation-bar-etc-in-the-default-theme" tabindex="-1">Example of Changing Progress Bar Color, Background Image, Navigation Bar, etc., in the Default Theme <a class="header-anchor" href="#example-of-changing-progress-bar-color-background-image-navigation-bar-etc-in-the-default-theme" aria-label="Permalink to &quot;Example of Changing Progress Bar Color, Background Image, Navigation Bar, etc., in the Default Theme&quot;">​</a></h4><details><summary>Click to expand/collapse</summary><div class="language-html vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">html</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&lt;</span><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">style</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;</span></span>
 <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">/* Screen adaptation */</span></span>
 <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">@media</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> only</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> screen</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> and</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">min-width</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1200</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">px</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
 <span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">    .ui.container</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>

assets/en_US_guide_settings.md.B9nzENlN.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":"Settings","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/settings.md","filePath":"en_US/guide/settings.md","lastUpdated":1725160726000}'),h={name:"en_US/guide/settings.md"},k=n("",39),l=[k];function t(p,e,r,E,d,g){return a(),i("div",null,l)}const o=s(h,[["render",t]]);export{F as __pageData,o as default};
+import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"Settings","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/settings.md","filePath":"en_US/guide/settings.md","lastUpdated":1728186808000}'),h={name:"en_US/guide/settings.md"},k=n("",39),l=[k];function t(p,e,r,E,d,g){return a(),i("div",null,l)}const o=s(h,[["render",t]]);export{F as __pageData,o as default};

assets/en_US_guide_tasks.md.Bz5ATSX-.js

@@ -1 +1 @@
-import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"Task Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/tasks.md","filePath":"en_US/guide/tasks.md","lastUpdated":1725160726000}'),n={name:"en_US/guide/tasks.md"},s=a('<h1 id="task-management" tabindex="-1">Task Management <a class="header-anchor" href="#task-management" aria-label="Permalink to &quot;Task Management&quot;">​</a></h1><p><strong>In the Tasks section, you can set up scheduled tasks, trigger tasks, and batch execute tasks on multiple servers.</strong></p><p>Nezha Monitoring supports pushing commands to Agents for execution. This feature is highly flexible and can be used for regular backups using tools like restic or rclone, periodically restarting a service to reset network connections, or executing a task when an notification is triggered, such as running a script when CPU usage is high for an extended period.</p><h2 id="how-to-use" tabindex="-1">How to Use <a class="header-anchor" href="#how-to-use" aria-label="Permalink to &quot;How to Use&quot;">​</a></h2><p>Go to the &quot;Tasks&quot; page in the admin panel and click &quot;Add Scheduled Task.&quot; When adding a scheduled task, you need to fill in the following parameters:</p><ul><li><p><strong>Name</strong>: Customize a task name.</p></li><li><p><strong>Task Type</strong>: Choose the type of task.</p><ul><li><strong>Scheduled Task</strong>: Executes periodically according to the schedule set below.</li><li><strong>Trigger Task</strong>: Only executed when triggered by an API call or notification rule, runs once per trigger.</li></ul></li><li><p><strong>Schedule</strong>: Set the schedule time (not enable when using trigger task type). The time format is <code>* * * * * *</code>, corresponding to <code>second minute hour day month weekday</code>. For more details, see <a href="https://pkg.go.dev/github.com/robfig/cron/v3#hdr-CRON_Expression_Format" target="_blank" rel="noreferrer">Cron Expression Format</a>.<br> For example: <code>0 0 3 * * *</code> means &quot;3 AM every day.&quot;</p></li><li><p><strong>Command</strong>: Set the command to execute, similar to writing Shell/Bat scripts, but it&#39;s recommended not to use new lines; connect multiple commands with <code>&amp;&amp;</code> or <code>&amp;</code>.<br> For example, to schedule a reboot, you can enter <code>reboot</code> here.</p></li><li><p><strong>Coverage</strong> and <strong>Specific Servers</strong>: Select rules to determine which Agents execute the scheduled task, similar to the settings on the &quot;Services&quot; page. When using the trigger task type, you can choose &quot;executed by the triggered server.&quot;</p></li><li><p><strong>Notification Group</strong>: Choose the notification methods you have set up on the &quot;Notifications&quot; page. <a href="/en_US/guide/notifications.html#flexible-notification-methods">Click here</a> for more details.</p></li><li><p><strong>Send Success Notification</strong>: Check this option to trigger a notification upon successful task execution.</p></li></ul><h2 id="managing-tasks" tabindex="-1">Managing Tasks <a class="header-anchor" href="#managing-tasks" aria-label="Permalink to &quot;Managing Tasks&quot;">​</a></h2><p>To manage existing scheduled tasks, go to the &quot;Tasks&quot; page in the admin panel. For each task configuration, the three icons on the right are:</p><ul><li><strong>Execute Immediately</strong>: Click to ignore the scheduled time and execute the task immediately.</li><li><strong>Edit</strong>: Click to modify the task configuration.</li><li><strong>Delete</strong>: Delete the scheduled task.</li></ul><h2 id="frequently-asked-questions" tabindex="-1">Frequently Asked Questions <a class="header-anchor" href="#frequently-asked-questions" aria-label="Permalink to &quot;Frequently Asked Questions&quot;">​</a></h2><ol><li><strong>Command not found error</strong><br> If a command fails to run with a &quot;command not found&quot; error, it may be a PATH environment variable issue. On Linux servers, you can add <code>source ~/.bashrc</code> at the beginning of the command or use the absolute path to execute the command.</li></ol>',11),i=[s];function r(c,l,d,u,h,g){return o(),t("div",null,i)}const k=e(n,[["render",r]]);export{p as __pageData,k as default};
+import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"Task Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/tasks.md","filePath":"en_US/guide/tasks.md","lastUpdated":1728186808000}'),n={name:"en_US/guide/tasks.md"},s=a('<h1 id="task-management" tabindex="-1">Task Management <a class="header-anchor" href="#task-management" aria-label="Permalink to &quot;Task Management&quot;">​</a></h1><p><strong>In the Tasks section, you can set up scheduled tasks, trigger tasks, and batch execute tasks on multiple servers.</strong></p><p>Nezha Monitoring supports pushing commands to Agents for execution. This feature is highly flexible and can be used for regular backups using tools like restic or rclone, periodically restarting a service to reset network connections, or executing a task when an notification is triggered, such as running a script when CPU usage is high for an extended period.</p><h2 id="how-to-use" tabindex="-1">How to Use <a class="header-anchor" href="#how-to-use" aria-label="Permalink to &quot;How to Use&quot;">​</a></h2><p>Go to the &quot;Tasks&quot; page in the admin panel and click &quot;Add Scheduled Task.&quot; When adding a scheduled task, you need to fill in the following parameters:</p><ul><li><p><strong>Name</strong>: Customize a task name.</p></li><li><p><strong>Task Type</strong>: Choose the type of task.</p><ul><li><strong>Scheduled Task</strong>: Executes periodically according to the schedule set below.</li><li><strong>Trigger Task</strong>: Only executed when triggered by an API call or notification rule, runs once per trigger.</li></ul></li><li><p><strong>Schedule</strong>: Set the schedule time (not enable when using trigger task type). The time format is <code>* * * * * *</code>, corresponding to <code>second minute hour day month weekday</code>. For more details, see <a href="https://pkg.go.dev/github.com/robfig/cron/v3#hdr-CRON_Expression_Format" target="_blank" rel="noreferrer">Cron Expression Format</a>.<br> For example: <code>0 0 3 * * *</code> means &quot;3 AM every day.&quot;</p></li><li><p><strong>Command</strong>: Set the command to execute, similar to writing Shell/Bat scripts, but it&#39;s recommended not to use new lines; connect multiple commands with <code>&amp;&amp;</code> or <code>&amp;</code>.<br> For example, to schedule a reboot, you can enter <code>reboot</code> here.</p></li><li><p><strong>Coverage</strong> and <strong>Specific Servers</strong>: Select rules to determine which Agents execute the scheduled task, similar to the settings on the &quot;Services&quot; page. When using the trigger task type, you can choose &quot;executed by the triggered server.&quot;</p></li><li><p><strong>Notification Group</strong>: Choose the notification methods you have set up on the &quot;Notifications&quot; page. <a href="/en_US/guide/notifications.html#flexible-notification-methods">Click here</a> for more details.</p></li><li><p><strong>Send Success Notification</strong>: Check this option to trigger a notification upon successful task execution.</p></li></ul><h2 id="managing-tasks" tabindex="-1">Managing Tasks <a class="header-anchor" href="#managing-tasks" aria-label="Permalink to &quot;Managing Tasks&quot;">​</a></h2><p>To manage existing scheduled tasks, go to the &quot;Tasks&quot; page in the admin panel. For each task configuration, the three icons on the right are:</p><ul><li><strong>Execute Immediately</strong>: Click to ignore the scheduled time and execute the task immediately.</li><li><strong>Edit</strong>: Click to modify the task configuration.</li><li><strong>Delete</strong>: Delete the scheduled task.</li></ul><h2 id="frequently-asked-questions" tabindex="-1">Frequently Asked Questions <a class="header-anchor" href="#frequently-asked-questions" aria-label="Permalink to &quot;Frequently Asked Questions&quot;">​</a></h2><ol><li><strong>Command not found error</strong><br> If a command fails to run with a &quot;command not found&quot; error, it may be a PATH environment variable issue. On Linux servers, you can add <code>source ~/.bashrc</code> at the beginning of the command or use the absolute path to execute the command.</li></ol>',11),i=[s];function r(c,l,d,u,h,g){return o(),t("div",null,i)}const k=e(n,[["render",r]]);export{p as __pageData,k as default};

assets/en_US_guide_tasks.md.Bz5ATSX-.lean.js

@@ -1 +1 @@
-import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"Task Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/tasks.md","filePath":"en_US/guide/tasks.md","lastUpdated":1725160726000}'),n={name:"en_US/guide/tasks.md"},s=a("",11),i=[s];function r(c,l,d,u,h,g){return o(),t("div",null,i)}const k=e(n,[["render",r]]);export{p as __pageData,k as default};
+import{_ as e,c as t,o,a4 as a}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"Task Management","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/tasks.md","filePath":"en_US/guide/tasks.md","lastUpdated":1728186808000}'),n={name:"en_US/guide/tasks.md"},s=a("",11),i=[s];function r(c,l,d,u,h,g){return o(),t("div",null,i)}const k=e(n,[["render",r]]);export{p as __pageData,k as default};

assets/en_US_index.md.DRz4-f6e.js

@@ -1 +1 @@
-import{_ as t,c as e,o as a}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"User Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"User Manual","hero":{"name":"Nezha Monitoring","text":"Open-source, lightweight, and easy-to-use server monitoring and operation tool","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Preview","link":"https://ops.naibahq.com"},{"theme":"alt","text":"Get Started →","link":"en_US/guide/dashboard"}]},"features":[{"title":"One-Click Installation","details":"Supports one-click installation of the Dashboard and Agent services, making it easy to operate. Compatible with mainstream systems, including Linux, Windows, macOS, OpenWRT, and Synology."},{"title":"Real-Time Monitoring","details":"Supports monitoring the status of multiple servers simultaneously, providing historical network status and latency charts, monitoring webpage and port availability, and SSL certificate status. Supports alerts for status such as faults and traffic, with notifications via Telegram, email, Slack, and more."},{"title":"Easy Operations","details":"Provides an API to get server status, supports WebSSH, DDNS, and traffic monitoring. Allows setting up scheduled and triggered tasks and executing server tasks in batches."}]},"headers":[],"relativePath":"en_US/index.md","filePath":"en_US/index.md","lastUpdated":1725160726000}'),i={name:"en_US/index.md"};function n(s,o,r,l,d,c){return a(),e("div")}const u=t(i,[["render",n]]);export{p as __pageData,u as default};
+import{_ as t,c as e,o as a}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"User Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"User Manual","hero":{"name":"Nezha Monitoring","text":"Open-source, lightweight, and easy-to-use server monitoring and operation tool","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Preview","link":"https://ops.naibahq.com"},{"theme":"alt","text":"Get Started →","link":"en_US/guide/dashboard"}]},"features":[{"title":"One-Click Installation","details":"Supports one-click installation of the Dashboard and Agent services, making it easy to operate. Compatible with mainstream systems, including Linux, Windows, macOS, OpenWRT, and Synology."},{"title":"Real-Time Monitoring","details":"Supports monitoring the status of multiple servers simultaneously, providing historical network status and latency charts, monitoring webpage and port availability, and SSL certificate status. Supports alerts for status such as faults and traffic, with notifications via Telegram, email, Slack, and more."},{"title":"Easy Operations","details":"Provides an API to get server status, supports WebSSH, DDNS, and traffic monitoring. Allows setting up scheduled and triggered tasks and executing server tasks in batches."}]},"headers":[],"relativePath":"en_US/index.md","filePath":"en_US/index.md","lastUpdated":1728186808000}'),i={name:"en_US/index.md"};function n(s,o,r,l,d,c){return a(),e("div")}const u=t(i,[["render",n]]);export{p as __pageData,u as default};

assets/en_US_index.md.DRz4-f6e.lean.js

@@ -1 +1 @@
-import{_ as t,c as e,o as a}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"User Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"User Manual","hero":{"name":"Nezha Monitoring","text":"Open-source, lightweight, and easy-to-use server monitoring and operation tool","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Preview","link":"https://ops.naibahq.com"},{"theme":"alt","text":"Get Started →","link":"en_US/guide/dashboard"}]},"features":[{"title":"One-Click Installation","details":"Supports one-click installation of the Dashboard and Agent services, making it easy to operate. Compatible with mainstream systems, including Linux, Windows, macOS, OpenWRT, and Synology."},{"title":"Real-Time Monitoring","details":"Supports monitoring the status of multiple servers simultaneously, providing historical network status and latency charts, monitoring webpage and port availability, and SSL certificate status. Supports alerts for status such as faults and traffic, with notifications via Telegram, email, Slack, and more."},{"title":"Easy Operations","details":"Provides an API to get server status, supports WebSSH, DDNS, and traffic monitoring. Allows setting up scheduled and triggered tasks and executing server tasks in batches."}]},"headers":[],"relativePath":"en_US/index.md","filePath":"en_US/index.md","lastUpdated":1725160726000}'),i={name:"en_US/index.md"};function n(s,o,r,l,d,c){return a(),e("div")}const u=t(i,[["render",n]]);export{p as __pageData,u as default};
+import{_ as t,c as e,o as a}from"./chunks/framework.BmdFiWrL.js";const p=JSON.parse('{"title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"User Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring - Server monitoring tool","titleTemplate":"User Manual","hero":{"name":"Nezha Monitoring","text":"Open-source, lightweight, and easy-to-use server monitoring and operation tool","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Preview","link":"https://ops.naibahq.com"},{"theme":"alt","text":"Get Started →","link":"en_US/guide/dashboard"}]},"features":[{"title":"One-Click Installation","details":"Supports one-click installation of the Dashboard and Agent services, making it easy to operate. Compatible with mainstream systems, including Linux, Windows, macOS, OpenWRT, and Synology."},{"title":"Real-Time Monitoring","details":"Supports monitoring the status of multiple servers simultaneously, providing historical network status and latency charts, monitoring webpage and port availability, and SSL certificate status. Supports alerts for status such as faults and traffic, with notifications via Telegram, email, Slack, and more."},{"title":"Easy Operations","details":"Provides an API to get server status, supports WebSSH, DDNS, and traffic monitoring. Allows setting up scheduled and triggered tasks and executing server tasks in batches."}]},"headers":[],"relativePath":"en_US/index.md","filePath":"en_US/index.md","lastUpdated":1728186808000}'),i={name:"en_US/index.md"};function n(s,o,r,l,d,c){return a(),e("div")}const u=t(i,[["render",n]]);export{p as __pageData,u as default};

assets/guide_agent.md.YP61D2Sg.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":"安装 Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1725160726000}'),e={name:"guide/agent.md"},t=n(`<h1 id="安装-agent" tabindex="-1">安装 Agent <a class="header-anchor" href="#安装-agent" aria-label="Permalink to &quot;安装 Agent&quot;">​</a></h1><p><strong>哪吒监控的被控端服务被称为 Agent，本文档将介绍如何在被控端服务器上安装 Agent，并与 Dashboard 连接。</strong></p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>Agent 二进制文件仓库地址为：<a href="https://github.com/nezhahq/agent/releases" target="_blank" rel="noreferrer">https://github.com/nezhahq/agent/releases</a></p></div><h2 id="一键安装-agent" tabindex="-1">一键安装 Agent <a class="header-anchor" href="#一键安装-agent" aria-label="Permalink to &quot;一键安装 Agent&quot;">​</a></h2><p>哪吒监控支持在 Windows 和 Linux 上一键安装 Agent。遵循本文档的步骤，你可以很轻松地在服务器上部署它。</p><h3 id="准备工作" tabindex="-1">准备工作 <a class="header-anchor" href="#准备工作" aria-label="Permalink to &quot;准备工作&quot;">​</a></h3><p>你需要提前在管理面板中设置好通信域名，此域名不可以接入 CDN。本文档以示例通信域名 “data.example.com” 为例。<br> 进入后台管理面板，转到“设置”页，在“未接入 CDN 的面板服务器域名/IP”项中填入通信域名，然后点击&quot;保存&quot;。</p><h3 id="在-linux-中一键安装" tabindex="-1">在 Linux 中一键安装 <a class="header-anchor" href="#在-linux-中一键安装" aria-label="Permalink to &quot;在 Linux 中一键安装&quot;">​</a></h3><ol><li>首先在管理面板中添加一台服务器。</li><li>点击新添加的服务器旁的绿色 Linux 图标按钮，复制一键安装命令。</li><li>在被控端服务器中运行复制的一键安装命令，等待安装完成后返回到 Dashboard 主页查看服务器是否上线。</li></ol><h3 id="在-macos-中一键安装" tabindex="-1">在 macOS 中一键安装 <a class="header-anchor" href="#在-macos-中一键安装" aria-label="Permalink to &quot;在 macOS 中一键安装&quot;">​</a></h3><ol><li>首先在管理面板中添加一台服务器。</li><li>点击新添加的服务器旁的绿色 Apple 图标按钮，复制一键安装命令。</li><li>在被控端服务器中运行复制的一键安装命令，等待安装完成后返回到 Dashboard 主页查看服务器是否上线。</li></ol><h3 id="在-windows-中一键安装" tabindex="-1">在 Windows 中一键安装 <a class="header-anchor" href="#在-windows-中一键安装" aria-label="Permalink to &quot;在 Windows 中一键安装&quot;">​</a></h3><ol><li>首先在管理面板中添加一台服务器。</li><li>点击新添加的服务器旁的绿色 Windows 图标按钮，复制一键安装命令。</li><li>进入 Windows 服务器，运行 PowerShell，在 PowerShell 中运行复制的安装命令。</li><li>如遇到确认「执行策略变更」请选择 Y。</li><li>等待安装完成后返回 Dashboard 主页查看服务器是否上线。</li></ol><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>如果在 PowerShell 中运行一键安装命令时遇到错误，请尝试下方的<strong>在 Windows 中手动安装 Agent</strong>。</p></div><h2 id="其他方式安装-agent" tabindex="-1">其他方式安装 Agent <a class="header-anchor" href="#其他方式安装-agent" aria-label="Permalink to &quot;其他方式安装 Agent&quot;">​</a></h2><h3 id="在-linux-中安装-agent-支持大部分发行版" tabindex="-1">在 Linux 中安装 Agent（支持大部分发行版） <a class="header-anchor" href="#在-linux-中安装-agent-支持大部分发行版" aria-label="Permalink to &quot;在 Linux 中安装 Agent（支持大部分发行版）&quot;">​</a></h3><details><summary>点击展开/收起</summary><ol><li>首先在管理面板中添加一台服务器。</li><li>在被控服务器中，运行脚本（位于中国大陆的服务器请使用镜像）：</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -L</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -o</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> nezha.sh</span><span style="--shiki-light:#24292E;--shiki-da
Line truncated
+import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const F=JSON.parse('{"title":"安装 Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1728186808000}'),e={name:"guide/agent.md"},t=n(`<h1 id="安装-agent" tabindex="-1">安装 Agent <a class="header-anchor" href="#安装-agent" aria-label="Permalink to &quot;安装 Agent&quot;">​</a></h1><p><strong>哪吒监控的被控端服务被称为 Agent，本文档将介绍如何在被控端服务器上安装 Agent，并与 Dashboard 连接。</strong></p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>Agent 二进制文件仓库地址为：<a href="https://github.com/nezhahq/agent/releases" target="_blank" rel="noreferrer">https://github.com/nezhahq/agent/releases</a></p></div><h2 id="一键安装-agent" tabindex="-1">一键安装 Agent <a class="header-anchor" href="#一键安装-agent" aria-label="Permalink to &quot;一键安装 Agent&quot;">​</a></h2><p>哪吒监控支持在 Windows 和 Linux 上一键安装 Agent。遵循本文档的步骤，你可以很轻松地在服务器上部署它。</p><h3 id="准备工作" tabindex="-1">准备工作 <a class="header-anchor" href="#准备工作" aria-label="Permalink to &quot;准备工作&quot;">​</a></h3><p>你需要提前在管理面板中设置好通信域名，此域名不可以接入 CDN。本文档以示例通信域名 “data.example.com” 为例。<br> 进入后台管理面板，转到“设置”页，在“未接入 CDN 的面板服务器域名/IP”项中填入通信域名，然后点击&quot;保存&quot;。</p><h3 id="在-linux-中一键安装" tabindex="-1">在 Linux 中一键安装 <a class="header-anchor" href="#在-linux-中一键安装" aria-label="Permalink to &quot;在 Linux 中一键安装&quot;">​</a></h3><ol><li>首先在管理面板中添加一台服务器。</li><li>点击新添加的服务器旁的绿色 Linux 图标按钮，复制一键安装命令。</li><li>在被控端服务器中运行复制的一键安装命令，等待安装完成后返回到 Dashboard 主页查看服务器是否上线。</li></ol><h3 id="在-macos-中一键安装" tabindex="-1">在 macOS 中一键安装 <a class="header-anchor" href="#在-macos-中一键安装" aria-label="Permalink to &quot;在 macOS 中一键安装&quot;">​</a></h3><ol><li>首先在管理面板中添加一台服务器。</li><li>点击新添加的服务器旁的绿色 Apple 图标按钮，复制一键安装命令。</li><li>在被控端服务器中运行复制的一键安装命令，等待安装完成后返回到 Dashboard 主页查看服务器是否上线。</li></ol><h3 id="在-windows-中一键安装" tabindex="-1">在 Windows 中一键安装 <a class="header-anchor" href="#在-windows-中一键安装" aria-label="Permalink to &quot;在 Windows 中一键安装&quot;">​</a></h3><ol><li>首先在管理面板中添加一台服务器。</li><li>点击新添加的服务器旁的绿色 Windows 图标按钮，复制一键安装命令。</li><li>进入 Windows 服务器，运行 PowerShell，在 PowerShell 中运行复制的安装命令。</li><li>如遇到确认「执行策略变更」请选择 Y。</li><li>等待安装完成后返回 Dashboard 主页查看服务器是否上线。</li></ol><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>如果在 PowerShell 中运行一键安装命令时遇到错误，请尝试下方的<strong>在 Windows 中手动安装 Agent</strong>。</p></div><h2 id="其他方式安装-agent" tabindex="-1">其他方式安装 Agent <a class="header-anchor" href="#其他方式安装-agent" aria-label="Permalink to &quot;其他方式安装 Agent&quot;">​</a></h2><h3 id="在-linux-中安装-agent-支持大部分发行版" tabindex="-1">在 Linux 中安装 Agent（支持大部分发行版） <a class="header-anchor" href="#在-linux-中安装-agent-支持大部分发行版" aria-label="Permalink to &quot;在 Linux 中安装 Agent（支持大部分发行版）&quot;">​</a></h3><details><summary>点击展开/收起</summary><ol><li>首先在管理面板中添加一台服务器。</li><li>在被控服务器中，运行脚本（位于中国大陆的服务器请使用镜像）：</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -L</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -o</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> nezha.sh</span><span style="--shiki-light:#24292E;--shiki-da
Line truncated
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">exec</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> 2&gt;&amp;1</span></span>
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">exec</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> /opt/nezha/agent/nezha-agent</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -s</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> server_name:port</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -p</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> password</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> 2&gt;&amp;1</span></span></code></pre></div><p>这里同样可以添加其它参数。</p><ol start="3"><li>创建 <code>/etc/sv/nezha-agent/log/run</code>：</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">#!/bin/sh</span></span>
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">exec</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> vlogger</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -t</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> nezha-agent</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -p</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> daemon</span></span></code></pre></div><ol start="4"><li>启用服务：</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">sudo</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> ln</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -s</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> /etc/sv/nezha-agent/</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> /var/service</span></span></code></pre></div><p>之后可以通过 <code>sv</code> 命令来操作服务。</p><p>如何查看日志：</p><ol><li>安装 <code>socklog</code>，并启用：</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">sudo</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> xbps-install</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -S</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> socklog-void</span></span>

assets/guide_agent.md.YP61D2Sg.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":"安装 Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1725160726000}'),e={name:"guide/agent.md"},t=n("",31),l=[t];function h(p,k,r,d,g,o){return a(),i("div",null,l)}const y=s(e,[["render",h]]);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":"安装 Agent","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1728186808000}'),e={name:"guide/agent.md"},t=n("",31),l=[t];function h(p,k,r,d,g,o){return a(),i("div",null,l)}const y=s(e,[["render",h]]);export{F as __pageData,y as default};

assets/guide_agentq.md.B3CLMKGD.js

@@ -1 +1 @@
-import{_ as a,c as t,o as e,a4 as n}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Agent 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agentq.md","filePath":"guide/agentq.md","lastUpdated":1725160726000}'),o={name:"guide/agentq.md"},i=n('<h1 id="agent-常见问题" tabindex="-1">Agent 常见问题 <a class="header-anchor" href="#agent-常见问题" aria-label="Permalink to &quot;Agent 常见问题&quot;">​</a></h1><h2 id="后台显示的-ip-和-agent-实际-ip-不一致" tabindex="-1">后台显示的 IP 和 Agent 实际 IP 不一致？ <a class="header-anchor" href="#后台显示的-ip-和-agent-实际-ip-不一致" aria-label="Permalink to &quot;后台显示的 IP 和 Agent 实际 IP 不一致？&quot;">​</a></h2><p>请查看 <a href="/guide/dashboardq.html#为什么管理面板中显示的ip和agent实际ip不一致？">Dashboard 相关-为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？</a>。在此不再赘述。</p><h2 id="一键脚本安装时出错" tabindex="-1">一键脚本安装时出错 <a class="header-anchor" href="#一键脚本安装时出错" aria-label="Permalink to &quot;一键脚本安装时出错&quot;">​</a></h2><h3 id="curl-failed-to-connect-to-raw-githubusercontent-com" tabindex="-1">curl: Failed to connect to raw.githubusercontent.com...... <a class="header-anchor" href="#curl-failed-to-connect-to-raw-githubusercontent-com" aria-label="Permalink to &quot;curl: Failed to connect to raw.githubusercontent.com......&quot;">​</a></h3><p>多出现在中国大陆的服务器中，目前一键脚本只从 Github 直接获取安装脚本，您可以多尝试几次，或者<a href="/guide/agent.html#其他方式安装agent">手动安装 Agent</a>。另外，也可以自行寻找第三方 Github 加速服务或者镜像，并在一键安装脚本中设置。</p><h3 id="sudo-command-not-found" tabindex="-1">sudo: command not found <a class="header-anchor" href="#sudo-command-not-found" aria-label="Permalink to &quot;sudo: command not found&quot;">​</a></h3><p>请先手动安装 sudo，例如在 Ubuntu 中：</p><div class="language-shell vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">apt</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> install</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> sudo</span></span></code></pre></div>',9),s=[i];function d(r,l,c,h,u,p){return e(),t("div",null,s)}const _=a(o,[["render",d]]);export{m as __pageData,_ as default};
+import{_ as a,c as t,o as e,a4 as n}from"./chunks/framework.BmdFiWrL.js";const m=JSON.parse('{"title":"Agent 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agentq.md","filePath":"guide/agentq.md","lastUpdated":1728186808000}'),o={name:"guide/agentq.md"},i=n('<h1 id="agent-常见问题" tabindex="-1">Agent 常见问题 <a class="header-anchor" href="#agent-常见问题" aria-label="Permalink to &quot;Agent 常见问题&quot;">​</a></h1><h2 id="后台显示的-ip-和-agent-实际-ip-不一致" tabindex="-1">后台显示的 IP 和 Agent 实际 IP 不一致？ <a class="header-anchor" href="#后台显示的-ip-和-agent-实际-ip-不一致" aria-label="Permalink to &quot;后台显示的 IP 和 Agent 实际 IP 不一致？&quot;">​</a></h2><p>请查看 <a href="/guide/dashboardq.html#为什么管理面板中显示的ip和agent实际ip不一致？">Dashboard 相关-为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？</a>。在此不再赘述。</p><h2 id="一键脚本安装时出错" tabindex="-1">一键脚本安装时出错 <a class="header-anchor" href="#一键脚本安装时出错" aria-label="Permalink to &quot;一键脚本安装时出错&quot;">​</a></h2><h3 id="curl-failed-to-connect-to-raw-githubusercontent-com" tabindex="-1">curl: Failed to connect to raw.githubusercontent.com...... <a class="header-anchor" href="#curl-failed-to-connect-to-raw-githubusercontent-com" aria-label="Permalink to &quot;curl: Failed to connect to raw.githubusercontent.com......&quot;">​</a></h3><p>多出现在中国大陆的服务器中，目前一键脚本只从 Github 直接获取安装脚本，您可以多尝试几次，或者<a href="/guide/agent.html#其他方式安装agent">手动安装 Agent</a>。另外，也可以自行寻找第三方 Github 加速服务或者镜像，并在一键安装脚本中设置。</p><h3 id="sudo-command-not-found" tabindex="-1">sudo: command not found <a class="header-anchor" href="#sudo-command-not-found" aria-label="Permalink to &quot;sudo: command not found&quot;">​</a></h3><p>请先手动安装 sudo，例如在 Ubuntu 中：</p><div class="language-shell vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">apt</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> install</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> sudo</span></span></code></pre></div>',9),s=[i];function d(r,l,c,h,u,p){return e(),t("div",null,s)}const _=a(o,[["render",d]]);export{m as __pageData,_ as default};

assets/guide_agentq.md.B3CLMKGD.lean.js

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

assets/guide_api.md.B4Y59-mI.js

@@ -1,4 +1,4 @@
-import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const y=JSON.parse('{"title":"API 接口","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1725160726000}'),h={name:"guide/api.md"},k=n(`<h1 id="api-接口" tabindex="-1">API 接口 <a class="header-anchor" href="#api-接口" aria-label="Permalink to &quot;API 接口&quot;">​</a></h1><p><strong>哪吒监控支持使用 API 接口查询面板中 Agent 的状态信息</strong></p><h2 id="创建-token" tabindex="-1">创建 Token <a class="header-anchor" href="#创建-token" aria-label="Permalink to &quot;创建 Token&quot;">​</a></h2><p>哪吒面板的 API 接口允许使用 Token 认证与 Cookies 认证。要新建一个 Token，在进入管理面板后，点击右上角的头像，选择 “API Token”，进入 Token 管理页面。点击 “API Token”，自定义备注后，点击 “添加”。</p><p>如需删除一个 Token，请选择相应的 Token，点击右侧的删除图标。</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Token 是 API 接口的鉴权凭据，它对你的面板的信息安全非常重要，请不要泄漏你的 Token 给他人。</p></div><h2 id="认证方式" tabindex="-1">认证方式 <a class="header-anchor" href="#认证方式" aria-label="Permalink to &quot;认证方式&quot;">​</a></h2><p>确保在请求头中包含 <code>Authorization: Token</code> 进行身份认证。</p><p>Token 认证方式：</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>Request Headers:</span></span>
+import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const y=JSON.parse('{"title":"API 接口","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1728186808000}'),h={name:"guide/api.md"},k=n(`<h1 id="api-接口" tabindex="-1">API 接口 <a class="header-anchor" href="#api-接口" aria-label="Permalink to &quot;API 接口&quot;">​</a></h1><p><strong>哪吒监控支持使用 API 接口查询面板中 Agent 的状态信息</strong></p><h2 id="创建-token" tabindex="-1">创建 Token <a class="header-anchor" href="#创建-token" aria-label="Permalink to &quot;创建 Token&quot;">​</a></h2><p>哪吒面板的 API 接口允许使用 Token 认证与 Cookies 认证。要新建一个 Token，在进入管理面板后，点击右上角的头像，选择 “API Token”，进入 Token 管理页面。点击 “API Token”，自定义备注后，点击 “添加”。</p><p>如需删除一个 Token，请选择相应的 Token，点击右侧的删除图标。</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Token 是 API 接口的鉴权凭据，它对你的面板的信息安全非常重要，请不要泄漏你的 Token 给他人。</p></div><h2 id="认证方式" tabindex="-1">认证方式 <a class="header-anchor" href="#认证方式" aria-label="Permalink to &quot;认证方式&quot;">​</a></h2><p>确保在请求头中包含 <code>Authorization: Token</code> 进行身份认证。</p><p>Token 认证方式：</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>Request Headers:</span></span>
 <span class="line"><span>Authorization: Token</span></span></code></pre></div><h2 id="使用说明" tabindex="-1">使用说明 <a class="header-anchor" href="#使用说明" aria-label="Permalink to &quot;使用说明&quot;">​</a></h2><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>下面示例中的负数时间戳为（0000-00-00），目前表示 Dashboard 上线后该 Agent 从未汇报过，但不建议用正负性判断状态。</p></div><div class="tip custom-block"><p class="custom-block-title">TIP</p><p><strong>请求方式为 <code>GET</code>，返回格式为 <code>JSON</code></strong></p></div><h3 id="获取服务器列表" tabindex="-1">获取服务器列表 <a class="header-anchor" href="#获取服务器列表" aria-label="Permalink to &quot;获取服务器列表&quot;">​</a></h3><p>请求：</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>GET /api/v1/server/list?tag=</span></span></code></pre></div><p>参数：</p><ul><li><code>tag</code>（可选）：ServerTag 是服务器的分组，提供此参数则仅查询该分组中的服务器。</li></ul><p>返回示例：</p><div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">    &quot;code&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
 <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">    &quot;message&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;success&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>

assets/guide_api.md.B4Y59-mI.lean.js

@@ -1 +1 @@
-import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const y=JSON.parse('{"title":"API 接口","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1725160726000}'),h={name:"guide/api.md"},k=n("",42),t=[k];function p(l,E,e,r,d,g){return a(),i("div",null,t)}const o=s(h,[["render",p]]);export{y as __pageData,o as default};
+import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.BmdFiWrL.js";const y=JSON.parse('{"title":"API 接口","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1728186808000}'),h={name:"guide/api.md"},k=n("",42),t=[k];function p(l,E,e,r,d,g){return a(),i("div",null,t)}const o=s(h,[["render",p]]);export{y as __pageData,o as default};

assets/guide_dashboard.md.D5aT48Vj.js

@@ -1,4 +1,4 @@
-import{_ as a,c as s,o as e,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"安装 Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboard.md","filePath":"guide/dashboard.md","lastUpdated":1725160726000}'),t={name:"guide/dashboard.md"},l=i(`<h1 id="安装-dashboard" tabindex="-1">安装 Dashboard <a class="header-anchor" href="#安装-dashboard" aria-label="Permalink to &quot;安装 Dashboard&quot;">​</a></h1><h2 id="准备工作" tabindex="-1">准备工作 <a class="header-anchor" href="#准备工作" aria-label="Permalink to &quot;准备工作&quot;">​</a></h2><p>搭建一个哪吒监控，你需要：</p><ol><li>一台可以连接公网的服务器，防火墙和安全策略需要放行 8008 和 5555 端口，否则会无法访问和无法接收数据。单核 512MB 内存的服务器配置就足以满足大多数使用场景。</li><li>一个已经设置好 A 记录，指向 Dashboard 服务器 IP 的域名。</li></ol><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>如果你想使用 CDN，请准备两个域名，一个配置好 CDN 用作公开访问，CDN 需要支持 WebSocket 协议；另一个域名不要使用 CDN，用作 Agent 端与 Dashboard 的通信。</p><p>本文档分别以 &quot;dashboard.example.com&quot; 和 &quot;data.example.com&quot; 两个域名来演示。</p></div><ol start="3"><li>一个 Github 账号（或：Gitlab、Gitee）。</li></ol><p><strong>本文档将以宝塔面板反代 Dashboard 的过程作为示范，随着未来版本的变化，部分功能的入口可能会发生改变，本文档仅供参考。</strong></p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>本项目并不依赖宝塔，你可以选择使用你喜欢的任何服务器面板，或手动安装 Nginx 或 Caddy 来配置 SSL 和反代。<br> 如果你认为没有必要使用 80、443 端口来访问 Dashboard，你甚至不需要安装 Nginx 就可以直接使用安装脚本安装并运行哪吒监控。</p></div><h2 id="获取-github-的-client-id-和密钥" tabindex="-1">获取 Github 的 Client ID 和密钥 <a class="header-anchor" href="#获取-github-的-client-id-和密钥" aria-label="Permalink to &quot;获取 Github 的 Client ID 和密钥&quot;">​</a></h2><p>哪吒监控接入 Github、Gitlab、Gitee 作为后台管理员账号。</p><ol><li>首先我们需要新建一个验证应用，以 Github 为例，登录 Github 后，打开 <a href="https://github.com/settings/developers" target="_blank" rel="noreferrer">https://github.com/settings/developers</a> ，依次选择“OAuth Apps” - “New OAuth App”。<br><code>Application name</code> - 随意填写。<br><code>Homepage URL</code> - 填写面板的访问域名，如：&quot;<a href="http://dashboard.example.com" target="_blank" rel="noreferrer">http://dashboard.example.com</a>&quot;（你的域名）。<br><code>Authorization callback URL</code> - 填写回调地址，如：&quot;<a href="http://dashboard.example.com/oauth2/callback" target="_blank" rel="noreferrer">http://dashboard.example.com/oauth2/callback</a>&quot;（不要忘记<code>/oauth2/callback</code>）。</li><li>点击 “Register application”。</li><li>保存页面中的 Client ID，然后点击 “Generate a new client secret“，创建一个新的 Client Secret，新建的密钥仅会显示一次，<strong>请妥善保存</strong>。</li></ol><h2 id="使用-cloudflare-access-作为-oauth2-提供方" tabindex="-1">使用 Cloudflare Access 作为 OAuth2 提供方 <a class="header-anchor" href="#使用-cloudflare-access-作为-oauth2-提供方" aria-label="Permalink to &quot;使用 Cloudflare Access 作为 OAuth2 提供方&quot;">​</a></h2><p>对于位于中国大陆的用户，直接连接到 GitHub 可能会遇到困难。如果您在使用 GitHub、GitLab 或 Gitee 作为管理员账户登录时遇到问题，建议切换到使用 <a href="/guide/q8.html">Cloudflare Access 作为 OAuth2 提供方</a> 进行登录。</p><h3 id="新建-saas-oidc-应用流程" tabindex="-1">新建 SaaS-OIDC 应用流程 <a class="header-anchor" href="#新建-saas-oidc-应用流程" aria-label="Permalink to &quot;新建 SaaS-OIDC 应用流程&quot;">​</a></h3><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>以下步骤适用于已经开始使用 Zero Trust 的用户。如果您尚未使用过 Cloudflare Zero Trust，强烈建议您首先阅读 <a href="/guide/q8.html">Cloudflare Access 作为 OAuth2 提供方的使用指南</a>，以了解 Cloudflare Access 的配置示例和流程。</p></div><ol><li>前往 <a href="https://one.dash.cloudflare.com" target="_blank" rel="noreferrer">Zero Trust Dashboard</a>，使用 Cloudflare 账号登录。</li><li><code>My Team</code> -&gt; <code>Users</code> -&gt; <code>&lt;具体用户&gt;</code> -&gt; 获取 <code>User ID</code> 并保存。</li><li><code>Access</code> -&gt; <
Line truncated
+import{_ as a,c as s,o as e,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"安装 Dashboard","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboard.md","filePath":"guide/dashboard.md","lastUpdated":1728186808000}'),t={name:"guide/dashboard.md"},l=i(`<h1 id="安装-dashboard" tabindex="-1">安装 Dashboard <a class="header-anchor" href="#安装-dashboard" aria-label="Permalink to &quot;安装 Dashboard&quot;">​</a></h1><h2 id="准备工作" tabindex="-1">准备工作 <a class="header-anchor" href="#准备工作" aria-label="Permalink to &quot;准备工作&quot;">​</a></h2><p>搭建一个哪吒监控，你需要：</p><ol><li>一台可以连接公网的服务器，防火墙和安全策略需要放行 8008 和 5555 端口，否则会无法访问和无法接收数据。单核 512MB 内存的服务器配置就足以满足大多数使用场景。</li><li>一个已经设置好 A 记录，指向 Dashboard 服务器 IP 的域名。</li></ol><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>如果你想使用 CDN，请准备两个域名，一个配置好 CDN 用作公开访问，CDN 需要支持 WebSocket 协议；另一个域名不要使用 CDN，用作 Agent 端与 Dashboard 的通信。</p><p>本文档分别以 &quot;dashboard.example.com&quot; 和 &quot;data.example.com&quot; 两个域名来演示。</p></div><ol start="3"><li>一个 Github 账号（或：Gitlab、Gitee）。</li></ol><p><strong>本文档将以宝塔面板反代 Dashboard 的过程作为示范，随着未来版本的变化，部分功能的入口可能会发生改变，本文档仅供参考。</strong></p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>本项目并不依赖宝塔，你可以选择使用你喜欢的任何服务器面板，或手动安装 Nginx 或 Caddy 来配置 SSL 和反代。<br> 如果你认为没有必要使用 80、443 端口来访问 Dashboard，你甚至不需要安装 Nginx 就可以直接使用安装脚本安装并运行哪吒监控。</p></div><h2 id="获取-github-的-client-id-和密钥" tabindex="-1">获取 Github 的 Client ID 和密钥 <a class="header-anchor" href="#获取-github-的-client-id-和密钥" aria-label="Permalink to &quot;获取 Github 的 Client ID 和密钥&quot;">​</a></h2><p>哪吒监控接入 Github、Gitlab、Gitee 作为后台管理员账号。</p><ol><li>首先我们需要新建一个验证应用，以 Github 为例，登录 Github 后，打开 <a href="https://github.com/settings/developers" target="_blank" rel="noreferrer">https://github.com/settings/developers</a> ，依次选择“OAuth Apps” - “New OAuth App”。<br><code>Application name</code> - 随意填写。<br><code>Homepage URL</code> - 填写面板的访问域名，如：&quot;<a href="http://dashboard.example.com" target="_blank" rel="noreferrer">http://dashboard.example.com</a>&quot;（你的域名）。<br><code>Authorization callback URL</code> - 填写回调地址，如：&quot;<a href="http://dashboard.example.com/oauth2/callback" target="_blank" rel="noreferrer">http://dashboard.example.com/oauth2/callback</a>&quot;（不要忘记<code>/oauth2/callback</code>）。</li><li>点击 “Register application”。</li><li>保存页面中的 Client ID，然后点击 “Generate a new client secret“，创建一个新的 Client Secret，新建的密钥仅会显示一次，<strong>请妥善保存</strong>。</li></ol><h2 id="使用-cloudflare-access-作为-oauth2-提供方" tabindex="-1">使用 Cloudflare Access 作为 OAuth2 提供方 <a class="header-anchor" href="#使用-cloudflare-access-作为-oauth2-提供方" aria-label="Permalink to &quot;使用 Cloudflare Access 作为 OAuth2 提供方&quot;">​</a></h2><p>对于位于中国大陆的用户，直接连接到 GitHub 可能会遇到困难。如果您在使用 GitHub、GitLab 或 Gitee 作为管理员账户登录时遇到问题，建议切换到使用 <a href="/guide/q8.html">Cloudflare Access 作为 OAuth2 提供方</a> 进行登录。</p><h3 id="新建-saas-oidc-应用流程" tabindex="-1">新建 SaaS-OIDC 应用流程 <a class="header-anchor" href="#新建-saas-oidc-应用流程" aria-label="Permalink to &quot;新建 SaaS-OIDC 应用流程&quot;">​</a></h3><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>以下步骤适用于已经开始使用 Zero Trust 的用户。如果您尚未使用过 Cloudflare Zero Trust，强烈建议您首先阅读 <a href="/guide/q8.html">Cloudflare Access 作为 OAuth2 提供方的使用指南</a>，以了解 Cloudflare Access 的配置示例和流程。</p></div><ol><li>前往 <a href="https://one.dash.cloudflare.com" target="_blank" rel="noreferrer">Zero Trust Dashboard</a>，使用 Cloudflare 账号登录。</li><li><code>My Team</code> -&gt; <code>Users</code> -&gt; <code>&lt;具体用户&gt;</code> -&gt; 获取 <code>User ID</code> 并保存。</li><li><code>Access</code> -&gt; <
Line truncated
 <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">location</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> / </span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
 <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">    proxy_pass </span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">http://127.0.0.1:8008;</span></span>
 <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">    proxy_set_header </span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">Host $http_host;</span></span>

assets/guide_dashboard.md.D5aT48Vj.lean.js

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

assets/guide_dashboardq.md.PGgMu2gV.js

@@ -1,4 +1,4 @@
-import{_ as a,c as s,o as e,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Dashboard 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboardq.md","filePath":"guide/dashboardq.md","lastUpdated":1725160726000}'),t={name:"guide/dashboardq.md"},n=i(`<h1 id="dashboard-常见问题" tabindex="-1">Dashboard 常见问题 <a class="header-anchor" href="#dashboard-常见问题" aria-label="Permalink to &quot;Dashboard 常见问题&quot;">​</a></h1><h2 id="为什么管理面板中显示的-ip-和-agent-实际-ip-不一致" tabindex="-1">为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？ <a class="header-anchor" href="#为什么管理面板中显示的-ip-和-agent-实际-ip-不一致" aria-label="Permalink to &quot;为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？&quot;">​</a></h2><p>首先解释管理面板中显示的IP是怎么得到的：Agent 会每隔一段时间请求一遍 IP-API，获取到 IP 信息后上报到 Dashboard，目前使用的 IP-API 可在此查看：<a href="https://github.com/nezhahq/agent/blob/main/pkg/monitor/myip.go" target="_blank" rel="noreferrer">myip.go</a>。<br> 如您发现管理面板中显示的 IP 和服务商提供给您的 IP 不一致，最大的可能是服务商给您的是<strong>入口 IP</strong>，但 Agent 测试的是您的<strong>出口 IP</strong>。这个问题也可能会出现在多线服务器和 IPLC 专线中。</p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>举个简单也十分常见的例子，服务商给您提供的是一台高防服务器，为了同时满足高防和低网络中断率的目标，提供给您的 IP 可能是经过映射后的高防 IP 而并非您服务器的真实出口 IP。</p></div><p>您也可以在 Agent 服务器中运行以下命令测试出口 IP:</p><div class="language-shell vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> https://ipapi.co/ip/</span></span>
+import{_ as a,c as s,o as e,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Dashboard 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboardq.md","filePath":"guide/dashboardq.md","lastUpdated":1728186808000}'),t={name:"guide/dashboardq.md"},n=i(`<h1 id="dashboard-常见问题" tabindex="-1">Dashboard 常见问题 <a class="header-anchor" href="#dashboard-常见问题" aria-label="Permalink to &quot;Dashboard 常见问题&quot;">​</a></h1><h2 id="为什么管理面板中显示的-ip-和-agent-实际-ip-不一致" tabindex="-1">为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？ <a class="header-anchor" href="#为什么管理面板中显示的-ip-和-agent-实际-ip-不一致" aria-label="Permalink to &quot;为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？&quot;">​</a></h2><p>首先解释管理面板中显示的IP是怎么得到的：Agent 会每隔一段时间请求一遍 IP-API，获取到 IP 信息后上报到 Dashboard，目前使用的 IP-API 可在此查看：<a href="https://github.com/nezhahq/agent/blob/main/pkg/monitor/myip.go" target="_blank" rel="noreferrer">myip.go</a>。<br> 如您发现管理面板中显示的 IP 和服务商提供给您的 IP 不一致，最大的可能是服务商给您的是<strong>入口 IP</strong>，但 Agent 测试的是您的<strong>出口 IP</strong>。这个问题也可能会出现在多线服务器和 IPLC 专线中。</p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>举个简单也十分常见的例子，服务商给您提供的是一台高防服务器，为了同时满足高防和低网络中断率的目标，提供给您的 IP 可能是经过映射后的高防 IP 而并非您服务器的真实出口 IP。</p></div><p>您也可以在 Agent 服务器中运行以下命令测试出口 IP:</p><div class="language-shell vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> https://ipapi.co/ip/</span></span>
 <span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> ip.sb</span></span>
 <span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> ip-api.com</span></span></code></pre></div><h2 id="忘记查看密码-删除查看密码" tabindex="-1">忘记查看密码\\删除查看密码 <a class="header-anchor" href="#忘记查看密码-删除查看密码" aria-label="Permalink to &quot;忘记查看密码\\删除查看密码&quot;">​</a></h2><p>请查看或编辑 <code>/opt/nezha/dashboard/data/config.yaml</code> 文件。<br> 密码位于 <code>site-viewpassword</code> 项中。</p><h2 id="面板安装-重启-更新失败-iptables" tabindex="-1">面板安装/重启/更新失败: iptables ...... <a class="header-anchor" href="#面板安装-重启-更新失败-iptables" aria-label="Permalink to &quot;面板安装/重启/更新失败: iptables ......&quot;">​</a></h2><p>首先尝试重启 Docker 再操作：</p><div class="language-shell vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">systemctl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> status</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> docker</span></span>
 <span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">systemctl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> restart</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> docker</span></span>

assets/guide_dashboardq.md.PGgMu2gV.lean.js

@@ -1 +1 @@
-import{_ as a,c as s,o as e,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Dashboard 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboardq.md","filePath":"guide/dashboardq.md","lastUpdated":1725160726000}'),t={name:"guide/dashboardq.md"},n=i("",37),o=[n];function r(l,h,d,p,c,k){return e(),s("div",null,o)}const u=a(t,[["render",r]]);export{b as __pageData,u as default};
+import{_ as a,c as s,o as e,a4 as i}from"./chunks/framework.BmdFiWrL.js";const b=JSON.parse('{"title":"Dashboard 常见问题","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboardq.md","filePath":"guide/dashboardq.md","lastUpdated":1728186808000}'),t={name:"guide/dashboardq.md"},n=i("",37),o=[n];function r(l,h,d,p,c,k){return e(),s("div",null,o)}const u=a(t,[["render",r]]);export{b as __pageData,u as default};