diff --git a/assets/en_US_guide_api.md.d519a59e.js b/assets/en_US_guide_api.md.28a2e5f3.js similarity index 72% rename from assets/en_US_guide_api.md.d519a59e.js rename to assets/en_US_guide_api.md.28a2e5f3.js index fd389c91..c8559428 100644 --- a/assets/en_US_guide_api.md.d519a59e.js +++ b/assets/en_US_guide_api.md.28a2e5f3.js @@ -1,4 +1,4 @@ -import{_ as t,c as o,o as e,d as u}from"./app.9c3473cb.js";const v='{"title":"Create Token","description":"","frontmatter":{},"headers":[{"level":2,"title":"Create Token","slug":"create-token"},{"level":2,"title":"Authentication method","slug":"authentication-method"},{"level":2,"title":"How to use","slug":"how-to-use"}],"relativePath":"en_US/guide/api.md"}',n={},q=u(`

Nezha Monitoring now supports querying the status information of the Agent in the Dashboard using the API

Create Token

API allows Token authentication method and Cookies authentication method
To create a new Token, after entering the admin panel, click on the avatar in the upper right corner and select "API Token" to enter the Token management page
Click "Add Token" and after customizing the notes, click "Add"
To delete a Token, please select the corresponding Token and click the delete icon on the right

WARNING

Token is the authentication tool of API, it is very important for your Dashboard's information security, please don't leak your Token to others

Authentication method

Token authentication method:

Request Headers:  
+import{_ as t,c as o,o as e,d as u}from"./app.9c3473cb.js";const m='{"title":"Create Token","description":"","frontmatter":{},"headers":[{"level":2,"title":"Create Token","slug":"create-token"},{"level":2,"title":"Authentication method","slug":"authentication-method"},{"level":2,"title":"How to use","slug":"how-to-use"},{"level":2,"title":"Case - Build your own Telegram bot to query server information","slug":"case-build-your-own-telegram-bot-to-query-server-information"}],"relativePath":"en_US/guide/api.md"}',n={},q=u(`
Nezha Monitoring now supports querying the status information of the Agent in the Dashboard using the API
Create Token 
API allows Token authentication method and Cookies authentication method
 To create a new Token, after entering the admin panel, click on the avatar in the upper right corner and select "API Token" to enter the Token management page
 Click "Add Token" and after customizing the notes, click "Add"
 To delete a Token, please select the corresponding Token and click the delete icon on the right
WARNING
Token is the authentication tool of API, it is very important for your Dashboard's information security, please don't leak your Token to others
Authentication method 
Token authentication method:
Request Headers:  
 Authorization: Token
 
How to use 
WARNING
The negative timestamp in the example below is (0000-00-00)
 It is currently used to indicate that the Agent has never reported since the Dashboard went live
 However, it is not recommended to use positivity or negativity to determine the status
TIP
The request method is Get and the return format is JSON.
  • Get a list of servers: GET /api/v1/server/list?tag=
     query: tag (ServerTag means the group of servers, if this value is provided, only the servers in this group are queried)
JSON Return Example:
{
     "code": 0,
@@ -110,4 +110,4 @@ Authorization: Token
         }
     ]
 }
