MainsailOS¶
MainsailOS is a prebuilt image for single board computers that already includes Mainsail, Moonraker and Klipper.
What is MainsailOS?¶
MainsailOS is a prebuilt image for several Single Board Computer (SBC) models. It contains pre-configured software needed to run Klipper firmware with Mainsail as your web interface to control your 3D printer. MainsailOS is not a full distribution like Debian or Ubuntu. It only adds the required software on top of the existing base image for your SBC.
The following software is included in MainsailOS images:
- Mainsail — Web interface for Klipper
- Klipper — 3D printer firmware
- Moonraker — API web server for Klipper
- Crowsnest — Webcam daemon
- Sonar — WiFi keepalive daemon
- Timelapse — Timelapse plugin for Moonraker
- Preinstalled dependencies for Measuring Resonances
Note
MainsailOS is not an "all in one" solution for every use case. It is a simple and easy starting point to enjoy Mainsail and its features.
Supported Hardware¶
The list of supported SBCs is continually being expanded. Below is an overview of currently supported boards and those planned for the future.
| Model | Supported | Base Image | Note |
|---|---|---|---|
| Raspberry Pi 1 / Zero 1 / 2 | ✅ | Raspberry Pi OS Lite | not recommended |
| Raspberry Pi Zero 2 / 3 / 4 / 5 | ✅ | Raspberry Pi OS Lite | |
| Orange Pi Zero 2 / Zero 3 | ✅ | Armbian CLI | |
| Orange Pi 3 LTS / 4 LTS | ✅ | Armbian CLI | |
| Radxa Rock 4 SE / CM3 | ❌ | Armbian CLI | Work in Progress 🛠️ |
| BigTreeTech CB1 | ❌ | Armbian CLI | Planned 📅 |
| Libre Computer Le Potato | ❌ | — | Planned 📅 |
Getting Started¶
To get started with MainsailOS, head over to the getting started guide for your SBC: