v1.3.0

We are happy to announce, that the installation script has made it into the main branch!

Of course, the docs have also received fresh updates.

How to install Klipper-Backup now?

The installation and configuration of Klipper-Backup is now simplified for everyone. The current recommendation for installation consists of:
curl -fsSL https://raw.githubusercontent.com/Staubgeborener/klipper-backup/download/get-klipper-backup.sh | bash

And running the installation with a ~/klipper-backup/install.sh. As always, everything is described in the docs.

Automatic feature installation

The following features can now be installed automatically using the script:

• backup on file changes
• cronjobs for automated regular updates
• cronjob for backup on boot
• the moonraker entry can also be added automatically

In theory, only the GitHub token needs to be created. If you want to change the configuration or install features later, simply call the script again with ~/klipper-backup/install.sh.

New .env syntax

The .env file has been given a slightly new syntax. If you are still using the old .env syntax, don't worry, a script is running in the background together with the installation script which recognizes this and converts it to the new one. Completely automatically.

The biggest thanks to the realization of this script goes to @Tylerjet.

v1.2.2

• With the optional parameter empty_commit=yes empty commits can now be pushed - or not (commit)
• Add exlude list, preserve README.md, allow multiple branches per repo, thanks to @Tylerjet (commit)
• With the optional parameter git_protocol=http you can choose whether you want to use http or https. This allows, for example, the use of local git applications without a certificate, thanks to @ziti (commit)
• Replaced cp -r with rsync to support more compatibility with different systems (commit)

v1.2.1

• New optional parameter git_host="" + corresponding docs section (commit)
• Standard commit message now has a different date layout $(date +"%x - %X") (commit)
• Use of the hashed mac address as unique id for end of the mail (commit)
• In the future the tags will start with v, to make the Moonraker Update Manager more uniform
• The documentation has been slightly reworked and expanded. New article: Backup on file changes

1.2.0

Klipper-Backup now offers a documentation.

• pushing empty commits so that you can see that the script is actually running in the background
• more than one word is now possible as an optional commit name. For example, you can now push ./script.sh my new commit where my new commit is the commit name
• improved git pull --rebase so that conflicts are merged without manual intervention needed, added a check that ensures git pull does trying to pull from a remote repo with no existing commit/branch history
• now it properly checks for a remote repo before pulling
• Reordered some actions for proper pull/push. Script will now pull any changes to the local branch first (should prevent any need for rebase or merge), then copy the backup to the repository folder, add and commit the backup's files, then push it back to the remote repository
• make user.email more unique to keep issue #34 from occuring (#35)
• The script now checks whether the $branch_name or the $repository has been changed before pushing, adjusts it if necessary and then pushes to prevent errors

1.1.0

Complete changelog

Long story short:

• backup_folder parameter is not necessary anymore in .env file and hardcoded
• beautify code
• better recognition of the specified paths / folders / files in .env and adaptation of these as required (e.g. adding /* if necessary)
• force push with -f parameter
• keep directory structure in pushed repository (fix: some files are not overwritten + structure remains)

Once again: Big thanks to @Tylerjet who invest too much of his free time here ❤️

1.0.0

Something to celebrate, klipper-backup got an essential bug fixed thanks to @Tylerjet, and we reached a final version 1.0.0!
The long-standing dirty moonraker flag bug has now been fixed.

Version 1.0.0 comes with the following changes:

• the wiki has been completely revised and adapted to version 1.0.0
• anyone who has used the previous versions is encouraged to take a look at the migration article in the wiki
• the .env file has new sections and a new syntax:
  • branch_name: Change the branch name manually based on your repository, in the most cases main is the default value
  • commit_username: With which name the commit should be pushed, without specification the username of the system (whoami) is taken
  • commit_email: The email address for the commit, without specification the username of the system (whoami) and the hostname (hostname) is taken
  • The script now searches for the paths in the home directory ($HOME), so the paths no longer have to be specified absolutely. For example, /home/pi/printer_data/config now becomes printer_data/config
• version 1.0.0 no longer maintains the versioning in the version file, as this is obsolete
• the installation script install.sh is also obsolete and therefore deleted

All in all, version 1.0.0 is now more lightweight and unnecessary files have been removed - but at the same time more flexible and easier to set up and update. Once again, many thanks to @Tylerjet without whom this update would have had to wait a while longer.

0.3.7

1. Merged commit 340410a (see PR) for comment-proof path variables in .env file. Thanks to @cherub-i. Wiki article has been adapted accordingly.

2. If the script is executed manually with ./script.sh, the commit message can optionally be customized. Simply ./script.sh takes the timestamp as before, ./script.sh "helloworld" is using helloworld as commit message. Wiki article has been adapted accordingly.

0.3.6

Fixed bug where recursive copying of multiple folders duplicated them in the backup directory (thanks to lapluviosilla for the hint).

0.3.5

Fix: Older release did not set the cp -r flag in script.sh

0.3.4

Adjusted the paths in .env file and slightly modified installation script.

There is now a wiki.