Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
View | Details | Raw Unified | Return to bug 205558 | Differences between
and this patch

Collapse All | Expand All

(-)boxbackup-0.11rc2.dist/bin/bbackupd/bbackupd-config.in (-2 / +2 lines)
Lines 19-25 Link Here
19
        working-dir [backup directories]
19
        working-dir [backup directories]
20
20
21
Parameters:
21
Parameters:
22
    config-dir          is usually @sysconfdir_expanded@/box
22
    config-dir          is usually @sysconfdir_expanded@/boxbackup
23
    backup-mode         is lazy or snapshot:
23
    backup-mode         is lazy or snapshot:
24
        lazy mode       runs continously, uploading files over a specified age
24
        lazy mode       runs continously, uploading files over a specified age
25
        snapshot mode   uploads a snapshot of the filesystem when instructed
25
        snapshot mode   uploads a snapshot of the filesystem when instructed
Lines 57-63 Link Here
57
}
57
}
58
58
59
# default locations
59
# default locations
60
my $default_config_location = '@sysconfdir_expanded@/box/bbackupd.conf';
60
my $default_config_location = '@sysconfdir_expanded@/boxbackup/bbackupd.conf';
61
61
62
# command line parameters
62
# command line parameters
63
my ($config_dir,$backup_mode,$account_num,$server,$working_dir,@tobackup) = @ARGV;
63
my ($config_dir,$backup_mode,$account_num,$server,$working_dir,@tobackup) = @ARGV;
(-)boxbackup-0.11rc2.dist/bin/bbstored/BackupConstants.h (-1 / +1 lines)
Lines 49-55 Link Here
49
#ifndef BACKUPCONSTANTS__H
49
#ifndef BACKUPCONSTANTS__H
50
#define BACKUPCONSTANTS__H
50
#define BACKUPCONSTANTS__H
51
51
52
#define BACKUP_STORE_DEFAULT_ACCOUNT_DATABASE_FILE	"/etc/box/backupstoreaccounts"
52
#define BACKUP_STORE_DEFAULT_ACCOUNT_DATABASE_FILE	"/etc/boxbackup/backupstoreaccounts"
53
53
54
// 15 minutes to timeout (milliseconds)
54
// 15 minutes to timeout (milliseconds)
55
#define	BACKUP_STORE_TIMEOUT			(15*60*1000)
55
#define	BACKUP_STORE_TIMEOUT			(15*60*1000)
(-)boxbackup-0.11rc2.dist/bin/bbstored/bbstored-config.in (-2 / +2 lines)
Lines 19-25 Link Here
19
    bbstored-config config-dir server-hostname username [raidfile-config]
19
    bbstored-config config-dir server-hostname username [raidfile-config]
20
20
21
Parameters:
21
Parameters:
22
    config-dir       is usually @sysconfdir_expanded@/box
22
    config-dir       is usually @sysconfdir_expanded@/boxbackup
23
    server-hostname  is the hostname that clients will use to connect to
23
    server-hostname  is the hostname that clients will use to connect to
24
                     this server
24
                     this server
25
    username         is the user to run the server under
25
    username         is the user to run the server under
Lines 47-53 Link Here
47
}
47
}
48
48
49
# default locations
49
# default locations
50
my $default_config_location = '@sysconfdir_expanded@/box/bbstored.conf';
50
my $default_config_location = '@sysconfdir_expanded@/boxbackup/bbstored.conf';
51
51
52
# command line parameters
52
# command line parameters
53
my ($config_dir,$server,$username,$raidfile_config) = @ARGV;
53
my ($config_dir,$server,$username,$raidfile_config) = @ARGV;
(-)boxbackup-0.11rc2.dist/configure.ac (-1 / +4 lines)
Lines 283-289 Link Here
283
localstatedir_expanded=`eval "echo $localstatedir"`
283
localstatedir_expanded=`eval "echo $localstatedir"`
284
prefix=$saved_prefix
284
prefix=$saved_prefix
285
exec_prefix=$saved_exec_prefix
285
exec_prefix=$saved_exec_prefix
286
AC_SUBST([bindir_expanded sysconfdir_expanded localstatedir_expanded])
286
AC_SUBST([bindir_expanded])
287
AC_SUBST([sbindir_expanded])
288
AC_SUBST([sysconfdir_expanded])
289
AC_SUBST([localstatedir_expanded])
287
290
288
291
289
### Output files
292
### Output files
(-)boxbackup-0.11rc2.dist/documentation/adminguide.xml (-48 / +48 lines)
Lines 96-117 Link Here
96
        <programlisting>mkdir /tmp/boxbackupRepository                        # Create the directory
96
        <programlisting>mkdir /tmp/boxbackupRepository                        # Create the directory
