summaryrefslogtreecommitdiff
path: root/debian/boxbackup-client.templates
blob: e1d71dc125b0497c191f5ea1c7ca5e3b18b5dc62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
Template: boxbackup-client/debconf
Type: boolean
Default: true
Description: Do you want to handle the boxbackup client configuration with debconf?
 Debconf can create the configuration files for boxbackup client.
 If you prefer to do this by yourself you will need to use the script
 bbackupd-config provided by this package.
 .
 The server won't start if it isn't configured.
 .
 Whatever you choose here, you will need to read the README.Debian file
 in /usr/share/doc/boxbackup-client.

Template: boxbackup-client/backupMode
Type: select
Choices: lazy, snapshot
Description: Select the backup mode you prefer
 Boxbackup client supports two modes of backup:
  -lazy: the backup daemon will regularly scan your filesystem searching
         for modified files. It will then upload the files over a specified age
         to the backup server.
  -snapshot: the backup will be explicitly run at given time set in a cron entry
             The cron file is provided with this package, you will have to set the
             time you wish the backup to occur (/etc/cron.d/boxbackup-client).

Template: boxbackup-client/accountNumber
Type: string
Description: Enter your account number on the backup server
 The administrator of the boxbackup server (perhaps you) should have provided
 you an account number. It consits in an hexadecimal number.
 .
 If you don't already have one, leave that field blank. You will be able to
 configure it later by running dpkg-reconfigure boxbackup-client as root.

Template: boxbackup-client/incorrectAccountNumber
Type: note
Description: Please enter an hexadecimal number
 The account number must be an hexadecimal number (e.g. 1E04 or 4500).

Template: boxbackup-client/backupServer
Type: string
Description: Enter the fully qualified domain name of the backup server
 The server name is the computer running an instance of Boxbackup server
 your client will connect to. It must be the fully qualified domain name
 of that machine (that can be resolve to an IP address).
 If you are behind a firewall, you must allow outgoing connexion to tcp
 port 2201 to be able to reach the server.

Template: boxbackup-client/backupDirs
Type: string
Description: Enter a space separated list of directories to backup
 You must tell boxbackup which directories you would like to backup to the remote
 server.
 You must enter this directories as a space separated list of absolute path names.
 Be careful that those directories do NOT contain other mounted file systems within
 them at any depth or you will have problems.

Template: boxbackup-client/incorrectDirectories
Type: note
Description: Please enter correct path names
 The path names to the directories must be absolute path names separated by spaces.
 .
 For example: /home/myaccount /etc/

Template: boxbackup-client/UpdateStoreInterval
Type: string
Default: 3600
Description: Enter the interval in seconds between scan of directories
 Boxbackup scans the directories you have selected looking for modified files.
 This scans occurs at regular interval that you can customize.
 .
 The default value is 3600s (one hour).

Template: boxbackup-client/MinimumFileAge
Type: string
Default: 21600
Description: Enter the time in seconds to wait after a file modification before uploading it
 A file will be uploaded to the server only after a certain time after its
 last modification. If you reduce this value and you modify your files often,
 remember that you will have more old revisions of your files on the server and
 reach your quota limit faster (thus removing older revisions of our files sooner)
 .
 The default value is 21600s (six hours).

Template: boxbackup-client/MaxUploadWait
Type: string
Default: 86400
Description: Enter the max time in seconds to wait before uploading a frequently modified file
 As a file is not uploaded before a certain time after its last modification,
 if it is frequently modified, it would never get uploaded. So this parameter
 defines the maximum time to wait since the first modification noticed
 before uploading a file.
 .
 The default value is 86400s (1 day).

Template: boxbackup-client/IncorrectNumber
Type: note
Description: Please enter a correct number of seconds
 This parameter must be a number.

Template: boxbackup-client/notifyMail
Type: string
Default: root
Description: Enter the user name or email address to send notification to.
 Boxbackup client must know the user name or email address of the person
 who will receive alert notifications. Such notifications are sent when
 a problem occurs during the backup (the store is full or some files
 were not readable).
 .
 Enter either a user name (e.g. root) or an email address (e.g. admin@mydomain.org)

Template: boxbackup-client/generateCertificate
Type: boolean
Default: true
Description: Do you want debconf to generate the client private key and x509 certificate request?
 The boxbackup client needs a RSA private key and the corresponding x509 certificate
 to authenticate itself to the server.
 .
 Debconf can generate for you the private key and a x509 certificate sign request.
 You will need to send the certificate request to the administrator of the Boxbackup server
 and this one will sign it and send it back to you along with the server Certification Authority
 certificate. You will need to put these files in your boxbackup configuration directory (see
 /etc/boxbackup/bbackupd.conf file for the exact name to give to these files).
 .
 If you prefer to manage this by yourself, say No here.

Template: boxbackup-client/generalInfo
Type: note
Description: Read /usr/share/doc/boxbackup-client/README.Debian to finish the configuration
 You should read the /usr/share/doc/boxbackup-client/README.Debian file
 to learn how to finish the configuration of boxbackup client.
 You will have to send the certificate request to the boxbackup server
 administrator.
 You can also customize the directories to backup in the file /etc/boxbackup/bbackupd.conf.
 .
 Be sure to make a *secure* backup copy of the following files:
   - /etc/boxbackup/bbackupd/boxbackup-client-encrypt-key.raw : the key used to encrypt/decrypt
                                                                your backup.
   - /etc/boxbackup/bbackupd/boxbackup-client-priv-key.pem : your private key.
   - /etc/boxbackup/bbackupd/boxbackup-client-cert.pem : your certificate signed by the
                                                         server administrator.
 I advise you to backup the whole /etc/boxbackup directory.
 Without those files you won't be able to restore your data. You have been warned.