Armbian Build Framework Quick Start Guide

Requirements

x86_64 / aarch64 machine
at least 2GB of memory and ~35GB of disk space for VM, container or bare metal installation
Armbian / Ubuntu Jammy 22.04.x for native building or any Docker capable Linux for containerised
Windows 10/11 with WSL2 subsystem running Armbian / Ubuntu Jammy 22.04.x
Superuser rights (configured sudo or root access).
Make sure your system is up-to-date! Outdated Docker binaries, for example, can cause trouble
Install git (apt-get -y -qq install git)

!!! danger Make sure that full path to the build script does not contain spaces.

Clone repository:

git clone --depth=1 --branch=main https://github.com/armbian/build  
cd build

Interactive

Run framework:

./compile.sh

graph LR
  A[./compile.sh] --> B{Change<br>kernel<br>config};
  B ---> |yes| C["HW"];
  B ---> |no| C["HW"];
  C ---> |branch| D["legacy<br>vendor<br>current<br>edge"];
  D --> |base| E["Debian<br>Ubuntu"];
  E ---> |type| F["CLI"];
  F ---> |type| G["Server"];
  F ---> |type| H["Minimal"];
  E ---> I["Desktop"];
  I ---> K["XFCE"];
  I ---> L["Gnome"];
  I ---> M["Cinammon"];
  I ---> N["KDE Neon"];

Video instructions: https://www.youtube.com/watch?v=kQcEFsXEJEE

CLI

Comprehensive list of build Options

Example:

./compile.sh build \
BOARD=uefi-x86 \
BRANCH=current \
BUILD_DESKTOP=yes \
BUILD_MINIMAL=no \
DESKTOP_APPGROUPS_SELECTED='browsers chat desktop_tools' \
DESKTOP_ENVIRONMENT=gnome \
DESKTOP_ENVIRONMENT_CONFIG_NAME=config_base \
KERNEL_CONFIGURE=no \
RELEASE=noble

!!! question "Interpretation?"

This command will generate **Ubuntu 24.04 Noble** based **Gnome desktop** environment image for Intel based hardware (**uefi-x86**). Besides bare desktop, it will contain packages from **browsers** and **desktop_tool** sections and it will use unchanged kernel from **current kernel** branch.

GitHub actions

If you do not own the proper equipment to build images on your own, you can use our GitHub action.

2.1 KiB Raw Blame History

Armbian Build Framework Quick Start Guide

Requirements

Interactive

CLI

GitHub actions

2.1 KiB

Raw Blame History