keeper.git

This is a bash script utility that backs up or loads the files that you specify to wherever you specify

How to use?

Usage

Usage: keeper.sh [options]
general:
    -b, --backup          backup option [requires -t]
    -r, --restore         restore option [requires -f]
    -f, --from <path>     in case of restore, specify the backup file
                          in case of backup its optional, specify the directory to start from [default=\$PWD]
    -t, --to <path>       in case of backup, specify the name of the backup file
                          in case of restore its optional, specify the directory to restore to [default=\$PWD]
    --no-confirm          don't ask for confirmation before executing the backup/restore
    --no-color            don't use colors in output
    --dont-run            run everything but the backup/restore
    -h, --help            show this help message

backup:
    --profiles            show the available profiles
    --profile <profile>   backup profile (what files to backup), default is 'default'
    -m, --message <msg>   in case of backup, the message to be added to the backup info file (to be previewed)
    --message-file <file> in case of backup, the file to be added to the backup info file (to be previewed)
                          this option is made for when the message you want is pre-made or multilined
restore:
    --preview             preview information about the backup before restoring it
    --only-preview        calls --preview and --dont-run
    --sed-home-path       will replace the old home path with the new one inside all the files from the archive
                          mainly used for images and files that were written as in /home/<old_user> inside
                          config files and now are in /home/<new_user>

** Note: you cannot combine options as one command line argument e.g: **
Good:
    keeper.sh -b -f $HOME -t /tmp/backup.tar.gz
Bad:
    keeper.sh -bf $HOME -t /tmp/backup.tar.gz

TL;DR (examples)

# backup starting from my current directory to backup.zip
./keeper.sh -b [options] -t backup.zip
# backup starting from a specific directory to backup.zip
./keeper.sh -b [options] -t backup.zip -f <specific directory>

# restore my backup.zip to home directory
./keeper.sh -r [options] -f backup.zip
# restore my backup.zip to a specific directory
./keeper.sh -r [options] -f backup.zip -t <specific directory>

# restore my backup.zip to a specific directory from a script that restores that config to
# a new user (at least that how I'd do it)
./keeper.sh -r --no-confirm --sed-home-path -f backup.zip -t <specific directory>

What can be backed up?

Everything! I use it to back up an entire template home directories for quickly setting up a user when going onto a new machine including wallpapers and programs preferences. It comes with a few templates so you can use them or learn from them how to create your own.

Features

• different archive types (.zip, .tar.gz)
• execute purely from command line arguments
• support external archive profiles look here for more information
• choose a backup profile
• preview archive information
• edit the content when restoring a backup according to the new user

Create you own profiles

you can easily make your own archive profiles just look on the doc and look at the already existing profiles for ideas.

Archive internals

with the knowledge about the layout and the parts you can create your own archives without using the script and modify existing backups to work with it

Archive info file

this file will contain information that helps keeper to present and use the archive (it is located in /archive.info)

you can add to this file other stuff outside of what listed in the example 'creator' field is required if you want to use the --sed-home-path option

Archive information file

the archive info file must be with the 4 first lines:

1. comment line
2. creator name
3. date
4. one line doc The other lines will be printed later as a message if preview is chosen

# default archive.info file
creator='$USER'
date_archive_created='$(date +%Y-%m-%d)'
doc='backup made by $USER on $HOSTNAME'
# Preview message
This archive is for KDE and needs such and such
packages, Enjoy

Archive layout

|- <archive-name>/            The archive
|  |- archive.info            File that contains the information about the archive
|  |- all the other the stuff