From 18534678f0f600d9e8de8b7a7cc1fa2efd59f03c Mon Sep 17 00:00:00 2001 From: Mike Peralta Date: Sat, 1 Sep 2018 05:21:11 -0700 Subject: [PATCH] Update README.md --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7db0e4a..a56a739 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A simple python script utilizing rsync for both full and differential backups, and auto folder naming, over SSH Honestly this is more of a wrapper around rsync's beautiful functionality. It simply makes daily backups slightly easier by: -* Automatically choosing a *full* or *differential* backup type, based on whether it detects an existing *full* backup folder +* Automatically choosing a *full* or *differential* backup type, based on whether it detects an existing *full* backup folder at the remote end * Automatically generate a folder based on today's date and time, so you can generate a great many *differential* backup folders without manually changing anything ## Requirements @@ -10,6 +10,9 @@ Honestly this is more of a wrapper around rsync's beautiful functionality. It si * python3 * Backup server accessible over SSH +## Assumptions +* Your backup destination is an SSH server + ## Command Line Arguments * ```--full``` Forces the script to run a *full* backup * ```--differential``` Forces the script to run an *incremental* backup @@ -19,6 +22,13 @@ Honestly this is more of a wrapper around rsync's beautiful functionality. It si * ```--remote-user ``` Specifies the remote username to use, when connecting to the remote host * ```--remote-dir ``` Specifies the remote backup destination directory * ```--ssh-key ``` Specifies the local ssh key to use for authentication +* ```--exclude ``` Specifies a source directory to exclude (can be passed multiple times) + +## Example +For daily use, you'll probably want to create a small bash script that calls this script with the parameters you want, and then call that with cron daily (or whatever your preference is) +```#!/bin/bash + +/path/to/mikes-backup --log-dir "/my/log/dir" --source-dir "/home/or/whatever" --remote-host "my-awesome-host.home" --remote-user "me" --remote-dir "/path/to/backup/destination/on/remote/" --ssh-key "/home/me/.ssh/id_rsa" --exclude "/my/dumb/downloads"``` ## Questions I realize these docs are sparse at best, so please send in questions if you have any, and I will try to update this file or create a Wiki if need be