RUclips seems to have butchered one of the commands in the description. If you have issues with copying and pasting any of the commands you can also find them in the official documentation here: staubgeborener.github.io/klipper-backup/quickstart/
Another SUPER helpful video, Daniel. You continue to show werk-after-week why yours is one of the most valuable 3D printing channels on RUclips! Thank you for what you do.
Thank you very much for the kind words :)!! I really hope this helps others. Losing a config and having to start over can be such a painful process. Have a great weekend!
One small security tip: The personal access token (PAT) you created can be used to make changes to any of your repositories. To fix this, when you create the PAT, there is an option there "Fine-grained tokens". Select that option. When creating the token, for "Repository Access" choose "Only select repositories", and then add the repository you just created for the backups. For permissions, expand the "Repository permissions" section and grant read and write permission for "Contents". Those are the only permissions that the script needs. Also, when you're editing the .env value, you can create the setting "commit_username=xxxx", and set xxxx to any value you want (doesn't have to be any kind of user you create). This will just make commits from the script show up under that name. This is useful to distinguish commits from the script from any commits you make yourself.
THIS is what RUclips is for. Thank you so much for this video. I use Linux on my PC for everyday use and I found the documentation for Klipper on Git to be exceptionally obtuse. Thank you so much for clarifying literally every questions I was asking.
I just added this to my printers and it is great. Incidentally: the installation now configures all the settings, so you don't have to edit or change anything. Easy installation Thanks for the great content.
Another tip: Document your changes! You solve a lot of problems that you or someone else will need to solve again one day. You may have a config that solves it on one printer, but you can’t just copy it to another printer. Don’t rely on your silly human memory!
I have a git repo for this with commit messages explaining the gist of changes I’m making In my case I have a script that pulls down the config files but this could be used with any number of merge/pukls methods to do the same
After spending yesterday and today upgrading a kobra 2 from marlin to klipper this is EXACTLY what I need. There is NO WAY I want to go through this again. lol Thank you.
Man this just saved me today.. I added the feature few hours after this video released and guess what... 24hrs later my printer its SD-card died,. Thanks to you no config is lost... 🙂
Very nice. I've been manually backing up all my klipper instance to github via ssh from day 1. This script will make it even easier though so I'm gonna switch over to it. Thanks for the video!
Thanks - a great tip, following it now! Please note that RUclips mangled the Github link in that "git clone" command that you've shared, so some folks might have issues copying it.
PSA for those using KIAUH with multiple Klipper instances. On the .env file you'll need to change or add or change the default path: path_klipperdata=printername_data/config* With KIAUH, the printer_data/config folder only has minimal configuration files that are shared through the instances.
hey i'm trying to figure this out myself now, how would i go about multiple instances? have the machine dump all configs to one repo or each machine to a different repo?
Hello, thank you for this tutorial which is in place on my klipper, however, what do we do afterwards, if we have a problem with an update, we just have to redo the files and copy/paste, but if the transition from klipper to a version n Isn't it good how to go back? I have a really difficult card to flash, a K lerdge, and their procedure is wrong, impossible to flash ourselves and I was forced to use their .bin and therefore I am stuck at a certain version of klipper or the bed-mesh is installed, but not yet adaptive and therefore impossible to do it because KAMP conflicts with it and that of klipper is read-only... I have to upgrade it for that but if my card no longer works after that I'm stuck...
I automated my backup to be every week using a delayed_gcode running the shell script on every restart of klipper. I wrote my own shell script, it stores the date of the backup to a txt file and checks if more than a week has passed. For the button in mainsail UI, i added a force parameter to the script, so a button press will always update the config, while the delayed_gcode will run without the force parameter and only update onve a week.
An update to this video is needed.... Klipper no longer has option 8 [G-Code shell Command] available... I have searched through the Kiauh menus and am unable to find this option help please?
I am glad you did a video of this! Great help and much easier to backup. I'm now wondering how to populate my 3d printer cfg files via Github? like when you upload AutoZ or KAMP
Another option is to use a cronjob on the kilpper host to run this. No need to remember to press a macro button or ssh to the klipper host. Set it to run daily/weekly, etc.
Added this backup method. The backup appears to have been updated since this video was created. There are now setup Qs for enabling backup on change of a cfg file, on boot, etc. One thing not explained in the video is how to restore a cfg file from the git repository to the Klipper machine cfg files. I tried copy a cfg file contents from git and paste to the Klipper machine file. This did not work. Scatching my head on how to use contents of git repository to restore cfg files to Klipper machine cfg files in the event a motherboard needs to be replaced or a decision is made to upgrade.
Not just a config file, just create an image of the entire SD card. If the card bites the dust you're just a new card and a write of the image away from just continuing.
Hey, thanks for the video. Is anyone else getting the prompt to log into github while using the clone command? i put in my username and password then it says that password authentication was removed aug 13, 2021.
Thank you ModBot for this great tip! DO NOT RUN KIAH for installing during a print. The Putty/SSH work is find, but KIUAH WILL stop your klipper service. (This you can put a note on the video pop ups?) I should've known better but great guide and I can't wait to use klipper for more QoL upgrades like this. Do you have any recommendations for klipper becoming unreachable and only ever to solve it after a reboot to the entire printer? Hoping there is some auto config to check if there's an active print, and when not, restart the pi and klipper every so often.
Probably a stupid question but how do you restore everything? Is there an automated way to do it or do you just download everything from git onto your new installation? I'm about to reinstall klipper on a new sd card so I'll be wanting to restore all my configs.
I have followed all the steps and can back up by using SSH but the macro button does not appear in my DASHBOARD. I did the powershell and copied the script per your video. HELP.
Well, got close but ran in to an issue. When I go in the klipper-backup nano .env command there is nothing showing for me to add my git up info? not sure where I went wrong, but is there a way to wipe this clean and start over? I did get this message when loading things initially. Cloning into 'klipper-backup'... remote: Enumerating objects: 623, done. remote: Counting objects: 100% (238/238), done. remote: Compressing objects: 100% (80/80), done. remote: Total 623 (delta 185), reused 177 (delta 149), pack-reused 385 Receiving objects: 100% (623/623), 1.34 MiB | 2.51 MiB/s, done. Resolving deltas: 100% (290/290), done. cp: cannot stat './klipper-backup/env.example': No such file or directory
Are you saying you don’t have an .env file? Or yours is blank? If you don’t have an env file it sounds like the main larger command may not have installed properly. If it’s there but blank there and odd one. I deleted my directory once by ftping in and deleting the klipper back up folder. There are also commands that will let you delete it from the terminal: www.freecodecamp.org/news/how-to-delete-a-file-or-directory-in-linux/
@@ModBotArmy I believe what you are asking is when I go in to the place to enter the repository info and key, all I show is GNU nano 5.4 .env with nothing below it. :-( . One other note, was tuff to cut and paste the large command due to it being cut off by RUclips. Guess only way to fix is find file and delete?
OK, Thanks for the link. I used the rm - r command to clean things and try again. This time I was successful and it appears everything has backed up. I'll take a breather and give the macro option a try tomorrow. ;-). Thank you so much for your help and I am slowly learning Klipper with your help. Great resource.
For some reason, the shell_command.cfg file was not created for me after installing the shell command extension via the kiauh steps you noted. I added the macro to my printer.cfg file and it works as intended. Hope this helps someone.
The commands for pulling the repo in the description dont work at least for me it cuts off the repo name after klip, to fix that open the repo over the hyperling and copy it out of the url and replace the broken one. I think this is either an issue with how youtube shortens hyperlinks in the description or my Browser, idk not gonna install another browser to find out. XD
Maybe you don't want a public repo? I'm fairly certain that one of those configs has your wifi password in it. Fairly cool to back stuff up this way, but just be aware of the security implications.
How does this work if you have multiple instances of Klipper installed on one Pi or one BTT7 pad? Do you just run the install script one time and the cfg file appears in all Klipper instances?
I wish I knew this existed previously because I just had my sd card fail on my Mercury 1. Thanks for sharing. Also thinking about investing in a ssd hat for the pi. Does anyone recommend this to reduce the chance of a sd card failure?
In my config directory i have a subfolder config/.theme for adding a bit of customization to mainsail. This hidden folder causes problems when running the backup script. Anyone know how to solve this? warning: adding embedded git repository: printer_data/config/.theme hint: You've added another git repository inside your current repository. hint: Clones of the outer repository will not contain the contents of hint: the embedded repository and will not know how to obtain it. hint: If you meant to add a submodule, use: hint: hint: git submodule add printer_data/config/.theme hint: hint: If you added this path by mistake, you can remove it from the hint: index with: hint: hint: git rm --cached printer_data/config/.theme hint: hint: See "git help submodule" for more information.
A more flexible way is very similar, just don't use the scripts. You can manually handle the git repo in an ssh session. This would then let you comment, branch, revert changed as you like. Learning how to use git from the command line would also allow many other things 'downloaded' from github to be directly managed by git instead.
I would much rather not have my configuration files on the internet. I prefer offline only backups. I just don't like cloud based stuff as I don't have control of the computers storing my data. You also have to pay if you want your repository private.
RUclips seems to have butchered one of the commands in the description. If you have issues with copying and pasting any of the commands you can also find them in the official documentation here: staubgeborener.github.io/klipper-backup/quickstart/
Another SUPER helpful video, Daniel. You continue to show werk-after-week why yours is one of the most valuable 3D printing channels on RUclips!
Thank you for what you do.
Thank you very much for the kind words :)!! I really hope this helps others. Losing a config and having to start over can be such a painful process.
Have a great weekend!
One small security tip: The personal access token (PAT) you created can be used to make changes to any of your repositories. To fix this, when you create the PAT, there is an option there "Fine-grained tokens". Select that option. When creating the token, for "Repository Access" choose "Only select repositories", and then add the repository you just created for the backups. For permissions, expand the "Repository permissions" section and grant read and write permission for "Contents". Those are the only permissions that the script needs. Also, when you're editing the .env value, you can create the setting "commit_username=xxxx", and set xxxx to any value you want (doesn't have to be any kind of user you create). This will just make commits from the script show up under that name. This is useful to distinguish commits from the script from any commits you make yourself.
Thanks for this tip!
Amazing tips thank you
THIS is what RUclips is for. Thank you so much for this video. I use Linux on my PC for everyday use and I found the documentation for Klipper on Git to be exceptionally obtuse. Thank you so much for clarifying literally every questions I was asking.
I just added this to my printers and it is great. Incidentally: the installation now configures all the settings, so you don't have to edit or change anything. Easy installation Thanks for the great content.
Another tip: Document your changes! You solve a lot of problems that you or someone else will need to solve again one day. You may have a config that solves it on one printer, but you can’t just copy it to another printer. Don’t rely on your silly human memory!
I have a git repo for this with commit messages explaining the gist of changes I’m making
In my case I have a script that pulls down the config files but this could be used with any number of merge/pukls methods to do the same
@@admiraladama5877 care to share?
Backing up your klipper machine is super important. Glad your teaching people how to do it easier
After spending yesterday and today upgrading a kobra 2 from marlin to klipper this is EXACTLY what I need. There is NO WAY I want to go through this again. lol
Thank you.
I set this up last week. Works so well, as you can see the version history too 🎉
Man this just saved me today.. I added the feature few hours after this video released and guess what... 24hrs later my printer its SD-card died,. Thanks to you no config is lost... 🙂
wonderful video that perfectly shows what to do to install the backup, thank you so much for making this easy
Thank you for this.
This is something that I've been meaning to do for a long time.
Your video provided the perfect guide.
brilliant video and so easy to follow. Keep up the great content!
Very nice. I've been manually backing up all my klipper instance to github via ssh from day 1. This script will make it even easier though so I'm gonna switch over to it. Thanks for the video!
Always wanted to do this. Thanks for pushing me to install it on both of my machines!
Super easy and worked great! Thanks!
i've used this for a while now. Has saved me a couple of times.
This is supper cool and helpful, thank you. I might just have to show this off in a livestream. Thank you.
Thank you very much, your video made it very easy to install! I'm currently building my first Voron and I hope this precaution will never be used ;)
Thanks - a great tip, following it now!
Please note that RUclips mangled the Github link in that "git clone" command that you've shared, so some folks might have issues copying it.
Thanks for the heads up! I just posted a pinned comment with the link directly to the official docs for anyone having issues.
I wish backup was part of kiauh, as its such a useful tool
PSA for those using KIAUH with multiple Klipper instances.
On the .env file you'll need to change or add or change the default path:
path_klipperdata=printername_data/config*
With KIAUH, the printer_data/config folder only has minimal configuration files that are shared through the instances.
hey i'm trying to figure this out myself now, how would i go about multiple instances? have the machine dump all configs to one repo or each machine to a different repo?
Good info! I need this.... we all need this.
This is neat. I have gites running on my homelab so I will have to try this out.
gracias desde Argentina
i am now all backed up.... thanks!
What Printer is this on the right @0:35 ? is there info about the Z-Setup ? i was searching for something like that for my setup 😇
Thank you for this.
Thanks for the video.
Hello, thank you for this tutorial which is in place on my klipper, however, what do we do afterwards, if we have a problem with an update, we just have to redo the files and copy/paste, but if the transition from klipper to a version n Isn't it good how to go back?
I have a really difficult card to flash, a K lerdge, and their procedure is wrong, impossible to flash ourselves and I was forced to use their .bin and therefore I am stuck at a certain version of klipper or the bed-mesh is installed, but not yet adaptive and therefore impossible to do it because KAMP conflicts with it and that of klipper is read-only... I have to upgrade it for that but if my card no longer works after that I'm stuck...
I automated my backup to be every week using a delayed_gcode running the shell script on every restart of klipper.
I wrote my own shell script, it stores the date of the backup to a txt file and checks if more than a week has passed. For the button in mainsail UI, i added a force parameter to the script, so a button press will always update the config, while the delayed_gcode will run without the force parameter and only update onve a week.
An update to this video is needed.... Klipper no longer has option 8 [G-Code shell Command] available... I have searched through the Kiauh menus and am unable to find this option help please?
I am glad you did a video of this! Great help and much easier to backup. I'm now wondering how to populate my 3d printer cfg files via Github? like when you upload AutoZ or KAMP
Another option is to use a cronjob on the kilpper host to run this. No need to remember to press a macro button or ssh to the klipper host. Set it to run daily/weekly, etc.
all the links are dead....
I haven’t read the docs yet but we should be able to automate this with a cron job to run this script periodically
Added this backup method. The backup appears to have been updated since this video was created. There are now setup Qs for enabling backup on change of a cfg file, on boot, etc. One thing not explained in the video is how to restore a cfg file from the git repository to the Klipper machine cfg files. I tried copy a cfg file contents from git and paste to the Klipper machine file. This did not work. Scatching my head on how to use contents of git repository to restore cfg files to Klipper machine cfg files in the event a motherboard needs to be replaced or a decision is made to upgrade.
Not just a config file, just create an image of the entire SD card. If the card bites the dust you're just a new card and a write of the image away from just continuing.
Hey, thanks for the video. Is anyone else getting the prompt to log into github while using the clone command? i put in my username and password then it says that password authentication was removed aug 13, 2021.
Thank you ModBot for this great tip!
DO NOT RUN KIAH for installing during a print. The Putty/SSH work is find, but KIUAH WILL stop your klipper service. (This you can put a note on the video pop ups?) I should've known better but great guide and I can't wait to use klipper for more QoL upgrades like this.
Do you have any recommendations for klipper becoming unreachable and only ever to solve it after a reboot to the entire printer? Hoping there is some auto config to check if there's an active print, and when not, restart the pi and klipper every so often.
Tried everything here and I only get a folder in my repository printer data with a config folder and nothing in it.
Can you do a video about setting up klippain?
cant find the shell script command anywhere, searched the pages in the links many times,
Probably a stupid question but how do you restore everything? Is there an automated way to do it or do you just download everything from git onto your new installation? I'm about to reinstall klipper on a new sd card so I'll be wanting to restore all my configs.
Make sure when you create your new repository that you don’t put a readme or license in it. I had push issues until I deleted the readme.
git push -f
With fluid you can select all files with one click and zip it. Then download it manually. I do this after I did changes to my configs every time.
my printer config didnt save, any idea what could be the problem? im running an elegoo is that makes a difference
I have followed all the steps and can back up by using SSH but the macro button does not appear in my DASHBOARD. I did the powershell and copied the script per your video. HELP.
Well, got close but ran in to an issue. When I go in the klipper-backup nano .env command there is nothing showing for me to add my git up info? not sure where I went wrong, but is there a way to wipe this clean and start over?
I did get this message when loading things initially.
Cloning into 'klipper-backup'...
remote: Enumerating objects: 623, done.
remote: Counting objects: 100% (238/238), done.
remote: Compressing objects: 100% (80/80), done.
remote: Total 623 (delta 185), reused 177 (delta 149), pack-reused 385
Receiving objects: 100% (623/623), 1.34 MiB | 2.51 MiB/s, done.
Resolving deltas: 100% (290/290), done.
cp: cannot stat './klipper-backup/env.example': No such file or directory
Are you saying you don’t have an .env file? Or yours is blank? If you don’t have an env file it sounds like the main larger command may not have installed properly. If it’s there but blank there and odd one. I deleted my directory once by ftping in and deleting the klipper back up folder.
There are also commands that will let you delete it from the terminal:
www.freecodecamp.org/news/how-to-delete-a-file-or-directory-in-linux/
@@ModBotArmy I believe what you are asking is when I go in to the place to enter the repository info and key, all I show is GNU nano 5.4 .env with nothing below it. :-( . One other note, was tuff to cut and paste the large command due to it being cut off by RUclips. Guess only way to fix is find file and delete?
OK, Thanks for the link. I used the rm - r command to clean things and try again. This time I was successful and it appears everything has backed up. I'll take a breather and give the macro option a try tomorrow. ;-). Thank you so much for your help and I am slowly learning Klipper with your help. Great resource.
For some reason, the shell_command.cfg file was not created for me after installing the shell command extension via the kiauh steps you noted. I added the macro to my printer.cfg file and it works as intended. Hope this helps someone.
is it possible to do it with a gitLAB repo?
The commands for pulling the repo in the description dont work at least for me it cuts off the repo name after klip, to fix that open the repo over the hyperling and copy it out of the url and replace the broken one. I think this is either an issue with how youtube shortens hyperlinks in the description or my Browser, idk not gonna install another browser to find out. XD
is it possible to save mainsail config also?
your git hub copy and paste link needs to be updated.. it doesn't work because of the "kli..."
Maybe you don't want a public repo? I'm fairly certain that one of those configs has your wifi password in it.
Fairly cool to back stuff up this way, but just be aware of the security implications.
How does this work if you have multiple instances of Klipper installed on one Pi or one BTT7 pad? Do you just run the install script one time and the cfg file appears in all Klipper instances?
Klipper 12 messed up my calibration
I wish I knew this existed previously because I just had my sd card fail on my Mercury 1. Thanks for sharing. Also thinking about investing in a ssd hat for the pi. Does anyone recommend this to reduce the chance of a sd card failure?
Question... Can I just set my token to never expire?
It doesn’t appear so 😕. I imagine it’s some sort of security thing but I would totally do the same.
I was able to set it to “no expiration” it’s the last option under “custom” they just warn you about a security risk. I’d check it out!
@@diablodaub good to know! Thanks for the feedback 👍
Cool
How do you do this for multiple instances of Klipper on one device?
Edit .env and include other folders
this vid has been very useful, thanks. but I think it is now obsolete as the process is now very automated with script made by staubgeborener
I splice my micro SD 1 month ago and lost everything (5 years of configurations), didn't have a backup
In my config directory i have a subfolder config/.theme for adding a bit of customization to mainsail. This hidden folder causes problems when running the backup script. Anyone know how to solve this?
warning: adding embedded git repository: printer_data/config/.theme
hint: You've added another git repository inside your current repository.
hint: Clones of the outer repository will not contain the contents of
hint: the embedded repository and will not know how to obtain it.
hint: If you meant to add a submodule, use:
hint:
hint: git submodule add printer_data/config/.theme
hint:
hint: If you added this path by mistake, you can remove it from the
hint: index with:
hint:
hint: git rm --cached printer_data/config/.theme
hint:
hint: See "git help submodule" for more information.
A more flexible way is very similar, just don't use the scripts. You can manually handle the git repo in an ssh session. This would then let you comment, branch, revert changed as you like.
Learning how to use git from the command line would also allow many other things 'downloaded' from github to be directly managed by git instead.
I just do the top select all checkbox and download, it creates a zip file with everything. I toss that on a NAS and sleep easy.
I wish I had this. My child erased my CFG playing with the keyboard cause I left it open
I would much rather not have my configuration files on the internet. I prefer offline only backups. I just don't like cloud based stuff as I don't have control of the computers storing my data.
You also have to pay if you want your repository private.
🖨🖨🖨🖨❤🤟
This video is WAAAAAAAAY out of date, and not at all relevant anymore.