97
chown _bbstored /tmp/boxbackupRepository/             # Change the owner to the new boxbackup daemon user
97
chown _bbstored /tmp/boxbackupRepository/             # Change the owner to the new boxbackup daemon user
98
98
99
/usr/local/bin/raidfile-config /etc/box/  1024 /tmp/boxbackupRepository
99
/usr/sbin/raidfile-config /etc/boxbackup/  1024 /tmp/boxbackupRepository
100
100
101
#substitute 1024 with the desired blocksize
101
#substitute 1024 with the desired blocksize
102
#substitute /tmp/boxbackupRepository with a directory that exists where you want the backup store located
102
#substitute /tmp/boxbackupRepository with a directory that exists where you want the backup store located
103
#/usr/local/bin/raidfile-config --help shows you the options</programlisting>
103
#/usr/sbin/raidfile-config --help shows you the options</programlisting>
104
104
105
        <para>Then create the configuration file /etc/box/bbstored.conf The
105
        <para>Then create the configuration file /etc/boxbackup/bbstored.conf The
106
        hostname is tricky as it is used for two things: The name of the
106
        hostname is tricky as it is used for two things: The name of the
107
        server in the certificate and the address the server is listening on.
107
        server in the certificate and the address the server is listening on.
108
        Since you might be using NAT, might move the server around or the
108
        Since you might be using NAT, might move the server around or the
109
        domain name might change, choose a name that describes the server.
109
        domain name might change, choose a name that describes the server.
110
        When the network address of the server changes, you need to update the
110
        When the network address of the server changes, you need to update the
111
        <literal>ListenAddresses</literal> directive in the
111
        <literal>ListenAddresses</literal> directive in the
112
        <filename>/etc/box/bbstored.conf</filename> file.</para>
112
        <filename>/etc/boxbackup/bbstored.conf</filename> file.</para>
113
113
114
        <programlisting>/usr/local/bin/bbstored-config /etc/box hostname _bbstored</programlisting>
114
        <programlisting>/usr/sbin/bbstored-config /etc/boxbackup hostname _bbstored</programlisting>
115
115
116
        <para>This last step outputs 5 instructions that you must execute to
116
        <para>This last step outputs 5 instructions that you must execute to
117
        the letter. A lot of questions are raised on the mailing list because
117
        the letter. A lot of questions are raised on the mailing list because
Lines 164-170 Link Here
164
164
165
          <para>To setup the basic key structure, do the following:</para>
165
          <para>To setup the basic key structure, do the following:</para>
166
166
167
          <programlisting>/usr/local/bin/bbstored-certs ca init</programlisting>
167
          <programlisting>/usr/sbin/bbstored-certs ca init</programlisting>
168
168
169
          <para>(See <ulink url="instguide.xml">OpenSSL notes</ulink> if you
169
          <para>(See <ulink url="instguide.xml">OpenSSL notes</ulink> if you
170
          get an OpenSSL error)</para>
170
          get an OpenSSL error)</para>
Lines 181-187 Link Here
181
          request (CSR) for you. Transfer it to the machine with your CA, then
181
          request (CSR) for you. Transfer it to the machine with your CA, then
182
          do:</para>
182
          do:</para>
183
183
184
          <programlisting>/usr/local/bin/bbstored-certs ca sign-server hostname-csr.pem</programlisting>
184
          <programlisting>/usr/sbin/bbstored-certs ca sign-server hostname-csr.pem</programlisting>
185
185
186
          <para>This signs the certificate for the server. Follow the
186
          <para>This signs the certificate for the server. Follow the
187
          instructions in the output on which files to install on the server.
187
          instructions in the output on which files to install on the server.
Lines 199-205 Link Here
199
          0, for example, 1 or 75AB23C. Then on the backup store server,
199
          0, for example, 1 or 75AB23C. Then on the backup store server,
200
          create the account with:</para>
200
          create the account with:</para>
201
201
202
          <programlisting>/usr/local/bin/bbstoreaccounts create 75AB23C 0 4096M 4505M</programlisting>
202
          <programlisting>/usr/sbin/bbstoreaccounts create 75AB23C 0 4096M 4505M</programlisting>
203
203
204
          <para>This looks complicated. The numbers are, in order:</para>
204
          <para>This looks complicated. The numbers are, in order:</para>
205
205
Lines 261-267 Link Here
261
261
262
          <para>Sign this CSR with this command:</para>
262
          <para>Sign this CSR with this command:</para>
263
263
264
          <programlisting>/usr/local/bin/bbstored-certs ca sign 75AB23C-csr.pem</programlisting>
264
          <programlisting>/usr/sbin/bbstored-certs ca sign 75AB23C-csr.pem</programlisting>
265
265
266
          <para>Don't forget to check that the embedded account number is
266
          <para>Don't forget to check that the embedded account number is
267
          correct! Then send the two files back to the user, as instructed by
267
          correct! Then send the two files back to the user, as instructed by
Lines 333-339 Link Here
333
        <para>The backup client has to be run as root, because it needs to
333
        <para>The backup client has to be run as root, because it needs to
334
        read all your files to back them up, although it is possible to back
334
        read all your files to back them up, although it is possible to back
335
        up a single user's files by running it as that user. (Tip: specify a
335
        up a single user's files by running it as that user. (Tip: specify a
336
        directory other than <filename>/etc/box</filename>, and then give the
