sshbackup/README.md

sshbackup
=========

for automated backups configure a sshkey for the user running sshbackup.

you must add following to /etc/sudoers on your remote servers as well to
make automated backups work
```backupuser ALL=(root)NOPASSWD: /usr/bin/rsync```


scheduling
----------
using cron will help you with that. example /etc/crontab:
```
SHELL=/bin/sh
PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
MAILTO="admin@example.com"

# m h dom mon dow user  command
0 2     * * *   root    sshbackup /path/to/source /path/to/destination 5
0 3     * * *   root    sshbackup -s /path/to/sshkey -l /path/to/listfile
0 4     * * *   root    sshbackup bkpuser@server:/path/to/source /path/to/destination 30
```


notifications
-------------
utilize crons MAILTO directive for getting error notifications.
```
MAILTO=admin@example.com
```


automation
----------
for automated backups configure a sshkey for the root user and
configure your remote machines to trust that key.
```
sudo su
ssh-keygen
ssh-copy-id <remote machine>
```

you can use a file which should have a source/destination combination each line.
example listfile:
```
#<source> <destination> [<versions>]
david@dev.socialnerds.org:/home/david /home/david/Downloads/devhome 30
backupuser@dev.socialnerds.org:/home/gollum/ /home/david/Downloads/gollum
/home/david/something /home/david/backup 5
```


~/.sshbackup
------------
a example config for default values looks like this [optional]:
```
#rsync options.
rsyncoptions="-pogEthrzl --numeric-ids --no-motd"
#dotglob option removes bug while rsyncing folder with no visible files in it.
remotecmd="shopt -s dotglob; /usr/bin/sudo /usr/bin/rsync"
localcmd="/usr/bin/rsync"
sshkeyfile="$HOME/.ssh/id_rsa"
```

future features
---------------
- [x] notification on errors (with cron for now)
- [ ] useful logging
- [ ] remote settings deployment
- [ ] bandwidth limits
- [ ] sshkey creation/management
- [ ] some kind of optional reports/stats
- [ ] install missing dependencies