diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index a3d94451..aa432388 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -198,7 +198,7 @@ function getGuideSidebarEnUS() { { text: 'Perform Data Migration and Backup Recovery', link: '/en_US/guide/q5.html' }, { text: 'Reset Traffic Statistics Monthly', link: '/en_US/guide/q6.html' }, { text: 'Custom Agent Monitoring Projects', link: '/en_US/guide/q7.html' }, - { text: 'Use Cloudflare Access As OAuth2 Provider', link: '/guide/q8' }, + { text: 'Use Cloudflare Access As OAuth2 Provider', link: '/en_US/guide/q8' }, ] }, { diff --git a/docs/en_US/guide/agent.md b/docs/en_US/guide/agent.md index b6f009cb..dfd8fbd9 100644 --- a/docs/en_US/guide/agent.md +++ b/docs/en_US/guide/agent.md @@ -2,6 +2,8 @@ outline: deep --- +# Install Agent + **This document will introduce how to install the Agent on the monitored server and connect it to the Dashboard.** ::: tip The repository for Agent binaries can be found at: diff --git a/docs/en_US/guide/agentq.md b/docs/en_US/guide/agentq.md index 2067cd3b..f1acf4a9 100755 --- a/docs/en_US/guide/agentq.md +++ b/docs/en_US/guide/agentq.md @@ -2,6 +2,8 @@ outline: deep --- +# Frequently Asked Questions about the Agent + ## The IP Displayed in the Admin Panel is Different from the Actual Agent IP? Please refer to [Dashboard Related - Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP?](/en_US/guide/dashboardq.html#why-is-the-ip-displayed-in-the-admin-panel-different-from-the-actual-agent-ip). This will not be repeated here. diff --git a/docs/en_US/guide/api.md b/docs/en_US/guide/api.md index 562d2246..6e62b295 100644 --- a/docs/en_US/guide/api.md +++ b/docs/en_US/guide/api.md @@ -2,6 +2,8 @@ outline: deep --- +# API Interface + **Nezha Monitoring supports querying the status information of Agents using the API interface** ## Creating a Token diff --git a/docs/en_US/guide/dashboard.md b/docs/en_US/guide/dashboard.md index e122b9e7..78857987 100755 --- a/docs/en_US/guide/dashboard.md +++ b/docs/en_US/guide/dashboard.md @@ -2,6 +2,8 @@ outline: deep --- +# Install Dashboard + ## Preparation To set up Nezha Monitoring, you need: diff --git a/docs/en_US/guide/dashboardq.md b/docs/en_US/guide/dashboardq.md index 97b212e0..80100d29 100755 --- a/docs/en_US/guide/dashboardq.md +++ b/docs/en_US/guide/dashboardq.md @@ -2,6 +2,8 @@ outline: deep --- +# Frequently Asked Questions about the Dashboard + ## Why is the IP Displayed in the Admin Panel Different from the Actual Agent IP? First, let'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: [myip.go](https://github.com/nezhahq/agent/blob/main/pkg/monitor/myip.go). diff --git a/docs/en_US/guide/loginq.md b/docs/en_US/guide/loginq.md index 6ed4aa34..86b8b6d0 100644 --- a/docs/en_US/guide/loginq.md +++ b/docs/en_US/guide/loginq.md @@ -2,6 +2,8 @@ outline: deep --- +# Frequently Asked Questions about logging into the Dashboard + ## Stuck Page/Connection Refused/Long Response Time After Login Callback These issues can manifest in various ways, but ultimately the browser cannot display correctly after login. diff --git a/docs/en_US/guide/notifications.md b/docs/en_US/guide/notifications.md index 4365b779..0c7f1c8c 100644 --- a/docs/en_US/guide/notifications.md +++ b/docs/en_US/guide/notifications.md @@ -2,6 +2,8 @@ outline: deep --- +# Notification Configuration + 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. ## Flexible Notification Methods diff --git a/docs/en_US/guide/q8.md b/docs/en_US/guide/q8.md index c506ac4d..8437a2df 100644 --- a/docs/en_US/guide/q8.md +++ b/docs/en_US/guide/q8.md @@ -1,3 +1,4 @@ +# Cloudflare Access OAuth2 Configuration 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. ## Example Configuration: diff --git a/docs/en_US/guide/servers.md b/docs/en_US/guide/servers.md index 85138bb4..6d794969 100644 --- a/docs/en_US/guide/servers.md +++ b/docs/en_US/guide/servers.md @@ -2,7 +2,7 @@ outline: deep --- -# Server +# Server Management ## Introduction diff --git a/docs/en_US/guide/services.md b/docs/en_US/guide/services.md index d0405268..3ba1bd6a 100644 --- a/docs/en_US/guide/services.md +++ b/docs/en_US/guide/services.md @@ -2,6 +2,8 @@ outline: deep --- +# Service Monitoring + **The Services section is where you set up monitoring for external websites or servers using Agents.** **Configured service monitors can be viewed on the "Services" page of the homepage, displaying the availability monitoring results for the past 30 days.** diff --git a/docs/en_US/guide/settings.md b/docs/en_US/guide/settings.md index 68890c4f..7c7a4414 100644 --- a/docs/en_US/guide/settings.md +++ b/docs/en_US/guide/settings.md @@ -2,6 +2,8 @@ outline: deep --- +# Settings + ## Site Title You can customize the site title in this section. diff --git a/docs/en_US/guide/tasks.md b/docs/en_US/guide/tasks.md index c4ae7595..cbf09411 100644 --- a/docs/en_US/guide/tasks.md +++ b/docs/en_US/guide/tasks.md @@ -2,6 +2,8 @@ outline: deep --- +# Task Management + **In the Tasks section, you can set up scheduled tasks, trigger tasks, and batch execute tasks on multiple servers.** 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. diff --git a/docs/guide/agent.md b/docs/guide/agent.md index 11e7b86b..7597747a 100644 --- a/docs/guide/agent.md +++ b/docs/guide/agent.md @@ -2,6 +2,8 @@ outline: deep --- +# 安装 Agent + **哪吒监控的被控端服务被称为 Agent，本文档将介绍如何在被控端服务器上安装 Agent，并与 Dashboard 连接。** ::: tip Agent 二进制文件仓库地址为： diff --git a/docs/guide/agentq.md b/docs/guide/agentq.md index a5be780c..ada70ef4 100644 --- a/docs/guide/agentq.md +++ b/docs/guide/agentq.md @@ -2,6 +2,8 @@ outline: deep --- +# Agent 常见问题 + ## 后台显示的 IP 和 Agent 实际 IP 不一致？ 请查看 [Dashboard 相关-为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？](/guide/dashboardq.html#为什么管理面板中显示的ip和agent实际ip不一致？)。在此不再赘述。 diff --git a/docs/guide/api.md b/docs/guide/api.md index c49b354c..183dae3f 100644 --- a/docs/guide/api.md +++ b/docs/guide/api.md @@ -2,6 +2,8 @@ outline: deep --- +# API 接口 + **哪吒监控支持使用 API 接口查询面板中 Agent 的状态信息** ## 创建 Token diff --git a/docs/guide/dashboard.md b/docs/guide/dashboard.md index 18803ff8..7ad8eb24 100755 --- a/docs/guide/dashboard.md +++ b/docs/guide/dashboard.md @@ -2,6 +2,8 @@ outline: deep --- +# 安装 Dashboard + ## 准备工作 搭建一个哪吒监控，你需要： diff --git a/docs/guide/dashboardq.md b/docs/guide/dashboardq.md index f847cb54..addf85da 100644 --- a/docs/guide/dashboardq.md +++ b/docs/guide/dashboardq.md @@ -2,6 +2,8 @@ outline: deep --- +# Dashboard 常见问题 + ## 为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致？ 首先解释管理面板中显示的IP是怎么得到的：Agent 会每隔一段时间请求一遍 IP-API，获取到 IP 信息后上报到 Dashboard，目前使用的 IP-API 可在此查看：[myip.go](https://github.com/nezhahq/agent/blob/main/pkg/monitor/myip.go)。 diff --git a/docs/guide/loginq.md b/docs/guide/loginq.md index 4ef85a63..f930d66d 100644 --- a/docs/guide/loginq.md +++ b/docs/guide/loginq.md @@ -2,6 +2,8 @@ outline: deep --- +# 登录常见问题 + ## 登录回调后页面卡住\拒绝连接\响应时间过长 还有其他一些表现形式，总之登录后浏览器无法正常显示。 diff --git a/docs/guide/notifications.md b/docs/guide/notifications.md index b7817c4b..b2c0cbdc 100755 --- a/docs/guide/notifications.md +++ b/docs/guide/notifications.md @@ -2,6 +2,8 @@ outline: deep --- +# 通知设置 + 哪吒监控支持对服务器的负载、CPU、内存、硬盘、流量、月流量、进程数、连接数进行监控，并在达到用户设定的阈值时发送告警通知。 ## 灵活的通知方式 diff --git a/docs/guide/q1.md b/docs/guide/q1.md index 0dac3d8f..db462be8 100644 --- a/docs/guide/q1.md +++ b/docs/guide/q1.md @@ -1,7 +1,10 @@ -## 准备工作 +# 反向代理 Telegram Bot API 如果你的 Dashboard 服务器无法访问 Telegram Bot API，但你依然想使用 Telegram 来推送通知，你可以尝试使用反向代理的方式解决这个问题。 + +## 准备工作 + **这里介绍使用你自己的服务器进行反代的方法。你也可以选择使用 Cloudflare 的 Workers 进行反代，但可能对于中国大陆的用户来说网络连通性依然不佳。** 要搭建一个 Telegram Bot API 反代，你需要准备以下内容： diff --git a/docs/guide/q8.md b/docs/guide/q8.md index a826eaa4..a4ba232d 100755 --- a/docs/guide/q8.md +++ b/docs/guide/q8.md @@ -1,3 +1,4 @@ +# 使用 Cloudflare Access 作为 OAuth2 提供方 相较于 Github，Cloudflare Access 对于中国大陆用户更加友好。如您当前使用 Github、Gitlab、Gitee 作为管理员账户登录时遇到问题，您可以考虑切换 Cloudflare Access 作为 OAuth2 提供方 ## 示例配置： diff --git a/docs/guide/services.md b/docs/guide/services.md index 9752fe52..2745bf31 100755 --- a/docs/guide/services.md +++ b/docs/guide/services.md @@ -2,6 +2,8 @@ outline: deep --- +# 服务监控 + **服务区域是设置 Agent 监控外部网站或服务器的功能设置区** **设置好的服务监控可以在主页中的“服务”页查看过去 30 天的可用性监控结果** diff --git a/docs/guide/settings.md b/docs/guide/settings.md index e380900c..f11c46f1 100644 --- a/docs/guide/settings.md +++ b/docs/guide/settings.md @@ -2,6 +2,8 @@ outline: deep --- +# 设置 + ## 站点标题 你可以在此项中自定义站点标题。 diff --git a/docs/guide/tasks.md b/docs/guide/tasks.md index 94a71ca6..009b8134 100644 --- a/docs/guide/tasks.md +++ b/docs/guide/tasks.md @@ -2,6 +2,8 @@ outline: deep --- +# 任务管理 + **在任务区域中，可以设置计划任务，触发任务，多服务器批量执行任务** 哪吒监控支持推送命令到 Agent 执行，此功能非常灵活。使用此功能可以定期结合 restic、rclone 给服务器备份，定期重启某项服务来重置网络连接。也可以配合告警通知，在触发告警时执行某项任务，例如在 CPU 长时间高占用的情况下运行某个脚本。