336
        directory other than <filename>/etc/boxbackup</filename>, and then give the
337
        alternate config file as the first argument to
337
        alternate config file as the first argument to
338
        <command>bbackupd</command>). However, it will fall over if you don't
338
        <command>bbackupd</command>). However, it will fall over if you don't
339
        give yourself read access to one of your files.</para>
339
        give yourself read access to one of your files.</para>
Lines 345-351 Link Here
345
          the configuration files and generate a private key and certificate
345
          the configuration files and generate a private key and certificate
346
          request.</para>
346
          request.</para>
347
347
348
          <programlisting>/usr/local/bin/bbackupd-config /etc/box lazy <emphasis
348
          <programlisting>/usr/sbin/bbackupd-config /etc/boxbackup lazy <emphasis
349
              role="bold">999 hostname</emphasis> /var/bbackupd <emphasis
349
              role="bold">999 hostname</emphasis> /var/bbackupd <emphasis
350
              role="bold">/home</emphasis></programlisting>
350
              role="bold">/home</emphasis></programlisting>
351
351
Lines 407-413 Link Here
407
          basic bbackupd configuration.</para>
407
          basic bbackupd configuration.</para>
408
408
409
          <para>You can then run the daemon (as root) by running
409
          <para>You can then run the daemon (as root) by running
410
          <command>/usr/local/bin/bbackupd</command>, and of course, adding it
410
          <command>/usr/sbin/bbackupd</command>, and of course, adding it
411
          to your system's startup scripts. The first time it's run it will
411
          to your system's startup scripts. The first time it's run it will
412
          upload everything. Interrupting it and restarting it will only
412
          upload everything. Interrupting it and restarting it will only
413
          upload files which were not uploaded before - it's very
413
          upload files which were not uploaded before - it's very
Lines 423-429 Link Here
423
          <para>Remember to make a traditional backup of the keys file, as
423
          <para>Remember to make a traditional backup of the keys file, as
424
          instructed. You cannot restore files without it.</para>
424
          instructed. You cannot restore files without it.</para>
425
425
426
          <para>It is recommended that you backup up all of /etc/box as it
426
          <para>It is recommended that you backup up all of /etc/boxbackup as it
427
          will make things easier if you need to restore files. But only the
427
          will make things easier if you need to restore files. But only the
428
          keys are absolutely essential.</para>
428
          keys are absolutely essential.</para>
429
429
Lines 435-441 Link Here
435
        <section>
435
        <section>
436
          <title>Adding and removing backed up locations</title>
436
          <title>Adding and removing backed up locations</title>
437
437
438
          <para>By editing the /etc/box/bbackupd.conf file, you can add and
438
          <para>By editing the /etc/boxbackup/bbackupd.conf file, you can add and
439
          remove directories to back up - see comments in this file for help.
439
          remove directories to back up - see comments in this file for help.
440
          Send bbackupd a HUP signal after you modify it.</para>
440
          Send bbackupd a HUP signal after you modify it.</para>
441
441
Lines 517-528 Link Here
517
            here -- they may be different for your system.</para>
517
            here -- they may be different for your system.</para>
518
          </important>
518
          </important>
519
519
520
          <programlisting>/usr/local/bin/bbackupd-config /etc/box lazy 51 server.example.com /var/bbackupd /home /etc/samba
520
          <programlisting>/usr/sbin/bbackupd-config /etc/boxbackup lazy 51 server.example.com /var/bbackupd /home /etc/samba
521
521
522
Setup bbackupd config utility.
522
Setup bbackupd config utility.
523
523
524
Configuration:
524
Configuration:
525
   Writing configuration file: /etc/box/bbackupd.conf
525
   Writing configuration file: /etc/boxbackup/bbackupd.conf
526
   Account: 51
526
   Account: 51
527
   Server hostname: server.example.com
527
   Server hostname: server.example.com
528
   Directories to back up:
528
   Directories to back up:
Lines 535-548 Link Here
535
535
536
WARNING: Directories not checked against mountpoints. Check mounted filesystems manually.
536
WARNING: Directories not checked against mountpoints. Check mounted filesystems manually.
537
537
538
Creating /etc/box...
538
Creating /etc/boxbackup...
539
Creating /etc/box/bbackupd
539
Creating /etc/boxbackup/bbackupd
540
Generating private key...
540
Generating private key...
541
 [OpenSSL output omitted]
541
 [OpenSSL output omitted]
542
542
543
Generating keys for file backup
543
Generating keys for file backup
544
Writing notify script /etc/box/bbackupd/NotifyStoreFull.sh
544
Writing notify script /etc/boxbackup/bbackupd/NotifyStoreFull.sh
545
Writing configuration file /etc/box/bbackupd.conf
545
Writing configuration file /etc/boxbackup/bbackupd.conf
546
546
547
===================================================================
547
===================================================================
548
548
Lines 550-585 Link Here
550
550
551
What you need to do now...
551
What you need to do now...
552
552
553
1) Make a backup of /etc/box/bbackupd/51-FileEncKeys.raw
553
1) Make a backup of /etc/boxbackup/bbackupd/51-FileEncKeys.raw
554
   This should be a secure offsite backup.
