From faab89ecaf8a2406a1112b9063d4ea648b636b04 Mon Sep 17 00:00:00 2001 From: Per Reedtz Thomsen Date: Wed, 26 Apr 2006 06:14:12 +0000 Subject: Added raidfile-config, bbstored-certs and bbstored-config. Also, hacked makefile to do the right thing. --- documentation/boxbackup/Makefile | 4 +- documentation/boxbackup/bbstored-certs.xml | 125 ++++++++++++++++++++++++ documentation/boxbackup/bbstored-config.xml | 140 +++++++++++++++++++++++++++ documentation/boxbackup/raidfile-config.xml | 143 ++++++++++++++++++++++++++++ 4 files changed, 410 insertions(+), 2 deletions(-) create mode 100644 documentation/boxbackup/bbstored-certs.xml create mode 100644 documentation/boxbackup/bbstored-config.xml create mode 100644 documentation/boxbackup/raidfile-config.xml diff --git a/documentation/boxbackup/Makefile b/documentation/boxbackup/Makefile index e1d65a7c..ea795710 100644 --- a/documentation/boxbackup/Makefile +++ b/documentation/boxbackup/Makefile @@ -36,9 +36,9 @@ $(HTMLPREFIX)/man-html/.there: man-pages/.there: if [ ! -d man-pages ]; then mkdir man-pages; touch man-pages/.there; fi -man-nroff: bbackupquery.1 bbackupctl.1 bbstoreaccounts.1 +man-nroff: bbackupquery.1 bbackupctl.1 bbstoreaccounts.1 bbstored-config.1 raidfile-config.1 bbstored-certs.1 -man-html: bbackupquery.html bbackupctl.html bbstoreaccounts.html +man-html: bbackupquery.html bbackupctl.html bbstoreaccounts.html bbstored-config.html raidfile-config.html bbstored-certs.html %.html: %.xml $(DBPROC) -o $@ $(NOCHUNKBOOKXSL) $< diff --git a/documentation/boxbackup/bbstored-certs.xml b/documentation/boxbackup/bbstored-certs.xml new file mode 100644 index 00000000..e7cb9316 --- /dev/null +++ b/documentation/boxbackup/bbstored-certs.xml @@ -0,0 +1,125 @@ + + + + bbstored-certs + + 1 + + + + bbstored-certs + + Manage certificates for the Box Backup system + + + + + bbstored-certs <certs-dir> <command> + [<arguments>] + + + + + Description + + bbstored-certs creates and signs certificates for + use in Box Backup. It allows the user to create and sign the server keys, + as well as signing client keys. + + All commands must be followed by the certs-dir, + which is the directory in which the certificates are stored. + + + Commands + + There are 3 commands: + + + + init: Create the + certs-dir, and generate the server keys for + bbstored. certs-dir cannot exist before running + the command. + + + + sign-server <servercsrfile>: Sign the + server certificate. The servercsrfile is the file + generated by the init command. + + + + sign <clientcsrfile>: Sign a client + certificate. The clientcsrfile is generated + during client setup. See bbackupd-config(1). Send + the signed certificate back to the client, and install according to + the instructions given by bbackupd-config. + + + + + + + Author + + Ben Summers and contributors. For help, please go to the Wiki, or subscribe to the Box + Backup mailing + list. + + + + See Also + + bbstored-config(1) + + bbstored.conf(5) + + bbstoreaccounts(1) + + + + Files + + raidfile-config generates the raidfile.conf(5) + file. + + + + Bugs + + If you find a bug in Box Backup, and you want to let us know about + it, join the mailing + list, and send a description of the problem there. + + To report a bug, give us at least the following information: + + + + The version of Box Backup you are running + + + + The platform you are running on (Hardware and OS), for both + client and server. + + + + If possible attach your config files (bbstored.conf, + bbackupd.conf) to the bug report. + + + + Also attach any log file output that helps shed light on the + problem you are seeing. + + + + And last but certainly not least, a description of what you are + seeing, in as much detail as possible. + + + + \ No newline at end of file diff --git a/documentation/boxbackup/bbstored-config.xml b/documentation/boxbackup/bbstored-config.xml new file mode 100644 index 00000000..56a4fe23 --- /dev/null +++ b/documentation/boxbackup/bbstored-config.xml @@ -0,0 +1,140 @@ + + + + bbstored-config + + 1 + + + + bbstored-config + + Create config files for bbstored + + + + + bbstored-config <configdir> <servername> + <username> + + + + + Description + + The bbstored-config script creates config files + and server certificates for a bbstored instance. It takes three + parameters: + + + + configdir: The directory where config files + will reside. A subdirectory bbstored will be created, where several + config files will reside. the bbstored.conf file + will be created in configdir. + + + + servername: The name of the server that is + being configured. Usually the fully qualified domain name of the + machine in question. + + + + username: The name of the user that should be + running the bbstored processes. Recommended name: + _bbstored. + + + + A valid raidfile.conf(5) must be found in configdir. Several steps + are taken during the run of bbstored-config: + + + + Configuration files are created. + + + + Server certificates are created. This requires interaction from + the operator. + + + + The raid volumes are checked, to ensure that the configuration + is consistent, and will work. + + + + Instructions for next steps to take are shown. These steps may + be different for different OS platforms, so pay close attention to + these instructions. + + + + + + Author + + Ben Summers and contributors. For help, please go to the Wiki, or subscribe to the Box + Backup mailing + list. + + + + See Also + + raidfile-config(1) + + bbstored.conf(5) + + raidfile.conf(5) + + + + Files + + bbstoreaccounts uses the Box Backup server + configuration file, usually located in + /etc/box/bbstored.conf. + + + + Bugs + + If you find a bug in Box Backup, and you want to let us know about + it, join the mailing + list, and send a description of the problem there. + + To report a bug, give us at least the following information: + + + + The version of Box Backup you are running + + + + The platform you are running on (Hardware and OS), for both + client and server. + + + + If possible attach your config files (bbstored.conf, + bbackupd.conf) to the bug report. + + + + Also attach any log file output that helps shed light on the + problem you are seeing. + + + + And last but certainly not least, a description of what you are + seeing, in as much detail as possible. + + + + \ No newline at end of file diff --git a/documentation/boxbackup/raidfile-config.xml b/documentation/boxbackup/raidfile-config.xml new file mode 100644 index 00000000..05163502 --- /dev/null +++ b/documentation/boxbackup/raidfile-config.xml @@ -0,0 +1,143 @@ + + + + raidfile-config + + 1 + + + + raidfile-config + + Configure Box Backup's RAID files + + + + + raidfile-config <configdir> <blocksize> + <dir1> [<dir2> <dir3>] + + + + + Description + + raidfile-config creates a raidfile.conf file for Box Backup. This + file holds information about the directories used to store backups in. Box + Backup supports userland RAID, in a restricted RAID5 configuration, where + 3 and only 3 'drives' are supported. You can read more about RAID5 (and + other RAID-levels) here. + + + + Parameters + + The parameters are as follows: + + + + configdir: The directory path where + configuration files are located. Usually this is + /etc/box. raidfile.conf will + be written in this directory. + + + + blocksize: The block size used for file + storage in the system, in bytes. Using a multple of the file system + block size is a good strategy. Depending on the size of the files + you will be backing up, this multiple varies. Of course it also + depends on the native block size of your file system. + + + + dir1: The first directory in the built-in + RAID array. + + + + dir2: The second directory in the built-in + RAID array. If you are not using the built-in RAID functionality, + this field should be ignored. You should not use the built-in RAID, + when you have a hardware RAID solution, or if you're using another + type of software RAID (like md on Linux). + + + + dir3: The third directory in the built-in + RAID array. The same notes that apply to dir2 + also apply to dir3. + + + + Note that there are currently no way to add multiple disk sets to + the raidfile.conf file using command line tools, etc. See + raidfile.conf(5) for details on adding more disks + + + + + Author + + Ben Summers and contributors. For help, please go to the Wiki, or subscribe to the Box + Backup mailing + list. + + + + See Also + + bbstored-config(1) + + bbstored.conf(5) + + raidfile.conf(5) + + + + Files + + raidfile-config generates the raidfile.conf(5) + file. + + + + Bugs + + If you find a bug in Box Backup, and you want to let us know about + it, join the mailing + list, and send a description of the problem there. + + To report a bug, give us at least the following information: + + + + The version of Box Backup you are running + + + + The platform you are running on (Hardware and OS), for both + client and server. + + + + If possible attach your config files (bbstored.conf, + bbackupd.conf) to the bug report. + + + + Also attach any log file output that helps shed light on the + problem you are seeing. + + + + And last but certainly not least, a description of what you are + seeing, in as much detail as possible. + + + + \ No newline at end of file -- cgit v1.2.3