DE GitHub
Navigation

Getting Started

openbridge server is an open-source, MIT-licensed multi-protocol server for building automation. It connects KNX, Modbus, MQTT, Home Assistant, ioBroker, and other systems through a unified REST API.

Prerequisites

To run openbridge server you need:

  • Docker and Docker Compose (recommended) or a native Linux environment
  • At least 512 MB RAM (1 GB recommended)
  • A network connection to your building automation devices

Installation with Docker Compose

The easiest way is to install via Docker Compose. Create a file called compose.yml with the following content:

services:
  openbridge:
    image: ghcr.io/abeggled/openbridgeserver:latest
    restart: unless-stopped
    ports:
      - "8080:8080"
    volumes:
      - ./config:/app/config
      - ./data:/app/data

Then start the server with:

docker compose up -d

Initial Configuration

Once started, the API is available at http://localhost:8080. The configuration files are located in the ./config directory.

Connecting KNX

To set up a KNX connection, add the following to your configuration:

knx:
  enabled: true
  host: 192.168.1.10   # IP address of your KNX IP router
  port: 3671

Connecting MQTT

mqtt:
  enabled: true
  broker: mqtt://192.168.1.5:1883
  topic_prefix: openbridge/

Next Steps

← Back to home