updated README
This commit is contained in:
parent
dc56cb53b1
commit
ebef9cf1cc
31
README.md
31
README.md
|
@ -1,14 +1,39 @@
|
|||
# sshbackup
|
||||
sshbackup is a shell script for doing incremental backups.
|
||||
it creates as many incremental versions of a folder as you
|
||||
wish for and it does that with local folders as well as with
|
||||
remote folders.
|
||||
|
||||
### installation
|
||||
```sh
|
||||
sudo wget https://raw.github.com/beyondthewall/sshbackup/0.3/sshbackup /usr/bin/sshbackup
|
||||
sudo chmod +x /usr/bin/sshbackup
|
||||
```
|
||||
|
||||
|
||||
### usage
|
||||
```
|
||||
"usage: sshbackup <options> source destination [versions]"
|
||||
"source/destination example: [[user@]server:]/path/to/files"
|
||||
|
||||
"OPTIONS:"
|
||||
-h, --help show this message"
|
||||
-v, --version version information"
|
||||
|
||||
-c, --config <file> alternate config file [~/.sshbackup]"
|
||||
-l, --list <file> list of sources and destinations"
|
||||
-s, --sshkey <file> alternate sshkey [~/.ssh/id_rsa]"
|
||||
```
|
||||
|
||||
|
||||
### scheduling
|
||||
using cron will help you with that. example /etc/crontab:
|
||||
using cronjobs is the way to go. 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
|
||||
#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
|
||||
|
@ -51,7 +76,7 @@ backupuser@dev.socialnerds.org:/home/gollum/ /home/david/Downloads/gollum
|
|||
|
||||
|
||||
### ~/.sshbackup
|
||||
a example config for default values looks like this [optional]:
|
||||
an example config for default values looks like this [optional]:
|
||||
```
|
||||
#rsync options.
|
||||
rsyncoptions="-pogEthrzl --numeric-ids --no-motd"
|
||||
|
|
Reference in New Issue