diff options
| author | xengineering <me@xengineering.eu> | 2021-10-10 11:41:40 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2021-10-10 11:48:30 +0200 |
| commit | b143bb0fc8ac9d8cc9a40e9bd92108ab3dcef11d (patch) | |
| tree | 345d172e90d6da9e3ce0afdc18f98ec5d82bcdb3 | |
| parent | a16f53af407ac95c76478761cd5a1180988d0207 (diff) | |
| download | xbackup-b143bb0fc8ac9d8cc9a40e9bd92108ab3dcef11d.tar xbackup-b143bb0fc8ac9d8cc9a40e9bd92108ab3dcef11d.tar.zst xbackup-b143bb0fc8ac9d8cc9a40e9bd92108ab3dcef11d.zip | |
Update Documentation
| -rw-r--r-- | README.md | 34 |
1 files changed, 27 insertions, 7 deletions
@@ -59,6 +59,10 @@ make tarball ## Usage +This section covers the main use cases addressed by xbackup. + +### Configuration + Please edit the configuration file at `/etc/xbackup/config.json` before you run the software. It contains suitable defaults for a full system backup which is the main purpose of this script. @@ -69,17 +73,33 @@ because they are virtual filesystems from the Linux kernel (like `/dev`), only contain temporary data (like `/tmp`) or are not part of the system itself (like `/mnt` or `/media`). +### Make a Backup + After configuration you can run the backup like this: ``` -sudo xbackup -c path/to/my/config.json backup +sudo xbackup backup ``` -In case of the default configuration location `/etc/xbackup/config.json` you can -skip the `-c` option. In addition you can select `--script` to avoid the -interactive execution of the script. +For further details run `xbackup --help`. There are options to select a +different configuration file and for a non-interactive execution which is +suitable for scripting. + +### Prune your Backups + +Just making backups leads to increased disk space usage. To avoid a harddrive +full of backups the Borg backup tool allows you to prune your backups. This +functionality is also wrapped by xbackup. + +Edit the configuration file to select how many backups you want to keep. Then +run: + +``` +sudo xbackup prune +``` -For further details run `xbackup --help`. +This will clean up the backup repository in the location specified by your +configuration file. ## Done / Features @@ -95,13 +115,13 @@ For further details run `xbackup --help`. - [x] setup project structure -## To Do / Feature Requests +## To do / Feature Requests (Highest priority first) - [ ] release v1.0.0 - [ ] MariaDB fullbackup -- [ ] backup systemd daemon +- [ ] backup daemon - [ ] backup transfer tool (?) - [ ] backup diff tool (backup vs. filesystem) - [ ] backup restore tool with qemu (for testing) |