MainsailOS

A Raspberry Pi OS based distribution for 3D Printers.
It includes everything to get started with Klipper Firmware and Mainsail.

Learn more about:

• Klipper Firmware
• Moonraker
• Mainsail

How to install MainsailOS ?

You can find detailed instructions in our documentation.

We recommend the installation via Raspberry Pi Imager.

Community

For additional help, join us on Discord.

What is included?

Here a list of included and preinstalled Software:

• Klipper (3D Printer Firmware)
• Moonraker (API Web Server for Klipper)
• Mainsail (Web interface for Klipper/Moonraker)
• Crowsnest (Webcam streaming)
• Sonar (Keepalive daemon)
• Nginx (Webserver & Proxy)

also includes

• Enabled Serial Connection by default.
  Using Hardware UART (PL011) for Boards like BTT SKR Mini E3 V3
• Preinstalled Dependencies for Klipper's Input Shaper.
  You only need to build the klipper_mcu and installing the service.
  See Klipper documentation for more information.
• Preinstalled python3-serial package, needed for CanBoot

Screenshots

Build your own / Developing

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 visit CustomPiOS.
Especially "Build a Distro From within Raspbian / Debian / Ubuntu / CustomPiOS Distros"