554
   This should be a secure offsite backup.
555
   Without it, you cannot restore backups. Everything else can
555
   Without it, you cannot restore backups. Everything else can
556
   be replaced. But this cannot.
556
   be replaced. But this cannot.
557
   KEEP IT IN A SAFE PLACE, OTHERWISE YOUR BACKUPS ARE USELESS.
557
   KEEP IT IN A SAFE PLACE, OTHERWISE YOUR BACKUPS ARE USELESS.
558
558
559
2) Send /etc/box/bbackupd/51-csr.pem
559
2) Send /etc/boxbackup/bbackupd/51-csr.pem
560
   to the administrator of the backup server, and ask for it to
560
   to the administrator of the backup server, and ask for it to
561
   be signed.
561
   be signed.
562
562
563
3) The administrator will send you two files. Install them as
563
3) The administrator will send you two files. Install them as
564
      /etc/box/bbackupd/51-cert.pem
564
      /etc/boxbackup/bbackupd/51-cert.pem
565
      /etc/box/bbackupd/serverCA.pem
565
      /etc/boxbackup/bbackupd/serverCA.pem
566
   after checking their authenticity.
566
   after checking their authenticity.
567
567
568
4) You may wish to read the configuration file
568
4) You may wish to read the configuration file
569
      /etc/box/bbackupd.conf
569
      /etc/boxbackup/bbackupd.conf
570
   and adjust as appropraite.
570
   and adjust as appropraite.
571
   
571
   
572
   There are some notes in it on excluding files you do not
572
   There are some notes in it on excluding files you do not
573
   wish to be backed up.
573
   wish to be backed up.
574
574
575
5) Review the script
575
5) Review the script
576
      /etc/box/bbackupd/NotifyStoreFull.sh
576
      /etc/boxbackup/bbackupd/NotifyStoreFull.sh
577
   and check that it will email the right person when the store
577
   and check that it will email the right person when the store
578
   becomes full. This is important -- when the store is full, no
578
   becomes full. This is important -- when the store is full, no
579
   more files will be backed up. You want to know about this.
579
   more files will be backed up. You want to know about this.
580
580
581
6) Start the backup daemon with the command
581
6) Start the backup daemon with the command
582
      /usr/local/bin/bbackupd
582
      /usr/sbin/bbackupd
583
   in /etc/rc.local, or your local equivalent.
583
   in /etc/rc.local, or your local equivalent.
584
   Note that bbackupd must run as root.
584
   Note that bbackupd must run as root.
585
585
Lines 607-618 Link Here
607
          <programlisting>StoreHostname = localhost
607
          <programlisting>StoreHostname = localhost
608
AccountNumber = 0x2
608
AccountNumber = 0x2
609
609
610
KeysFile = /etc/box/2-FileEncKeys.raw
610
KeysFile = /etc/boxbackup/2-FileEncKeys.raw
611
CertificateFile = /etc/box/2-cert.pem
611
CertificateFile = /etc/boxbackup/2-cert.pem
612
PrivateKeyFile = /etc/box/2-key.pem
612
PrivateKeyFile = /etc/boxbackup/2-key.pem
613
TrustedCAsFile = /etc/box/serverCA.pem
613
TrustedCAsFile = /etc/boxbackup/serverCA.pem
614
DataDirectory = /var/run/boxbackup
614
DataDirectory = /var/run/boxbackup
615
NotifyScript = /etc/box/NotifySysadmin.sh
615
NotifyScript = /etc/boxbackup/NotifySysadmin.sh
616
CommandSocket = /var/run/box/bbackupd.sock
616
CommandSocket = /var/run/box/bbackupd.sock
617
617
618
UpdateStoreInterval = 86400
618
UpdateStoreInterval = 86400
Lines 1304-1310 Link Here
1304
1304
1305
        <para>The command line syntax is:</para>
1305
        <para>The command line syntax is:</para>
1306
1306
1307
        <programlisting>/usr/local/bin/bbackupctl [-q] [-c config-file] command</programlisting>
1307
        <programlisting>/usr/sbin/bbackupctl [-q] [-c config-file] command</programlisting>
1308
1308
1309
        <para>The -q option reduces the amount of output the program emits,
1309
        <para>The -q option reduces the amount of output the program emits,
1310
        and -c allows an alternative configuration file to be
1310
        and -c allows an alternative configuration file to be
Lines 1358-1364 Link Here
1358
        <para>Use bbackupd-config to write a configuration file in snapshot
1358
        <para>Use bbackupd-config to write a configuration file in snapshot
1359
        mode, and then run the following command as a cron job.</para>
1359
        mode, and then run the following command as a cron job.</para>
1360
1360
1361
        <programlisting>/usr/local/bin/bbackupctl -q sync</programlisting>
1361
        <programlisting>/usr/sbin/bbackupctl -q sync</programlisting>
1362
1362
1363
        <para>This will cause the backup daemon to upload all changed files
