updated README
This commit is contained in:
parent
dc9de46413
commit
3dcaaa0114
17
README.md
17
README.md
|
@ -1,5 +1,4 @@
|
|||
sshbackup
|
||||
=========
|
||||
# sshbackup
|
||||
|
||||
for automated backups configure a sshkey for the user running sshbackup.
|
||||
|
||||
|
@ -8,8 +7,7 @@ make automated backups work
|
|||
```backupuser ALL=(root)NOPASSWD: /usr/bin/rsync```
|
||||
|
||||
|
||||
scheduling
|
||||
----------
|
||||
### scheduling
|
||||
using cron will help you with that. example /etc/crontab:
|
||||
```
|
||||
SHELL=/bin/sh
|
||||
|
@ -23,16 +21,14 @@ MAILTO="admin@example.com"
|
|||
```
|
||||
|
||||
|
||||
notifications
|
||||
-------------
|
||||
### notifications
|
||||
utilize crons MAILTO directive for getting error notifications.
|
||||
```
|
||||
MAILTO=admin@example.com
|
||||
```
|
||||
|
||||
|
||||
automation
|
||||
----------
|
||||
### automation
|
||||
for automated backups configure a sshkey for the root user and
|
||||
configure your remote machines to trust that key.
|
||||
```
|
||||
|
@ -51,8 +47,7 @@ backupuser@dev.socialnerds.org:/home/gollum/ /home/david/Downloads/gollum
|
|||
```
|
||||
|
||||
|
||||
~/.sshbackup
|
||||
------------
|
||||
### ~/.sshbackup
|
||||
a example config for default values looks like this [optional]:
|
||||
```
|
||||
#rsync options.
|
||||
|
@ -63,7 +58,7 @@ localcmd="/usr/bin/rsync"
|
|||
sshkeyfile="$HOME/.ssh/id_rsa"
|
||||
```
|
||||
|
||||
future features
|
||||
### future features
|
||||
---------------
|
||||
- [x] notification on errors (with cron for now)
|
||||
- [ ] useful logging
|
||||
|
|
Reference in New Issue