Installation

git

You need git for this script.

Debian / Ubuntu based distributions

sudo apt update && sudo apt install git

Arch / Manjaro based distributions

sudo pacman -Syu && sudo pacman -S git

Prepare GitHub repository

1. Log in to GitHub
2. Click on the + in the upper right corner
3. Click on "New repository"

Danger

Don't create a README.md at this point! You can create your own later.

The most important part in the next window is here to give the repository a name, you will need this later.

Create GitHub token

1. In GitHub, click on the profile in the upper right corner and click
2. Settings → Developer settings → Personal access tokens → Fine-grained tokens → Generate new token
3. Use the following settings:

   Token name: whatever you feel like
   Only select repositories: Your backup repository which you created at step "Prepare GitHub repository"
   
   Repository permissions:
   Contents: Read and write
   Metadata: Read and write or Read-Only
   

4. Click Generate new token

Copy the new token, you will need this later.

Installation

There are two ways at this point. Whatever you choose, the installation script guides you through the essential steps. Have your GitHub token ready for this. You can decide during the installation whether you want to install some features like backup on boot, backup on file changes, or even add the moonraker entry, etc (this can also be done afterwards).

1. Native

Download:

curl -fsSL get.klipperbackup.xyz | bash

Install:

~/klipper-backup/install.sh

Info

You can run the install.sh script at any time to install any features!

2. KIAUH

KIAUH supports Klipper-Backup since v6.0.0-alpha. Download KIAUH, execute v6 at the prompt, select E for Extension, select 4 for Klipper-Backup:

Jump to configuration

Now edit your .env file.