README.md

# PIGWay Device Console

[简体中文](README.zh-CN.md) | 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.

### Installation

Docker Compose:

```bash
docker compose up -d --build
docker compose exec manager cat /data/manager.token
```

Direct execution using only the Python standard library:

```bash
PIGWAY_DATA="$PWD/.data" PIGWAY_PORT=6001 python3 app/server.py
cat .data/manager.token
```

Optional systemd installation:

```bash
sudo ./install.sh --port 6001
sudo cat /var/lib/pigway-web-manager/manager.token
```

Open `http://console-host:6001`, enter the Console token, and register each device URL and API token under Machine Management. Use `PIGWAY_PORT=6002 docker compose up -d --build` to change the published port.

Device tokens remain in the server-side data volume and are never returned by list APIs. The Console login token is kept only in the current browser session. Use an HTTPS reverse proxy or VPN across untrusted networks. Logs are queried from each device journal on demand; the Console does not create another log database.

### Features and boundaries

- Device registration, connectivity checks, multi-device status cards, and journal queries.
- Per-device configuration, service and plugin management, plus hierarchical batch configuration sync.
- Chinese and English interfaces with automatic, light, and dark themes.
- Up to 32 registered devices and 8 concurrent queries; one offline device does not block the others.
- Up to 50,000 journal entries per device per query, with an explicit warning when the date range must be narrowed.
- Stopping or uninstalling the Console never stops a Device Agent or hardware plugin.

Related projects: [PIGWay Device Agent](https://tea.pigway.com/way/pigway-device-agent) · [PIGWay Yahboom Cooling HAT](https://tea.pigway.com/way/pigway-yahboom-cooling-hat)
docs: align project names and repository links 2026-09-27 22:36:29 +08:00			`# PIGWay Device Console`
feat: add standalone fleet web manager 2026-09-27 22:28:03 +08:00
docs: refine language switch links 2026-09-28 21:28:28 +08:00			`[简体中文](README.zh-CN.md) \| English`
feat: add standalone fleet web manager 2026-09-27 22:28:03 +08:00
docs: add bilingual project documentation 2026-09-27 23:31:24 +08:00
			`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.`

			`### Installation`

			`Docker Compose:`

			```bash
			`docker compose up -d --build`
			`docker compose exec manager cat /data/manager.token`
			```

			`Direct execution using only the Python standard library:`

			```bash
			`PIGWAY_DATA="$PWD/.data" PIGWAY_PORT=6001 python3 app/server.py`
			`cat .data/manager.token`
			```

			`Optional systemd installation:`

			```bash
			`sudo ./install.sh --port 6001`
			`sudo cat /var/lib/pigway-web-manager/manager.token`
			```

			Open `http://console-host:6001`, enter the Console token, and register each device URL and API token under Machine Management. Use `PIGWAY_PORT=6002 docker compose up -d --build` to change the published port.

			`Device tokens remain in the server-side data volume and are never returned by list APIs. The Console login token is kept only in the current browser session. Use an HTTPS reverse proxy or VPN across untrusted networks. Logs are queried from each device journal on demand; the Console does not create another log database.`

			`### Features and boundaries`

			`- Device registration, connectivity checks, multi-device status cards, and journal queries.`
			`- Per-device configuration, service and plugin management, plus hierarchical batch configuration sync.`
			`- Chinese and English interfaces with automatic, light, and dark themes.`
			`- Up to 32 registered devices and 8 concurrent queries; one offline device does not block the others.`
			`- Up to 50,000 journal entries per device per query, with an explicit warning when the date range must be narrowed.`
			`- Stopping or uninstalling the Console never stops a Device Agent or hardware plugin.`

			`Related projects: [PIGWay Device Agent](https://tea.pigway.com/way/pigway-device-agent) · [PIGWay Yahboom Cooling HAT](https://tea.pigway.com/way/pigway-yahboom-cooling-hat)`