更新英文Agent、Dashboard文档以匹配中文文档更改,更新中文排障指南

This commit is contained in:
hhhkkk520 2022-05-21 16:03:23 +02:00
parent 9248db2546
commit 19e97360fd
7 changed files with 63 additions and 28 deletions

View File

@ -97,4 +97,10 @@ Run `./nezha-agent --help` to view supported flagsif you are already using th
- `--disable-auto-update` Disable **Automatic Update** Agent (security feature)
- `--disable-force-update` Disable **Forced Update** Agent (security feature)
- `--disable-command-execute` Disable execution of scheduled tasks, disallow WebShell (security feature)
- `--tls` Enable SSL/TLS encryption (If you are using nginx to reverse proxy Agent´s grpc connections, and if nginx has SSL/TLS enabled, you need to enable this configuration)
- `--tls` Enable SSL/TLS encryption (If you are using nginx to reverse proxy Agent´s grpc connections, and if nginx has SSL/TLS enabled, you need to enable this configuration)
## 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.

View File

@ -91,4 +91,23 @@ Now, you should be able to access the panel directly using a domain name such as
## 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**
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!**
::: danger
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

View File

@ -107,7 +107,7 @@ restart() {
- `--tls` 启用 SSL/TLS 加密(使用 nginx 反向代理 Agent 的 grpc 连接,并且 nginx 开启 SSL/TLS 时,需要启用该项配置)
## FAQ
#### Agent有Docker版吗?
Agent目前没有推出Docker镜像。
Agent和Dashboard思路相反Dashboard要尽可能不影响宿主机工作但Agent则需要插入宿主机中执行监控和其他命令。
将Agent放入容器中确实可以继续执行监控任务但WebShell等功能无法正常运行因此不提供Docker镜像。
### Agent 有 Docker 镜像吗?
**Agent 目前没有推出 Docker 镜像。**
Agent 的设计思路和 Dashboard 相反Dashboard 要尽可能不影响宿主机工作,但 Agent 则需要在宿主机中执行监控服务和运行命令。
Agent 放入容器中确实可以继续执行监控任务,但 WebShell 等功能无法正常运行,因此不提供 Docker 镜像。

View File

@ -1,7 +1,7 @@
# Agent相关
### 后台显示的IP和Agent实际IP不一致
请查看[Dashboard相关-后台显示的IP和Agent实际IP不一致](/guide/dashboardq.html#后台显示的ip和agent实际ip不一致)
## 后台显示的IP和Agent实际IP不一致
请查看 [Dashboard相关-后台显示的IP和Agent实际IP不一致](/guide/dashboardq.html#后台显示的ip和agent实际ip不一致)
在此不再赘述。
### 一键脚本安装出错
#### curl: Failed to connect to raw.githubusercontent.com......
## 一键脚本安装出错
### curl: Failed to connect to raw.githubusercontent.com......
多出现在国内主机中目前一键脚本只从github直接获取安装脚本您可以多尝试几次或者[手动安装Agent](/guide/agent.html#其他方式安装agent),别忘了使用镜像。

View File

@ -106,14 +106,20 @@ location ~ ^/(ws|terminal/.+)$ {
完成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等需求中可以直接修改数据库。
### 我对面板提供的数据修改/增加功能不满意,我想要自己修改/增加数据怎么办?
常见于批量插入 Agent 等需求中,可以直接修改数据库。
请注意数据库中并非什么都可以修改错误的修改会导致数据混乱无法启动Dashboard**请勿随意修改数据库!**
::: danger
再重复一遍,**请勿随意修改数据库!**
请先**停止**面板容器数据库是sqlite3位于`/opt/nezha/dashboard/data/sqlite.db`,请备份后操作
:::
如需要在数据库中修改数据,请先**停止**面板容器再修改。
数据库类型是 sqlite3位于 `/opt/nezha/dashboard/data/sqlite.db`,修改前请备份
#### 数据库中各表/列是什么意思?
### 数据库中各表/列是什么意思?
文档不提供数据库解释,有能力修改数据库的稍加分析应该就足以看懂。
#### Dashboard会自动更新吗
Agent通常情况下会自动更新但Dashboard并不会需要手动更新。
### Dashboard 会自动更新吗?
Agent通常情况下会自动更新但Dashboard并不会需要手动更新。
### 如何更新 Dashboard
运行脚本 `./nezha.sh` ,选择重启面板并更新

View File

@ -1,24 +1,26 @@
# Dashboard相关
### 实时通道断开/在线终端连接失败
## 实时通道断开/在线终端连接失败
请查看[常见问题-实时通道断开/在线终端连接失败](/guide/q4.html)
在此不再赘述。
### 后台显示的IP和Agent实际IP不一致
首先解释后台显示的IP是怎么来的Agent会每隔一段时间请求一遍IP-API获取到IP信息后进行上报目前使用的IP-API可在此查看[myip.go](https://github.com/naiba/nezha/blob/master/cmd/agent/monitor/myip.go)。
## 后台显示的IP和Agent实际IP不一致
首先解释后台显示的IP是怎么来的Agent会每隔一段时间请求一遍IP-API获取到IP信息后进行上报目前使用的IP-API可在此查看[myip.go](https://github.com/naiba/nezha/blob/master/cmd/agent/monitor/myip.go)。
如您认为后台显示的IP和服务商提供给您的IP不一致最大的可能是服务商给您的是**入口**但Agent测试的是您的**出口**。这个问题也可能会出现在多线主机中。
举个简单也十分常见的例子服务商给您提供的是一台高防主机为了同时满足高防和低网络中断率的目标提供给您的IP可能是经过映射后的高防IP而并非您主机的真实出口IP。
您也可以使用以下命令在Agent部署主机中进行测试。
::: tip
举个简单也十分常见的例子服务商给您提供的是一台高防主机为了同时满足高防和低网络中断率的目标提供给您的IP可能是经过映射后的高防IP而并非您主机的真实出口IP
:::
您也可以使用以下命令在Agent部署主机中进行测试:
```shell
curl api.myip.la
curl ip.sb
curl ip-api.com
```
### 查看密码忘记\删除查看密码
请查看或编辑`/opt/nezha/dashboard/data/config.yaml`文件。
密码位于site-viewpassword。
## 查看密码忘记\删除查看密码
请查看或编辑 `/opt/nezha/dashboard/data/config.yaml` 文件。
密码位于 site-viewpassword。
### 面板安装失败: iptables ......
## 面板安装失败: iptables ......
首先尝试重启docker再操作
```shell
systemctl status docker

View File

@ -1 +1,3 @@
# 登录相关
敬请期待
## 问题1