build Documentation

1. Project Overview & Quickstart (armbian/build) Copy Chapter

Purpose of This Repository Copy Chapter

The Armbian Linux Build Framework creates customizable OS images based on Debian or Ubuntu for single-board computers (SBCs) and embedded devices.

It builds a complete Linux system including kernel, bootloader, and root filesystem, giving you control over versions, configuration, firmware, device trees, and system optimizations.

The framework supports native, cross, and containerized builds for multiple architectures (x86_64, aarch64, armhf, riscv64) and is suitable for development, testing, production, or automation.

Looking for prebuilt images? Use Armbian Imager — the easiest way to download and flash Armbian to your SD card or USB drive. Available for Linux, macOS, and Windows.

Quick Start Copy Chapter

git clone https://github.com/armbian/build
cd build
./compile.sh

Build Host Requirements Copy Chapter

Hardware Copy Section

• RAM: ≥8GB (less with KERNEL_BTF=no)
• Disk: ~50GB free space
• Architecture: x86_64, aarch64, or riscv64

Operating System Copy Section

• Native builds: Armbian/Debian 13 (Trixie)
• Containerized: Any Docker-capable Linux
• Windows: WSL2 with Armbian/Debian 13 (Trixie)

Software Copy Section

• Superuser privileges (sudo or root)
• Up-to-date system (outdated Docker or other tools can cause failures)

Resources Copy Chapter

• Documentation — Comprehensive guides for building, configuring, and customizing
• Website — News, features, and board information
• Blog — Development updates and technical articles
• Forums — Community support and discussions

Contributing Copy Chapter

We welcome contributions! See CONTRIBUTING.md for guidelines on reporting issues, submitting changes, and contributing code.

Support Copy Chapter

Community Forums Copy Section

Get help from users and contributors on troubleshooting, configuration, and development.
👉 forum.armbian.com

Real-time Chat Copy Section

Join discussions with developers and community members on IRC or Discord.
👉 Community Chat

Paid Consultation Copy Section

For commercial projects, guaranteed response times, or advanced needs, paid support is available from Armbian maintainers.
👉 Contact us

Contributors Copy Chapter

Thank you to everyone who has contributed to Armbian!

Armbian Partners Copy Chapter

Our partnership program supports Armbian's development and community. Learn more about our Partners.

2. Official Technical Reference & Guides (armbian/armbian.github.io) Copy Chapter

Purpose of This Repository Copy Section

This repository acts as a central automation and orchestration hub for the Armbian project. It coordinates CI workflows, maintains metadata, syncs external data, and generates machine-readable output to power armbian.com, docs.armbian.com, and related services.

It also produces data exchange files used for automation, reporting, and content delivery across the Armbian infrastructure.

Workflow Status & Monitoring Copy Section

GitHub actions dashboard

Monitor all automation workflows with real-time status tracking:

• Execution history — Complete log of past workflow runs with timestamps and outcomes
• Performance metrics — Runtime duration, resource usage, and success/failure rates
• Live status — Current state of running CI/CD pipelines and scheduled tasks
• Debugging tools — Detailed logs and error traces for failed workflows