Getting Started
Install Zircon HA Proxy

Install Zircon HA Proxy

Install Zircon HA Proxy as Home Assistant Addon

At first you need to add Zircon3D Addon Repository:

Hello

Add a new repository with the following URL:

https://github.com/lichr/zircon-ha-repository

Then you should be able to see Zircon3D Addon in the list of available addons. Click it and install it.

Configure Zircon3D Addon

After installation complete, you can start the addon and check the options like this:

Hello

You need to:

  • Check the Start on boot, Watchdog, Auto Update and Show in sidebar options
    • After checking Show in sidebar, you can see Zircon3D Addon in the sidebar of Home Assistant
  • Click Start button to start the addon

Alternative Port

As normal HA addon you can access zircon-ha-proxy via ingress. zircon-ha-proxy also exposes port 11200 for direct access. You can access its management UI by http://homeassistant:11200 (opens in a new tab)

Install Zircon HA Proxy using Docker

Prerequisites:

Docker Compose Example

services:
  zircon-proxy:
    container_name: zircon-proxy
    image: lichr/zircon3d-ha-proxy-amd64:local
    environment:
      - ZIRCON_PROXY_MODE=service # important !
      - ZIRCON_PROXY_PORT=11200 # optional, default is 11200
      - ZIRCON_PROXY_LOG_LEVEL=info # optional, default is info
      - HA_API_URL=http://homeassistant:8123/api # change this if you run HA in same docker-compose file
      - HA_WS_URL=http://homeassistant:8123/api/websocket # see above
      - HA_ACCESS_TOKEN=YOUR_HA_ACCESS_TOKEN # long lived access token
    volumes:
      - YOUR_DATA_DIR:/data
    ports:
      - 11200:11200

Of cause you can run zirocn-ha-proxy side by side with Home Assistant in the same docker-compose file, just change http://homeassistant:8123 (opens in a new tab) for HA_API_URL and HA_WS_URL to HA's service name.

Visit Proxy UI

If zircon-ha-proxy is running, you can visit the UI by visiting http://localhost:11200 in your browser.

Create AccountUsing Zircon HA Proxy