Klipper Backup

[FoxPhantomThief]

First off, I'd like to thank you for creating and maintaining this repo. Your extensive configurations and documentation have made it easy for newbies to get up and running with Klipper. I've been much happier with the performance of my SV06 since upgrading from Marlin using your instructions. So, thank you!

I'd like to backup my configuration using Klipper-Backup. The problem I'm running into is that the script fails because it attempts to include files in the backup repo that are already part of your repo. This manifests as ~/printer_data/config being treated as a symlink and nothing else being tracked. Could you offer any advice on a workaround, or perhaps provide instructions on how to get the backup functioning?

Thanks!

[bassamanator]

What timezone are you?

[FoxPhantomThief]

PDT, why?

[bassamanator]

Basically, a very simple task, tracking your klipper config, is being offloaded to an outside package/repo, it's completely unnecessary.

Begin by creating a repo on your github, can be public or private, called klipper-config-{printer-name}.

[FoxPhantomThief]

Okay, done.

[bassamanator]

Is your klipper config working as it should at this point?

[FoxPhantomThief]

Yes, it's been running great for the past 2 years.

[bassamanator]

1. ssh into the klipper host.
2. cd ~/printer_data/config
3. git status
4. Post output here in code blocks.

[FoxPhantomThief]

pi@raspberrypi:~/printer_data/config $ git status
On branch my-settings
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   KlipperScreen.conf
        modified:   cfgs/Z_TILT.cfg
        modified:   cfgs/misc-macros.cfg
        modified:   osskc.cfg
        modified:   printer.cfg

no changes added to commit (use "git add" and/or "git commit -a")

[bassamanator]

git remote -v

Just the first page from this git log --all --graph --decorate --oneline.

git branch -a

[FoxPhantomThief]

pi@raspberrypi:~/printer_data/config $ git remote -v
origin  https://github.com/bassamanator/Sovol-SV06-firmware.git (fetch)
origin  https://github.com/bassamanator/Sovol-SV06-firmware.git (push)
pi@raspberrypi:~/printer_data/config $ git log --all --graph --decorate --oneline
*   e74fb9f (HEAD -> my-settings) Update with upstream.
|\
| * 7d9cb1d (origin/master, origin/HEAD, master) Add new OS bundles: added 15mm3 profiles.
| * 5267b5d Adjust readme: differences between marlin.
| * f704ca2 Lower stepper_z run_current to 0.900.
| * 100308b Adjust FAQ: _globals explanation; NOTEs in misc-macros.cfg.
| * 720ad09 Merge bedtempNotExact into master.
| * 21ab593 Minor adjustments to README download section. Add firmware v0.13.x.
* | ef43a9c Saving my settings.
* | bc91b05 Update with upstream.
|\|
| * 17f4c3a Update OS bundles.
| *   5419530 Adjust OrcaSlicer merge.
| |\
| | * 75d7f24 Merge pull request #211 from apparle/orcaslicer_support
| |/|
| | * b622ca4 Reword the documentation a bit.
| | * e1bc37e Add initial version of OrcaSlicer and ancillary files to convert config from PrusaSlicer to OrcaSlicer
| |/
| * e712f7b Adjust bundles: PS-2.9.2.
| * e00ff1d Adjust scarf joint settings.
| * b02417e Adjust prusa bundle: improve scarf join settings; update to 2.9.1.
| * 28a8d8a Add PS bundle 2.9.0 with 0.6 mm nozzle.
| * 89904dc Add mcu timer too close error to special considerations.
| * 9b025cd Adjust readme.
| *   a414f1a Adjust readme header.
| |\
| | * bb4dd6a Adjust styling.
| | * f29a29f Adjust styling.
| * | cf931af New PrusaSlicer config bundle.
| |/
| * 8c3d4a7 Adjust gitignore.
| * e8436ad Delete misc/marlin-SV06V2.0.0A_2.24.bin
| * 7dba6de Add new klipper-v0.12.0-289-g08a1c9f1.bin, latest.
| * f174110 Adjust before you begin section.
| * 6b156cb Add notices to README.
| * 116f6c9 Fix test_speed macro.
| * efdfd86 Fix kamp notes link.
* | dc2417b Saving my settings.
* | eab0358 Update with upstream.
|\|
| *   34a57ff Merge branch 'master' of github.com:bassamanator/Sovol-SV06-firmware
| |\
| | * acb6549 Update README.md
| |/
pi@raspberrypi:~/printer_data/config $ git branch -a
  master
