Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mainsail-crew/MainsailOS

This Raspberry Pi distribution for managing Klipper 3D printers with Mainsail provides all you need.
https://github.com/mainsail-crew/MainsailOS

3d-printing crowsnest distribution hacktoberfest image klipper mainsail mainsail-os moonraker raspberry-pi rpi sonar webcam

Last synced: 3 months ago
JSON representation

This Raspberry Pi distribution for managing Klipper 3D printers with Mainsail provides all you need.

Host: GitHub
URL: https://github.com/mainsail-crew/MainsailOS
Owner: mainsail-crew
License: gpl-3.0
Created: 2020-08-02T20:13:45.000Z (over 4 years ago)
Default Branch: develop
Last Pushed: 2024-04-08T17:21:25.000Z (7 months ago)
Last Synced: 2024-04-26T15:33:26.274Z (7 months ago)
Topics: 3d-printing, crowsnest, distribution, hacktoberfest, image, klipper, mainsail, mainsail-os, moonraker, raspberry-pi, rpi, sonar, webcam
Language: Shell
Homepage: https://docs.mainsail.xyz/setup/mainsail-os
Size: 9.16 MB
Stars: 510
Watchers: 26
Forks: 230
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-raspberry-pi - Mainsail OS - A distribution for 3D Printers that includes everything to get started with Klipper Firmware and Mainsail. (OS Images)

README

        ![downloads](https://img.shields.io/github/downloads/mainsail-crew/MainsailOS/total)

[![discord](https://img.shields.io/discord/758059413700345988?color=%235865F2&label=discord&logo=discord&logoColor=white&style=flat)](https://discord.gg/mainsail)







# MainsailOS

A [Raspberry Pi OS](https://www.raspberrypi.org/software/) based distribution for 3D Printers. \

It includes everything to get started with Klipper Firmware and Mainsail.

Learn more about:

-   [Klipper Firmware](https://www.klipper3d.org/)

-   [Moonraker](https://moonraker.readthedocs.io/en/latest/)

-   [Mainsail](https://docs.mainsail.xyz/)

## How to install MainsailOS ?

You can find detailed instructions in our [documentation](https://docs-os.mainsail.xyz).

We recommend the installation via [Raspberry Pi Imager](https://docs-os.mainsail.xyz/getting-started/raspberry-pi-os-based).

## How to get help?

Please join us on [Discord](https://discord.gg/mainsail), if you need additional help.

[![discord](https://img.shields.io/discord/758059413700345988?color=%235865F2&label=discord&logo=discord&logoColor=white&style=flat)](https://discord.gg/mainsail)

Also see the [FAQ](#faq) section.

## What is included?

Here a list of included and preinstalled Software:

-   [Klipper (3D Printer Firmware)](https://github.com/Klipper3d/klipper)

-   [Moonraker (API Web Server for Klipper)](https://github.com/Arksine/moonraker)

-   [Mainsail (Web interface for Klipper/Moonraker)](https://github.com/mainsail-crew/mainsail)

-   [Crowsnest (Webcam streaming)](https://github.com/mainsail-crew/crowsnest)

-   [Sonar (Keepalive daemon)](https://github.com/mainsail-crew/sonar)

-   [Nginx (Webserver & Proxy)](https://nginx.org/en/)

## 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](https://www.klipper3d.org/RPi_microcontroller.html) and installing the service. \

    See [Klipper documentation](https://www.klipper3d.org/Measuring_Resonances.html) for more information.

-   Preinstalled python3-serial package, needed for [CanBoot](https://github.com/Arksine/CanBoot)

## Screenshots

![screenshot-dashboard](https://github.com/mainsail-crew/docs/raw/master/assets/img/screenshot.png)

# 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](https://github.com/mainsail-crew/MainsailOS/blob/develop/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](https://github.com/guysoft/CustomPiOS). \

Especially ["Build a Distro From within Raspbian / Debian / Ubuntu / CustomPiOS Distros"](https://github.com/guysoft/CustomPiOS#build-a-distro-from-within-raspbian--debian--ubuntu--custompios-distros)