更新README、四个FAQ英文文档
This commit is contained in:
parent
c6b74042c8
commit
5c365f41d1
@ -4,3 +4,6 @@
|
||||
npm i
|
||||
npm run dev
|
||||
```
|
||||
|
||||
当你增加文档时,请同步添加其他语言的文档
|
||||
When you add a new document, please add document in other languages at the same time
|
@ -1 +1,4 @@
|
||||
q2
|
||||
#### 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?](https://www.google.com/search?q=How+to+disable+SELinux)
|
@ -1 +1,52 @@
|
||||
q3
|
||||
#### Reverse Proxy gRPC Port (support Cloudflare CDN)
|
||||
Use Nginx or Caddy to reverse proxy gRPC
|
||||
|
||||
- Nginx configuration files
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 443 ssl http2;
|
||||
listen [::]:443 ssl http2;
|
||||
server_name data.example.com; # The domain name where the Agent connects to Dashboard
|
||||
|
||||
ssl_certificate /data/letsencrypt/fullchain.pem; # Your domain certificate path
|
||||
ssl_certificate_key /data/letsencrypt/key.pem; # Your domain's private key path
|
||||
|
||||
underscores_in_headers on;
|
||||
|
||||
location / {
|
||||
grpc_read_timeout 300s;
|
||||
grpc_send_timeout 300s;
|
||||
grpc_pass grpc://localhost:5555;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- Caddy configuration files
|
||||
|
||||
```
|
||||
data.example.com:443 { # The domain name where the Agent connects to Dashboard
|
||||
reverse_proxy {
|
||||
to localhost:5555
|
||||
transport http {
|
||||
versions h2c 2
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Dashboard Configuration
|
||||
|
||||
- First login to the Dashboard and enter the admin panel, go to the settings page, fill in the `CDN Bypassed Domain/IP` with the domain name you configured in Nginx or Caddy, for example `data.example.com`, and save it.
|
||||
- Then open the `/opt/nezha/dashboard/data/config.yaml` file in the panel server and change `proxygrpcport` to the port that Nginx or Caddy is listening on, such as `443` as set in the previous step. Since we have SSL/TLS enabled in Nginx or Caddy, we need to set `tls` to `true`, restart the panel when you are done.
|
||||
|
||||
Agent Configuration
|
||||
|
||||
- Log in to the admin panel, copy the one-click install command, and run the one-click install command on the corresponding server to reinstall the agent.
|
||||
|
||||
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).
|
||||
|
||||
- Log in to Cloudflare and select the domain you are using. Go to the `Network` page and turn on the `gRPC` switch, then go to the `DNS` page, find the resolution record of the domain with gRPC configuration, and turn on the orange cloud icon to enable CDN.
|
@ -1 +1,3 @@
|
||||
q4
|
||||
#### 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](/en_US/guide/dashboard.html#configure-reverse-proxy) to see the reverse proxy configuration
|
@ -1 +1,5 @@
|
||||
q5
|
||||
#### 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`
|
Loading…
x
Reference in New Issue
Block a user