About Wheelhouse#

Wheelhouse OS is a bootable router image: VyOS underneath, and two programs on top of it — wheelhouse-agent, a Go control plane, and the React web UI the agent serves. The base is free software under the GPL and stays that way. The agent, the UI and the installer are proprietary and are licensed as a subscription. This section holds the paperwork that follows from that split: the licence, the corresponding source for the GPL parts, the third-party notices, the trademarks, what the router sends and where, how to report a vulnerability, what support exists, and what is and is not finished.

What this is, precisely#

Product	Wheelhouse — the agent, the web UI, the installer and the migration tooling
Wheelhouse OS	The bootable image: the above, installed on a self-built VyOS base
Current version	1.0.2
Licence of the parts Wheelhouse wrote	Proprietary. The Wheelhouse licence
Licence of the base	GPL-2.0, unmodified upstream. Built on VyOS
Published by	Not established. See the note below

One version number covers the whole product. The agent, the UI, the installer, the packaging and the image are built and released together from one tag.

The questions this section answers#

If you are asking	Read
What am I allowed to do with this software?	The Wheelhouse licence
What is it built on, and what did that give you?	Built on VyOS
How do I get the source for the GPL parts?	Corresponding source
What else is compiled into it, and under what terms?	Third-party licences
Whose names are these, and who is affiliated with whom?	Trademarks
What does the router send, to whom, and how do I stop it?	Privacy
I have found a security flaw. Where does it go?	Reporting a vulnerability
Something is broken. Who do I write to?	Support
Is this finished enough to trust with my network?	What is finished, and what is not
Is the thing I need planned?	Roadmap
What changed, and when?	Release history
Who wrote this documentation, and how do I report an error in it?	About this documentation

The same facts, on the router#

All of it is on the machine as well, readable from the console with no network:

Path	What is in it
`/usr/share/doc/wheelhouse-agent/copyright`	The Wheelhouse grant, and the full licence text of everything linked into the agent binary or bundled into the UI
`/usr/share/doc/wheelhouse-agent/README`	What the package is, the VyOS credit, and where the corresponding source is
`/usr/share/doc/wheelhouse/TERMS.txt`	The end-user terms, which say in their own first paragraph that they are a placeholder
`/usr/share/doc/wheelhouse/THIRD-PARTY.txt`	Where every licence on the machine is, and what is not third party
`/usr/share/doc/wheelhouse/SOURCE-OFFER.txt`	Where the corresponding source is: on this machine, in the release directory, and from Debian for the unmodified packages. Nothing has to be requested
`/usr/share/doc/wheelhouse/SOURCES.txt`	What this image was built from: the `vyos-build` commit, the container, the patches
`/usr/share/doc/<package>/copyright`	The licence of every installed package. Generated from the packages actually installed
`/usr/share/common-licenses/`	The full text of the GPL, LGPL, Apache and the rest, from Debian's `base-files`
`/var/lib/dpkg/status`	Every installed package and its exact version, which is what a source request needs

The last four are on a Wheelhouse OS image; the first two travel with the .deb wherever it is installed. On the image, show license prints the terms: /usr/share/vyos/EULA is a symlink to TERMS.txt.

The console banner above every login prompt carries the credit and the path:

  Wheelhouse 0.6.2 -- edge
  ==========================================================================
  Web UI:    https://192.0.2.1:8443  (eth1)
  Sign in:   with your Wheelhouse admin account
  Console:   wheelhouse, with the password chosen at install
             vyos is kept for recovery
  --------------------------------------------------------------------------
  Built on VyOS <version>
  Licences and corresponding source: /usr/share/doc/wheelhouse
  ==========================================================================

That is /etc/issue. The addresses, the host name and the two version strings come from the machine it is running on. The header line carries the Wheelhouse version and the host name; the base version below the rule is read from VYOS_VERSION in /etc/os-release. In the web UI, System → About shows the same set.

Attribution, in one paragraph#

Wheelhouse is built on VyOS, which is free software under the GNU General Public License, version 2, on a Debian base. The kernel, nftables, FRR, Kea, pdns-recursor, the VPN daemons and the container runtime are VyOS'; Wheelhouse adds the agent, the web UI, the installer and the app catalogue, which drive VyOS over its documented HTTP API and its op-mode commands as separate programs. The images are self-built from vyos-build and rebranded per upstream's trademark policy with attribution intact. The VyOS trademark is not ours, and no affiliation, endorsement or partnership exists. The whole of that is on Built on VyOS.