c8bf5526705bbb0a1b05b2d86c38c9a163d4a86c

Message

Make readme pretty! (using markdown)

Diff

This diff is truncated to protect this page.

  1diff --git a/README b/README
  2deleted file mode 100644
  3index dc939aa6a7e3625247a77c2af8efd0417159d210..0000000000000000000000000000000000000000
  4--- a/README
  5+++ /dev/null
  6@@ -1,171 +0,0 @@
  7-ABOUT THIS SCRIPT
  8-=================
  9-
 10-This bash script was designed to automate and simplify the remote backup process
 11-of duplicity on Amazon S3 primarily. Other backup destinations are possible
 12-(FTP, SFTP, SCP, rsync, file...), i.e. any of duplicity's supported outputs.
 13-
 14-After your script is configured, you can easily backup, restore, verify and
 15-clean (either via cron or manually) your data without having to remember lots of
 16-different command options and passphrases.
 17-
 18-Most importantly, you can easily backup the script and your gpg key in a
 19-convenient passphrase-encrypted file. This comes in in handy if/when your
 20-machine ever does go belly up.
 21-
 22-Optionally, you can set up an email address where the log file will be sent,
 23-which is useful when the script is used via cron.
 24-
 25-This version is a rewriting of the code originally written by Damon Timm,
 26-including many patches that have been brought to the original scripts by various
 27-forks on Github.
 28-
 29-Latest version of the code available at:
 30-http://github.com/zertrin/duplicity-backup
 31-
 32-Merge requests are welcome :)
 33-
 34-More information about this script available at:
 35-http://zertrin.org/projects/duplicity-backup/
 36-
 37-The original version of the code is availabe at:
 38-http://github.com/theterran/dt-s3-backup
 39-
 40-BEFORE YOU START
 41-================
 42-
 43-This script requires user configuration. Instructions are in the config file
 44-itself and should be self-explanatory. Please DO NOT edit the example config
 45-file, but make a copy of it and edit this one. Be sure to replace all the
 46-*foobar* values with your real ones. Almost every value needs to be configured
 47-in someway.
 48-
 49-You can use one copy of the script with different settings for different backup
 50-scenarios. It is designed to run as a cron job and will log information to a
 51-text file (including remote file sizes, if you have s3cmd installed). Be sure to
 52-make the script executable (chmod +x) before you hit the gas.
 53-
 54-REQUIREMENTS
 55-============
 56-
 57-* duplicity
 58-* gpg
 59-* Basic utilities like: which, tee
 60-* Amazon S3 (optional)
 61-* s3cmd (optional)
 62-* mailx (optional)
 63-
 64-CONFIGURATION
 65-=============
 66-
 67-The configuration takes place in a separate config file and is documented there.
 68-
 69-You want to copy duplicity-backup.conf.example to another place that suits your
 70-needs (for example /etc/duplicity-backup.conf)
 71-
 72-The script looks for its configuration by reading the config file specified by
 73-the command line option -c or --config (see USAGE)
 74-
 75-If no config file was given on the command line, the script will try to find the
 76-file specified in the CONFIG parameter at the beggining of the script (defaults
 77-to "duplicity-backup.conf" in the script's directory).
 78-
 79-So be sure either:
 80-- to specify the configuration file path on the command line [recommended]
 81-- or to edit the CONFIG parameter in the script to match the actual location of
 82-  your config file. [deprecated]
 83-
 84-NOTE: to ease future updates of the script, you may prefer NOT to edit the
 85-      script at all and to specify systematically the path to your config file
 86-      on the command line with the -c or --config option.
 87-
 88-USAGE
 89-=====
 90-
 91-  duplicity-backup.sh [options]
 92-
 93-  Options:
 94-    -c, --config CONFIG_FILE   specify the config file to use
 95-
 96-    -b, --backup               runs an incremental backup
 97-    -f, --full                 forces a full backup
 98-
 99-    -v, --verify               verifies the backup
100-        --restore [PATH]       restores the entire backup to [path]
101-        --restore-file [FILE_TO_RESTORE] [DESTINATION]
102-                               restore a specific file
103-
104-    -l, --list-current-files   lists the files currently backed up in the archive
105-    -s, --collection-status    show all the backup sets in the archive
106diff --git a/README.md b/README.md
107new file mode 100644
108index 0000000000000000000000000000000000000000..218cafff650ae21e00c9e1ccde91d96c88c55a93
109--- /dev/null
110+++ b/README.md
111@@ -0,0 +1,150 @@
112+# duplicity-backup
113+
114+This bash script was designed to automate and simplify the remote backup process of duplicity on Amazon S3 primarily. Other backup destinations are possible (FTP, SFTP, SCP, rsync, file...), i.e. any of duplicity's supported outputs.
115+
116+After your script is configured, you can easily backup, restore, verify and clean (either via cron or manually) your data without having to remember lots of different command options and passphrases.
117+
118+Most importantly, you can easily backup the script and your gpg key in a convenient passphrase-encrypted file. This comes in in handy if/when your machine ever does go belly up.
119+
120+Optionally, you can set up an email address where the log file will be sent, which is useful when the script is used via cron.
121+
122+This version is a rewriting of the code originally written by [Damon Timm](https://github.com/thornomad), including many patches that have been brought to the original scripts by various forks on Github.
123+
124+Latest version of the code is available [here](http://github.com/zertrin/duplicity-backup) - Merge requests are welcome! :)
125+
126+More information about this script is available [here](http://zertrin.org/projects/duplicity-backup/).
127+
128+The original version of the code is availabe [here](http://github.com/theterran/dt-s3-backup).
129+
130+
131+## Before you start
132+