From f8f3b16e90b15f8a9a7a720c60b37c6f6dc253e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B8=A1=E5=8F=A3=E6=B5=AA=E4=BA=BA?= Date: Mon, 28 Sep 2026 20:03:12 +0800 Subject: [PATCH] docs: split English and Chinese readmes --- README.md | 43 +------------------------------------------ README.zh-CN.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ SHA256SUMS | 3 ++- 3 files changed, 47 insertions(+), 43 deletions(-) create mode 100644 README.zh-CN.md diff --git a/README.md b/README.md index 4ef15f7..4a3b905 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,7 @@ # PIGWay Device Console -## 中文 +[English](README.md) | [简体中文](README.zh-CN.md) -独立的多设备管理中心,可运行在 NAS、服务器或其他能访问设备 API 的主机上。所有设备都需要显式登记;Console 不采集所在主机状态,不控制硬件,也不依赖 Agent 或插件持续运行。 - -### 安装 - -Docker Compose: - -```bash -docker compose up -d --build -docker compose exec manager cat /data/manager.token -``` - -直接运行(仅使用 Python 标准库): - -```bash -PIGWAY_DATA="$PWD/.data" PIGWAY_PORT=6001 python3 app/server.py -cat .data/manager.token -``` - -可选 systemd 安装: - -```bash -sudo ./install.sh --port 6001 -sudo cat /var/lib/pigway-web-manager/manager.token -``` - -打开 `http://管理中心地址:6001`,输入管理中心令牌,然后在“机器管理”中登记设备地址和该设备的 API 令牌。用 `PIGWAY_PORT=6002 docker compose up -d --build` 可修改外部端口。 - -设备令牌只保存在服务端数据卷,列表不会返回;管理中心登录令牌只保存在当前浏览器会话。跨公网部署应使用 HTTPS 反向代理或 VPN。日志按需查询设备 journal,不建立额外日志数据库。 - -### 功能与边界 - -- 设备登记、连接检测、多机状态卡片和 journal 查询。 -- 单机配置、服务及插件管理,以及按配置层级选择的批量同步。 -- 中英文界面和自动、浅色、深色主题。 -- 最多登记 32 台设备,并发查询最多 8 台;单台离线不会阻塞其他设备。 -- 单设备单次日志聚合上限 50,000 条,超出时明确提示缩小日期范围。 -- Console 停止或卸载不会停止任何设备上的 Agent 或硬件插件。 - -相关项目:[PIGWay Device Agent](https://tea.pigway.com/way/pigway-device-agent) · [PIGWay Yahboom Cooling HAT](https://tea.pigway.com/way/pigway-yahboom-cooling-hat) - -## English PIGWay Device Console is an independent multi-device management application for a NAS, server, or any host that can reach the device APIs. Every device is registered explicitly. The Console does not monitor its own host, control hardware directly, or require an Agent or plugin to remain operational. diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 0000000..60b3c18 --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,44 @@ +# PIGWay Device Console + +[English](README.md) | [简体中文](README.zh-CN.md) + + +独立的多设备管理中心,可运行在 NAS、服务器或其他能访问设备 API 的主机上。所有设备都需要显式登记;Console 不采集所在主机状态,不控制硬件,也不依赖 Agent 或插件持续运行。 + +### 安装 + +Docker Compose: + +```bash +docker compose up -d --build +docker compose exec manager cat /data/manager.token +``` + +直接运行(仅使用 Python 标准库): + +```bash +PIGWAY_DATA="$PWD/.data" PIGWAY_PORT=6001 python3 app/server.py +cat .data/manager.token +``` + +可选 systemd 安装: + +```bash +sudo ./install.sh --port 6001 +sudo cat /var/lib/pigway-web-manager/manager.token +``` + +打开 `http://管理中心地址:6001`,输入管理中心令牌,然后在“机器管理”中登记设备地址和该设备的 API 令牌。用 `PIGWAY_PORT=6002 docker compose up -d --build` 可修改外部端口。 + +设备令牌只保存在服务端数据卷,列表不会返回;管理中心登录令牌只保存在当前浏览器会话。跨公网部署应使用 HTTPS 反向代理或 VPN。日志按需查询设备 journal,不建立额外日志数据库。 + +### 功能与边界 + +- 设备登记、连接检测、多机状态卡片和 journal 查询。 +- 单机配置、服务及插件管理,以及按配置层级选择的批量同步。 +- 中英文界面和自动、浅色、深色主题。 +- 最多登记 32 台设备,并发查询最多 8 台;单台离线不会阻塞其他设备。 +- 单设备单次日志聚合上限 50,000 条,超出时明确提示缩小日期范围。 +- Console 停止或卸载不会停止任何设备上的 Agent 或硬件插件。 + +相关项目:[PIGWay Device Agent](https://tea.pigway.com/way/pigway-device-agent) · [PIGWay Yahboom Cooling HAT](https://tea.pigway.com/way/pigway-yahboom-cooling-hat) diff --git a/SHA256SUMS b/SHA256SUMS index 283e1df..b7b07b3 100644 --- a/SHA256SUMS +++ b/SHA256SUMS @@ -1,7 +1,8 @@ 535a162cf05549e3089c61b1850b25627b48bf606548a41e4c10bf461f5ccf97 .dockerignore 62dbe9a72fc425104d5dfe5c63d089cd7785e49ca94386463aa9372dee48163f .gitignore e3d6adb86d19118a02a43aeb929e8fa8ca486e0721586652d908c1822f4a4dcc Dockerfile -097b368200551f5196585a313ae36618e68bb0140f7e045772fe373172089bdb README.md +ab0b8d9ce15cfd7cdf8fe4e191c59a70289aa0bffed0b91598fca26a1c042268 README.md +1564170e9e5a3471f1a00513b1107749fc9e4f18641946564777a518f3205362 README.zh-CN.md 3c1531ef7c99dc3672d091715c88a0803eb117ad21601200a9b5753bf818fc76 app/server.py d3cdab188f694f7216d3bb361394a2e160a8b3d425c1a904ede7372698582a3e compose.yaml 148e0523932cc4e65537ec2cff38ee93fda1a9447c411ae410cbec8b7b93d6bb install.sh