-
`,16),a=[q];function i(r,s,d,l,c,p){return e(),o("div",null,a)}var m=t(n,[["render",i]]);export{v as __pageData,m as default};
+

Case - Build your own Telegram bot to query server information

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

`,18),a=[q];function r(i,s,d,l,c,h){return e(),o("div",null,a)}var v=t(n,[["render",r]]);export{m as __pageData,v as default}; diff --git a/assets/en_US_guide_api.md.28a2e5f3.lean.js b/assets/en_US_guide_api.md.28a2e5f3.lean.js new file mode 100644 index 00000000..c4b16b47 --- /dev/null +++ b/assets/en_US_guide_api.md.28a2e5f3.lean.js @@ -0,0 +1 @@ +import{_ as t,c as o,o as e,d as u}from"./app.9c3473cb.js";const m='{"title":"Create Token","description":"","frontmatter":{},"headers":[{"level":2,"title":"Create Token","slug":"create-token"},{"level":2,"title":"Authentication method","slug":"authentication-method"},{"level":2,"title":"How to use","slug":"how-to-use"},{"level":2,"title":"Case - Build your own Telegram bot to query server information","slug":"case-build-your-own-telegram-bot-to-query-server-information"}],"relativePath":"en_US/guide/api.md"}',n={},q=u("",18),a=[q];function r(i,s,d,l,c,h){return e(),o("div",null,a)}var v=t(n,[["render",r]]);export{m as __pageData,v as default}; diff --git a/assets/en_US_guide_api.md.d519a59e.lean.js b/assets/en_US_guide_api.md.d519a59e.lean.js deleted file mode 100644 index ad635ea9..00000000 --- a/assets/en_US_guide_api.md.d519a59e.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as t,c as o,o as e,d as u}from"./app.9c3473cb.js";const v='{"title":"Create Token","description":"","frontmatter":{},"headers":[{"level":2,"title":"Create Token","slug":"create-token"},{"level":2,"title":"Authentication method","slug":"authentication-method"},{"level":2,"title":"How to use","slug":"how-to-use"}],"relativePath":"en_US/guide/api.md"}',n={},q=u("",16),a=[q];function i(r,s,d,l,c,p){return e(),o("div",null,a)}var m=t(n,[["render",i]]);export{v as __pageData,m as default}; diff --git a/assets/guide_api.md.52e8f873.lean.js b/assets/guide_api.md.52e8f873.lean.js deleted file mode 100644 index e6218660..00000000 --- a/assets/guide_api.md.52e8f873.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as t,c as o,o as u,d as q}from"./app.9c3473cb.js";const T='{"title":"\u521B\u5EFAToken","description":"","frontmatter":{},"headers":[{"level":2,"title":"\u521B\u5EFAToken","slug":"\u521B\u5EFAtoken"},{"level":2,"title":"\u8BA4\u8BC1\u65B9\u5F0F","slug":"\u8BA4\u8BC1\u65B9\u5F0F"},{"level":2,"title":"\u4F7F\u7528\u8BF4\u660E","slug":"\u4F7F\u7528\u8BF4\u660E"}],"relativePath":"guide/api.md"}',n={},e=q("",16),a=[e];function s(r,i,d,l,c,p){return u(),o("div",null,a)}var g=t(n,[["render",s]]);export{T as __pageData,g as default}; diff --git a/assets/guide_api.md.52e8f873.js b/assets/guide_api.md.eadbd62a.js similarity index 67% rename from assets/guide_api.md.52e8f873.js rename to assets/guide_api.md.eadbd62a.js index faeef06d..2dc0384e 100644 --- a/assets/guide_api.md.52e8f873.js +++ b/assets/guide_api.md.eadbd62a.js @@ -1,4 +1,4 @@ -import{_ as t,c as o,o as u,d as q}from"./app.9c3473cb.js";const T='{"title":"\u521B\u5EFAToken","description":"","frontmatter":{},"headers":[{"level":2,"title":"\u521B\u5EFAToken","slug":"\u521B\u5EFAtoken"},{"level":2,"title":"\u8BA4\u8BC1\u65B9\u5F0F","slug":"\u8BA4\u8BC1\u65B9\u5F0F"},{"level":2,"title":"\u4F7F\u7528\u8BF4\u660E","slug":"\u4F7F\u7528\u8BF4\u660E"}],"relativePath":"guide/api.md"}',n={},e=q(`

\u54EA\u5412\u9762\u677F\u73B0\u5728\u5DF2\u7ECF\u652F\u6301\u4F7F\u7528API\u63A5\u53E3\u67E5\u8BE2\u9762\u677F\u4E2DAgent\u7684\u72B6\u6001\u4FE1\u606F

\u521B\u5EFAToken

\u54EA\u5412\u9762\u677F\u7684API\u63A5\u53E3\u5141\u8BB8\u4F7F\u7528Token\u8BA4\u8BC1\u4E0ECookies\u8BA4\u8BC1
\u8981\u65B0\u5EFA\u4E00\u4E2AToken\uFF0C\u5728\u8FDB\u5165\u7BA1\u7406\u9762\u677F\u540E\uFF0C\u70B9\u51FB\u53F3\u4E0A\u89D2\u7684\u5934\u50CF\uFF0C\u9009\u62E9 \u201CAPI Token\u201D\uFF0C\u8FDB\u5165Token\u7BA1\u7406\u9875\u9762
\u70B9\u51FB \u201C\u6DFB\u52A0Token\u201D\uFF0C\u81EA\u5B9A\u4E49\u5907\u6CE8\u540E\uFF0C\u70B9\u51FB \u201C\u6DFB\u52A0\u201D
\u5982\u9700\u5220\u9664\u4E00\u4E2AToken\uFF0C\u8BF7\u9009\u62E9\u76F8\u5E94\u7684Token\uFF0C\u70B9\u51FB\u53F3\u4FA7\u7684\u5220\u9664\u56FE\u6807

WARNING

Token\u662FAPI\u63A5\u53E3\u7684\u9274\u6743\u5DE5\u5177\uFF0C\u5B83\u5BF9\u4F60\u7684\u9762\u677F\u7684\u4FE1\u606F\u5B89\u5168\u975E\u5E38\u91CD\u8981\uFF0C\u8BF7\u4E0D\u8981\u6CC4\u6F0F\u4F60\u7684Token\u7ED9\u4ED6\u4EBA

\u8BA4\u8BC1\u65B9\u5F0F

Token\u8BA4\u8BC1\u65B9\u5F0F\uFF1A

Request Headers:  
+import{_ as t,c as o,o as u,d as q}from"./app.9c3473cb.js";const T='{"title":"\u521B\u5EFAToken","description":"","frontmatter":{},"headers":[{"level":2,"title":"\u521B\u5EFAToken","slug":"\u521B\u5EFAtoken"},{"level":2,"title":"\u8BA4\u8BC1\u65B9\u5F0F","slug":"\u8BA4\u8BC1\u65B9\u5F0F"},{"level":2,"title":"\u4F7F\u7528\u8BF4\u660E","slug":"\u4F7F\u7528\u8BF4\u660E"},{"level":2,"title":"\u4F7F\u7528\u6848\u4F8B - \u81EA\u5EFA\u4E00\u4E2ATG\u673A\u5668\u4EBA\u6765\u67E5\u8BE2\u670D\u52A1\u5668\u4FE1\u606F","slug":"\u4F7F\u7528\u6848\u4F8B-\u81EA\u5EFA\u4E00\u4E2Atg\u673A\u5668\u4EBA\u6765\u67E5\u8BE2\u670D\u52A1\u5668\u4FE1\u606F"}],"relativePath":"guide/api.md"}',n={},e=q(`
\u54EA\u5412\u9762\u677F\u73B0\u5728\u5DF2\u7ECF\u652F\u6301\u4F7F\u7528API\u63A5\u53E3\u67E5\u8BE2\u9762\u677F\u4E2DAgent\u7684\u72B6\u6001\u4FE1\u606F
\u521B\u5EFAToken 
\u54EA\u5412\u9762\u677F\u7684API\u63A5\u53E3\u5141\u8BB8\u4F7F\u7528Token\u8BA4\u8BC1\u4E0ECookies\u8BA4\u8BC1
 \u8981\u65B0\u5EFA\u4E00\u4E2AToken\uFF0C\u5728\u8FDB\u5165\u7BA1\u7406\u9762\u677F\u540E\uFF0C\u70B9\u51FB\u53F3\u4E0A\u89D2\u7684\u5934\u50CF\uFF0C\u9009\u62E9 \u201CAPI Token\u201D\uFF0C\u8FDB\u5165Token\u7BA1\u7406\u9875\u9762
 \u70B9\u51FB \u201C\u6DFB\u52A0Token\u201D\uFF0C\u81EA\u5B9A\u4E49\u5907\u6CE8\u540E\uFF0C\u70B9\u51FB \u201C\u6DFB\u52A0\u201D
 \u5982\u9700\u5220\u9664\u4E00\u4E2AToken\uFF0C\u8BF7\u9009\u62E9\u76F8\u5E94\u7684Token\uFF0C\u70B9\u51FB\u53F3\u4FA7\u7684\u5220\u9664\u56FE\u6807
WARNING
Token\u662FAPI\u63A5\u53E3\u7684\u9274\u6743\u5DE5\u5177\uFF0C\u5B83\u5BF9\u4F60\u7684\u9762\u677F\u7684\u4FE1\u606F\u5B89\u5168\u975E\u5E38\u91CD\u8981\uFF0C\u8BF7\u4E0D\u8981\u6CC4\u6F0F\u4F60\u7684Token\u7ED9\u4ED6\u4EBA
\u8BA4\u8BC1\u65B9\u5F0F 
Token\u8BA4\u8BC1\u65B9\u5F0F\uFF1A
Request Headers:  
 Authorization: Token
 
\u4F7F\u7528\u8BF4\u660E 
WARNING
\u4E0B\u9762\u793A\u4F8B\u4E2D\u7684\u8D1F\u6570\u65F6\u95F4\u6233\u4E3A\uFF080000-00-00\uFF09
 \u76EE\u524D\u8868\u793ADashboard\u4E0A\u7EBF\u540E\u8BE5Agent\u4ECE\u672A\u6C47\u62A5\u8FC7
 \u4F46\u4E0D\u5EFA\u8BAE\u7528\u6B63\u8D1F\u6027\u5224\u65AD\u72B6\u6001
TIP
\u8BF7\u6C42\u65B9\u5F0F\u4E3A Get\uFF0C\u8FD4\u56DE\u683C\u5F0F\u4E3A JSON
  • \u83B7\u53D6\u670D\u52A1\u5668\u5217\u8868\uFF1AGET /api/v1/server/list?tag=
     query: tag (ServerTag\u662F\u670D\u52A1\u5668\u7684\u5206\u7EC4\uFF0C\u63D0\u4F9B\u6B64\u53C2\u6570\u5219\u4EC5\u67E5\u8BE2\u8BE5\u5206\u7EC4\u4E2D\u7684\u670D\u52A1\u5668)
JSON\u8FD4\u56DE\u793A\u4F8B\uFF1A
{
     "code": 0,
@@ -110,4 +110,4 @@ Authorization: Token
         }
     ]
 }