1363
        <para>This will cause the backup daemon to upload all changed files
1364
        immediately. <emphasis role="bold">bbackupctl</emphasis> will exit
1364
        immediately. <emphasis role="bold">bbackupctl</emphasis> will exit
Lines 1376-1382 Link Here
1376
          for this account. Either use the usage command in interactive mode,
1376
          for this account. Either use the usage command in interactive mode,
1377
          or type:</para>
1377
          or type:</para>
1378
1378
1379
          <programlisting>/usr/local/bin/bbackupquery -q usage quit</programlisting>
1379
          <programlisting>/usr/sbin/bbackupquery -q usage quit</programlisting>
1380
1380
1381
          <para>to show the space used as a single command.</para>
1381
          <para>to show the space used as a single command.</para>
1382
        </section>
1382
        </section>
Lines 1388-1398 Link Here
1388
          the limits. To display the space used on the server for an account,
1388
          the limits. To display the space used on the server for an account,
1389
          use:</para>
1389
          use:</para>
1390
1390
1391
          <programlisting>/usr/local/bin/bbstoreaccounts info 75AB23C</programlisting>
1391
          <programlisting>/usr/sbin/bbstoreaccounts info 75AB23C</programlisting>
1392
1392
1393
          <para>To adjust the soft and hard limits on an account, use:</para>
1393
          <para>To adjust the soft and hard limits on an account, use:</para>
1394
1394
1395
          <programlisting>/usr/local/bin/bbstoreaccounts setlimit 75AB23C new-soft-limit new-hard-limit</programlisting>
1395
          <programlisting>/usr/sbin/bbstoreaccounts setlimit 75AB23C new-soft-limit new-hard-limit</programlisting>
1396
1396
1397
          <para>You do not need to restart the server.</para>
1397
          <para>You do not need to restart the server.</para>
1398
        </section>
1398
        </section>
Lines 1405-1411 Link Here
1405
        utility does this and more.</para>
1405
        utility does this and more.</para>
1406
1406
1407
        <para>You don't provide any login information to it, as it just picks
1407
        <para>You don't provide any login information to it, as it just picks
1408
        up the data it needs from /etc/box/bbackupd.conf. You should run it as
1408
        up the data it needs from /etc/boxbackup/bbackupd.conf. You should run it as
1409
        root so it can find everything it needs.</para>
1409
        root so it can find everything it needs.</para>
1410
1410
1411
        <para>Full documentation can be found in the <ulink
1411
        <para>Full documentation can be found in the <ulink
Lines 1435-1441 Link Here
1435
1435
1436
          <programlisting>[pthomsen@host bbackupquery]$ bbackupquery 
1436
          <programlisting>[pthomsen@host bbackupquery]$ bbackupquery 
1437
Box Backup Query Tool  v0.10, (c) Ben Summers and contributors 2003-2006
1437
Box Backup Query Tool  v0.10, (c) Ben Summers and contributors 2003-2006
1438
Using configuration file /etc/box/bbackupd.conf
1438
Using configuration file /etc/boxbackup/bbackupd.conf
1439
Connecting to store...
1439
Connecting to store...
1440
Handshake with store...
1440
Handshake with store...
1441
Login to store...
1441
Login to store...
Lines 1538-1544 Link Here
1538
          regularly, and check its output. You can run the command manually as
1538
          regularly, and check its output. You can run the command manually as
1539
          follows:</para>
1539
          follows:</para>
1540
1540
1541
          <programlisting>/usr/local/bin/bbackupquery "compare -a" quit</programlisting>
1541
          <programlisting>/usr/sbin/bbackupquery "compare -a" quit</programlisting>
1542
1542
1543
          <para>This command will report all the differences found between the
1543
          <para>This command will report all the differences found between the
1544
          store and the files on disc. It will download everything, so may
1544
          store and the files on disc. It will download everything, so may
Lines 1561-1567 Link Here
1561
          <para>If you would like to do a "quick" check which just downloads
1561
          <para>If you would like to do a "quick" check which just downloads
1562
          file checksums and compares against that, then run:</para>
1562
          file checksums and compares against that, then run:</para>
1563
1563
1564
          <programlisting>/usr/local/bin/bbackupquery "compare -aq" quit</programlisting>
1564
          <programlisting>/usr/sbin/bbackupquery "compare -aq" quit</programlisting>
1565
1565
1566
          <para>However, this does not check that the file attributes are
1566
          <para>However, this does not check that the file attributes are
1567
          correct, and since the checksums are generated on the client they
1567
          correct, and since the checksums are generated on the client they
Lines 1580-1586 Link Here
1580
          file safe, you indirectly keep your entire backup safe.</para>
1580
          file safe, you indirectly keep your entire backup safe.</para>
1581
1581
1582
          <para>The first step is to recreate the configuration of the backup
1582
          <para>The first step is to recreate the configuration of the backup
1583
          client. It's probably best to have stored the /etc/box directory
1583
          client. It's probably best to have stored the /etc/boxbackup directory
1584
          with your keys. But if you're recreating it, all you really need is
