Skip to content

Commit 9ac276d

Browse files
committed
更新说明
1 parent c58eaf6 commit 9ac276d

1 file changed

Lines changed: 19 additions & 38 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ ServerStatus 是一个轻量的服务器探针和云监控面板,支持多节
1111

1212
![Latest Host Version](https://dl.cpp.la/Archive/serverstatus_1_1_7.png)
1313

14+
`Watchdog 的 `interval` 是最小通知间隔,用于避免频繁报警,并不是探测间隔。`rule` 使用 Exprtk 表达式,当前窄字符解析对中文等 Unicode 字符不友好,规则中建议使用英文、数字和字段名。`
15+
1416
## 功能
1517

1618
- 主机监控:在线状态、CPU、内存、虚存、硬盘、IO、负载、进程、连接、流量。
@@ -21,36 +23,16 @@ ServerStatus 是一个轻量的服务器探针和云监控面板,支持多节
2123
- WebUI:主机、服务、证书、配置四个页面;配置页可增删改节点、监测、证书和 Watchdog 规则。
2224
- HTTP 管理 API:方便 WebUI 或 AI Agent 读写配置、重载和重启服务。
2325

24-
注意:Watchdog 的 `interval` 是最小通知间隔,用于避免频繁报警,并不是探测间隔。`rule` 使用 Exprtk 表达式,当前窄字符解析对中文等 Unicode 字符不友好,规则中建议使用英文、数字和字段名。
25-
26-
## 快速启动
27-
28-
### 服务端 Docker Compose
2926

30-
推荐用 Compose 启动服务端。默认 Web 端口映射为 `8080:80`,客户端连接端口为 `35601`。
27+
## 一、服务端
3128

3229
```bash
33-
ADMIN_TOKEN='your-strong-token' docker compose -f docker-compose-server.yml up -d --build
34-
```
35-
36-
启动后访问:
37-
38-
- WebUI:http://127.0.0.1:8080/
39-
- HTTP API 自检:http://127.0.0.1:8080/api/health
40-
- HTTP API 文档:http://127.0.0.1:8080/api/schema
41-
42-
`ADMIN_TOKEN` 可选;不设置时 WebUI 仍可查看监控数据,但「配置」页和写入类 API 不允许修改配置。
43-
44-
`docker-compose-server.yml` 默认挂载:
45-
46-
```text
47-
./server/config.json -> /ServerStatus/server/config.json
48-
./web/json -> /usr/share/nginx/html/json
30+
# Docker Compose,本地构建加:--build
31+
ADMIN_TOKEN='your-strong-token' docker compose -f docker-compose-server.yml up -d
4932
```
5033

51-
### 服务端 Docker Run
52-
5334
```bash
35+
# Docker Run
5436
wget --no-check-certificate -qO ~/serverstatus-config.json \
5537
https://raw.githubusercontent.com/cppla/ServerStatus/master/server/config.json
5638
mkdir -p ~/serverstatus-monthtraffic
@@ -63,33 +45,32 @@ docker run -d --restart=always --name=serverstatus-server \
6345
cppla/serverstatus:server
6446
```
6547

66-
### 客户端 Docker Compose
67-
68-
客户端必须使用服务端 `config.json` 中存在的 `username/password`。默认示例用户名是 `s01`。
48+
启动后访问:
6949

70-
```bash
71-
SERVER=127.0.0.1 USER=s01 PASSWORD=USER_DEFAULT_PASSWORD \
72-
docker compose -f docker-compose-client.yml up -d --force-recreate
73-
```
50+
- WebUI:http://127.0.0.1:8080/
51+
- HTTP API 自检:http://127.0.0.1:8080/api/health
52+
- HTTP API 文档:http://127.0.0.1:8080/api/schema
53+
- HTTP 默认端口映射为`8080:80`,客户端连接端口为`35601`。`ADMIN_TOKEN` 可选:不设置时Web仅可查看监控数据,但web配置页无法修改。
7454

75-
注意:`USER` 是 docker compose 常见的宿主机环境变量名。如果没有在运行命令里显式传递,或传递方式不正确,Compose 可能会把系统里的 `$USER` 解析成本机用户名,而不是默认 `s01`。推荐优先级:
7655

77-
1. 运行命令显式传递 `USER=...`
78-
2. 用户修改 `docker-compose-client.yml` 里的 `USER` 默认值
79-
3. 依赖 Docker/系统环境
56+
## 二、客户端
8057

81-
### 客户端 Docker Run
58+
```bash
59+
# Docker Compose,本地构建加:--build
60+
SERVER=127.0.0.1 USER=s01 docker compose -f docker-compose-client.yml up -d --force-recreate
61+
```
8262

8363
```bash
64+
# Docker Run
8465
docker run -d --restart=always --name=serverstatus-client \
8566
--network=host --pid=host \
8667
-e SERVER=127.0.0.1 \
8768
-e USER=s01 \
88-
-e PASSWORD=USER_DEFAULT_PASSWORD \
8969
cppla/serverstatus:client
9070
```
9171

92-
### 客户端环境变量
72+
客户端环境变量和注意事项:
73+
`USER` 是常见的宿主机环境变量名。如果没有显式传递,Compose 可能会把系统里的 `$USER` 解析成本机用户名。推荐优先级:1. 运行命令显式传递 `USER=...`,2. 用户修改 `docker-compose-client.yml` 里的 `USER` 默认值
9374

9475
| 变量 | 默认值 | 说明 |
9576
| --- | --- | --- |

0 commit comments

Comments
 (0)