-
`,16),a=[e];function s(r,i,d,l,c,p){return u(),o("div",null,a)}var g=t(n,[["render",s]]);export{T as __pageData,g as default};
+

\u4F7F\u7528\u6848\u4F8B - \u81EA\u5EFA\u4E00\u4E2ATG\u673A\u5668\u4EBA\u6765\u67E5\u8BE2\u670D\u52A1\u5668\u4FE1\u606F

\u53C2\u8003\u793E\u533A\u9879\u76EE
\u673A\u5668\u4EBA\u53EF\u4EE5\u901A\u8FC7API\u5411\u9762\u677F\u8BF7\u6C42\u670D\u52A1\u5668\u72B6\u6001\u4FE1\u606F\uFF0C\u5F97\u5230\u4FE1\u606F\u540E\u53D1\u9001\u7ED9\u7528\u6237
\u4F60\u53EF\u4EE5\u642D\u5EFA\u6B64\u673A\u5668\u4EBA\u6765\u65B9\u4FBF\u5730\u67E5\u770B\u6307\u5B9A\u670D\u52A1\u5668\u7684\u5F53\u524D\u72B6\u6001\u4E14\u4E0D\u9700\u8981\u6253\u5F00\u9762\u677F

`,18),a=[e];function r(i,s,d,l,c,p){return u(),o("div",null,a)}var g=t(n,[["render",r]]);export{T as __pageData,g as default}; diff --git a/assets/guide_api.md.eadbd62a.lean.js b/assets/guide_api.md.eadbd62a.lean.js new file mode 100644 index 00000000..f2354c67 --- /dev/null +++ b/assets/guide_api.md.eadbd62a.lean.js @@ -0,0 +1 @@ +import{_ as t,c as o,o as u,d as q}from"./app.9c3473cb.js";const T='{"title":"\u521B\u5EFAToken","description":"","frontmatter":{},"headers":[{"level":2,"title":"\u521B\u5EFAToken","slug":"\u521B\u5EFAtoken"},{"level":2,"title":"\u8BA4\u8BC1\u65B9\u5F0F","slug":"\u8BA4\u8BC1\u65B9\u5F0F"},{"level":2,"title":"\u4F7F\u7528\u8BF4\u660E","slug":"\u4F7F\u7528\u8BF4\u660E"},{"level":2,"title":"\u4F7F\u7528\u6848\u4F8B - \u81EA\u5EFA\u4E00\u4E2ATG\u673A\u5668\u4EBA\u6765\u67E5\u8BE2\u670D\u52A1\u5668\u4FE1\u606F","slug":"\u4F7F\u7528\u6848\u4F8B-\u81EA\u5EFA\u4E00\u4E2Atg\u673A\u5668\u4EBA\u6765\u67E5\u8BE2\u670D\u52A1\u5668\u4FE1\u606F"}],"relativePath":"guide/api.md"}',n={},e=q("",18),a=[e];function r(i,s,d,l,c,p){return u(),o("div",null,a)}var g=t(n,[["render",r]]);export{T as __pageData,g as default}; diff --git a/developer/index.html b/developer/index.html index 2b468d2d..8fcc821f 100644 --- a/developer/index.html +++ b/developer/index.html @@ -14,7 +14,7 @@
哪吒监控

开发手册

欢迎使用哪吒监控开发手册，我们欢迎你提出高质量的Pull Request，帮助哪吒监控变得更好！

开始使用 →

Copyright © 2022-present Nezhahq

- + diff --git a/developer/l10n.html b/developer/l10n.html index ff55c6ad..94df2545 100644 --- a/developer/l10n.html +++ b/developer/l10n.html @@ -14,7 +14,7 @@
哪吒监控

哪吒监控的Dashboard已经添加本地化，支持多个语言，你可以在开发新功能时遵循以下步骤来支持本地化

WARNING

哪吒监控使用 Crowdin 平台翻译文本，请不要直接修改除 zh-CN.toml 以外的toml文件

