From 9ac276d443df052e70d8e5112bc4ddb5d0f493a9 Mon Sep 17 00:00:00 2001 From: cppla Date: Wed, 1 Jul 2026 15:32:17 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 57 +++++++++++++++++++------------------------------------ 1 file changed, 19 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 59889ad..26195ca 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ ServerStatus 是一个轻量的服务器探针和云监控面板，支持多节 ![Latest Host Version](https://dl.cpp.la/Archive/serverstatus_1_1_7.png) +`Watchdog 的 `interval` 是最小通知间隔，用于避免频繁报警，并不是探测间隔。`rule` 使用 Exprtk 表达式，当前窄字符解析对中文等 Unicode 字符不友好，规则中建议使用英文、数字和字段名。` + ## 功能 - 主机监控：在线状态、CPU、内存、虚存、硬盘、IO、负载、进程、连接、流量。 @@ -21,36 +23,16 @@ ServerStatus 是一个轻量的服务器探针和云监控面板，支持多节 - WebUI：主机、服务、证书、配置四个页面；配置页可增删改节点、监测、证书和 Watchdog 规则。 - HTTP 管理 API：方便 WebUI 或 AI Agent 读写配置、重载和重启服务。 -注意：Watchdog 的 `interval` 是最小通知间隔，用于避免频繁报警，并不是探测间隔。`rule` 使用 Exprtk 表达式，当前窄字符解析对中文等 Unicode 字符不友好，规则中建议使用英文、数字和字段名。 -## 快速启动 - -### 服务端 Docker Compose - -推荐用 Compose 启动服务端。默认 Web 端口映射为 `8080:80`，客户端连接端口为 `35601`。 +## 一、服务端 ```bash -ADMIN_TOKEN='your-strong-token' docker compose -f docker-compose-server.yml up -d --build +# Docker Compose，本地构建加：--build +ADMIN_TOKEN='your-strong-token' docker compose -f docker-compose-server.yml up -d ``` -启动后访问： - -- WebUI：http://127.0.0.1:8080/ -- HTTP API 自检：http://127.0.0.1:8080/api/health -- HTTP API 文档：http://127.0.0.1:8080/api/schema - -`ADMIN_TOKEN` 可选；不设置时 WebUI 仍可查看监控数据，但「配置」页和写入类 API 不允许修改配置。 - -`docker-compose-server.yml` 默认挂载： - -```text -./server/config.json -> /ServerStatus/server/config.json -./web/json -> /usr/share/nginx/html/json -``` - -### 服务端 Docker Run - ```bash +# Docker Run wget --no-check-certificate -qO ~/serverstatus-config.json \ https://raw.githubusercontent.com/cppla/ServerStatus/master/server/config.json mkdir -p ~/serverstatus-monthtraffic @@ -63,33 +45,32 @@ docker run -d --restart=always --name=serverstatus-server \ cppla/serverstatus:server ``` -### 客户端 Docker Compose +启动后访问： -客户端必须使用服务端 `config.json` 中存在的 `username/password`。默认示例用户名是 `s01`。 +- WebUI：http://127.0.0.1:8080/ +- HTTP API 自检：http://127.0.0.1:8080/api/health +- HTTP API 文档：http://127.0.0.1:8080/api/schema +- HTTP 默认端口映射为`8080:80`，客户端连接端口为`35601`。`ADMIN_TOKEN` 可选：不设置时Web仅可查看监控数据，但web配置页无法修改。 + + +## 二、客户端 ```bash -SERVER=127.0.0.1 USER=s01 PASSWORD=USER_DEFAULT_PASSWORD \ - docker compose -f docker-compose-client.yml up -d --force-recreate +# Docker Compose，本地构建加：--build +SERVER=127.0.0.1 USER=s01 docker compose -f docker-compose-client.yml up -d --force-recreate ``` -注意：`USER` 是 docker compose 常见的宿主机环境变量名。如果没有在运行命令里显式传递，或传递方式不正确，Compose 可能会把系统里的 `$USER` 解析成本机用户名，而不是默认 `s01`。推荐优先级： - -1. 运行命令显式传递 `USER=...` -2. 用户修改 `docker-compose-client.yml` 里的 `USER` 默认值 -3. 依赖 Docker/系统环境 - -### 客户端 Docker Run - ```bash +# Docker Run docker run -d --restart=always --name=serverstatus-client \ --network=host --pid=host \ -e SERVER=127.0.0.1 \ -e USER=s01 \ - -e PASSWORD=USER_DEFAULT_PASSWORD \ cppla/serverstatus:client ``` -### 客户端环境变量 +客户端环境变量和注意事项： +`USER` 是常见的宿主机环境变量名。如果没有显式传递，Compose 可能会把系统里的 `$USER` 解析成本机用户名。推荐优先级：1. 运行命令显式传递 `USER=...`，2. 用户修改 `docker-compose-client.yml` 里的 `USER` 默认值 | 变量 | 默认值 | 说明 | | --- | --- | --- |