1584
          with your keys. But if you're recreating it, all you really need is
1585
          to have got the login infomation correct (ie the certs and
1585
          to have got the login infomation correct (ie the certs and
1586
          keys).</para>
1586
          keys).</para>
Lines 1595-1601 Link Here
1595
1595
1596
          <para>Type:</para>
1596
          <para>Type:</para>
1597
1597
1598
          <programlisting>/usr/local/bin/bbackupquery</programlisting>
1598
          <programlisting>/usr/sbin/bbackupquery</programlisting>
1599
1599
1600
          <para>to run it in interactive mode.</para>
1600
          <para>to run it in interactive mode.</para>
1601
1601
Lines 1628-1634 Link Here
1628
          <para>Firstly, run bbackupquery in interactive mode. It behaves in a
1628
          <para>Firstly, run bbackupquery in interactive mode. It behaves in a
1629
          similar manner to a command line sftp client.</para>
1629
          similar manner to a command line sftp client.</para>
1630
1630
1631
          <programlisting>/usr/local/bin/bbackupquery</programlisting>
1631
          <programlisting>/usr/sbin/bbackupquery</programlisting>
1632
1632
1633
          <para>Then navigate to the directory containing the file you want,
1633
          <para>Then navigate to the directory containing the file you want,
1634
          using list, cd and pwd.</para>
1634
          using list, cd and pwd.</para>
Lines 1744-1757 Link Here
1744
        <para>First, run the check utility, and see what errors it
1744
        <para>First, run the check utility, and see what errors it
1745
        reports.</para>
1745
        reports.</para>
1746
1746
1747
        <programlisting>/usr/local/bin/bbstoreaccounts check 1234</programlisting>
1747
        <programlisting>/usr/sbin/bbstoreaccounts check 1234</programlisting>
1748
1748
1749
        <para>This will take some time, and use a fair bit of memory (about 16
1749
        <para>This will take some time, and use a fair bit of memory (about 16
1750
        bytes per file and directory). If the output looks plausible and
1750
        bytes per file and directory). If the output looks plausible and
1751
        reports errors which need fixing, run it again but with the fix
1751
        reports errors which need fixing, run it again but with the fix
1752
        flag:</para>
1752
        flag:</para>
1753
1753
1754
        <programlisting>/usr/local/bin/bbstoreaccounts check 1234 fix</programlisting>
1754
        <programlisting>/usr/sbin/bbstoreaccounts check 1234 fix</programlisting>
1755
1755
1756
        <para>This will fix any errors, and remove unrecoverable files.
1756
        <para>This will fix any errors, and remove unrecoverable files.
1757
        Directories will be recreated if necessary.</para>
1757
        Directories will be recreated if necessary.</para>
Lines 1841-1847 Link Here
1841
        configuration file locations to daemons and programs. For
1841
        configuration file locations to daemons and programs. For
1842
        example</para>
1842
        example</para>
1843
1843
1844
        <programlisting>/usr/local/bin/bbstored /some/other/dir/bbstored.config /usr/local/bin/bbackupquery -c /some/other/dir/bbackupd.config</programlisting>
1844
        <programlisting>/usr/sbin/bbstored /some/other/dir/bbstored.config /usr/sbin/bbackupquery -c /some/other/dir/bbackupd.config</programlisting>
1845
1845
1846
        <para>(daemons specify the name as the first argument, utility
1846
        <para>(daemons specify the name as the first argument, utility
1847
        programs with the -c option).</para>
1847
        programs with the -c option).</para>
Lines 1965-1971 Link Here
1965
      <para>Follow the installation instructions, but install the executable
1965
      <para>Follow the installation instructions, but install the executable
1966
      files manually to somewhere in your home directory. Then use
1966
      files manually to somewhere in your home directory. Then use
1967
      bbackupd-config to configure the daemon, but use a directory other than
1967
      bbackupd-config to configure the daemon, but use a directory other than
1968
      /etc/box, probably somewhere in your home directory.</para>
1968
      /etc/boxbackup, probably somewhere in your home directory.</para>
1969
1969
1970
      <para>All directories you specify to be backed up must be readable, and
1970
      <para>All directories you specify to be backed up must be readable, and
1971
      all files must be owned by the user and readable to that user.</para>
1971
      all files must be owned by the user and readable to that user.</para>
(-)boxbackup-0.11rc2.dist/documentation/bbackupctl.xml (-1 / +1 lines)
Lines 103-109 Link Here
103
103
104
    <para><literal>bbackupctl</literal> uses the Box Backup client
104
    <para><literal>bbackupctl</literal> uses the Box Backup client
105
    configuration file, usually located in
105
    configuration file, usually located in
106
    <filename>/etc/box/bbackupd.conf</filename>. On Windows this file is
106
    <filename>/etc/boxbackup/bbackupd.conf</filename>. On Windows this file is
107
    usually located in the installation directory, and is named
107
    usually located in the installation directory, and is named
108
    <filename>bbackupd.conf</filename> as well.</para>
108
    <filename>bbackupd.conf</filename> as well.</para>
109
  </refsection>
