diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 46 |
1 files changed, 33 insertions, 13 deletions
@@ -5,17 +5,37 @@ This collection of systemd timers/services and scripts enables a precise - gpg e System-wide backups and user-specific backups are possible. ## Features -**System**: Backups of the following program settings/ folders are possible: -- aura -- bitlbee -- git -- mail/ mailman -- mariadb -- /var/log -- /var/log/journal -- websites - -**User**: Backups of the following program profiles are possible: -- firefox -- thunderbird +Backups of the following program settings/profiles/folders are possible: +### System +* aura +* bitlbee +* git +* mail/ mailman +* mariadb +* /var/log +* /var/log/journal +* websites +### User +* firefox +* thunderbird + +## Requirements +At the moment crypted-backups only supports [xz](http://tukaani.org/xz/) compression. + +## Configuration +Crypted-backups uses two forms of configuration files. One for system-wide services and one for user services. + +### System +The configuration file for system services can be found in */etc/crypted-backups* and is well documented. + +### User +The configuration file for user services is read from *$HOME/.config/crypted-backups*. +Make sure to copy and modify one from your system skeleton folder (**/etc/skel/.crypted-backups**). + +## TODO +* Using [pixz](https://github.com/vasi/pixz) +* Using [rsync](https://rsync.samba.org/) for backup mirroring + +## License +Crypted-backups is licensed under the GPLv3. |