62 lines
3.6 KiB
Markdown
62 lines
3.6 KiB
Markdown
# PIGWay Raspberry Pi Agent v3.11.3
|
|
|
|
[简体中文](README.zh-CN.md) | English
|
|
|
|
Disk discovery is manual: Device Console → System configuration → select the device → Storage settings → Scan disks. The inventory persists across restarts; known filesystem capacity updates weekly. Names and visibility belong to the Agent. See [deployment and validation](docs/STORAGE.md).
|
|
|
|
|
|
PIGWay Raspberry Pi Agent is a lightweight local monitoring service for Raspberry Pi. It monitors CPU, memory, temperature, disk, networking, services, processes, system health alerts, and journal events. Ethernet monitoring reads the negotiated link speed and can alert when it remains below the configured minimum. It has no embedded Web UI and does not require a hardware plugin or Device Console.
|
|
|
|
### Installation
|
|
|
|
See the [Trixie fresh-install guide](docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.md) for Raspberry Pi OS Lite 64-bit based on Debian 13. The Agent itself does not access GPIO or I2C; OLED, RGB, and fan control belong to the independent hardware plugin.
|
|
|
|
```bash
|
|
sudo ./install.sh
|
|
# Explicitly enable the API:
|
|
sudo ./install.sh --enable-api
|
|
# Keep the API disabled:
|
|
sudo ./install.sh --disable-api
|
|
```
|
|
|
|
Interactive installation asks whether to enable the remote API and defaults to no. Non-interactive installation also keeps it disabled unless explicitly enabled. `--no-start` only updates files and configuration; it does not change the current service state.
|
|
|
|
The configuration file is `/etc/pigway-pi-control.conf`. Restart the Agent after changing monitoring settings:
|
|
|
|
```bash
|
|
sudo systemctl restart pigway-pi-control.service
|
|
```
|
|
|
|
### Optional API
|
|
|
|
The default is `[api] enabled = false`, with no network listener. To use centralized management, enable it and configure the bind address and port, then run:
|
|
|
|
```bash
|
|
sudo systemctl enable --now pigway-pi-control-api.service
|
|
sudo cat /etc/pigway-pi-control-api.token
|
|
```
|
|
|
|
The default port is 6001. Every read and write request requires `Authorization: Bearer <token>`. The token belongs only to this device and is not printed directly by the installer. The API exposes health, status, logs, configuration, services, plugins, and plugin configuration under `/api/v1`. It does not serve a Web UI, register multiple machines, or proxy remote requests.
|
|
|
|
### Console and hardware plugins
|
|
|
|
- [PIGWay Device Console](https://tea.pigway.com/way/pigway-device-console) can run on a NAS or remote server for dashboards, configuration, and batch synchronization.
|
|
- [PIGWay Yahboom Cooling HAT](https://tea.pigway.com/way/pigway-yahboom-cooling-hat) independently provides local telemetry, OLED, fan control, and RGB effects.
|
|
|
|
The remote API and local plugin integration are independent. After enabling plugin integration, register `yahboom-cooling-hat = /run/pigway-plugins/yahboom-cooling-hat/api.sock` under `[plugins]` and restart the Agent, or attach it through the Console. Discovery never binds a plugin automatically. Pausing or disconnecting integration does not stop the plugin's local functions.
|
|
|
|
### Operations
|
|
|
|
```bash
|
|
sudo /usr/local/sbin/pigway-pi-control --diagnose
|
|
sudo journalctl -u pigway-pi-control.service -f
|
|
```
|
|
|
|
Logs follow the system journal retention policy; no additional database is created. Uninstalling one project never uninstalls either of the others. See [Plugin API v1](docs/HARDWARE_PLUGIN_API.md).
|
|
|
|
## Naming and compatibility
|
|
|
|
This project targets Raspberry Pi. Other Linux platforms are not covered by its support claim and may have separately maintained adapters. Repository naming does not change the existing `pigway-agent` adapter ID or `pigway-pi-control` service, configuration and API identifiers.
|
|
|
|
[Documentation](docs/README.md)
|