109
  </refsection>
(-)boxbackup-0.11rc2.dist/documentation/bbackupquery.xml (-1 / +1 lines)
Lines 336-342 Link Here
336
336
337
    <para><literal>bbackupquery</literal> uses the Box Backup client
337
    <para><literal>bbackupquery</literal> uses the Box Backup client
338
    configuration file, usually located in
338
    configuration file, usually located in
339
    <filename>/etc/box/bbackupd.conf</filename>. On Windows this file is
339
    <filename>/etc/boxbackup/bbackupd.conf</filename>. On Windows this file is
340
    usually located in the installation directory, and is named
340
    usually located in the installation directory, and is named
341
    <filename>bbackupd.conf</filename> as well.</para>
341
    <filename>bbackupd.conf</filename> as well.</para>
342
  </refsection>
342
  </refsection>
(-)boxbackup-0.11rc2.dist/documentation/bbstoreaccounts.xml (-2 / +2 lines)
Lines 38-44 Link Here
38
      <para><literal>-c &lt;configfile&gt;</literal></para>
38
      <para><literal>-c &lt;configfile&gt;</literal></para>
39
39
40
      <para>The configfile to use for connecting to the store. Default is
40
      <para>The configfile to use for connecting to the store. Default is
41
      <literal>/etc/box/bbstored.conf</literal>.</para>
41
      <literal>/etc/boxbackup/bbstored.conf</literal>.</para>
42
    </refsection>
42
    </refsection>
43
43
44
    <refsection>
44
    <refsection>
Lines 248-254 Link Here
248
248
249
    <para><literal>bbstoreaccounts</literal> uses the Box Backup server
249
    <para><literal>bbstoreaccounts</literal> uses the Box Backup server
250
    configuration file, usually located in
250
    configuration file, usually located in
251
    <filename>/etc/box/bbstored.conf</filename>. </para>
251
    <filename>/etc/boxbackup/bbstored.conf</filename>. </para>
252
  </refsection>
252
  </refsection>
253
253
254
  <refsection>
254
  <refsection>
(-)boxbackup-0.11rc2.dist/documentation/bbstored-config.xml (-1 / +1 lines)
Lines 98-104 Link Here
98
98
99
    <para><literal>bbstoreaccounts</literal> uses the Box Backup server
99
    <para><literal>bbstoreaccounts</literal> uses the Box Backup server
100
    configuration file, usually located in
100
    configuration file, usually located in
101
    <filename>/etc/box/bbstored.conf</filename>.</para>
101
    <filename>/etc/boxbackup/bbstored.conf</filename>.</para>
102
  </refsection>
102
  </refsection>
103
103
104
  <refsection>
104
  <refsection>
(-)boxbackup-0.11rc2.dist/documentation/instguide.xml (-1 / +1 lines)
Lines 240-246 Link Here
240
      <para>This builds two parcels of binaries and scripts, 'backup-client'
240
      <para>This builds two parcels of binaries and scripts, 'backup-client'
241
      and 'backup-server'. The generated installation scripts assumes you want
241
      and 'backup-server'. The generated installation scripts assumes you want
242
      everything installed in <emphasis
242
      everything installed in <emphasis
243
      role="bold">/usr/local/bin</emphasis></para>
243
      role="bold">/usr/sbin</emphasis></para>
244
244
245
      <para>Optionally, type <emphasis role="bold">make test</emphasis> to run
245
      <para>Optionally, type <emphasis role="bold">make test</emphasis> to run
246
      all the tests.</para>
246
      all the tests.</para>
(-)boxbackup-0.11rc2.dist/documentation/raidfile-config.xml (-1 / +1 lines)
Lines 39-45 Link Here
39
        <listitem>
39
        <listitem>
40
          <para><literal>configdir</literal>: The directory path where
40
          <para><literal>configdir</literal>: The directory path where
41
          configuration files are located. Usually this is
41
          configuration files are located. Usually this is
42
          <literal>/etc/box</literal>. <literal>raidfile.conf</literal> will
42
          <literal>/etc/boxbackup</literal>. <literal>raidfile.conf</literal> will
43
          be written in this directory.</para>
43
          be written in this directory.</para>
44
        </listitem>
44
        </listitem>
45
45
(-)boxbackup-0.11rc2.dist/infrastructure/makeparcels.pl.in (+1 lines)
Lines 161-166 Link Here
161
			{
161
			{
162
				$local_install_dir = "@prefix@/$dest";
162
				$local_install_dir = "@prefix@/$dest";
163
			}
163
			}
164
			print SCRIPT "mkdir -p \${DESTDIR}$install_into_dir/\n";
164
			print SCRIPT "install $name " .
165
			print SCRIPT "install $name " .
165
				"\$DESTDIR$local_install_dir\n";
166
				"\$DESTDIR$local_install_dir\n";
166
		}
167
		}
(-)boxbackup-0.11rc2.dist/lib/common/BoxPortsAndFiles.h.in (-3 / +3 lines)
Lines 31-39 Link Here
31
	#define BOX_GET_DEFAULT_BBSTORED_CONFIG_FILE \
