[OPEN BETA] New installation script

[Staubgeborener]

@Tylerjet and I are happy to announce that after a lot of work the installation script is going into open beta. Before I go into this, I would like to thank @Tylerjet, who did 99% of the work. 🎉

💡 The idea

The idea behind this script is to automate everything as much as possible, as the manual installation, especially the addition of new features such as cronjobs or systemd services, led to errors for some users.
The script should now guide the user through the most important installation steps and enables us to integrate future features more easily, such as the official KIAUH support.

The script is currently located in a separate branch called installer-beta. After the public beta, everything will be merged into the main branch.

Every user who participates here takes a huge amount of test work off our hands, as there are many scenarios that we simply can't think of.

💝 How to participate

Simply try the installation script to install klipper-backup.

Use it to install various services such as klipper-backup-on-boot.service or klipper-backup-filewatch.service or have a cronjob created automatically. Have a moonraker entry added automatically or not. And so on. Try different constellations and check whether the script actually executes what you expect.

If there is a mistake somewhere - tell us!
If everything is going well - tell us!

All we need is feedback.

📆 How long does the beta last?

I hope only a few weeks. The more data and information we get, the better and faster the beta should be over and everything will be merged into the main branch.

📝 How to use

To use the script and thus participate in the public beta, simply use the following commands in the terminal:

cd ~
cp ./klipper-backup/.env . # create a backup of your .env file in your home directory - just in case!
sudo rm -r ./klipper-backup ./config_backup # we want a clean start so delete the old files
git clone https://github.com/Staubgeborener/klipper-backup
cd ./klipper-backup
git checkout installer-beta

Start installation script: ~/klipper-backup/install.sh (you can still use some of your old .env files: cat ~/.env)

[BenBergman]

Needed to add klipper-backup to a new printer, so this is perfect timing for me. I'll put my notes here.

1. On the GitHub token page, it would be nice if it gave the info for how to generate that or provided a link to that info.
2. When installing the file watch service, I got this error message and it wasn't clear if it self recovered or not
   • /home/biqu/klipper-backup/utils/utils.func: line 189: inotifywait: command not found
   • Running through the installer again did not give me the same error, but changing my printer.cfg isn't pushing new commits to GitHub
   • I have tried doing sudo apt-get install inotify-tools
3. Doing chmod +x * changed the permissions on the readme, so moonraker update thinks my repo is dirty now.
4. On-boot service is not pushing my configs on reboot
5. Filewatch commit message template isn't filled in correctly - printer.cfg modified - %x - %X

Sorry if the constant edits are making this hard to follow live. I figure it is better than me sending a million messages though.

[BenBergman]

Oh, one issue I am seeing withe the filewatch commit - it seems the template didn't fill out correctly. The commit message is printer.cfg modified - %x - %X while the on-boot message is New Backup on boot - 04/16/2024 - 03:10:14 PM

[Tylerjet]

ooop that is probably another Tyler oppsie when i moved it to its own .sh file i forgot to remove the extra escape characters

[Tylerjet]

un momento

[Tylerjet]

@BenBergman alright pushed an update you can pull and try it now along with added some checks that ensure those libinotifyfiles are apt removed if they exists.

[BenBergman]

filewatch commit messages look good now. Thanks for all the rapid help and fixes!

[Kellwaxx11]

Totally new to klipper-backup
I tried the beta installer and everything works fine

• installed without any issues
• files backed up , also on file change triggered ok and backed up

am happy to test more things if needed, but for my basic setup/needs its working perfectly.

Thank you very much

[Staubgeborener]

Thanks for the feedback. Which device do you use for klipper? And could you also provide the os: cat /etc/os-release.

[Kellwaxx11]

I am using a very old 2in1 chinese table "Chuwi Hi8 Air" which comes with Windows+Android.
Chuwi Hi8 Air Specs
but I wiped it out and installed Linux Debian on it, so now it is 2in1 tablet Printer Server + KlipperScreen

output of "cat /etc/os-release"
PRETTY_NAME="Debian GNU/Linux 12 (bookworm)" NAME="Debian GNU/Linux" VERSION_ID="12" VERSION="12 (bookworm)" VERSION_CODENAME=bookworm ID=debian

it not high end at all with 2GB RAM, but havent had any issue with it other than slow wifi (and hard time to get as many hardware to work with Linux as possible)

[Staubgeborener]

Old Chinese 2in1 tablet - tbh I would not have expected that. But when it works, it works.

[n4t3y]

I have installed this beta installation script and I'm having issues backing up:

fly@flypilite2:~$ ~/klipper-backup/script.sh
● Checking for installed dependencies Done!

Klipper-backup is up to date

fatal: not a git repository (or any of the parent directories): .git
fatal: not in a git directory
fatal: not in a git directory
fatal: not a git repository (or any of the parent directories): .git
fatal: not a git repository (or any of the parent directories): .git
fatal: not a git repository (or any of the parent directories): .git
fatal: not a git repository (or any of the parent directories): .git
fatal: not a git repository (or any of the parent directories): .git
fatal: not a git repository (or any of the parent directories): .git
fatal: No remote configured to list refs from.
fatal: not a git repository (or any of the parent directories): .git
fatal: not a git repository (or any of the parent directories): .git

Is the output.

