summaryrefslogtreecommitdiff
path: root/README.md
blob: e7554bd6a2f3c4c1d6b0383d7a4f6f34f729ec29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65


# xbackup

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.

These dependencies have to be installed:

- [python3](https://www.python.org/)
- [borg](https://www.borgbackup.org/)


## Installation

The Makefile of this repository contains an `install` target. Simply run

```
sudo make install
```

to install it to your system. Alternatively you can install it to a fake root
folder:

```
sudo make DESTDIR="path/to/my/fakeroot" install
```

or create only a tar archive from this source for external packaging:

```
make tarball
```


## Done / Features

(Last finished task first)

- [x] move Arch Linux packaging to pkgbuilds repository
- [x] manual backup functionality / MVP
- [x] config parsing
- [x] argument parsing
- [x] implement Arch Linux Packaging
- [x] setup project structure


## To Do / Feature Requests

(Highest priority first)

- [ ] implement purge 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)