Browse Source

rename the config for it to be coherent with the script itself, add the license text and some comment fixes

Von Random 4 years ago
parent
commit
a681b52517
2 changed files with 30 additions and 4 deletions
  1. 24
    0
      backup.zsh
  2. 6
    4
      backup.zsh.cfg

+ 24
- 0
backup.zsh View File

@@ -1,4 +1,28 @@
1 1
 #!/usr/bin/env zsh
2
+#
3
+# The MIT License (MIT)
4
+#
5
+# Copyright (c) 2014 Von Random
6
+#
7
+# Permission is hereby granted, free of charge, to any person obtaining a copy
8
+# of this software and associated documentation files (the "Software"), to deal
9
+# in the Software without restriction, including without limitation the rights
10
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+# copies of the Software, and to permit persons to whom the Software is
12
+# furnished to do so, subject to the following conditions:
13
+#
14
+# The above copyright notice and this permission notice shall be included in all
15
+# copies or substantial portions of the Software.
16
+#
17
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
+# SOFTWARE.
24
+#
25
+
2 26
 self_name=$0
3 27
 
4 28
 # some hardcoded defaults

backup.cfg → backup.zsh.cfg View File

@@ -3,12 +3,12 @@
3 3
 ## Can be ftp, sftp, ftps, ssh or local.
4 4
 protocol='ssh'
5 5
 
6
-## The directory store backups in, locally or remotely.
6
+## The directory to store backups in, locally or remotely.
7 7
 backup_dir='relative_or_full_path'
8 8
 
9 9
 ## The list of patterns to exclude from backups, for
10 10
 ## more details look into tar -X option.
11
-#exclude_list='/usr/local/etc/backup/excludes.list' 
11
+#exclude_list='/usr/local/etc/backup/excludes.list'
12 12
 
13 13
 ## The compression algorithm for backups.
14 14
 ## Can be gz, bz2, xz or empty (for non-compressed).
@@ -32,7 +32,9 @@ source_dirs=( '/home/user/source1:/var/backup/snapshot.list'
32 32
 #backup_filename='somebackup'
33 33
 
34 34
 ## GPG key to encrypt backups, uses name of the private
35
-## key in your keyring
35
+## key in your keyring. It is also entirely possible to
36
+## add the GNUPGHOME environment variable export here in
37
+## order to use the private key from a specific location.
36 38
 #gnupg_key='keyname'
37 39
 
38 40
 #### remote options ####
@@ -45,7 +47,7 @@ remote_user='username'
45 47
 ## Password, due to how openssh handles security it only
46 48
 ## works for *ftp* protocols; backups via ssh protocol
47 49
 ## work interactively. Later versions will have support
48
-## for ssh keys.
50
+## for ssh keys... If I ever decide to make it happen.
49 51
 remote_pass='PassWd'
50 52
 
51 53
 ## Port is optional, the defaults are hardcoded.

Loading…
Cancel
Save