Any ideas what the issue might be? I am directing it to this repo: https://github.com/n4t3y/klipper-configuration-backup

[n4t3y]

I wiped my SD card and reinstalled the image. It's not a RPI so I had to use a custom image (Mellow Fly Pi Lite 2).

I ran the klipper-backup per the docs (non-beta) but it kept saying that install.sh was not found, so then I found this beta install and went through the process, ending up with this error I initially posted about.

I'm happy to provide any information you need to help track down any faults (if any)

[n4t3y]

fly@flypilite2:~$ history
    1  exit 0
    2  kiauh/kiauh.sh
    3  sudo apt update && sudo apt install git[B
    4  cd ~ && git clone https://github.com/Staubgeborener/klipper-backup.git && chmod +x ./klipper-backup/script.sh ./klipper-backup/install.sh
    5  cd ~ && ./klipper-backup/install.sh
    6  /klipper-backup/install.sh
    7  cd ~
    8  ls
    9  cd klipper-backup
   10  ls
   11  script.sh
   12  cd ~
   13  cd ~ && git clone https://github.com/Staubgeborener/klipper-backup.git && chmod +x ./klipper-backup/script.sh ./klipper-backup/install.sh
   14  sudo rm klipper-backup
   15  sudo rmdir klipper-backup
   16  sudo rm -r klipper-backup
   17  cd ~ && git clone https://github.com/Staubgeborener/klipper-backup.git && chmod +x ./klipper-backup/script.sh ./klipper-backup/install.sh
   18  cd ~ && git clone https://github.com/Staubgeborener/klipper-backup.git && chmod +x ./klipper-backup/script.sh
   19  sudo rm -r klipper-backup
   20  cd ~ && git clone https://github.com/Staubgeborener/klipper-backup.git && chmod +x ./klipper-backup/script.sh
   21  ./klipper-backup/install.sh
   22  sudo reboot
   23  sudo rm -r klipper-backup
   24  cd ~ && git clone https://github.com/Staubgeborener/klipper-backup/tree/installer-beta && chmod +x ./klipper-backup/script.sh
   25  cd ~ && git clone https://github.com/Staubgeborener/klipper-backup/tree/installer-beta/klipper-backup.git && chmod +x ./klipper-backup/script.sh
   26  cd ~ && git clone -b installer-beta https://github.com/Staubgeborener/klipper-backup
   27  chmod +x ./klipper-backup/script.sh ./klipper-backup/install.sh
   28  ./klipper-backup/script.sh
   29  ./klipper-backup/install.sh
   30  ~/klipper-backup/script.sh
   31  cd ~ && git clone https://github.com/Staubgeborener/klipper-backup.git && chmod +x ./klipper-backup/script.sh
   32  cd ~ && chmod +x ./klipper-backup/script.sh ./klipper-backup/install.sh
   33  ./klipper-backup/install.sh
   34  ~/klipper-backup/script.sh
   35  cd ~
   36* cp ./klipper-backup/.env .
   37  sudo rm -r ./klipper-backup ./config_backup
   38  git clone https://github.com/Staubgeborener/klipper-backup
   39  cd ./klipper-backup
   40  git checkout installer-beta
   41  install.sh
   42  cd~
   43  cd ~
   44  ~/klipper-backup/install.sh
   45  ~/klipper-backup/script.sh
   46  cd ~
   47  rm -r config_backup
   48  ~/klipper-backup/script.sh
   49  rm -r config_backup
   50  ~/klipper-backup/install.sh
   51  ~/klipper-backup/script.sh
   52  cp.env.bkp .env
   53  cp .env.bkp .env
   54  cp .env.example .env
   55  cd klipper-backup
   56  cp .env.example .env
   57  script.sh
   58  cd ~
   59  ~/klipper-backup/script.sh
   60  ~/klipper-backup/install.sh
   61  ~/klipper-backup/script.sh
   62  cd ~
   63  rm -rf config_backup
   64  cd klipper-backup
   65  ls
   66  cd ~
   67  ~/klipper-backup/script.sh
   68  history

[Tylerjet]

hrmm so to me it seems like it could have been a combination of doing different steps between each of the branches that probably it didn't like. I think Staubgeborener updated some of the docs preparing to merge this to main so that may have messed up the normal steps that would have worked hehe.

[n4t3y]

Haha, oh well, at least it's working now. I did have it working (non-beta) before I wiped the Sd card, but I had issues reinstalling everything so had to wipe and start again. Originally I installed it on 23rd April without any issues, so not sure if there's been recent changes which affected my install this time around

[Staubgeborener]

I think Staubgeborener updated some of the docs preparing to merge this to main so that may have messed up the normal steps that would have worked hehe.

Yeah, that issue is my fault.

In @n4t3y history you can see at line 4
cd ~ && git clone https://github.com/Staubgeborener/klipper-backup.git && chmod +x ./klipper-backup/script.sh ./klipper-backup/install.sh

which is the latest edit in the docs which i did yesterday. There is no git checkout command in order to get install.sh (and any other installation file).

I wanted to merge the beta branch into the main branch asap and was probably a bit too hasty. Hooopsie.

[Staubgeborener]

Thanks to everyone, v1.3.0 is now released.

[Staubgeborener]

@BenBergman @Kellwaxx11 @n4t3y We started a new beta for the restore function.