LogoLogo
MainsailMainsailOSCrowsnest
  • Welcome to Mainsail
  • Setup
    • Installation
      • MainsailOS
      • KIAUH
      • Docker
      • Manual setup
      • my.mainsail.xyz
    • Updates
      • Update Manager
      • Manual Update
    • Configuration
  • overview
    • Features
      • Bed Mesh
      • Console
      • Dashboard Organisation
      • Exclude Objects
      • Hide macros, outputs or fans
      • Localization
      • Macro Management
      • Macro Prompts
      • Presets
      • Print History and Statistics
      • Query devices
      • Built-in Themes
      • Custom Themes
        • Prepare
        • Backgrounds
        • Logos and Icons
        • Custom Navigation
        • Custom CSS
        • Community Themes
      • Thumbnails
      • Webcam
    • Settings
      • General
      • Console
      • Control
      • Dashboard
      • Editor
      • G-Code Viewer
      • Macros
      • Presets
      • Printers
      • UI-Settings
      • Webcams
    • Slicer
      • Cura
      • Ideamaker
      • PrusaSlicer
      • SuperSlicer
    • Quicktips
      • Slicer upload
      • Remote Access
      • Printer power switch
      • Additional Sensors
      • Disable Octoprint LCD menu
      • config.json
  • FAQ
    • Mainsail
    • Klipper warnings
      • Deprecated Values
      • Deprecated Options
      • Runtime Warning
    • Moonraker warnings
      • PolicyKit Permissions
    • Klipper errors
      • MCU Protocol error
    • Mainsail errors
      • Unauthorized
    • Getting Help
      • Discord
      • GitHub Discussions
  • About
    • Data Privacy
    • Sponsors
    • Development
      • Code standards
      • Contribute
      • Environment
      • Localization
    • Credits
  • 🔗Links
    • Github
    • Release Notes
    • Discord
    • Youtube
Powered by GitBook
On this page
  • Local installation
  • MainsailOS
  • KIAUH - Klipper Installation And Update Helper
  • Docker
  • Manual setup
  • Hosted

Was this helpful?

Edit on GitHub
  1. Setup

Installation

You will need to choose which way you want to install Mainsail.

PreviousWelcome to MainsailNextKIAUH

Last updated 1 year ago

Was this helpful?

Local installation

MainsailOS

recommended for Raspberry Pi users

MainsailOS is a prebuilt image for single board computers that already includes Mainsail, Moonraker and Klipper. The least amount of setup.

KIAUH - Klipper Installation And Update Helper

A script toolbox to install and update Klipper, Moonraker and Mainsail. KIAUH contains additional features and is recommended for multi-printer setups.

Docker

For those who prefer the containerized approach, Docker runs Mainsail in an isolated Docker environment with our pre-built NGINX-based image.

Manual setup

The rocky road for the daring. For those who want to know how everything is set up manually.

Hosted

You can test and review a hosted version of Mainsail at . Please read the documentation for usage and configuration.

my.mainsail.xyz
my.mainsail.xyz
KIAUH
Docker
Manual setup
MainsailOS