This script is meant to be set up as a service to backup your klipper config files to a GitHub repository, or Google Drive.
If you have any questions, bug reports or requests feel free to DM me on Discord: Low_Frequency#0831
This script runs when your Pi starts, or if configured even on a set timeschedule. It waits for network connection and then pushes a backup to your specified locations. Every action is logged. This way you always know what fails, or has failed in the past.
It even has log rotation implemented, so it doesn't eat up the precious space for your gcodes 😉
If you want to know what each script does, just execute it with the flags -h or --help and you get an overview and description for all scripts.
This script even sets up custom commands for you to use.
Create a GitHub account if you want to store your backup there. If not, just use Google Drive.
If you plan to store the backup on GitHub, go ahead and create a new repo.
To install this script, SSH into your Pi and execute the following command :
wget -qO setup.sh "https://raw.githubusercontent.com/Low-Frequency/klipper_backup_script/main/setup.sh" && chmod +x setup.sh && ./setup.shIt can take a while for the Google Drive authentication and backup to succeed, so don't panic if the install stops responding for a short period of time.
Be aware that this script only works correctly if the installed version of git is 2.28 or newer. Check this with git --version.
If the displayed version is prior to 2.28, update your system first! If apt update && apt upgrade doesn't let you update to an newer version of git, follow this guide.
I added an update script for easy addition of features in the future. To update, just type update_bak_util. If you don't have the update script yet, please uninstall the existing version and install it again. After that you have the update command availabe in the future.
The setup script tells you to copy a private key and add it to your GitHub account. To do this just navigate to your profile -> settings -> SSH and GPG keys, add a new key and paste the copied key.
To manually create a backup just execute the following command that is created during install:
backupYou can customzie how long the log files will be stored, add a backup location and pretty much everything the setup script has asked you during the install.
To customize this, open the config file:
nano ~/.config/klipper_backup_script/backup.cfgIn this file there are all customizable features.
If you want to disable the log rotation completely, just set the ROTATION variable to 0.
To change the log retention time, just change the RETENTION variable. Note that the time is calculated in months.
Enabling or disabling backup locations is done via the GIT and CLOUD variables.
To set up Google Drive as a backup location after you've done the install, just execute this command:
reconfigure_driveIf you want to set up GitHub as a backup location after you've done the install, just execute this command:
reconfigure_gitIf you want to customize the backup schedule, edit the following variables:
INTERVAL: Enable/disable backup schedule.
TIME: The schedule interval time.
UNIT: The time unit for the interval.
Changing USER, REPO, REMOTE, FOLDER and BREAK is not advised unless you know what you're doing.
The script sets up a custom command for this.
If you need to restore your config files, you have two options:
- Restoring to your existing installation with the git repo already configured
- Restoring to a new installation
Just execute the following command and follow the instructions to choose from the availabe options:
restoreI don't know why you wouldn't want to use automatic backups, but I might as well provide you with an easy way to revert all the changes the scripts have done. Just execute this custom command:
uninstall_bak_utilYou still have to manually delete your GitHub repo and the SSH keys though.
To delete the SSH keys, just execute this command:
rm -r ~/.ssh/github_id_rsa*Don't forget to delete the public key in your GitHub profile too!