This commit is contained in:
cantoblanco committed 2024-05-14 15:47:17 +00:00
1 parent d900d88c87
commit 8df244390b
179 files changed
+377 -393

No files matched your search

+1 -1
View File
@@ -15,7 +15,7 @@
</head> </head>
<body> <body>
<div id="app"><div class="Layout" data-v-b2cf3e0b><!--[--><!--]--><!--[--><span tabindex="-1" data-v-b8b11faa></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-b8b11faa> Skip to content </a><!--]--><!----><header class="VPNav" data-v-b2cf3e0b data-v-7e5bc4a5><div class="VPNavBar" data-v-7e5bc4a5 data-v-7683ced7><div class="container" data-v-7683ced7><div class="title" data-v-7683ced7><div class="VPNavBarTitle" data-v-7683ced7 data-v-4d981103><a class="title" href="/" data-v-4d981103><!--[--><!--]--><!----><!--[-->哪吒监控<!--]--><!--[--><!--]--></a></div></div><div class="content" data-v-7683ced7><div class="curtain" data-v-7683ced7></div><div class="content-body" data-v-7683ced7><!--[--><!--]--><div class="VPNavBarSearch search" style="--vp-meta-key:&#39;Meta&#39;;" data-v-7683ced7><!--[--><div id="docsearch"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg class="DocSearch-Search-Icon" width="20" height="20" viewBox="0 0 20 20" aria-label="search icon"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-7683ced7 data-v-7f418b0f><span id="main-nav-aria-label" class="visually-hidden" data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/" tabindex="0" data-v-7f418b0f data-v-5e623618 data-v-8f4dc553><!--[-->使用指南<!--]--><!----></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/case/index.html" tabindex="0" data-v-7f418b0f data-v-5e623618 data-v-8f4dc553><!--[-->社区项目<!--]--><!----></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/developer/index.html" tabindex="0" data-v-7f418b0f data-v-5e623618 data-v-8f4dc553><!--[-->开发手册<!--]--><!----></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-7683ced7 data-v-74abcbb9 data-v-764effdf><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Change language" data-v-764effdf><span class="text" data-v-764effdf><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="option-icon" data-v-764effdf><path d="M0 0h24v24H0z" fill="none"></path><path d=" M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z " class="css-c4d79v"></path></svg> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="text-icon" data-v-764effdf><path d="M12,16c-0.3,0-0.5-0.1-0.7-0.3l-6-6c-0.4-0.4-0.4-1,0-1.4s1-0.4,1.4,0l5.3,5.3l5.3-5.3c0.4-0.4,1-0.4,1.4,0s0.4,1,0,1.4l-6,6C12.5,15.9,12.3,16,12,16z"></path></svg></span></button><div class="menu" data-v-764effdf><div class="VPMenu" data-v-764effdf data-v-e7ea1737><!----><!--[--><!--[--><div class="items" data-v-74abcbb9><p class="title" data-v-74abcbb9>简体中文</p><!--[--><div class="VPMenuLink" data-v-74abcbb9 data-v-2f2cfafc><a class="VPLink link" href="/en_US/" data-v-2f2cfafc data-v-8f4dc553><!--[-->English<!--]--><!----></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-7683ced7 data-v-f6a63727><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="toggle dark mode" aria-checked="false" data-v-f6a63727 data-v-82b282f1 data-v-f3c41672><span class="check" data-v-f3c41672><span class="icon" data-v-f3c41672><!--[--><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="sun" data-v-82b282f1><path d="M12,18c-3.3,0-6-2.7-6-6s2.7-6,6-6s6,2.7,6,6S15.3,18,12,18zM12,8c-2.2,0-4,1.8-4,4c0,2.2,1.8,4,4,4c2.2,0,4-1.8,4-4C16,9.8,14.2,8,12,8z"></path><path d="M12,4c-0.6,0-1-0.4-1-1V1c0-0.6,0.4-1,1-1s1,0.4,1,1v2C13,3.6,12.6,4,12,4z"></path><path d="M12,24c-0.6,0-1-0.4-1-1v-2c0-0.6,0.4-1,1-1s1,0.4,1,1v2C13,23.6,12.6,24,12,24z"></path><path d="M5.6,6.6c-0.3,0-0.5-0.1-0.7-0.3L3.5,4.9c-0.4-0.4-0.4-1,0-1.4s1-0.4,1.4,0l1.4,1.4c0.4,0.4,0.4,1,0,1.4C6.2,6.5,5.9,6.6,5.6,6.6z"></path><path d="M19.8,20.8c-0.3,0-0.5-0.1-0.7-0.3l-1.4-1.4c-0.4-0.4-0.4-1,0-1.4s1-0.4,1.4,0l1.4,1.4c0.4,0.4,0.4,1,0,1.4C20.3,20.7,20,20.8,19.8,20.8z"></path><path d="M3,13H1c-0.6,0-1-0.4-1-1s0.4-1,1-1h2c0.6,0Line truncated <div id="app"><div class="Layout" data-v-b2cf3e0b><!--[--><!--]--><!--[--><span tabindex="-1" data-v-b8b11faa></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-b8b11faa> Skip to content </a><!--]--><!----><header class="VPNav" data-v-b2cf3e0b data-v-7e5bc4a5><div class="VPNavBar" data-v-7e5bc4a5 data-v-7683ced7><div class="container" data-v-7683ced7><div class="title" data-v-7683ced7><div class="VPNavBarTitle" data-v-7683ced7 data-v-4d981103><a class="title" href="/" data-v-4d981103><!--[--><!--]--><!----><!--[-->哪吒监控<!--]--><!--[--><!--]--></a></div></div><div class="content" data-v-7683ced7><div class="curtain" data-v-7683ced7></div><div class="content-body" data-v-7683ced7><!--[--><!--]--><div class="VPNavBarSearch search" style="--vp-meta-key:&#39;Meta&#39;;" data-v-7683ced7><!--[--><div id="docsearch"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg class="DocSearch-Search-Icon" width="20" height="20" viewBox="0 0 20 20" aria-label="search icon"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-7683ced7 data-v-7f418b0f><span id="main-nav-aria-label" class="visually-hidden" data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/" tabindex="0" data-v-7f418b0f data-v-5e623618 data-v-8f4dc553><!--[-->使用指南<!--]--><!----></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/case/index.html" tabindex="0" data-v-7f418b0f data-v-5e623618 data-v-8f4dc553><!--[-->社区项目<!--]--><!----></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/developer/index.html" tabindex="0" data-v-7f418b0f data-v-5e623618 data-v-8f4dc553><!--[-->开发手册<!--]--><!----></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-7683ced7 data-v-74abcbb9 data-v-764effdf><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Change language" data-v-764effdf><span class="text" data-v-764effdf><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="option-icon" data-v-764effdf><path d="M0 0h24v24H0z" fill="none"></path><path d=" M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z " class="css-c4d79v"></path></svg> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="text-icon" data-v-764effdf><path d="M12,16c-0.3,0-0.5-0.1-0.7-0.3l-6-6c-0.4-0.4-0.4-1,0-1.4s1-0.4,1.4,0l5.3,5.3l5.3-5.3c0.4-0.4,1-0.4,1.4,0s0.4,1,0,1.4l-6,6C12.5,15.9,12.3,16,12,16z"></path></svg></span></button><div class="menu" data-v-764effdf><div class="VPMenu" data-v-764effdf data-v-e7ea1737><!----><!--[--><!--[--><div class="items" data-v-74abcbb9><p class="title" data-v-74abcbb9>简体中文</p><!--[--><div class="VPMenuLink" data-v-74abcbb9 data-v-2f2cfafc><a class="VPLink link" href="/en_US/" data-v-2f2cfafc data-v-8f4dc553><!--[-->English<!--]--><!----></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-7683ced7 data-v-f6a63727><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="toggle dark mode" aria-checked="false" data-v-f6a63727 data-v-82b282f1 data-v-f3c41672><span class="check" data-v-f3c41672><span class="icon" data-v-f3c41672><!--[--><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="sun" data-v-82b282f1><path d="M12,18c-3.3,0-6-2.7-6-6s2.7-6,6-6s6,2.7,6,6S15.3,18,12,18zM12,8c-2.2,0-4,1.8-4,4c0,2.2,1.8,4,4,4c2.2,0,4-1.8,4-4C16,9.8,14.2,8,12,8z"></path><path d="M12,4c-0.6,0-1-0.4-1-1V1c0-0.6,0.4-1,1-1s1,0.4,1,1v2C13,3.6,12.6,4,12,4z"></path><path d="M12,24c-0.6,0-1-0.4-1-1v-2c0-0.6,0.4-1,1-1s1,0.4,1,1v2C13,23.6,12.6,24,12,24z"></path><path d="M5.6,6.6c-0.3,0-0.5-0.1-0.7-0.3L3.5,4.9c-0.4-0.4-0.4-1,0-1.4s1-0.4,1.4,0l1.4,1.4c0.4,0.4,0.4,1,0,1.4C6.2,6.5,5.9,6.6,5.6,6.6z"></path><path d="M19.8,20.8c-0.3,0-0.5-0.1-0.7-0.3l-1.4-1.4c-0.4-0.4-0.4-1,0-1.4s1-0.4,1.4,0l1.4,1.4c0.4,0.4,0.4,1,0,1.4C20.3,20.7,20,20.8,19.8,20.8z"></path><path d="M3,13H1c-0.6,0-1-0.4-1-1s0.4-1,1-1h2c0.6,0Line truncated
<script>__VP_HASH_MAP__ = JSON.parse("{\"case_index.md\":\"73e6bfcc\",\"case_case1.md\":\"b0ffeb45\",\"case_case3.md\":\"48bb8f95\",\"case_case2.md\":\"ed3674ae\",\"developer_l10n.md\":\"44af3a03\",\"developer_index.md\":\"40e8edab\",\"case_case5.md\":\"c6a30f74\",\"case_case4.md\":\"622962b5\",\"en_us_case_case3.md\":\"d6e1e0c9\",\"en_us_case_case2.md\":\"3050bd1d\",\"en_us_guide_dashboardq.md\":\"1d2992f0\",\"en_us_guide_agentq.md\":\"8b51bd53\",\"en_us_guide_dashboard.md\":\"f5ba44c9\",\"en_us_developer_theme.md\":\"c6c2705e\",\"en_us_case_case1.md\":\"68d4b8c0\",\"en_us_guide_api.md\":\"ff18d057\",\"en_us_case_index.md\":\"426c1c9c\",\"developer_theme.md\":\"de32339f\",\"en_us_guide_q4.md\":\"34457c09\",\"en_us_guide_notifications.md\":\"da167b63\",\"guide_agent.md\":\"c5504e5b\",\"guide_q3.md\":\"ccf3ac7d\",\"guide_agentq.md\":\"a7cf9dc4\",\"guide_q6.md\":\"ddbb7fcc\",\"guide_q4.md\":\"20d0f5c4\",\"guide_q5.md\":\"4a1bad66\",\"en_us_developer_index.md\":\"9ebb076b\",\"guide_dashboardq.md\":\"5f436dce\",\"en_us_developer_l10n.md\":\"13b00a40\",\"en_us_guide_q7.md\":\"32e7f672\",\"guide_q1.md\":\"9b7b06a4\",\"en_us_case_case5.md\":\"0c5c8026\",\"guide_q8.md\":\"d9f62b2a\",\"en_us_case_case4.md\":\"5c1a6961\",\"en_us_guide_q6.md\":\"b458d2f7\",\"en_us_index.md\":\"1aa6edfc\",\"en_us_guide_loginq.md\":\"da359af2\",\"guide_loginq.md\":\"6ab914ff\",\"en_us_guide_q8.md\":\"156ed04a\",\"guide_dashboard.md\":\"224f2444\",\"en_us_guide_q2.md\":\"890a5b8b\",\"guide_tasks.md\":\"9d198fac\",\"index.md\":\"c76cb732\",\"guide_q7.md\":\"cba664b5\",\"en_us_guide_tasks.md\":\"7f2837a8\",\"en_us_guide_services.md\":\"522160e5\",\"en_us_guide_q5.md\":\"b118b88f\",\"guide_notifications.md\":\"1e97e129\",\"en_us_guide_servers.md\":\"89212d49\",\"guide_api.md\":\"4a4d6c33\",\"guide_services.md\":\"1ae95d3e\",\"en_us_guide_agent.md\":\"df49cb2f\",\"guide_q2.md\":\"f3513918\",\"en_us_guide_q3.md\":\"5dfcdcea\",\"guide_servers.md\":\"9dbc33a5\",\"en_us_guide_settings.md\":\"786426d1\",\"guide_settings.md\":\"2309481e\"}") <script>__VP_HASH_MAP__ = JSON.parse("{\"developer_index.md\":\"111a68f3\",\"en_us_guide_loginq.md\":\"cbcb363e\",\"en_us_case_case4.md\":\"9e4f3127\",\"en_us_guide_q8.md\":\"babff2f0\",\"case_case2.md\":\"1b519ed4\",\"developer_theme.md\":\"650aa830\",\"developer_l10n.md\":\"82b6ef01\",\"en_us_guide_q6.md\":\"88b5afe3\",\"en_us_guide_agent.md\":\"cc9897a3\",\"guide_q8.md\":\"3f79bbbf\",\"en_us_guide_q3.md\":\"2c8f5905\",\"guide_q6.md\":\"2387732f\",\"guide_q4.md\":\"385e3441\",\"en_us_guide_q2.md\":\"f03cfb16\",\"guide_q7.md\":\"5f75b305\",\"guide_q5.md\":\"f2042fe7\",\"guide_tasks.md\":\"8f7f039f\",\"en_us_case_case2.md\":\"04a1553e\",\"en_us_developer_theme.md\":\"02a748b8\",\"en_us_case_index.md\":\"e0cbd391\",\"en_us_guide_agentq.md\":\"d6149542\",\"en_us_developer_l10n.md\":\"9c7c5854\",\"guide_q2.md\":\"266cd01b\",\"case_case1.md\":\"5ca7d527\",\"case_case3.md\":\"7b739806\",\"en_us_guide_q5.md\":\"a97be7a8\",\"en_us_guide_q7.md\":\"43c5a1a6\",\"en_us_guide_q4.md\":\"b3bf1aae\",\"en_us_case_case1.md\":\"feb3e39a\",\"en_us_guide_tasks.md\":\"bb6ba1f3\",\"en_us_guide_notifications.md\":\"26ba83c4\",\"en_us_guide_dashboardq.md\":\"0c4d5040\",\"en_us_case_case5.md\":\"3d7ef894\",\"guide_agentq.md\":\"658b47c5\",\"en_us_developer_index.md\":\"11878279\",\"guide_loginq.md\":\"74c0b434\",\"case_case5.md\":\"e585c67c\",\"case_index.md\":\"87221e96\",\"guide_dashboardq.md\":\"23ea658c\",\"en_us_index.md\":\"b913a84e\",\"guide_agent.md\":\"543f423f\",\"guide_api.md\":\"ad4b295f\",\"en_us_case_case3.md\":\"1ac3d51f\",\"case_case4.md\":\"b184f4de\",\"en_us_guide_servers.md\":\"f9e06964\",\"guide_q3.md\":\"a7ac5ff7\",\"guide_services.md\":\"460da91d\",\"en_us_guide_dashboard.md\":\"b5a70b91\",\"guide_settings.md\":\"330c6934\",\"guide_notifications.md\":\"a70fdddd\",\"guide_q1.md\":\"d83a745a\",\"index.md\":\"c944995f\",\"en_us_guide_services.md\":\"2500cf90\",\"guide_servers.md\":\"e4f7abb2\",\"en_us_guide_settings.md\":\"8c07b41e\",\"guide_dashboard.md\":\"f6e4d1f8\",\"en_us_guide_api.md\":\"381d03f9\"}")
__VP_SITE_DATA__ = JSON.parse("{\"lang\":\"zh-CN\",\"dir\":\"ltr\",\"title\":\"VitePress\",\"description\":\"A VitePress site\",\"base\":\"/\",\"head\":[],\"appearance\":true,\"themeConfig\":{\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/nezhahq/nezhahq.github.io\"}],\"algolia\":{\"appId\":\"HP6QF6KMZD\",\"apiKey\":\"fb8bae9ed373d1057e0c07fcf32b3f1a\",\"indexName\":\"nezhahq\"},\"footer\":{\"message\":\"This work is licensed under a <a rel=\\\"license\\\" href=\\\"http://creativecommons.org/licenses/by-nc-sa/4.0/\\\">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) License\",\"copyright\":\"Copyright © 2022-present NezhaHQ\"}},\"locales\":{\"root\":{\"lang\":\"zh-CN\",\"label\":\"简体中文\",\"title\":\"哪吒监控\",\"description\":\"哪吒监控是一个轻量化的运维工具\",\"link\":\"/\",\"themeConfig\":{\"lastUpdatedText\":\"上次更新\",\"editLink\":{\"pattern\":\"https://github.com/nezhahq/nezhahq.github.io/edit/main/docs/:path\",\"text\":\"在GitHub中编辑\"},\"nav\":[{\"text\":\"使用指南\",\"link\":\"/\",\"activeMatch\":\"^/$|^/guide/\"},{\"text\":\"社区项目\",\"link\":\"/case/index.html\",\"activeMatch\":\"^/case/\"},{\"text\":\"开发手册\",\"link\":\"/developer/index.html\",\"activeMatch\":\"^/developer/\"}],\"sidebar\":{\"/\":[{\"text\":\"安装手册\",\"items\":[{\"text\":\"安装 Dashboard\",\"link\":\"/guide/dashboard.html\"},{\"text\":\"安装 Agent\",\"link\":\"/guide/agent.html\"}]},{\"text\":\"管理面板配置\",\"items\":[{\"text\":\"服务器\",\"link\":\"/guide/servers.html\"},{\"text\":\"服务\",\"link\":\"/guide/services.html\"},{\"text\":\"任务\",\"link\":\"/guide/tasks.html\"},{\"text\":\"告警\",\"link\":\"/guide/notifications.html\"},{\"text\":\"设置\",\"link\":\"/guide/settings.html\"},{\"text\":\"API\",\"link\":\"/guide/api.html\"}]},{\"text\":\"常见问题\",\"items\":[{\"text\":\"反向代理 Telegram API\",\"link\":\"/guide/q1.html\"},{\"text\":\"Agent 启动/上线 问题自检流程\",\"link\":\"/guide/q2.html\"},{\"text\":\"反向代理 gRPC 端口\",\"link\":\"/guide/q3.html\"},{\"text\":\"实时通道断开/在线终端连接失败\",\"link\":\"/guide/q4.html\"},{\"text\":\"面板数据迁移、备份和恢复\",\"link\":\"/guide/q5.html\"},{\"text\":\"设置每月重置流量统计\",\"link\":\"/guide/q6.html\"},{\"text\":\"自定义 Agent 监控项目\",\"link\":\"/guide/q7.html\"},{\"text\":\"使用 Cloudflare Access 作为 OAuth2 提供方\",\"link\":\"/guide/q8\"}]},{\"text\":\"排障指南\",\"items\":[{\"text\":\"Dashboard 相关\",\"link\":\"/guide/dashboardq.html\"},{\"text\":\"Agent 相关\",\"link\":\"/guide/agentq.html\"},{\"text\":\"登录相关\",\"link\":\"/guide/loginq.html\"}]}],\"/guide/\":[{\"text\":\"安装手册\",\"items\":[{\"text\":\"安装 Dashboard\",\"link\":\"/guide/dashboard.html\"},{\"text\":\"安装 Agent\",\"link\":\"/guide/agent.html\"}]},{\"text\":\"管理面板配置\",\"items\":[{\"text\":\"服务器\",\"link\":\"/guide/servers.html\"},{\"text\":\"服务\",\"link\":\"/guide/services.html\"},{\"text\":\"任务\",\"link\":\"/guide/tasks.html\"},{\"text\":\"告警\",\"link\":\"/guide/notifications.html\"},{\"text\":\"设置\",\"link\":\"/guide/settings.html\"},{\"text\":\"API\",\"link\":\"/guide/api.html\"}]},{\"text\":\"常见问题\",\"items\":[{\"text\":\"反向代理 Telegram API\",\"link\":\"/guide/q1.html\"},{\"text\":\"Agent 启动/上线 问题自检流程\",\"link\":\"/guide/q2.html\"},{\"text\":\"反向代理 gRPC 端口\",\"link\":\"/guide/q3.html\"},{\"text\":\"实时通道断开/在线终端连接失败\",\"link\":\"/guide/q4.html\"},{\"text\":\"面板数据迁移、备份和恢复\",\"link\":\"/guide/q5.html\"},{\"text\":\"设置每月重置流量统计\",\"link\":\"/guide/q6.html\"},{\"text\":\"自定义 Agent 监控项目\",\"link\":\"/guide/q7.html\"},{\"text\":\"使用 Cloudflare Access 作为 OAuth2 提供方\",\"link\":\"/guide/q8\"}]},{\"text\":\"排障指南\",\"items\":[{\"text\":\"Dashboard 相关\",\"link\":\"/guide/dashboardq.html\"},{\"text\":\"Agent 相关\",\"link\":\"/guide/agentq.html\"},{\"text\":\"登录相关\",\"link\":\"/guide/loginq.html\"}]}],\"/case/\":[{\"text\":\"社区项目\",\"items\":[{\"text\":\"1. 搭建哪吒 Telegram 机器人\",\"link\":\"/case/case1.html\"},{\"text\":\"2. 使用 Siri 语音运行快捷指令查询服务器状态\",\"link\":\"/case/case2.html\"},{\"text\":\"3. 自建多用户多语言 Telegram 服务器状态查询机器人\",\"link\":\"/case/case3.html\"},{\"text\":\"4. Fake-agent,监控数据作弊器\",\"link\":\"/case/case4.html\"},{\"text\":\"5. 使用 Argo 隧道的哪吒服务端\",\"link\":\"/case/case5.html\"}]}],\"/developer/\":[{\"text\":\"开发手册\",\"items\":[{\"text\":\"创建新主题\",\"link\":\"/developer/theme.html\"},{\"text\":\"l10n\",\"link\":\"/developer/l10n.html\"}]}]}}},\"en_US\":{\"lang\":\"en-US\",\"label\":\"English\",\"title\":\"Nezha MoniLine truncated __VP_SITE_DATA__ = JSON.parse("{\"lang\":\"zh-CN\",\"dir\":\"ltr\",\"title\":\"VitePress\",\"description\":\"A VitePress site\",\"base\":\"/\",\"head\":[],\"appearance\":true,\"themeConfig\":{\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/nezhahq/nezhahq.github.io\"}],\"algolia\":{\"appId\":\"HP6QF6KMZD\",\"apiKey\":\"fb8bae9ed373d1057e0c07fcf32b3f1a\",\"indexName\":\"nezhahq\"},\"footer\":{\"message\":\"This work is licensed under a <a rel=\\\"license\\\" href=\\\"http://creativecommons.org/licenses/by-nc-sa/4.0/\\\">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) License\",\"copyright\":\"Copyright © 2022-present NezhaHQ\"}},\"locales\":{\"root\":{\"lang\":\"zh-CN\",\"label\":\"简体中文\",\"title\":\"哪吒监控\",\"description\":\"哪吒监控是一个轻量化的运维工具\",\"link\":\"/\",\"themeConfig\":{\"lastUpdatedText\":\"上次更新\",\"editLink\":{\"pattern\":\"https://github.com/nezhahq/nezhahq.github.io/edit/main/docs/:path\",\"text\":\"在GitHub中编辑\"},\"nav\":[{\"text\":\"使用指南\",\"link\":\"/\",\"activeMatch\":\"^/$|^/guide/\"},{\"text\":\"社区项目\",\"link\":\"/case/index.html\",\"activeMatch\":\"^/case/\"},{\"text\":\"开发手册\",\"link\":\"/developer/index.html\",\"activeMatch\":\"^/developer/\"}],\"sidebar\":{\"/\":[{\"text\":\"安装手册\",\"items\":[{\"text\":\"安装 Dashboard\",\"link\":\"/guide/dashboard.html\"},{\"text\":\"安装 Agent\",\"link\":\"/guide/agent.html\"}]},{\"text\":\"管理面板配置\",\"items\":[{\"text\":\"服务器\",\"link\":\"/guide/servers.html\"},{\"text\":\"服务\",\"link\":\"/guide/services.html\"},{\"text\":\"任务\",\"link\":\"/guide/tasks.html\"},{\"text\":\"告警\",\"link\":\"/guide/notifications.html\"},{\"text\":\"设置\",\"link\":\"/guide/settings.html\"},{\"text\":\"API\",\"link\":\"/guide/api.html\"}]},{\"text\":\"常见问题\",\"items\":[{\"text\":\"反向代理 Telegram API\",\"link\":\"/guide/q1.html\"},{\"text\":\"Agent 启动/上线 问题自检流程\",\"link\":\"/guide/q2.html\"},{\"text\":\"反向代理 gRPC 端口\",\"link\":\"/guide/q3.html\"},{\"text\":\"实时通道断开/在线终端连接失败\",\"link\":\"/guide/q4.html\"},{\"text\":\"面板数据迁移、备份和恢复\",\"link\":\"/guide/q5.html\"},{\"text\":\"设置每月重置流量统计\",\"link\":\"/guide/q6.html\"},{\"text\":\"自定义 Agent 监控项目\",\"link\":\"/guide/q7.html\"},{\"text\":\"使用 Cloudflare Access 作为 OAuth2 提供方\",\"link\":\"/guide/q8\"}]},{\"text\":\"排障指南\",\"items\":[{\"text\":\"Dashboard 相关\",\"link\":\"/guide/dashboardq.html\"},{\"text\":\"Agent 相关\",\"link\":\"/guide/agentq.html\"},{\"text\":\"登录相关\",\"link\":\"/guide/loginq.html\"}]}],\"/guide/\":[{\"text\":\"安装手册\",\"items\":[{\"text\":\"安装 Dashboard\",\"link\":\"/guide/dashboard.html\"},{\"text\":\"安装 Agent\",\"link\":\"/guide/agent.html\"}]},{\"text\":\"管理面板配置\",\"items\":[{\"text\":\"服务器\",\"link\":\"/guide/servers.html\"},{\"text\":\"服务\",\"link\":\"/guide/services.html\"},{\"text\":\"任务\",\"link\":\"/guide/tasks.html\"},{\"text\":\"告警\",\"link\":\"/guide/notifications.html\"},{\"text\":\"设置\",\"link\":\"/guide/settings.html\"},{\"text\":\"API\",\"link\":\"/guide/api.html\"}]},{\"text\":\"常见问题\",\"items\":[{\"text\":\"反向代理 Telegram API\",\"link\":\"/guide/q1.html\"},{\"text\":\"Agent 启动/上线 问题自检流程\",\"link\":\"/guide/q2.html\"},{\"text\":\"反向代理 gRPC 端口\",\"link\":\"/guide/q3.html\"},{\"text\":\"实时通道断开/在线终端连接失败\",\"link\":\"/guide/q4.html\"},{\"text\":\"面板数据迁移、备份和恢复\",\"link\":\"/guide/q5.html\"},{\"text\":\"设置每月重置流量统计\",\"link\":\"/guide/q6.html\"},{\"text\":\"自定义 Agent 监控项目\",\"link\":\"/guide/q7.html\"},{\"text\":\"使用 Cloudflare Access 作为 OAuth2 提供方\",\"link\":\"/guide/q8\"}]},{\"text\":\"排障指南\",\"items\":[{\"text\":\"Dashboard 相关\",\"link\":\"/guide/dashboardq.html\"},{\"text\":\"Agent 相关\",\"link\":\"/guide/agentq.html\"},{\"text\":\"登录相关\",\"link\":\"/guide/loginq.html\"}]}],\"/case/\":[{\"text\":\"社区项目\",\"items\":[{\"text\":\"1. 搭建哪吒 Telegram 机器人\",\"link\":\"/case/case1.html\"},{\"text\":\"2. 使用 Siri 语音运行快捷指令查询服务器状态\",\"link\":\"/case/case2.html\"},{\"text\":\"3. 自建多用户多语言 Telegram 服务器状态查询机器人\",\"link\":\"/case/case3.html\"},{\"text\":\"4. Fake-agent,监控数据作弊器\",\"link\":\"/case/case4.html\"},{\"text\":\"5. 使用 Argo 隧道的哪吒服务端\",\"link\":\"/case/case5.html\"}]}],\"/developer/\":[{\"text\":\"开发手册\",\"items\":[{\"text\":\"创建新主题\",\"link\":\"/developer/theme.html\"},{\"text\":\"l10n\",\"link\":\"/developer/l10n.html\"}]}]}}},\"en_US\":{\"lang\":\"en-US\",\"label\":\"English\",\"title\":\"Nezha MoniLine truncated
</body> </body>
@@ -1 +1 @@
import{_ as e,o as t,c as a,R as r}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1715651890000}'),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 t(),a("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default}; import{_ as e,o as t,c as a,R as r}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1715701589000}'),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 t(),a("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a,R as r}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1715651890000}'),o={name:"case/case1.md"},_=r("",5),s=[_];function i(n,c,p,h,l,d){return t(),a("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default}; import{_ as e,o as t,c as a,R as r}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1715701589000}'),o={name:"case/case1.md"},_=r("",5),s=[_];function i(n,c,p,h,l,d){return t(),a("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default};
@@ -1 +1 @@
import{_ as a}from"./chunks/qrcode.59c44dde.js";import{_ as e,o as r,c as i,R as t}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1715651890000}'),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 r(),i("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; import{_ as a}from"./chunks/qrcode.59c44dde.js";import{_ as e,o as r,c as i,R as t}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1715701589000}'),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 r(),i("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default};
@@ -1 +1 @@
import{_ as a}from"./chunks/qrcode.59c44dde.js";import{_ as e,o as r,c as i,R as t}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1715651890000}'),o={name:"case/case2.md"},c=t("",8),s=[c];function l(d,n,h,_,p,m){return r(),i("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; import{_ as a}from"./chunks/qrcode.59c44dde.js";import{_ as e,o as r,c as i,R as t}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1715701589000}'),o={name:"case/case2.md"},c=t("",8),s=[c];function l(d,n,h,_,p,m){return r(),i("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default};
@@ -1 +1 @@
import{_ as t,o as e,c as a,R as r}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1715651890000}'),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><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 e(),a("div",null,i)}const b=t(d,[["render",o]]);export{f as __pageData,b as default}; import{_ as t,o as e,c as a,R as r}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1715701589000}'),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><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 e(),a("div",null,i)}const b=t(d,[["render",o]]);export{f as __pageData,b as default};
@@ -1 +1 @@
import{_ as t,o as e,c as a,R as r}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1715651890000}'),d={name:"case/case3.md"},l=r("",12),i=[l];function o(h,n,c,s,_,m){return e(),a("div",null,i)}const b=t(d,[["render",o]]);export{f as __pageData,b as default}; import{_ as t,o as e,c as a,R as r}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1715701589000}'),d={name:"case/case3.md"},l=r("",12),i=[l];function o(h,n,c,s,_,m){return e(),a("div",null,i)}const b=t(d,[["render",o]]);export{f as __pageData,b as default};
@@ -1 +1 @@
import{_ as s,o as t,c as e,R as a}from"./chunks/framework.44fd0451.js";const r="/assets/2.38c2ea56.png",n="/assets/5.23139306.png",o="/assets/6.22a61698.png",p="/assets/4.fe6a4e7a.jpg",c="/assets/1.b4b4591f.jpeg",y=JSON.parse('{"title":"重磅推荐!一秒拥有宇宙级算力!让你在人前,不!再!自!卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1715651890000}'),_={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(f,b,h,m,d,k){return t(),e("div",null,l)}const z=s(_,[["render",g]]);export{y as __pageData,z as default}; import{_ as s,o as t,c as e,R as a}from"./chunks/framework.44fd0451.js";const r="/assets/2.38c2ea56.png",n="/assets/5.23139306.png",o="/assets/6.22a61698.png",p="/assets/4.fe6a4e7a.jpg",c="/assets/1.b4b4591f.jpeg",y=JSON.parse('{"title":"重磅推荐!一秒拥有宇宙级算力!让你在人前,不!再!自!卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1715701589000}'),_={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(f,b,h,m,d,k){return t(),e("div",null,l)}const z=s(_,[["render",g]]);export{y as __pageData,z as default};
@@ -1 +1 @@
import{_ as s,o as t,c as e,R as a}from"./chunks/framework.44fd0451.js";const r="/assets/2.38c2ea56.png",n="/assets/5.23139306.png",o="/assets/6.22a61698.png",p="/assets/4.fe6a4e7a.jpg",c="/assets/1.b4b4591f.jpeg",y=JSON.parse('{"title":"重磅推荐!一秒拥有宇宙级算力!让你在人前,不!再!自!卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1715651890000}'),_={name:"case/case4.md"},i=a("",12),l=[i];function g(f,b,h,m,d,k){return t(),e("div",null,l)}const z=s(_,[["render",g]]);export{y as __pageData,z as default}; import{_ as s,o as t,c as e,R as a}from"./chunks/framework.44fd0451.js";const r="/assets/2.38c2ea56.png",n="/assets/5.23139306.png",o="/assets/6.22a61698.png",p="/assets/4.fe6a4e7a.jpg",c="/assets/1.b4b4591f.jpeg",y=JSON.parse('{"title":"重磅推荐!一秒拥有宇宙级算力!让你在人前,不!再!自!卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1715701589000}'),_={name:"case/case4.md"},i=a("",12),l=[i];function g(f,b,h,m,d,k){return t(),e("div",null,l)}const z=s(_,[["render",g]]);export{y as __pageData,z as default};
@@ -1,4 +1,4 @@
import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1715651890000}'),l={name:"case/case5.md"},n=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><h1 id="目录" tabindex="-1">目录 <a class="header-anchor" href="#目录" aria-label="Permalink to &quot;目录&quot;">​</a></h1><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,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1715701589000}'),l={name:"case/case5.md"},n=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><h1 id="目录" tabindex="-1">目录 <a class="header-anchor" href="#目录" aria-label="Permalink to &quot;目录&quot;">​</a></h1><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 style="color:#A6ACCD;"> --name nezha_dashboard \\</span></span> <span class="line"><span style="color:#A6ACCD;"> --name nezha_dashboard \\</span></span>
<span class="line"><span style="color:#A6ACCD;"> --pull always \\</span></span> <span class="line"><span style="color:#A6ACCD;"> --pull always \\</span></span>
<span class="line"><span style="color:#A6ACCD;"> --restart always \\</span></span> <span class="line"><span style="color:#A6ACCD;"> --restart always \\</span></span>
@@ -1 +1 @@
import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1715651890000}'),l={name:"case/case5.md"},n=t("",89),r=[n];function o(c,i,p,h,d,g){return e(),s("div",null,r)}const u=a(l,[["render",o]]);export{m as __pageData,u as default}; import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1715701589000}'),l={name:"case/case5.md"},n=t("",89),r=[n];function o(c,i,p,h,d,g){return e(),s("div",null,r)}const u=a(l,[["render",o]]);export{m as __pageData,u as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1715651890000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default}; import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1715701589000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1715651890000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default}; import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1715701589000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1715651890000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default}; import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1715701589000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1715651890000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default}; import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1715701589000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default};
@@ -1 +1 @@
import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1715651890000}'),l={name:"developer/l10n.md"},r=t('<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>',5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default}; import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1715701589000}'),l={name:"developer/l10n.md"},r=t('<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>',5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default};
@@ -1 +1 @@
import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1715651890000}'),l={name:"developer/l10n.md"},r=t("",5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default}; import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1715701589000}'),l={name:"developer/l10n.md"},r=t("",5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default};
@@ -1 +1 @@
import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1715651890000}'),c={name:"developer/theme.md"},l=t('<h2 id="哪吒主题开发环境" tabindex="-1">哪吒主题开发环境 <a class="header-anchor" href="#哪吒主题开发环境" aria-label="Permalink to &quot;哪吒主题开发环境&quot;">​</a></h2><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,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1715701589000}'),c={name:"developer/theme.md"},l=t('<h2 id="哪吒主题开发环境" tabindex="-1">哪吒主题开发环境 <a class="header-anchor" href="#哪吒主题开发环境" aria-label="Permalink to &quot;哪吒主题开发环境&quot;">​</a></h2><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};
@@ -1 +1 @@
import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1715651890000}'),c={name:"developer/theme.md"},l=t("",7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default}; import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1715701589000}'),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};
@@ -1 +1 @@
import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1715651890000}'),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 t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default}; import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1715701589000}'),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 t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
@@ -1 +1 @@
import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1715651890000}'),a={name:"en_US/case/case1.md"},n=o("",6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default}; import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1715701589000}'),a={name:"en_US/case/case1.md"},n=o("",6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default};
@@ -1 +1 @@
import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1715651890000}'),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 r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default}; import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1715701589000}'),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 r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
@@ -1 +1 @@
import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1715651890000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default}; import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1715701589000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default};
@@ -1 +1 @@
import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1715651890000}'),d={name:"en_US/case/case3.md"},i=a('<h1 id="build-your-own-server-status-query-telegram-bot-with-multi-language-and-multi-user-support" tabindex="-1">Build your own server status query Telegram bot with multi-language and multi-user support <a class="header-anchor" href="#build-your-own-server-status-query-telegram-bot-with-multi-language-and-multi-user-support" aria-label="Permalink to &quot;Build your own server status query Telegram bot with multi-language and multi-user support&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><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),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default}; import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1715701589000}'),d={name:"en_US/case/case3.md"},i=a('<h1 id="build-your-own-server-status-query-telegram-bot-with-multi-language-and-multi-user-support" tabindex="-1">Build your own server status query Telegram bot with multi-language and multi-user support <a class="header-anchor" href="#build-your-own-server-status-query-telegram-bot-with-multi-language-and-multi-user-support" aria-label="Permalink to &quot;Build your own server status query Telegram bot with multi-language and multi-user support&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><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),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default};
@@ -1 +1 @@
import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1715651890000}'),d={name:"en_US/case/case3.md"},i=a("",9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default}; import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1715701589000}'),d={name:"en_US/case/case3.md"},i=a("",9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default};
@@ -1 +1 @@
import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1715651890000}'),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 a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default}; import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1715701589000}'),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 a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
@@ -1 +1 @@
import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1715651890000}'),n={name:"en_US/case/case4.md"},o=r("",5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default}; import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1715701589000}'),n={name:"en_US/case/case4.md"},o=r("",5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default};
@@ -1,4 +1,4 @@
import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1715651890000}'),n={name:"en_US/case/case5.md"},o=s(`<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><h1 id="catalog" tabindex="-1">Catalog <a class="header-anchor" href="#catalog" aria-label="Permalink to &quot;Catalog&quot;">​</a></h1><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,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1715701589000}'),n={name:"en_US/case/case5.md"},o=s(`<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><h1 id="catalog" tabindex="-1">Catalog <a class="header-anchor" href="#catalog" aria-label="Permalink to &quot;Catalog&quot;">​</a></h1><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 style="color:#A6ACCD;"> --name nezha_dashboard \\</span></span> <span class="line"><span style="color:#A6ACCD;"> --name nezha_dashboard \\</span></span>
<span class="line"><span style="color:#A6ACCD;"> --pull always \\</span></span> <span class="line"><span style="color:#A6ACCD;"> --pull always \\</span></span>
<span class="line"><span style="color:#A6ACCD;"> --restart always \\</span></span> <span class="line"><span style="color:#A6ACCD;"> --restart always \\</span></span>
@@ -1 +1 @@
import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1715651890000}'),n={name:"en_US/case/case5.md"},o=s("",89),r=[o];function l(i,c,h,p,d,u){return a(),t("div",null,r)}const f=e(n,[["render",l]]);export{g as __pageData,f as default}; import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1715701589000}'),n={name:"en_US/case/case5.md"},o=s("",89),r=[o];function l(i,c,h,p,d,u){return a(),t("div",null,r)}const f=e(n,[["render",l]]);export{g as __pageData,f as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1715651890000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default}; import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1715701589000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1715651890000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default}; import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1715701589000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1715651890000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default}; import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1715701589000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1715651890000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default}; import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1715701589000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1715651890000}'),o={name:"en_US/developer/l10n.md"},i=n('<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>',5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default}; import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1715701589000}'),o={name:"en_US/developer/l10n.md"},i=n('<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>',5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1715651890000}'),o={name:"en_US/developer/l10n.md"},i=n("",5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default}; import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1715701589000}'),o={name:"en_US/developer/l10n.md"},i=n("",5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default};
@@ -1 +1 @@
import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1715651890000}'),n={name:"en_US/developer/theme.md"},c=a('<h2 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></h2><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 o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default}; import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1715701589000}'),n={name:"en_US/developer/theme.md"},c=a('<h2 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></h2><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 o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
@@ -1 +1 @@
import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1715651890000}'),n={name:"en_US/developer/theme.md"},c=a("",7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default}; import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1715701589000}'),n={name:"en_US/developer/theme.md"},c=a("",7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default};
@@ -1,4 +1,4 @@
import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1715651890000}'),o={name:"en_US/guide/agent.md"},e=l(`<p><strong>The service in the monitored server is called Agent. This document will describe how to install the Agent on the monitored server and connect it with Dashboard</strong></p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>Agent binary repository: <a href="https://github.com/nezhahq/agent/releases" target="_blank" rel="noreferrer">https://github.com/nezhahq/agent/releases</a></p></div><h2 id="install-agent-using-one-click-script" tabindex="-1">Install Agent using one-click script <a class="header-anchor" href="#install-agent-using-one-click-script" aria-label="Permalink to &quot;Install Agent using one-click script&quot;">​</a></h2><p>Nezha Monitoring now supports one-click installation of the Agent on Windows and Linux. Follow the steps in this document and you can easily deploy it on your server<br><br></p><h3 id="preparation" tabindex="-1">Preparation <a class="header-anchor" href="#preparation" aria-label="Permalink to &quot;Preparation&quot;">​</a></h3><p>First of all, you need to set up the communication domain name in the settings page of the admin panel, this domain name can not connect to the CDN, here is the sample communication domain name &quot;data.example.com&quot; mentioned earlier for demonstration<br> Enter the administration panel, go to the &quot;Settings&quot; page, in the item &quot;CDN Bypassed Domain/IP &quot;, fill in the communication domain name, and then click &quot;Save&quot;<br><br></p><h3 id="one-click-installation-on-linux-ubuntu-debian-centos" tabindex="-1">One-click installation on Linux (Ubuntu, Debian, CentOS) <a class="header-anchor" href="#one-click-installation-on-linux-ubuntu-debian-centos" aria-label="Permalink to &quot;One-click installation on Linux (Ubuntu, Debian, CentOS)&quot;">​</a></h3><ul><li>First add a server in the admin panel</li><li>Click on the green Linux icon button next to the newly added server and copy the one-click installation command</li><li>Run the copied one-click installation command on the monitored server, wait for the installation to complete, and then return to the Dashboard home page to see if the server is online.<br><br></li></ul><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><ul><li>First add a server in the admin panel</li><li>Click on the green Linux icon button next to the newly added server and copy the one-click installation command</li><li>Login to Windows Server, open PowerShell, and run the copied installation command in PowerShell</li><li>If you encounter the prompt &quot;Implement Policy Change&quot; please select Y</li><li>Wait for the installation to complete and return to the Dashboard home page to see if the server is online<br><br><br><br></li></ul><h2 id="other-ways-to-install-agent" tabindex="-1">Other ways to install Agent <a class="header-anchor" href="#other-ways-to-install-agent" aria-label="Permalink to &quot;Other ways to install Agent&quot;">​</a></h2><br><h3 id="installing-agent-on-linux-ubuntu-debian-centos" tabindex="-1">Installing Agent on Linux (Ubuntu, Debian, CentOS) <a class="header-anchor" href="#installing-agent-on-linux-ubuntu-debian-centos" aria-label="Permalink to &quot;Installing Agent on Linux (Ubuntu, Debian, CentOS)&quot;">​</a></h3><ul><li>First add a server in the admin panel</li><li>In the monitored server, run the script:</li></ul><div class="language-bash"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">-L</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">-o</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">nezha.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&amp;&amp;</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">chmod</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">+x</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">nezha.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&amp;&amp;</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">sudo</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">./nezha.sh</span></span></code> Line truncated import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1715701589000}'),o={name:"en_US/guide/agent.md"},e=l(`<p><strong>The service in the monitored server is called Agent. This document will describe how to install the Agent on the monitored server and connect it with Dashboard</strong></p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>Agent binary repository: <a href="https://github.com/nezhahq/agent/releases" target="_blank" rel="noreferrer">https://github.com/nezhahq/agent/releases</a></p></div><h2 id="install-agent-using-one-click-script" tabindex="-1">Install Agent using one-click script <a class="header-anchor" href="#install-agent-using-one-click-script" aria-label="Permalink to &quot;Install Agent using one-click script&quot;">​</a></h2><p>Nezha Monitoring now supports one-click installation of the Agent on Windows and Linux. Follow the steps in this document and you can easily deploy it on your server<br><br></p><h3 id="preparation" tabindex="-1">Preparation <a class="header-anchor" href="#preparation" aria-label="Permalink to &quot;Preparation&quot;">​</a></h3><p>First of all, you need to set up the communication domain name in the settings page of the admin panel, this domain name can not connect to the CDN, here is the sample communication domain name &quot;data.example.com&quot; mentioned earlier for demonstration<br> Enter the administration panel, go to the &quot;Settings&quot; page, in the item &quot;CDN Bypassed Domain/IP &quot;, fill in the communication domain name, and then click &quot;Save&quot;<br><br></p><h3 id="one-click-installation-on-linux-ubuntu-debian-centos" tabindex="-1">One-click installation on Linux (Ubuntu, Debian, CentOS) <a class="header-anchor" href="#one-click-installation-on-linux-ubuntu-debian-centos" aria-label="Permalink to &quot;One-click installation on Linux (Ubuntu, Debian, CentOS)&quot;">​</a></h3><ul><li>First add a server in the admin panel</li><li>Click on the green Linux icon button next to the newly added server and copy the one-click installation command</li><li>Run the copied one-click installation command on the monitored server, wait for the installation to complete, and then return to the Dashboard home page to see if the server is online.<br><br></li></ul><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><ul><li>First add a server in the admin panel</li><li>Click on the green Linux icon button next to the newly added server and copy the one-click installation command</li><li>Login to Windows Server, open PowerShell, and run the copied installation command in PowerShell</li><li>If you encounter the prompt &quot;Implement Policy Change&quot; please select Y</li><li>Wait for the installation to complete and return to the Dashboard home page to see if the server is online<br><br><br><br></li></ul><h2 id="other-ways-to-install-agent" tabindex="-1">Other ways to install Agent <a class="header-anchor" href="#other-ways-to-install-agent" aria-label="Permalink to &quot;Other ways to install Agent&quot;">​</a></h2><br><h3 id="installing-agent-on-linux-ubuntu-debian-centos" tabindex="-1">Installing Agent on Linux (Ubuntu, Debian, CentOS) <a class="header-anchor" href="#installing-agent-on-linux-ubuntu-debian-centos" aria-label="Permalink to &quot;Installing Agent on Linux (Ubuntu, Debian, CentOS)&quot;">​</a></h3><ul><li>First add a server in the admin panel</li><li>In the monitored server, run the script:</li></ul><div class="language-bash"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">-L</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">-o</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">nezha.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&amp;&amp;</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">chmod</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">+x</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">nezha.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&amp;&amp;</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">sudo</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">./nezha.sh</span></span></code> Line truncated
<span class="line"><span style="color:#C3E88D;">#!/sbin/openrc-run</span></span> <span class="line"><span style="color:#C3E88D;">#!/sbin/openrc-run</span></span>
<span class="line"><span style="color:#C3E88D;">SERVER=&quot;&quot; #Dashboard address ip:port</span></span> <span class="line"><span style="color:#C3E88D;">SERVER=&quot;&quot; #Dashboard address ip:port</span></span>
<span class="line"><span style="color:#C3E88D;">SECRET=&quot;&quot; #SECRET</span></span> <span class="line"><span style="color:#C3E88D;">SECRET=&quot;&quot; #SECRET</span></span>
@@ -1 +1 @@
import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1715651890000}'),o={name:"en_US/guide/agent.md"},e=l("",75),p=[e];function t(r,c,i,D,y,C){return n(),a("div",null,p)}const u=s(o,[["render",t]]);export{h as __pageData,u as default}; import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1715701589000}'),o={name:"en_US/guide/agent.md"},e=l("",75),p=[e];function t(r,c,i,D,y,C){return n(),a("div",null,p)}const u=s(o,[["render",t]]);export{h as __pageData,u as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1715651890000}'),i={name:"en_US/guide/agentq.md"},o=n('<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"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">apt</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">install</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">sudo</span></span></code></pre></div>',8),l=[o];function r(s,c,d,h,p,u){return t(),a("div",null,l)}const _=e(i,[["render",r]]);export{f as __pageData,_ as default}; import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1715701589000}'),i={name:"en_US/guide/agentq.md"},o=n('<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"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">apt</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">install</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">sudo</span></span></code></pre></div>',8),l=[o];function r(s,c,d,h,p,u){return t(),a("div",null,l)}const _=e(i,[["render",r]]);export{f as __pageData,_ as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1715651890000}'),i={name:"en_US/guide/agentq.md"},o=n("",8),l=[o];function r(s,c,d,h,p,u){return t(),a("div",null,l)}const _=e(i,[["render",r]]);export{f as __pageData,_ as default}; import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1715701589000}'),i={name:"en_US/guide/agentq.md"},o=n("",8),l=[o];function r(s,c,d,h,p,u){return t(),a("div",null,l)}const _=e(i,[["render",r]]);export{f as __pageData,_ as default};
@@ -1,4 +1,4 @@
import{_ as s,o as a,c as n,R as o}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1715651890000}'),l={name:"en_US/guide/api.md"},p=o(`<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-"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#A6ACCD;">Request Headers:</span></span> import{_ as s,o as a,c as n,R as o}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1715701589000}'),l={name:"en_US/guide/api.md"},p=o(`<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-"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#A6ACCD;">Request Headers:</span></span>
<span class="line"><span style="color:#A6ACCD;">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-"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#A6ACCD;">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"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">{</span></span> <span class="line"><span style="color:#A6ACCD;">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-"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#A6ACCD;">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"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">code</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#F78C6C;">0</span><span style="color:#89DDFF;">,</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">code</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#F78C6C;">0</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">message</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">success</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">message</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">success</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
@@ -1 +1 @@
import{_ as s,o as a,c as n,R as o}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1715651890000}'),l={name:"en_US/guide/api.md"},p=o("",32),e=[p];function t(D,r,c,F,y,C){return a(),n("div",null,e)}const u=s(l,[["render",t]]);export{i as __pageData,u as default}; import{_ as s,o as a,c as n,R as o}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1715701589000}'),l={name:"en_US/guide/api.md"},p=o("",32),e=[p];function t(D,r,c,F,y,C){return a(),n("div",null,e)}const u=s(l,[["render",t]]);export{i as __pageData,u as default};
@@ -1,4 +1,4 @@
import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1715651890000}'),s={name:"en_US/guide/dashboard.md"},n=o(`<h2 id="preparations" tabindex="-1">Preparations <a class="header-anchor" href="#preparations" aria-label="Permalink to &quot;Preparations&quot;">​</a></h2><p>To setup a Nezha monitorning Dashboard, you need these things:</p><ol><li>A VPS that can connect to the Internet, firewall and security policies need to open ports 8008 and 5555, otherwise it will be inaccessible and unable to receive data. A 1 core 512MB RAM server is sufficient for most usage scenarios</li><li>A domain name that has been set up with an A record that resolves to the Dashboard server IP</li></ol><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>If you want to use CDN, please prepare two domains, one connect to CDN for public access, CDN needs to support WebSocket protocol; the other domain should not connect to CDN, use it as Agent to send data to Dashboard.<br> This document uses &quot;cdn.example.com&quot; and &quot;data.example.com&quot; domains to demonstrate respectively</p></div><ol start="3"><li>A Github or Gitlab account</li></ol><p><strong>This document will use the aaPanel as an example, with future versions of the changes, some of the features may change, this document is for reference only</strong></p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>This project does not rely on aaPanel, you can choose to use any server panel you like, and if you are capable enough, you can manually install NginX or Caddy to configure SSL and reverse proxy.<br> If you don&#39;t think it&#39;s necessary to use port 80 or 443 to access Dashboard, you don&#39;t even need to install NginX and you can just use the install script.</p></div><br><br><h2 id="get-the-client-id-and-client-secret-on-github-gitlab" tabindex="-1">Get the Client ID and Client Secret on Github/Gitlab <a class="header-anchor" href="#get-the-client-id-and-client-secret-on-github-gitlab" aria-label="Permalink to &quot;Get the Client ID and Client Secret on Github/Gitlab&quot;">​</a></h2><p>Nezha Monitor uses a Github account as the login account for the admin panel</p><ul><li>First we need to create a new authentication application, after logging into Github, open <a href="https://github.com/settings/developers" target="_blank" rel="noreferrer">https://github.com/settings/developers</a> and select &quot;OAuth Apps&quot; - &quot;New OAuth App &quot;<br><code>Application name</code> - Fill in as you like<br><code>Homepage URL</code> - Fill in the panel&#39;s access domain name, such as: &quot;<a href="http://cdn.example.com" target="_blank" rel="noreferrer">http://cdn.example.com</a>&quot;<br><code>Authorization callback URL</code> - Fill in the callback address, e.g., &quot;<a href="http://cdn.example.com/oauth2/callback" target="_blank" rel="noreferrer">http://cdn.example.com/oauth2/callback</a>&quot;</li><li>Click on &quot;Registration Application&quot;</li><li>Remember the Client ID in the page, then click &quot;Generate a new client secret&quot; to create a new Client Secret, the new secret will be displayed only once, please save it properly <br><br></li><li>If you&#39;re using Gitlab, you&#39;ll need to go to <a href="https://gitlab.com/-/profile/applications" target="_blank" rel="noreferrer">https://gitlab.com/-/profile/applications</a> to create a new application</li><li>Fill in <code>Redirect URL</code> with the callback address</li><li>In <code>Scopes</code>, select <code>read_user</code> and <code>read_api</code></li><li>Once created, save the Application ID and Secret</li></ul><h2 id="installing-dashboard-on-the-server" tabindex="-1">Installing Dashboard on the server <a class="header-anchor" href="#installing-dashboard-on-the-server" aria-label="Permalink to &quot;Installing Dashboard on the server&quot;">​</a></h2><ul><li>In the panel server, run the installation script:</li></ul><div class="language-bash"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">-L</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">-o</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">nezha.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&amp;&amp;</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">chmod</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">+x</span><span style="color Line truncated import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1715701589000}'),s={name:"en_US/guide/dashboard.md"},n=o(`<h2 id="preparations" tabindex="-1">Preparations <a class="header-anchor" href="#preparations" aria-label="Permalink to &quot;Preparations&quot;">​</a></h2><p>To setup a Nezha monitorning Dashboard, you need these things:</p><ol><li>A VPS that can connect to the Internet, firewall and security policies need to open ports 8008 and 5555, otherwise it will be inaccessible and unable to receive data. A 1 core 512MB RAM server is sufficient for most usage scenarios</li><li>A domain name that has been set up with an A record that resolves to the Dashboard server IP</li></ol><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>If you want to use CDN, please prepare two domains, one connect to CDN for public access, CDN needs to support WebSocket protocol; the other domain should not connect to CDN, use it as Agent to send data to Dashboard.<br> This document uses &quot;cdn.example.com&quot; and &quot;data.example.com&quot; domains to demonstrate respectively</p></div><ol start="3"><li>A Github or Gitlab account</li></ol><p><strong>This document will use the aaPanel as an example, with future versions of the changes, some of the features may change, this document is for reference only</strong></p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>This project does not rely on aaPanel, you can choose to use any server panel you like, and if you are capable enough, you can manually install NginX or Caddy to configure SSL and reverse proxy.<br> If you don&#39;t think it&#39;s necessary to use port 80 or 443 to access Dashboard, you don&#39;t even need to install NginX and you can just use the install script.</p></div><br><br><h2 id="get-the-client-id-and-client-secret-on-github-gitlab" tabindex="-1">Get the Client ID and Client Secret on Github/Gitlab <a class="header-anchor" href="#get-the-client-id-and-client-secret-on-github-gitlab" aria-label="Permalink to &quot;Get the Client ID and Client Secret on Github/Gitlab&quot;">​</a></h2><p>Nezha Monitor uses a Github account as the login account for the admin panel</p><ul><li>First we need to create a new authentication application, after logging into Github, open <a href="https://github.com/settings/developers" target="_blank" rel="noreferrer">https://github.com/settings/developers</a> and select &quot;OAuth Apps&quot; - &quot;New OAuth App &quot;<br><code>Application name</code> - Fill in as you like<br><code>Homepage URL</code> - Fill in the panel&#39;s access domain name, such as: &quot;<a href="http://cdn.example.com" target="_blank" rel="noreferrer">http://cdn.example.com</a>&quot;<br><code>Authorization callback URL</code> - Fill in the callback address, e.g., &quot;<a href="http://cdn.example.com/oauth2/callback" target="_blank" rel="noreferrer">http://cdn.example.com/oauth2/callback</a>&quot;</li><li>Click on &quot;Registration Application&quot;</li><li>Remember the Client ID in the page, then click &quot;Generate a new client secret&quot; to create a new Client Secret, the new secret will be displayed only once, please save it properly <br><br></li><li>If you&#39;re using Gitlab, you&#39;ll need to go to <a href="https://gitlab.com/-/profile/applications" target="_blank" rel="noreferrer">https://gitlab.com/-/profile/applications</a> to create a new application</li><li>Fill in <code>Redirect URL</code> with the callback address</li><li>In <code>Scopes</code>, select <code>read_user</code> and <code>read_api</code></li><li>Once created, save the Application ID and Secret</li></ul><h2 id="installing-dashboard-on-the-server" tabindex="-1">Installing Dashboard on the server <a class="header-anchor" href="#installing-dashboard-on-the-server" aria-label="Permalink to &quot;Installing Dashboard on the server&quot;">​</a></h2><ul><li>In the panel server, run the installation script:</li></ul><div class="language-bash"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">-L</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">-o</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">nezha.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&amp;&amp;</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">chmod</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">+x</span><span style="color Line truncated
<span class="line"><span style="color:#C792EA;">location</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">/ </span><span style="color:#A6ACCD;">{</span></span> <span class="line"><span style="color:#C792EA;">location</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">/ </span><span style="color:#A6ACCD;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> proxy_pass </span><span style="color:#A6ACCD;">http://127.0.0.1:8008</span><span style="color:#89DDFF;">;</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> proxy_pass </span><span style="color:#A6ACCD;">http://127.0.0.1:8008</span><span style="color:#89DDFF;">;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> proxy_set_header </span><span style="color:#A6ACCD;">Host </span><span style="color:#89DDFF;">$</span><span style="color:#A6ACCD;">http_host</span><span style="color:#89DDFF;">;</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> proxy_set_header </span><span style="color:#A6ACCD;">Host </span><span style="color:#89DDFF;">$</span><span style="color:#A6ACCD;">http_host</span><span style="color:#89DDFF;">;</span></span>
@@ -1 +1 @@
import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1715651890000}'),s={name:"en_US/guide/dashboard.md"},n=o("",41),l=[n];function r(i,p,c,d,h,u){return a(),t("div",null,l)}const m=e(s,[["render",r]]);export{y as __pageData,m as default}; import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1715701589000}'),s={name:"en_US/guide/dashboard.md"},n=o("",41),l=[n];function r(i,p,c,d,h,u){return a(),t("div",null,l)}const m=e(s,[["render",r]]);export{y as __pageData,m as default};
@@ -1,4 +1,4 @@
import{_ as e,o as a,c as s,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1715651890000}'),t={name:"en_US/guide/dashboardq.md"},n=o(`<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"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">https://ipapi.co/ip/</span></span> import{_ as e,o as a,c as s,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1715701589000}'),t={name:"en_US/guide/dashboardq.md"},n=o(`<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"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">https://ipapi.co/ip/</span></span>
<span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">ip.sb</span></span> <span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">ip.sb</span></span>
<span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">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"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">systemctl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">status</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">docker</span></span> <span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">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"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">systemctl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">status</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">docker</span></span>
<span class="line"><span style="color:#FFCB6B;">systemctl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">restart</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">docker</span></span> <span class="line"><span style="color:#FFCB6B;">systemctl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">restart</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">docker</span></span>
@@ -1 +1 @@
import{_ as e,o as a,c as s,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1715651890000}'),t={name:"en_US/guide/dashboardq.md"},n=o("",22),r=[n];function i(l,p,d,c,h,u){return a(),s("div",null,r)}const f=e(t,[["render",i]]);export{y as __pageData,f as default}; import{_ as e,o as a,c as s,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1715701589000}'),t={name:"en_US/guide/dashboardq.md"},n=o("",22),r=[n];function i(l,p,d,c,h,u){return a(),s("div",null,r)}const f=e(t,[["render",i]]);export{y as __pageData,f as default};
@@ -1 +1 @@
import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1715651890000}'),i={name:"en_US/guide/loginq.md"},r=a('<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 id="the-user-is-not-an-admin-of-this-site-and-cannot-log-in" tabindex="-1">The user is not an admin of this site and cannot log in <a class="header-anchor" href="#the-user-is-not-an-admin-of-this-site-and-cannot-log-in" aria-label="Permalink to &quot;The user is not an admin of this site anLine truncated import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1715701589000}'),i={name:"en_US/guide/loginq.md"},r=a('<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 id="the-user-is-not-an-admin-of-this-site-and-cannot-log-in" tabindex="-1">The user is not an admin of this site and cannot log in <a class="header-anchor" href="#the-user-is-not-an-admin-of-this-site-and-cannot-log-in" aria-label="Permalink to &quot;The user is not an admin of this site anLine truncated
@@ -1 +1 @@
import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1715651890000}'),i={name:"en_US/guide/loginq.md"},r=a("",21),n=[r];function s(l,c,h,d,u,p){return o(),t("div",null,n)}const b=e(i,[["render",s]]);export{g as __pageData,b as default}; import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1715701589000}'),i={name:"en_US/guide/loginq.md"},r=a("",21),n=[r];function s(l,c,h,d,u,p){return o(),t("div",null,n)}const b=e(i,[["render",s]]);export{g as __pageData,b as default};
@@ -0,0 +1,40 @@
import{_ as o,o as s,c as a,R as e}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1715701589000}'),n={name:"en_US/guide/notifications.md"},t=e(`<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-parameter-acquisition-instructions-1" tabindex="-1">URL Parameter Acquisition Instructions <a class="header-anchor" href="#url-parameter-acquisition-instructions-1" aria-label="Permalink to &quot;URL Parameter Acquisition Instructions&quot;"> Line truncated
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">message</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#FFCB6B;">subject</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">Server Status Notification</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#FFCB6B;">body</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#F78C6C;">contentType</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">Text</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#F78C6C;">content</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#NEZHA#</span><span style="color:#89DDFF;">&quot;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">},</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#FFCB6B;">toRecipients</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">[</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#F78C6C;">emailAddress</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#F07178;">address</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">ADDRESS FOR RECEVING EMAILS</span><span style="color:#89DDFF;">&quot;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">}</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">}</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">]</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">}</span></span>
<span class="line"><span style="color:#89DDFF;">}</span></span></code></pre></div></li></ul></details><h3 id="dingtalk-group-bot-configuration-example" tabindex="-1">DingTalk Group Bot Configuration Example <a class="header-anchor" href="#dingtalk-group-bot-configuration-example" aria-label="Permalink to &quot;DingTalk Group Bot Configuration Example&quot;">​</a></h3><details><summary>Click to expand/collapse</summary><h4 id="url-parameter-acquisition-instructions-3" tabindex="-1">URL Parameter Acquisition Instructions <a class="header-anchor" href="#url-parameter-acquisition-instructions-3" aria-label="Permalink to &quot;URL Parameter Acquisition Instructions&quot;">​</a></h4><p>Create a bot in DingTalk in advance and get the bot&#39;s token.</p><p>The bot URL is obtained after creating a bot in the DingTalk group - Manage Bot - Create Bot. Choose custom keywords for the security method, and the Body content value must contain these keywords.</p><ul><li>Name: Nezha Assistant</li><li>URL: <a href="https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxxxxxxxxxxx" target="_blank" rel="noreferrer">https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxxxxxxxxxxx</a></li><li>Request Method: POST</li><li>Request Type: JSON</li><li>Header: <code>{&quot;Content-Type&quot;: &quot;application/json&quot;}</code></li><li>Body: <code>{&quot;msgtype&quot;: &quot;text&quot;,&quot;text&quot;: {&quot;content&quot;:&quot;Nezha Probe:\\n#NEZHA#&quot;}}</code></li></ul></details><h3 id="wechat-work-group-bot-example-contributor-chowrex" tabindex="-1">WeChat Work Group Bot Example Contributor: <a href="https://github.com/ChowRex" target="_blank" rel="noreferrer">@ChowRex</a> <a class="header-anchor" href="#wechat-work-group-bot-example-contributor-chowrex" aria-label="Permalink to &quot;WeChat Work Group Bot Example Contributor: [@ChowRex](https://github.com/ChowRex)&quot;">​</a></h3><details><summary>Click to expand/collapse</summary><p>Supported placeholders list</p><div class="language-json"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">content</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#NEZHA#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerName</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NAME#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerIP</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.IP#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerIPV4</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.IPV4#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerIPV6</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.IPV6#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">CPU</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.CPU#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">MEM</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.MEM#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">SWAP</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.SWAP#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">DISK</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.DISK#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">NetInSpeed</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NETINSPEED#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">NetOutSpeed</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NETOUTSPEED#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">TransferIn</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFERIN#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">TranferOut</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFEROUT#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">Load1</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD1#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">Load5</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD5#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">Load15</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD15#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">TCP_CONN_COUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.TCPCONNCOUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span><span style="color:#A6ACCD;"> # invalid</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">UDP_CONN_COUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.UDPCONNCOUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span><span style="color:#A6ACCD;"> # invalid</span></span>
<span class="line"><span style="color:#89DDFF;">}</span></span></code></pre></div><blockquote><p>This document is <strong>NOT</strong> available in English.</p><p><a href="https://developer.work.weixin.qq.com/document/path/91770#markdown%E7%B1%BB%E5%9E%8B" target="_blank" rel="noreferrer">Group Bot Configuration Instructions - Document - WeChat Work Developer Center</a></p></blockquote><ul><li>Name: WeChat Work Group Bot</li><li>URL: <a href="https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=YOUR_BOT_KEY" target="_blank" rel="noreferrer">https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=YOUR_BOT_KEY</a></li><li>Request Method: POST</li><li>Request Type: JSON</li><li>Body:<div class="language-json"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">msgtype</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">markdown</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">markdown</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#FFCB6B;">content</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;"># Nezha Notification</span><span style="color:#A6ACCD;">\\n\\n\\&quot;</span><span style="color:#C3E88D;">#NEZHA#</span><span style="color:#A6ACCD;">\\&quot;\\n\\n</span><span style="color:#C3E88D;">&gt; Name: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.NAME#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; IP: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.IP#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; IPv4: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.IPV4#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">IPv6: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.IPV6#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; CPU: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.CPU#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Memory: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.MEM#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Swap: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.SWAP#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Disk: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.DISK#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Upload Speed: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.NETINSPEED#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Download Speed: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.NETOUTSPEED#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Total Upload: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFERIN#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Total Download: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFEROUT#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Load1: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD1#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Load5: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD5#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Load15: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD15#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; TCP Connection Count: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.TCPCONNCOUNT</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; UDP Connection Count: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.UDPCONNCOUNT</span><span style="color:#A6ACCD;">\\&quot;\\n\\n</span><span style="color:#89DDFF;">&quot;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">}</span></span>
<span class="line"><span style="color:#89DDFF;">}</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>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></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 statistical cycle (can be the start date of your server billing cycle). The time format is RFC3339, e.g., Beijing Line truncated
@@ -0,0 +1 @@
import{_ as o,o as s,c as a,R as e}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1715701589000}'),n={name:"en_US/guide/notifications.md"},t=e("",43),l=[t];function p(r,c,i,u,D,y){return s(),a("div",null,l)}const C=o(n,[["render",p]]);export{F as __pageData,C as default};
@@ -1,40 +0,0 @@
import{_ as o,o as s,c as e,R as t}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1715651890000}'),n={name:"en_US/guide/notifications.md"},a=t(`<p>Nezha Monitoring supports monitoring of server load, CPU, memory, hard disk, data transfer, monthly data transfer, number of processes, number of connections, and sends alarm notifications when one of these items reaches a user-set limit.<br><br><br></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><p>In panel messages, the placeholder <code>#DATETIME#</code> represents the timestamp of when an event occurs. When the notification is triggered, the panel automatically replaces #DATETIME# with the actual time of the event.</p><p><code>#NEZHA#</code> is the panel message placeholder, the panel will automatically replace the placeholder with the actual message when it triggers the notification</p><p>The content of Body is in <code>JSON</code> format:<strong>When the request type is FORM</strong>,the value is in the form of <code>key:value</code>,<code>value</code> can contain placeholders that will be automatically replaced when notified. <strong>When the request type is JSON</strong> It will only do string substitution and submit to the <code>URL</code> directly.</p><p>Placeholders can also be placed inside the URL, and it will perform a simple string substitution when requested.</p><p>Refer to the example below, it is very flexible.</p><ul><li><p><strong>Bark Example</strong></p><ul><li><p>Name: Bark</p></li><li><p>URL: The first part is the key, followed by three matches/: 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: null</p></li><li><p>Name: Bark</p></li><li><p>URL:/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></li><li><p><strong>Telegram Example, contributed by <a href="https://github.com/haitau" target="_blank" rel="noreferrer">@haitau</a></strong></p><ul><li>Name:Telegram Robot message notification</li><li>URL:<a href="https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&amp;text=#NEZHA#" target="_blank" rel="noreferrer">https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&amp;text=#NEZHA#</a></li><li>Request method: GET</li><li>Request type: default</li><li>Body: null</li><li>Notes for this method:The XXXXXX in botXXXXXX is the token provided when you follow the official @Botfather in Telegram and enter /newbot to create a new bot. (In the line after <em>Use this token to access the HTTP API</em>). The &#39;bot&#39; are essential. After creating a bot, you need to talk to the BOT in Telegram (send a random message) before you can send a message by using API. YYYYYY is Telegram user&#39;s ID, you can get it by talking to the bot @userinfobot.</li></ul></li><li><p><strong>Email notification example - Outlook</strong></p><ul><li>Name: MS Mail Notification</li><li>URL:<a href="https://graph.microsoft.com/v1.0/me/microsoft.graph.sendMail" target="_blank" rel="noreferrer">https://graph.microsoft.com/v1.0/me/microsoft.graph.sendMail</a></li><li>Request method: POST</li><li>Request type: JSON</li><li>Header: <code>{&quot;Content-type&quot;:&quot;application/json&quot;, &quot;Authorization&quot;:&quot;Bearer {Token}&quot;}</code></li><li>Body:</li></ul><div class="language-json"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">message</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#FFCB6B;">subject</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">Server Status Notification</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#FFCB6B;">body</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#F78C6C;">contentType</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">Text</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#F78C6C;">content</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#NEZHA#</span><span style="color:#89DDFF;">&quot;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">},</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#FFCB6B;">toRecipients</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">[</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#F78C6C;">emailAddress</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#F07178;">address</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">ADDRESS FOR RECEVING EMAILS</span><span style="color:#89DDFF;">&quot;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">}</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">}</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">]</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">}</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">}</span></span></code></pre></div><p>Notes for this method: This method requires calling Microsoft Graph V1.0, you need to go to Microsoft Graph and create your own application, give <code>Mail.Send</code> permission and get the Token, or you can go <a href="https://developer.microsoft.com/en-us/graph/graph-explorer" target="_blank" rel="noreferrer">Microsoft Graph Explorer</a> directly to give permission and get the Token, just replace the Token in the Header with the actual Token.</p></li><li><p><strong>DingTalk Group bot notification Example</strong></p><ul><li><p>Name: DingTalk Group</p></li><li><p>URL: <a href="https://oapi.dingtalk.com/robot/send?access_token=xxxxxxx" target="_blank" rel="noreferrer">https://oapi.dingtalk.com/robot/send?access_token=xxxxxxx</a></p></li><li><p>Request method: POST</p></li><li><p>Request Type: JSON</p></li><li><p>Header: <code>{&quot;Content-Type&quot;: &quot;application/json&quot;}</code></p></li><li><p>Body: <code>{&quot;msgtype&quot;: &quot;text&quot;,&quot;text&quot;: {&quot;content&quot;:&quot;nezha:\\n#NEZHA#&quot;}}</code></p></li><li><p>Notes for this method:URL:Creating bot in DingTalk groups to obtain bot URLs, Security settings validation set to custom keywords,The security settings validation is set to a custom keyword, and the keyword must be included in the content field of the body, such as nezha</p></li><li><p><strong>Wechat Work Group bot Example, contributed by <a href="https://github.com/ChowRex" target="_blank" rel="noreferrer">@ChowRex</a></strong></p><p>Support placeholders:</p><div class="language-json"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">content</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#NEZHA#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerName</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NAME#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerIP</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.IP#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerIPV4</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.IPV4#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerIPV6</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.IPV6#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">CPU</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.CPU#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">MEM</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.MEM#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">SWAP</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.SWAP#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">DISK</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.DISK#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">NetInSpeed</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NETINSPEED#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">NetOutSpeed</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NETOUTSPEED#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">TransferIn</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFERIN#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">TranferOut</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFEROUT#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">Load1</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD1#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">Load5</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD5#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">Load15</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD15#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">TCP_CONN_COUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.TCPCONNCOUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span><span style="color:#A6ACCD;"> # Invalid</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">UDP_CONN_COUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.UDPCONNCOUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span><span style="color:#A6ACCD;"> # Invalid</span></span>
<span class="line"><span style="color:#89DDFF;">}</span></span></code></pre></div><blockquote><p>Sorry, this document is <strong>NOT</strong> available in English.</p><p><a href="https://developer.work.weixin.qq.com/document/path/91770#markdown%E7%B1%BB%E5%9E%8B" target="_blank" rel="noreferrer">群机器人配置说明 - 文档 - 企业微信开发者中心</a></p></blockquote><ul><li><p>Name:WechatWork Group bot notification</p></li><li><p>URL:<a href="https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=YOUR_BOT_KEY" target="_blank" rel="noreferrer">https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=YOUR_BOT_KEY</a></p></li><li><p>Request method: POST</p></li><li><p>Request type: JSON</p></li><li><p>Body:</p><div class="language-json"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">msgtype</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">markdown</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">markdown</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#FFCB6B;">content</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;"># Nezha Notification</span><span style="color:#A6ACCD;">\\n\\n\\&quot;</span><span style="color:#C3E88D;">#NEZHA#</span><span style="color:#A6ACCD;">\\&quot;\\n\\n</span><span style="color:#C3E88D;">&gt; ServerName: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.NAME#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; IP: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.IP#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; IPv4: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.IPV4#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; IPv6: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.IPV6#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; CPU: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.CPU#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Memory: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.MEM#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; SWAP: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.SWAP#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Storage: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.DISK#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Real-time Upload: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.NETINSPEED#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Real-time Download: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.NETOUTSPEED#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Total Upload: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFERIN#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; Total Download: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFEROUT#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 1m Load: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD1#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 5m Load: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD5#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 15m Load: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD15#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; TCP Connections: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.TCPCONNCOUNT</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; UDP Connections: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.UDPCONNCOUNT</span><span style="color:#A6ACCD;">\\&quot;\\n\\n</span><span style="color:#89DDFF;">&quot;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">}</span></span>
<span class="line"><span style="color:#89DDFF;">}</span></span></code></pre></div><p>Delete relevant content information as needed</p><p><img src="https://user-images.githubusercontent.com/30169860/223605886-b7736825-24b8-4b6c-8bc9-96ac388599ef.png" alt="Notice Picture"></p></li></ul></li></ul></li></ul><br><br><h2 id="description-of-notification-rules" tabindex="-1">Description of notification rules <a class="header-anchor" href="#description-of-notification-rules" aria-label="Permalink to &quot;Description of notification rules&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>Type: one or more types can be selected, such as in a rule to select more than one type, you need to <strong>meet all the selected types at the same time</strong> to trigger the notification (see the example later) <ul><li><code>cpu</code>、<code>memory</code>、<code>swap</code>、<code>disk</code></li><li><code>net_in_speed</code> Inbound speed, <code>net_out_speed</code> Outbound speed, <code>net_all_speed</code> Inbound + Outbound speed, <code>transfer_in</code> Inbound Transfer, <code>transfer_out</code> Outbound Transfer, <code>transfer_all</code> Total Transfer</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> Number of processes <em>Currently, counting the number of processes takes up too many resources and is not supported at the moment</em></li><li><code>tcp_conn_count</code>、<code>udp_conn_count</code> Number of connections</li></ul></li><li>duration:Lasting for a few seconds, the notification will only be triggered when the sampling record reaches 30% or more within a few seconds</li><li>min/max <ul><li>Transfer, network speed, and other values of the same type. Unit is byte (1KB=1024B,1MB = 1024*1024B)</li><li>Memory, hard disk, CPU. units are usage percentages</li><li>No setup required for offline monitoring</li></ul></li><li>cover <code>[{&quot;type&quot;:&quot;offline&quot;,&quot;duration&quot;:10, &quot;cover&quot;:0, &quot;ignore&quot;:{&quot;5&quot;: true}}]</code><ul><li><code>0</code> Cover all, use <code>ignore</code> to ignore specific servers</li><li><code>1</code> Ignore all, use <code>ignore</code> to monitoring specific servers<br> For 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>ignore: Select to ignore specific servers, use with <code>cover</code> with server id and boolean, e.g.: <code>{&quot;1&quot;: true, &quot;2&quot;:false}</code></li></ul><p><strong>Complete examples:</strong></p><blockquote><blockquote><p>Add an offline notification</p></blockquote><ul><li>Name: Offline notification</li><li>Rules: <code>[{&quot;Type&quot;:&quot;offline&quot;,&quot;Duration&quot;:10}]</code></li><li>Enable: √</li></ul></blockquote><blockquote><blockquote><p>Add an notification when the CPU exceeds 50% for 10s <strong>but</strong> the memory usage is below 20% for 20s</p></blockquote><ul><li>Name: CPU and RAM</li><li>Rules: <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>Enable: √</li></ul></blockquote><blockquote><blockquote><p>Send specific server notifications to specific notification groups</p></blockquote><p>Case:<br> You have four servers, 1, 2, 3, 4, and two different notification groups, A and B<br> 1, 2 The two servers are down for 10 minutes and send a notification to Notification Group A<br> 3, 4 These two servers are down for ten minutes and then send a notification to Notification Group B</p><p>First you need to set up two notification groups, A and B, and then add two alarm rules:</p><p><strong>Rule I:</strong></p><ul><li>Name: 1, 2 Off-line, send notification to group A</li><li>Rules:<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>Enable: √</li></ul><p><strong>Rule II:</strong></p><ul><li>Name: 3, 4 Off-line, send notification to group B</li><li>Rules:<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>Enable: √</li></ul></blockquote><p><strong>Using these rules flexibly will help you to make full use of the notification function</strong></p><br><h3 id="special-any-cycle-transfer-notification" tabindex="-1">Special: Any-cycle transfer notification <a class="header-anchor" href="#special-any-cycle-transfer-notification" aria-label="Permalink to &quot;Special: Any-cycle transfer Line truncated
@@ -1 +0,0 @@
import{_ as o,o as s,c as e,R as t}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1715651890000}'),n={name:"en_US/guide/notifications.md"},a=t("",28),l=[a];function p(r,c,i,u,D,y){return s(),e("div",null,l)}const q=o(n,[["render",p]]);export{F as __pageData,q as default};
@@ -1 +1 @@
import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.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":1715651890000}'),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 t(),o("div",null,s)}const f=e(r,[["render",i]]);export{g as __pageData,f as default}; import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.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":1715701589000}'),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 t(),o("div",null,s)}const f=e(r,[["render",i]]);export{g as __pageData,f as default};
@@ -1 +1 @@
import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.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":1715651890000}'),r={name:"en_US/guide/q2.md"},a=n("",2),s=[a];function i(c,l,d,h,p,u){return t(),o("div",null,s)}const f=e(r,[["render",i]]);export{g as __pageData,f as default}; import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.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":1715701589000}'),r={name:"en_US/guide/q2.md"},a=n("",2),s=[a];function i(c,l,d,h,p,u){return t(),o("div",null,s)}const f=e(r,[["render",i]]);export{g as __pageData,f as default};
@@ -1,4 +1,4 @@
import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const A=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":1715651890000}'),l={name:"en_US/guide/q3.md"},p=o(`<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"><button title="Copy Code" class="copy"></button><span class="lang">nginx</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#C792EA;">server</span><span style="color:#A6ACCD;"> {</span></span> import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const A=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":1715701589000}'),l={name:"en_US/guide/q3.md"},p=o(`<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"><button title="Copy Code" class="copy"></button><span class="lang">nginx</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#C792EA;">server</span><span style="color:#A6ACCD;"> {</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> listen </span><span style="color:#A6ACCD;">443 ssl http2</span><span style="color:#89DDFF;">;</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> listen </span><span style="color:#A6ACCD;">443 ssl http2</span><span style="color:#89DDFF;">;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> listen </span><span style="color:#A6ACCD;">[::]:443 ssl http2</span><span style="color:#89DDFF;">;</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> listen </span><span style="color:#A6ACCD;">[::]:443 ssl http2</span><span style="color:#89DDFF;">;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> server_name </span><span style="color:#A6ACCD;">data.example.com</span><span style="color:#89DDFF;">;</span><span style="color:#A6ACCD;"> </span><span style="color:#676E95;font-style:italic;"># Your domain that the Agent uses to connect to the Dashboard</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> server_name </span><span style="color:#A6ACCD;">data.example.com</span><span style="color:#89DDFF;">;</span><span style="color:#A6ACCD;"> </span><span style="color:#676E95;font-style:italic;"># Your domain that the Agent uses to connect to the Dashboard</span></span>
@@ -1 +1 @@
import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const A=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":1715651890000}'),l={name:"en_US/guide/q3.md"},p=o("",15),e=[p];function t(c,r,D,C,y,i){return n(),a("div",null,e)}const d=s(l,[["render",t]]);export{A as __pageData,d as default}; import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const A=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":1715701589000}'),l={name:"en_US/guide/q3.md"},p=o("",15),e=[p];function t(c,r,D,C,y,i){return n(),a("div",null,e)}const d=s(l,[["render",t]]);export{A as __pageData,d as default};
@@ -1 +1 @@
import{_ as a,o as i,c as o,z as e,a as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Real-Time Channel Disconnection/Online Terminal Connection Failure","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md","filePath":"en_US/guide/q4.md","lastUpdated":1715651890000}'),t={name:"en_US/guide/q4.md"},r=e("h1",{id:"real-time-channel-disconnection-online-terminal-connection-failure",tabindex:"-1"},[n("Real-Time Channel Disconnection/Online Terminal Connection Failure "),e("a",{class:"header-anchor",href:"#real-time-channel-disconnection-online-terminal-connection-failure","aria-label":'Permalink to "Real-Time Channel Disconnection/Online Terminal Connection Failure"'},"​")],-1),l=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=[r,l];function s(d,u,h,m,_,f){return i(),o("div",null,c)}const v=a(t,[["render",s]]);export{g as __pageData,v as default}; import{_ as a,o as i,c as o,z as e,a as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Real-Time Channel Disconnection/Online Terminal Connection Failure","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md","filePath":"en_US/guide/q4.md","lastUpdated":1715701589000}'),t={name:"en_US/guide/q4.md"},r=e("h1",{id:"real-time-channel-disconnection-online-terminal-connection-failure",tabindex:"-1"},[n("Real-Time Channel Disconnection/Online Terminal Connection Failure "),e("a",{class:"header-anchor",href:"#real-time-channel-disconnection-online-terminal-connection-failure","aria-label":'Permalink to "Real-Time Channel Disconnection/Online Terminal Connection Failure"'},"​")],-1),l=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=[r,l];function s(d,u,h,m,_,f){return i(),o("div",null,c)}const v=a(t,[["render",s]]);export{g as __pageData,v as default};
@@ -1 +1 @@
import{_ as a,o as i,c as o,z as e,a as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Real-Time Channel Disconnection/Online Terminal Connection Failure","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md","filePath":"en_US/guide/q4.md","lastUpdated":1715651890000}'),t={name:"en_US/guide/q4.md"},r=e("h1",{id:"real-time-channel-disconnection-online-terminal-connection-failure",tabindex:"-1"},[n("Real-Time Channel Disconnection/Online Terminal Connection Failure "),e("a",{class:"header-anchor",href:"#real-time-channel-disconnection-online-terminal-connection-failure","aria-label":'Permalink to "Real-Time Channel Disconnection/Online Terminal Connection Failure"'},"​")],-1),l=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=[r,l];function s(d,u,h,m,_,f){return i(),o("div",null,c)}const v=a(t,[["render",s]]);export{g as __pageData,v as default}; import{_ as a,o as i,c as o,z as e,a as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Real-Time Channel Disconnection/Online Terminal Connection Failure","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md","filePath":"en_US/guide/q4.md","lastUpdated":1715701589000}'),t={name:"en_US/guide/q4.md"},r=e("h1",{id:"real-time-channel-disconnection-online-terminal-connection-failure",tabindex:"-1"},[n("Real-Time Channel Disconnection/Online Terminal Connection Failure "),e("a",{class:"header-anchor",href:"#real-time-channel-disconnection-online-terminal-connection-failure","aria-label":'Permalink to "Real-Time Channel Disconnection/Online Terminal Connection Failure"'},"​")],-1),l=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=[r,l];function s(d,u,h,m,_,f){return i(),o("div",null,c)}const v=a(t,[["render",s]]);export{g as __pageData,v as default};
@@ -1 +1 @@
import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.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":1715651890000}'),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 o(),a("div",null,c)}const f=e(r,[["render",i]]);export{u as __pageData,f as default}; import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"How to Perform Data Migration and Backup Recovery?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q5.md","filePath":"en_US/guide/q5.md","lastUpdated":1715701589000}'),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 o(),a("div",null,c)}const f=e(r,[["render",i]]);export{u as __pageData,f as default};
@@ -1 +1 @@
import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.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":1715651890000}'),r={name:"en_US/guide/q5.md"},n=t("",2),c=[n];function i(d,s,_,l,h,p){return o(),a("div",null,c)}const f=e(r,[["render",i]]);export{u as __pageData,f as default}; import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"How to Perform Data Migration and Backup Recovery?","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q5.md","filePath":"en_US/guide/q5.md","lastUpdated":1715701589000}'),r={name:"en_US/guide/q5.md"},n=t("",2),c=[n];function i(d,s,_,l,h,p){return o(),a("div",null,c)}const f=e(r,[["render",i]]);export{u as __pageData,f as default};
@@ -1 +1 @@
import{_ as t,o as e,c as o,R as i}from"./chunks/framework.44fd0451.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":1715651890000}'),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 e(),o("div",null,c)}const u=t(a,[["render",r]]);export{p as __pageData,u as default}; import{_ as t,o as e,c as o,R as i}from"./chunks/framework.44fd0451.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":1715701589000}'),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 e(),o("div",null,c)}const u=t(a,[["render",r]]);export{p as __pageData,u as default};
@@ -1 +1 @@
import{_ as t,o as e,c as o,R as i}from"./chunks/framework.44fd0451.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":1715651890000}'),a={name:"en_US/guide/q6.md"},s=i("",4),c=[s];function r(n,l,h,f,d,_){return e(),o("div",null,c)}const u=t(a,[["render",r]]);export{p as __pageData,u as default}; import{_ as t,o as e,c as o,R as i}from"./chunks/framework.44fd0451.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":1715701589000}'),a={name:"en_US/guide/q6.md"},s=i("",4),c=[s];function r(n,l,h,f,d,_){return e(),o("div",null,c)}const u=t(a,[["render",r]]);export{p as __pageData,u as default};
@@ -1 +1 @@
import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Custom Agent Monitoring Projects","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q7.md","filePath":"en_US/guide/q7.md","lastUpdated":1715651890000}'),a={name:"en_US/guide/q7.md"},s=n('<h1 id="custom-agent-monitoring-projects" tabindex="-1">Custom Agent Monitoring Projects <a class="header-anchor" href="#custom-agent-monitoring-projects" aria-label="Permalink to &quot;Custom Agent Monitoring Projects&quot;">​</a></h1><h2 id="customizing-monitored-network-interfaces-and-disk-partitions" tabindex="-1">Customizing Monitored Network Interfaces and Disk Partitions <a class="header-anchor" href="#customizing-monitored-network-interfaces-and-disk-partitions" aria-label="Permalink to &quot;Customizing Monitored Network Interfaces and Disk Partitions&quot;">​</a></h2><p>Execute the following command to select custom network interfaces and partitions, then restart the Agent for the changes to take effect:</p><div class="language-bash"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">/opt/nezha/agent/nezha-agent</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">--edit-agent-config</span></span></code></pre></div><h2 id="other-runtime-parameters" tabindex="-1">Other Runtime Parameters <a class="header-anchor" href="#other-runtime-parameters" aria-label="Permalink to &quot;Other Runtime Parameters&quot;">​</a></h2><p>To view the supported parameters, execute:</p><div class="language-bash"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">./nezha-agent</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">--help</span></span></code></pre></div><p>If you installed the Agent using the one-click script, you can edit <code>/etc/systemd/system/nezha-agent.service</code> and add the following parameters at the end of the <code>ExecStart=</code> line:</p><ul><li><code>--report-delay</code>: Controls the interval for reporting system information. The default is 1 second. You can set it to 3 to further reduce the agent&#39;s system resource usage (configuration range: 1-4).</li><li><code>--skip-conn</code>: Does not monitor connection counts. Recommended for servers with high connection density or high CPU usage.</li><li><code>--skip-procs</code>: Does not monitor process counts, which can also reduce Agent resource usage.</li><li><code>--disable-auto-update</code>: Disables <strong>automatic updates</strong> for the Agent (security feature).</li><li><code>--disable-force-update</code>: Disables <strong>forced updates</strong> for the Agent (security feature).</li><li><code>--disable-command-execute</code>: Disables the execution of scheduled tasks and the opening of the online terminal on the Agent (security feature).</li><li><code>--tls</code>: Enables SSL/TLS encryption (required if you use nginx to reverse proxy the Agent&#39;s gRPC connection and nginx has SSL/TLS enabled).</li></ul>',9),i=[s];function r(c,d,l,p,u,h){return t(),o("div",null,i)}const f=e(a,[["render",r]]);export{m as __pageData,f as default}; import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Custom Agent Monitoring Projects","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q7.md","filePath":"en_US/guide/q7.md","lastUpdated":1715701589000}'),a={name:"en_US/guide/q7.md"},s=n('<h1 id="custom-agent-monitoring-projects" tabindex="-1">Custom Agent Monitoring Projects <a class="header-anchor" href="#custom-agent-monitoring-projects" aria-label="Permalink to &quot;Custom Agent Monitoring Projects&quot;">​</a></h1><h2 id="customizing-monitored-network-interfaces-and-disk-partitions" tabindex="-1">Customizing Monitored Network Interfaces and Disk Partitions <a class="header-anchor" href="#customizing-monitored-network-interfaces-and-disk-partitions" aria-label="Permalink to &quot;Customizing Monitored Network Interfaces and Disk Partitions&quot;">​</a></h2><p>Execute the following command to select custom network interfaces and partitions, then restart the Agent for the changes to take effect:</p><div class="language-bash"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">/opt/nezha/agent/nezha-agent</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">--edit-agent-config</span></span></code></pre></div><h2 id="other-runtime-parameters" tabindex="-1">Other Runtime Parameters <a class="header-anchor" href="#other-runtime-parameters" aria-label="Permalink to &quot;Other Runtime Parameters&quot;">​</a></h2><p>To view the supported parameters, execute:</p><div class="language-bash"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">./nezha-agent</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">--help</span></span></code></pre></div><p>If you installed the Agent using the one-click script, you can edit <code>/etc/systemd/system/nezha-agent.service</code> and add the following parameters at the end of the <code>ExecStart=</code> line:</p><ul><li><code>--report-delay</code>: Controls the interval for reporting system information. The default is 1 second. You can set it to 3 to further reduce the agent&#39;s system resource usage (configuration range: 1-4).</li><li><code>--skip-conn</code>: Does not monitor connection counts. Recommended for servers with high connection density or high CPU usage.</li><li><code>--skip-procs</code>: Does not monitor process counts, which can also reduce Agent resource usage.</li><li><code>--disable-auto-update</code>: Disables <strong>automatic updates</strong> for the Agent (security feature).</li><li><code>--disable-force-update</code>: Disables <strong>forced updates</strong> for the Agent (security feature).</li><li><code>--disable-command-execute</code>: Disables the execution of scheduled tasks and the opening of the online terminal on the Agent (security feature).</li><li><code>--tls</code>: Enables SSL/TLS encryption (required if you use nginx to reverse proxy the Agent&#39;s gRPC connection and nginx has SSL/TLS enabled).</li></ul>',9),i=[s];function r(c,d,l,p,u,h){return t(),o("div",null,i)}const f=e(a,[["render",r]]);export{m as __pageData,f as default};
@@ -1 +1 @@
import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Custom Agent Monitoring Projects","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q7.md","filePath":"en_US/guide/q7.md","lastUpdated":1715651890000}'),a={name:"en_US/guide/q7.md"},s=n("",9),i=[s];function r(c,d,l,p,u,h){return t(),o("div",null,i)}const f=e(a,[["render",r]]);export{m as __pageData,f as default}; import{_ as e,o as t,c as o,R as n}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Custom Agent Monitoring Projects","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q7.md","filePath":"en_US/guide/q7.md","lastUpdated":1715701589000}'),a={name:"en_US/guide/q7.md"},s=n("",9),i=[s];function r(c,d,l,p,u,h){return t(),o("div",null,i)}const f=e(a,[["render",r]]);export{m as __pageData,f as default};
@@ -1,4 +1,4 @@
import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q8.md","filePath":"en_US/guide/q8.md","lastUpdated":1715651890000}'),c={name:"en_US/guide/q8.md"},n=t(`<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"><button title="Copy Code" class="copy"></button><span class="lang">yaml</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#F07178;">Oauth2</span><span style="color:#89DDFF;">:</span></span> import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q8.md","filePath":"en_US/guide/q8.md","lastUpdated":1715701589000}'),c={name:"en_US/guide/q8.md"},n=t(`<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"><button title="Copy Code" class="copy"></button><span class="lang">yaml</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#F07178;">Oauth2</span><span style="color:#89DDFF;">:</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">Admin</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">701b9ea6-9f56-48cd-af3e-cbb4bfc1475c</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">Admin</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">701b9ea6-9f56-48cd-af3e-cbb4bfc1475c</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">ClientID</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">3516291f53eca9b4901a01337e41be7dc52f565c8657d08a3fddb2178d13c5bf</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">ClientID</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">3516291f53eca9b4901a01337e41be7dc52f565c8657d08a3fddb2178d13c5bf</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">ClientSecret</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">0568b67c7b6d0ed51c663e2fe935683007c28f947a27b7bd47a5ad3d8b56fb67</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">ClientSecret</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">0568b67c7b6d0ed51c663e2fe935683007c28f947a27b7bd47a5ad3d8b56fb67</span></span>
@@ -1 +1 @@
import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q8.md","filePath":"en_US/guide/q8.md","lastUpdated":1715651890000}'),c={name:"en_US/guide/q8.md"},n=t("",10),s=[n];function i(l,d,r,p,h,u){return o(),a("div",null,s)}const y=e(c,[["render",i]]);export{g as __pageData,y as default}; import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q8.md","filePath":"en_US/guide/q8.md","lastUpdated":1715701589000}'),c={name:"en_US/guide/q8.md"},n=t("",10),s=[n];function i(l,d,r,p,h,u){return o(),a("div",null,s)}const y=e(c,[["render",i]]);export{g as __pageData,y as default};
@@ -1,4 +1,4 @@
import{_ as e,o,c as s,R as n}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Server","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/servers.md","filePath":"en_US/guide/servers.md","lastUpdated":1715651890000}'),a={name:"en_US/guide/servers.md"},l=n(`<h1 id="server" tabindex="-1">Server <a class="header-anchor" href="#server" aria-label="Permalink to &quot;Server&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>.<br> Note that in the WebSSH terminal function, the Agent connects to the <strong>public access domain</strong> via WebSocket, not through gRPC.</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><li>Confidential information is only stored on the Dashboard server, preventing leakage.</li></ul><h3 id="configuration-instructions" tabindex="-1">Configuration Instructions <a class="header-anchor" href="#configuration-instructions" aria-label="Permalink to &quot;Configuration Instructio Line truncated import{_ as e,o,c as s,R as n}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Server","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/servers.md","filePath":"en_US/guide/servers.md","lastUpdated":1715701589000}'),a={name:"en_US/guide/servers.md"},l=n(`<h1 id="server" tabindex="-1">Server <a class="header-anchor" href="#server" aria-label="Permalink to &quot;Server&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>.<br> Note that in the WebSSH terminal function, the Agent connects to the <strong>public access domain</strong> via WebSocket, not through gRPC.</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><li>Confidential information is only stored on the Dashboard server, preventing leakage.</li></ul><h3 id="configuration-instructions" tabindex="-1">Configuration Instructions <a class="header-anchor" href="#configuration-instructions" aria-label="Permalink to &quot;Configuration Instructio Line truncated
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">Enable</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#FF9CAC;">true</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">Enable</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#FF9CAC;">true</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">Provider</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">webhook</span><span style="color:#89DDFF;">&quot;</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">Provider</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">webhook</span><span style="color:#89DDFF;">&quot;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">AccessID</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;&quot;</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">AccessID</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;&quot;</span></span>
@@ -1 +1 @@
import{_ as e,o,c as s,R as n}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Server","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/servers.md","filePath":"en_US/guide/servers.md","lastUpdated":1715651890000}'),a={name:"en_US/guide/servers.md"},l=n("",39),t=[l];function i(r,c,p,d,u,h){return o(),s("div",null,t)}const g=e(a,[["render",i]]);export{y as __pageData,g as default}; import{_ as e,o,c as s,R as n}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"Server","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/servers.md","filePath":"en_US/guide/servers.md","lastUpdated":1715701589000}'),a={name:"en_US/guide/servers.md"},l=n("",39),t=[l];function i(r,c,p,d,u,h){return o(),s("div",null,t)}const g=e(a,[["render",i]]);export{y as __pageData,g as default};
@@ -1 +1 @@
import{_ as e,o as t,c as o,R as i}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/services.md","filePath":"en_US/guide/services.md","lastUpdated":1715651890000}'),n={name:"en_US/guide/services.md"},a=i('<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 Panel 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 the corresponding data.</p><h2 id="managing-monitors" tabindex="-1">Managing Monitors <a class="header-anchor" href="#managing-monitors" aria-label="Permalink to &quot;Managing Monitors&quot;">​</a>Line truncated import{_ as e,o as t,c as o,R as i}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/services.md","filePath":"en_US/guide/services.md","lastUpdated":1715701589000}'),n={name:"en_US/guide/services.md"},a=i('<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 Panel 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 the corresponding data.</p><h2 id="managing-monitors" tabindex="-1">Managing Monitors <a class="header-anchor" href="#managing-monitors" aria-label="Permalink to &quot;Managing Monitors&quot;">​</a>Line truncated
@@ -1 +1 @@
import{_ as e,o as t,c as o,R as i}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/services.md","filePath":"en_US/guide/services.md","lastUpdated":1715651890000}'),n={name:"en_US/guide/services.md"},a=i("",15),r=[a];function s(c,h,l,g,d,u){return t(),o("div",null,r)}const f=e(n,[["render",s]]);export{m as __pageData,f as default}; import{_ as e,o as t,c as o,R as i}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/services.md","filePath":"en_US/guide/services.md","lastUpdated":1715701589000}'),n={name:"en_US/guide/services.md"},a=i("",15),r=[a];function s(c,h,l,g,d,u){return t(),o("div",null,r)}const f=e(n,[["render",s]]);export{m as __pageData,f as default};
@@ -1,4 +1,4 @@
import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/settings.md","filePath":"en_US/guide/settings.md","lastUpdated":1715651890000}'),p={name:"en_US/guide/settings.md"},o=l(`<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"><button title="Copy Code" class="copy"></button><span class="lang">html</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">&lt;</span><span style="color:#F07178;">style</span><span style="color:#89DDFF;">&gt;</span></span> import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/settings.md","filePath":"en_US/guide/settings.md","lastUpdated":1715701589000}'),p={name:"en_US/guide/settings.md"},o=l(`<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"><button title="Copy Code" class="copy"></button><span class="lang">html</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">&lt;</span><span style="color:#F07178;">style</span><span style="color:#89DDFF;">&gt;</span></span>
<span class="line"><span style="color:#676E95;font-style:italic;">/* Screen adaptation */</span></span> <span class="line"><span style="color:#676E95;font-style:italic;">/* Screen adaptation */</span></span>
<span class="line"><span style="color:#89DDFF;font-style:italic;">@media</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">only</span><span style="color:#A6ACCD;"> screen </span><span style="color:#89DDFF;">and</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">(</span><span style="color:#FFCB6B;">min-width</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#F78C6C;">1200px</span><span style="color:#89DDFF;">)</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span> <span class="line"><span style="color:#89DDFF;font-style:italic;">@media</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">only</span><span style="color:#A6ACCD;"> screen </span><span style="color:#89DDFF;">and</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">(</span><span style="color:#FFCB6B;">min-width</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#F78C6C;">1200px</span><span style="color:#89DDFF;">)</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">.</span><span style="color:#FFCB6B;">ui</span><span style="color:#89DDFF;">.</span><span style="color:#FFCB6B;">container</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">.</span><span style="color:#FFCB6B;">ui</span><span style="color:#89DDFF;">.</span><span style="color:#FFCB6B;">container</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
@@ -1 +1 @@
import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/settings.md","filePath":"en_US/guide/settings.md","lastUpdated":1715651890000}'),p={name:"en_US/guide/settings.md"},o=l("",38),e=[o];function t(r,c,F,D,y,C){return a(),n("div",null,e)}const B=s(p,[["render",t]]);export{A as __pageData,B as default}; import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/settings.md","filePath":"en_US/guide/settings.md","lastUpdated":1715701589000}'),p={name:"en_US/guide/settings.md"},o=l("",38),e=[o];function t(r,c,F,D,y,C){return a(),n("div",null,e)}const B=s(p,[["render",t]]);export{A as __pageData,B as default};
@@ -1 +1 @@
import{_ as e,o as t,c as o,R as s}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/tasks.md","filePath":"en_US/guide/tasks.md","lastUpdated":1715651890000}'),n={name:"en_US/guide/tasks.md"},a=s('<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>',10),i=[a];function r(c,l,d,u,h,g){return t(),o("div",null,i)}const k=e(n,[["render",r]]);export{m as __pageData,k as default}; import{_ as e,o as t,c as o,R as s}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/tasks.md","filePath":"en_US/guide/tasks.md","lastUpdated":1715701589000}'),n={name:"en_US/guide/tasks.md"},a=s('<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>',10),i=[a];function r(c,l,d,u,h,g){return t(),o("div",null,i)}const k=e(n,[["render",r]]);export{m as __pageData,k as default};
@@ -1 +1 @@
import{_ as e,o as t,c as o,R as s}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/tasks.md","filePath":"en_US/guide/tasks.md","lastUpdated":1715651890000}'),n={name:"en_US/guide/tasks.md"},a=s("",10),i=[a];function r(c,l,d,u,h,g){return t(),o("div",null,i)}const k=e(n,[["render",r]]);export{m as __pageData,k as default}; import{_ as e,o as t,c as o,R as s}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"en_US/guide/tasks.md","filePath":"en_US/guide/tasks.md","lastUpdated":1715701589000}'),n={name:"en_US/guide/tasks.md"},a=s("",10),i=[a];function r(c,l,d,u,h,g){return t(),o("div",null,i)}const k=e(n,[["render",r]]);export{m as __pageData,k as default};
-1
View File
@@ -1 +0,0 @@
import{_ as t,o as e,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"User Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","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":"/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":1715651890000}'),i={name:"en_US/index.md"};function n(s,o,r,l,d,c){return e(),a("div")}const u=t(i,[["render",n]]);export{m as __pageData,u as default};
-1
View File
@@ -1 +0,0 @@
import{_ as t,o as e,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"User Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","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":"/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":1715651890000}'),i={name:"en_US/index.md"};function n(s,o,r,l,d,c){return e(),a("div")}const u=t(i,[["render",n]]);export{m as __pageData,u as default};
+1
View File
@@ -0,0 +1 @@
import{_ as t,o as e,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"User Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","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":1715701589000}'),i={name:"en_US/index.md"};function n(s,o,r,l,d,c){return e(),a("div")}const u=t(i,[["render",n]]);export{m as __pageData,u as default};
+1
View File
@@ -0,0 +1 @@
import{_ as t,o as e,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"User Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","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":1715701589000}'),i={name:"en_US/index.md"};function n(s,o,r,l,d,c){return e(),a("div")}const u=t(i,[["render",n]]);export{m as __pageData,u as default};
@@ -1,4 +1,4 @@
import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1715651890000}'),p={name:"guide/agent.md"},o=l(`<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,遵循本文档的步骤,你可以很轻松的在服务器上部署它<br><br></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;<br><br></p><h3 id="在-linux-中一键安装-ubuntu、debian、centos" tabindex="-1">在 Linux 中一键安装 (Ubuntu、Debian、CentOS) <a class="header-anchor" href="#在-linux-中一键安装-ubuntu、debian、centos" aria-label="Permalink to &quot;在 Linux 中一键安装 (Ubuntu、Debian、CentOS)&quot;">​</a></h3><ul><li>首先在管理面板中添加一台服务器</li><li>点击新添加的服务器旁,绿色的 Linux 图标按钮,复制一键安装命令</li><li>在被控端服务器中运行复制的一键安装命令,等待安装完成后返回到 Dashboard 主页查看服务器是否上线<br><br></li></ul><h3 id="在-windows-中一键安装" tabindex="-1">在 Windows 中一键安装 <a class="header-anchor" href="#在-windows-中一键安装" aria-label="Permalink to &quot;在 Windows 中一键安装&quot;">​</a></h3><ul><li>首先在管理面板中添加一台服务器</li><li>点击新添加的服务器旁,绿色的 Windows 图标按钮,复制一键安装命令</li><li>进入 Windows 服务器,运行 PowerShell,在 PowerShell 中运行复制的安装命令</li><li>如遇到确认「执行策略变更」请选择 Y</li><li>等待安装完成后返回 Dashboard 主页查看服务器是否上线<br><br></li></ul><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>如果在 Powershell 中运行一键安装命令时遇到错误,请尝试下方的<strong>在 Windows 中手动安装 Agent</strong></p></div><br><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-ubuntu、debian、centos" tabindex="-1">在 Linux 中安装 Agent (Ubuntu、Debian、CentOS) <a class="header-anchor" href="#在-linux-中安装-agent-ubuntu、debian、centos" aria-label="Permalink to &quot;在 Linux 中安装 Agent (Ubuntu、Debian、CentOS)&quot;">​</a></h3><details><summary>点击展开/收起</summary><ul><li>首先在管理面板中添加一台服务器</li><li>在被控服务器中,运行脚本(位于中国大陆的服务器请使用镜像):</li></ul><div class="language-bash"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">-L</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">-o</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">nezha.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&amp;&amp;</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">chmod</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">+x</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">nezha.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&amp;&amp;</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">sudo</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">./nezha.sh</span></span></code></pre></div><p>如果你的被控服务器位于中国大陆,可以使用镜像:</p><div class="langu Line truncated import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1715701589000}'),p={name:"guide/agent.md"},o=l(`<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,遵循本文档的步骤,你可以很轻松的在服务器上部署它<br><br></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;<br><br></p><h3 id="在-linux-中一键安装-ubuntu、debian、centos" tabindex="-1">在 Linux 中一键安装 (Ubuntu、Debian、CentOS) <a class="header-anchor" href="#在-linux-中一键安装-ubuntu、debian、centos" aria-label="Permalink to &quot;在 Linux 中一键安装 (Ubuntu、Debian、CentOS)&quot;">​</a></h3><ul><li>首先在管理面板中添加一台服务器</li><li>点击新添加的服务器旁,绿色的 Linux 图标按钮,复制一键安装命令</li><li>在被控端服务器中运行复制的一键安装命令,等待安装完成后返回到 Dashboard 主页查看服务器是否上线<br><br></li></ul><h3 id="在-windows-中一键安装" tabindex="-1">在 Windows 中一键安装 <a class="header-anchor" href="#在-windows-中一键安装" aria-label="Permalink to &quot;在 Windows 中一键安装&quot;">​</a></h3><ul><li>首先在管理面板中添加一台服务器</li><li>点击新添加的服务器旁,绿色的 Windows 图标按钮,复制一键安装命令</li><li>进入 Windows 服务器,运行 PowerShell,在 PowerShell 中运行复制的安装命令</li><li>如遇到确认「执行策略变更」请选择 Y</li><li>等待安装完成后返回 Dashboard 主页查看服务器是否上线<br><br></li></ul><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>如果在 Powershell 中运行一键安装命令时遇到错误,请尝试下方的<strong>在 Windows 中手动安装 Agent</strong></p></div><br><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-ubuntu、debian、centos" tabindex="-1">在 Linux 中安装 Agent (Ubuntu、Debian、CentOS) <a class="header-anchor" href="#在-linux-中安装-agent-ubuntu、debian、centos" aria-label="Permalink to &quot;在 Linux 中安装 Agent (Ubuntu、Debian、CentOS)&quot;">​</a></h3><details><summary>点击展开/收起</summary><ul><li>首先在管理面板中添加一台服务器</li><li>在被控服务器中,运行脚本(位于中国大陆的服务器请使用镜像):</li></ul><div class="language-bash"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">-L</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">-o</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">nezha.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&amp;&amp;</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">chmod</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">+x</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">nezha.sh</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&amp;&amp;</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">sudo</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">./nezha.sh</span></span></code></pre></div><p>如果你的被控服务器位于中国大陆,可以使用镜像:</p><div class="langu Line truncated
<span class="line"><span style="color:#C3E88D;">#!/sbin/openrc-run</span></span> <span class="line"><span style="color:#C3E88D;">#!/sbin/openrc-run</span></span>
<span class="line"><span style="color:#C3E88D;">SERVER=&quot;&quot; #Dashboard 地址 ip:port</span></span> <span class="line"><span style="color:#C3E88D;">SERVER=&quot;&quot; #Dashboard 地址 ip:port</span></span>
<span class="line"><span style="color:#C3E88D;">SECRET=&quot;&quot; #SECRET</span></span> <span class="line"><span style="color:#C3E88D;">SECRET=&quot;&quot; #SECRET</span></span>
@@ -1 +1 @@
import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1715651890000}'),p={name:"guide/agent.md"},o=l("",35),e=[o];function t(c,r,D,y,C,i){return a(),n("div",null,e)}const h=s(p,[["render",t]]);export{A as __pageData,h as default}; import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const A=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agent.md","filePath":"guide/agent.md","lastUpdated":1715701589000}'),p={name:"guide/agent.md"},o=l("",35),e=[o];function t(c,r,D,y,C,i){return a(),n("div",null,e)}const h=s(p,[["render",t]]);export{A as __pageData,h as default};
@@ -1 +1 @@
import{_ as a,o as e,c as t,R as o}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agentq.md","filePath":"guide/agentq.md","lastUpdated":1715651890000}'),n={name:"guide/agentq.md"},s=o('<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"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">apt</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">install</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">sudo</span></span></code></pre></div>',8),c=[s];function l(r,i,d,u,p,h){return e(),t("div",null,c)}const _=a(n,[["render",l]]);export{g as __pageData,_ as default}; import{_ as a,o as e,c as t,R as o}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agentq.md","filePath":"guide/agentq.md","lastUpdated":1715701589000}'),n={name:"guide/agentq.md"},s=o('<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"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">apt</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">install</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">sudo</span></span></code></pre></div>',8),c=[s];function l(r,i,d,u,p,h){return e(),t("div",null,c)}const _=a(n,[["render",l]]);export{g as __pageData,_ as default};
@@ -1 +1 @@
import{_ as a,o as e,c as t,R as o}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agentq.md","filePath":"guide/agentq.md","lastUpdated":1715651890000}'),n={name:"guide/agentq.md"},s=o("",8),c=[s];function l(r,i,d,u,p,h){return e(),t("div",null,c)}const _=a(n,[["render",l]]);export{g as __pageData,_ as default}; import{_ as a,o as e,c as t,R as o}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/agentq.md","filePath":"guide/agentq.md","lastUpdated":1715701589000}'),n={name:"guide/agentq.md"},s=o("",8),c=[s];function l(r,i,d,u,p,h){return e(),t("div",null,c)}const _=a(n,[["render",l]]);export{g as __pageData,_ as default};
@@ -1,4 +1,4 @@
import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1715651890000}'),l={name:"guide/api.md"},p=o(`<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-"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#A6ACCD;">Request Headers:</span></span> import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1715701589000}'),l={name:"guide/api.md"},p=o(`<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-"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#A6ACCD;">Request Headers:</span></span>
<span class="line"><span style="color:#A6ACCD;">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-"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#A6ACCD;">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"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">{</span></span> <span class="line"><span style="color:#A6ACCD;">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-"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#A6ACCD;">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"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">code</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#F78C6C;">0</span><span style="color:#89DDFF;">,</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">code</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#F78C6C;">0</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">message</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">success</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">message</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">success</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
@@ -1 +1 @@
import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1715651890000}'),l={name:"guide/api.md"},p=o("",32),t=[p];function e(D,F,c,r,y,C){return n(),a("div",null,t)}const i=s(l,[["render",e]]);export{u as __pageData,i as default}; import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1715701589000}'),l={name:"guide/api.md"},p=o("",32),t=[p];function e(D,F,c,r,y,C){return n(),a("div",null,t)}const i=s(l,[["render",e]]);export{u as __pageData,i as default};
@@ -1,4 +1,4 @@
import{_ as a,o as s,c as e,R as o}from"./chunks/framework.44fd0451.js";const D=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboard.md","filePath":"guide/dashboard.md","lastUpdated":1715651890000}'),l={name:"guide/dashboard.md"},n=o(`<h2 id="准备工作" tabindex="-1">准备工作 <a class="header-anchor" href="#准备工作" aria-label="Permalink to &quot;准备工作&quot;">​</a></h2><p>搭建一个哪吒监控,你需要:</p><ol><li>一台可以连接公网的 VPS,防火墙和安全策略需要放行 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 的通信<br> 本文档分别以 &quot;dashboard.example.com&quot; 和 &quot;data.example.com&quot; 两个域名来演示</p></div><ol start="3"><li>一个 Github 账号(或:Gitlab、Gitee)</li></ol><p><strong>本文档将以宝塔面板反代面板的过程作为范例,随着未来版本的变化,部分功能的入口可能会发生改变,本文档仅供参考</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><br><br><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><p><strong>新建 SaaS-OIDC 应用流程</strong></p><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; <code>Application</code> -&gt; <code>Add an Application</code>;</li><li>选择 <code>SaaS</code>,在 <code>Application</code> 中输入自定义的应用名称(例如 nezha),选择 <code>OIDC</code> 后点击 <code>Add application</code>;</li><li><code>Scopes</code> 选择 <code>openid</code>, <code>email</code>, <code>profile</code>, <code>groups</code>;</li><li><code>Redirect URLs</code> 填写你的 callback 地址,例如 <code>https://dashboard.example.com/oauth2/callback</code>;</li><li>保存 <code>Client ID</code>、<code>Client Secret</code>、<code>Issuer</code> 地址中协议与域名的部分,例如 <code>https://xxxxx.cloudflareaccess.com</code></li></ol><p><strong>如使用此方式,安装 Dashboard 完成后,需要修改配置文件 <code>/ Line truncated import{_ as a,o as s,c as e,R as o}from"./chunks/framework.44fd0451.js";const D=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboard.md","filePath":"guide/dashboard.md","lastUpdated":1715701589000}'),l={name:"guide/dashboard.md"},n=o(`<h2 id="准备工作" tabindex="-1">准备工作 <a class="header-anchor" href="#准备工作" aria-label="Permalink to &quot;准备工作&quot;">​</a></h2><p>搭建一个哪吒监控,你需要:</p><ol><li>一台可以连接公网的 VPS,防火墙和安全策略需要放行 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 的通信<br> 本文档分别以 &quot;dashboard.example.com&quot; 和 &quot;data.example.com&quot; 两个域名来演示</p></div><ol start="3"><li>一个 Github 账号(或:Gitlab、Gitee)</li></ol><p><strong>本文档将以宝塔面板反代面板的过程作为范例,随着未来版本的变化,部分功能的入口可能会发生改变,本文档仅供参考</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><br><br><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><p><strong>新建 SaaS-OIDC 应用流程</strong></p><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; <code>Application</code> -&gt; <code>Add an Application</code>;</li><li>选择 <code>SaaS</code>,在 <code>Application</code> 中输入自定义的应用名称(例如 nezha),选择 <code>OIDC</code> 后点击 <code>Add application</code>;</li><li><code>Scopes</code> 选择 <code>openid</code>, <code>email</code>, <code>profile</code>, <code>groups</code>;</li><li><code>Redirect URLs</code> 填写你的 callback 地址,例如 <code>https://dashboard.example.com/oauth2/callback</code>;</li><li>保存 <code>Client ID</code>、<code>Client Secret</code>、<code>Issuer</code> 地址中协议与域名的部分,例如 <code>https://xxxxx.cloudflareaccess.com</code></li></ol><p><strong>如使用此方式,安装 Dashboard 完成后,需要修改配置文件 <code>/ Line truncated
<span class="line"><span style="color:#C792EA;">location</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">/ </span><span style="color:#A6ACCD;">{</span></span> <span class="line"><span style="color:#C792EA;">location</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">/ </span><span style="color:#A6ACCD;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> proxy_pass </span><span style="color:#A6ACCD;">http://127.0.0.1:8008</span><span style="color:#89DDFF;">;</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> proxy_pass </span><span style="color:#A6ACCD;">http://127.0.0.1:8008</span><span style="color:#89DDFF;">;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> proxy_set_header </span><span style="color:#A6ACCD;">Host </span><span style="color:#89DDFF;">$</span><span style="color:#A6ACCD;">http_host</span><span style="color:#89DDFF;">;</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> proxy_set_header </span><span style="color:#A6ACCD;">Host </span><span style="color:#89DDFF;">$</span><span style="color:#A6ACCD;">http_host</span><span style="color:#89DDFF;">;</span></span>
@@ -1 +1 @@
import{_ as a,o as s,c as e,R as o}from"./chunks/framework.44fd0451.js";const D=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboard.md","filePath":"guide/dashboard.md","lastUpdated":1715651890000}'),l={name:"guide/dashboard.md"},n=o("",46),t=[n];function p(r,c,d,i,h,C){return s(),e("div",null,t)}const A=a(l,[["render",p]]);export{D as __pageData,A as default}; import{_ as a,o as s,c as e,R as o}from"./chunks/framework.44fd0451.js";const D=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboard.md","filePath":"guide/dashboard.md","lastUpdated":1715701589000}'),l={name:"guide/dashboard.md"},n=o("",46),t=[n];function p(r,c,d,i,h,C){return s(),e("div",null,t)}const A=a(l,[["render",p]]);export{D as __pageData,A as default};
@@ -1,4 +1,4 @@
import{_ as s,o as a,c as e,R as n}from"./chunks/framework.44fd0451.js";const C=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboardq.md","filePath":"guide/dashboardq.md","lastUpdated":1715651890000}'),o={name:"guide/dashboardq.md"},l=n(`<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"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">https://ipapi.co/ip/</span></span> import{_ as s,o as a,c as e,R as n}from"./chunks/framework.44fd0451.js";const C=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboardq.md","filePath":"guide/dashboardq.md","lastUpdated":1715701589000}'),o={name:"guide/dashboardq.md"},l=n(`<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"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">https://ipapi.co/ip/</span></span>
<span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">ip.sb</span></span> <span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">ip.sb</span></span>
<span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">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"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">systemctl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">status</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">docker</span></span> <span class="line"><span style="color:#FFCB6B;">curl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">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"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">systemctl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">status</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">docker</span></span>
<span class="line"><span style="color:#FFCB6B;">systemctl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">restart</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">docker</span></span> <span class="line"><span style="color:#FFCB6B;">systemctl</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">restart</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">docker</span></span>
@@ -1 +1 @@
import{_ as s,o as a,c as e,R as n}from"./chunks/framework.44fd0451.js";const C=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboardq.md","filePath":"guide/dashboardq.md","lastUpdated":1715651890000}'),o={name:"guide/dashboardq.md"},l=n("",22),t=[l];function p(r,c,i,d,h,y){return a(),e("div",null,t)}const b=s(o,[["render",p]]);export{C as __pageData,b as default}; import{_ as s,o as a,c as e,R as n}from"./chunks/framework.44fd0451.js";const C=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/dashboardq.md","filePath":"guide/dashboardq.md","lastUpdated":1715701589000}'),o={name:"guide/dashboardq.md"},l=n("",22),t=[l];function p(r,c,i,d,h,y){return a(),e("div",null,t)}const b=s(o,[["render",p]]);export{C as __pageData,b as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/loginq.md","filePath":"guide/loginq.md","lastUpdated":1715651890000}'),s={name:"guide/loginq.md"},i=o('<h2 id="登录回调后页面卡住-拒绝连接-响应时间过长" tabindex="-1">登录回调后页面卡住\\拒绝连接\\响应时间过长 <a class="header-anchor" href="#登录回调后页面卡住-拒绝连接-响应时间过长" aria-label="Permalink to &quot;登录回调后页面卡住\\拒绝连接\\响应时间过长&quot;">​</a></h2><p>还有其他一些表现形式,总之登录后浏览器无法正常显示。</p><ol><li>您的服务器无法连接到 Github/Gitee,最常见于国内服务器配置 Github 情况下,可以考虑多尝试几次或者切换到 Cloudflare Access。</li><li>您配置错了回调地址,确保您的回调地址正确且<strong>端口与协议</strong>均正确!</li><li>Dashboard 发生未知错误,您可以使用脚本查看日志。</li></ol><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>什么是协议? 在浏览器中,您的域名以 <code>://</code> 结尾的字符串即为协议,通常为 <code>http</code> 和 <code>https</code> 两种。由于正常部署情况下面板可能有多种协议+域名+端口组合均可访问,请务必选一个最合适的作为回调。</p></div><h3 id="如何检查我的回调地址是否错误" tabindex="-1">如何检查我的回调地址是否错误? <a class="header-anchor" href="#如何检查我的回调地址是否错误" aria-label="Permalink to &quot;如何检查我的回调地址是否错误?&quot;">​</a></h3><p>请确保登录前浏览器显示的协议+域名+端口和登录后跳转到的协议+域名+端口一致。<br> 请确保您的路径为 <code>/oauth2/callback</code>,<strong>全部小写</strong>。</p><h2 id="登录后面板报错" tabindex="-1">登录后面板报错 <a class="header-anchor" href="#登录后面板报错" aria-label="Permalink to &quot;登录后面板报错&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>清理 cookies 后重新登录,或换个浏览器。</li><li>检查回调地址,确保您的回调地址正确且<strong>端口与协议</strong>均正确!发起请求的地址需要和回调地址处于同域,端口、协议和域名(或IP)都需要一致。</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>容器 DNS 解析失败,多数情况下为修改了 iptables 相关配置。<br> 建议先重启 docker,<code>sudo systemctl restart docker</code>,再使用脚本重启面板。<br> 仍然出现 lookup 错误建议查看是否有其他控制 iptables 的工具,如宝塔防火墙等。<br> 这个问题也可能与内核有关系,请尝试更换官方内核。</p><h3 id="授权方式无效-或者登录回调地址无效、过期或已被撤销" tabindex="-1">授权方式无效,或者登录回调地址无效、过期或已被撤销 <a class="header-anchor" href="#授权方式无效-或者登录回调地址无效、过期或已被撤销" aria-label="Permalink to &quot;授权方式无效,或者登录回调地址无效、过期或已被撤销&quot;">​</a></h3><p>只出现在 Gitee 登录方式中,原因不明,建议更换到 GitHub。</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>可能由多种因素引起,最大可能性是网络问题,建议检查网络后重试。<br> 无法解决的话建议更换 Github 等。</p><h3 id="该用户不是本站点管理员-无法登录" tabindex="-1">该用户不是本站点管理员,无法登录 <a class="header-anchor" href="#该用户不是本站点管理员-无法登录" aria-label="Permalink to &quot;该用户不是本站点管理员,无法登录&quot;">​</a></h3><p>您登陆错了账号或者配置错了用户名,注意<strong>用户名不是邮箱</strong>,可使用脚本修改。<br> Cloudflare Access 用户请注意,您的用户名不是邮箱,而是 User ID。</p><h3 id="dial-tcp-xxx-443-i-o-timeout" tabindex="-1">dial tcp xxx:443 i/o timeout <a class="header-anchor" href="#dial-tcp-xxx-443-i-o-timeout" aria-label="Permalink to &quot;dial tcp xxx:443 i/o timeout&quot;">​</a></h3><p>网络问题,可先重启 Docker,<code>sudo systemctl restart docker</code>,再使用脚本重启面板。<br> 如为国内服Line truncated import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/loginq.md","filePath":"guide/loginq.md","lastUpdated":1715701589000}'),s={name:"guide/loginq.md"},i=o('<h2 id="登录回调后页面卡住-拒绝连接-响应时间过长" tabindex="-1">登录回调后页面卡住\\拒绝连接\\响应时间过长 <a class="header-anchor" href="#登录回调后页面卡住-拒绝连接-响应时间过长" aria-label="Permalink to &quot;登录回调后页面卡住\\拒绝连接\\响应时间过长&quot;">​</a></h2><p>还有其他一些表现形式,总之登录后浏览器无法正常显示。</p><ol><li>您的服务器无法连接到 Github/Gitee,最常见于国内服务器配置 Github 情况下,可以考虑多尝试几次或者切换到 Cloudflare Access。</li><li>您配置错了回调地址,确保您的回调地址正确且<strong>端口与协议</strong>均正确!</li><li>Dashboard 发生未知错误,您可以使用脚本查看日志。</li></ol><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>什么是协议? 在浏览器中,您的域名以 <code>://</code> 结尾的字符串即为协议,通常为 <code>http</code> 和 <code>https</code> 两种。由于正常部署情况下面板可能有多种协议+域名+端口组合均可访问,请务必选一个最合适的作为回调。</p></div><h3 id="如何检查我的回调地址是否错误" tabindex="-1">如何检查我的回调地址是否错误? <a class="header-anchor" href="#如何检查我的回调地址是否错误" aria-label="Permalink to &quot;如何检查我的回调地址是否错误?&quot;">​</a></h3><p>请确保登录前浏览器显示的协议+域名+端口和登录后跳转到的协议+域名+端口一致。<br> 请确保您的路径为 <code>/oauth2/callback</code>,<strong>全部小写</strong>。</p><h2 id="登录后面板报错" tabindex="-1">登录后面板报错 <a class="header-anchor" href="#登录后面板报错" aria-label="Permalink to &quot;登录后面板报错&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>清理 cookies 后重新登录,或换个浏览器。</li><li>检查回调地址,确保您的回调地址正确且<strong>端口与协议</strong>均正确!发起请求的地址需要和回调地址处于同域,端口、协议和域名(或IP)都需要一致。</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>容器 DNS 解析失败,多数情况下为修改了 iptables 相关配置。<br> 建议先重启 docker,<code>sudo systemctl restart docker</code>,再使用脚本重启面板。<br> 仍然出现 lookup 错误建议查看是否有其他控制 iptables 的工具,如宝塔防火墙等。<br> 这个问题也可能与内核有关系,请尝试更换官方内核。</p><h3 id="授权方式无效-或者登录回调地址无效、过期或已被撤销" tabindex="-1">授权方式无效,或者登录回调地址无效、过期或已被撤销 <a class="header-anchor" href="#授权方式无效-或者登录回调地址无效、过期或已被撤销" aria-label="Permalink to &quot;授权方式无效,或者登录回调地址无效、过期或已被撤销&quot;">​</a></h3><p>只出现在 Gitee 登录方式中,原因不明,建议更换到 GitHub。</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>可能由多种因素引起,最大可能性是网络问题,建议检查网络后重试。<br> 无法解决的话建议更换 Github 等。</p><h3 id="该用户不是本站点管理员-无法登录" tabindex="-1">该用户不是本站点管理员,无法登录 <a class="header-anchor" href="#该用户不是本站点管理员-无法登录" aria-label="Permalink to &quot;该用户不是本站点管理员,无法登录&quot;">​</a></h3><p>您登陆错了账号或者配置错了用户名,注意<strong>用户名不是邮箱</strong>,可使用脚本修改。<br> Cloudflare Access 用户请注意,您的用户名不是邮箱,而是 User ID。</p><h3 id="dial-tcp-xxx-443-i-o-timeout" tabindex="-1">dial tcp xxx:443 i/o timeout <a class="header-anchor" href="#dial-tcp-xxx-443-i-o-timeout" aria-label="Permalink to &quot;dial tcp xxx:443 i/o timeout&quot;">​</a></h3><p>网络问题,可先重启 Docker,<code>sudo systemctl restart docker</code>,再使用脚本重启面板。<br> 如为国内服Line truncated
@@ -1 +1 @@
import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/loginq.md","filePath":"guide/loginq.md","lastUpdated":1715651890000}'),s={name:"guide/loginq.md"},i=o("",21),r=[i];function l(n,c,d,h,p,u){return t(),a("div",null,r)}const k=e(s,[["render",l]]);export{b as __pageData,k as default}; import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/loginq.md","filePath":"guide/loginq.md","lastUpdated":1715701589000}'),s={name:"guide/loginq.md"},i=o("",21),r=[i];function l(n,c,d,h,p,u){return t(),a("div",null,r)}const k=e(s,[["render",l]]);export{b as __pageData,k as default};
-36
View File
@@ -1,36 +0,0 @@
import{_ as o,o as s,c as t,R as l}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/notifications.md","filePath":"guide/notifications.md","lastUpdated":1715651890000}'),a={name:"guide/notifications.md"},e=l(`<p>哪吒监控支持对服务器的负载、CPU、内存、硬盘、流量、月流量、进程数、连接数进行监控,并在其中某项达到用户设定值时发送告警通知 <br><br></p><h2 id="灵活的通知方式" tabindex="-1">灵活的通知方式 <a class="header-anchor" href="#灵活的通知方式" aria-label="Permalink to &quot;灵活的通知方式&quot;">​</a></h2><ul><li>在面板消息中,占位符 <code>#DATETIME#</code> 代表事件发生的时间戳。当通知被触发时,面板会自动将 <code>#DATETIME#</code> 替换为事件的实际时间。</li><li><code>#NEZHA#</code> 是面板消息占位符,面板触发通知时会自动用实际消息替换占位符</li><li>Body 内容是<code>JSON</code> 格式的:<strong>当请求类型为 FORM 时</strong>,值为 <code>key:value</code> 的形式,<code>value</code> 里面可放置占位符,通知时会自动替换。<strong>当请求类型为 JSON 时</strong> 只会简单进行字符串替换后直接提交到<code>URL</code>。</li><li>URL 里面也可放置占位符,请求时会进行简单的字符串替换。</li></ul><p><strong>请参考以下的通知方式示例,也可以根据自己的需求灵活设置推送方式</strong></p><h3 id="bark-示例" tabindex="-1">Bark 示例 <a class="header-anchor" href="#bark-示例" aria-label="Permalink to &quot;Bark 示例&quot;">​</a></h3><details><summary>点击展开/收起</summary><ul><li><p>名称:Bark</p></li><li><p>URL 组成: 第一个部分是 key,之后有三个匹配 /:key/:body or /:key/:title/:body or /:key/:category/:title/:body</p></li><li><p>请求方式: GET</p></li><li><p>请求类型: 默认</p></li><li><p>Body: 空</p></li><li><p>名称:Bark</p></li><li><p>URL 组成: /push</p></li><li><p>请求方式: POST</p></li><li><p>请求类型: 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="server-酱示例" tabindex="-1">Server 酱示例 <a class="header-anchor" href="#server-酱示例" aria-label="Permalink to &quot;Server 酱示例&quot;">​</a></h3><details><summary>点击展开/收起</summary><ul><li>名称:Server 酱</li><li>URL:<a href="https://sc.ftqq.com/SCUrandomkeys.send?title=%E5%93%AA%E5%90%92%E5%91%8A%E8%AD%A6%E4%BF%A1%E6%81%AF&amp;desp=#NEZHA#" target="_blank" rel="noreferrer">https://sc.ftqq.com/SCUrandomkeys.send?title=哪吒告警信息&amp;desp=#NEZHA#</a></li><li>请求方式: GET</li><li>请求类型: 默认</li><li>Body: 空</li></ul><p><strong>Server 酱进阶</strong></p><ul><li>名称:Server 酱</li><li>URL:<a href="https://sc.ftqq.com/SCUrandomkeys.send" target="_blank" rel="noreferrer">https://sc.ftqq.com/SCUrandomkeys.send</a></li><li>请求方式: POST</li><li>请求类型: FORM</li><li>Body:</li></ul><div class="language-json"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">title</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NAME#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">desp</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">**#NEZHA#</span><span style="color:#A6ACCD;">\\n\\n</span></span>
<span class="line"><span style="color:#C3E88D;">平均负载: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD1#</span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">,</span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD5#</span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">,</span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD15#</span><span style="color:#A6ACCD;">\\&quot;\\n\\n</span></span>
<span class="line"><span style="color:#C3E88D;">## [点击访问面板](https://你的面板域名)</span><span style="color:#A6ACCD;">\\n\\n</span></span>
<span class="line"><span style="color:#C3E88D;">![logo](https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg)</span><span style="color:#89DDFF;">&quot;</span></span>
<span class="line"><span style="color:#89DDFF;">}</span></span></code></pre></div><p><img src="https://github.com/iilemon/nezhahq.github.io/blob/main/docs/images/photo_2023-03-16_00-22-47a.jpg?raw=true" alt="展示"></p></details><h3 id="wxpusher-示例" tabindex="-1">wxpusher 示例 <a class="header-anchor" href="#wxpusher-示例" aria-label="Permalink to &quot;wxpusher 示例&quot;">​</a></h3><p><strong>需要提前关注你的应用</strong></p><details><summary>点击展开/收起</summary><ul><li>名称: wxpusher</li><li>URL:<a href="http://wxpusher.zjiecode.com/api/send/message" target="_blank" rel="noreferrer">http://wxpusher.zjiecode.com/api/send/message</a></li><li>请求方式: POST</li><li>请求类型: JSON</li><li>Body: <code>{&quot;appToken&quot;:&quot;你的appToken&quot;,&quot;topicIds&quot;:[],&quot;content&quot;:&quot;#NEZHA#&quot;,&quot;contentType&quot;:&quot;1&quot;,&quot;uids&quot;:[&quot;你的uid&quot;]}</code></li></ul></details><h3 id="telegram-示例-贡献者-haitau" tabindex="-1">Telegram 示例 贡献者:<a href="https://github.com/haitau" target="_blank" rel="noreferrer">@haitau</a> <a class="header-anchor" href="#telegram-示例-贡献者-haitau" aria-label="Permalink to &quot;Telegram 示例 贡献者:[@haitau](https://github.com/haitau)&quot;">​</a></h3><details><summary>点击展开/收起</summary><ul><li>名称:telegram 机器人消息通知</li><li>URL:<a href="https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&amp;text=#NEZHA#" target="_blank" rel="noreferrer">https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&amp;text=#NEZHA#</a></li><li>请求方式: GET</li><li>请求类型: 默认</li><li>Body: 空</li><li>URL 参数获取说明:botXXXXXX 中的 XXXXXX 是在 telegram 中关注官方 @Botfather ,输入/newbot ,创建新的机器人(bot)时,会提供的 token(在提示 Use this token to access the HTTP API:后面一行)这里 &#39;bot&#39; 三个字母不可少。创建 bot 后,需要先在 telegram 中与 BOT 进行对话(随便发个消息),然后才可用 API 发送消息。YYYYYY 是 telegram 用户的数字 ID。与机器人@userinfobot 对话可获得。</li></ul></details><h3 id="邮件通知示例-sendcloud-贡献者-白歌" tabindex="-1">邮件通知示例 - SendCloud 贡献者:<a href="https://github.com/cantoblanco" target="_blank" rel="noreferrer">@白歌</a> <a class="header-anchor" href="#邮件通知示例-sendcloud-贡献者-白歌" aria-label="Permalink to &quot;邮件通知示例 - SendCloud 贡献者:[@白歌](https://github.com/cantoblanco)&quot;">​</a></h3><details><summary>点击展开/收起</summary><p><strong>注意:SendCloud 有每日免费发送邮件限额限制,这里仅作示例,你可以选择付费服务或其他类似的免费服务,使用方法类似。</strong></p><ul><li>名称:邮件告警</li><li>URL:<a href="https://api.sendcloud.net/apiv2/mail/send?apiUser=" target="_blank" rel="noreferrer">https://api.sendcloud.net/apiv2/mail/send?apiUser=</a>&lt;替换APIUSER&gt;apiKey=&lt;替换APIKEY&gt;&amp;from=&lt;自定义发件邮箱&gt;&amp;fromName=Nezha&amp;to=&lt;自定义收件邮箱&gt;&amp;subject=Nezha-Notification&amp;html=#NEZHA#</li><li>请求方式: POST</li><li>请求类型: JSON</li><li>Header: 留空</li><li>Body: 留空</li></ul><p>URL 参数获取说明:此方式需提前在 <a href="https://www.sendcloud.net/" target="_blank" rel="noreferrer">SendCloud</a> 注册账号,创建发件邮箱,然后在<a href="https://www.sendcloud.net/sendSetting/apiuser" target="_blank" rel="noreferrer">这里</a>获取 APIUSER 和 APIKEY,替换 URL 中的 &lt;替换APIUSER&gt; 和 &lt;替换APIKEY&gt; 为自己的 APIUSER 和 APIKEY,替换 URL 中的 &lt;自定义发件邮箱&gt; 和 &lt;自定义收件邮箱&gt; 为自己的发件邮箱和收件邮箱。</p></details><h3 id="钉钉群机器人配置-示例" tabindex="-1">钉钉群机器人配置 示例 <a class="header-anchor" href="#钉钉群机器人配置-示例" aria-label="Permalink to &quot;钉钉群机器人配置 示例&quot;">​</a></h3><details><summary>点击展开/收起</summary><ul><li>名称: 哪吒探针小跟班</li><li>URL:<a href="https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxxxxxxxxxxx" target="_blank" rel="noreferrer">https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxxxxxxxxxxx</a></li><li>请求方式: POST</li><li>请求类型: JSON</li><li>Header: <code>{&quot;Content-Type&quot;: &quot;application/json&quot;}</code></li><li>Body: <code>{&quot;msgtype&quot;: &quot;text&quot;,&quot;text&quot;: {&quot;content&quot;:&quot;哪吒探针:\\n#NEZHA#&quot;}}</code></li><li>URL 参数获取说明:机器人URL在钉钉群-管理机器人-创建机器人后获取,安全方式选择自定义关键词,Body中content中需包含该关键词</li></ul></details><h3 id="企业微信-群机器人-示例-贡献者-chowrex" tabindex="-1">企业微信 群机器人 Line truncated
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">content</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#NEZHA#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerName</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NAME#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerIP</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.IP#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerIPV4</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.IPV4#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerIPV6</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.IPV6#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">CPU</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.CPU#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">MEM</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.MEM#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">SWAP</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.SWAP#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">DISK</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.DISK#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">NetInSpeed</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NETINSPEED#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">NetOutSpeed</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NETOUTSPEED#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">TransferIn</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFERIN#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">TranferOut</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFEROUT#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">Load1</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD1#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">Load5</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD5#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">Load15</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD15#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">TCP_CONN_COUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.TCPCONNCOUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span><span style="color:#A6ACCD;"> # 无效</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">UDP_CONN_COUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.UDPCONNCOUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span><span style="color:#A6ACCD;"> # 无效</span></span>
<span class="line"><span style="color:#89DDFF;">}</span></span></code></pre></div><blockquote><p><a href="https://developer.work.weixin.qq.com/document/path/91770#markdown%E7%B1%BB%E5%9E%8B" target="_blank" rel="noreferrer">群机器人配置说明 - 文档 - 企业微信开发者中心</a></p></blockquote><ul><li><p>名称:企业微信群机器人</p></li><li><p>URL:<a href="https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=YOUR_BOT_KEY" target="_blank" rel="noreferrer">https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=YOUR_BOT_KEY</a></p></li><li><p>请求方式: POST</p></li><li><p>请求类型: JSON</p></li><li><p>Body:</p><pre><code>\`\`\`json
{
&quot;msgtype&quot;: &quot;markdown&quot;,
&quot;markdown&quot;: {
&quot;content&quot;: &quot;# 哪吒通知消息\\n\\n\\&quot;#NEZHA#\\&quot;\\n\\n&gt; 名称: \\&quot;#SERVER.NAME#\\&quot;\\n&gt; IP: \\&quot;#SERVER.IP#\\&quot;\\n&gt; IPv4: \\&quot;#SERVER.IPV4#\\&quot;\\n&gt; IPv6: \\&quot;#SERVER.IPV6#\\&quot;\\n&gt; CPU: \\&quot;#SERVER.CPU#\\&quot;\\n&gt; 内存: \\&quot;#SERVER.MEM#\\&quot;\\n&gt; 交换分区: \\&quot;#SERVER.SWAP#\\&quot;\\n&gt; 存储: \\&quot;#SERVER.DISK#\\&quot;\\n&gt; 实时上传速度: \\&quot;#SERVER.NETINSPEED#\\&quot;\\n&gt; 实时下载速度: \\&quot;#SERVER.NETOUTSPEED#\\&quot;\\n&gt; 总上传: \\&quot;#SERVER.TRANSFERIN#\\&quot;\\n&gt; 总下载: \\&quot;#SERVER.TRANSFEROUT#\\&quot;\\n&gt; 1分钟内负载: \\&quot;#SERVER.LOAD1#\\&quot;\\n&gt; 5分钟内负载: \\&quot;#SERVER.LOAD5#\\&quot;\\n&gt; 15分钟内负载: \\&quot;#SERVER.LOAD15#\\&quot;\\n&gt; TCP连接数: \\&quot;#SERVER.TCPCONNCOUNT\\&quot;\\n&gt; UDP连接数: \\&quot;#SERVER.UDPCONNCOUNT\\&quot;\\n\\n&quot;
}
}
\`\`\`
根据需求删减相关内容信息即可
</code></pre></li></ul><p><img src="https://user-images.githubusercontent.com/30169860/223605620-eac53ee6-09f9-4583-94fa-9b0cdedba81c.png" alt="通知效果"></p></details><h3 id="飞书群机器人配置-示例-贡献者-eya46" tabindex="-1">飞书群机器人配置 示例 贡献者:<a href="https://github.com/eya46" target="_blank" rel="noreferrer">@eya46</a> <a class="header-anchor" href="#飞书群机器人配置-示例-贡献者-eya46" aria-label="Permalink to &quot;飞书群机器人配置 示例 贡献者:[@eya46](https://github.com/eya46)&quot;">​</a></h3><details><summary>点击展开/收起</summary><ul><li>名称: 哪吒面板Bot</li><li>URL:<a href="https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxx" target="_blank" rel="noreferrer">https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxx</a></li><li>请求方式: POST</li><li>请求类型: JSON</li><li>Body: <code>{&quot;content&quot;:{&quot;text&quot;:&quot;#NEZHA#\\n#DATETIME#&quot;},&quot;msg_type&quot;:&quot;text&quot;}</code></li><li>URL 参数获取说明:机器人URL通过飞书群-群机器人-添加机器人-自定义机器人(webhook)创建后获取</li></ul></details><br><br><h2 id="告警规则说明" tabindex="-1">告警规则说明 <a class="header-anchor" href="#告警规则说明" aria-label="Permalink to &quot;告警规则说明&quot;">​</a></h2><h3 id="基本规则" tabindex="-1">基本规则 <a class="header-anchor" href="#基本规则" aria-label="Permalink to &quot;基本规则&quot;">​</a></h3><ul><li>type:可选取一个或多个类型,如在一个规则中选择了多个类型,需要<strong>同时满足</strong>所有选择的类型才会触发通知(可参考后面的示例) <ul><li><code>cpu</code>、<code>memory</code>、<code>swap</code>、<code>disk</code></li><li><code>net_in_speed</code> 入站网速、<code>net_out_speed</code> 出站网速、<code>net_all_speed</code> 双向网速、<code>transfer_in</code> 入站流量、<code>transfer_out</code> 出站流量、<code>transfer_all</code> 双向流量</li><li><code>offline</code> 离线监控</li><li><code>load1</code>、<code>load5</code>、<code>load15</code> 负载</li><li><code>process_count</code> 进程数 <em>目前取线程数占用资源太多,暂时不支持</em></li><li><code>tcp_conn_count</code>、<code>udp_conn_count</code> 连接数</li></ul></li><li>duration:持续数秒,数秒内采样记录 30% 以上触发阈值才会告警(防数据插针)</li><li>min 或 max: <ul><li>流量、网速类数值 为字节(1KB=1024B,1MB = 1024*1024B)</li><li>内存、硬盘、CPU 以占用百分比计数</li><li>离线监控无需设置此项</li></ul></li><li>cover: <ul><li><code>0</code> 监控所有,通过 <code>ignore</code> 忽略特定服务器</li><li><code>1</code> 忽略所有,通过 <code>ignore</code> 监控特定服务器<br> 例如:<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>ignore: 选择忽略特定服务器,搭配 <code>cover</code> 使用,内容为服务器 id 和布尔值,例如:<code>{&quot;1&quot;: true, &quot;2&quot;:false}</code></li></ul><p><strong>完整示例:</strong></p><blockquote><blockquote><p>添加一个离线告警</p></blockquote><ul><li>名称:离线通知</li><li>规则:<code>[{&quot;Type&quot;:&quot;offline&quot;,&quot;Duration&quot;:10}]</code></li><li>启用:√</li></ul></blockquote><blockquote><blockquote><p>添加一个监控 CPU 持续 10s 超过 50% <strong>且</strong> 内存持续 20s 占用低于 20% 的告警</p></blockquote><ul><li>名称:CPU+内存</li><li>规则:<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>启用:√</li></ul></blockquote><blockquote><blockquote><p>将特定的服务器通知发送到特定的通知分组</p></blockquote><p>示例场景:<br> 你有 1、2、3、4 四台服务器和 A、B 两个不同的通知组<br> 1、2 这两台服务器掉线十分钟后给通知组 A 发送通知<br> 3、4 这两台服务器掉线十分钟后给通知组 B 发送通知</p><p>首先你需要先设置好 A、B 两个通知组,然后添加两条告警规则:</p><p><strong>规则一:</strong></p><ul><li>名称:1、2 离线,发送给通知组 A</li><li>规则:<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>通知方式组: A</li><li>启用:√</li></ul><p><strong>规则二:</strong></p><ul><li>名称:3、4 离线,发送给通知组 B</li><li>规则:<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><Line truncated
@@ -1 +0,0 @@
import{_ as o,o as s,c as t,R as l}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/notifications.md","filePath":"guide/notifications.md","lastUpdated":1715651890000}'),a={name:"guide/notifications.md"},e=l("",41),n=[e];function p(r,c,u,i,D,q){return s(),t("div",null,n)}const F=o(a,[["render",p]]);export{d as __pageData,F as default};
+28
View File
@@ -0,0 +1,28 @@
import{_ as o,o as s,c as a,R as l}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/notifications.md","filePath":"guide/notifications.md","lastUpdated":1715701589000}'),n={name:"guide/notifications.md"},t=l(`<p>哪吒监控支持对服务器的负载、CPU、内存、硬盘、流量、月流量、进程数、连接数进行监控,并在达到用户设定的阈值时发送告警通知。</p><h2 id="灵活的通知方式" tabindex="-1">灵活的通知方式 <a class="header-anchor" href="#灵活的通知方式" aria-label="Permalink to &quot;灵活的通知方式&quot;">​</a></h2><ul><li>在面板消息中,占位符 <code>#DATETIME#</code> 代表事件发生的时间戳。当通知被触发时,面板会自动将 <code>#DATETIME#</code> 替换为事件的实际时间。</li><li><code>#NEZHA#</code> 是面板消息占位符,面板触发通知时会自动用实际消息替换占位符。</li><li>Body 内容是 <code>JSON</code> 格式的:<strong>当请求类型为 FORM 时</strong>,值为 <code>key:value</code> 的形式,<code>value</code> 里面可放置占位符,通知时会自动替换。<strong>当请求类型为 JSON 时</strong> 只会简单进行字符串替换后直接提交到 <code>URL</code>。</li><li>URL 里面也可放置占位符,请求时会进行简单的字符串替换。</li></ul><p><strong>请参考以下的通知方式示例,也可以根据自己的需求灵活设置推送方式。</strong></p><h3 id="bark-示例" tabindex="-1">Bark 示例 <a class="header-anchor" href="#bark-示例" aria-label="Permalink to &quot;Bark 示例&quot;">​</a></h3><details><summary>点击展开/收起</summary><ul><li><p>名称:Bark</p></li><li><p>URL 组成: /:key/:body or /:key/:title/:body or /:key/:category/:title/:body</p></li><li><p>请求方式: GET</p></li><li><p>请求类型: 默认</p></li><li><p>Body: 空</p></li><li><p>名称:Bark</p></li><li><p>URL 组成: /push</p></li><li><p>请求方式: POST</p></li><li><p>请求类型: 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-示例-贡献者-白歌" tabindex="-1">Slack 示例 贡献者:<a href="https://github.com/cantoblanco" target="_blank" rel="noreferrer">@白歌</a> <a class="header-anchor" href="#slack-示例-贡献者-白歌" aria-label="Permalink to &quot;Slack 示例 贡献者:[@白歌](https://github.com/cantoblanco)&quot;">​</a></h3><details><summary>点击展开/收起</summary><h4 id="url-参数获取说明" tabindex="-1">URL 参数获取说明 <a class="header-anchor" href="#url-参数获取说明" aria-label="Permalink to &quot;URL 参数获取说明&quot;">​</a></h4><p>请提前准备好 Slack 的 Workspace 并为这个 Workspace 创建一个 App。如果你还没有创建,可以在 <a href="https://api.slack.com/apps" target="_blank" rel="noreferrer">Slack API</a> 创建一个 App。</p><p>创建完成 App 后,需要为这个 App 添加一个 Incoming Webhook。在 App 的设置页面中找到 Incoming Webhooks,将 Activate Incoming Webhooks 勾选为 ON,在页面下方找到并点击 Add New Webhook to Workspace,选择一个 Channel,然后点击允许。完成创建后,你会得到一个 Webhook URL,使用这个 URL 替换下方的示例 URL。</p><ul><li>名称: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>请求方式: POST</li><li>请求类型: JSON</li><li>Body: <code>{&quot;text&quot;:&quot;#NEZHA#&quot;}</code></li></ul></details><h3 id="server-酱示例" tabindex="-1">Server 酱示例 <a class="header-anchor" href="#server-酱示例" aria-label="Permalink to &quot;Server 酱示例&quot;">​</a></h3><details><summary>点击展开/收起</summary><ul><li>名称:Server 酱</li><li>URL:<a href="https://sc.ftqq.com/SCUrandomkeys.send?title=%E5%93%AA%E5%90%92%E5%91%8A%E8%AD%A6%E4%BF%A1%E6%81%AF&amp;desp=#NEZHA#" target="_blank" rel="noreferrer">https://sc.ftqq.com/SCUrandomkeys.send?title=哪吒告警信息&amp;desp=#NEZHA#</a></li><li>请求方式: GET</li><li>请求类型: 默认</li><li>Body: 空</li></ul><p><strong>Server 酱进阶</strong></p><ul><li><p>名称:Server 酱</p></li><li><p>URL:<a href="https://sc.ftqq.com/SCUrandomkeys.send" target="_blank" rel="noreferrer">https://sc.ftqq.com/SCUrandomkeys.send</a></p></li><li><p>请求方式: POST</p></li><li><p>请求类型: FORM</p></li><li><p>Body:</p><div class="language-json"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki material-theme-palenight"><code><span class="line"><span Line truncated
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">title</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NAME#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">desp</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">**#NEZHA#</span><span style="color:#A6ACCD;">\\n\\n</span><span style="color:#C3E88D;">平均负载: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD1#</span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">,</span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD5#</span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">,</span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD15#</span><span style="color:#A6ACCD;">\\&quot;\\n\\n</span><span style="color:#C3E88D;">## [点击访问面板](https://你的面板域名)</span><span style="color:#A6ACCD;">\\n\\n</span><span style="color:#C3E88D;">![logo](https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg)</span><span style="color:#89DDFF;">&quot;</span></span>
<span class="line"><span style="color:#89DDFF;">}</span></span></code></pre></div><p><img src="https://github.com/iilemon/nezhahq.github.io/blob/main/docs/images/photo_2023-03-16_00-22-47a.jpg?raw=true" alt="展示"></p></li></ul></details><h3 id="telegram-示例-贡献者-白歌" tabindex="-1">Telegram 示例 贡献者:<a href="https://github.com/cantoblanco" target="_blank" rel="noreferrer">@白歌</a> <a class="header-anchor" href="#telegram-示例-贡献者-白歌" aria-label="Permalink to &quot;Telegram 示例 贡献者:[@白歌](https://github.com/cantoblanco)&quot;">​</a></h3><details><summary>点击展开/收起</summary><h4 id="url-参数获取说明-1" tabindex="-1">URL 参数获取说明 <a class="header-anchor" href="#url-参数获取说明-1" aria-label="Permalink to &quot;URL 参数获取说明&quot;">​</a></h4><p>请提前在 Telegram 中创建一个机器人,获取到机器人的 token 和你的 Telegram 用户 ID。</p><p>机器人的 token 和用户 ID 都是数字和字母的组合,可以在 Telegram 中与 @userinfobot 对话获取自己的用户 ID。与 @BotFather 对话,输入命令 /newbot 创建一个机器人,创建完成后可以获得机器人的 token。</p><p>得到的 token 和用户 ID 都是字符串,可以直接拼接到 URL 中,如下所示,将其中的 botXXXXXX 替换为你的机器人 token,将 YYYYYY 替换为你的用户 ID。注意,你需要先与机器人对话,否则机器人无法发送消息给你。</p><ul><li>名称:Telegram</li><li>URL:<a href="https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&amp;text=#NEZHA#" target="_blank" rel="noreferrer">https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&amp;text=#NEZHA#</a></li><li>请求方式: GET</li><li>请求类型: 默认</li><li>Body: 留空</li></ul></details><h3 id="wxpusher-示例" tabindex="-1">wxpusher 示例 <a class="header-anchor" href="#wxpusher-示例" aria-label="Permalink to &quot;wxpusher 示例&quot;">​</a></h3><p><strong>需要提前关注你的应用</strong></p><details><summary>点击展开/收起</summary><ul><li>名称: wxpusher</li><li>URL:<a href="http://wxpusher.zjiecode.com/api/send/message" target="_blank" rel="noreferrer">http://wxpusher.zjiecode.com/api/send/message</a></li><li>请求方式: POST</li><li>请求类型: JSON</li><li>Body: <code>{&quot;appToken&quot;:&quot;你的appToken&quot;,&quot;topicIds&quot;:[],&quot;content&quot;:&quot;#NEZHA#&quot;,&quot;contentType&quot;:&quot;1&quot;,&quot;uids&quot;:[&quot;你的uid&quot;]}</code></li></ul></details><h3 id="邮件通知示例-sendcloud-贡献者-白歌" tabindex="-1">邮件通知示例 - SendCloud 贡献者:<a href="https://github.com/cantoblanco" target="_blank" rel="noreferrer">@白歌</a> <a class="header-anchor" href="#邮件通知示例-sendcloud-贡献者-白歌" aria-label="Permalink to &quot;邮件通知示例 - SendCloud 贡献者:[@白歌](https://github.com/cantoblanco)&quot;">​</a></h3><details><summary>点击展开/收起</summary><p><strong>注意:SendCloud 有每日免费发送邮件限额限制,这里仅作示例,你可以选择付费服务或其他类似的免费服务,使用方法类似。</strong></p><h4 id="url-参数获取说明-2" tabindex="-1">URL 参数获取说明 <a class="header-anchor" href="#url-参数获取说明-2" aria-label="Permalink to &quot;URL 参数获取说明&quot;">​</a></h4><p>该示例使用 SendCloud 作为发信服务,需提前在 <a href="https://www.sendcloud.net/" target="_blank" rel="noreferrer">SendCloud</a> 注册账号,创建发件邮箱,然后在<a href="https://www.sendcloud.net/sendSetting/apiuser" target="_blank" rel="noreferrer">这里</a>获取 APIUSER 和 APIKEY。</p><p>替换示例 URL 中的 <code>&lt;替换APIUSER&gt;</code> 和 <code>&lt;替换APIKEY&gt;</code> 为自己的 APIUSER 和 APIKEY,替换 URL 中的 <code>&lt;自定义发件邮箱&gt;</code> 和 <code>&lt;自定义收件邮箱&gt;</code> 为任意的的发件邮箱和收件邮箱。</p><ul><li>名称:邮件告警</li><li>URL:<a href="https://api.sendcloud.net/apiv2/mail/send?apiUser=" target="_blank" rel="noreferrer">https://api.sendcloud.net/apiv2/mail/send?apiUser=</a>&lt;替换APIUSER&gt;&amp;apiKey=&lt;替换APIKEY&gt;&amp;from=&lt;自定义发件邮箱&gt;&amp;fromName=Nezha&amp;to=&lt;自定义收件邮箱&gt;&amp;subject=Nezha-Notification&amp;html=#NEZHA#</li><li>请求方式: POST</li><li>请求类型: JSON</li><li>Header: 留空</li><li>Body: 留空</li></ul></details><h3 id="钉钉群机器人配置-示例" tabindex="-1">钉钉群机器人配置 示例 <a class="header-anchor" href="#钉钉群机器人配置-示例" aria-label="Permalink to &quot;钉钉群机器人配置 示例&quot;">​</a></h3><details><summary>点击展开/收起</summary><h4 id="url-参数获取说明-3" tabindex="-1">URL 参数获取说明 <a class="header-anchor" href="#url-参数获取说明-3" aria-label="Permalink to &quot;URL 参Line truncated
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">content</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#NEZHA#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerName</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NAME#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerIP</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.IP#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerIPV4</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.IPV4#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">ServerIPV6</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.IPV6#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">CPU</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.CPU#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">MEM</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.MEM#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">SWAP</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.SWAP#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">DISK</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.DISK#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">NetInSpeed</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NETINSPEED#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">NetOutSpeed</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.NETOUTSPEED#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">TransferIn</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFERIN#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">TranferOut</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFEROUT#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">Load1</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD1#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">Load5</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD5#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">Load15</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD15#</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">TCP_CONN_COUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.TCPCONNCOUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span><span style="color:#A6ACCD;"> # 无效</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">UDP_CONN_COUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">#SERVER.UDPCONNCOUNT</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span><span style="color:#A6ACCD;"> # 无效</span></span>
<span class="line"><span style="color:#89DDFF;">}</span></span></code></pre></div><blockquote><p><a href="https://developer.work.weixin.qq.com/document/path/91770#markdown%E7%B1%BB%E5%9E%8B" target="_blank" rel="noreferrer">群机器人配置说明 - 文档 - 企业微信开发者中心</a></p></blockquote><ul><li>名称:企业微信群机器人</li><li>URL:<a href="https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=YOUR_BOT_KEY" target="_blank" rel="noreferrer">https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=YOUR_BOT_KEY</a></li><li>请求方式: POST</li><li>请求类型: JSON</li><li>Body:<div class="language-json"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">msgtype</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">markdown</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C792EA;">markdown</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#FFCB6B;">content</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">:</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;"># 哪吒通知消息</span><span style="color:#A6ACCD;">\\n\\n\\&quot;</span><span style="color:#C3E88D;">#NEZHA#</span><span style="color:#A6ACCD;">\\&quot;\\n\\n</span><span style="color:#C3E88D;">&gt; 名称: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.NAME#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; IP: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.IP#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; IPv4: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.IPV4#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; IPv6: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.IPV6#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; CPU: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.CPU#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 内存: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.MEM#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 交换分区: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.SWAP#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 存储: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.DISK#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 实时上传速度: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.NETINSPEED#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 实时下载速度: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.NETOUTSPEED#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 总上传: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFERIN#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 总下载: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.TRANSFEROUT#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 1分钟内负载: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD1#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 5分钟内负载: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD5#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; 15分钟内负载: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.LOAD15#</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; TCP连接数: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.TCPCONNCOUNT</span><span style="color:#A6ACCD;">\\&quot;\\n</span><span style="color:#C3E88D;">&gt; UDP连接数: </span><span style="color:#A6ACCD;">\\&quot;</span><span style="color:#C3E88D;">#SERVER.UDPCONNCOUNT</span><span style="color:#A6ACCD;">\\&quot;\\n\\n</span><span style="color:#89DDFF;">&quot;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">}</span></span>
<span class="line"><span style="color:#89DDFF;">}</span></span></code></pre></div></li></ul><p>根据需求删减相关内容信息即可。</p><p><img src="https://user-images.githubusercontent.com/30169860/223605620-eac53ee6-09f9-4583-94fa-9b0cdedba81c.png" alt="通知效果"></p></details><h3 id="飞书群机器人配置-示例-贡献者-eya46" tabindex="-1">飞书群机器人配置 示例 贡献者:<a href="https://github.com/eya46" target="_blank" rel="noreferrer">@eya46</a> <a class="header-anchor" href="#飞书群机器人配置-示例-贡献者-eya46" aria-label="Permalink to &quot;飞书群机器人配置 示例 贡献者:[@eya46](https://github.com/eya46)&quot;">​</a></h3><details><summary>点击展开/收起</summary><h4 id="url-参数获取说明-4" tabindex="-1">URL 参数获取说明 <a class="header-anchor" href="#url-参数获取说明-4" aria-label="Permalink to &quot;URL 参数获取说明&quot;">​</a></h4><p>机器人 URL 通过飞书群 - 群机器人 - 添加机器人 - 自定义机器人(webhook)创建后获取。</p><ul><li>名称: 哪吒面板 Bot</li><li>URL:<a href="https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxx" target="_blank" rel="noreferrer">https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxx</a></li><li>请求方式: POST</li><li>请求类型: JSON</li><li>Body: <code>{&quot;content&quot;:{&quot;text&quot;:&quot;#NEZHA#\\n#DATETIME#&quot;},&quot;msg_type&quot;:&quot;text&quot;}</code></li></ul></details><h2 id="告警规则说明" tabindex="-1">告警规则说明 <a class="header-anchor" href="#告警规则说明" aria-label="Permalink to &quot;告警规则说明&quot;">​</a></h2><h3 id="基本规则" tabindex="-1">基本规则 <a class="header-anchor" href="#基本规则" aria-label="Permalink to &quot;基本规则&quot;">​</a></h3><ul><li><code>type</code>:可选取一个或多个类型,如在一个规则中选择了多个类型,需要<strong>同时满足</strong>所有选择的类型才会触发通知(可参考后面的示例) <ul><li><code>cpu</code>、<code>memory</code>、<code>swap</code>、<code>disk</code></li><li><code>net_in_speed</code> 入站网速、<code>net_out_speed</code> 出站网速、<code>net_all_speed</code> 双向网速、<code>transfer_in</code> 入站流量、<code>transfer_out</code> 出站流量、<code>transfer_all</code> 双向流量</li><li><code>offline</code> 离线监控</li><li><code>load1</code>、<code>load5</code>、<code>load15</code> 负载</li><li><code>process_count</code> 进程数(目前取线程数占用资源太多,暂时不支持)</li><li><code>tcp_conn_count</code>、<code>udp_conn_count</code> 连接数</li></ul></li><li><code>duration</code>:持续数秒,数秒内采样记录 30% 以上触发阈值才会告警(防数据插针)</li><li><code>min</code> 或 <code>max</code>: <ul><li>流量、网速类单位为字节(1KB=1024B,1MB=1024*1024B)</li><li>内存、硬盘、CPU 以占用百分比计数</li><li>离线监控无需设置此项</li></ul></li><li><code>cover</code>: <ul><li><code>0</code> 监控所有服务器,通过 <code>ignore</code> 忽略特定服务器</li><li><code>1</code> 忽略所有服务器,通过 <code>ignore</code> 监控特定服务器<br> 例如:<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>:选择忽略特定服务器,搭配 <code>cover</code> 使用,内容为服务器 ID 和布尔值,例如:<code>{&quot;1&quot;: true, &quot;2&quot;: false}</code></li></ul><p><strong>完整示例:</strong></p><p>添加一个离线告警:</p><ul><li>名称:离线通知</li><li>规则:<code>[{&quot;Type&quot;:&quot;offline&quot;,&quot;Duration&quot;:10}]</code></li><li>启用:√</li></ul><p>添加一个监控 CPU 持续 10 秒超过 50% <strong>且</strong> 内存持续 20 秒占用低于 20% 的告警:</p><ul><li>名称:CPU+内存</li><li>规则:<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>启用:√</li></ul><p>将特定的服务器通知发送到特定的通知分组:</p><p>示例场景:<br> 有 1、2、3、4 四台服务器和 A、B 两个不同的通知组。<br> 1、2 这两台服务器掉线十分钟后给通知组 A 发送通知。<br> 3、4 这两台服务器掉线十分钟后给通知组 B 发送通知。</p><p>首先你需要先设置好 A、B 两个通知组,然后添加两条告警规则:</p><p><strong>规则一:</strong></p><ul><li>名称:1、2 离线,发送给通知组 A</li><li>规则:<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>通知方式组:A</li><li>启用:√</Line truncated
@@ -0,0 +1 @@
import{_ as o,o as s,c as a,R as l}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/notifications.md","filePath":"guide/notifications.md","lastUpdated":1715701589000}'),n={name:"guide/notifications.md"},t=l("",50),e=[t];function p(r,c,D,i,u,y){return s(),a("div",null,e)}const q=o(n,[["render",p]]);export{d as __pageData,q as default};
@@ -1,4 +1,4 @@
import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q1.md","filePath":"guide/q1.md","lastUpdated":1715651890000}'),p={name:"guide/q1.md"},o=l(`<h2 id="准备工作" tabindex="-1">准备工作 <a class="header-anchor" href="#准备工作" aria-label="Permalink to &quot;准备工作&quot;">​</a></h2><p>如果你的 Dashboard 服务器无法访问 Telegram Bot API,但你依然想使用 Telegram 来推送通知,你可以尝试使用反向代理的方式解决这个问题。</p><p><strong>这里介绍使用你自己的服务器进行反代的方法。你也可以选择使用 Cloudflare 的 Workers 进行反代,但可能对于中国大陆的用户来说网络连通性依然不佳。</strong></p><p>要搭建一个 Telegram Bot API 反代,你需要准备以下内容:</p><ol><li>一个可以连接 Telegram Bot API 服务器(并安装好 Nginx)。</li><li>一个域名(提前申请 SSL 证书)。</li></ol><h2 id="nginx-配置" tabindex="-1">NGINX 配置 <a class="header-anchor" href="#nginx-配置" aria-label="Permalink to &quot;NGINX 配置&quot;">​</a></h2><p>编辑 Nginx 配置文件,在 <code>http{}</code> 中添加如下配置:</p><div class="language-nginx"><button title="Copy Code" class="copy"></button><span class="lang">nginx</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#676E95;font-style:italic;"># HTTP 强制跳转到 HTTPS</span></span> import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q1.md","filePath":"guide/q1.md","lastUpdated":1715701589000}'),p={name:"guide/q1.md"},o=l(`<h2 id="准备工作" tabindex="-1">准备工作 <a class="header-anchor" href="#准备工作" aria-label="Permalink to &quot;准备工作&quot;">​</a></h2><p>如果你的 Dashboard 服务器无法访问 Telegram Bot API,但你依然想使用 Telegram 来推送通知,你可以尝试使用反向代理的方式解决这个问题。</p><p><strong>这里介绍使用你自己的服务器进行反代的方法。你也可以选择使用 Cloudflare 的 Workers 进行反代,但可能对于中国大陆的用户来说网络连通性依然不佳。</strong></p><p>要搭建一个 Telegram Bot API 反代,你需要准备以下内容:</p><ol><li>一个可以连接 Telegram Bot API 服务器(并安装好 Nginx)。</li><li>一个域名(提前申请 SSL 证书)。</li></ol><h2 id="nginx-配置" tabindex="-1">NGINX 配置 <a class="header-anchor" href="#nginx-配置" aria-label="Permalink to &quot;NGINX 配置&quot;">​</a></h2><p>编辑 Nginx 配置文件,在 <code>http{}</code> 中添加如下配置:</p><div class="language-nginx"><button title="Copy Code" class="copy"></button><span class="lang">nginx</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#676E95;font-style:italic;"># HTTP 强制跳转到 HTTPS</span></span>
<span class="line"><span style="color:#C792EA;">server</span><span style="color:#A6ACCD;"> {</span></span> <span class="line"><span style="color:#C792EA;">server</span><span style="color:#A6ACCD;"> {</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> listen </span><span style="color:#A6ACCD;">80</span><span style="color:#89DDFF;">;</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> listen </span><span style="color:#A6ACCD;">80</span><span style="color:#89DDFF;">;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> listen </span><span style="color:#A6ACCD;">[::]:80</span><span style="color:#89DDFF;">;</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> listen </span><span style="color:#A6ACCD;">[::]:80</span><span style="color:#89DDFF;">;</span></span>
@@ -1 +1 @@
import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q1.md","filePath":"guide/q1.md","lastUpdated":1715651890000}'),p={name:"guide/q1.md"},o=l("",16),e=[o];function t(c,r,C,y,D,A){return a(),n("div",null,e)}const d=s(p,[["render",t]]);export{F as __pageData,d as default}; import{_ as s,o as a,c as n,R as l}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q1.md","filePath":"guide/q1.md","lastUpdated":1715701589000}'),p={name:"guide/q1.md"},o=l("",16),e=[o];function t(c,r,C,y,D,A){return a(),n("div",null,e)}const d=s(p,[["render",t]]);export{F as __pageData,d as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Agent 启动/上线 问题自检流程","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q2.md","filePath":"guide/q2.md","lastUpdated":1715651890000}'),n={name:"guide/q2.md"},r=o('<h1 id="agent-启动-上线-问题自检流程" tabindex="-1">Agent 启动/上线 问题自检流程 <a class="header-anchor" href="#agent-启动-上线-问题自检流程" aria-label="Permalink to &quot;Agent 启动/上线 问题自检流程&quot;">​</a></h1><ol><li>直接执行 <code>/opt/nezha/agent/nezha-agent -s 面板IP或非CDN域名:面板RPC端口 -p Agent密钥 -d</code> 查看日志是否是因为 DNS、网络不佳导致超时(timeout)</li><li><code>nc -v 域名/IP 面板RPC端口</code> 或者 <code>telnet 域名/IP 面板RPC端口</code> 来检验是否是网络问题,检查本机与面板服务器的出入站防火墙,如果无法判断问题可借助 <a href="https://port.ping.pe/" target="_blank" rel="noreferrer">https://port.ping.pe/</a> 提供的端口检查工具进行检测。</li><li>如果上面步骤检测正常,Agent 依然没有正常上线,请尝试关闭 SELinux,<a href="https://www.google.com/search?q=%E5%85%B3%E9%97%ADSELINUX" target="_blank" rel="noreferrer">如何关闭 SELinux?</a></li></ol>',2),i=[r];function c(s,_,d,l,p,g){return t(),a("div",null,i)}const u=e(n,[["render",c]]);export{f as __pageData,u as default}; import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Agent 启动/上线 问题自检流程","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q2.md","filePath":"guide/q2.md","lastUpdated":1715701589000}'),n={name:"guide/q2.md"},r=o('<h1 id="agent-启动-上线-问题自检流程" tabindex="-1">Agent 启动/上线 问题自检流程 <a class="header-anchor" href="#agent-启动-上线-问题自检流程" aria-label="Permalink to &quot;Agent 启动/上线 问题自检流程&quot;">​</a></h1><ol><li>直接执行 <code>/opt/nezha/agent/nezha-agent -s 面板IP或非CDN域名:面板RPC端口 -p Agent密钥 -d</code> 查看日志是否是因为 DNS、网络不佳导致超时(timeout)</li><li><code>nc -v 域名/IP 面板RPC端口</code> 或者 <code>telnet 域名/IP 面板RPC端口</code> 来检验是否是网络问题,检查本机与面板服务器的出入站防火墙,如果无法判断问题可借助 <a href="https://port.ping.pe/" target="_blank" rel="noreferrer">https://port.ping.pe/</a> 提供的端口检查工具进行检测。</li><li>如果上面步骤检测正常,Agent 依然没有正常上线,请尝试关闭 SELinux,<a href="https://www.google.com/search?q=%E5%85%B3%E9%97%ADSELINUX" target="_blank" rel="noreferrer">如何关闭 SELinux?</a></li></ol>',2),i=[r];function c(s,_,d,l,p,g){return t(),a("div",null,i)}const u=e(n,[["render",c]]);export{f as __pageData,u as default};
@@ -1 +1 @@
import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Agent 启动/上线 问题自检流程","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q2.md","filePath":"guide/q2.md","lastUpdated":1715651890000}'),n={name:"guide/q2.md"},r=o("",2),i=[r];function c(s,_,d,l,p,g){return t(),a("div",null,i)}const u=e(n,[["render",c]]);export{f as __pageData,u as default}; import{_ as e,o as t,c as a,R as o}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Agent 启动/上线 问题自检流程","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q2.md","filePath":"guide/q2.md","lastUpdated":1715701589000}'),n={name:"guide/q2.md"},r=o("",2),i=[r];function c(s,_,d,l,p,g){return t(),a("div",null,i)}const u=e(n,[["render",c]]);export{f as __pageData,u as default};
@@ -1,4 +1,4 @@
import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"反向代理 gRPC 端口(支持 Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q3.md","filePath":"guide/q3.md","lastUpdated":1715651890000}'),p={name:"guide/q3.md"},o=l(`<h1 id="反向代理-grpc-端口-支持-cloudflare-cdn" tabindex="-1">反向代理 gRPC 端口(支持 Cloudflare CDN) <a class="header-anchor" href="#反向代理-grpc-端口-支持-cloudflare-cdn" aria-label="Permalink to &quot;反向代理 gRPC 端口(支持 Cloudflare CDN)&quot;">​</a></h1><p>使用 Nginx 或者 Caddy 反向代理 gRPC</p><ul><li>Nginx 配置</li></ul><div class="language-nginx"><button title="Copy Code" class="copy"></button><span class="lang">nginx</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#C792EA;">server</span><span style="color:#A6ACCD;"> {</span></span> import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const i=JSON.parse('{"title":"反向代理 gRPC 端口(支持 Cloudflare CDN)","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q3.md","filePath":"guide/q3.md","lastUpdated":1715701589000}'),p={name:"guide/q3.md"},o=l(`<h1 id="反向代理-grpc-端口-支持-cloudflare-cdn" tabindex="-1">反向代理 gRPC 端口(支持 Cloudflare CDN) <a class="header-anchor" href="#反向代理-grpc-端口-支持-cloudflare-cdn" aria-label="Permalink to &quot;反向代理 gRPC 端口(支持 Cloudflare CDN)&quot;">​</a></h1><p>使用 Nginx 或者 Caddy 反向代理 gRPC</p><ul><li>Nginx 配置</li></ul><div class="language-nginx"><button title="Copy Code" class="copy"></button><span class="lang">nginx</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#C792EA;">server</span><span style="color:#A6ACCD;"> {</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> listen </span><span style="color:#A6ACCD;">443 ssl http2</span><span style="color:#89DDFF;">;</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> listen </span><span style="color:#A6ACCD;">443 ssl http2</span><span style="color:#89DDFF;">;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> listen </span><span style="color:#A6ACCD;">[::]:443 ssl http2</span><span style="color:#89DDFF;">;</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> listen </span><span style="color:#A6ACCD;">[::]:443 ssl http2</span><span style="color:#89DDFF;">;</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> server_name </span><span style="color:#A6ACCD;">data.example.com</span><span style="color:#89DDFF;">;</span><span style="color:#A6ACCD;"> </span><span style="color:#676E95;font-style:italic;"># 你的 Agent 连接 Dashboard 的域名</span></span> <span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;"> server_name </span><span style="color:#A6ACCD;">data.example.com</span><span style="color:#89DDFF;">;</span><span style="color:#A6ACCD;"> </span><span style="color:#676E95;font-style:italic;"># 你的 Agent 连接 Dashboard 的域名</span></span>
Loaded 100 of 179 files, more files were not shown because too many files have changed in this diff. Show more