system-bridge

System Bridge

[!IMPORTANT] Any version 4 users will need to remove any integrations, and uninstall the old application before installing v5 to avoid conflicts. Your token and settings will not carry over to the new version.

A bridge for your systems.

[!NOTE] Contributions welcome! Feel free to submit a PR if you have any changes, fixes or improvements.

Features

• Supports Linux and Windows. MacOS is untested but can be compiled and tested by the community.
• Access your system information via data modules and the API/WebSocket server.
• Control your system via the API/WebSocket server.
• Integrated with Home Assistant

Installation

See installation documentation.

Optional dependencies

System Bridge reads most hardware metrics directly from the kernel, so these tools are not required. Installing them improves detection on some systems:

• Linux

  • pciutils (lspci): resolves friendly GPU model names. GPUs are still detected without it, but fall back to a generic name.
  • lm_sensors: helps expose the full set of temperature and fan sensors on some boards. Run sudo sensors-detect once to load the relevant modules.
  • nvidia-utils (nvidia-smi): required for NVIDIA GPU metrics. Intel and AMD GPUs use the kernel drm/hwmon interfaces and need nothing extra.

  Install with pacman (sudo pacman -S pciutils lm_sensors) or apt (sudo apt install pciutils lm-sensors).

• Windows / macOS: no optional tools are needed.

File Locations

• Linux settings/token: ~/.local/share/system-bridge/v5/
• Windows settings/token: %LOCALAPPDATA%\system-bridge\v5\
• macOS settings/token: ~/Library/Application Support/system-bridge/v5/
• Linux logs: ~/.local/state/system-bridge/YYYY-MM-DD.log
• Windows logs: %LOCALAPPDATA%\system-bridge\logs\YYYY-MM-DD.log
• macOS logs: ~/Library/Logs/system-bridge/YYYY-MM-DD.log

Development Setup

See the developing documentation for toolchain setup, build tasks, the pitchfork dev-server workflow, testing, and quality checks.

Quick start:

1. Install mise and run mise install
2. Run mise run deps then mise run build:all
3. Run mise run serve:all (Linux) or mise run run (all platforms)

Packages

Connector

Allows other applications to connect to the backend. For example, in the Home Assistant integration.