diff --git a/docs/en_US/guide/dashboard.md b/docs/en_US/guide/dashboard.md index cad87666..d22f1643 100644 --- a/docs/en_US/guide/dashboard.md +++ b/docs/en_US/guide/dashboard.md @@ -15,6 +15,7 @@ If you don't think it's necessary to use port 80 or 443 to access Dashboard, you :::

+ ## Get the Client ID and Client Secret on Github/Gitlab Nezha Monitor uses a Github account as the login account for the admin panel + First we need to create a new authentication application, after logging into Github, open https://github.com/settings/developers and select "OAuth Apps" - "New OAuth App " diff --git a/docs/en_US/guide/notifications.md b/docs/en_US/guide/notifications.md index 1ce728be..b43f04da 100644 --- a/docs/en_US/guide/notifications.md +++ b/docs/en_US/guide/notifications.md @@ -11,20 +11,20 @@ Placeholders can also be placed inside the URL, and it will perform a simple str Refer to the example below, it is very flexible. - - Bark Example - - Name: Bark - - URL composition: the first part is the key, followed by three matches/: key/: body or/: key/: title/: body or/: key/: category/: title/: body - - Request method: GET - - Request Type: Default - - Body: null + - **Bark Example** + - Name: Bark + - URL: The first part is the key, followed by three matches/: key/: body or/: key/: title/: body or/: key/: category/: title/: body + - Request method: GET + - Request Type: Default + - Body: null - - Name: Bark - - URL composition:/push - - Request method: POST - - Request type: FORM - - Body: `{"title": "#SERVER.NAME#","device_key":"xxxxxxxxx","body":"#NEZHA#","icon":" https://xxxxxxxx/nz.png "}` + - Name: Bark + - URL:/push + - Request method: POST + - Request type: FORM + - Body: `{"title": "#SERVER.NAME#","device_key":"xxxxxxxxx","body":"#NEZHA#","icon":" https://xxxxxxxx/nz.png "}` - - Telegram Example, contributed by [@haitau](https://github.com/haitau) + - **Telegram Example, contributed by [@haitau](https://github.com/haitau)** - Name：Telegram Robot message notification - URL：https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&text=#NEZHA# @@ -33,8 +33,7 @@ Refer to the example below, it is very flexible. - Body: null - 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 _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. - - Email notification example - Outlook, contributed by [@MIKU_N -](https://github.com/MIKU-N) + - **Email notification example - Outlook, contributed by [@Cantoblanco](https://github.com/cantoblanco)** - Name: MS Mail Notification - URL：https://graph.microsoft.com/v1.0/me/microsoft.graph.sendMail diff --git a/docs/guide/agent.md b/docs/guide/agent.md index 3c6604ee..27ded88f 100644 --- a/docs/guide/agent.md +++ b/docs/guide/agent.md @@ -27,7 +27,7 @@ ## 其他方式安装 Agent -### 在 Linux 中安装Agent (Ubuntu、Debian、CentOS) +### 在 Linux 中安装 Agent (Ubuntu、Debian、CentOS) * 首先在管理面板中添加一台服务器 * 在被控服务器中，运行脚本（位于中国大陆的服务器请使用镜像）： @@ -36,7 +36,7 @@ curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh ``` 如果你的被控服务器位于中国大陆，可以使用镜像： ````bash -curl -L https://jihulab.com/nezha/nezha/-/raw/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh +curl -L https://cdn.jsdelivr.net/gh/naiba/nezha/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh ```` * 选择“安装监控 Agent” * 输入通信域名，如：”data.example.com“ @@ -135,20 +135,20 @@ EOF -### 在 Windows 中安装Agent +### 在 Windows 中安装 Agent - 请参考社区文章： [哪吒探针 - Windows 客户端安装](https://nyko.me/2020/12/13/nezha-windows-client.html)
-### 在 群晖DSM 中安装Agent +### 在 群晖DSM 中安装 Agent - 请参考社区文章： [哪吒探针——群晖客户端（被控端）安装教程](https://wl.gta5pdx.cn/archives/546/)
-### 在 MacOS 中安装Agent -***本节内容改编自[Mitsea Blog](https://blog.mitsea.com/e796f93db38d49e4b18df234c6ee75f5)，改编已获得原作者授权*** +### 在 MacOS 中安装 Agent +***本节内容改编自 [Mitsea Blog](https://blog.mitsea.com/e796f93db38d49e4b18df234c6ee75f5)，改编已获得原作者授权***
::: warning 安装过程中如提示“macOS 无法验证此 app“，请前往系统设置手动允许程序运行 diff --git a/docs/guide/api.md b/docs/guide/api.md index bf79bfdb..2795bdba 100644 --- a/docs/guide/api.md +++ b/docs/guide/api.md @@ -1,16 +1,16 @@ -**哪吒面板现在已经支持使用API接口查询面板中Agent的状态信息** +**哪吒面板现在已经支持使用 API 接口查询面板中 Agent 的状态信息** -## 创建Token -哪吒面板的API接口允许使用Token认证与Cookies认证 -要新建一个Token，在进入管理面板后，点击右上角的头像，选择 “API Token”，进入Token管理页面 -点击 “添加Token”，自定义备注后，点击 “添加” -如需删除一个Token，请选择相应的Token，点击右侧的删除图标 +## 创建 Token +哪吒面板的 API 接口允许使用 Token 认证与 Cookies 认证 +要新建一个 Token，在进入管理面板后，点击右上角的头像，选择 “API Token”，进入 Token 管理页面 +点击 “添加 Token”，自定义备注后，点击 “添加” +如需删除一个 Token，请选择相应的 Token，点击右侧的删除图标 ::: warning -Token是API接口的鉴权工具，它对你的面板的信息安全非常重要，请不要泄漏你的Token给他人 +Token 是 API 接口的鉴权工具，它对你的面板的信息安全非常重要，请不要泄漏你的 Token 给他人 ::: ## 认证方式 -Token认证方式： +Token 认证方式： ``` Request Headers: Authorization: Token @@ -18,16 +18,16 @@ Authorization: Token ## 使用说明 ::: warning 下面示例中的负数时间戳为（0000-00-00） -目前表示Dashboard上线后该Agent从未汇报过 +目前表示 Dashboard 上线后该 Agent 从未汇报过 但不建议用正负性判断状态 ::: ::: tip **请求方式为 `Get`，返回格式为 `JSON`** ::: + 获取服务器列表：`GET /api/v1/server/list?tag=` -query: tag (ServerTag是服务器的分组，提供此参数则仅查询该分组中的服务器) +query: tag (ServerTag 是服务器的分组，提供此参数则仅查询该分组中的服务器) -JSON返回示例： +JSON 返回示例： ``` { "code": 0, @@ -56,10 +56,10 @@ JSON返回示例： ``` + 获取服务器详情：`GET /api/v1/server/details?id=&tag=` -query: id (ServerID 多个ID以逗号分隔，提供此参数则查询该ID对应的服务器，同时无视tag参数) +query: id (ServerID 多个 ID 以逗号分隔，提供此参数则查询该 ID 对应的服务器，同时无视tag参数) query: tag (ServerTag 提供此参数则仅查询该分组下的服务器) -JSON返回示例： +JSON 返回示例： ``` { "code": 0, diff --git a/docs/guide/dashboard.md b/docs/guide/dashboard.md index d4c57f00..4c1dca24 100644 --- a/docs/guide/dashboard.md +++ b/docs/guide/dashboard.md @@ -14,7 +14,7 @@ **本文档将以宝塔面板反代面板的过程作为范例，随着未来版本的变化，部分功能的入口可能会发生改变，本文档仅供参考** :::warning -本项目并不依赖宝塔，你可以选择使用你喜欢的任何服务器面板，如果你能力足够，可以手动安装 NginX 或 Caddy 来配置SSL和反代。 +本项目并不依赖宝塔，你可以选择使用你喜欢的任何服务器面板，如果你能力足够，可以手动安装 NginX 或 Caddy 来配置 SSL 和反代。 如果你认为没有必要使用 80、443 端口来访问 Dashboard，你甚至不需要安装 NginX 就可以直接使用安装脚本。 :::
@@ -44,7 +44,7 @@ curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh ``` 如果你的面板服务器位于中国大陆，可以使用镜像： ````bash -curl -L https://jihulab.com/nezha/nezha/-/raw/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh +curl -L https://cdn.jsdelivr.net/gh/naiba/nezha/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh ```` * 等待Docker安装完毕后，分别输入以下值： diff --git a/docs/guide/notifications.md b/docs/guide/notifications.md index 336d7cd3..eb51d5da 100644 --- a/docs/guide/notifications.md +++ b/docs/guide/notifications.md @@ -10,7 +10,7 @@ URL 里面也可放置占位符，请求时会进行简单的字符串替换。 你可以参考以下的通知方式示例，也可以根据自己的需求灵活设置推送方式 - - Bark 示例 + - **Bark 示例** - 名称：Bark - URL 组成: 第一个部分是 key,之后有三个匹配 /:key/:body or /:key/:title/:body or /:key/:category/:title/:body @@ -23,15 +23,15 @@ URL 里面也可放置占位符，请求时会进行简单的字符串替换。 - 请求类型: form - Body: `{"title": "#SERVER.NAME#","device_key":"xxxxxxxxx","body":"#NEZHA#","icon":"https://xxxxxxxx/nz.png"}` - - server 酱示例 + - **Server 酱示例** - - 名称：server 酱 + - 名称：Server 酱 - URL：https://sc.ftqq.com/SCUrandomkeys.send?text=#NEZHA# - 请求方式: GET - 请求类型: 默认 - Body: 空 - - wxpusher 示例，需要关注你的应用 + - **wxpusher 示例，需要关注你的应用** - 名称: wxpusher - URL：http://wxpusher.zjiecode.com/api/send/message @@ -39,7 +39,7 @@ URL 里面也可放置占位符，请求时会进行简单的字符串替换。 - 请求类型: JSON - Body: `{"appToken":"你的appToken","topicIds":[],"content":"#NEZHA#","contentType":"1","uids":["你的uid"]}` - - Telegram 示例 贡献者：[@haitau](https://github.com/haitau) + - **Telegram 示例 贡献者：[@haitau](https://github.com/haitau)** - 名称：telegram 机器人消息通知 - URL：https://api.telegram.org/botXXXXXX/sendMessage?chat_id=YYYYYY&text=#NEZHA# @@ -48,34 +48,16 @@ URL 里面也可放置占位符，请求时会进行简单的字符串替换。 - 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 对话可获得。 - - 邮件通知示例 - Outlook 贡献者：[@MIKU_N](https://github.com/MIKU-N) + - **邮件通知示例 - SendCloud 贡献者：[@白歌](https://github.com/cantoblanco)** + **注意：SendCloud 有每日免费发送邮件限额限制，这里仅作示例，你可以选择付费服务或其他类似的免费服务，使用方法类似。** - - 名称：MS邮件告警 - - URL：https://graph.microsoft.com/v1.0/me/microsoft.graph.sendMail + - 名称：邮件告警 + - URL：https://api.sendcloud.net/apiv2/mail/send?apiUser=<替换APIUSER>apiKey=<替换APIKEY>&from=<自定义发件邮箱>&fromName=Nezha&to=<自定义收件邮箱>&subject=Nezha-Notification&html=#NEZHA# - 请求方式: POST - 请求类型: JSON - - Header: `{"Content-type":"application/json", - "Authorization":"Bearer {Token}"}` - - Body: - ``` - { - "message": { - "subject": "服务器状态警报", - "body": { - "contentType": "Text", - "content": "#NEZHA#" - }, - "toRecipients": [ - { - "emailAddress": { - "address": "接收邮件地址" - } - } - ] - } -} - ``` - - URL 参数获取说明：此方式调用 Microsoft Graph V1.0,需要前往 Microsoft Graph 自行创建应用程序，授予 `Mail.Send` 权限并获取 Token;或者你可以使用[Microsoft Graph Explorer](https://developer.microsoft.com/zh-cn/graph/graph-explorer)直接授予权限并获取 Token。将 Header 中的 Token 字段替换为实际字符段即可。 + - Header: 留空 + - Body: 留空 + - URL 参数获取说明：此方式需提前在 [SendCloud](https://www.sendcloud.net/) 注册账号，创建发件邮箱，然后在[这里](https://www.sendcloud.net/sendSetting/apiuser)获取 APIUSER 和 APIKEY，替换 URL 中的 <替换APIUSER> 和 <替换APIKEY> 为自己的 APIUSER 和 APIKEY，替换 URL 中的 <自定义发件邮箱> 和 <自定义收件邮箱> 为自己的发件邮箱和收件邮箱。
diff --git a/docs/guide/q1.md b/docs/guide/q1.md index 59d89b20..6cc44341 100644 --- a/docs/guide/q1.md +++ b/docs/guide/q1.md @@ -1,11 +1,11 @@ ## 准备工作 -**你可以选择CloudFlare的workers进行反代,但大陆的网络你懂的,这里介绍用你自己服务器反代方式** -搭建一个TGbot api反代，你需要： -1.一个不受GFW封锁的服务器(且安装好nginx) -2.一个域名(提前申请SSL证书) +**你可以选择 CloudFlare 的 workers 进行反代，但大陆的网络你懂的，这里介绍用你自己服务器反代方式** +搭建一个 TGbot api 反代，你需要： +1.一个不受 GFW 封锁的服务器(且安装好 Nginx) +2.一个域名(提前申请 SSL 证书)
-## NGINX配置 -编辑你nginx的配置文件,在http{}中加上如下配置 +## NGINX 配置 +编辑你 Nginx 的配置文件,在 http{} 中加上如下配置 ```nginx # http强制跳转到htpps server { @@ -49,15 +49,15 @@ server { error_log /var/log/tg.log error; } ``` -`yourDomainName`-你准备的域名 -`ssl_certificate`-SSL证书路径 -`ssl_certificate_key`-SSL证书路径 +`yourDomainName` - 你准备的域名 +`ssl_certificate` - SSL 证书路径 +`ssl_certificate_key` - SSL 证书路径
## 使用方式 -:tada:然后执行`systemctl restart nginx`回到nezha将原来的https://api.telegram.org/ 替换为https://yourDomainName/ ,即可正常推送消息 +:tada:然后执行 `systemctl restart nginx` 回到 Nezha 将原来的https://api.telegram.org/ 替换为 https://yourDomainName/ ,即可正常推送消息
## 防止盗用 -`serverIp`-你监控鸡的ip地址,你系统安装的那个就用那个命令,ufw iptables都可. +`serverIp` - Agent 的 ip 地址,你系统安装的哪个就用哪个命令,ufw iptables 都可. ```bash #ubuntu ufw allow proto tcp from serverIp to any port 443 diff --git a/docs/guide/q4.md b/docs/guide/q4.md index 56de175e..6cac3826 100644 --- a/docs/guide/q4.md +++ b/docs/guide/q4.md @@ -1,3 +1,3 @@ #### 实时通道断开/在线终端连接失败 -+ 如果你使用了CDN，请确认CDN服务商提供WebSocket服务，并且已开启WebSocket ++ 如果你使用了 CDN，请确认 CDN 服务商提供 WebSocket 服务，并且已开启 WebSocket + 确认你的反代规则中针对 /ws,/terminal 路径的 WebSocket 进行了特别配置，你可以 [点击这里](/guide/dashboard.html#配置反向代理) 查看反向代理配置 \ No newline at end of file diff --git a/docs/guide/settings.md b/docs/guide/settings.md index 750fc00a..cefd9e2a 100644 --- a/docs/guide/settings.md +++ b/docs/guide/settings.md @@ -3,7 +3,7 @@
## 管理员列表 -+ 如果你修改了自己的Github, Gitlab, Jihulab或Gitee的用户名，可以在此项中同步修改，否则无法登录，多个用户请用逗号隔开: `user1,user2` ++ 如果你修改了自己的 Github, Gitlab, Jihulab 或 Gitee 的用户名，可以在此项中同步修改，否则无法登录，多个用户请用逗号隔开: `user1,user2` + 如需更改管理员账户，请前往 `/opt/nezha/dashboard/data/config.yaml` ，重新设置新的管理员 `Client ID` 和 `Client Secret`
@@ -24,7 +24,7 @@
## 自定义代码 -改LOGO、改色调、加统计代码等。 +改 LOGO、改色调、加统计代码等。 :::warning 自定义代码仅在游客首页生效，管理面板不生效 @@ -103,7 +103,7 @@ 设置密码后，需要输入密码才可以访问主页
-## 未接入CDN的面板服务器域名/IP +## 未接入 CDN 的面板服务器域名/IP 此项设置是使用一键脚本安装 Agent 的前提，详情请查看[这里](/guide/agent.html#%E5%87%86%E5%A4%87%E5%B7%A5%E4%BD%9C)