Creating a backup - Phil1988/FreeDi GitHub Wiki

In most cases a basic backup is totally sufficient and fine.
However a full image backup never hurts and will help if you want to revert back to the the stock system...
...for whatever insane reason you might have ;)

Basic backup:

There are two ways to create a basic backup of your printer configuration:

Method 1: Browser-based backup (beginner friendly)

Important

Your browser or operating system may block the downloaded files, claiming *.cfg might be potentially dangerous.
So please make sure to have them downloaded properly (and these are by the way NOT dangerous for your PC 😅)

Click here to see the guide
Use your favorite browser to access your printer.
For the stock printer use the port 10088: http//YourPrintersIPaddess:10088
For non stock printers no port (default 80): http//YourPrintersIPaddess

On Fluidd (eg. for the stock system)

image

  1. Go to Config [1]
  2. Right-Click on each file in the list [2]
  3. Click download to save each file [3]
  4. Save it somewhere, where you can find it later ;)

On Mainsail

image

  1. Go to Machine [1]
  2. Check all the files in the config path [2]
  3. Click download to save the zip compressed config [3]
  4. Save it somewhere, where you can find it later ;)

Method 2: SSH-based backup (recommended if you are familiar with the SSH terminal)

Click here to see the guide

This method is faster and less tedious than downloading files individually.

Step 1 — Create a backup archive on the printer

SSH into your printer with the default password makerbase (unless changed).
Then run:

cd ~
tar czf klipper-config-backup.tar.gz klipper_config

You should now have:

/home/mks/klipper-config-backup.tar.gz

Verify the backup:

ls -lh klipper-config-backup.tar.gz

Step 2 — Download it to your computer

Download the file using an SFTP client such as WinSCP from:
/home/mks/klipper-config-backup.tar.gz

Alternatively, download via command line:

Windows (PowerShell or CMD)

scp mks@PRINTER_IP:/home/mks/klipper-config-backup.tar.gz %USERPROFILE%\Downloads\

Or in PowerShell:

scp mks@PRINTER_IP:/home/mks/klipper-config-backup.tar.gz $env:USERPROFILE\Downloads\

Note for Windows users:
Windows 10 (1809+) and Windows 11 include OpenSSH by default.
If scp is missing, install it via:
Settings → Apps → Optional Features → Add "OpenSSH Client"

If you're using Tailscale

scp [email protected]:/home/mks/klipper-config-backup.tar.gz ~/Downloads/

(Windows users: replace ~/Downloads/ with the Windows path above)

If SCP hangs or stalls (legacy mode)

scp -O mks@PRINTER_IP:/home/mks/klipper-config-backup.tar.gz ~/Downloads/

(Windows users: adjust the path accordingly)

Mac/Linux

scp mks@PRINTER_IP:/home/mks/klipper-config-backup.tar.gz ~/Downloads/

Optional: One-liner that streams directly to your PC

No file is created on the printer — data streams directly to your PC.

Windows (PowerShell)

ssh mks@PRINTER_IP "tar czf - -C ~ klipper_config" | Set-Content -Path "$env:USERPROFILE\Downloads\klipper-config-backup.tar.gz" -Encoding Byte

Windows (CMD)

ssh mks@PRINTER_IP "tar czf - -C ~ klipper_config" > %USERPROFILE%\Downloads\klipper-config-backup.tar.gz

Mac/Linux

ssh mks@PRINTER_IP "tar czf - -C ~ klipper_config" > ~/Downloads/klipper-config-backup.tar.gz

Restore instructions

If you reflash or reinstall, use:

Windows

scp %USERPROFILE%\Downloads\klipper-config-backup.tar.gz mks@PRINTER_IP:/home/mks/
ssh mks@PRINTER_IP "tar xzf klipper-config-backup.tar.gz"

Or:

scp $env:USERPROFILE\Downloads\klipper-config-backup.tar.gz mks@PRINTER_IP:/home/mks/
ssh mks@PRINTER_IP "tar xzf klipper-config-backup.tar.gz"

Mac/Linux

scp ~/Downloads/klipper-config-backup.tar.gz mks@PRINTER_IP:/home/mks/
ssh mks@PRINTER_IP "tar xzf klipper-config-backup.tar.gz"

This will restore the full klipper_config directory.

Full image backup

  1. Shutdown the printer and turn off the power via the switch on the back (or pull the plug).
  2. Open the cover on the backside to get access to the mainboard.
  3. Remove the two screws and detach the EMMC card:
    image
  4. Use an EMMC card reader to connect it to your PC.
  5. Open an imager software like Win32DiskImager and backup the entire EMMC by creating an *.img file: image

Next Chapter:

Installation Tour #1: You have a stock system or want to start fresh (recommended)
OR
Installation Tour #2: You have already installed a custom OS and only want to add FreeDi to get the Display funtionality

⚠️ **GitHub.com Fallback** ⚠️