53034bcfd86d598e7f8fa7dfdf02024f7aed41b6
- Author
- Zertrin <zertrin@gmail.com>
- Committer
- Zertrin <zertrin@gmail.com>
- Date
Message
Renaming the script + update of README and CHANGELOG
Diff
This diff is truncated to protect this page.
1diff --git a/AUTHORS b/AUTHORS
2index 1052dc89b40fdc2717841a561fda7764cf4025a5..44851d592c1f93e722332e01cb1e10424838af3f 100644
3--- a/AUTHORS
4+++ b/AUTHORS
5@@ -1,3 +1,4 @@
6 Damon Timm <damontimm@gmail.com> <http://blog.damontimm.com>
7 Mario Santagiuliana <mario@marionline.it> <http://www.marionline.it>
8 Razvan Marescu <rmarescu+github@gmail.com> <http://github.com/rmarescu>
9+Marc Gallet <gmarc34@gmail.com> <http://github.com/zertrin>
10diff --git a/CHANGELOG b/CHANGELOG
11index ad0f72df3dc66b9fb656ec5018dfc66e85609412..25cba55a49081b897015ad643364cb1c7a9e2907 100644
12--- a/CHANGELOG
13+++ b/CHANGELOG
14@@ -1,47 +1,62 @@
15+0.6 Version Six (4 May 2012)
16+============================
17+This is a rework of the script to include some github patches that were brought to the original script in order to make the script more generic than only Amazon S3 oriented and fix a few issues.
18+
19+ * Added ability not to encrypt the backup [orkaa]
20+ * Added ability to use backup destination locations other than Amazon S3 [orkaa]
21+ * Added support for collection-status function [orkaa]
22+ * Added ability to specify variables in a config file [poppen]
23+ * Fixed broken european S3 buckets [thornomad]
24+ * Fixed sed issue [poppen]
25+ * Fixed incorrect handling of spaces un paths and filenames [hexwizard]
26+ * Renamed script to 'duplicity-backup'
27+ * Modified README file to reflect the renaming of the script
28+ * Cleaned up tabs in source file
29+
30 0.5 Version Five (05/09/11)
31 ===========================
32
33- * added ability to email log using `mailx`
34- * added `%H` (hour) to default logfile name
35+ * added ability to email log using `mailx`
36+ * added `%H` (hour) to default logfile name
37
38 0.4 Version Four (03/13/10)
39 ===========================
40
41- * Moved the source code to github
42- * Add --list-files to view in the standart-output files stored in my archive [marionline]
43- * Added ECHO command to troublshoot the code when needed
44- * Added command line --restore to path & removed RESTORE variable [marionline]
45- * Added --restore-file option [marionline]
46- * Changed --backup-this-script to --backup-scrip
47- * Added README to --backup-script
48- * Force use of --backup option (no accidently running the script)
49- * Added help text to the command line script itself [marionline]
50- * Script without options shows --help and current directory settings
51- * Script checks to make sure you have put some variables in before it runs [marionline]
52- * A number of other minor changes
53+ * Moved the source code to github
54+ * Add --list-files to view in the standart-output files stored in my archive [marionline]
55+ * Added ECHO command to troublshoot the code when needed
56+ * Added command line --restore to path & removed RESTORE variable [marionline]
57+ * Added --restore-file option [marionline]
58+ * Changed --backup-this-script to --backup-script
59+ * Added README to --backup-script
60+ * Force use of --backup option (no accidently running the script)
61+ * Added help text to the command line script itself [marionline]
62+ * Script without options shows --help and current directory settings
63+ * Script checks to make sure you have put some variables in before it runs [marionline]
64+ * A number of other minor changes
65
66 Version Three (01/31/09)
67 ========================
68
69- * Added comment to explain why folks need to use 's3+' and not 's3:' for Amazon buckets
70- * Used "unset" to remove the variables at end of the script
71- * Fixed a problem when the backup folder on S3 was nested inside another bucket
72- * Changed the PASSPHRASE field to default to the actual passphrase, so one can easily backup the entire script and not have to worry about the passphrase.
73- * Added --backup-this-script option which will turn the script and the secret key into an encrypted tarball that can be kept somewhere safe for easy restores if the machine goes down.
74- * Cleaned up the get_file_size function so it wouldn't run when it wasn't supposed to.
75+ * Added comment to explain why folks need to use 's3+' and not 's3:' for Amazon buckets
76+ * Used "unset" to remove the variables at end of the script
77+ * Fixed a problem when the backup folder on S3 was nested inside another bucket
78+ * Changed the PASSPHRASE field to default to the actual passphrase, so one can easily backup the entire script and not have to worry about the passphrase.
79+ * Added --backup-this-script option which will turn the script and the secret key into an encrypted tarball that can be kept somewhere safe for easy restores if the machine goes down.
80+ * Cleaned up the get_file_size function so it wouldn't run when it wasn't supposed to.
81
82 Version Two (12/03/08)
83 ======================
84
85- * added GPL license
86- * changed the cleanup feature to automatically force a full backup after (n) number of days as well as automatically cleanup after (n) number of days
87- * added option to force cleanup after (n) number of full backups (rather than by days)
88- * option to changed log file ownership
89- * runtime checks for installed required software and write permissions on log directory
90- * fixed formatting of logfile to be a little more consistent
91- * setup everything in clever functions
92+ * added GPL license
93+ * changed the cleanup feature to automatically force a full backup after (n) number of days as well as automatically cleanup after (n) number of days
94+ * added option to force cleanup after (n) number of full backups (rather than by days)
95+ * option to changed log file ownership
96+ * runtime checks for installed required software and write permissions on log directory
97+ * fixed formatting of logfile to be a little more consistent
98+ * setup everything in clever functions
99
100 Version One (11/24/08)
101 ======================
102
103-* Initial release.
104+ * Initial release.
105diff --git a/README b/README
106index 9f5b54d1986a7c64eed519243c47f541ca07ce6b..5c43a4a6f769a5264c102c3dcd4c57efd253b376 100644
107--- a/README
108+++ b/README
109@@ -2,10 +2,10 @@ ABOUT THIS SCRIPT
110 =================
111
112 This bash script was designed to automate and simplify the remote backup
113-process of duplicity on Amazon S3. After your script is configured, you can
114-easily backup, restore, verify and clean (either via cron or manually) your
115-data without having to remember lots of different command options and
116-passphrases.
117+process of duplicity on Amazon S3 primarily. Other backup destinations are
118+possible. After your script is configured, you can easily backup, restore,
119+verify and clean (either via cron or manually) your data without having to
120+remember lots of different command options and passphrases.
121
122 Most importantly, you can easily backup the script and your gpg key in a
123 convenient passphrase-encrypted file. This comes in in handy if/when your
124@@ -14,11 +14,20 @@ machine ever does go belly up.
125 Optionally, you can set up an email address where the log file will be sent,
126 which is useful when the script is used via cron.
127
128-More information about this script avaiable at:
129-http://damontimm.com/code/dt-s3-backup
130+This version is a rewriting of the original code by Marc Gallet, including many
131+of the patches that have been brought to the original scripts by various forks
132+on Github.
133
134-Latest version of the code is available at:
135-http://github.com/thornomad/dt-s3-backup
136+Latest version of the code available at:
137+http://github.com/zertrin/duplicity-backup
138+
139+Merge requests are welcome :)
140+
141+More information about this script available at:
142+http://zertrin.org/duplicity-backup.html
143+
144+The original version of the code availabe at:
145+http://github.com/theterran/dt-s3-backup
146
147 BEFORE YOU START
148 ================
149@@ -38,7 +47,7 @@ REQUIREMENTS
150
151 * duplicity
152 * gpg
153-* Amazon S3
154+* Amazon S3 (optional)
155 * s3cmd (optional)
156 * mailx (optional)
157
158@@ -46,39 +55,39 @@ COMMON USAGE EXAMPLES
159 =====================
160
161 * View help:
162- $ dt-s3-backup.sh
163+ $ duplicity-backup.sh
164
165 * Run an incremental backup:
166- $ dt-s3-backup.sh --backup
167+ $ duplicity-backup.sh --backup
168
169 * Force a one-off full backup:
170- $ dt-s3-backup.sh --full
171+ $ duplicity-backup.sh --full
172
173 * Restore your entire backup:
174- $ dt-s3-backup.sh --restore
175+ $ duplicity-backup.sh --restore
176 You will be prompted for a restore directory
177
178- $ dt-s3-backup.sh --restore /home/user/restore-folder
179+ $ duplicity-backup.sh --restore /home/user/restore-folder
180 You can also provide a restore folder on the command line.
181
182 * Restore a specific file in the backup:
183- $ dt-s3-backup.sh --restore-file
184+ $ duplicity-backup.sh --restore-file
185 You will be prompted for a file to restore to the current directory
186
187- $ dt-s3-backup.sh --restore-file img/mom.jpg
188+ $ duplicity-backup.sh --restore-file img/mom.jpg
189 Restores the file img/mom.jpg to the current directory
190
191- $ dt-s3-backup.sh --restore-file img/mom.jpg /home/user/i-love-mom.jpg
192+ $ duplicity-backup.sh --restore-file img/mom.jpg /home/user/i-love-mom.jpg
193 Restores the file img/mom.jpg to /home/user/i-love-mom.jpg
194
195 * List files in the remote archive
196- $ dt-s3-backup.sh --list-current-files
197+ $ duplicity-backup.sh --list-current-files
198
199 * Verify the backup
200- $ dt-s3-backup.sh --verify
201+ $ duplicity-backup.sh --verify
202
203 * Backup the script and gpg key (for safekeeping)
204- $ dt-s3-backup.sh --backup-script
205+ $ duplicity-backup.sh --backup-script
206
207 TROUBLESHOOTING
208 ===============
209diff --git a/dt-s3-backup.sh b/duplicity-backup.sh
210rename from dt-s3-backup.sh
211rename to duplicity-backup.sh
212index 0b92f4146c18e8b4922b60ab96914a754f7a3425..d3c03e2e52aa278e76b63290f2a7989ec962b341 100755
213--- a/dt-s3-backup.sh
214+++ b/duplicity-backup.sh
215@@ -125,7 +125,7 @@ VERBOSITY="-v3"
216 # address is provided, no alert will be sent.
217 # You can set a custom from email address and a custom subject (both optionally)
218 # If no value is provided for the subject, the following value will be
219-# used by default: "DT-S3 Alert ${LOG_FILE}"
220+# used by default: "duplicity-backup Alert ${LOG_FILE}"
221 # MTA used: mailx
222 #EMAIL="admin@example.com"
223 EMAIL_TO=
224@@ -187,7 +187,7 @@ size information unavailable."
225 NO_S3CMD_CFG="WARNING: s3cmd is not configured, run 's3cmd --configure' \
226 in order to retrieve remote file size information. Remote file \
227 size information unavailable."