Armbian Build Framework Quick Start Guide¶
Requirements¶
- x86_64 / aarch64 / riscv64 machine
- at least 4GB of memory and ~50GB 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
Clone repository¶
Note
- Make sure that full path to the build script does not contain spaces
- For stable branch use last point release
--branch=v24.11
gitGraph
commit
commit
checkout main
commit id: "v24.08" tag: "v24.08"
branch v24.08
commit
commit
commit
commit
checkout main
commit id: "v24.11" tag: "v24.11"
branch v24.11
commit
commit
commit
commit
checkout main
commit
commit
commit
commit
commit
commit
commit id: "main" type: REVERSE tag: "Trunk"
Interactive¶
Run framework:
Bash | |
---|---|
Video
CLI¶
Comprehensive list of build Commands and Switches
Example:
Bash | |
---|---|
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.
Logging¶
Logs are written to output/logs. Old logs (all but the current build) are compressed and moved to output/logs/archive.
Log formats are:
- ANSI - text with ANSI escapes for color coding - *.log.ans
- ASCII (if ansi2txt is available) - text without color coding escapes - *.log
- Markdown summary - *.md
- Raw (if RAW_LOG=yes) - tar file containg all the raw logs - *.raw.tar
For much more verbose logs set switch ‘DEBUG=yes’.
GitHub actions¶
If you do not own the proper equipment to build images on your own, you can use our GitHub action.