31
	#define BOX_GET_DEFAULT_BBSTORED_CONFIG_FILE \
32
		GetDefaultConfigFilePath("bbstored.conf").c_str()
32
		GetDefaultConfigFilePath("bbstored.conf").c_str()
33
#else
33
#else
34
#define BOX_FILE_BBACKUPD_DEFAULT_CONFIG "@sysconfdir_expanded@/box/bbackupd.conf"
34
#define BOX_FILE_BBACKUPD_DEFAULT_CONFIG "@sysconfdir_expanded@/boxbackup/bbackupd.conf"
35
#define BOX_FILE_RAIDFILE_DEFAULT_CONFIG "@sysconfdir_expanded@/box/raidfile.conf"
35
#define BOX_FILE_RAIDFILE_DEFAULT_CONFIG "@sysconfdir_expanded@/boxbackup/raidfile.conf"
36
#define BOX_FILE_BBSTORED_DEFAULT_CONFIG "@sysconfdir_expanded@/box/bbstored.conf"
36
#define BOX_FILE_BBSTORED_DEFAULT_CONFIG "@sysconfdir_expanded@/boxbackup/bbstored.conf"
37
#endif
37
#endif
38
38
39
#endif // BOXPORTSANDFILES__H
39
#endif // BOXPORTSANDFILES__H
(-)boxbackup-0.11rc2.dist/lib/raidfile/RaidFileController.h (-1 / +1 lines)
Lines 121-127 Link Here
121
	
121
	
122
public:
122
public:
123
	void Initialise(const std::string& rConfigFilename = 
123
	void Initialise(const std::string& rConfigFilename = 
124
		"/etc/box/raidfile.conf");
124
		"/etc/boxbackup/raidfile.conf");
125
	int GetNumDiscSets() {return mSetList.size();}
125
	int GetNumDiscSets() {return mSetList.size();}
126
126
127
	// --------------------------------------------------------------------------
127
	// --------------------------------------------------------------------------
(-)boxbackup-0.11rc2.dist/lib/raidfile/raidfile-config.in (-1 / +1 lines)
Lines 19-25 Link Here
19
    raidfile-config config-dir block-size dir0 [dir1 dir2]
19
    raidfile-config config-dir block-size dir0 [dir1 dir2]
20
20
21
Parameters:
21
Parameters:
22
    config-dir        is usually @sysconfdir_expanded@/box
22
    config-dir        is usually @sysconfdir_expanded@/boxbackup
23
    block-size        must be a power of two, and usually the block or
23
    block-size        must be a power of two, and usually the block or
24
                      fragment size of your file system
24
                      fragment size of your file system
25
    dir0, dir1, dir2  are the directories used as the root of the raid
25
    dir0, dir1, dir2  are the directories used as the root of the raid
(-)boxbackup-0.11rc2.dist/notes/backup_encryption.txt (-1 / +1 lines)
Lines 33-39 Link Here
33
33
34
The file data is encrypted with AES in CBC mode, with a 256 bit key (max length). Blowfish is used elsewhere because the larger block size of AES, while more secure, would be terribly space inefficient. Note that Blowfish may also be used when older versions of OpenSSL are in use, and for backwards compatibility with older versions.
34
The file data is encrypted with AES in CBC mode, with a 256 bit key (max length). Blowfish is used elsewhere because the larger block size of AES, while more secure, would be terribly space inefficient. Note that Blowfish may also be used when older versions of OpenSSL are in use, and for backwards compatibility with older versions.
35
35
36
The keys are generated using "openssl rand", and a 1k file of key material is stored in /etc/box/bbackupd. The configuration scripts make this readable only by root.
36
The keys are generated using "openssl rand", and a 1k file of key material is stored in /etc/boxbackup/bbackupd. The configuration scripts make this readable only by root.
37
37
38
Code for review: BackupClientCryptoKeys_Setup()
38
Code for review: BackupClientCryptoKeys_Setup()
39
in lib/backupclient/BackupClientCryptoKeys.cpp
39
in lib/backupclient/BackupClientCryptoKeys.cpp
(-)boxbackup-0.11rc2.dist/notes/lib_raidfile.txt (-1 / +1 lines)
Lines 11-17 Link Here
11
11
12
SUBTITLE Controller
12
SUBTITLE Controller
13
13
14
The raid disc sets are managed by RaidFileController. This reads the configuration file, /etc/box/raidfile.conf, and then stores the sets of discs for use by the other classes.
14
The raid disc sets are managed by RaidFileController. This reads the configuration file, /etc/boxbackup/raidfile.conf, and then stores the sets of discs for use by the other classes.
15
15
16
In the code, files are referenced using an integer set number, and a filename within that set. For example, (0, "dir/subdir/filename.ext"). The RAID file controller turns this into actual physcial filenames transparently.
16
In the code, files are referenced using an integer set number, and a filename within that set. For example, (0, "dir/subdir/filename.ext"). The RAID file controller turns this into actual physcial filenames transparently.
17
17

Return to bug 205558