README.md

April 4, 2026 · View on GitHub

Logo

AurixOS

Report a Bug · Request a Feature . Ask a Question

Project license Discord Chat OpenCollective

Table of Contents

About

AurixOS is a general-purpose operating system, meant to take security, performance and usability to the next level.

Getting Started

Latest official releases of AurixOS are available for download here.

Prerequisites

If you have Homebrew installed, simply run brew bundle to install all required build dependencies (incl. packages to build AurixOS for every supported architecture). Alternatively, read the Brewfile in the root of this repository and install the required (and optional) packages manually.

Building

To build AurixOS, simply run make in the root directory of this repository. To change the build target, run make ARCH=arch PLATFORM=platform, where arch is the target architecture, and platform is the target platform (Default is set to x86_64/generic-pc).

Building with Docker

You can also invoke any build target through Docker by adding DOCKER_BUILD=y:

make DOCKER_BUILD=y livecd

This is especially useful for running QEMU with UEFI on the host while building the image in a container:

make DOCKER_BUILD=y run-uefi

Build the image once:

docker build -t aurix-build .

Then build AurixOS (artifacts land in your local build/, sysroot/, release/):

docker run --rm -it \
  -v "$PWD:/src" -w /src \
  --user "$(id -u):$(id -g)" \
  aurix-build make CONFIG_USE_HOSTTOOLCHAIN=y livecd

Possible/planned targets:

i686 / x86_64
  • generic-pc
arm32 (not available yet)
  • raspi2
aarch64
  • raspi3 (not available yet)
  • raspi4 (limited support)
  • raspi5 (not available yet)

Note


On x86(_64) architectures, a UEFI bootloader will be automatically built and packaged together together with a legacy stub. On arm32 and aarch64, invoke Make with NOUEFI=n modifier to create a UEFI-capable image.

Inputting an invalid architecture/platform combination will result in an error.

Building AurixOS images is also supported with Make recipes:

  • livecd builds a CD-ROM image (.iso)
  • livehdd builds a HDD image (.img)
  • livesd builds an SD Card image (.img)

Please note that not all bootable images can be created for all platforms (eg. rpi4 only supports creating an SD Card image). Any attempt at creating an unsupported image will result in an error.

All generated images reside in the release/ directory and follow this naming scheme: aurixos-live[MEDIA]-[GIT_REV]_[ARCH]-[PLATFORM].iso

make help shows you all available build options

Running

To run AurixOS on QEMU, run make run (optionally, append ARCH=arch PLATFORM=platform if you're building/running AurixOS on an architecture other than x86_64).

Alternatively, you can boot AurixOS on a physical machine by running dd if=release/<usb-image>.img of=/dev/<target USB drive> bs=1M and booting off of this USB drive.

Developer Docs

Userland credits

Support

If you have any questions, feel free to open an issue on our Git instance. Alternatively, you can visit us:

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

For a full list of all authors and contributors, see the contributors page.

Security

AurixOS follows good practices of security, but 100% security cannot be assured. AurixOS is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

Screenshots

(Current state) March 14th, 2026

Current state March 14th, 2026

February 1st, 2026

February 1st, 2026

License

This project is licensed under the MIT license.

See LICENSE for more information.