aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: e75c0fb9c759e70d93eab6690388d34cf1382822 (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
# Crypted backups

## About
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:  
### 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
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**.

### User
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)
* Using [rsync](https://rsync.samba.org/) for backup mirroring

## License
Crypted-backups is licensed under the GPLv3.