SPEEDBIRD

Install on Linux & Raspberry Pi#

SpeedBird-VM and SpeedBird-PI install from the same package. It sets up SPEEDBIRD as a system service with its web UI on HTTPS.

Supported
Linux Debian 12+, Ubuntu 22.04+
Raspberry Pi Raspberry Pi OS 64-bit
CPU amd64, arm64

Quick install#

Linux · Raspberry Pi$ curl -fsSL https://speedbird.io/install.sh | sudo bash

The script detects your system, downloads the latest release, checks its SHA-256 and installs the .deb package. Want to read it first? Open install.sh.

Add options after bash -s --:

curl -fsSL https://speedbird.io/install.sh | sudo bash -s -- --without-pat --no-start
Option Effect
--without-pat Don't install the bundled Pat Winlink client
--no-start Install, but don't start the service
--offline-only Use only the bundled Python wheels, never PyPI
--skip-geodata Skip geodata
--tarball Install from the .tar.gz bundle instead of the .deb
--dry-run Download and verify only; install nothing

Manual install#

Download a package from Downloads, then install it one of two ways.

.deb package

sudo apt install ./speedbird_<version>_all.deb

Options are passed as environment variables:

sudo SPEEDBIRD_INSTALL_PAT=0 apt install ./speedbird_<version>_all.deb

.tar.gz bundle

tar xzf speedbird-<version>.tar.gz
cd speedbird-<version>
sudo ./install.sh
install.sh option .deb environment variable Effect
--without-pat SPEEDBIRD_INSTALL_PAT=0 Skip the bundled Pat Winlink client
--no-start SPEEDBIRD_NO_START=1 Don't start the service after install
--offline-only SPEEDBIRD_OFFLINE_ONLY=1 Bundled wheels only, never PyPI
--skip-geodata SPEEDBIRD_SKIP_GEODATA=1 Skip geodata
--prefix DIR Install somewhere other than /opt/SPEEDBIRD
--force Reinstall over an existing install

What gets installed#

Path / unit What it is
/opt/SPEEDBIRD/.venv Python environment, built from the bundled wheels
speedbird user System user the service runs as
/etc/speedbird/speedbird.yaml Configuration, created only if it doesn't exist
/etc/speedbird/tls/ Self-signed TLS certificate for the web UI
/var/lib/speedbird/ State: radios, modems, channel plan, logs
speedbird.service The SPEEDBIRD service, HTTPS on port 443
/usr/local/bin/pat, pat-speedbird.service Pat, the Winlink client (see below)

The install is offline for the Python versions and CPU architectures the bundle has wheels for. Other Python versions fetch the missing packages from PyPI.

Pat (MIT licence) is a separate program, bundled under third_party/pat. It's skipped if an equal or newer Pat is already installed (for example /usr/bin/pat), or if you pass --without-pat. Its licence ships in third_party/pat/LICENSE and THIRD-PARTY-NOTICES.txt.

After installing#

  1. Set your callsign. Edit /etc/speedbird/speedbird.yaml and set station.callsign. Nothing transmits as N0CALL.

    bash sudo nano /etc/speedbird/speedbird.yaml sudo systemctl restart speedbird

  2. Open the web UI at https://<host>/. Your browser will warn about the self-signed certificate.

  3. Add your radios and make a first contact: see the quick start.

Warning: the web UI has no authentication yet. Keep it on a trusted network.

Manage#

Task Command
Status systemctl status speedbird
Live logs journalctl -u speedbird -f
Restart sudo systemctl restart speedbird
Update Run the quick install again
Remove (.deb) sudo apt remove speedbird
Remove everything sudo apt purge speedbird deletes /etc/speedbird too. /var/lib/speedbird is kept.