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.

How to get help?

Please join us on Discord, if you need additional help.

Also see the FAQ section.

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

FAQ

Q: How do I report a Bug? A: First of all make sure it is not an misconfiguration of

• moonraker
• klipper
• crowsnest
• sonar

If there is a bug that belongs to the OS itself, please look first at the official Forum of Raspberry Pi OS.
MainsailOS is based on Raspberry Pi OS and is only slightly modified to
carry the basics to run Klipper on your 3D Printer. Most configuration of the single components is up to you. We only want to provide an Image as a starting point.

If there is something that is a bug caused due to the misconfiguration of MainsailOS itself, please let us know, and we will take action as soon as possible. Please use the issue section for that. Please provide as much information as you can.

Q: What is the philosophy behind MainsailOS? A: KISS - Keep it simple and stupid.
We only do a bit of modification. All other documented things of the Raspberry Foundation apply.

And that's our main goal of staying compatible with existing documentation. We will provide documentation if something is handled differently than the original documentation.

Q: How do I contribute/support? A: There are several ways to contribute or support our work. Please take a closer look to CONTRIBUTING.md

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"