diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 8 insertions, 7 deletions
@@ -1,8 +1,8 @@ # Crypted backups ## About -This collection of systemd timers/services and scripts enables a precise - gpg encrypted - backup of certain configuration data. -System-wide backups and user-specific backups are possible. +This collection of services, timers and scripts enables a precise - gpg encrypted - backup of certain configuration data. +System-wide and user-specific backups are possible. ## Features Backups of the following program settings/profiles/folders are possible: @@ -10,7 +10,7 @@ Backups of the following program settings/profiles/folders are possible: * aura * bitlbee * git -* mail/ mailman +* mail & mailman * mariadb * /var/log * /var/log/journal @@ -24,14 +24,15 @@ Backups of the following program settings/profiles/folders are possible: 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. +Two forms of configuration files are used: One for system-wide services and one for user services. +Both are documented and show examples on how to setup the variables. ### System -The configuration file for system services can be found in */etc/crypted-backups* and is well documented. +The configuration file for system services can be found in **/etc/crypted-backups**. ### 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**). +The configuration file for user services is read first from **$HOME/.crypted-backups** followed by **$HOME/.config/crypted-backups**. Environment variables set in the first file will be replaced by the ones set in the latter, if present. +Make sure to copy and modify a plain one from your system skeleton folder (**/etc/skel/.crypted-backups**). ## TODO * Using [pixz](https://github.com/vasi/pixz) |