← Back to branch summary

~ubuntu-branches/ubuntu/vivid/burp/vivid-proposed

« back to all changes in this revision

Viewing changes to website/content/html/howto.content

  • Committer: Package Import Robot
  • Author(s): Bastiaan Franciscus van den Dikkenberg
  • Date: 2012-02-27 17:01:35 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20120227170135-on2z4842wv2ppmrm
Tags: 1.3.1-1
http://bugs.debian.org/661281
http://bugs.debian.org/661001
http://bugs.debian.org/660964
http://bugs.debian.org/661267
* New upstream release version 1.3.1
  -fixes respect noopt in DEB_BUILD_OPTIONS. (Closes: #661281)
* Switched to Standards-Version 3.9.3 Debian bug: (Closes: #661001)
* Fixed typo in logrotate script Debian bug: (Closes: #660964)
* added debug package Debian bug: (Closes: #661267)

Show diffs side-by-side

added added

removed removed

Lines of Context:
website/content/html/howto.content
15
15
Make sure that you have openssl, zlib and librsync libraries and development
16
16
libraries installed. With debian or ubuntu, this command should install them
17
17
for you:
18
 
apt-get install librsync-dev libz-dev libssl-dev
 
18
apt-get install librsync-dev libz-dev libssl-dev uthash-dev
19
19
Change to the burp source directory and run "./configure",
20
20
then "make".
21
21
All being well, burp will compile successfully.
44
44
it is yet time for a new backup. It is probably a good idea to change the
45
45
numbers for each client, in order to spread the load a bit:
46
46
MAILTO=
47
 
7,27,47 * * * * root    /sbin/burp -a t
 
47
7,27,47 * * * * root    /usr/sbin/burp -a t
48
48
 
49
49
WINDOWS CLIENT
50
50
 
159
159
              in the config file. Use /dev/null to deactivate or '' to reacti‐
160
160
              vate output.
161
161
 
 
162
       -s [number]
 
163
              For  use  with  restores - strip a number of leading path compo‐
 
164
              nents.
 
165
 
162
166
 
163
167
EXAMPLES
164
168
       burp -a b
177
181
              Lists all the files in all the backups.
178
182
 
179
183
       burp -a l -b 1 -r myregex
180
 
              Lists  all  the  files in backup number 1 that match the regular
 
184
              Lists all the files in backup number 1 that  match  the  regular
181
185
              expression 'myregex'.
182
186
 
183
187
       burp -a L -b 1 -r myregex
186
190
 
187
191
       burp -a r -b 1 -r myregex
188
192
              Restores all the files in backup number 1 that match the regular
189
 
              expression 'myregex' back to their original location. You  won't
 
193
              expression  'myregex' back to their original location. You won't
190
194
              be given a warning if the files already exist there, so use with
191
195
              caution.
192
196
 
194
198
              Restores all the files in backup number 1 that match the regular
195
199
              expression 'myregex' into the directory /tmp/restoredir.
196
200
 
 
201
       burp -a r -b 1 -r myregex -d /tmp/restoredir -s 2
 
202
              Restores all the files in backup number 1 that match the regular
 
203
              expression  'myregex'  into  the  directory  /tmp/restoredir and
 
204
              strip 2 leading path components.
 
205
 
197
206
       burp -a r
198
207
              Restores all the files in the most recent backup to their origi‐
199
 
              nal location. You won't be given a warning if the files  already
 
208
              nal  location. You won't be given a warning if the files already
200
209
              exist there, so use with caution.
201
210
 
202
211
       burp -a v
203
212
              Verifies the most recent backup.
204
213
 
205
214
       burp -a v -b 1 -r myregex
206
 
              Verifies  everything in backup number 1 that matches the regular
 
215
              Verifies everything in backup number 1 that matches the  regular
207
216
              expression 'myregex'.
208
217
 
209
218
       burp -a t
210
 
              Timed backup. The same as 'burp -a b', except that a  script  is
211
 
              run  on the server before deciding to go ahead. The intention is
212
 
              that this command will be run on a repeating  cron  job  with  a
213
 
              short  interval, and that the server will decide when it is time
 
219
              Timed  backup.  The same as 'burp -a b', except that a script is
 
220
              run on the server before deciding to go ahead. The intention  is
 
221
              that  this  command  will  be run on a repeating cron job with a
 
222
              short interval, and that the server will decide when it is  time
214
223
              for a new backup.
215
224
 
216
225
 
222
231
              Defines the main TCP port that the server listens on.
223
232
 
224
233
       status_port=[port number]
225
 
              Defines the TCP port that  the  server  listens  on  for  status
 
234
              Defines  the  TCP  port  that  the  server listens on for status
226
235
              requests.
227
236
 
228
237
       directory=[path]
245
254
              Number of backups to keep. This can be overriddden by the client
246
255
              configuration files in clientconfdir on the server. Specify mul‐
247
256
              tiple 'keep' entries on separate lines in order to keep multiple
248
 
              periods  of  backups. For example, assuming that you are doing a
 
257
              periods of backups. For example, assuming that you are  doing  a
249
258
              backup a day, keep=7 keep=4 keep=6 (on separate lines) will keep
250
259
              7 daily backups, 4 weekly backups (7x4=28), and 6 multiples of 4
251
 
              weeks (7x4x6=168) - roughly 6 monthly backups. Effectively,  you
252
 
              will  be  guaranteed  to  be able to restore up to 168 days ago,
 
260
              weeks  (7x4x6=168) - roughly 6 monthly backups. Effectively, you
 
261
              will be guaranteed to be able to restore up  to  168  days  ago,
253
262
              with the number of available backups exponentially decreasing as
254
 
              you  go  back  in time to that point. In this example, every 7th
255
 
              backup will be hardlinked to allow burp to safely delete  inter‐
256
 
              mediate  backups  when  necessary.  You  can have as many 'keep'
257
 
              lines as you like, as long as they don't  exceed  52560000  when
258
 
              multiplied  together.  That  is,  a  backup every minute for 100
 
263
              you go back in time to that point. In this  example,  every  7th
 
264
              backup  will be hardlinked to allow burp to safely delete inter‐
 
265
              mediate backups when necessary. You  can  have  as  many  'keep'
 
266
              lines  as  you  like, as long as they don't exceed 52560000 when
 
267
              multiplied together. That is, a  backup  every  minute  for  100
259
268
              years.
260
269
 
261
270
       hardlinked_archive=[0|1]
262
 
              On the server, defines whether to keep hardlinked files  in  the
263
 
              backups,  or  whether  to generate reverse deltas and delete the
264
 
              original files. Can be set to either 0 (off) or 1  (on).  Disad‐
265
 
              vantage:  More  disk space will be used Advantage: Restores will
 
271
              On  the  server, defines whether to keep hardlinked files in the
 
272
              backups, or whether to generate reverse deltas  and  delete  the
 
273
              original  files.  Can be set to either 0 (off) or 1 (on). Disad‐
 
274
              vantage: More disk space will be used Advantage:  Restores  will
266
275
              be faster, and since no reverse deltas need to be generated, the
267
 
              time  and  effort  the  server  needs  at the end of a backup is
 
276
              time and effort the server needs at  the  end  of  a  backup  is
268
277
              reduced.
269
278
 
270
279
       max_hardlinks=[number]
271
 
              On the server, the number of times that a  single  file  can  be
272
 
              hardlinked.  The  bedup  program  also  obeys  this setting. The
 
280
              On  the  server,  the  number of times that a single file can be
 
281
              hardlinked. The bedup  program  also  obeys  this  setting.  The
273
282
              default is 10000.
274
283
 
275
284
       librsync=[0|1]
276
 
              When set to 0, delta differencing will not take place. That  is,
 
285
              When  set to 0, delta differencing will not take place. That is,
277
286
              when a file changes, the server will request the whole new file.
278
 
              The default is 1. This option can be overridden  by  the  client
 
287
              The  default  is  1. This option can be overridden by the client
279
288
              configuration files in clientconfdif on the server.
280
289
 
281
290
       compression=[gzip0-9]
282
 
              Choose  the  level of gzip compression. Setting 0 or gzip0 turns
283
 
              compression off. The default is gzip9. This option can be  over‐
 
291
              Choose the level of gzip compression. Setting 0 or  gzip0  turns
 
292
              compression  off. The default is gzip9. This option can be over‐
284
293
              ridden by the client configuration files in clientconfdif on the
285
294
              server.
286
295
 
287
296
       client_lockdir=[path]
288
297
              Path to the directory in which to keep per-client lock files. By
289
 
              default,  this  is  set  to  the  path  given by the 'directory'
 
298
              default, this is set  to  the  path  given  by  the  'directory'
290
299
              option.
291
300
 
292
301
       user=[username]
293
 
              Run as a particular user. This can be overridden by  the  client
 
302
              Run  as  a particular user. This can be overridden by the client
294
303
              configuration files in clientconfdir on the server.
295
304
 
296
305
       group=[groupname]
297
 
              Run  as a particular group. This can be overridden by the client
 
306
              Run as a particular group. This can be overridden by the  client
298
307
              configuration files in clientconfdir on the server.
299
308
 
300
309
       umask=[umask]
301
310
              Set the file creation umask. Default is 0022.
302
311
 
303
312
       ratelimit=[Mb/s]
304
 
              Set the network send rate limit, in Mb/s. If this option is  not
 
313
              Set  the network send rate limit, in Mb/s. If this option is not
305
314
              given, burp will send data as fast as it can.
306
315
 
307
316
       network_timeout=[s]
308
 
              Set  the  network  timeout  in  seconds.  If  no data is sent or
309
 
              received over a period of this length, burp will  give  up.  The
 
317
              Set the network timeout in  seconds.  If  no  data  is  sent  or
 
318
              received  over  a  period of this length, burp will give up. The
310
319
              default is 7200 seconds (2 hours).
311
320
 
312
321
       working_dir_recovery_method=[resume|use|delete]
313
 
              This  option tells the server what to do when it finds the work‐
314
 
              ing directory of an interrupted backup (perhaps somebody  pulled
 
322
              This option tells the server what to do when it finds the  work‐
 
323
              ing  directory of an interrupted backup (perhaps somebody pulled
315
324
              the plug on the server, or something). This can be overridden by
316
 
              the client configurations files in clientconfdir on the  server.
 
325
              the  client configurations files in clientconfdir on the server.
317
326
              Options are...
318
327
 
319
328
       delete: Just delete the old working directory.
320
329
 
321
330
       use: Convert the working directory into a complete backup.
322
331
 
323
 
       resume:  Simply continue the previous backup from the point at which it
324
 
       left off.
 
332
       resume: Simply continue the previous backup from the point at which  it
 
333
       left  off. NOTE: If the client has changed its include/exclude configu‐
 
334
       ration since the backup was interrupted, the recovery method will auto‐
 
335
       matically switch to 'use'.
325
336
 
326
337
       ssl_cert_ca=[path]
327
 
              The path to the SSL CA certificate. This file will  probably  be
 
338
              The  path  to the SSL CA certificate. This file will probably be
328
339
              the same on both the server and the client. The file should con‐
329
340
              tain just the certificate in PEM format
330
341
 
331
342
       ssl_cert=[path]
332
343
              The path to the server SSL certificate. It works for me when the
333
 
              file  contains  the concatenation of the certificate and private
 
344
              file contains the concatenation of the certificate  and  private
334
345
              key in PEM format.
335
346
 
336
347
       ssl_key=[path]
343
354
              Synonym for ssl_key_password.
344
355
 
345
356
       ssl_dhfile=[path]
346
 
              Path to Diffie-Hellman parameter  file.  To  generate  one  with
347
 
              openssl,   use   a  command  like  this:  openssl  dhparam  -out
 
357
              Path  to  Diffie-Hellman  parameter  file.  To generate one with
 
358
              openssl,  use  a  command  like  this:  openssl   dhparam   -out
348
359
              dhfile.pem -5 1024
349
360
 
350
361
       max_children=[number]
351
 
              Defines the number of child processes to  fork  (the  number  of
 
362
              Defines  the  number  of  child processes to fork (the number of
352
363
              clients that can simultaneously connect. The default is 5.
353
364
 
354
365
       max_storage_subdirs=[number]
355
 
              Defines  the number of subdirectories in the data storage areas.
356
 
              The maximum number of subdirectories that ext3 allows is  32000.
 
366
              Defines the number of subdirectories in the data storage  areas.
 
367
              The  maximum number of subdirectories that ext3 allows is 32000.
357
368
              If you do not set this option, it defaults to 30000.
358
369
 
359
370
       timer_script=[path]
360
 
              Path  to the script to run when a client connects with the timed
361
 
              backup option. If the script exits with code 0,  a  backup  will
 
371
              Path to the script to run when a client connects with the  timed
 
372
              backup  option.  If  the script exits with code 0, a backup will
362
373
              run. The first two arguments are the client name and the path to
363
 
              the 'current' storage directory. The next  three  arguments  are
 
374
              the  'current'  storage  directory. The next three arguments are
364
375
              reserved, and user arguments are appended after that. An example
365
 
              timer script is provided. The timer_script option can  be  over‐
366
 
              riddden  by  the  client configuration files in clientconfdir on
 
376
              timer  script  is provided. The timer_script option can be over‐
 
377
              riddden by the client configuration files  in  clientconfdir  on
367
378
              the server.
368
379
 
369
380
       timer_arg=[string]
374
385
       notify_success_script=[path]
375
386
              Path to the script to run when a backup succeeds. User arguments
376
387
              are appended after the first five reserved arguments. An example
377
 
              notify script is provided. The notify_success_script option  can
378
 
              be  overriddden  by  the  client  configuration files in client‐
 
388
              notify  script is provided. The notify_success_script option can
 
389
              be overriddden by the  client  configuration  files  in  client‐
379
390
              confdir on the server.
380
391
 
381
392
       notify_success_arg=[string]
382
 
              A user-definable argument to the notify success script. You  can
383
 
              have  many of these. The notify_success_arg options can be over‐
384
 
              riddden by the client configuration files  in  clientconfdir  on
 
393
              A  user-definable argument to the notify success script. You can
 
394
              have many of these. The notify_success_arg options can be  over‐
 
395
              riddden  by  the  client configuration files in clientconfdir on
385
396
              the server.
386
397
 
387
398
       notify_success_warnings_only=[0|1]
388
 
              Set  to  1  to  send  success notifications only when there were
389
 
              warnings. Leave unset or set to 0 to send success  notifications
 
399
              Set to 1 to send success  notifications  only  when  there  were
 
400
              warnings.  Leave unset or set to 0 to send success notifications
390
401
              for every backup.
391
402
 
392
403
       notify_failure_script=[path]
396
407
              The same as notify_failure_arg, but for backups that failed.
397
408
 
398
409
       dedup_group=[string]
399
 
              Enables  you  to  group  clients together for file deduplication
400
 
              purposes. For example, you might want  to  set  'dedup_group=xp'
401
 
              for  each Windows XP client, and then run the bedup program on a
 
410
              Enables you to group clients  together  for  file  deduplication
 
411
              purposes.  For  example,  you might want to set 'dedup_group=xp'
 
412
              for each Windows XP client, and then run the bedup program on  a
402
413
              cron job every other day with the option '-g xp'.
403
414
 
404
415
       server_script_pre=[path]
405
 
              Path to a script to run on the server  after  each  successfully
 
416
              Path  to  a  script to run on the server after each successfully
406
417
              authenticated connection but before any work is carried out. The
407
 
              arguments to it are 'pre', '(client  command)',  'reserved3'  to
408
 
              'reserved5',      and      then     arguments     defined     by
409
 
              server_script_pre_arg. If the script returns non-zero, the  task
410
 
              asked  for  by  the  client  will  not  be run. This command and
411
 
              related options can be overriddden by the  client  configuration
 
418
              arguments  to  it  are 'pre', '(client command)', 'reserved3' to
 
419
              'reserved5',     and     then     arguments      defined      by
 
420
              server_script_pre_arg.  If the script returns non-zero, the task
 
421
              asked for by the client  will  not  be  run.  This  command  and
 
422
              related  options  can be overriddden by the client configuration
412
423
              files in clientconfdir on the server.
413
424
 
414
425
       server_script_pre_arg=[string]
416
427
              many of these.
417
428
 
418
429
       server_script_post=[path]
419
 
              Path to a script to run on the server before the client  discon‐
420
 
              nects.  The  arguments  to  it  are  'post', '(client command)',
 
430
              Path  to a script to run on the server before the client discon‐
 
431
              nects. The arguments  to  it  are  'post',  '(client  command)',
421
432
              'reserved3'  to  'reserved5',  and  then  arguments  defined  by
422
 
              server_script_post_arg.  This command and related options can be
423
 
              overriddden by the client configuration files  in  clientconfdir
 
433
              server_script_post_arg. This command and related options can  be
 
434
              overriddden  by  the client configuration files in clientconfdir
424
435
              on the server.
425
436
 
426
437
       server_script_post_arg=[string]
427
 
              A  user-definable  argument  to  the server post script. You can
 
438
              A user-definable argument to the server  post  script.  You  can
428
439
              have many of these.
429
440
 
430
441
       server_script=[path]
431
442
              You can use this to save space in your config file when you want
432
 
              to   run   the   same   server   script   twice.   It  overrides
433
 
              server_script_pre  and  server_script_post.  This  command   and
434
 
              related  options  can be overriddden by the client configuration
 
443
              to  run   the   same   server   script   twice.   It   overrides
 
444
              server_script_pre   and  server_script_post.  This  command  and
 
445
              related options can be overriddden by the  client  configuration
435
446
              files in clientconfdir on the server.
436
447
 
437
448
       server_script_arg=[path]
438
 
              Goes with server_script and overrides server_script_pre_arg  and
 
449
              Goes  with server_script and overrides server_script_pre_arg and
439
450
              server_script_post_arg.
440
451
 
441
452
       server_script_post_run_on_fail=[0|1]
442
 
              If  this is set to 1, server_script_post will always be run. The
443
 
              default is 0, which means that if the  task  asked  for  by  the
 
453
              If this is set to 1, server_script_post will always be run.  The
 
454
              default  is  0,  which  means  that if the task asked for by the
444
455
              client fails, server_script_post will not be run.
445
456
 
446
457
       autoupgrade_dir=[path]
447
 
              Path  to  autoupgrade  directory  from  which upgrades are down‐
 
458
              Path to autoupgrade directory  from  which  upgrades  are  down‐
448
459
              loaded. The option can be left unset in order not to autoupgrade
449
 
              clients.  Please  see docs/autoupgrade.txt in the source package
 
460
              clients. Please see docs/autoupgrade.txt in the  source  package
450
461
              for more help with this option.
451
462
 
452
463
 
483
494
              Run as a particular group (not supported on Windows).
484
495
 
485
496
       ratelimit=[Mb/s]
486
 
              Set  the network send rate limit, in Mb/s. If this option is not
 
497
              Set the network send rate limit, in Mb/s. If this option is  not
487
498
              given, burp will send data as fast as it can.
488
499
 
489
500
       network_timeout=[s]
490
 
              Set the network timeout in  seconds.  If  no  data  is  sent  or
491
 
              received  over  a  period of this length, burp will give up. The
 
501
              Set  the  network  timeout  in  seconds.  If  no data is sent or
 
502
              received over a period of this length, burp will  give  up.  The
492
503
              default is 7200 seconds (2 hours).
493
504
 
494
505
       include=[path]
495
 
              Path to include in the backup. You  can  have  multiple  include
496
 
              lines.  Use  forward  slashes  '/',  not backslashes '\' as path
 
506
              Path  to  include  in  the backup. You can have multiple include
 
507
              lines. Use forward slashes '/',  not  backslashes  '\'  as  path
497
508
              delimiters.
498
509
 
499
510
       exclude=[path]
500
 
              Path to exclude from the backup. You can have  multiple  exclude
501
 
              lines.  Use  forward  slashes  '/',  not backslashes '\' as path
 
511
              Path  to  exclude from the backup. You can have multiple exclude
 
512
              lines. Use forward slashes '/',  not  backslashes  '\'  as  path
502
513
              delimiters.
503
514
 
504
515
       exclude_ext=[extension]
506
517
              have multiple exclude extension lines. For example, set 'vdi' to
507
518
              exclude VirtualBox disk images.
508
519
 
 
520
       exclude_fs=[fstype]
 
521
              File  systems  to exclude from the backup. Case insensitive. You
 
522
              can have multiple exclude file system lines.  For  example,  set
 
523
              'tmpfs'  to  exclude tmpfs. Burp has an internal mapping of file
 
524
              system names to file system IDs. If you know the file system ID,
 
525
              you can use that instead. For example, 'exclude_fs = 0x01021994'
 
526
              will also exclude tmpfs.
 
527
 
509
528
       min_file_size=[b/Kb/Mb/Gb]
510
529
              Do not back up files that are  less  than  the  specified  size.
511
530
              Example:  'min_file_size = 10Mb'. Set to 0 (the default) to have