介绍

  1. 你可以直接使用 /resource/l10n/zh-CN.toml 中的配置来替换新功能中的文本
  2. 如果新功能中有新的文本，请将新文本拉取到 zh-CN.toml 中
  3. 在Pull Request被合并后，你可以前往 Crowdin 平台贡献新文本的翻译
- + diff --git a/developer/theme.html b/developer/theme.html index fb63fecf..92c52190 100644 --- a/developer/theme.html +++ b/developer/theme.html @@ -14,7 +14,7 @@
哪吒监控

哪吒主题开发环境

哪吒面板提供了主题开发环境，你可以使用它来创建新的哪吒监控主题

WARNING

请注意： 此开发环境仅支持 dashboard v0.13.16 及更新版本。

使用说明

  1. 克隆此仓库到本地
  2. 修改 data/config.yaml 中的 Oauth2 配置（回调连接可以填 http://localhost）
  3. 运行 docker-compose up
  4. 开始开发
  5. 主题制作完成之后可以将 theme-custom 放置到服务器上的 /opt/nezha/dashboard/theme-custom 位置

FAQ

  • 如果不能使用 80 端口，在 docker-compose.yaml 中修改配置。
- + diff --git a/en_US/developer/index.html b/en_US/developer/index.html index c17fdb1a..9fa70936 100644 --- a/en_US/developer/index.html +++ b/en_US/developer/index.html @@ -14,7 +14,7 @@
Nezha Monitoring

Development Manual

Welcome to the Nezha Monitoring Development Manual.

Start Now →

Copyright © 2022-present Nezhahq

- + diff --git a/en_US/developer/l10n.html b/en_US/developer/l10n.html index bcda2914..e46e3b39 100644 --- a/en_US/developer/l10n.html +++ b/en_US/developer/l10n.html @@ -14,7 +14,7 @@
Nezha Monitoring

Nezha Monitoring's Dashboard has added localization to support multiple languages, and you can follow these steps to support localization when developing new features

WARNING

Nezha uses the Crowdin platform to translate text, please do not directly modify the toml files other than zh-CN.toml.

Introduction

  1. You can replace the text in the new feature directly using the configuration in /resource/l10n/zh-CN.toml
  2. If there is new text in the new feature, pull the new text into zh-CN.toml

TIP

If you don't understand Chinese at all, you can translate the text using Google or DeepL Translate, and specify in the Pull Request, we will revise the Chinese translation after you add the English translation

  1. After the Pull Request has been merged, you can go to Crowdin Platform to contribute translations of the new text
- + diff --git a/en_US/developer/theme.html b/en_US/developer/theme.html index 352d0fd4..a0b7ebfe 100644 --- a/en_US/developer/theme.html +++ b/en_US/developer/theme.html @@ -14,7 +14,7 @@
Nezha Monitoring

Nezha Theme Development Environment

Nezha Monitoring provides a theme development environment that you can use to create new Nezha Monitoring themes

WARNING

Please note: This development environment only supports dashboard v0.13.16 and newer versions.

How to use

  1. Clone this repository to local
  2. Modify the Oauth2 configuration in data/config.yaml（The callback connection can be filled with http://localhost）
  3. Run docker-compose up
  4. Start development
  5. Once the theme has been created, you can place theme-custom in /opt/nezha/dashboard/theme-custom on the server

FAQ

  • If you can't use port 80, change the configuration in docker-compose.yaml.
- + diff --git a/en_US/guide/agent.html b/en_US/guide/agent.html index 9185f870..9bf4e763 100644 --- a/en_US/guide/agent.html +++ b/en_US/guide/agent.html @@ -63,7 +63,7 @@ start }

Customize Agent

Customize the NIC and hard drive partitions to be monitored

Other Flags

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

FAQ

Is there a Docker image for Agent?

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

- + diff --git a/en_US/guide/agentq.html b/en_US/guide/agentq.html index 0412c328..3ae119d7 100644 --- a/en_US/guide/agentq.html +++ b/en_US/guide/agentq.html @@ -14,7 +14,7 @@
Nezha Monitoring

Why the IP displayed in the admin panel and the actual IP of the Agent are not the same?

Please check Dashboard - Why the IP displayed in the admin panel and the actual IP of the Agent are not the same?

Error on one-click script installation

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

Please check if your server can connect to Github, try again, or check Other ways to install Agent

sudo: command not found

Please install sudo first

- + diff --git a/en_US/guide/api.html b/en_US/guide/api.html index 2a3ddc34..1d8d9e5f 100644 --- a/en_US/guide/api.html +++ b/en_US/guide/api.html @@ -7,13 +7,13 @@ - + -
Nezha Monitoring

Nezha Monitoring now supports querying the status information of the Agent in the Dashboard using the API

Create Token

API allows Token authentication method and Cookies authentication method
To create a new Token, after entering the admin panel, click on the avatar in the upper right corner and select "API Token" to enter the Token management page
Click "Add Token" and after customizing the notes, click "Add"
To delete a Token, please select the corresponding Token and click the delete icon on the right

WARNING

Token is the authentication tool of API, it is very important for your Dashboard's information security, please don't leak your Token to others

Authentication method

Token authentication method:

Request Headers:  
+    
 Nezha Monitoring
Nezha Monitoring now supports querying the status information of the Agent in the Dashboard using the API
Create Token 
API allows Token authentication method and Cookies authentication method
 To create a new Token, after entering the admin panel, click on the avatar in the upper right corner and select "API Token" to enter the Token management page
 Click "Add Token" and after customizing the notes, click "Add"
 To delete a Token, please select the corresponding Token and click the delete icon on the right
WARNING
Token is the authentication tool of API, it is very important for your Dashboard's information security, please don't leak your Token to others
Authentication method 
Token authentication method:
Request Headers:  
 Authorization: Token
 
How to use 
WARNING
The negative timestamp in the example below is (0000-00-00)
 It is currently used to indicate that the Agent has never reported since the Dashboard went live
 However, it is not recommended to use positivity or negativity to determine the status
TIP
The request method is Get and the return format is JSON.
  • Get a list of servers: GET /api/v1/server/list?tag=
     query: tag (ServerTag means the group of servers, if this value is provided, only the servers in this group are queried)
JSON Return Example:
{
     "code": 0,
@@ -125,8 +125,8 @@ Authorization: Token
         }
     ]
 }
