Getting Started - celsworth/lxp-bridge GitHub Wiki

Docker

The recommended way to use lxp-bridge is with Docker. Images are provided on Docker Hub.

the latest tag is the latest release. Note that we haven't hit v1.0 yet so every release is considered a pre-release and subject to breaking changes in subsequent releases. Normally you probably want to use this.
the dev tag is a build of the current HEAD. You should probably only use this if you want to test the very latest unreleased changes.

Create a config.yaml by copying config.yaml.example from this repo and editing it to taste. See Configuration.

Start the container, using one of the following

Either run docker directly with something like:

# this example mounts the config.yaml in the current directory into the container where lxp-bridge expects to find it.
docker run --init --rm --mount type=bind,source=${PWD}/config.yaml,target=/etc/config.yaml celsworth/lxp-bridge

Or there's a docker-compose.yaml.example if you prefer that.
[TODO: provide a systemd unit file to start with Docker?]

Compiling from source

If you're not a Docker fan, you can also compile it from source:

Install pre-requisites

sudo apt-get install pkg-config libssl-dev # or equivalent for your distribution

Install Rust

Build and "install" lxp-bridge:

git clone https://github.com/celsworth/lxp-bridge.git
cd lxp-bridge
cargo build
sudo cp target/debug/lxp-bridge /usr/local/bin/lxp-bridge

Edit /etc/lxp-bridge/config.yaml to suit your configuration; see Configuration. You can start by copying the example into the correct place:
```
sudo mkdir /etc/lxp-bridge
sudo cp config.yaml.example /etc/lxp-bridge/config.yaml
```

Use systemd/lxp-bridge.service to get it running:

sudo cp systemd/lxp-bridge.service /etc/systemd/system
sudo systemctl daemon-reload
sudo systemctl start lxp-bridge

Inverter Setup

lxp-bridge expects to be able to connect to your inverter over TCP. The first time you set this up you'll need to open a port for it. The process for this is described at Inverter Setup