Managing SSH chroots to backup a lot of machines
Go to file
Benoît.S cda75d8c79 Merge branch 'master' into beautification-of-backups-commands 2019-07-10 14:34:35 +02:00
docs Fix default bkctld.conf path in docs 2019-01-29 10:48:52 -05:00
lib Use mktemp for keepfile and rm it after usage (Fix #9) 2019-02-18 11:32:28 +01:00
test Rewrite bats test 2019-01-28 17:51:41 -05:00
tpl Use lastlog in sshrc 2019-01-28 17:51:41 -05:00
.gitignore Add a Vagrantfile for test with Vagrant 2018-03-05 14:15:23 +01:00
LICENSE fix file name 2017-08-05 17:33:00 -04:00 Improved and adjacent files. 2019-01-28 17:51:41 -05:00
Vagrantfile Fix shell error on vagrant provision 2019-01-28 17:51:41 -05:00
bash_completion Subcommand list are now dynamic in bash completion 2019-01-28 17:51:41 -05:00
bkctld Do not create dirs in bkctld script 2019-01-28 17:51:41 -05:00
bkctld.8 Fix default bkctld.conf path in docs 2019-01-29 10:48:52 -05:00
bkctld.conf bkctld.conf: Add NODE by default 2019-03-18 16:50:06 +01:00
bkctld.conf.5 Fix default bkctld.conf path in docs 2019-01-29 10:48:52 -05:00
bkctld.service Transform bkctld SysVinit script into systemd oneshot service 2019-01-28 17:51:41 -05:00 Add a script 2019-03-29 18:20:46 +01:00
evobackup-incl.5 Switch documentation to mdoc(7) 2019-01-02 13:45:21 -05:00
zzz_evobackup Merge branch 'master' into beautification-of-backups-commands 2019-07-10 14:34:35 +02:00

Bkctld (aka evobackup)

Bkctld is a shell script that creates and manages a backup server which can handle the backups of many other servers (clients). It is licensed under the AGPLv3.

It uses SSH chroots (called "jails" in the FreeBSD world) to sandbox every clients backups. Each client will upload it's data every day using rsync in it's chroot (using the root account). Prior backups are stored incrementally outside of the chroot using hard links or BTRFS snapshots. (So they can not be affected by the client).

Using this method, we can keep a large quantity of backups of each client securely and efficiently.

                                    Backup server
Server 1 ------ SSH/rsync ------->  * tcp/2222 *
                                    *          *
Server 2 ------ SSH/rsync ------->  * tcp/2223 *

This method uses standard tools (ssh, rsync, cp -al, btrfs subvolume) and has been used for many years by Evolix to backup hundreds of servers, totaling many terabytes of data, each day. bkctld has been tested on Debian Jessie and should be compatible with other Debian versions or derived distributions like Ubuntu.

A large enough volume must be mounted on /backup, we recommend the usage of BTRFS so you can use sub-volumes and snapshots. This volume can also be encrypted with LUKS.


See the installation guide for instructions.


You can deploy test environments with Vagrant :

vagrant up


Launch rsync-auto in a terminal for automatic synchronization of your local code with Vagrant VM :

vagrant rsync-auto


You can run bats tests with the test provision :

vagrant provision --provision-with test


See docs/

The man(1) page, in troff(7) language, can be generated with pandoc:

pandoc -f markdown \
	-t man \
	--template \
	-V title=bkctld \
	-V section=8 \
	-V date="$(date '+%d %b %Y')" \
	-V footer="$(git describe --tags)" \
	-V header="bkctld man page"

Client configuration

You can save various systems in the evobackup jails : Linux, BSD, Windows, MacOSX. The only prerequisite is the rsync command.

rsync -av -e "ssh -p SSH_PORT" /home/ root@SERVER_NAME:/var/backup/home/

An example synchronization script is present in zzz_evobackup, clone the evobackup repository and read the CLIENT CONFIGURATION section of the manual.

git clone
cd evobackup
man ./docs/bkctld.8