Getting Started
Install the required tools, set up your workspace, and build your first Moonforge image.
Moonforge is an open-source collection of Yocto layers and build tooling maintained by Igalia. It gives system integrators and product teams a production-ready starting point for building custom, immutable embedded Linux operating systems, without duplicating the integration work that every project ends up doing from scratch.
If you are new to Moonforge, work through the documentation in this order:
If you already have a working image and want to extend it, jump directly to Customize a Moonforge OS.
Before building a Moonforge image you will need:
kas 5.0 or later installed via pip:
pip install --user kas==5.0
Sufficient disk space. A first build typically requires around 100 GB for downloads and the shared-state cache. Subsequent builds reuse the cache and are much faster.
Layers are the building blocks of a Moonforge image. Each layer encapsulates a single feature: hardware support, containerisation, Over-the-air updates, a graphical session, and so on. Layers are designed to be composed freely; you include only what your product needs.
kas is the build orchestration tool Moonforge uses to manage layer composition and build configuration. Each Moonforge layer ships a kas YAML fragment that declares its own dependencies, so including a layer is as simple as adding one line to your kas configuration file.
kas-container wraps kas in a container, giving you a fully reproducible build environment that works the same on a developer laptop, a private CI runner, or a public cloud agent (GitHub Actions, GitLab CI, Bitbucket Pipelines).
meta-derivative shows the recommended pattern for your own product repository. It is a ready-to-use example of a thin downstream layer that references upstream Moonforge layers and adds your product-specific recipes, machine configuration, and distribution name. You can fork the meta-derivative repository and adapt it to your needs, or you can create your own if you prefer so.
Install the required tools, set up your workspace, and build your first Moonforge image.
A guide to the available Moonforge layers and how to compose them into an OS image.
Step-by-step guides for building and customising a Moonforge-based OS image.
Answers to common questions about what Moonforge is, how it compares to alternatives, and how to solve typical build and runtime issues.
Architecture, partition layout, and release policy for Moonforge.