Installation¶

Execute the commands below to install Crowsnest and follow the instructions carefully.

sudo apt-get update && sudo apt-get install git -y
cd ~
git clone https://github.com/mainsail-crew/crowsnest.git
cd ~/crowsnest

Multi Instance Setup

If you have multiple Klipper instances installed on a single host, run make config before proceeding with the installation. This launches a wizard that lets you configure paths for your multi-instance setup.

make config

Choose a path as your Master path. This will be the instance where Crowsnest's files (crowsnest.conf, crowsnest.env, and crowsnest.log) are located. In Mainsail, this instance is used to set up Crowsnest and control the service via Moonraker.

Now run the installer:

sudo make install

Moonraker Update Manager¶

After a successful installation, update your moonraker.conf as shown below to keep Crowsnest up to date. During installation, you will be asked if you want the script to do this for you.

[update_manager crowsnest]
type: git_repo
path: ~/crowsnest
origin: https://github.com/mainsail-crew/crowsnest.git
install_script: tools/pkglist.sh

Tip

Don't forget to reboot after installation!