RatOS is a preconfigured image for Raspberry Pi and alternative single-board computers that aims to make it as painless as possible to get Klipper, Mainsail and Moonraker up and running on your printer. It is developed and maintained by Mikkel Schmidt (miklschmidt#2036 on the Rat Rig Unofficial Discord) with help from the community.

Start by reading the Documentation

• qemu-arm-static
• CustomPiOS
• Bash
• Git
• Docker
• Docker-Compose
• QEMU for emulation
• About 5GB of free diskspace for the build
• Yarn & Docusaurus for docs

To prevent you have to deal with an entire build chain setup,
simply fork this repository.

Enable the workflows in your fork and you are good to go.
On each push you make, an image is build and uploaded as an artifact.

If you want or need to build locally please read CustomPiOS.
Especially "Build a Distro From within Raspbian / Debian / Ubuntu / CustomPiOS Distros"

You can use the provided docker compose to build with Docker. Customize the BUILD_VARIANT environment variable if you only want to build a specific variant.

docker-compose up -d

Then run the build command:

docker exec -it ratos-build build