-

-    
+

Case - Build your own Telegram bot to query server information

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

+ diff --git a/en_US/guide/dashboard.html b/en_US/guide/dashboard.html index c15f0ab1..4af8cc45 100644 --- a/en_US/guide/dashboard.html +++ b/en_US/guide/dashboard.html @@ -38,7 +38,7 @@ proxy /terminal/* http://ip:8008 { header_upstream -Origin }

Configuring SSL in the aaPanel

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

FAQ

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

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

WARNING

Again, please do not modify the database at will!

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

What are each table or column in the database?

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

Does Dashboard update automatically?

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

How do I update the Dashboard?

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

- + diff --git a/en_US/guide/dashboardq.html b/en_US/guide/dashboardq.html index ef42ea30..4c39be1a 100644 --- a/en_US/guide/dashboardq.html +++ b/en_US/guide/dashboardq.html @@ -20,7 +20,7 @@ systemctl restart docker systemctl status docker

Restart and try to reinstall the Dashboard.
If you still get iptables... etc. errors, then consider simply closing iptables or even removing it.
This issue may also be kernel related, try replacing the official kernel as well.

Dashboard reboot failed: Invalid hostPort: nz_site_port etc.

Usually this does not occur, if it does, you can modify the configuration through the installation script.

- + diff --git a/en_US/guide/loginq.html b/en_US/guide/loginq.html index c1114998..a5971b1c 100644 --- a/en_US/guide/loginq.html +++ b/en_US/guide/loginq.html @@ -14,7 +14,7 @@
Nezha Monitoring

Page refuses to connect or timeout after login callback

  1. Your server cannot connect to Github, consider trying several times or switching to Gitlab.
  2. You have configured the wrong callback URL, make sure your callback URL is correct and port and protocol are correct!
  3. An unknown error occurred in Dashboard, you can use the script to check the logs.

TIP

What is a protocol?
In the browser, your domain name ending with :// is the protocol, usually http and https. Since the Dashboard may be accessible by multiple protocols + domain + port combinations under normal deployment, please make sure to choose the most appropriate one as the callback.

How do I check if my callback URL is wrong?

Please make sure the protocol+domain+port displayed by your browser before login and the protocol+domain+port you jump to after login are the same.
Please make sure your path is /oauth2/callback, all lowercase.

Dashboard errors after login

Clear your browser cookies and log in again, or change your browser.

lookup xxx

DNS resolution failure, in most cases, is due to iptables-related configuration changes.
It is recommended to restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
If the lookup error still occurs, it is recommended to check whether there are other tools to control iptables, such as Aapanel Firewall.
This problem may also be related to the kernel, please try to change the official kernel.

The authorization method is invalid, or the login callback URL is invalid, expired, or has been revoked

Suggest changing the authentication method to Github/Gitlab.

oauth2: server response missing access_token

It may be caused by a number of factors, the most likely is a network problem, we suggest to check the network and retry.
If you can't solve it, we suggest changing the authentication method to Github/Gitlab.

This user is not the administrator or cannot login

You have logged into the wrong account or configured the wrong username, note that username is not email, you can use a script to modify it.

dial tcp xxx:443 i/o timeout

If the server has network problems, you can restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
You can also change to another OAuth method if necessary.

net/http: TLS handshake timeout

Same as above.

- + diff --git a/en_US/guide/notifications.html b/en_US/guide/notifications.html index d6cb3fd2..a92d491e 100644 --- a/en_US/guide/notifications.html +++ b/en_US/guide/notifications.html @@ -14,7 +14,7 @@
Nezha Monitoring

Nezha Monitoring supports monitoring of server load, CPU, memory, hard disk, data transfer, monthly data transfer, number of processes, number of connections, and sends alarm notifications when one of these items reaches a user-set limit.


Flexible notification methods

#NEZHA# is the panel message placeholder, the panel will automatically replace the placeholder with the actual message when it triggers the notification

The content of Body is in JSON format：When the request type is FORM，the value is in the form of key:value，value can contain placeholders that will be automatically replaced when notified. When the request type is JSON It will only do string substitution and submit to the URL directly.

Placeholders can also be placed inside the URL, and it will perform a simple string substitution when requested.

Refer to the example below, it is very flexible.

  • Telegram Example, contributed by @haitau

    • Name：Telegram Robot message notification
    • URL：https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&text=#NEZHA#
    • Request method: GET
    • Request type: default
    • Body: null
    • URL Parameter acquisition instructions：The XXXXXX in botXXXXXX is the token provided when you follow the official @Botfather in Telegram and enter /newbot to create a new bot. (In the line after Use this token to access the HTTP API). The 'bot' are essential. After creating a bot, you need to talk to the BOT in Telegram (send a random message) before you can send a message by using API. YYYYYY is Telegram user's ID, you can get it by talking to the bot @userinfobot.


Description of notification rules

Basic Rules

  • Type: one or more types can be selected, such as in a rule to select more than one type, you need to meet all the selected types at the same time to trigger the notification (see the example later)
    • cpu、memory、swap、disk
    • net_in_speed Inbound speed, net_out_speed Outbound speed, net_all_speed Inbound + Outbound speed, transfer_in Inbound Transfer, transfer_out Outbound Transfer, transfer_all Total Transfer
    • offline Offline monitoring
    • load1、load5、load15 Load
    • process_count Number of processes Currently, counting the number of processes takes up too many resources and is not supported at the moment
    • tcp_conn_count、udp_conn_count Number of connections
  • duration：Lasting for a few seconds, the notification will only be triggered when the sampling record reaches 30% or more within a few seconds
  • min/max
    • Transfer, network speed, and other values of the same type. Unit is byte (1KB=1024B，1MB = 1024*1024B)
    • Memory, hard disk, CPU. units are usage percentages
    • No setup required for offline monitoring
  • cover [{"type":"offline","duration":10, "cover":0, "ignore":{"5": true}}]
    • 0 Cover all, use ignore to ignore specific servers
    • 1 Ignore all, use ignore to monitoring specific servers
      For example: [{"type":"offline","duration":10, "cover":0, "ignore":{"5": true}}]
  • ignore: Select to ignore specific servers, use with cover with server id and boolean, e.g.: {"1": true, "2":false}

Complete examples:

TIP

Add an offline notification

  • Name: Offline notification
  • Rules: [{"Type":"offline","Duration":10}]
  • Enable: √

TIP

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

  • Name CPU and RAM
  • Rules: [{"Type":"cpu","Min":0,"Max":50,"Duration":10},{"Type":"memory","Min":20,"Max":0,"Duration":20}]
  • Enable: √

Special: Any-cycle transfer notification

Can be used as monthly transfer notificatin

  • type

    • transfer_in_cycle Inbound transfer during the cycle
    • transfer_out_cycle Outbound transfer during the cycle
    • transfer_all_cycle The sum of inbound and outbound transfer during the cycle

  • cycle_start Start date of the statistical cycle (can be the start date of your server's billing cycle), the time format is RFC3339, for example, the format in Beijing time zone is 2022-01-11T08:00:00.00+08:00

  • cycle_interval Interval time cycle (For example, if the cycle is in days and the value is 7, it means that the statistics are counted every 7 days)

  • cycle_unit Statistics cycle unit, default hour, optional (hour, day, week, month, year)

  • min/max, cover, ignore Please refer to the basic rules to configure

Example: The servers with ID 3 and 4 (defined in the ignore) are counted on the 1st of each month, and a notification is triggered when the monthly outbound transfer reaches 1TB during the cycle. [{"type":"transfer_out_cycle","max":1099511627776,"cycle_start":"2022-01-01T00:00:00+08:00","cycle_interval":1,"cycle_unit":"month","cover":1,"ignore":{"3":true,"4":true}}]

- + diff --git a/en_US/guide/q2.html b/en_US/guide/q2.html index 7ef021be..6439b96f 100644 --- a/en_US/guide/q2.html +++ b/en_US/guide/q2.html @@ -14,7 +14,7 @@
Nezha Monitoring

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

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

Dashboard Configuration

Agent Configuration

Enable Cloudflare CDN (optional)

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

- + diff --git a/en_US/guide/q4.html b/en_US/guide/q4.html index c5fdb84d..5112aa0b 100644 --- a/en_US/guide/q4.html +++ b/en_US/guide/q4.html @@ -14,7 +14,7 @@
Nezha Monitoring

Real-time channel disconnection/online terminal connection failure

  • If you are using a CDN, please make sure that the CDN provider provides WebSocket service and that WebSocket is enabled
  • Confirm that you are using a reverse proxy requires special configuration of the WebSocket for the /ws and /terminal paths, you can click here to see the reverse proxy configuration
- + diff --git a/en_US/guide/q5.html b/en_US/guide/q5.html index 4aa422d5..90040112 100644 --- a/en_US/guide/q5.html +++ b/en_US/guide/q5.html @@ -14,7 +14,7 @@
Nezha Monitoring

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

  1. First use the one-click script and select Stop Panel
  2. Compress the /opt/nezha folder to the same path as the new server
  3. Run the one-click script in the new server, select Launch Panel
- + diff --git a/en_US/guide/q6.html b/en_US/guide/q6.html index a6fe5741..43808ae9 100644 --- a/en_US/guide/q6.html +++ b/en_US/guide/q6.html @@ -14,7 +14,7 @@
Nezha Monitoring

How to set up a monthly reset of transfer statistics?

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

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

TIP

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

- + diff --git a/en_US/guide/servers.html b/en_US/guide/servers.html index bc46b2cd..ee9fbfd0 100644 --- a/en_US/guide/servers.html +++ b/en_US/guide/servers.html @@ -14,7 +14,7 @@
Nezha Monitoring

Servers

Introduction

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

Add a server

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

Install Agent

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

Forced Updates

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

Data List

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

Webshell

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

- + diff --git a/en_US/guide/services.html b/en_US/guide/services.html index 2fc78306..c4cda3ac 100644 --- a/en_US/guide/services.html +++ b/en_US/guide/services.html @@ -14,7 +14,7 @@
Nezha Monitoring

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

How to use

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

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

  • Name - Customize a name

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

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

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

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

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

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

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

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

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

Management Monitor

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

- + diff --git a/en_US/guide/settings.html b/en_US/guide/settings.html index 3edf5c88..00f499c3 100644 --- a/en_US/guide/settings.html +++ b/en_US/guide/settings.html @@ -61,7 +61,7 @@ avatar.style} </style>

Access Password

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

CDN Bypassed Domain/IP

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

IP Change Alert

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

Coverage

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

Specific Servers

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

Send Notification To Specific Notification Group

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

WARNING

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


WARNING

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

- + diff --git a/en_US/guide/tasks.html b/en_US/guide/tasks.html index 55fbc145..94ead412 100644 --- a/en_US/guide/tasks.html +++ b/en_US/guide/tasks.html @@ -14,7 +14,7 @@
Nezha Monitoring

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

Nezha monitoring supports pushing commands to the Agent for execution, so this feature is very flexible and can be used to periodically back up the server in conjunction with restic, rclone, or periodically restart a service to reset the network connection.

How to use

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

  • Name - Customize a task name

  • Cron Expression - Set schedule time, the Cron Expression is like:： * * * * * * sec min hour day month week, see details in CRON Expression Format
    For example: 0 0 3 * * * is Every day at 3 o'clock

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

  • Coverage and Specific Servers - Similar to the settings on the Services page, select rules to determine which Agents need to execute scheduled tasks

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

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

Manage tasks

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

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

FAQ

  1. Command not found
    Command not found may cause by missing PATH environment variable, for Linux Server, you may try adding source ~/.bashrc at beginning of your command or execute by absolute path.
- + diff --git a/en_US/index.html b/en_US/index.html index 99c4b495..e1857b79 100644 --- a/en_US/index.html +++ b/en_US/index.html @@ -14,7 +14,7 @@
Nezha Monitoring

Nezha Monitoring

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

Learn More →

One-Click Installation

Support use one-click script to install Dashboard and Agent services; Linux, WIndows, MacOS, OpenWRT and other mainstream systems are supported

Monitoring at any time

Support monitoring the system status of multiple servers at the same time, support monitoring the status of web pages, ports, SSL certificates; support notifications in case of failure, out of data and other status. Support multiple notification methods (Telegram, email, WeChat, etc.)

Lightweight O&M tool

Support WebSSH, support cyclic monitoring data, support setting scheduled tasks and running command on multiple servers

Copyright © 2022-present Nezhahq

- + diff --git a/guide/agent.html b/guide/agent.html index 04f47658..b6132c95 100644 --- a/guide/agent.html +++ b/guide/agent.html @@ -64,7 +64,7 @@ start }

自定义Agent监控项目

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

其他运行参数

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

FAQ

Agent 有 Docker 镜像吗？

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

- + diff --git a/guide/agentq.html b/guide/agentq.html index fa3ba86f..fc886523 100644 --- a/guide/agentq.html +++ b/guide/agentq.html @@ -14,7 +14,7 @@
哪吒监控

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

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

一键脚本安装时出错

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

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

sudo: command not found

请先手动安装sudo。

- + diff --git a/guide/api.html b/guide/api.html index acb800a8..4407b060 100644 --- a/guide/api.html +++ b/guide/api.html @@ -7,13 +7,13 @@ - + -
哪吒监控

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

创建Token

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

WARNING

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

认证方式

Token认证方式：

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

-    
+

使用案例 - 自建一个TG机器人来查询服务器信息

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

+ diff --git a/guide/dashboard.html b/guide/dashboard.html index 4b8a2a98..f5cfd628 100644 --- a/guide/dashboard.html +++ b/guide/dashboard.html @@ -39,7 +39,7 @@ proxy /terminal/* http://ip:8008 { header_upstream -Origin }

在宝塔面板中配置SSL

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

FAQ

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

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

WARNING

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

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

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

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

Dashboard 会自动更新吗？

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

如何更新 Dashboard？

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

- + diff --git a/guide/dashboardq.html b/guide/dashboardq.html index e7f8f8ec..a5e02558 100644 --- a/guide/dashboardq.html +++ b/guide/dashboardq.html @@ -20,7 +20,7 @@ systemctl restart docker systemctl status docker

重启后尝试重新安装面板。
若依然出现iptables...等错误，则考虑直接关闭iptables甚至移除iptables。
这个问题也可能与内核有关，也可以尝试更换官方内核。

面板重启失败：Invalid hostPort: nz_site_port 等

通常不会出现这个情况，如出现可以通过安装脚本修改配置。

- + diff --git a/guide/loginq.html b/guide/loginq.html index d6e22f43..ad732255 100644 --- a/guide/loginq.html +++ b/guide/loginq.html @@ -14,7 +14,7 @@
哪吒监控

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

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

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

TIP

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

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

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

登录后面板报错

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

lookup xxx

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

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

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

oauth2: server response missing access_token

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

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

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

dial tcp xxx:443 i/o timeout

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

net/http: TLS handshake timeout

同上。

- + diff --git a/guide/notifications.html b/guide/notifications.html index 0caa84ea..ccb1e583 100644 --- a/guide/notifications.html +++ b/guide/notifications.html @@ -14,7 +14,7 @@
哪吒监控

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

灵活的通知方式

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

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

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

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

  • server酱示例

  • wxpusher 示例，需要关注你的应用

  • Telegram 示例 @haitau 贡献

    • 名称：telegram 机器人消息通知
    • URL：https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&text=#NEZHA#
    • 请求方式: GET
    • 请求类型: 默认
    • Body: 空
    • URL 参数获取说明：botXXXXXX 中的 XXXXXX 是在 telegram 中关注官方 @Botfather ，输入/newbot ，创建新的机器人（bot）时，会提供的 token（在提示 Use this token to access the HTTP API:后面一行）这里 'bot' 三个字母不可少。创建 bot 后，需要先在 telegram 中与 BOT 进行对话（随便发个消息），然后才可用 API 发送消息。YYYYYY 是 telegram 用户的数字 ID。与机器人@userinfobot 对话可获得。


报警规则说明

基本规则

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

完整示例:

TIP

添加一个离线报警

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

TIP

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

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

特殊：任意周期流量报警

可以用作月流量报警

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

示例: ID 为 3 和 4 的服务器（ignore 里面定义），以每月 1 号为统计周期，周期内统计的出站月流量达到 1TB 时报警 [{"type":"transfer_out_cycle","max":1099511627776,"cycle_start":"2022-01-01T00:00:00+08:00","cycle_interval":1,"cycle_unit":"month","cover":1,"ignore":{"3":true,"4":true}}]

- + diff --git a/guide/q1.html b/guide/q1.html index 9051cca1..8d346ecc 100644 --- a/guide/q1.html +++ b/guide/q1.html @@ -60,7 +60,7 @@ ufw allow proto tcp from serverIp to any port 443443 -j DROP iptables -I INPUT -s serverIp -p tcp --dport 443 -j ACCEPT
- + diff --git a/guide/q2.html b/guide/q2.html index af7da184..b0cf907d 100644 --- a/guide/q2.html +++ b/guide/q2.html @@ -14,7 +14,7 @@
哪吒监控

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

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

Dashboard 面板端配置

Agent 端配置

开启 Cloudflare CDN（可选）

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

- + diff --git a/guide/q4.html b/guide/q4.html index 814d3a84..1b3fbafc 100644 --- a/guide/q4.html +++ b/guide/q4.html @@ -14,7 +14,7 @@
哪吒监控

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

  • 如果你使用了CDN，请确认CDN服务商提供WebSocket服务，并且已开启WebSocket
  • 确认你的反代规则中针对 /ws,/terminal 路径的 WebSocket 进行了特别配置，你可以 点击这里 查看反向代理配置
- + diff --git a/guide/q5.html b/guide/q5.html index 647f5bc8..61487a43 100644 --- a/guide/q5.html +++ b/guide/q5.html @@ -14,7 +14,7 @@
哪吒监控

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

  1. 先运行一键脚本，选择 停止面板
  2. 在旧服务器中打包 /opt/nezha 文件夹，复制到新环境相同位置解压
  3. 在新环境中运行一键脚本，选择 启动面板
- + diff --git a/guide/q6.html b/guide/q6.html index d55bd691..5954648c 100644 --- a/guide/q6.html +++ b/guide/q6.html @@ -14,7 +14,7 @@
哪吒监控

如何每月重置流量统计？

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

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

TIP

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

- + diff --git a/guide/servers.html b/guide/servers.html index ec03dc8c..ec991091 100644 --- a/guide/servers.html +++ b/guide/servers.html @@ -14,7 +14,7 @@
哪吒监控

主机

介绍

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

添加服务器

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

安装Agent

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

强制更新

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

数据列

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

在线终端

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

- + diff --git a/guide/services.html b/guide/services.html index 1286837a..cfa53cd4 100644 --- a/guide/services.html +++ b/guide/services.html @@ -14,7 +14,7 @@
哪吒监控

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

使用方法

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

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

  • 名称 - 自定义一个名称

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

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

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

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

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

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

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

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

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

管理监控

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

- + diff --git a/guide/settings.html b/guide/settings.html index 9b693b5e..23ff7366 100644 --- a/guide/settings.html +++ b/guide/settings.html @@ -61,7 +61,7 @@ avatar.style} </style>

前台查看密码

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

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

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

IP 变更提醒

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

覆盖范围

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

特定服务器

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

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

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

WARNING

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


WARNING

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

- + diff --git a/guide/tasks.html b/guide/tasks.html index efd0b678..0aa3f1a3 100644 --- a/guide/tasks.html +++ b/guide/tasks.html @@ -14,7 +14,7 @@
哪吒监控

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

哪吒监控支持推送命令到 Agent 执行，因此此功能非常灵活，使用此功能可以定期结合 restic、rclone 给服务器备份，或者定期重启某项服务来重置网络连接

使用方法

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

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

  • 计划 - 设置计划时间，时间的格式为： * * * * * * 分别对应 秒 分 时 天 月 星期，详情见计划表达式格式
    如：0 0 3 * * * 对应为 每天3点

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

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

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

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

管理任务

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

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

常见问题

  1. xxx 命令找不到
    如果运行失败，提示 xxx 命令找不到，可能是 PATH 环境变量的问题，Linux 服务器在命令开头加入 source ~/.bashrc 或者使用绝对路径执行
- + diff --git a/hashmap.json b/hashmap.json index c7e91c88..88af5c70 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"developer_index.md":"87b2164a","developer_l10n.md":"423ded75","developer_theme.md":"4c18ce46","en_us_developer_index.md":"e3a7643d","en_us_developer_l10n.md":"a6ae6fae","en_us_developer_theme.md":"68f6eb4c","en_us_guide_agent.md":"be3521e6","en_us_guide_agentq.md":"adb0548b","en_us_guide_api.md":"d519a59e","en_us_guide_dashboard.md":"0e405f14","en_us_guide_dashboardq.md":"6d86f723","en_us_guide_loginq.md":"424e5ff1","en_us_guide_notifications.md":"3d75e558","en_us_guide_q2.md":"39fe67c6","en_us_guide_q3.md":"4e2fdc99","en_us_guide_q4.md":"f5b1d1b8","en_us_guide_q5.md":"415f1b49","en_us_guide_q6.md":"40fabb53","en_us_guide_servers.md":"547e489b","en_us_guide_services.md":"5b8d6f74","en_us_guide_settings.md":"6147c70c","en_us_guide_tasks.md":"1aa90124","en_us_index.md":"065e3776","guide_agent.md":"996d4a27","guide_agentq.md":"f8573204","guide_api.md":"52e8f873","guide_dashboard.md":"26bb8f08","guide_dashboardq.md":"65877597","guide_loginq.md":"9cd6ef44","guide_notifications.md":"9e6d6d2d","guide_q1.md":"02a52d8b","guide_q2.md":"659c70e9","guide_q3.md":"dc9bcac4","guide_q4.md":"df8db5fe","guide_q5.md":"6679febd","guide_q6.md":"c6ca959a","guide_servers.md":"bfc8c36a","guide_services.md":"08a3a1d5","guide_settings.md":"84bf7e05","guide_tasks.md":"1d8bc936","index.md":"0a71af9a"} +{"developer_index.md":"87b2164a","developer_l10n.md":"423ded75","developer_theme.md":"4c18ce46","en_us_developer_index.md":"e3a7643d","en_us_developer_l10n.md":"a6ae6fae","en_us_developer_theme.md":"68f6eb4c","en_us_guide_agent.md":"be3521e6","en_us_guide_agentq.md":"adb0548b","en_us_guide_api.md":"28a2e5f3","en_us_guide_dashboard.md":"0e405f14","en_us_guide_dashboardq.md":"6d86f723","en_us_guide_loginq.md":"424e5ff1","en_us_guide_notifications.md":"3d75e558","en_us_guide_q2.md":"39fe67c6","en_us_guide_q3.md":"4e2fdc99","en_us_guide_q4.md":"f5b1d1b8","en_us_guide_q5.md":"415f1b49","en_us_guide_q6.md":"40fabb53","en_us_guide_servers.md":"547e489b","en_us_guide_services.md":"5b8d6f74","en_us_guide_settings.md":"6147c70c","en_us_guide_tasks.md":"1aa90124","en_us_index.md":"065e3776","guide_agent.md":"996d4a27","guide_agentq.md":"f8573204","guide_api.md":"eadbd62a","guide_dashboard.md":"26bb8f08","guide_dashboardq.md":"65877597","guide_loginq.md":"9cd6ef44","guide_notifications.md":"9e6d6d2d","guide_q1.md":"02a52d8b","guide_q2.md":"659c70e9","guide_q3.md":"dc9bcac4","guide_q4.md":"df8db5fe","guide_q5.md":"6679febd","guide_q6.md":"c6ca959a","guide_servers.md":"bfc8c36a","guide_services.md":"08a3a1d5","guide_settings.md":"84bf7e05","guide_tasks.md":"1d8bc936","index.md":"0a71af9a"} diff --git a/index.html b/index.html index 88b9a4a0..de098d75 100644 --- a/index.html +++ b/index.html @@ -14,7 +14,7 @@
哪吒监控

哪吒监控

一个开源、轻量的服务器和网站监控、运维工具

开始使用 →

一键安装

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

随时监控

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

轻量运维

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

Copyright © 2022-present Nezhahq

- +