Files
barusu/README.md
Derisis13 ce2ac58341 QA: unused import
doc: updated usage recommendation
2022-08-09 17:16:27 +02:00

38 lines
1.7 KiB
Markdown

# Barusu - a python tool to back up your apt packages and dconf settings
## Usage:
backup_assistant [opts]
Options:
`-h --help`: show help and exit
`-d --backup-dir [directory]`: set the directory for the backup/restoration (default is ~/.backups)
`-r --restore`: run the restoration (from backupdir). You must be root to restore, as you'll install packages. If you are backing up from a directory different from `~/.backup` you need to use the `-d`/`--backup-dir` option BEFORE the `-r`/`--restore`
## Installation
After downloading run in the directory you downloaded barusu to: `python3 setup.py install`
## Using with cron/anacron
In a terminal run: `crontab -e` (you might need to choose an editor to continue)
Once you see your crontab in your editor paste the following line at the end:
```
0 3 * * * barusu
```
This will run barusu every 3:00, but if the computer is off, your daily backup is missed.
Alternatively you can set up anacron (usually not installed by default)
## How it works:
backup:
1. It uses `dpkg` to get a list of all installed packages.
2. It dumps all settings using `dconf`
3. The result is two files in `~/.backup` (unless specified otherwise): `packagelist.txt` and `dconf_out.txt` (and a hidden `.backupdone` file for internal usage of the program
restore:
(you must call the script as root when restoring!)
1. It uses `dpkg` to set a list of operations exported in `~/.backup/packagelist.txt` then calls `apt-get` to install them
2. It uses `dconf` to load settings exported in `~/.backup/dconf_out.txt`
It is possible to provide an alternative backup folder using option `-d` or `backup-dir` as with backups, but you need to specify the folder BEFORE the `-r`/`--restore` option