* my-settings
  remotes/origin/HEAD -> origin/master
  remotes/origin/master

[bassamanator]

Paste what it says when you go to your newly created repo.

[FoxPhantomThief]

Sorry, not entirely sure what you mean by "what it says when I go". Here's a screenshot of the github page after I created it:

It says "...or create a new repository on the command line:

echo "# klipper-config-SV06" >> README.md
git init
git add README.md
git commit -m "first commit"
git branch -M main
git remote add origin https://github.com/FoxPhantomThief/klipper-config-SV06.git
git push -u origin main

...or push an existing repository from the command line

git remote add origin https://github.com/FoxPhantomThief/klipper-config-SV06.git
git branch -M main
git push -u origin main

[bassamanator]

Commit (save) your changes to your branch

It seems that the following files were modified and you're fine with how the settings are currently.

        modified:   KlipperScreen.conf
        modified:   cfgs/Z_TILT.cfg
        modified:   cfgs/misc-macros.cfg
        modified:   osskc.cfg
        modified:   printer.cfg

# Stage all changes for commit.
git add --all

# Commit the changes
git commit -m "My klipper config is working as it should"

Linking your settings to your repo

# This will set your github repo as another remote available. `origin` is my repo, `myOrigin` is yours.
git remote add myOrigin https://github.com/FoxPhantomThief/klipper-config-SV06.git

# Make sure your branch is checked out.
git checkout my-settings

# Link your branch to `myOrigin` and push it to your repo. In the future, you can just do a `git push`
git push -u myOrigin

In the future, when you make changes to your config, you can check the status, stage the changes, then commit, then push.

[FoxPhantomThief]

Thanks for the detailed instructions on how to push my customized branch to my own repo. Unfortunately, I'm running into an authentication issue on the final step:

pi@raspberrypi:~/printer_data/config $ git remote add myOrigin https://github.com/FoxPhantomThief/klipper-config-SV06.git
pi@raspberrypi:~/printer_data/config $ git checkout my-settings
Already on 'my-settings'
pi@raspberrypi:~/printer_data/config $ git push -u myOrigin
Username for 'https://github.com': FoxPhantomThief
Password for 'https://FoxPhantomThief@github.com':
remote: Invalid username or token. Password authentication is not supported for Git operations.
fatal: Authentication failed for 'https://github.com/FoxPhantomThief/klipper-config-SV06.git/'

I searched the error and found info about support for password authentication being removed several years ago and instructions to use an SSH key instead. I generated one and added it to my account but I'm still receiving the same error.

[bassamanator]

Totally forgot about authentication.

Many ways to tackle this, and of course it's easiest with linux.

What OS is your PC, the computer you are using to ssh into the klipper host?

[FoxPhantomThief]

Windows 10 😅

[bassamanator]

On your klipper host, generate a very secure ssh key via ssh-keygen -t rsa -b 4096 -C "klipper-host-{devicename}".

Do not use a passphrase, unless you want to have to type it in every time. Just keep pressing enter and use defaults.

View ssh public key via cat ~/.ssh/id_rsa.pub, it is safe to share. Add it to your Github, Settings, SSH and GPG keys section.

Should be good to go.

Something to note, if someone gets their hands on your klipper host, they will be push code to your github.

[FoxPhantomThief]

I've followed your instructions but am running into the same issue as before, where it tells me password authentication is not supported.

pi@raspberrypi:~ $ ssh-keygen -t rsa -b 4096 -C "klipper-host-raspberrypi"
Generating public/private rsa key pair.
Enter file in which to save the key (/home/pi/.ssh/id_rsa):
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in /home/pi/.ssh/id_rsa
Your public key has been saved in /home/pi/.ssh/id_rsa.pub
The key fingerprint is: {keyfingerprint}
The key's randomart image is: {keyrandomartimage}
pi@raspberrypi:~ $ cd printer_data/config
pi@raspberrypi:~/printer_data/config $ git push -u myOrigin
Username for 'https://github.com': FoxPhantomThief
Password for 'https://FoxPhantomThief@github.com':
remote: Invalid username or token. Password authentication is not supported for Git operations.
fatal: Authentication failed for 'https://github.com/FoxPhantomThief/klipper-config-SV06.git/'

I've added the public key to my account as both an authentication key and signing key.

[bassamanator]

We need to switch away from the https protocol.

To do:

git remote remove myOrigin
git remote add myOrigin git@github.com:FoxPhantomThief/klipper-config-SV06.git
git push -u myOrigin