diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1e232bf --- /dev/null +++ b/LICENSE @@ -0,0 +1,25 @@ +BSD 2-Clause License + +Copyright (c) 2026, Matthias Berner +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index 6d52a31..d77fbee 100644 --- a/README.md +++ b/README.md @@ -135,6 +135,29 @@ tools/build-package.sh packaging state/ log/ backup/ runtime data (never shipped, never overwritten by updates) ``` +## Licences and attribution + +Our code is **BSD-2-Clause** (`LICENSE`). The extension only *drives* third-party +software; it does not ship it: + +| Component | Licence | bundled? | +|---|---|---| +| vm-bhyve | BSD-2-Clause | only if a `vendor/` build is used | +| bhyve, nmdm | BSD-2-Clause (FreeBSD base) | no | +| noVNC | MPL-2.0 | no (`pkg install novnc`) | +| websockify | LGPL-3.0 | no (`pkg install py312-websockify`) | +| ttyd | MIT | only in a `vendor/` build | +| edk2-bhyve | BSD-3-Clause | only in a `vendor/` build | +| grub2-bhyve | **GPL-3.0** | only in a `vendor/` build — see `THIRD-PARTY.md` | + +The release package built by the workflow contains **no** third-party binaries, +so there is nothing to redistribute. `tools/build-package.sh --with-vendor` +exists for embedded systems and ships licence files alongside; using it means +you are redistributing those binaries and must honour their terms (notably +GPL-3.0 for grub2-bhyve: source or written offer). + +Details and consequences: [`THIRD-PARTY.md`](THIRD-PARTY.md). + ## Uninstall ```sh diff --git a/THIRD-PARTY.md b/THIRD-PARTY.md new file mode 100644 index 0000000..c87d963 --- /dev/null +++ b/THIRD-PARTY.md @@ -0,0 +1,39 @@ +# Third-party software + +This extension is a management layer. It **does not ship** the third-party +programs it drives: `vm-bhyve`, `bhyve`, noVNC, websockify and ttyd are used at +runtime from the operating system (FreeBSD packages, base system) or from the +`vendor/` tree of the *installed* extension on systems that have no package for +them. + +The repository and the release package contain only our own code, so the +licences below apply to "use", not to "redistribution". If you redistribute a +build that includes `vendor/` binaries (`tools/build-package.sh --with-vendor`), +the obligations of the respective licence apply to you. + +| Component | Used as | Licence | Notes | +|---|---|---|---| +| **vm-bhyve** | CLI (`/usr/local/sbin/vm`, libs) | BSD-2-Clause | optional bundled copy in `vendor/vm-bhyve` | +| **bhyve / bhyvectl / nmdm** | FreeBSD base system | BSD-2-Clause | never bundled | +| **noVNC** | static web client (`pkg install novnc`) | MPL-2.0 | not bundled; file-level copyleft if modified | +| **websockify** | WebSocket ↔ VNC bridge (`pkg install py312-websockify`) | LGPL-3.0 | not bundled; dynamic use, no linking of our code | +| **ttyd** | serial console web terminal | MIT | optional bundled copy in `vendor/ttyd` | +| **edk2-bhyve** | UEFI firmware for guests (`pkg install edk2-bhyve`) | BSD-3-Clause | optional bundled copy in `vendor/edk2-bhyve` | +| **grub2-bhyve** | BIOS/GRUB loader for guests | **GPL-3.0** | bundled only if `vendor/` is shipped — then you must provide the corresponding source and licence texts | +| **XigmaNAS** | host platform (this extension runs inside it) | BSD-2-Clause | separate project | + +## Consequences for publishing + +- Plain release (no `vendor/`): nothing to do beyond this notice. The user + installs the packages themselves; their licences are accepted through `pkg`. +- Release with bundled binaries: ship the licence text of every bundled + component next to the binary (`vendor//LICENSE`), and for + `grub2-bhyve` (GPL-3.0) also provide the source or a written offer. +- Do not link our code against LGPL/MPL/GPL components; we call them as + separate programs, which keeps our BSD-2-Clause licensing valid. +- Names and trademarks (XigmaNAS, FreeBSD, noVNC, GRUB) are used descriptively; + there is no endorsement by those projects. + +## Our own licence + +`LICENSE` — BSD-2-Clause. Keep the copyright line in derived versions. diff --git a/tools/build-package.sh b/tools/build-package.sh index c73ed85..c664f6d 100755 --- a/tools/build-package.sh +++ b/tools/build-package.sh @@ -1,8 +1,13 @@ #!/bin/sh # build-package.sh - create the distributable extension tarball. # -# Usage: tools/build-package.sh [--version ] +# Usage: tools/build-package.sh [--version ] [--with-vendor] +# # Output: dist/vmmngr-.tar.gz (+ .sha256) +# +# By default no third-party binaries are shipped (see THIRD-PARTY.md). +# --with-vendor bundles vendor/ for systems without packages - then you are +# redistributing those binaries and must honour their licences. set -eu @@ -10,30 +15,41 @@ ROOT=$(cd "$(dirname "$0")/.." && pwd -P) cd "${ROOT}" VERSION=$(cat version.txt 2>/dev/null | tr -d '\n') -if [ "${1:-}" = "--version" ]; then - VERSION="$2" -fi +WITH_VENDOR=0 + +while [ $# -gt 0 ]; do + case "$1" in + --version) VERSION="$2"; shift 2 ;; + --with-vendor) WITH_VENDOR=1; shift ;; + *) echo "unknown option: $1" >&2; exit 2 ;; + esac +done + [ -n "${VERSION}" ] || { echo "version.txt missing or empty" >&2; exit 1; } NAME="vmmngr-${VERSION}" STAGE="dist/${NAME}" rm -rf "${STAGE}" + mkdir -p "${STAGE}" dist -# code and metadata (state/log/backup are runtime data and never shipped) +# our code and documentation cp -R bin gui templates "${STAGE}/" -cp vmm-init version.txt README.md CHANGELOG.md "${STAGE}/" 2>/dev/null || true -[ -f LICENSE ] && cp LICENSE "${STAGE}/" +cp vmm-init version.txt README.md CHANGELOG.md THIRD-PARTY.md LICENSE "${STAGE}/" -# bundled binaries (only when present) -if [ -d vendor ]; then +if [ "${WITH_VENDOR}" -eq 1 ] && [ -d vendor ]; then mkdir -p "${STAGE}/vendor" for d in vendor/*/; do [ -d "$d" ] || continue cp -R "$d" "${STAGE}/vendor/" + # ship the licence text next to the binary it covers + for lic in "$d"LICENSE* "$d"COPYING* "$d"license*; do + [ -e "${lic}" ] && cp "${lic}" "${STAGE}/vendor/" 2>/dev/null || true + done done find "${STAGE}/vendor" -name '.gitkeep' -delete + echo "NOTE: vendor/ bundled - third-party licences apply (see THIRD-PARTY.md)" fi find "${STAGE}" -name '.gitignore' -delete