35 lines
2.1 KiB
Markdown
35 lines
2.1 KiB
Markdown
<p><img src="docs/brand/pigway-logo.png" alt="PIGWay" width="96" height="96"></p>
|
|
|
|
# PIGWay Raspberry Pi Console Adapter
|
|
|
|
[简体中文](README.zh-CN.md) | English
|
|
|
|
An independently maintained Device Console adapter for the PIGWay Raspberry Pi Agent. It installs no extra process on the Pi and retains adapter ID `pigway-agent` for existing devices.
|
|
|
|
## Requirements and installation
|
|
|
|
The storage display and manual discovery integration requires Console v2.7.0 and Agent v3.11.1 or later. The shared UI semantics require Console v2.7.30. Runtime uses the Python standard library, JSON-RPC v1 and `console-ui-v1`.
|
|
|
|
Build the ZIP below, upload it under Machine management and enable it. Register the Agent API URL and device token. Use HTTPS or a trusted tunnel across untrusted networks. For local development, set `PIGWAY_ADAPTER_PATH` to this repository's absolute `plugin` directory. Production Docker installations keep installed plugins in the persistent Console data volume.
|
|
|
|
## Features and boundaries
|
|
|
|
- Host status, hardware integration, services/processes, network metrics and Console-managed history.
|
|
- Disk discovery runs only from Storage settings → Scan disks. Known disk capacity continues to refresh; display order, names and visibility use the shared Console settings.
|
|
- The adapter retains existing API and service identifiers, including `pigway-pi-control`; a repository rename does not change those interfaces. Other Linux platforms are outside its support claim.
|
|
|
|
Install only trusted plugins: frontend code shares the page JavaScript environment, and the backend process is not a security sandbox. The ZIP contains the manifest, worker, UI and LICENSE, not Console internals or Git metadata.
|
|
|
|
See [storage behavior](docs/STORAGE.md), [release notes](RELEASE_NOTES.md), and the [Console UI semantics](https://tea.pigway.com/way/pigway-device-console/src/branch/main/docs/UI_SEMANTICS.md). Dated deployment records describe historical validation, not a fresh online check.
|
|
|
|
## Build
|
|
|
|
Current adapter version: **1.6.12**.
|
|
|
|
```sh
|
|
mkdir -p dist
|
|
python3 package.py plugin dist/pigway-agent-1.6.12.zip
|
|
```
|
|
|
|
[Documentation](docs/README.md)
|