About Wheelhouse#
Wheelhouse OS is a bootable router image: VyOS underneath, and two
programs on top that we wrote — 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 | 0.5.1 — agent/main.go, ui/src/components/product.ts |
| Licence of the parts we wrote | Proprietary. The Wheelhouse licence |
| Licence of the base | GPL-2.0, unmodified upstream. Built on VyOS |
| Published by | <TODO: owner> |
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 —
CHANGELOG.md.
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#
None of this lives only on a website. A customer holding the box and no network can read all of it from the machine:
| 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 — packaging/copyright |
/usr/share/doc/wheelhouse-agent/README | What the package is, the VyOS credit, and where the corresponding source is — packaging/build-deb.py |
/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 | The written offer for the corresponding source, and three ways to take it up |
/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, so it cannot drift |
/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, because
/usr/share/vyos/EULA is a symlink to TERMS.txt —
packaging/iso/branding/50-wheelhouse-brand.chroot.
The console banner above every login prompt carries the credit and the path:
Wheelhouse 0.5.1 -- edge
==========================================================================
Web UI: https://192.0.2.1:8443 (eth1)
Sign in: with your Wheelhouse admin account
Console: vyos, with the password chosen at install
--------------------------------------------------------------------------
Built on VyOS <version>
Licences and source offer: /usr/share/doc/wheelhouse
==========================================================================That is packaging/console-banner.sh rendering
/etc/issue; the addresses, the host name and the two version strings come from the
machine it is running on. In the web UI, System → About shows the same set —
ui/src/components/AboutPage.tsx.
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, with
the file that proves each clause, is on Built on VyOS.
See also#
- What is finished, and what is not — the honest inventory, before you commit a network to this.
- Privacy — the one unprompted request the router makes, field by field.
- Wheelhouse and VyOS — the same split, explained as a concept rather than as attribution.
- What the licence gates — what a key does and does not unlock.
- Getting started — installing and signing in.
- The product site — what Wheelhouse is for, and what it costs.
Checked against#
README.md ·
packaging/copyright ·
packaging/build-deb.py ·
packaging/console-banner.sh ·
packaging/iso/branding/doc/THIRD-PARTY.txt ·
packaging/iso/branding/50-wheelhouse-brand.chroot ·
agent/main.go ·
ui/src/components/product.ts ·
ui/src/components/AboutPage.tsx