diff options
| author | xengineering <me@xengineering.eu> | 2021-10-08 09:36:02 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2021-10-09 10:36:27 +0200 |
| commit | 9416508e428fe501233cc2454c227050660d4aca (patch) | |
| tree | 538ffbbb7eacf51ba7629ea7cf7e8952e712963b /README.md | |
| parent | aca7009fda289a6b2f0d53a1ee5fbdbe62094420 (diff) | |
| download | xbackup-9416508e428fe501233cc2454c227050660d4aca.tar xbackup-9416508e428fe501233cc2454c227050660d4aca.tar.zst xbackup-9416508e428fe501233cc2454c227050660d4aca.zip | |
Update Documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 48 |
1 files changed, 45 insertions, 3 deletions
@@ -18,6 +18,25 @@ These dependencies have to be installed: ## Installation +Please select the right subsection for your system. + +### Arch Linux + +Visit my [packaging repository ](https://gitea.xengineering.eu/xengineering/pkgbuilds/src/branch/master/xbackup) +to get the build files. You can then install the software like an AUR package +following the [recommendations](https://wiki.archlinux.org/title/Arch_User_Repository#Installing_and_upgrading_packages) +in the Arch Linux wiki. + +### Other Linux Distributions + +The Makefile of this repository will help you to install the software or create +a tar archive of a certain commit (which could be helpful for packaging). + +Keep in mind, that there is no maintained way to uninstall the software via the +Makefile! The reason for that is an additional amount of work, the possibility +of bugs in the uninstall routine and the existence of package managers for Linux +which guarantee you correct uninstallation. + The Makefile of this repository contains an `install` target. Simply run ``` @@ -38,6 +57,31 @@ make tarball ``` +## Usage + +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. + +Using the default configuration, xbackup will include everything from the root +folder `/` blacklisting only folders which are not reasonable for a backup, +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`). + +After configuration you can run the backup like this: + +``` +sudo xbackup -c path/to/my/config.json 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`. + + ## Done / Features (Last finished task first) @@ -54,12 +98,10 @@ make tarball (Highest priority first) -- [ ] implement purge command +- [ ] implement prune command - [ ] release v1.0.0 -- [ ] XMPP notification via [xbot](https://gitea.xengineering.eu/xengineering/xbot) - [ ] MariaDB fullbackup - [ ] backup systemd daemon - [ ] backup transfer tool (?) - [ ] backup diff tool (backup vs. filesystem) - [ ] backup restore tool with qemu (for testing) - |