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.

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

1. Install mise
2. Run mise install in the repo root to install the pinned Go, Node, and pnpm toolchains.

mise.toml is the source of truth for local and CI runtimes.

Build and Install

1. Clone this repo
2. Run make build

Packages

Connector

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