diff options
| author | xengineering <me@xengineering.eu> | 2021-09-04 10:36:12 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2021-09-04 10:36:12 +0200 |
| commit | fbb5e1c7458842548851b36934c2e8b91b7ce208 (patch) | |
| tree | aaf41329ea96759cb560fc0f6e6183440d76bd06 /README.md | |
| parent | 5d0e725d2bd6208a7342394886a589045f645b94 (diff) | |
| download | xbackup-fbb5e1c7458842548851b36934c2e8b91b7ce208.tar xbackup-fbb5e1c7458842548851b36934c2e8b91b7ce208.tar.zst xbackup-fbb5e1c7458842548851b36934c2e8b91b7ce208.zip | |
Update Documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
@@ -5,6 +5,24 @@ This is a convenience wrapper around the Borg backup tool. +## Expected Environment + +This tool is designed for Arch Linux. Because it is written in Python and has minimal dependencies it should be easy to adapt it to other Linux distributions. + + +## Installation + +For Arch Linux: + +``` +git clone https://src.xengineering.eu/xengineering/xbackup.git +cd xbackup/archlinux +make install +``` + +This will create the Arch Linux package for xbackup and installs it as a foreign / unofficial package (like the AUR packages). + + ## Done / Features (Last finished task first) @@ -20,7 +38,9 @@ This is a convenience wrapper around the Borg backup tool. (Highest priority first) - [ ] manual backup functionality / MVP +- [ ] software list file support (generates list of all linux packages) - [ ] XMPP notification via [xbot](https://gitea.xengineering.eu/xengineering/xbot) +- [ ] MariaDB fullbackup - [ ] backup systemd daemon - [ ] backup transfer tool (?) - [ ] backup diff tool (backup vs. filesystem) |