XKNX Editor — Unraid

Run the XKNX Editor in your browser on an Unraid server. The editor opens, imports and exports KNX projects, browses the product catalog, and can commission devices on a KNXnet/IP gateway. The template xknx-editor.xml runs the ghcr.io/xknx/xknx-editor-web image described in docker/README.md.

Install

From Community Applications: open Apps, search for XKNX Editor, select it and click Install. Set the password and the folders (below), then Apply.

Without Community Applications, copy xknx-editor.xml to /boot/config/plugins/dockerMan/templates-user/my-XKNX-Editor.xml on the server, then choose Docker -> Add Container and select XKNX-Editor as the template.

Open the container's WebUI and sign in with the password.

Settings

The web UI is reachable from the whole network and can program the installation, so choose a strong password and don't expose the port to the internet. To reach projects and exports from other computers, point Projects to a share, e.g. /mnt/user/knx.

With PUID and PGID, the files the editor saves belong to nobody:users like other files on the shares, so they can be changed and deleted from other computers. At start, the container hands App Data to that user, and Projects too while it is empty. A Projects folder that already holds files keeps its owner; if the editor can't write to it, the container log says so, and Tools -> New Permissions on its share fixes it.

KNX bus access

Tunnelling to a gateway by its IP address works with the default Bridge network. Gateway auto-discovery and KNX routing use multicast, which a bridged container does not receive: set Network Type to Host if you need those. The web UI then uses port 8080 of the server directly.

Offline project editing, import and export need no bus access at all.

Signing-key extraction (optional)

Exporting a project that other tools accept as signed needs a key extracted from an installation of the KNX authoring tool you own. The key itself is never shipped. In the editor, open Signing, then either upload Knx.Ets.XmlSigning.dll straight from your computer (the dialog's Upload button, or drag-and-drop) or pick it from the file list after copying it into the Projects folder. Include its sibling assemblies so dependencies resolve.

Updates

The container uses the latest tag, so Check for Updates on the Docker tab pulls each new release. The template itself updates from this repository, so changed settings show up on the next edit of the container.

The template is based on the one Bjoern3003 wrote in Bjoern3003/xknx-editor-unraid.