https://github.com/timmo001/system-bridge
A bridge for your systems
https://github.com/timmo001/system-bridge
contributions-welcome nextjs python typescript
Last synced: about 1 month ago
JSON representation
A bridge for your systems
- Host: GitHub
- URL: https://github.com/timmo001/system-bridge
- Owner: timmo001
- License: apache-2.0
- Created: 2021-02-08T10:49:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-05-07T12:59:36.000Z (about 1 month ago)
- Last Synced: 2025-05-07T13:50:06.537Z (about 1 month ago)
- Topics: contributions-welcome, nextjs, python, typescript
- Language: Go
- Homepage: https://system-bridge.timmo.dev
- Size: 27.8 MB
- Stars: 296
- Watchers: 6
- Forks: 17
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# System Bridge
> [!NOTE]
> This project is currently going through a [rebuild in go](https://github.com/timmo001/system-bridge/issues/3392).
> If you would like to try the new version, you should use the [development instructions](https://github.com/timmo001/system-bridge?tab=readme-ov-file#development-setup).
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](https://www.home-assistant.io/integrations/system_bridge)
## System Requirements
> [!WARNING]
> The following documentation is for version 5.0.0 and
> above which is currently in development.
### Linux
#### Arch Linux
Install the following packages:
```zsh
sudo pacman -S inetutils wlr-randr
```
#### Debian/Ubuntu (Not verified)
Install the following packages:
```zsh
sudo apt install inetutils-tools wlr-randr
```
#### Fedora (Not verified)
Install the following packages:
```zsh
sudo dnf install inetutils wlr-randr
```
## Installation
Download the latest release from the [releases page](https://github.com/timmo001/system-bridge/releases).
### Linux installation
Install the package for your distribution's package manager.
### Windows installation
Run the setup executable to install the application.
## Running
> [!WARNING]
> The following documentation is for version 5.0.0 and
> above which is currently in development.
1. To run the backend server:
```bash
system-bridge backend
```
### Running as a Service
#### Linux (systemd)
> [!WARNING]
> Not supported with AppImage or Flatpak.
> You will need to configure the service
> manually to the correct path.
1. Copy the systemd service file to the systemd directory:
```bash
sudo cp .scripts/linux/system-bridge.service /etc/systemd/system/
```
2. Reload systemd daemon:
```bash
sudo systemctl daemon-reload
```
3. Enable the service to start on boot:
```bash
sudo systemctl enable system-bridge
```
4. Start the service:
```bash
sudo systemctl start system-bridge
```
5. Check the service status:
```bash
sudo systemctl status system-bridge
```
#### Windows (service installation)
1. Open PowerShell as Administrator
2. Navigate to the directory containing the installation scripts
3. Run the installation script:
```powershell
.\scripts\windows\install-service.ps1
```
4. To uninstall the service:
```powershell
.\scripts\windows\uninstall-service.ps1
```
## Development Setup
1. Install go
1. Set up your go workspace and make sure that your `GOPATH` is set correctly.
```zsh
export GOPATH=$HOME/go
export PATH=$PATH:/usr/local/go/bin:$GOPATH/bin
```
## Build and Install
1. Clone this repo
1. Run `go build`
1. Run `go install`
## Packages
### [Connector](https://github.com/timmo001/system-bridge-connector)
Allows other applications to connect to the backend. For example, in the
[Home Assistant](https://www.home-assistant.io/integrations/system_bridge)
integration.