summaryrefslogtreecommitdiff
path: root/docs/docbook/bbackupd.conf.xml
blob: 43ae2bedb6c27d32e9be47fab35c85dac3f9cf05 (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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:xi="http://www.w3.org/2001/XInclude"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:m="http://www.w3.org/1998/Math/MathML"
          xmlns:html="http://www.w3.org/1999/xhtml"
          xmlns:db="http://docbook.org/ns/docbook">
  <refmeta>
    <refentrytitle>bbackupd.conf</refentrytitle>

    <manvolnum>5</manvolnum>

    <refmiscinfo class="manual">Box Backup</refmiscinfo>

    <refmiscinfo class="source">Box Backup</refmiscinfo>

    <refmiscinfo class="version">0.11</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>bbackupd.conf</refname>

    <refpurpose>Box Backup client daemon configuration file</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>/etc/box/bbackupd.conf</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Description</title>

    <variablelist>
      <varlistentry>
        <term><varname>AccountNumber</varname></term>

        <listitem>
          <para>The account number of this client. This is set by the admin of
          the store server.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>UpdateStoreInterval</varname></term>

        <listitem>
          <para>Specifies the interval between scanning of the local discs. To
          avoid cycles of load on the server, this time is randomly adjusted
          by a small percentage as the daemon runs. Defaults to 1 hour.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>MinimumFileAge</varname></term>

        <listitem>
          <para>Specifies how long since a file was last modified before it
          will be uploaded. Defaults to 6 hours.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>MaxUploadWait</varname></term>

        <listitem>
          <para>If a file is repeatedly modified it won't be uploaded
          immediately in case it's modified again. However it should be
          uploaded eventually. This is how long we should wait after first
          noticing a change. Defaults to 1 day.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>MaxFileTimeInFuture</varname></term>

        <listitem>
          <para></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>AutomaticBackup</varname></term>

        <listitem>
          <para></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>SyncAllowScript</varname></term>

        <listitem>
          <para>Use this to temporarily stop bbackupd from syncronising or
          connecting to the store. This specifies a program or script script
          which is run just before each sync, and ideally the full path to the
          interpreter. It will be run as the same user bbackupd is running as,
          usually root.</para>

          <para>The script prints either "now" or a number to STDOUT (and a
          terminating newline, no quotes). If the result was "now", then the
          sync will happen. If it's a number, then the script will be asked
          again in that number of seconds.</para>

          <para>For example, you could use this on a laptop to only backup
          when on a specific network. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>MaximumDiffingTime</varname></term>

        <listitem>
          <para>How much time should be spent on diffing files.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>DeleteRedundantLocationsAfter</varname></term>

        <listitem>
          <para></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>FileTrackingSizeThreshold</varname></term>

        <listitem>
          <para></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>DiffingUploadSizeThreshold</varname></term>

        <listitem>
          <para></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>StoreHostname</varname></term>

        <listitem>
          <para>The hostname or IP address of the <citerefentry>
              <refentrytitle>bbstored</refentrytitle>

              <manvolnum>8</manvolnum>
            </citerefentry> server.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>StorePort</varname></term>

        <listitem>
          <para>The port used by the server. Defaults to 2201.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>ExtendedLogging</varname></term>

        <listitem>
          <para>Logs everything that happens between the client and server.
          The <citerefentry>
              <refentrytitle>bbackupd</refentrytitle>

              <manvolnum>8</manvolnum>
            </citerefentry> client must also be started with
          <option>-V</option>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>ExtendedLogFile</varname></term>

        <listitem>
          <para></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>LogAllFileAccess</varname></term>

        <listitem>
          <para></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>LogFile</varname></term>

        <listitem>
          <para></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>LogFileLevel</varname></term>

        <listitem>
          <para></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>CommandSocket</varname></term>

        <listitem>
          <para>Where the command socket is created in the filesystem.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>KeepAliveTime</varname></term>

        <listitem>
          <para></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>StoreObjectInfoFile</varname></term>

        <listitem>
          <para></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>NotifyScript</varname></term>

        <listitem>
          <para>The location of the script which runs at certain events. This
          script is generated by <citerefentry>
              <refentrytitle>bbackupd-config</refentrytitle>

              <manvolnum>8</manvolnum>
            </citerefentry>. Defaults to
          <filename>/etc/box/bbackupd/NotifySysAdmin.sh</filename>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>NotifyAlways</varname></term>

        <listitem>
          <para></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>CertificateFile</varname></term>

        <listitem>
          <para>The path to the client's public certificate.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>PrivateKeyFile</varname></term>

        <listitem>
          <para>The path to the client's private key. This should only be
          readable by root.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>TrustedCAsFile</varname></term>

        <listitem>
          <para>The Certificate Authority created by <citerefentry>
              <refentrytitle>bbstored-certs</refentrytitle>

              <manvolnum>8</manvolnum>
            </citerefentry>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>KeysFile</varname></term>

        <listitem>
          <para>The data encryption key. This <emphasis
          role="bold">must</emphasis> be kept safe at all costs, your data is
          useless without it!</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>DataDirectory</varname></term>

        <listitem>
          <para>A directory to keep temporary state files. This is usually
          something like <filename>/var/bbackupd</filename>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>Server</varname></term>

        <listitem>
          <para>This section relates to the running daemon.</para>

          <para><variablelist>
              <varlistentry>
                <term><varname>PidFile</varname></term>

                <listitem>
                  <para>The location of the process ID file. Defaults to
                  <filename>/var/run/bbackupd.pid</filename>.</para>
                </listitem>
              </varlistentry>
            </variablelist></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><varname>BackupLocations</varname></term>

        <listitem>
          <para>This section defines each directory to be backed up. Each
          entry must have at least a Path entry and, optionally, include and
          exclude directives.</para>

          <para>Multiple include and exclude directives may appear.</para>

          <para><variablelist>
              <varlistentry>
                <term><varname>Path</varname></term>

                <listitem>
                  <para>The path to back up.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term><varname>ExcludeFile</varname></term>

                <listitem>
                  <para>Exclude a single file.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term><varname>ExcludeFilesRegex</varname></term>

                <listitem>
                  <para>Exclude multiple files based on a regular expression.
                  See <citerefentry>
                      <refentrytitle>re_format</refentrytitle>

                      <manvolnum>7</manvolnum>
                    </citerefentry>.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term><varname>ExcludeDir</varname></term>

                <listitem>
                  <para>Exclude a single directory.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term><varname>ExcludeDirsRegex</varname></term>

                <listitem>
                  <para>Exclude multiple directories based on a regular
                  expression. See <citerefentry>
                      <refentrytitle>re_format</refentrytitle>

                      <manvolnum>7</manvolnum>
                    </citerefentry>.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term><varname>AlwaysIncludeFile</varname></term>

                <listitem>
                  <para>Include a single file from a directory which has been
                  excluded.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term><varname>AlwaysIncludeFilesRegex</varname></term>

                <listitem>
                  <para>Include multiple files from an excluded directory,
                  based on a regular expression.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term><varname>AlwaysIncludeDir</varname></term>

                <listitem>
                  <para>Include a single directory from a directory which has
                  been excluded.</para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term><varname>AlwaysIncludeDirsRegex</varname></term>

                <listitem>
                  <para>Include multiple directories from an excluded
                  directory, based on a regular expression.</para>
                </listitem>
              </varlistentry>
            </variablelist></para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Examples</title>

    <para>The following is an example of a backup location:</para>

    <programlisting>home
{
   Path = /home
   ExcludeDir = /home/guest
   ExcludeDir = /home/[^/]+/tmp
   ExcludeFilesRegex = .*\.(mp3|MP3)$
   AlwaysIncludeFile = /home/someuser/importantspeech.mp3
}</programlisting>
  </refsection>

  <refsection>
    <title>Files</title>

    <para><filename>/etc/box/bbackupd.conf</filename></para>
  </refsection>

  <refsection>
    <title>See Also</title>

    <para><citerefentry>
        <refentrytitle>bbackupd</refentrytitle>

        <manvolnum>8</manvolnum>
      </citerefentry>, <citerefentry>
        <refentrytitle>bbackupd-config</refentrytitle>

        <manvolnum>8</manvolnum>
      </citerefentry>, <citerefentry>
        <refentrytitle>bbackupctl</refentrytitle>

        <manvolnum>8</manvolnum>
      </citerefentry></para>
  </refsection>

  <refsection>
    <title>Authors</title>

    <para><author>
        <personname>Ben Summers</personname>
      </author></para>

    <para><author>
        <personname>Per Thomsen</personname>
      </author></para>

    <para><author>
        <personname>James O'Gorman</personname>
      </author></para>
  </refsection>
</refentry>