{"id":20324934,"url":"https://github.com/mainsail-crew/mainsailos","last_synced_at":"2025-04-09T07:03:58.739Z","repository":{"id":37029636,"uuid":"284533956","full_name":"mainsail-crew/MainsailOS","owner":"mainsail-crew","description":"This Raspberry Pi distribution for managing Klipper 3D printers with Mainsail provides all you need.","archived":false,"fork":false,"pushed_at":"2024-08-17T21:06:52.000Z","size":9619,"stargazers_count":600,"open_issues_count":12,"forks_count":291,"subscribers_count":25,"default_branch":"develop","last_synced_at":"2025-04-02T05:53:51.785Z","etag":null,"topics":["3d-printing","crowsnest","distribution","hacktoberfest","image","klipper","mainsail","mainsail-os","moonraker","raspberry-pi","rpi","sonar","webcam"],"latest_commit_sha":null,"homepage":"https://docs.mainsail.xyz/setup/mainsail-os","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mainsail-crew.png","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","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"patreon":"meteyou","ko_fi":"mainsail"}},"created_at":"2020-08-02T20:13:45.000Z","updated_at":"2025-03-31T22:14:00.000Z","dependencies_parsed_at":"2024-01-05T20:47:04.001Z","dependency_job_id":"52e15e5e-478e-43c7-80b8-97bdfb9c9a57","html_url":"https://github.com/mainsail-crew/MainsailOS","commit_stats":{"total_commits":288,"total_committers":18,"mean_commits":16.0,"dds":0.6354166666666667,"last_synced_commit":"0d951e47cb683a8d4859ed1f17f40702baa303ed"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainsail-crew%2FMainsailOS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainsail-crew%2FMainsailOS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainsail-crew%2FMainsailOS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainsail-crew%2FMainsailOS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mainsail-crew","download_url":"https://codeload.github.com/mainsail-crew/MainsailOS/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247994120,"owners_count":21030050,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d-printing","crowsnest","distribution","hacktoberfest","image","klipper","mainsail","mainsail-os","moonraker","raspberry-pi","rpi","sonar","webcam"],"created_at":"2024-11-14T19:38:13.742Z","updated_at":"2025-04-09T07:03:58.716Z","avatar_url":"https://github.com/mainsail-crew.png","language":"Shell","funding_links":["https://patreon.com/meteyou","https://ko-fi.com/mainsail"],"categories":[],"sub_categories":[],"readme":"![downloads](https://img.shields.io/github/downloads/mainsail-crew/MainsailOS/total)\n[![discord](https://img.shields.io/discord/758059413700345988?color=%235865F2\u0026label=discord\u0026logo=discord\u0026logoColor=white\u0026style=flat)](https://discord.gg/mainsail)\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\".github/sdcard-logo.png\" style=\"width:40%\" \u003e\n\u003c/p\u003e\n\n# MainsailOS\n\nA [Raspberry Pi OS](https://www.raspberrypi.org/software/) based distribution for 3D Printers. \\\nIt includes everything to get started with Klipper Firmware and Mainsail.\n\nLearn more about:\n\n-   [Klipper Firmware](https://www.klipper3d.org/)\n-   [Moonraker](https://moonraker.readthedocs.io/en/latest/)\n-   [Mainsail](https://docs.mainsail.xyz/)\n\n## How to install MainsailOS ?\n\nYou can find detailed instructions in our [documentation](https://docs-os.mainsail.xyz).\n\nWe recommend the installation via [Raspberry Pi Imager](https://docs-os.mainsail.xyz/getting-started/raspberry-pi-os-based).\n\n## How to get help?\n\nPlease join us on [Discord](https://discord.gg/mainsail), if you need additional help.\n\n[![discord](https://img.shields.io/discord/758059413700345988?color=%235865F2\u0026label=discord\u0026logo=discord\u0026logoColor=white\u0026style=flat)](https://discord.gg/mainsail)\n\nAlso see the [FAQ](#faq) section.\n\n## What is included?\n\nHere a list of included and preinstalled Software:\n\n-   [Klipper (3D Printer Firmware)](https://github.com/Klipper3d/klipper)\n-   [Moonraker (API Web Server for Klipper)](https://github.com/Arksine/moonraker)\n-   [Mainsail (Web interface for Klipper/Moonraker)](https://github.com/mainsail-crew/mainsail)\n-   [Crowsnest (Webcam streaming)](https://github.com/mainsail-crew/crowsnest)\n-   [Sonar (Keepalive daemon)](https://github.com/mainsail-crew/sonar)\n-   [Nginx (Webserver \u0026 Proxy)](https://nginx.org/en/)\n\n## also includes\n\n-   Enabled Serial Connection by default. \\\n    Using Hardware UART (PL011) for Boards like BTT SKR Mini E3 V3\n-   Preinstalled Dependencies for Klipper's Input Shaper. \\\n    You only need to build the [klipper_mcu](https://www.klipper3d.org/RPi_microcontroller.html) and installing the service. \\\n    See [Klipper documentation](https://www.klipper3d.org/Measuring_Resonances.html) for more information.\n-   Preinstalled python3-serial package, needed for [CanBoot](https://github.com/Arksine/CanBoot)\n\n## Screenshots\n\n![screenshot-dashboard](https://github.com/mainsail-crew/docs/raw/master/assets/img/screenshot.png)\n\n# FAQ\n\n**Q:** How do I report a Bug?\n**A:** First of all make sure it is _not_ an misconfiguration of\n\n-   moonraker\n-   klipper\n-   crowsnest\n-   sonar\n\nIf there is a bug that belongs to the OS itself,\nplease look first at the official Forum of Raspberry Pi OS.\\\nMainsailOS is based on Raspberry Pi OS and is only slightly modified to\\\ncarry the basics to run Klipper on your 3D Printer.\nMost configuration of the single components is up to you.\nWe only want to provide an Image as a starting point.\n\nIf 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.\nPlease use the issue section for that.\nPlease provide as much information as you can.\n\n**Q:** What is the philosophy behind MainsailOS?\n**A:** KISS - Keep it simple and stupid.\\\nWe only do a bit of modification. All other documented things of the Raspberry Foundation apply.\n\nAnd that's our main goal of staying compatible with existing documentation.\nWe will provide documentation if something is handled differently than the original documentation.\n\n**Q:** How do I contribute/support?\n**A:** There are several ways to contribute or support our work.\nPlease take a closer look to [CONTRIBUTING.md](https://github.com/mainsail-crew/MainsailOS/blob/develop/CONTRIBUTING.md)\n\n# Build your own / Developing\n\nTo prevent you have to deal with an entire build chain setup, \\\nsimply fork this repository.\n\nEnable the workflows in your fork and you are good to go. \\\nOn each push you make, an image is build and uploaded as an artifact.\n\nIf you want or need to build locally please visit [CustomPiOS](https://github.com/guysoft/CustomPiOS). \\\nEspecially [\"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)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmainsail-crew%2Fmainsailos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmainsail-crew%2Fmainsailos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmainsail-crew%2Fmainsailos/lists"}