Installation

Installation

There are three ways to run this project. Pick one.

	Home Assistant integration	Home Assistant App	Docker Compose
Needs Docker	No	Supervisor manages it	Yes
Needs an MQTT broker	No	Yes	Yes
Configured via	HA config flow	Supervisor Options UI	Environment variables

All three need DNS redirection - that part is not optional for any of them.

Home Assistant integration (recommended)

Install via HACS as a custom repository:

1. HACS → ⋮ (top right) → Custom repositories
2. Add https://github.com/Proxy-alt/cync-lan, category Integration
3. Find "Cync LAN" in HACS and install it
4. Restart Home Assistant
5. Settings → Devices & Services → Add Integration → "Cync LAN"

Or copy custom_components/cync_lan into your Home Assistant config/custom_components/ directory by hand and restart.

You will need your Cync account email and password, and access to that inbox - Cync emails a one-time code during setup. You also need at least one mains-powered Wi-Fi ("Direct Connect") Cync device to bridge to the rest of the mesh.

Full details, all entity types and every configuration option are in the integration's README.

Home Assistant App (add-on)

The Docker/MQTT stack, packaged so Supervisor manages the container for you. See Proxy-alt/hass-addons.

Docker

Tip

Existing cync_mesh.yaml? Use it as-is: bind mount it into the container. (This applies to the Docker/MQTT path only - the Home Assistant integration stores its configuration in the config entry, not a YAML file.)

Pull the published image (easiest)

Multi-arch images (linux/amd64, linux/arm64) are published to GitHub Packages on every cync-lan-mqtt-vX.Y.Z release:

docker pull ghcr.io/proxy-alt/cync-lan-mqtt:latest

Pin a version instead of latest if you would rather upgrade deliberately: ghcr.io/proxy-alt/cync-lan-mqtt:0.2.1. latest only ever moves to a full release, never to a bN beta.

Note

linux/arm/v7 (32-bit ARM) is not published. Neither uvloop nor cffi ships an armv7l wheel, so the image cannot be built for it without bundling a full C/Rust toolchain. arm64 covers Raspberry Pi 3/4/5 on any 64-bit OS.

Or build it locally

• Clone the repo
• cd into the repo directory
• docker compose -f ./docker/Dockerfile build will output a ghcr.io/proxy-alt/cync-lan-mqtt:latest tagged image
• Copy the example docker-compose.yaml file and edit it for your setup.
• Set up env vars using the docker-compose environment section or uncomment the env_file option and create an .env file (See example)

Upgrading

• Rebuild the image (use no-cache for a clean build): docker compose -f ./docker/Dockerfile build --no-cache