Getting started

Prepare the build computerCopy Anchor Link

Use an x86_64 Linux computer with Git, Make, Nix with flakes enabled, and stable Rust/Cargo with a C build toolchain. You need internet access to fetch build inputs, sudo access to write the USB, and space for the build store and image on a different disk from the USB you will erase.

Use a USB drive with at least 64 GB of capacity and good read/write performance, especially for small files. In the current test setup, the system runs from the USB drive, so its speed affects responsiveness.

Clone the source and fetch its pinned machine configuration:

git clone https://github.com/airlockos-org/airlockos.git
cd airlockos
git config submodule.airlock-machine.url https://github.com/airlockos-org/airlockos-machine.git
git submodule update --init --recursive

Choose a persistent build directory. Replace the example path with your own:

export AIRLOCK_DATA_ROOT=/absolute/path/to/airlock-build-data

Build and write the USBCopy Anchor Link

Connect the USB drive and identify its serial number:

lsblk -o NAME,TRAN,SIZE,MODEL,SERIAL,MOUNTPOINTS

The next command erases the selected USB drive. Check its model, capacity, and serial before proceeding. Replace YOUR_USB_SERIAL with its exact serial:

make usb-dev-install USB_SERIAL=YOUR_USB_SERIAL

Run this as your normal user and keep the USB connected. The command prompts for sudo authentication and a dom0 password, builds the image, and writes it to the selected drive after the build succeeds. Wait for it to finish before safely ejecting the USB.

For more information, see the repository's image instructions.

Boot and sign inCopy Anchor Link

Connect the USB to the target computer and select it from the UEFI boot menu. Choose the normal graphical Airlock OS entry. Airlock OS runs from the USB; keep it connected while the system is running.

At the GNOME login screen, sign in as user with the development password password. This is separate from the dom0 password chosen during preparation.