Installation & Deployment

Share on: linkedin copy

Siphon is distributed as a highly optimized, multi-architecture Go binary packaged via ko. It can be deployed as an isolated Docker container or as a deeply integrated Home Assistant Add-on.

Running Siphon directly within Home Assistant OS provides automatic MQTT credential provisioning, Ingress UI access, and local entity polling via the SUPERVISOR_TOKEN.

  1. Navigate to your Home Assistant Add-on Store.
  2. Click the three dots in the top right and select Repositories.
  3. Add the MekOps Siphon repository URL: https://github.com/mekops-labs/siphon-ha-addon
  4. Install Siphon and start the Add-on.
  5. Click Open Web UI to access the embedded config editor.

Option B: Standalone Docker (DMZ / Edge)

For deploying Siphon on remote VPS nodes, Raspberry Pis, or isolated DMZ networks.

  1. Create a configuration file:
1mkdir -p /opt/siphon/config
2touch /opt/siphon/config/config.yaml
  1. Deploy via Docker Compose:
 1services:
 2  siphon:
 3    image: ghcr.io/mekops-labs/siphon:latest
 4    container_name: siphon
 5    command: ["/config/config.yaml"]
 6    volumes:
 7      - /opt/siphon/config:/config
 8    environment:
 9      - TZ=Europe/Warsaw
10      # API Keys can be passed as secure environment variables
11      - IOT_PLOTTER_API_KEY=your_secret_key
12    restart: unless-stopped