base on Armbian Linux build framework generates custom Debian or Ubuntu image for x86, aarch64, riscv64 & armhf <p align="center"> <a href="#build-framework"> <img src=".github/armbian-logo.png" alt="Armbian logo" width="144"> </a><br> <strong>Armbian Linux Build Framework</strong><br> <br> <a href=https://github.com/armbian/build/graphs/contributors><img alt="GitHub contributors" src="https://img.shields.io/github/contributors-anon/armbian/build?logo=stackexchange&label=Contributors&style=for-the-badge&branch=main&logoColor=white"></a> <a href=https://github.com/armbian/os><img alt="Artifacts generation" src="https://img.shields.io/github/actions/workflow/status/armbian/os/complete-artifact-matrix-all.yml?logo=dependabot&label=CI%20Build&style=for-the-badge&branch=main&logoColor=white"></a> <a href=https://github.com/armbian/build/commits/main><img alt="GitHub last commit (branch)" src="https://img.shields.io/github/last-commit/armbian/build/main?logo=github&label=Last%20commit&style=for-the-badge&branch=main&logoColor=white"></a> </p> ## What does this project do? - Builds custom **kernel**, **image** or a **distribution** optimized for low-resource hardware, - Include filesystem generation, low-level control software, kernel image and **bootloader** compilation, - Provides a **consistent user experience** by keeping system standards across different platforms. ## Getting started ### Requirements for self hosted - 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](https://github.com/armbian/sdk) for native building or any Docker capable Linux for containerised - Windows 10/11 with WSL2 subsystem running 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. For stable branch use `--branch=v24.11` ```bash apt-get -y install git git clone --depth=1 --branch=main https://github.com/armbian/build cd build ./compile.sh ``` <a href="#how-to-build-an-image-or-a-kernel"><img src=".github/README.gif" alt="Armbian logo" width="100%"></a> - Interactive graphical interface. - Prepares the workspace by installing the necessary dependencies and sources. - It guides the entire process and creates a kernel package or a ready-to-use SD card image. ### Build parameter examples Show work-in-progress areas in interactive mode: ```bash ./compile.sh EXPERT="yes" ``` Build minimal CLI Armbian Jammy for Bananapi M5 with LTS kernel: ```bash ./compile.sh \ BOARD=bananapim5 \ BRANCH=current \ RELEASE=jammy \ BUILD_MINIMAL=yes \ BUILD_DESKTOP=no \ KERNEL_CONFIGURE=no ``` Build with GitHub actions: ([advanced version](https://github.com/armbian/os/blob/main/.github/workflows/complete-artifact-one-by-one.yml)) ``` name: "Build Armbian" on: workflow_dispatch: jobs: build-armbian: runs-on: ubuntu-latest steps: - uses: armbian/build@main with: armbian_token: "${{ secrets.GITHUB_TOKEN }}" # GitHub token armbian_release: "jammy" # userspace armbian_target: "build" # build=image, kernel=kernel armbian_board: "bananapim5" # build target ``` Generated image will be uploaded to your repository release. Note: GitHub upload file limit is 2Gb. ## More information: - [Building Armbian](https://docs.armbian.com/Developer-Guide_Build-Preparation/) (how to start) - [Build commands](https://docs.armbian.com/Developer-Guide_Build-Commands/) and [switches](https://docs.armbian.com/Developer-Guide_Build-Switches/) (build options) - [User configuration](https://docs.armbian.com/Developer-Guide_User-Configurations/) (how to add packages, patches, and override sources config) - [System config](https://docs.armbian.com/User-Guide_Armbian-Config/) (menu driven utility to setup OS and HW features) ## Download prebuilt images releases ### Point - [manually released **standard supported** builds](https://www.armbian.com/download/?device_support=Standard%20support) (quarterly) ### Rolling - [automatically released **staging and standard supported** builds](https://github.com/armbian/os/releases/latest) (daily) - [automatically released **community maintained** builds](https://github.com/armbian/community/releases/latest) (weekly) ## Compared with industry standards <details><summary>Expand</summary> Check similarities, advantages and disadvantages compared with leading industry standard build software. Function | Armbian | Yocto | Buildroot | |:--|:--|:--|:--| | Target | general purpose | embedded | embedded / IOT | | U-boot and kernel | compiled from sources | compiled from sources | compiled from sources | | Board support maintenance &nbsp; | complete | outside | outside | | Root file system | Debian or Ubuntu based| custom | custom | | Package manager | APT | any | none | | Configurability | limited | large | large | | Initramfs support | yes | yes | yes | | Getting started | quick | very slow | slow | | Cross compilation | yes | yes | yes | </details> ## Project structure <details><summary>Expand</summary> ```text ├── cache Work / cache directory │   ├── aptcache Packages │   ├── ccache C/C++ compiler │   ├── docker Docker last pull │   ├── git-bare Minimal Git │   ├── git-bundles Full Git │   ├── initrd Ram disk │   ├── memoize Git status │   ├── patch Kernel drivers patch │   ├── pip Python │   ├── rootfs Compressed userspaces │   ├── sources Kernel, u-boot and other sources │   ├── tools Additional tools like ORAS │   └── utility ├── config Packages repository configurations │   ├── targets.conf Board build target configuration │   ├── boards Board configurations │   ├── bootenv Initial boot loaders environments per family │   ├── bootscripts Initial Boot loaders scripts per family │   ├── cli CLI packages configurations per distribution │   ├── desktop Desktop packages configurations per distribution │   ├── distributions Distributions settings │   ├── kernel Kernel build configurations per family │   ├── sources Kernel and u-boot sources locations and scripts │   ├── templates User configuration templates which populate userpatches │   └── torrents External compiler and rootfs cache torrents ├── extensions Extend build system with specific functionality ├── lib Main build framework libraries │   ├── functions │   │   ├── artifacts │   │   ├── bsp │   │   ├── cli │   │   ├── compilation │   │   ├── configuration │   │   ├── general │   │   ├── host │   │   ├── image │   │   ├── logging │   │   ├── main │   │   └── rootfs │   └── tools ├── output Build artifact │   └── deb Deb packages │   └── images Bootable images - RAW or compressed │   └── debug Patch and build logs │   └── config Kernel configuration export location │   └── patch Created patches location ├── packages Support scripts, binary blobs, packages │   ├── blobs Wallpapers, various configs, closed source bootloaders │   ├── bsp-cli Automatically added to armbian-bsp-cli package │   ├── bsp-desktop Automatically added to armbian-bsp-desktopo package │   ├── bsp Scripts and configs overlay for rootfs │   └── extras-buildpkgs Optional compilation and packaging engine ├── patch Collection of patches │   ├── atf ARM trusted firmware │   ├── kernel Linux kernel patches | |   └── family-branch Per kernel family and branch │   ├── misc Linux kernel packaging patches │   └── u-boot Universal boot loader patches | ├── u-boot-board For specific board |    └── u-boot-family For entire kernel family ├── tools Tools for dealing with kernel patches and configs └── userpatches User: configuration patching area ├── lib.config User: framework common config/override file ├── config-default.conf User: default user config file ├── customize-image.sh User: script will execute just before closing the image    ├── atf User: ARM trusted firmware    ├── kernel User: Linux kernel per kernel family    ├── misc User: various    └── u-boot User: universal boot loader patches ``` </details> ## Contribution ### Want to help? We always need those volunteering positions: - [Code reviewer](https://forum.armbian.com/staffapplications/application/23-code-reviewer/) - [Build framework maintainer](https://forum.armbian.com/staffapplications/application/9-build-framework-maintainer/) - [Test Automation Engineer](https://forum.armbian.com/staffapplications/application/19-test-automation-engineer/) Just apply and follow! ## Support For commercial or prioritized assistance: - Book an hour of [professional consultation](https://calendly.com/armbian/consultation) - Consider becoming a [project partner](https://forum.armbian.com/subscriptions/) - [Contact us](https://armbian.com/contact)! Free support: Find free support via [general project search engine](https://www.armbian.com/search), [documentation](https://docs.armbian.com), [community forums](https://forum.armbian.com/) or [IRC/Discord](https://docs.armbian.com/Community_IRC/). Remember that our awesome community members mainly provide this in a **best-effort** manner, so there are no guaranteed solutions. ## Contact - [Forums](https://forum.armbian.com) for Participate in Armbian - IRC: `#armbian` on Libera.chat / oftc.net - Matrix: [https://forum.armbian.com/topic/40413-enter-the-matrix/](https://forum.armbian.com/topic/40413-enter-the-matrix/) - Discord: [https://discord.gg/armbian](https://discord.gg/armbian) - Follow [@armbian](https://twitter.com/armbian) on 𝕏 (formerly known as Twitter), <a rel="me" href="https://fosstodon.org/@armbian">Mastodon</a> or [LinkedIn](https://www.linkedin.com/company/armbian). - Bugs: [issues](https://github.com/armbian/build/issues) / [JIRA](https://armbian.atlassian.net/jira/dashboards/10000) - Office hours: [Wednesday, 12 midday, 18 afternoon, CET](https://calendly.com/armbian/office-hours) ## Contributors Thank you to all the people who already contributed to Armbian! <a href="https://github.com/armbian/build/graphs/contributors"> <img src="https://contrib.rocks/image?repo=armbian/build" /> </a> ### Also - [Current and past contributors](https://github.com/armbian/build/graphs/contributors), our families and friends. - [Support staff](https://forum.armbian.com/members/2-moderators/) that keeps forums usable. - [Friends and individuals](https://armbian.com/authors) who support us with resources and their time. - [The Armbian Community](https://forum.armbian.com/) helps with their ideas, reports and [donations](https://www.armbian.com/donate). ## Armbian Partners Armbian's partnership program helps to support Armbian and the Armbian community! Please take a moment to familiarize yourself with our Partners: - [Click here to visit our Partners page!](https://armbian.com/partners) - [How can I become a Partner?](https://forum.armbian.com/subscriptions) ## Star History [](https://star-history.com/#armbian/build&Date) ## License This software is published under the GPL-2.0 License license. ", Assign "at most 3 tags" to the expected json: {"id":"11893","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"