diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 129 | ||||
| -rw-r--r-- | docs/api-notes/INDEX.txt (renamed from docs/backup/INDEX.txt) | 10 | ||||
| -rw-r--r-- | docs/api-notes/Win32_Clients.txt (renamed from docs/backup/Win32_Clients.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/backup_encryption.txt (renamed from docs/backup/backup_encryption.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/bin_bbackupd.txt (renamed from docs/backup/bin_bbackupd.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/bin_bbstored.txt (renamed from docs/backup/bin_bbstored.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common.txt (renamed from docs/common/lib_common.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common/BoxTime.txt (renamed from docs/common/lib_common/BoxTime.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common/CollectInBufferStream.txt (renamed from docs/common/lib_common/CollectInBufferStream.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common/Configuration.txt (renamed from docs/common/lib_common/Configuration.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common/Conversion.txt (renamed from docs/common/lib_common/Conversion.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common/ExcludeList.txt (renamed from docs/common/lib_common/ExcludeList.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common/FdGetLine.txt (renamed from docs/common/lib_common/FdGetLine.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common/Guards.txt (renamed from docs/common/lib_common/Guards.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common/IOStream.txt (renamed from docs/common/lib_common/IOStream.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common/IOStreamGetLine.txt (renamed from docs/common/lib_common/IOStreamGetLine.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common/MainHelper.txt (renamed from docs/common/lib_common/MainHelper.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common/WaitForEvent.txt (renamed from docs/common/lib_common/WaitForEvent.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_common/xStream.txt (renamed from docs/common/lib_common/xStream.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_compress.txt (renamed from docs/common/lib_compress.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_compress/CompressStream.txt (renamed from docs/common/lib_compress/CompressStream.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_crypto.txt (renamed from docs/common/lib_crypto.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_crypto/CipherContext.txt (renamed from docs/common/lib_crypto/CipherContext.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_crypto/RollingChecksum.txt (renamed from docs/common/lib_crypto/RollingChecksum.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_server.txt (renamed from docs/common/lib_server.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_server/Daemon.txt (renamed from docs/common/lib_server/Daemon.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_server/Protocol.txt (renamed from docs/common/lib_server/Protocol.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_server/ServerStream.txt (renamed from docs/common/lib_server/ServerStream.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_server/ServerTLS.txt (renamed from docs/common/lib_server/ServerTLS.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_server/SocketStream.txt (renamed from docs/common/lib_server/SocketStream.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_server/SocketStreamTLS.txt (renamed from docs/common/lib_server/SocketStreamTLS.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/lib_server/TLSContext.txt (renamed from docs/common/lib_server/TLSContext.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/common/memory_leaks.txt (renamed from docs/common/memory_leaks.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/encrypt_rsync.txt (renamed from docs/backup/encrypt_rsync.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/lib_backupclient.txt (renamed from docs/backup/lib_backupclient.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/lib_backupstore.txt (renamed from docs/backup/lib_backupstore.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/raidfile/RaidFileRead.txt (renamed from docs/raidfile/lib_raidfile/RaidFileRead.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/raidfile/RaidFileWrite.txt (renamed from docs/raidfile/lib_raidfile/RaidFileWrite.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/raidfile/lib_raidfile.txt (renamed from docs/raidfile/lib_raidfile.txt) | 0 | ||||
| -rw-r--r-- | docs/api-notes/win32_build_on_cygwin_using_mingw.txt | 107 | ||||
| -rw-r--r-- | docs/api-notes/win32_build_on_linux_using_mingw.txt | 108 | ||||
| -rw-r--r-- | docs/api-notes/windows_porting.txt (renamed from docs/backup/windows_porting.txt) | 0 | ||||
| -rw-r--r-- | docs/backup/win32_build_on_cygwin_using_mingw.txt | 53 | ||||
| -rw-r--r-- | docs/backup/win32_build_on_linux_using_mingw.txt | 64 | ||||
| -rw-r--r-- | docs/docbook/adminguide.xml | 1981 | ||||
| -rw-r--r-- | docs/docbook/bb-book.xsl | 17 | ||||
| -rw-r--r-- | docs/docbook/bb-man.xsl.tmpl | 9 | ||||
| -rw-r--r-- | docs/docbook/bb-nochunk-book.xsl | 17 | ||||
| -rw-r--r-- | docs/docbook/bbackupctl.xml | 205 | ||||
| -rw-r--r-- | docs/docbook/bbackupd-config.xml | 153 | ||||
| -rw-r--r-- | docs/docbook/bbackupd.conf.xml | 479 | ||||
| -rw-r--r-- | docs/docbook/bbackupd.xml | 209 | ||||
| -rw-r--r-- | docs/docbook/bbackupquery.xml | 506 | ||||
| -rw-r--r-- | docs/docbook/bbstoreaccounts.xml | 386 | ||||
| -rw-r--r-- | docs/docbook/bbstored-certs.xml | 180 | ||||
| -rw-r--r-- | docs/docbook/bbstored-config.xml | 148 | ||||
| -rw-r--r-- | docs/docbook/bbstored.conf.xml | 211 | ||||
| -rw-r--r-- | docs/docbook/bbstored.xml | 90 | ||||
| -rw-r--r-- | docs/docbook/html/bbdoc-man.css | 104 | ||||
| -rw-r--r-- | docs/docbook/html/bbdoc.css | 112 | ||||
| -rw-r--r-- | docs/docbook/html/favicon.ico | bin | 0 -> 67646 bytes | |||
| -rw-r--r-- | docs/docbook/html/images/arrow.png | bin | 0 -> 197 bytes | |||
| -rw-r--r-- | docs/docbook/html/images/bblogo.png | bin | 0 -> 5882 bytes | |||
| -rw-r--r-- | docs/docbook/html/images/stepahead.png | bin | 0 -> 298 bytes | |||
| -rw-r--r-- | docs/docbook/instguide.xml | 766 | ||||
| -rw-r--r-- | docs/docbook/raidfile-config.xml | 198 | ||||
| -rw-r--r-- | docs/docbook/raidfile.conf.xml | 143 | ||||
| -rw-r--r-- | docs/images/bblogo-alpha.xcf | bin | 0 -> 93980 bytes | |||
| -rw-r--r-- | docs/tools/generate_except_xml.pl | 74 |
69 files changed, 6337 insertions, 122 deletions
diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..f337fd86 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,129 @@ + + +# Process DocBook to HTML + +DBPROC=xsltproc + +DOCBOOK_DIR = docbook +HTML_DIR = htmlguide +MAN_DIR = man + +BOOKXSL = $(DOCBOOK_DIR)/bb-book.xsl +NOCHUNKBOOKXSL = $(DOCBOOK_DIR)/bb-nochunk-book.xsl +MANXSL = $(DOCBOOK_DIR)/bb-man.xsl + +VPATH = $(DOCBOOK_DIR) +.SUFFIXES: .html .xml .gz .1 .5 .8 + +all: docs + +docs: instguide adminguide manpages + @mkdir -p $(HTML_DIR)/images + @cp $(DOCBOOK_DIR)/html/images/*.png $(HTML_DIR)/images/. + @cp $(DOCBOOK_DIR)/html/*.css $(HTML_DIR)/. + @cp $(DOCBOOK_DIR)/html/*.ico $(HTML_DIR)/. + +adminguide: $(DOCBOOK_DIR)/ExceptionCodes.xml $(HTML_DIR)/adminguide/index.html + +# all sources ($>) is exactly the right args for xsltproc +$(HTML_DIR)/adminguide/index.html: $(BOOKXSL) $(DOCBOOK_DIR)/adminguide.xml + $(DBPROC) -o $(HTML_DIR)/adminguide/ $> + +instguide: $(HTML_DIR)/instguide/index.html + +$(HTML_DIR)/instguide/index.html: $(BOOKXSL) $(DOCBOOK_DIR)/instguide.xml + $(DBPROC) -o $(HTML_DIR)/instguide/ $> + +# $< is empty on BSD make when making this rule, $> has all sources +# $< has the target on GNU make, $> is empty +$(DOCBOOK_DIR)/ExceptionCodes.xml: ../ExceptionCodes.txt + perl tools/generate_except_xml.pl $< $> $@ + +manpages: man-dirs man-nroff man-html + +xslt: $(MANXSL) + +$(MANXSL): $(MANXSL).tmpl + @if [ -f /usr/local/share/xsl/docbook/manpages/docbook.xsl ]; then \ + DOCBOOK=file:///usr/local/share/xsl/docbook/manpages/docbook.xsl; \ + elif [ -f /opt/local/share/xsl/docbook-xsl/manpages/docbook.xsl ]; then \ + DOCBOOK=file:///opt/local/share/xsl/docbook-xsl/manpages/docbook.xsl; \ + elif [ -f /usr/share/sgml/docbook/xsl-stylesheets/manpages/docbook.xsl ]; then \ + DOCBOOK=file:///usr/share/sgml/docbook/xsl-stylesheets/manpages/docbook.xsl; \ + else \ + DOCBOOK=http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl; \ + fi; \ + sed -e "s,%%DOCBOOK%%,$${DOCBOOK}," $(MANXSL).tmpl > $(MANXSL) + +man-dirs: man/.there $(HTML_DIR)/man-html/.there + +$(HTML_DIR)/man-html/.there: + mkdir -p $(HTML_DIR)/man-html + touch $(HTML_DIR)/man-html/.there + +man/.there: + mkdir -p man + touch man/.there + +NROFF_PAGES = bbackupd.8 bbackupd-config.8 bbackupctl.8 bbackupquery.8 \ + bbstored.8 bbstored-config.8 bbstoreaccounts.8 bbstored-certs.8 \ + raidfile-config.8 \ + bbackupd.conf.5 bbstored.conf.5 raidfile.conf.5 + +NROFF_FILES = $(NROFF_PAGES:%=$(MAN_DIR)/%.gz) + +man-nroff: $(NROFF_FILES) + +HTML_FILES_1 = $(NROFF_PAGES:%.5=%.html) +HTML_FILES_2 = $(HTML_FILES_1:%.8=%.html) +HTML_FILES = $(HTML_FILES_2:%=$(HTML_DIR)/man-html/%) + +man-html: $(HTML_FILES) + +# GNU make +$(HTML_DIR)/man-html/%.html: $(DOCBOOK_DIR)/%.xml $(NOCHUNKBOOKXSL) + $(DBPROC) -o $@ $(NOCHUNKBOOKXSL) $< + +# Before running xsltproc to generate manual pages, we need to check +# that $(MANXSL) has been built. We don't want to add it to dependencies, +# because that would cause # the man pages to try to be rebuilt even if +# they already exist if the date of the xslt file changes, and that +# requires xsltproc, which negates the point of precompiling them for +# distribution users. + +# GNU make +$(MAN_DIR)/%.8.gz: $(DOCBOOK_DIR)/%.xml + $(MAKE) xslt + $(DBPROC) -o $(@:.gz=) $(MANXSL) $< + gzip $(@:.gz=) + +# GNU make +$(MAN_DIR)/%.5.gz: $(DOCBOOK_DIR)/%.xml + $(MAKE) xslt + $(DBPROC) -o $(@:.gz=) $(MANXSL) $< + gzip $(@:.gz=) + +# BSD make: the final colon (:) is required to make the .for and .endfor +# lines valid in GNU make. It creates (different) dummy rules in GNU and +# BSD make. Both dummy rules are harmless. + +.for MAN_PAGE in $(NROFF_PAGES) : +$(MAN_DIR)/$(MAN_PAGE).gz: $(DOCBOOK_DIR)/$(MAN_PAGE:R).xml + $(MAKE) xslt + $(DBPROC) -o $(.TARGET:.gz=) $(MANXSL) $> + gzip $(@:.gz=) + +$(HTML_DIR)/man-html/$(MAN_PAGE:R).html: $(DOCBOOK_DIR)/$(MAN_PAGE:R).xml + $(DBPROC) -o $@ $(NOCHUNKBOOKXSL) $> +.endfor : + +dockit: clean docs + tar zcf documentation-kit-0.10.tar.gz $(HTML_DIR)/ + +clean: + rm -f $(HTML_FILES) + rm -f $(NROFF_FILES) + rm -f $(DOCBOOK_DIR)/ExceptionCodes.xml + rm -f documentation-kit-0.10.tar.gz + rm -f $(MANXSL) + diff --git a/docs/backup/INDEX.txt b/docs/api-notes/INDEX.txt index 50406cac..f333ac3b 100644 --- a/docs/backup/INDEX.txt +++ b/docs/api-notes/INDEX.txt @@ -19,12 +19,12 @@ In this directory, the files correspond to modules or areas of interest. Sub dir SUBTITLE Suggested reading order -* lib_common -* lib_server -* bin_bbackupd +* common/lib_common.txt +* common/lib_server.txt +* bin_bbackupd.txt * backup_encryption.txt -* bin_bstored -* lib_raidfile +* bin_bbstored.txt +* raidfile/lib_raidfile.txt and refer to other sections as required. diff --git a/docs/backup/Win32_Clients.txt b/docs/api-notes/Win32_Clients.txt index fad6c4af..fad6c4af 100644 --- a/docs/backup/Win32_Clients.txt +++ b/docs/api-notes/Win32_Clients.txt diff --git a/docs/backup/backup_encryption.txt b/docs/api-notes/backup_encryption.txt index 36580581..36580581 100644 --- a/docs/backup/backup_encryption.txt +++ b/docs/api-notes/backup_encryption.txt diff --git a/docs/backup/bin_bbackupd.txt b/docs/api-notes/bin_bbackupd.txt index 67ad9267..67ad9267 100644 --- a/docs/backup/bin_bbackupd.txt +++ b/docs/api-notes/bin_bbackupd.txt diff --git a/docs/backup/bin_bbstored.txt b/docs/api-notes/bin_bbstored.txt index c9c4e229..c9c4e229 100644 --- a/docs/backup/bin_bbstored.txt +++ b/docs/api-notes/bin_bbstored.txt diff --git a/docs/common/lib_common.txt b/docs/api-notes/common/lib_common.txt index 11d7b02d..11d7b02d 100644 --- a/docs/common/lib_common.txt +++ b/docs/api-notes/common/lib_common.txt diff --git a/docs/common/lib_common/BoxTime.txt b/docs/api-notes/common/lib_common/BoxTime.txt index 18bef5a5..18bef5a5 100644 --- a/docs/common/lib_common/BoxTime.txt +++ b/docs/api-notes/common/lib_common/BoxTime.txt diff --git a/docs/common/lib_common/CollectInBufferStream.txt b/docs/api-notes/common/lib_common/CollectInBufferStream.txt index 5f9556a3..5f9556a3 100644 --- a/docs/common/lib_common/CollectInBufferStream.txt +++ b/docs/api-notes/common/lib_common/CollectInBufferStream.txt diff --git a/docs/common/lib_common/Configuration.txt b/docs/api-notes/common/lib_common/Configuration.txt index ef5f38f6..ef5f38f6 100644 --- a/docs/common/lib_common/Configuration.txt +++ b/docs/api-notes/common/lib_common/Configuration.txt diff --git a/docs/common/lib_common/Conversion.txt b/docs/api-notes/common/lib_common/Conversion.txt index 62d1967a..62d1967a 100644 --- a/docs/common/lib_common/Conversion.txt +++ b/docs/api-notes/common/lib_common/Conversion.txt diff --git a/docs/common/lib_common/ExcludeList.txt b/docs/api-notes/common/lib_common/ExcludeList.txt index 8a5bf36c..8a5bf36c 100644 --- a/docs/common/lib_common/ExcludeList.txt +++ b/docs/api-notes/common/lib_common/ExcludeList.txt diff --git a/docs/common/lib_common/FdGetLine.txt b/docs/api-notes/common/lib_common/FdGetLine.txt index d92ff94d..d92ff94d 100644 --- a/docs/common/lib_common/FdGetLine.txt +++ b/docs/api-notes/common/lib_common/FdGetLine.txt diff --git a/docs/common/lib_common/Guards.txt b/docs/api-notes/common/lib_common/Guards.txt index 6174fea6..6174fea6 100644 --- a/docs/common/lib_common/Guards.txt +++ b/docs/api-notes/common/lib_common/Guards.txt diff --git a/docs/common/lib_common/IOStream.txt b/docs/api-notes/common/lib_common/IOStream.txt index 09460656..09460656 100644 --- a/docs/common/lib_common/IOStream.txt +++ b/docs/api-notes/common/lib_common/IOStream.txt diff --git a/docs/common/lib_common/IOStreamGetLine.txt b/docs/api-notes/common/lib_common/IOStreamGetLine.txt index 04c56b57..04c56b57 100644 --- a/docs/common/lib_common/IOStreamGetLine.txt +++ b/docs/api-notes/common/lib_common/IOStreamGetLine.txt diff --git a/docs/common/lib_common/MainHelper.txt b/docs/api-notes/common/lib_common/MainHelper.txt index eb5b07f0..eb5b07f0 100644 --- a/docs/common/lib_common/MainHelper.txt +++ b/docs/api-notes/common/lib_common/MainHelper.txt diff --git a/docs/common/lib_common/WaitForEvent.txt b/docs/api-notes/common/lib_common/WaitForEvent.txt index 0bc55726..0bc55726 100644 --- a/docs/common/lib_common/WaitForEvent.txt +++ b/docs/api-notes/common/lib_common/WaitForEvent.txt diff --git a/docs/common/lib_common/xStream.txt b/docs/api-notes/common/lib_common/xStream.txt index 91e9c0ea..91e9c0ea 100644 --- a/docs/common/lib_common/xStream.txt +++ b/docs/api-notes/common/lib_common/xStream.txt diff --git a/docs/common/lib_compress.txt b/docs/api-notes/common/lib_compress.txt index f3e26f20..f3e26f20 100644 --- a/docs/common/lib_compress.txt +++ b/docs/api-notes/common/lib_compress.txt diff --git a/docs/common/lib_compress/CompressStream.txt b/docs/api-notes/common/lib_compress/CompressStream.txt index eca43eb6..eca43eb6 100644 --- a/docs/common/lib_compress/CompressStream.txt +++ b/docs/api-notes/common/lib_compress/CompressStream.txt diff --git a/docs/common/lib_crypto.txt b/docs/api-notes/common/lib_crypto.txt index 9ddafe69..9ddafe69 100644 --- a/docs/common/lib_crypto.txt +++ b/docs/api-notes/common/lib_crypto.txt diff --git a/docs/common/lib_crypto/CipherContext.txt b/docs/api-notes/common/lib_crypto/CipherContext.txt index 30fb4608..30fb4608 100644 --- a/docs/common/lib_crypto/CipherContext.txt +++ b/docs/api-notes/common/lib_crypto/CipherContext.txt diff --git a/docs/common/lib_crypto/RollingChecksum.txt b/docs/api-notes/common/lib_crypto/RollingChecksum.txt index d871b3f2..d871b3f2 100644 --- a/docs/common/lib_crypto/RollingChecksum.txt +++ b/docs/api-notes/common/lib_crypto/RollingChecksum.txt diff --git a/docs/common/lib_server.txt b/docs/api-notes/common/lib_server.txt index 392f331d..392f331d 100644 --- a/docs/common/lib_server.txt +++ b/docs/api-notes/common/lib_server.txt diff --git a/docs/common/lib_server/Daemon.txt b/docs/api-notes/common/lib_server/Daemon.txt index 6956ec2b..6956ec2b 100644 --- a/docs/common/lib_server/Daemon.txt +++ b/docs/api-notes/common/lib_server/Daemon.txt diff --git a/docs/common/lib_server/Protocol.txt b/docs/api-notes/common/lib_server/Protocol.txt index 09d3c1f1..09d3c1f1 100644 --- a/docs/common/lib_server/Protocol.txt +++ b/docs/api-notes/common/lib_server/Protocol.txt diff --git a/docs/common/lib_server/ServerStream.txt b/docs/api-notes/common/lib_server/ServerStream.txt index 6c5932a0..6c5932a0 100644 --- a/docs/common/lib_server/ServerStream.txt +++ b/docs/api-notes/common/lib_server/ServerStream.txt diff --git a/docs/common/lib_server/ServerTLS.txt b/docs/api-notes/common/lib_server/ServerTLS.txt index dbde500f..dbde500f 100644 --- a/docs/common/lib_server/ServerTLS.txt +++ b/docs/api-notes/common/lib_server/ServerTLS.txt diff --git a/docs/common/lib_server/SocketStream.txt b/docs/api-notes/common/lib_server/SocketStream.txt index 82813279..82813279 100644 --- a/docs/common/lib_server/SocketStream.txt +++ b/docs/api-notes/common/lib_server/SocketStream.txt diff --git a/docs/common/lib_server/SocketStreamTLS.txt b/docs/api-notes/common/lib_server/SocketStreamTLS.txt index ebb3f233..ebb3f233 100644 --- a/docs/common/lib_server/SocketStreamTLS.txt +++ b/docs/api-notes/common/lib_server/SocketStreamTLS.txt diff --git a/docs/common/lib_server/TLSContext.txt b/docs/api-notes/common/lib_server/TLSContext.txt index ff50d3e6..ff50d3e6 100644 --- a/docs/common/lib_server/TLSContext.txt +++ b/docs/api-notes/common/lib_server/TLSContext.txt diff --git a/docs/common/memory_leaks.txt b/docs/api-notes/common/memory_leaks.txt index 9a9764ea..9a9764ea 100644 --- a/docs/common/memory_leaks.txt +++ b/docs/api-notes/common/memory_leaks.txt diff --git a/docs/backup/encrypt_rsync.txt b/docs/api-notes/encrypt_rsync.txt index a5db2df2..a5db2df2 100644 --- a/docs/backup/encrypt_rsync.txt +++ b/docs/api-notes/encrypt_rsync.txt diff --git a/docs/backup/lib_backupclient.txt b/docs/api-notes/lib_backupclient.txt index 3e4a079b..3e4a079b 100644 --- a/docs/backup/lib_backupclient.txt +++ b/docs/api-notes/lib_backupclient.txt diff --git a/docs/backup/lib_backupstore.txt b/docs/api-notes/lib_backupstore.txt index 8f24eb7b..8f24eb7b 100644 --- a/docs/backup/lib_backupstore.txt +++ b/docs/api-notes/lib_backupstore.txt diff --git a/docs/raidfile/lib_raidfile/RaidFileRead.txt b/docs/api-notes/raidfile/RaidFileRead.txt index 0a5efbf7..0a5efbf7 100644 --- a/docs/raidfile/lib_raidfile/RaidFileRead.txt +++ b/docs/api-notes/raidfile/RaidFileRead.txt diff --git a/docs/raidfile/lib_raidfile/RaidFileWrite.txt b/docs/api-notes/raidfile/RaidFileWrite.txt index 89500c37..89500c37 100644 --- a/docs/raidfile/lib_raidfile/RaidFileWrite.txt +++ b/docs/api-notes/raidfile/RaidFileWrite.txt diff --git a/docs/raidfile/lib_raidfile.txt b/docs/api-notes/raidfile/lib_raidfile.txt index 0c4244ce..0c4244ce 100644 --- a/docs/raidfile/lib_raidfile.txt +++ b/docs/api-notes/raidfile/lib_raidfile.txt diff --git a/docs/api-notes/win32_build_on_cygwin_using_mingw.txt b/docs/api-notes/win32_build_on_cygwin_using_mingw.txt new file mode 100644 index 00000000..dccb6be0 --- /dev/null +++ b/docs/api-notes/win32_build_on_cygwin_using_mingw.txt @@ -0,0 +1,107 @@ +How to build Box Backup on Win32 using Cygwin and MinGW +By Chris Wilson, 2009-03-31 + +(To read this document online with better formatting, browse to: +[http://www.boxbackup.org/trac/wiki/CompileWithMinGW]) + +== MinGW C++ == + +Start by installing Cygwin on your Windows machine from [http://www.cygwin.org/cygwin/]. + +Make sure to select the following packages during installation: + + * Devel/automake + * Devel/autoconf + * Devel/gcc-mingw + * Devel/gcc-mingw-core + * Devel/gcc-mingw-g++ + * Devel/make + * Devel/mingw-runtime + * Lib/libxml2 + * Lib/libxslt + * Mingw/mingw-zlib + * Perl/Perl + +If you already have Cygwin installed, please re-run the installer and +ensure that those packages are installed. + +== Base Directory == + +Choose a directory where you will unpack and compile OpenSSL, Zlib and Box Backup. We will call this the ''base directory''. An example might be: + + C:\Cygwin\Home\Your Username + +Make sure you know the full path to this directory. + +== OpenSSL == + +Download OpenSSL from [http://www.openssl.org/source/openssl-0.9.7i.tar.gz] + +Open a Cygwin shell, go to the base directory, and unpack OpenSSL: + + tar xzvf openssl-0.9.7i.tar.gz + +Configure OpenSSL for MinGW compilation, and build and install it: + + cd openssl-0.9.7i + ./Configure --prefix=/usr/i686-pc-mingw32/ mingw + make + make install + +== PCRE == + +This step is only required to support regular expressions in including/excluding files from backups. However, this is a very useful feature. + +Download PCRE from +[http://prdownloads.sourceforge.net/pcre/pcre-6.3.tar.bz2?download] + +Open a Cygwin shell, go to the base directory, and unpack PCRE: + + tar xjvf pcre-6.3.tar.bz2 + +Configure PCRE for MinGW compilation, and build and install it: + + cd pcre-6.3 + export CFLAGS="-mno-cygwin" + ./configure + make winshared + cp .libs/libpcre.a .libs/libpcreposix.a /lib/mingw + cp pcreposix.h /usr/include/mingw + +== Download Box Backup == + +Go back to the base directory, and download the latest Box Backup sources: + + svn co https://www.boxbackup.org/svn/box/trunk/ trunk + +Note: If you have problems during the configure or make stage, please try to eliminate one potential source of problems by running the following command to convert all line endings to Unix format: + + find -type f -not \( -wholename .*svn*. \) -exec dos2unix {} \; + +== Compile Box Backup == + +Enter the source directory and configure like this: + + cd trunk + ./infrastructure/mingw/configure.sh + make + +== Installation == + +Create the destination directory, ''C:\Program Files\Box Backup\bbackupd''. + +Write a configuration file, keys and certificate on a Unix machine, and copy them into the ''Box Backup'' directory, together with the following files from the ''base directory'': + + * boxbackup\release\bin\bbackupd\bbackupd.exe + * boxbackup\release\bin\bbackupquery\bbackupquery.exe + * boxbackup\release\bin\bbackupctl\bbackupctl.exe + * openssl\out32dll\libeay32.dll + * openssl\out32dll\ssleay32.dll + * zlib\zlib1.dll + +Ensure that the user running Box Backup can read from the ''Box Backup'' directory, and write to the ''bbackupd'' directory inside it. + +Run Box Backup by double-clicking on it, and check that it connects to the server. If the window opens and closes immediately, it's probably due to a problem with the configuration file - check the Windows Event Viewer for details. + +See also the service installation and upgrade instructions at +[https://www.boxbackup.org/trac/wiki/CompilationOnWindows]. diff --git a/docs/api-notes/win32_build_on_linux_using_mingw.txt b/docs/api-notes/win32_build_on_linux_using_mingw.txt new file mode 100644 index 00000000..2c3e4fe9 --- /dev/null +++ b/docs/api-notes/win32_build_on_linux_using_mingw.txt @@ -0,0 +1,108 @@ +How to build Box Backup for Windows (Native) on Linux using MinGW +By Chris Wilson, 2005-12-07 + +Install the MinGW cross-compiler for Windows: + +- Debian and Ubuntu users can "apt-get install mingw32" +- Fedora and SuSE users can download RPM packages from + [http://mirzam.it.vu.nl/mingw/] + +You will need to know the prefix used by the cross-compiler executables. +It will usually be something like "ix86-mingw32*-". All the binaries in the +cross-compiler package will start with this prefix. The documentation below +assumes that it is "i386-mingw32-". Adjust to taste. + +You will also need to install Wine and the Linux kernel "binary formats" +(binfmt) support, so that you can run Windows executables on Linux, +otherwise the configure scripts will not work properly with a cross-compiler. +On Ubuntu, run: + + apt-get install wine binfmt-support + /etc/init.d/binfmt-support start + +Start by downloading Zlib from [http://www.zlib.net/], unpack and enter +source directory: + + export CC=i386-mingw32-gcc + export AR="i386-mingw32-ar rc" + export RANLIB="i386-mingw32-ranlib" + ./configure + make + make install prefix=/usr/local/i386-mingw32 + +Download OpenSSL 0.9.8b from +[http://www.openssl.org/source/openssl-0.9.8b.tar.gz] + +Unpack and configure: + + tar xzvf openssl-0.9.8b.tar.gz + cd openssl-0.9.8b + ./Configure --prefix=/usr/local/i386-mingw32 mingw + make makefile.one + wget http://www.boxbackup.org/svn/box/chris/win32/support/openssl-0.9.8b-mingw-cross.patch + patch -p1 < openssl-0.9.8b-mingw-cross.patch + make -f makefile.one + make -f makefile.one install + +Download PCRE from +[http://prdownloads.sourceforge.net/pcre/pcre-6.3.tar.bz2?download] + +Unpack: + + tar xjvf pcre-6.3.tar.bz2 + cd pcre-6.3 + +Configure and make: + + export AR=i386-mingw32-ar + ./configure --host=i386-mingw32 --prefix=/usr/local/i386-mingw32/ + make winshared + +If you get this error: + + ./dftables.exe pcre_chartables.c + /bin/bash: ./dftables.exe: cannot execute binary file + make: *** [pcre_chartables.c] Error 126 + +then run: + + wine ./dftables.exe pcre_chartables.c + make winshared + +to complete the build. Finally: + + cp .libs/libpcre.a /usr/local/i386-pc-mingw32/lib + cp .libs/libpcreposix.a /usr/local/i386-pc-mingw32/lib + cp pcreposix.h /usr/local/i386-pc-mingw32/include + +You will need to find a copy of mingwm10.dll that matches your cross-compiler. +Most MinGW distributions should come with it. On Debian and Ubuntu, for some +bizarre reason, you'll find it compressed as +/usr/share/doc/mingw32-runtime/mingwm10.dll.gz, in which case you'll +have to un-gzip it with "gzip -d". Copy it to a known location, e.g. +/usr/local/i386-mingw32/bin. + +Download and extract Box Backup, and change into the base directory, +e.g. boxbackup-0.11rc2. Change the path to mingwm10.dll in parcels.txt to +match where you found or installed it. + +Now configure Box with: + + ./configure --host=i386-mingw32 \ + CXXFLAGS="-mthreads -I/usr/local/i386-mingw32/include" \ + LDFLAGS=" -mthreads -L/usr/local/i386-mingw32/lib" \ + LIBS="-lcrypto -lws2_32 -lgdi32" + make + +or, if that fails, try this: + + export CXX="i386-mingw32-g++" + export AR=i386-mingw32-ar + export RANLIB=i386-mingw32-ranlib + export CFLAGS="-mthreads" + export CXXFLAGS="-mthreads" + export LDFLAGS="-mthreads" + export LIBS="-lcrypto -lws2_32 -lgdi32" + (if you don't have a "configure" file, run "./bootstrap") + ./configure --target=i386-mingw32 + make CXX="$CXX" AR="$AR" RANLIB="$RANLIB" WINDRES="i386-mingw32-windres" diff --git a/docs/backup/windows_porting.txt b/docs/api-notes/windows_porting.txt index ada3b857..ada3b857 100644 --- a/docs/backup/windows_porting.txt +++ b/docs/api-notes/windows_porting.txt diff --git a/docs/backup/win32_build_on_cygwin_using_mingw.txt b/docs/backup/win32_build_on_cygwin_using_mingw.txt deleted file mode 100644 index e71b5764..00000000 --- a/docs/backup/win32_build_on_cygwin_using_mingw.txt +++ /dev/null @@ -1,53 +0,0 @@ -How to build Box Backup on Win32 using Cygwin and MinGW -By Chris Wilson, 2007-05-26 - -(To read this document online with better formatting, browse to: -http://bbdev.fluffy.co.uk/trac/wiki/CompileWithMinGW) - -Start by installing Cygwin on your Windows machine [http://www.cygwin.org]. -Make sure to select the following packages during installation: - -* Devel/gcc-mingw -* Devel/gcc-mingw-core -* Devel/gcc-mingw-g++ -* Mingw/mingw-zlib - -If you already have Cygwin installed, please re-run the installer and -ensure that those packages are installed. - -Download OpenSSL from -[http://www.openssl.org/source/openssl-0.9.7i.tar.gz] - -Open a Cygwin shell, and unpack OpenSSL: - - tar xzvf openssl-0.9.7i.tar.gz - -Configure OpenSSL for MinGW compilation, and build and install it: - - cd openssl-0.9.7i - ./Configure --prefix=/usr/i686-pc-mingw32/ mingw - make - make install - -Download PCRE from -[http://prdownloads.sourceforge.net/pcre/pcre-6.3.tar.bz2?download] - -Open a Cygwin shell, and unpack PCRE: - - tar xjvf pcre-6.3.tar.bz2 - -Configure PCRE for MinGW compilation, and build and install it: - - cd pcre-6.3 - export CFLAGS="-mno-cygwin" - ./configure - make winshared - cp .libs/libpcre.a .libs/libpcreposix.a /usr/lib/mingw - cp pcreposix.h /usr/include/mingw - -Now unpack the Box Backup sources, enter the source directory, -and configure like this: - - ./infrastructure/mingw/configure.sh - make - diff --git a/docs/backup/win32_build_on_linux_using_mingw.txt b/docs/backup/win32_build_on_linux_using_mingw.txt deleted file mode 100644 index 407096b1..00000000 --- a/docs/backup/win32_build_on_linux_using_mingw.txt +++ /dev/null @@ -1,64 +0,0 @@ -How to build Box Backup for Windows (Native) on Linux using MinGW -By Chris Wilson, 2005-12-07 - -Install the MinGW cross-compiler for Windows: - -- Debian users can "apt-get install mingw32" -- Fedora and SuSE users can download RPM packages from - [http://mirzam.it.vu.nl/mingw/] - -You will need to know the prefix used by the cross-compiler executables. -It will usually be something like "ix86-mingw32*-". All the binaries in the -cross-compiler package will start with this prefix. The documentation below -assumes that it is "i386-mingw32-". Adjust to taste. - -Download Zlib from [http://www.zlib.net/], unpack and enter source directory: - - export CC=i386-mingw32-gcc - export AR="i386-mingw32-ar rc" - export RANLIB="i386-mingw32-ranlib" - ./configure - make - make install prefix=/usr/local/i386-mingw32 - -Download OpenSSL 0.9.8b from -[http://www.openssl.org/source/openssl-0.9.8b.tar.gz] - -Unpack and configure: - - tar xzvf openssl-0.9.8b.tar.gz - cd openssl-0.9.8b - ./Configure --prefix=/usr/local/i386-mingw32 mingw - make makefile.one - wget http://bbdev.fluffy.co.uk/svn/box/chris/win32/support/openssl-0.9.8b-mingw-cross.patch - patch -p1 < openssl-0.9.8b-mingw-cross.patch - make -f makefile.one - make -f makefile.one install - -Download PCRE from -[http://prdownloads.sourceforge.net/pcre/pcre-6.3.tar.bz2?download] - -Unpack: - - tar xjvf pcre-6.3.tar.bz2 - cd pcre-6.3 - -Configure and make: - - ./configure --host=i586-mingw32msvc --prefix=/usr/i386-mingw32/ - make winshared wininstall - cp .libs/libpcreposix.a /usr/i386-pc-mingw32/lib - cp pcreposix.h /usr/i386-pc-mingw32/include/regex.h - -Configure Box with: - - export CXX="i386-mingw32-g++" - export AR=i386-mingw32-ar - export RANLIB=i386-mingw32-ranlib - export CFLAGS="-mthreads" - export CXXFLAGS="-mthreads" - export LDFLAGS="-mthreads" - export LIBS="-lcrypto -lws2_32 -lgdi32" - (if you don't have a "configure" file, run "./bootstrap") - ./configure --target=i386-mingw32 - make CXX="$CXX" AR="$AR" RANLIB="$RANLIB" WINDRES="i386-mingw32-windres" diff --git a/docs/docbook/adminguide.xml b/docs/docbook/adminguide.xml new file mode 100644 index 00000000..edb0a58c --- /dev/null +++ b/docs/docbook/adminguide.xml @@ -0,0 +1,1981 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ +<!ENTITY __ExceptionCodes__elfjz3fu SYSTEM "ExceptionCodes.xml"> +]> +<book> + <title>Box Backup administrator's guide</title> + + <preface> + <title>License</title> + + <para>Copyright © 2003 - 2007, Ben Summers and contributors. All rights + reserved.</para> + + <para>Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are + met:</para> + + <itemizedlist> + <listitem> + <para>Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer.</para> + </listitem> + + <listitem> + <para>Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following disclaimer + in the documentation and/or other materials provided with the + distribution.</para> + </listitem> + + <listitem> + <para>All use of this software and associated advertising materials + must display the following acknowledgement: This product includes + software developed by Ben Summers and contributors.</para> + </listitem> + + <listitem> + <para>The names of the Authors may not be used to endorse or promote + products derived from this software without specific prior written + permission.</para> + </listitem> + </itemizedlist> + + <para>[Where legally impermissible the Authors do not disclaim liability + for direct physical injury or death caused solely by defects in the + software unless it is modified by a third party.]</para> + + <para>THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR + IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN + NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED + TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</para> + </preface> + + <chapter> + <title>Configuration</title> + + <section> + <title>System configuration</title> + + <section> + <title>Server</title> + + <para>After you've downloaded and compiled the programs you need to + install the programs on your server. As root do the following:</para> + + <programlisting>make install-backup-server</programlisting> + + <para>This assumes that you are installing on the same server that you + compiled the software on. If not, copy the + boxbackup-x.xx-backup-server-OSNAME.tgz file to the server you want to + run on, and install there. For example (on Mac OS X):</para> + + <programlisting>tar zxvf boxbackup-0.10-server-darwin8.5.0.tgz +cd boxbackup-0.10-server-darwin8.5.0 +./install-backup-server</programlisting> + + <para>Then create the user for the backup daemon on the server:</para> + + <programlisting>useradd _bbstored</programlisting> + + <para>Box Backup has a built-in software RAID facility (redundant + array of inexpensive disks) for the backup store. This allows you to + spread the store data over three disks, and recover from the loss of + any one disk without losing data. However, this is now deprecated, and + you are recommended to use the software or hardware RAID facilities of + your operating system instead. Use the following command if you want + to create a simple server without Box Backup RAID:</para> + + <programlisting>mkdir /tmp/boxbackupRepository # Create the directory +chown _bbstored /tmp/boxbackupRepository/ # Change the owner to the new boxbackup daemon user + +/usr/local/sbin/raidfile-config /etc/box/ 1024 /tmp/boxbackupRepository + +#substitute 1024 with the desired blocksize +#substitute /tmp/boxbackupRepository with a directory that exists where you want the backup store located +#/usr/local/sbin/raidfile-config --help shows you the options</programlisting> + + <para>Then create the configuration file /etc/box/bbstored.conf The + hostname is tricky as it is used for two things: The name of the + server in the certificate and the address the server is listening on. + Since you might be using NAT, might move the server around or the + domain name might change, choose a name that describes the server. + When the network address of the server changes, you need to update the + <literal>ListenAddresses</literal> directive in the + <filename>/etc/box/bbstored.conf</filename> file.</para> + + <programlisting>/usr/local/sbin/bbstored-config /etc/box hostname _bbstored</programlisting> + + <para>This last step outputs 5 instructions that you must execute to + the letter. A lot of questions are raised on the mailing list because + these steps have not been followed properly.</para> + + <para>TODO: Expand on this. Explain the 5 steps in detail.</para> + + <para>If you want to run the server as a non-root user, look <link + linkend="WORoot">here</link>.</para> + </section> + + <section> + <title>Certificate Management</title> + + <para>There are two steps involved to create an account. You need to + create the account on the server, and sign a certificate to give the + client permission to connect to the server.</para> + + <para>Running a Certification Authority for TLS (SSL) connections is + not trivial. However, a script to does most of the work in a way which + should be good enough for most deployments.</para> + + <important> + <para>The certificate authority directory is intended to be stored + on another server. It should not be kept on the backup server, in + order to limit the impact of a server compromise. The instructions + and the script assume that it will be kept elsewhere, so will ask + you to copy files to and from the CA.</para> + </important> + + <warning> + <para>SSL certificates contain validity dates, including a "valid + from" time. If the clock on the machine which signs the certificates + is not syncronised to the clocks of the machines using these + certificates, you will probably get strange errors until the start + time is reached on all machines. If you get strange errors when + attempting to use new certificates, check the clocks on all machines + (client, store and CA). You will probably just need to wait a while + until the certificates become valid, rather than having to + regenerate them.</para> + </warning> + + <section> + <title>Set up a Certificate Authority</title> + + <para>It is recommended that you keep your Certificate Authority on + a separate machine than either the client or the server, preferably + without direct network access. The contents of this directory + control who can access your backup store server.</para> + + <para>To setup the basic key structure, do the following:</para> + + <programlisting>/usr/local/sbin/bbstored-certs ca init</programlisting> + + <para>(See <ulink url="instguide.xml">OpenSSL notes</ulink> if you + get an OpenSSL error)</para> + + <para>This creates the directory called <filename>ca</filename> in + the current directory, and initialises it with basic keys.</para> + </section> + + <section> + <title>Sign a server certificate</title> + + <para>When you use the <command>bbstored-config</command> script to + set up a config file for a server, it will generate a certificate + request (CSR) for you. Transfer it to the machine with your CA, then + do:</para> + + <programlisting>/usr/local/sbin/bbstored-certs ca sign-server hostname-csr.pem</programlisting> + + <para>This signs the certificate for the server. Follow the + instructions in the output on which files to install on the server. + The CSR file is now no longer needed. Make sure you run this command + from the directory above the directory 'ca'.</para> + + <para>TODO: Explain instructions in output.</para> + </section> + + <section> + <title>Set up an account</title> + + <para>Choose an account number for the user. This must be unique on + the server, and is presented as a 31 bit number in hex greater than + 0, for example, 1 or 75AB23C. Then on the backup store server, + create the account with:</para> + + <programlisting>/usr/local/sbin/bbstoreaccounts create 75AB23C 0 4096M 4505M</programlisting> + + <para>This looks complicated. The numbers are, in order:</para> + + <itemizedlist> + <listitem> + <para>The account number allocated (hex)</para> + </listitem> + + <listitem> + <para>The RAID disc set (0 if you use raidfile-config and don't + add a new set)</para> + </listitem> + + <listitem> + <para>Soft limit (size)</para> + </listitem> + + <listitem> + <para>Hard limit (size)</para> + </listitem> + </itemizedlist> + + <para>The sizes are are specified in Mb, Gb, or blocks, depending on + the suffix. 1M specifies 1 Mb, 1G specifies 1 Gb, and 1B specifies 1 + block, the size of which depends on how you have configured the + raidfile system with raidfile-config.</para> + + <para>In this example, I have allocated 4Gb (assuming you use 2048 + byte blocks as per my example) as the soft limit, and 4Gb + 10% as + the hard limit.</para> + + <para>NOTE The sizes specified here are pre-RAID. So if you are + using userland RAID, you are actually allocating two-thirds of this + amount. This means that, when you take compression into account, + that if you allocate 2Gb on the server, it'll probably hold about + 2Gb of backed up files (depending on the compressability of those + files).</para> + + <para>The backup client will (voluntarily) try not to upload more + data than is allowed by the soft limit. The store server will refuse + to accept a file if it would take it over the hard limit, and when + doing housekeeping for this account, try and delete old versions and + deleted files to reduce the space taken to below the soft + limit.</para> + + <para>This command will create some files on disc in the raid file + directories (if you run as root, the utility will change to the user + specified in the bbstored.conf file to write them) and update the + accounts file. A server restart is not required.</para> + + <para>NOTE If you get a message saying 'Exception: RaidFile (2/8)', + the directories you specified in the raidfile.conf are not writable + by the _bbstored user -- fix it, and try again.</para> + + <para>Finally, tell the user their account number, and the hostname + of your server. They will use this to set up the backup client, and + send you a CSR. This has the account number embedded in it, and you + should be sure that it has the right account number in it.</para> + + <para>Sign this CSR with this command:</para> + + <programlisting>/usr/local/sbin/bbstored-certs ca sign 75AB23C-csr.pem</programlisting> + + <para>Don't forget to check that the embedded account number is + correct! Then send the two files back to the user, as instructed by + the script.</para> + + <para>Please read the Troubleshooting page if you have + problems.</para> + + <para>TODO: Link to troubleshooting...</para> + </section> + </section> + + <section> + <title>Log Files</title> + + <para>You may wish to see what's going on with the server. Edit + /etc/syslog.conf, and add:</para> + + <programlisting>local6.info /var/log/box +local5.info /var/log/raidfile</programlisting> + + <para><emphasis role="bold">Note:</emphasis> Separators must be tabs, + otherwise these entries will be ignored.</para> + + <programlisting>touch /var/log/box +touch /var/log/raidfile</programlisting> + + <para>Set up log rotation for these new log files. For example, if you + have <filename>/etc/newsyslog.conf</filename>, add the following lines + to it:</para> + + <programlisting>/var/log/box 644 7 2000 * Z +/var/log/raidfile 644 7 2000 * Z</programlisting> + + <para>If you have <filename>/etc/logrotate.d</filename>, create a new + file in there (for example + <filename>/etc/logrotate.d/boxbackup</filename>) containing the + following:</para> + + <programlisting>/var/log/box /var/log/raidfile { + weekly + create + compress + rotate 52 +}</programlisting> + + <para>Then restart syslogd, for example:</para> + + <programlisting>/etc/init.d/syslogd restart</programlisting> + </section> + + <section> + <title>Configuring a client</title> + + <para>Before you can do any configuration, you need to know the + hostname of the server you will be using, and your account number on + that server.</para> + + <para>Later in the process, you will need to send a certificate + request to the administrator of that server for it to be + signed.</para> + + <para>Installation is covered in the compiling and installing section. + You only need the backup-client parcel.</para> + + <para>It is important that you read all the output of the config + scripts. See the end of this page for an example.</para> + + <para>The backup client has to be run as root, because it needs to + read all your files to back them up, although it is possible to back + up a single user's files by running it as that user. (Tip: specify a + directory other than <filename>/etc/box</filename>, and then give the + alternate config file as the first argument to + <command>bbackupd</command>). However, it will fall over if you don't + give yourself read access to one of your files.</para> + + <section> + <title id="BasicConfig">Basic configuration</title> + + <para>Run the <command>bbackupd-config</command> script to generate + the configuration files and generate a private key and certificate + request.</para> + + <programlisting>/usr/local/sbin/bbackupd-config /etc/box lazy <emphasis + role="bold">999 hostname</emphasis> /var/bbackupd <emphasis + role="bold">/home</emphasis></programlisting> + + <para>(See <ulink url="instguide.xml">OpenSSL notes</ulink> if you + get an OpenSSL error)</para> + + <para>The items in bold need to be changed. In order, they are the + account number, the hostname of the server you're using, and + finally, the directories you want backed up. You can include as many + you want here.</para> + + <para>However, the directories you specify must not contain other + mounted file systems within them at any depth. Specify them + separately, one per mount point. No checks are currently made to + catch bad configuration of this nature!</para> + + <para>You may also want to consider changing the mode from lazy to + snapshot, depending on what your system is used for:</para> + + <glosslist> + <glossentry> + <glossterm>Lazy Mode</glossterm> + + <glossdef> + <para>This mode regularly scans the files, with only a rough + schedule. It uploads files as and when they are changed, if + the latest version is more than a set age. This is good for + backing up user's documents stored on a server, and spreads + the load out over the day.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>Snapshot Mode</glossterm> + + <glossdef> + <para>This mode emulates the traditional backup behaviour of + taking a snapshot of the filesystem. The backup daemon does + absolutely nothing until it is instructed to make a backup + using the bbackupctl utility (probably as a cron job), at + which point it uploads all files which have been changed since + the last time it uploaded.</para> + </glossdef> + </glossentry> + </glosslist> + + <para>When you run the config script, it will tell you what you need + to do next. Don't forget to read all the output. An example is shown + at the end of this page, but the instructions for your installation + may be different.</para> + </section> + + <section> + <title>Certificates</title> + + <para>After you have sent your certificate request off to the server + administrator and received your certificate and CA root back, + install them where instructed by the bbackupd-config script during + basic bbackupd configuration.</para> + + <para>You can then run the daemon (as root) by running + <command>/usr/local/sbin/bbackupd</command>, and of course, adding it + to your system's startup scripts. The first time it's run it will + upload everything. Interrupting it and restarting it will only + upload files which were not uploaded before - it's very + tolerant.</para> + + <para>If you run in snapshot mode, you will need to add a cron job + to schedule backups. The config script will tell you the exact + command to use for your system.</para> + + <para>Please read the Troubleshooting page if you have + problems.</para> + + <para>Remember to make a traditional backup of the keys file, as + instructed. You cannot restore files without it.</para> + + <para>It is recommended that you backup up all of /etc/box as it + will make things easier if you need to restore files. But only the + keys are absolutely essential.</para> + + <para>If you want to see what it's doing in more detail (probably a + good idea), follow the instructions in the server setup to create + new log files with syslog. </para> + </section> + + <section> + <title>Adding and removing backed up locations</title> + + <para>By editing the /etc/box/bbackupd.conf file, you can add and + remove directories to back up - see comments in this file for help. + Send bbackupd a HUP signal after you modify it.</para> + + <para>When you remove a location, it will not be marked as deleted + immediately. Instead, bbackupd waits about two days before doing so, + just in case you change your mind. After this, it will be eventually + removed from the store by the housekeeping process. Run as + root.</para> + + <para>The backup client is designed to be run as root. It is + possible to run without root, but this is not recommended. Clock + synchronisation for file servers.</para> + + <para>If you are using the backup client to backup a filesystem + served from a fileserver, you should ideally ensure that the + fileserver clocks are synchronised with the fileserver.</para> + + <para>bbackupd will cope perfectly well if the clocks are not + synchronised. Errors up to about half an hour cause no problems. + Larger discrepancies cause a loss of efficiency and the potential to + back up a file during a write process.</para> + + <para>There is a configuration parameter MaxFileTimeInFuture, which + specifies how far in the future a file must be for it to be uploaded + as soon as it is seen. You should not need to adjust this (default + is 2 days). Instead, get those clocks synchronised. Excluding files + and directories from the backup.</para> + + <para>Within the bbackupd.conf file, there is a section named + BackupLocations which specifies which locations on disc should be + backed up. It has subsections, each of which is in the + format:</para> + + <programlisting> name + { + Path = /path/of/directory + (optional exclude directives) + }</programlisting> + + <para><emphasis role="bold">name</emphasis> is derived from the Path + by the config script, but should merely be unique.</para> + + <para>The exclude directives are of the form:</para> + + <programlisting>[Exclude|AlwaysInclude][File|Dir][|sRegex] = regex or full pathname</programlisting> + + <para>(The regex suffix is shown as 'sRegex' to make File or Dir + plural)</para> + + <para>For example:</para> + + <programlisting> ExcludeDir = /home/guest-user + ExcludeFilesRegex = *.(mp3|MP3)\$ + AlwaysIncludeFile = /home/username/veryimportant.mp3</programlisting> + + <para>This excludes the directory /home/guest-user from the backup + along with all mp3 files, except one MP3 file in particular.</para> + + <para>In general, Exclude excludes a file or directory, unless the + directory is explicitly mentioned in a AlwaysInclude + directive.</para> + + <para>If a directive ends in Regex, then it is a regular expression + rather than a explicit full pathname. See</para> + + <programlisting> man 7 re_format</programlisting> + + <para>for the regex syntax on your platform.</para> + </section> + + <section> + <title>Example configuration output</title> + + <para>This is an example of output from the bbstored-config + script.</para> + + <important> + <para>Follow the instructions output by your script, not the ones + here -- they may be different for your system.</para> + </important> + + <programlisting>/usr/local/sbin/bbackupd-config /etc/box lazy 51 server.example.com /var/bbackupd /home /etc/samba + +Setup bbackupd config utility. + +Configuration: + Writing configuration file: /etc/box/bbackupd.conf + Account: 51 + Server hostname: server.example.com + Directories to back up: + /home + /etc/samba + +Note: If other file systems are mounted inside these directories, then problems may occur +with files on the store server being renamed incorrectly. This will cause efficiency +problems, but not affect the integrity of the backups. + +WARNING: Directories not checked against mountpoints. Check mounted filesystems manually. + +Creating /etc/box... +Creating /etc/box/bbackupd +Generating private key... + [OpenSSL output omitted] + +Generating keys for file backup +Writing notify script /etc/box/bbackupd/NotifyStoreFull.sh +Writing configuration file /etc/box/bbackupd.conf + +=================================================================== + +bbackupd basic configuration complete. + +What you need to do now... + +1) Make a backup of /etc/box/bbackupd/51-FileEncKeys.raw + This should be a secure offsite backup. + Without it, you cannot restore backups. Everything else can + be replaced. But this cannot. + KEEP IT IN A SAFE PLACE, OTHERWISE YOUR BACKUPS ARE USELESS. + +2) Send /etc/box/bbackupd/51-csr.pem + to the administrator of the backup server, and ask for it to + be signed. + +3) The administrator will send you two files. Install them as + /etc/box/bbackupd/51-cert.pem + /etc/box/bbackupd/serverCA.pem + after checking their authenticity. + +4) You may wish to read the configuration file + /etc/box/bbackupd.conf + and adjust as appropraite. + + There are some notes in it on excluding files you do not + wish to be backed up. + +5) Review the script + /etc/box/bbackupd/NotifyStoreFull.sh + and check that it will email the right person when the store + becomes full. This is important -- when the store is full, no + more files will be backed up. You want to know about this. + +6) Start the backup daemon with the command + /usr/local/sbin/bbackupd + in /etc/rc.local, or your local equivalent. + Note that bbackupd must run as root. + +===================================================================</programlisting> + + <para>Remember to make a secure, offsite backup of your backup keys, + as described in <link linkend="BasicConfig">Basic + configuration</link> above. If you do not, and that key is lost, you + have no backups.</para> + </section> + </section> + + <section> + <title>Configuration Options</title> + + <para>Box Backup has many options in its configuration file. We will + try to list them all here.</para> + + <para>First of all, here is an example configuration file, for + reference:</para> + + <example> + <title>Example Configuration File</title> + + <programlisting>StoreHostname = localhost +AccountNumber = 0x2 + +KeysFile = /etc/box/2-FileEncKeys.raw +CertificateFile = /etc/box/2-cert.pem +PrivateKeyFile = /etc/box/2-key.pem +TrustedCAsFile = /etc/box/serverCA.pem +DataDirectory = /var/run/boxbackup +NotifyScript = /etc/box/NotifySysadmin.sh +CommandSocket = /var/run/box/bbackupd.sock + +UpdateStoreInterval = 86400 +MinimumFileAge = 3600 +MaxUploadWait = 7200 +FileTrackingSizeThreshold = 65536 +DiffingUploadSizeThreshold = 65536 +MaximumDiffingTime = 20 +ExtendedLogging = no +LogAllFileAccess = yes + +Server +{ + PidFile = /var/run/bbackupd.pid +} +BackupLocations +{ + etc + { + Path = /etc + } + home + { + Path = /home + ExcludeDir = /home/shared + ExcludeDir = /home/chris/.ccache + ExcludeDir = /home/chris/.mozilla/firefox/vvvkq3vp.default/Cache + } +}</programlisting> + </example> + + <para>As you can see from the example above, the configuration file + has a number of subsections, enclosed in curly braces {}. Some options + appear outside of any subsection, and we will refer to these as <link + linkend="RootOptions">root options</link>. The available options in + each section are described below.</para> + + <para>Every option has the form <quote>name = value</quote>. Names are + not case-sensitive, but values are. Depending on the option, the value + may be:</para> + + <itemizedlist> + <listitem> + <para>a path (to a file or directory);</para> + </listitem> + + <listitem> + <para>a number (usually in seconds or bytes);</para> + </listitem> + + <listitem> + <para>a boolean (the word Yes or No);</para> + </listitem> + + <listitem> + <para>a hostname (or IP address).</para> + </listitem> + </itemizedlist> + + <para>Paths are specified in native format, i.e. a full Windows path + with drive letter on Windows clients, or a full Unix path on Unix + clients.</para> + + <para><example> + <title>Example:</title> + + <para>StoreObjectInfoFile = + /var/state/boxbackup/bbackupd.dat</para> + + <para>StoreObjectInfoFile = C:\Program Files\Box + Backup\data\bbackupd.dat</para> + </example>The use of relative paths (which do not start with a + forward slash on Unix, or a drive specification on Windows) is + possible but not recommended, since they are interpreted relative to + the current working directory when bbackupd was started, which is + liable to change unexpectedly over time.</para> + + <para>Numbers which start with "0x" are interpreted as hexadecimal. + Numbers which do not start with "0x" are interpreted as + decimal.</para> + + <section> + <title id="RootOptions">Root Options</title> + + <para>These options appear outside of any subsection. By convention + they are at the beginning of the configuration file.</para> + + <para>Some options are required, and some are optional.</para> + + <glosslist> + <glossentry> + <glossterm>StoreHostname (required)</glossterm> + + <glossdef> + <para>The Internet host name (DNS name) or IP address of the + server. This is only used to connect to the server.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>AccountNumber (required)</glossterm> + + <glossdef> + <para>The number of the client's account on the server. This + must be provided by the server operator, and must match the + account number in the client's certificate, otherwise the + client will not be able to log into the server.</para> + + <para>The account number may be specified in hexadecimal + (starting with 0x, as in the example above) or in decimal, but + since the server operator works in hexadecimal, that format is + highly recommended and is the default.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>KeysFile (required)</glossterm> + + <glossdef> + <para>The path to the file containing the encryption key used + for data encryption of client file data and filenames. This is + the most important file to keep safe, since without it your + backups cannot be decrypted and are useless. Likewise, if an + attacker gets access to this key and to your encrypted + backups, he can decrypt them and read all your data. </para> + + <para>Do not change the encryption key without deleting all + files from the account on the server first. None of your old + files on the store will be readable if you do so, and if you + change it back, none of the files uploaded with the new key + will be readable.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>CertificateFile (required)</glossterm> + + <glossdef> + <para>The path to the OpenSSL client certificate in PEM + format. This is supplied by the server operator in response to + the certificate request which you send to them. Together with + the PrivateKeyFile, this provides access to the store server + and the encrypted data stored there.</para> + + <para>It is not critical to protect this file or to back it up + safely, since it can be regenerated by creating a new + certificate request, and asking the server operator to sign + it. You may wish to back it up, together with the + PrivateKeyFile, to avoid this inconvenience if you lose all + your data and need quick access to your backups.</para> + + <para>If you do back them up, you should keep them in a + separate location to the KeysFile, since any person holding + the KeysFile and the PrivateKeyFile can gain access to your + encrypted data and decrypt it.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>PrivateKeyFile (required)</glossterm> + + <glossdef> + <para>The path to the OpenSSL private key in PEM format. This + is generated at the same time as the certificate request, but + there is no need to send it to the server operator, and you + should not do so, in case the communication is intercepted by + an attacker. Together with the CertificateFile, this provides + access to the store server and the encrypted data stored + there.</para> + + <para>See the notes under CertificateFile for information + about backing up this file.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>TrustedCAsFile (required)</glossterm> + + <glossdef> + <para>The path to the OpenSSL certificate of the Client + Certificate Authority (CCA), in PEM format. This is supplied + by the server operator along with your account details, or + along with your signed client certificate. This is used to + verify that the server which you are connecting to is + authorised by the person who signed your certificate. It + protects you against DNS and ARP poisoning and IP spoofing + attacks.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>DataDirectory (required)</glossterm> + + <glossdef> + <para>The path to a directory where bbackupd will keep local + state information. This consists of timestamp files which + identify the last backup start and end times, used by + <command>bbackupquery</command> to determine whether files + have changed, and optionally a database of inode numbers, + which are used to check for files being renamed. The database + is only saved if Box Backup is built with Berkeley Database + (BDB) support.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>NotifyScript (optional)</glossterm> + + <glossdef> + <para>The path to the script or command to run when the Box + Backup client detects an error during the backup process. This + is normally used to notify the client system administrator by + e-mail when a backup fails for any reason.</para> + + <para>The script or command is called with one of the + following additional arguments to identify the cause of the + problem:</para> + + <glosslist> + <glossentry> + <glossterm>store-full</glossterm> + + <glossdef> + <para>The backup store is full. No new files are being + uploaded. If some files are marked as deleted, they + should be removed in due course by the server's + housekeeping process. Otherwise, you need to remove some + files from your backup set, or ask the store operator + for more space.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>read-error</glossterm> + + <glossdef> + <para>One or more files which were supposed to be backed + up could not be read. This could be due to:<itemizedlist> + <listitem> + <para>running the server as a non-root user;</para> + </listitem> + + <listitem> + <para>backing up a mounted filesystem such as + NFS;</para> + </listitem> + + <listitem> + <para>access control lists being applied to some + files;</para> + </listitem> + + <listitem> + <para>SELinux being enabled;</para> + </listitem> + + <listitem> + <para>trying to back up open files under + Windows;</para> + </listitem> + + <listitem> + <para>strange directory permissions such as 0000 or + 0400.</para> + </listitem> + </itemizedlist>Check the client logs, e.g. + /var/log/bbackupd on Unix, or the Windows Event Viewer + in Control Panel > Administrative Tools, for more + information about which files are not being backed up + and why.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>backup-error</glossterm> + + <glossdef> + <para>There was a communications error with the server, + or an unexpected exception was encountered during a + backup run. Check the client logs, e.g. + <filename>/var/log/box</filename> on Unix, or the + Windows Event Viewer in Control Panel > + Administrative Tools, for more information about the + problem.</para> + + <para>You may wish to check your Internet access to the + server, check that the server is running, and ask your + server operator to check your account on the + server.</para> + </glossdef> + </glossentry> + </glosslist> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>CommandSocket (optional)</glossterm> + + <glossdef> + <para>The path to the Unix socket which + <command>bbackupd</command> creates when running, and which + <command>bbackupctl</command> uses to communicate with it, for + example to force a sync or a configuration reload. If this + option is omitted, no socket will be created, and + <command>bbackupctl</command> will not function.</para> + + <para>Unix sockets appear within the filesystem on Unix, as a + special type of file, and must be created in a directory which + exists and to which bbackupd has write access, and bbackupctl + has read access. </para> + + <para>On Windows, the path is ignored, and a <glossterm>named + pipe</glossterm> is created instead. This does not currently + have any security attached, so it can be accessed by any user. + Unlike a Unix socket it can also be accessed remotely. Please + use this option with extreme caution on Windows, and only on + fully trusted networks.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>AutomaticBackup (optional)</glossterm> + + <glossdef> + <para>Enable or disable the client from connecting + automatically to the store every + <glossterm>UpdateStoreInterval</glossterm> seconds. When + enabled (set to <quote>Yes</quote>), the client is in + <glossterm>Lazy Mode</glossterm>. When disabled (set to + <quote>No</quote>), it is in <glossterm>Snapshot + Mode</glossterm>. This setting is optional, and the default + value is <quote>Yes</quote>.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>UpdateStoreInterval (required)</glossterm> + + <glossdef> + <para>The approximate time between successive connections to + the server, in seconds, when the client is in <glossterm>Lazy + Mode</glossterm>. The actual time is randomised slightly to + prevent "rush hour" traffic jams on the server, where many + clients try to connect at the same time.</para> + + <para>This value is ignored if the client is in + <glossterm>Snapshot Mode</glossterm>. However, it is still + required. It can be set to zero in this case.</para> + + <para>You will probably need to experiment with the value of + this option. A good value to start with is probably 86400 + seconds, which is one day.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>MinimumFileAge (required)</glossterm> + + <glossdef> + <para>The number of seconds since a file was last modified + before it will be backed up. The reason for this is to avoid + repeatedly backing up files which are repeatedly changing. A + good value is about 3600 seconds (one hour). If set to zero, + files which have changed will always be backed up on the next + backup run. </para> + + <para>The <glossterm>MaxUploadWait</glossterm> option + overrides this option in some circumstances.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>MaxUploadWait (required)</glossterm> + + <glossdef> + <para>The number of seconds since a file was last uploaded + before it will be uploaded again, even if it keeps changing. + The reason for this is to ensure that files which are + continuously modified are eventually uploaded anyway. This + should be no less than the value of + <glossterm>MinimumFileAge</glossterm>. A good value is about + 14400 seconds (4 hours).</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>MaxFileTimeInFuture (optional)</glossterm> + + <glossdef> + <para>The maximum time that a file's timestamp can be in the + future, before it will be backed up anyway. Due to clock + synchronisation problems, it is inevitable that you will + occasionally see files timestamped in the future. Normally, + for files which are dated only slightly in the future, you + will want to wait until after the file's date before backing + it up. However, for files whose dates are very wrong (more + than a few hours) you will normally prefer to back them up + immediately.</para> + + <para>A good value is about 7200 seconds (2 hours) to cope + with potential problems when moving in and out of daylight + saving time, if applicable in your timezone. The default + value, if this setting is not provided, is 172800 seconds (2 + days).</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>FileTrackingSizeThreshold (required)</glossterm> + + <glossdef> + <para>The minimum size of files which will be tracked by inode + number to detect renames. It is not worth detecting renames of + small files, since they are quick to upload again in full, and + keeping their inode numbers in memory increases the client's + memory usage and slows down searches. Larger files should be + tracked to avoid wasting space on the store and long + uploads.</para> + + <para>A good value is about 65536 bytes (64 kilobytes).</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>DiffingUploadSizeThreshold (required)</glossterm> + + <glossdef> + <para>The minimum size of files which will be compared to the + old file on the server, and for which only changes will be + uploaded. It is not worth comparing small files, since they + are quick to upload again in full, and sending the entire file + reduces the risk of data loss if the store is accidentally + corrupted. Larger files should have only their differences + uploaded to avoid wasting space on the store and long + uploads.</para> + + <para>A good value is about 65536 bytes (64 kilobytes).</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>MaximumDiffingTime (optional)</glossterm> + + <glossdef> + <para>The maximum time for which the client will attempt to + find differences between the current version and the old + version in the store, before giving up and uploading the + entire file again. Very large files (several gigabytes) may + take a very long time to scan for changes, but would also take + a very long time to upload again and use a lot of space on the + store, so it is normally worth omitting this value. </para> + + <para>Use this option only if, for some bizarre reason, you + prefer to upload really large files in full rather than spend + a long time scanning them for changes.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>KeepAliveTime (optional)</glossterm> + + <glossdef> + <para>The interval (in seconds) between sending Keep-Alive + messages to the server while performing long operations such + as finding differences in large files, or scanning large + directories. </para> + + <para>These messages ensure that the SSL connection is not + closed by the server, or an intervening firewall, due to lack + of activity.</para> + + <para>The server will normally wait up to 15 minutes (900 + seconds) before disconnecting the client, so the value should + be given and should be less than 900. Some firewalls may time + out inactive connections after 10 or 5 minutes. </para> + + <para>A good value is 300 seconds (5 minutes). You may need to + reduce this if you frequently see TLSReadFailed or + TLSWriteFailed errors on the client.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>StoreObjectInfoFile (optional)</glossterm> + + <glossdef> + <para>Enables the use of a state file, which stores the + client's internal state when the client is not running. This + is useful on clients machines which are frequently shut down, + for example desktop and laptop computers, because it removes + the need for the client to recontact the store and rescan all + directories on the first backup run, which may take some time. + This feature is somewhat experimental and not well tested. + </para> + + <para>This is option is disabled by default, in which case the + state is stored in memory only. The value is the path to the + state file.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>ExtendedLogging (optional)</glossterm> + + <glossdef> + <para>Enables the connection debugging mode of the client, + which writes all commands sent to or received from the server + to the system logs. This generates a <emphasis>lot</emphasis> + of output, so it should only be used when instructed, or when + you suspect a connection problem or client-server protocol + error (and you know how to interpret the output).</para> + + <para>This is a boolean value, which may be set to + <quote>Yes</quote> or <quote>No</quote>. The default is of + course <quote>No</quote>.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>ExtendedLogFile (optional, new in 0.11)</glossterm> + + <glossdef> + <para>Enables the same debugging output as + <glossterm>ExtendedLogging</glossterm>, but written to a file + instead of the system logs. This is useful if you need + extended logging, but do not have access to the system logs, + for example if you are not the administrator of the + computer.</para> + + <para>The value is the path to the file where these logs will + be written. If omitted, extended logs will not be written to a + file. This is entirely independent of the + <glossterm>ExtendedLogging</glossterm> option. It does not + make much sense to use both at the same time.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>LogAllFileAccess (optional, new in 0.11)</glossterm> + + <glossdef> + <para>Enables logging of all local file and directory access, + file uploads (full and differential), and excluded files. This + may be useful if the client is failing to upload a particular + file, or crashing while trying to upload it. The logs will be + sent to the system log or Windows Event Viewer.</para> + + <para>This generates a <emphasis>lot</emphasis> + of output, so it should only be used when instructed, or when + you suspect that bbackupd is skipping some files and want to + know why. Because it is verbose, the messages are hidden by + default even if the option is enabled. To see them, you must + run bbackupd with at least one -v option.</para> + + <para>This is a boolean value, which may be set to + <quote>Yes</quote> or <quote>No</quote>. The default is of + course <quote>No</quote>.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>SyncAllowScript (optional)</glossterm> + + <glossdef> + <para>The path to the script or command to run when the client + is about to start an automatic backup run, and wishes to know + whether it is safe to do so. This is useful for clients which + do not always have access to the server, for example laptops + and computers on dial-up Internet connections.</para> + + <para>The script should either output the word + <quote>now</quote> if the backup should proceed, or else a + number, in seconds, which indicates how long the client should + wait before trying to connect again. Any other output will + result in an error on the client, and the backup will not + run.</para> + + <para>This value is optional, and by default no such script is + used.</para> + </glossdef> + </glossentry> + </glosslist> + </section> + + <section> + <title>Server Section</title> + + <para>These options appear within the Server subsection, which is at + the root level.</para> + + <glosslist> + <glossentry> + <glossterm>PidFile</glossterm> + + <glossdef> + <para>This option enables the client to write its processs + identifier (PID) to the specified file after starting. The + file will be deleted when the client daemon exits for any + reason. This is disabled by default, but is recommended + whenever you run the client daemon as a daemon (in the + background), which is usually the case. This file can be used + by scripts to determine whether the daemon is still running, + and to send it messages to reload its configuration or to + terminate.</para> + + <example> + <title>Example Server Section</title> + + <programlisting>Server +{ + PidFile = /var/state/boxbackup/bbackupd.pid +}</programlisting> + </example> + </glossdef> + </glossentry> + </glosslist> + </section> + + <section> + <title>Backup Locations Section</title> + + <para>This section serves only as a container for all defined backup + locations.</para> + + <example> + <title>Example Backup Locations Section</title> + + <programlisting>BackupLocations +{ + etc + { + Path = /etc + } + home + { + Path = /home + ExcludeDir = /home/shared + ExcludeDir = /home/chris/.ccache + ExcludeDir = /home/chris/.mozilla/firefox/vvvkq3vp.default/Cache + } +}</programlisting> + </example> + + <para>Each subsection is a backup location. The name of the + subsection is the name that will be used on the server. The root + directory of the account on the server contains one subdirectory per + location. The name should be simple, not containing any spaces or + special characters.</para> + + <para>If you do not define any locations, the client will not back + up any files!</para> + + <para>It is currently not recommended to back up the root directory + of the filesystem on Unix. Box Backup is designed to back up + important data and configuration files, not full systems. + Nevertheless, nothing prevents you from doing so if you + desire.</para> + + <para>On Windows, it is currently not possible to back up files + which are open (currently in use), such as open documents in + Microsoft Office, and system files such as the registry and the + paging file. You will get an error for each open file which the + client attempts to back up. Once the file has been closed, it will + be backed up normally. System files will always be open, and should + be excluded from your backups.</para> + </section> + </section> + </section> + </chapter> + + <chapter> + <title>Administration</title> + + <para>This chapter deals with the dauily running and management of the Box + Backup system. It explains most day-to-day tasks.</para> + + <section> + <title>Regular Maintenance</title> + + <para>The steps involved in maintaining and keeping the backup sets + healthy are outlined in this section.</para> + + <section> + <title>Controlling a backup client</title> + + <para>The bbackupctl program sends control commands to the bbackupd + daemon. It must be run as the same user as the daemon, and there is no + exception for root.</para> + + <para>The command line syntax is:</para> + + <programlisting>/usr/local/sbin/bbackupctl [-q] [-c config-file] command</programlisting> + + <para>The -q option reduces the amount of output the program emits, + and -c allows an alternative configuration file to be + specified.</para> + + <para>Valid commands are:</para> + + <itemizedlist> + <listitem> + <para><emphasis role="bold">terminate</emphasis></para> + + <para>Stop the bbackupd daemon now (equivalent to kill)</para> + </listitem> + + <listitem> + <para><emphasis role="bold">reload</emphasis></para> + + <para>Reload the configuration file (equivalent to kill + -HUP)</para> + </listitem> + + <listitem> + <para><emphasis role="bold">sync</emphasis></para> + + <para>Connect to the server and synchronise files now</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">bbackupctl</emphasis> communicates with + the server via a UNIX domain socket, specified in bbackupd.conf with + the CommandSocket directive. This does not need to be specified, and + <emphasis role="bold">bbackupd</emphasis> will run without the command + socket, but in this case bbackupctl will not be able to communicate + with the daemon.</para> + + <para>Some platforms cannot check the user id of the connecting + process, so this command socket becomes a denial of service security + risk. <emphasis role="bold">bbackupd</emphasis> will warn you when it + starts up if this is the case on your platform, and you should + consider removing the CommandSocket directive on these + platforms.</para> + </section> + + <section> + <title>Using bbackupctl to perform snapshots</title> + + <para><emphasis role="bold">bbackupctl</emphasis>'s main purpose is to + implement snapshot based backups, emulating the behaviour of + traditional backup software.</para> + + <para>Use bbackupd-config to write a configuration file in snapshot + mode, and then run the following command as a cron job.</para> + + <programlisting>/usr/local/sbin/bbackupctl -q sync</programlisting> + + <para>This will cause the backup daemon to upload all changed files + immediately. <emphasis role="bold">bbackupctl</emphasis> will exit + almost immediately, and will not output anything unless there is an + error.</para> + </section> + + <section> + <title>Checking storage space used on the server</title> + + <section> + <title>From the client machine</title> + + <para>bbackupquery can tell you how much space is used on the server + for this account. Either use the usage command in interactive mode, + or type:</para> + + <programlisting>/usr/local/sbin/bbackupquery -q usage quit</programlisting> + + <para>to show the space used as a single command.</para> + </section> + + <section> + <title>On the server</title> + + <para>bbstoreaccounts allows you to query the space used, and change + the limits. To display the space used on the server for an account, + use:</para> + + <programlisting>/usr/local/sbin/bbstoreaccounts info 75AB23C</programlisting> + + <para>To adjust the soft and hard limits on an account, use:</para> + + <programlisting>/usr/local/sbin/bbstoreaccounts setlimit 75AB23C new-soft-limit new-hard-limit</programlisting> + + <para>You do not need to restart the server.</para> + </section> + </section> + + <section> + <title>Verify and restore files</title> + + <para>Backups are no use unless you can restore them. The bbackupquery + utility does this and more.</para> + + <para>You don't provide any login information to it, as it just picks + up the data it needs from /etc/box/bbackupd.conf. You should run it as + root so it can find everything it needs.</para> + + <para>Full documentation can be found in the <ulink + url="bbackupquery.xml">bbackupquery manual page</ulink>. It follows + the model of a command line sftp client quite closely.</para> + + <para>TODO: Link to bbackupquery man-page here.</para> + + <para>On systems where GNU readline is available (by default) it uses + that for command line history and editing. Otherwise it falls back to + very basic UNIX text entry.</para> + + <para>TODO: Did the readline dependency change to editline?</para> + + <section> + <title>Using bbackupquery</title> + + <para>bbackupquery is the tool you use to verify, restore and + investigate your backup files with. When invoked, it simply logs + into the server using the certificates you have listed in + bbackupd.conf.</para> + + <para>After you run bbackupquery, you will see a prompt, allowing + you to execute commands. The list (or ls) command lets you view + files in the store. It works much like unix ls, but with different + options. An example:</para> + + <programlisting>[pthomsen@host bbackupquery]$ bbackupquery +Box Backup Query Tool v0.10, (c) Ben Summers and contributors 2003-2006 +Using configuration file /etc/box/bbackupd.conf +Connecting to store... +Handshake with store... +Login to store... +Login complete. + +Type "help" for a list of commands. + +query > ls +00000002 -d---- mp3 +00000003 -d---- video +00000004 -d---- home-pthomsen +00000005 -d---- root +query > </programlisting> + + <para>The ls commands shows the directories that are backed up. Now + we'll take a closer look at the home-pthomsen directory:</para> + + <programlisting>query > cd home-pthomsen +query > ls +00002809 f----- sample.tiff +0000280a f----- s3.tiff +0000280b f----- s4.tiff +0000280d f----- s2.tiff +0000280e f----- foo.pdf +0000286c f----- core.28720 +0000339a -d---- .emacs.d +0000339d -d---- bbackup-contrib +00003437 f----- calnut.compare.txt +0000345d f----- DSCN1783.jpg +0000345e f----- DSCN1782.jpg +query ></programlisting> + + <para>The ls command takes the following options;</para> + + <itemizedlist> + <listitem> + <para><emphasis role="bold">-r </emphasis>-- recursively list + all files</para> + </listitem> + + <listitem> + <para><emphasis role="bold">-d</emphasis> -- list deleted + files/directories</para> + </listitem> + + <listitem> + <para><emphasis role="bold">-o</emphasis> -- list old versions + of files/directories</para> + </listitem> + + <listitem> + <para><emphasis role="bold">-I</emphasis> -- don't display + object ID</para> + </listitem> + + <listitem> + <para><emphasis role="bold">-F </emphasis>-- don't display + flags</para> + </listitem> + + <listitem> + <para><emphasis role="bold">-t </emphasis>-- show file + modification time (and attr mod time if has the object has + attributes, ~ separated)</para> + </listitem> + + <listitem> + <para><emphasis role="bold">-s</emphasis> -- show file size in + blocks used on server (only very approximate indication of size + locally)</para> + </listitem> + </itemizedlist> + + <para>The flags displayed from the ls command are as follows:</para> + + <simplelist> + <member>f = file</member> + + <member>d = directory</member> + + <member>X = deleted</member> + + <member>o = old version</member> + + <member>R = remove from server as soon as marked deleted or + old</member> + + <member>a = has attributes stored in directory record which + override attributes in backup file</member> + </simplelist> + </section> + + <section> + <title>Verify backups</title> + + <para>As with any backup system, you should frequently check that + your backups are working properly by comparing them. Box Backup + makes this very easy and completely automatic. All you have to do is + schedule the <command>bbackupquery compare</command> command to run + regularly, and check its output. You can run the command manually as + follows:</para> + + <programlisting>/usr/local/sbin/bbackupquery "compare -a" quit</programlisting> + + <para>This command will report all the differences found between the + store and the files on disc. It will download everything, so may + take a while. You should expect to see some differences on a typical + compare, because files which have recently changed are unlikely to + have been uploaded yet. It will also tell you how many files have + been modified since the last backup run, since these will normally + have changed, and such failures are expected.</para> + + <para>You are strongly recommended to add this command as a + <command>cron</command> job, at least once a month, and to check the + output for anything suspicious, particularly a large number of + compare failures, failures on files that have not been modified, or + any error (anything except a compare mismatch) that occurs during + the compare operation.</para> + + <para>Consider keeping a record of these messages and comparing them + with a future verification.</para> + + <para>If you would like to do a "quick" check which just downloads + file checksums and compares against that, then run:</para> + + <programlisting>/usr/local/sbin/bbackupquery "compare -aq" quit</programlisting> + + <para>However, this does not check that the file attributes are + correct, and since the checksums are generated on the client they + may not reflect the data on the server if there is a problem -- the + server cannot check the encrypted contents. View this as a quick + indication, rather than a definite check that your backup verifies + correctly.</para> + </section> + + <section> + <title>Restore backups</title> + + <para>You will need the keys file created when you configured the + server. Without it, you cannot restore the files; this is the + downside of encrypted backups. However, by keeping the small keys + file safe, you indirectly keep your entire backup safe.</para> + + <para>The first step is to recreate the configuration of the backup + client. It's probably best to have stored the /etc/box directory + with your keys. But if you're recreating it, all you really need is + to have got the login infomation correct (ie the certs and + keys).</para> + + <para>Don't run bbackupd yet! It will mark all your files as deleted + if you do, which is not hugely bad in terms of losing data, just a + major inconvenience. (This assumes that you are working from a blank + slate. If you want to restore some files to a different location, + it's fine to restore while bbackupd is running, just do it outside a + backed up directory to make sure it doesn't start uploading the + restored files.)</para> + + <para>Type:</para> + + <programlisting>/usr/local/sbin/bbackupquery</programlisting> + + <para>to run it in interactive mode.</para> + + <para>Type:</para> + + <programlisting>list</programlisting> + + <para>to see a list of the locations stored on the server.</para> + + <para>For each location you want to restore, type:</para> + + <programlisting>restore name-on-server local-dir-name</programlisting> + + <para>The directory specified by local-dir-name must not exist yet. + If the restore is interrupted for any reason, repeat the above + steps, but add the <emphasis role="bold">-r</emphasis> flag to the + restore command to tell it to resume.</para> + </section> + + <section> + <title>Retrieving deleted and old files</title> + + <para>Box Backup makes old versions of files and files you have + deleted available, subject to there being enough disc space on the + server to hold them.</para> + + <para>This is how to retrieve them using bbackupquery. Future + versions will make this far more user-friendly.</para> + + <para>Firstly, run bbackupquery in interactive mode. It behaves in a + similar manner to a command line sftp client.</para> + + <programlisting>/usr/local/sbin/bbackupquery</programlisting> + + <para>Then navigate to the directory containing the file you want, + using list, cd and pwd.</para> + + <programlisting>query > cd home/profiles/USERNAME</programlisting> + + <para>List the directory, using the "o" option to list the files + available without filtering out everything apart from the current + version. (if you want to see deleted files as well, use list + -odt)</para> + + <programlisting>query > list -ot +00000078 f--o- 2004-01-21T20:17:48 NTUSER.DAT +00000079 f--o- 2004-01-21T20:17:48 ntuser.dat.LOG +0000007a f--o- 2004-01-21T17:55:12 ntuser.ini +0000007b f---- 2004-01-12T15:32:00 ntuser.pol +0000007c -d--- 1970-01-01T00:00:00 Templates +00000089 -d--- 1970-01-01T00:00:00 Start Menu +000000a0 -d--- 1970-01-01T00:00:00 SendTo +000000a6 -d--- 1970-01-01T00:00:00 Recent +00000151 -d--- 1970-01-01T00:00:00 PrintHood +00000152 -d--- 1970-01-01T00:00:00 NetHood +00000156 -d--- 1970-01-01T00:00:00 My Documents +0000018d -d--- 1970-01-01T00:00:00 Favorites +00000215 -d--- 1970-01-01T00:00:00 Desktop +00000219 -d--- 1970-01-01T00:00:00 Cookies +0000048b -d--- 1970-01-01T00:00:00 Application Data +000005da -d--- 1970-01-01T00:00:00 UserData +0000437e f--o- 2004-01-24T02:45:43 NTUSER.DAT +0000437f f--o- 2004-01-24T02:45:43 ntuser.dat.LOG +00004380 f--o- 2004-01-23T17:01:29 ntuser.ini +00004446 f--o- 2004-01-24T02:45:43 NTUSER.DAT +00004447 f--o- 2004-01-24T02:45:43 ntuser.dat.LOG +000045f4 f---- 2004-01-26T15:54:16 NTUSER.DAT +000045f5 f---- 2004-01-26T15:54:16 ntuser.dat.LOG +000045f6 f---- 2004-01-26T16:54:31 ntuser.ini</programlisting> + + <para>(this is a listing from a server which is used as a Samba + server for a network of Windows clients.) You now need to fetch the + file using it's ID, rather than it's name. The ID is the hex number + in the first column. Fetch it like this:</para> + + <programlisting>query > get -i 0000437e NTUSER.DAT +Object ID 0000437e fetched successfully.</programlisting> + + <para>The object is now available on your local machine. You can use + lcd to move around, and sh ls to list directories on your local + machine.</para> + </section> + </section> + </section> + + <section> + <title id="FixCorruptions">Fixing corruptions of store data</title> + + <para>This section gives help on what to do if your server has suffered + corruption, for example, after an unclean shutdown or other operating + system or hardware problem.</para> + + <para>In general, as updates to the store are made in an atomic manner, + the most likely result is wasted disc space. However, if really bad + things happen, or you believe that there is a lot of wasted space, then + these instructions will help to restore your data.</para> + + <para>You know you will need to do something if you get strange errors, + and bbackupd attempts to contact the server every 100 seconds or so. Or + if one of the discs in your RAID disc set has failed.</para> + + <para>After following these instructions, the end result will be that + bbackupquery will be able to see all the files which were stored on your + server, and retrieve them. Some of them may be in lost+found directories + in the root of the store (or in their original position if they have + been moved) but they will all be able to be retrieved.</para> + + <para>After you have retrieved the files you want, bbackupd will upload + new versions where necessary, and after about two days, mark any + lost+found directories as deleted. Finally, those directories will be + removed by the housekeeping process on the server.</para> + + <para>These instructions assume you're working on account 1234. Replace + this with the account number that you actually want to check (the one + that is experiencing errors). These steps will need to be repeated for + all affected accounts.</para> + + <section> + <title>Stop bbackupd</title> + + <para>First, make sure that bbackupd is not running on the client + machine for the account you are going to recover. Use + <command>bbackupctl terminate</command> to stop it. This step is not + strictly necessary, but is recommended. During any checks on the + account, bbackupd will be unable to log in, and after they are + complete, the account is marked as changed on the server so bbackupd + will perform a complete scan.</para> + </section> + + <section> + <title>Are you using RAID on the server?</title> + + <para>The raidfile recovery tools have not been written, and probably + will not be, since Box Backup RAID is deprecated. However, when two + out of three files are available, the server will successfully allow + access to your data, even if it complains a lot in the logs. The best + thing to do is to fix the accounts, if necessary, and retrieve any + files you need. Then move the old store directories aside (in case you + need them) and start afresh with new accounts, and let the clients + upload all their data again.</para> + </section> + + <section> + <title>Check and fix the account</title> + + <para>First, run the check utility, and see what errors it + reports.</para> + + <programlisting>/usr/local/sbin/bbstoreaccounts check 1234</programlisting> + + <para>This will take some time, and use a fair bit of memory (about 16 + bytes per file and directory). If the output looks plausible and + reports errors which need fixing, run it again but with the fix + flag:</para> + + <programlisting>/usr/local/sbin/bbstoreaccounts check 1234 fix</programlisting> + + <para>This will fix any errors, and remove unrecoverable files. + Directories will be recreated if necessary.</para> + + <para><emphasis role="bold">NOTE</emphasis>: The utility may adjust + the soft and hard limits on the account to make sure that housekeeping + will not remove anything -- check these afterwards.</para> + </section> + + <section> + <title>Grab any files you need with bbackupquery</title> + + <para>At this point, you will have a working store. Every file which + was on the server, and wasn't corrupt, will be available.</para> + + <para>On the client, use bbackupquery to log in and examine the store. + (type help at the prompt for instructions). Retrieve any files you + need, paying attention to any lost+found directories in the root + directory of the store.</para> + + <para>You can skip this step if you are sure that the client machine + is fine -- in this case, bbackupd will bring the store up to + date.</para> + </section> + + <section> + <title>Restart bbackupd</title> + + <para>Restart bbackupd on the client machine. The store account will + be brought up to date, and files in the wrong place will be marked for + eventual deletion.</para> + </section> + </section> + + <section> + <title id="Troubleshooting">Troubleshooting</title> + + <para>If you are trying to fix a store after your disc has been + corrupted, see <link linkend="FixCorruptions">Fixing corruptions of + store data</link>.</para> + + <para>Unfortunately, the error messages are not particularly helpful at + the moment. This page lists some of the common errors, and the most + likely causes of them.</para> + + <para>When an error occurs, you will see a message like 'Exception: + RaidFile/OSFileError (2/8)' either on the screen or in your log files. + (it is recommended you set up another log file as recommended in the + server setup instructions.)</para> + + <para>This error may not be particularly helpful, although some do have + extra information about probable causes. To get further information, + check the ExceptionCodes.txt file in the root of the distribution. This + file is generated by the ./configure script, so you will need to have + run that first.</para> + + <para>Some common causes of exceptions are listed below.</para> + + <para>Please email me with any other codes you get, and I will let you + know what they mean, and add notes here.</para> + + <section> + <title>RaidFile (2/8)</title> + + <para>This is found either when running bbstoreaccounts or in the + bbstored logs.</para> + + <para><emphasis role="bold">Problem</emphasis>: The directories you + specified in the raidfile.conf are not writable by the _bbstored + user.</para> + + <para><emphasis role="bold">Resolution</emphasis>: Change permissions + appropriately.</para> + </section> + + <section> + <title>Common (1/2)</title> + + <para>This usually occurs when the configuration files can't be + opened.</para> + + <para><emphasis role="bold">Problem</emphasis>: You created your + configurations in non-standard locations, and the programs cannot find + them.</para> + + <para><emphasis role="bold">Resolution</emphasis>: Explicitly specify + configuration file locations to daemons and programs. For + example</para> + + <programlisting>/usr/local/sbin/bbstored /some/other/dir/bbstored.config /usr/local/sbin/bbackupquery -c /some/other/dir/bbackupd.config</programlisting> + + <para>(daemons specify the name as the first argument, utility + programs with the -c option).</para> + + <para><emphasis role="bold">Problem</emphasis>: bbstored can't find + the raidfile.conf file specified in bbstored.conf.</para> + + <para><emphasis role="bold">Resolution</emphasis>: Edit bbstored.conf + to point to the correct location of this additional configuration + file.</para> + </section> + + <section> + <title>Server (3/16)</title> + + <para>The server can't listen for connections on the IP address + specified when you configured it.</para> + + <para><emphasis role="bold">Problem</emphasis>: This probably means + you've specified the wrong hostname to bbstored-config -- maybe your + server is behind a NAT firewall?</para> + + <para><emphasis role="bold">Resolution</emphasis>: Edit bbstored.conf + and correct the ListenAddresses line. You should replace the server + address with the IP address of your machine.</para> + </section> + + <section> + <title>Connection (7/x)</title> + + <para>These errors all relate to connections failing -- you may see + them during operation if there are network failures or other problems + between the client and server. The backup system will recover from + them automatically.</para> + + <section> + <title>Connection (7/30) - SSL problems</title> + + <para>Log snippet from client side:</para> + + <programlisting>bbackupd[1904]: Opening connection to server xxxx.xxx... +bbackupd[1904]: SSL err during Connect: error:xxxxxxxx:rsa routines:RSA_padding_check_PKCS1_type_1:block type is not 01 +bbackupd[1904]: SSL err during Connect: error:xxxxxxxx:rsa routines:RSA_EAY_PUBLIC_DECRYPT:padding check failed +bbackupd[1904]: SSL err during Connect: error:xxxxxxxx:asn1 encoding routines:ASN1_verify:EVP lib +bbackupd[1904]: SSL err during Connect: error:xxxxxxxx:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed +bbackupd[1904]: TRACE: Exception thrown: ConnectionException(Conn_TLSHandshakeFailed) at SocketStreamTLS.cpp(237) +bbackupd[1904]: Exception caught (7/30), reset state and waiting to retry...</programlisting> + + <para>And from the server:</para> + + <programlisting>bbstored[19291]: Incoming connection from xx.xxx.xx.xxx port xxxxx (handling in child xxxxx) +bbstored[21588]: SSL err during Accept: error:xxxxxxxx:SSL routines:SSL3_READ_BYTES:tlsv1 alert decrypt error +bbstored[21588]: in server child, exception Connection TLSHandshakeFailed (7/30) -- terminating child</programlisting> + + <para><emphasis role="bold">Solution</emphasis>: Create a new CA on + the server side and re-generate the client certificate. Re-creating + the client certificate request is not necessary.</para> + </section> + </section> + + <section> + <title>Advanced troubleshooting</title> + + <para>If this really doesn't help, then using the DEBUG builds of the + system will give you much more information -- a more descriptive + exception message and the file and line number where the error + occurred.</para> + + <para>For example, if you are having problems with bbstoreaccounts, + build the debug version with:</para> + + <programlisting>cd boxbackup-0.0 +cd bin/bbstoreaccounts +make</programlisting> + + <para>Within the module directories, make defaults to building the + debug version. At the top level, it defaults to release.</para> + + <para>This will build an executable in debug/bin/bbstoreaccounts which + you can then use instead of the release version. It will give far more + useful error messages.</para> + + <para>When you get an error message, use the file and line number to + locate where the error occurs in the code. There will be comments + around that line to explain why the exception happened.</para> + + <para>If you are using a debug version of a daemon, these extended + messages are found in the log files.</para> + </section> + </section> + </chapter> + + &__ExceptionCodes__elfjz3fu; + + <appendix> + <title id="WORoot">Running without root</title> + + <para>It is possible to run both the server and client without root + privileges.</para> + + <section> + <title>Server</title> + + <para>The server, by default, runs as a non-root user. However, it + expects to be run as root and changes user to a specified user as soon + as it can, simply for administrative convenience. The server uses a port + greater than 1024, so it doesn't need root to start.</para> + + <para>To run it entirely as a non-root user, edit the bbstored.conf + file, and remove the User directive from the Server section. Then simply + run the server as your desired user.</para> + </section> + + <section> + <title>Client</title> + + <para>The client requires root for normal operation, since it must be + able to access all files to back them up. However, it is possible to run + the client as a non-root user, with certain limitations.</para> + + <para>Follow the installation instructions, but install the executable + files manually to somewhere in your home directory. Then use + bbackupd-config to configure the daemon, but use a directory other than + /etc/box, probably somewhere in your home directory.</para> + + <para>All directories you specify to be backed up must be readable, and + all files must be owned by the user and readable to that user.</para> + + <para>Important: If any file or directory is not readable by this user, + the backup process will skip that file or directory. Keep an eye on the + logs for reports of this failure.</para> + + <para>Non-root operation of the backup client is recommended only for + testing, and should not be relied on in a production environment.</para> + </section> + </appendix> +</book> diff --git a/docs/docbook/bb-book.xsl b/docs/docbook/bb-book.xsl new file mode 100644 index 00000000..a4f05fdb --- /dev/null +++ b/docs/docbook/bb-book.xsl @@ -0,0 +1,17 @@ +<?xml version='1.0'?> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> + +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/> + +<xsl:param name="html.stylesheet" select="'../bbdoc.css'"/> +<xsl:param name="chunk.section.depth" select="'0'"/> +<xsl:template name="user.header.navigation"> +<div id="header"> +<div id="logo"> +<img src="../images/bblogo.png" alt="logo" height="65" width="331" border="0" vspace="5" align="middle" /> <img src="../images/stepahead.png" alt="a step ahead in data security" width="182" height="11" hspace="10" vspace="20" border="0" align="middle" /></div> +</div> +</xsl:template> + + +</xsl:stylesheet> diff --git a/docs/docbook/bb-man.xsl.tmpl b/docs/docbook/bb-man.xsl.tmpl new file mode 100644 index 00000000..e20eedd5 --- /dev/null +++ b/docs/docbook/bb-man.xsl.tmpl @@ -0,0 +1,9 @@ +<?xml version='1.0'?> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> + +<xsl:import href="%%DOCBOOK%%"/> + +<xsl:param name="chunk.section.depth" select="'0'"/> + +</xsl:stylesheet> diff --git a/docs/docbook/bb-nochunk-book.xsl b/docs/docbook/bb-nochunk-book.xsl new file mode 100644 index 00000000..86574122 --- /dev/null +++ b/docs/docbook/bb-nochunk-book.xsl @@ -0,0 +1,17 @@ +<?xml version='1.0'?> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> + +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"/> + +<xsl:param name="html.stylesheet" select="'../bbdoc-man.css'"/> +<xsl:param name="chunk.section.depth" select="'0'"/> +<xsl:template name="user.header.content"> +<div id="header"> +<div id="logo"> +<img src="../images/bblogo.png" alt="logo" height="65" width="331" border="0" vspace="5" align="middle" /> <img src="../images/stepahead.png" alt="a step ahead in data security" width="182" height="11" hspace="10" vspace="20" border="0" align="middle" /></div> +</div> +</xsl:template> + + +</xsl:stylesheet> diff --git a/docs/docbook/bbackupctl.xml b/docs/docbook/bbackupctl.xml new file mode 100644 index 00000000..b4880bfd --- /dev/null +++ b/docs/docbook/bbackupctl.xml @@ -0,0 +1,205 @@ +<?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>bbackupctl</refentrytitle> + + <manvolnum>8</manvolnum> + + <refmiscinfo class="manual">Box Backup</refmiscinfo> + + <refmiscinfo class="source">Box Backup</refmiscinfo> + + <refmiscinfo class="version">0.11</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>bbackupctl</refname> + + <refpurpose>Control the Box Backup client daemon</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>bbackupctl</command> + + <arg>-q</arg> + + <arg>-c config-file</arg> + + <arg choice="plain">command</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para><command>bbackupctl</command> sends commands to a running + <command>bbackupd</command> daemon on a client machine. It can be used to + force an immediate backup, tell the daemon to reload its configuration + files or stop the daemon. If <command>bbackupd</command> is configured in + snapshot mode, it will not back up automatically, and the + <command>bbackupctl</command> must be used to tell it when to start a + backup.</para> + + <para>Communication with the bbackupd daemon takes place over a local + socket (not over the network). Some platforms (notably Windows) can't + determine if the user connecting on this socket has the correct + credentials to execute the commands. On these platforms, ANY local user + can interfere with bbackupd. To avoid this, remove the CommandSocket + option from bbackupd.conf, which will also disable bbackupctl. See the + Client Configuration page for more information.</para> + + <para><command>bbackupctl</command> needs to read the + <command>bbackupd</command> configuration file to find out the name of the + CommandSocket. If you have to tell <command>bbackupd</command> where to + find the configuration file, you will have to tell + <command>bbackupctl</command> as well. The default on Unix systems is + usually <filename>/etc/box/bbackupd.conf</filename>. On Windows systems, + it is <filename>bbackupd.conf</filename> in the same directory where + <command>bbackupd.exe</command> is located. If + <command>bbackupctl</command> cannot find or read the configuration file, + it will log an error message and exit.</para> + + <para><command>bbackupctl</command> usually writes error messages to the + console and the system logs. If it is not doing what you expect, please + check these outputs first of all.</para> + + <variablelist> + <varlistentry> + <term><option>-q</option></term> + + <listitem> + <para>Run in quiet mode.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-c</option> config-file</term> + + <listitem> + <para>Specify configuration file.</para> + </listitem> + </varlistentry> + </variablelist> + + <refsection> + <title>Commands</title> + + <para>The following commands are available in bbackupctl:</para> + + <variablelist> + <varlistentry> + <term><command>terminate</command></term> + + <listitem> + <para>This command cleanly shuts down <command>bbackupd</command>. + This is better than killing or terminating it any other + way.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>reload</command></term> + + <listitem> + <para>Causes the <command>bbackupd</command> daemon to re-read all + its configuration files. Equivalent to <command>kill + -HUP</command>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>sync</command></term> + + <listitem> + <para>Initiates a backup. If no files need to be backed up, no + connection will be made to the server.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>force-sync</command></term> + + <listitem> + <para>Initiates a backup, even if the + <varname>SyncAllowScript</varname> says that no backup should run + now.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>wait-for-sync</command></term> + + <listitem> + <para>Passively waits until the next backup starts of its own + accord, and then terminates.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>wait-for-end</command></term> + + <listitem> + <para>Passively waits until the next backup starts of its own + accord and finishes, and then terminates.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>sync-and-wait</command></term> + + <listitem> + <para>Initiates a backup, waits for it to finish, and then + terminates.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + </refsection> + + <refsection> + <title>Files</title> + + <para><filename>/etc/box/bbackupd.conf</filename></para> + </refsection> + + <refsection> + <title>See Also</title> + + <para><citerefentry> + <refentrytitle>bbackupd.conf</refentrytitle> + + <manvolnum>5</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> diff --git a/docs/docbook/bbackupd-config.xml b/docs/docbook/bbackupd-config.xml new file mode 100644 index 00000000..41bb6587 --- /dev/null +++ b/docs/docbook/bbackupd-config.xml @@ -0,0 +1,153 @@ +<?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-config</refentrytitle> + + <manvolnum>8</manvolnum> + + <refmiscinfo class="manual">Box Backup</refmiscinfo> + + <refmiscinfo class="source">Box Backup</refmiscinfo> + + <refmiscinfo class="version">0.11</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>bbackupd-config</refname> + + <refpurpose>Box Backup client daemon configuration file + generator</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>bbackupd-config</command> + + <arg choice="plain">config-dir</arg> + + <arg choice="plain">backup-mode</arg> + + <arg choice="plain">account-num</arg> + + <arg choice="plain">server-hostname</arg> + + <arg choice="plain">working-dir</arg> + + <arg choice="plain">backup-dir</arg> + + <arg choice="opt">backup-dir ...</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>The bbackupd-config script creates configuration files and client + certificates. It takes at least six parameters:</para> + + <variablelist> + <varlistentry> + <term>config-dir</term> + + <listitem> + <para>Configuration directory. Usually + <filename>/etc/box</filename>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>backup-mode</term> + + <listitem> + <para>Either lazy or snapshot.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>account-num</term> + + <listitem> + <para>The client account number. This is set by the bbstored + administrator.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>server-hostname</term> + + <listitem> + <para>The hostname or IP address of the bbstored server.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>working-dir</term> + + <listitem> + <para>A directory to keep temporary state files. This is usually + something like <filename>/var/bbackupd</filename>. This can be + changed in <filename>bbackupd.conf</filename> later on if + required.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>backup-dir</term> + + <listitem> + <para>A space-separated list of directories to be backed up. Note + that this <emphasis>does not</emphasis> traverse mount + points.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + + <refsection> + <title>Files</title> + + <para><filename>/etc/box/bbackupd.conf</filename></para> + + <para><filename>/etc/box/bbackupd/NotifySysAdmin.sh</filename></para> + </refsection> + + <refsection> + <title>See Also</title> + + <para><citerefentry> + <refentrytitle>bbackupd.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbackupd</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> diff --git a/docs/docbook/bbackupd.conf.xml b/docs/docbook/bbackupd.conf.xml new file mode 100644 index 00000000..43ae2bed --- /dev/null +++ b/docs/docbook/bbackupd.conf.xml @@ -0,0 +1,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> diff --git a/docs/docbook/bbackupd.xml b/docs/docbook/bbackupd.xml new file mode 100644 index 00000000..11de0f3f --- /dev/null +++ b/docs/docbook/bbackupd.xml @@ -0,0 +1,209 @@ +<?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</refentrytitle> + + <manvolnum>8</manvolnum> + + <refmiscinfo class="manual">Box Backup</refmiscinfo> + + <refmiscinfo class="source">Box Backup</refmiscinfo> + + <refmiscinfo class="version">0.11</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>bbackupd</refname> + + <refpurpose>Box Backup client daemon</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>bbackupd</command> + + <arg>-DFkqvVT</arg> + + <arg>-c config-file</arg> + + <arg>-t tag</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para><command>bbackupd</command> runs on client computers in the + background, finding new files to back up. When it is time for a backup, + <command>bbackupd</command> will connect to the server + (<command>bbstored</command>) to upload the files.</para> + + <para>A running <command>bbackupd</command> daemon can be controlled with + the <command>bbackupctl</command> command, to make it shut down, reload + its configuration, or start an immediate backup.</para> + + <para><command>bbackupd</command> needs to be configured to tell it which + files to back up, how often, and to which server (running + <command>bbstored</command>). See the Client Configuration page for more + information. For this, you must write a configuration file. You must + either place it in the default location, or tell + <command>bbackupd</command> where to find it.</para> + + <para>You can check the default location with the <option>-h</option> + option. The default on Unix systems is usually + <filename>/etc/box/bbackupd.conf</filename>. On Windows systems, it is + <filename>bbackupd.conf</filename> in the same directory where + <command>bbackupd.exe</command> is located. If bbackupd cannot find or + read the configuration file, it will log an error message and exit.</para> + + <para><command>bbackupd</command> usually writes log messages to the + system logs, using the facility <function>local5</function>, which you can + use to filter them to send them to a separate file. It can also write them + to the console, see options below. If <command>bbackupd</command> is not + doing what you expect, please check the logs first of all.</para> + + <refsection> + <title>Options</title> + + <variablelist> + <varlistentry> + <term><option>-c</option> config-file</term> + + <listitem> + <para>Use the specified configuration file. If <option>-c</option> + is omitted, the last argument is the configuration file. If none + is specified, the default is used (see above).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-D</option></term> + + <listitem> + <para>Debugging mode. Do not fork into the background (do not run + as a daemon). Not available on Windows.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-F</option></term> + + <listitem> + <para>No-fork mode. Same as <option>-D</option> for bbackupd. Not + available on Windows.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-k</option></term> + + <listitem> + <para>Keep console open after fork, keep writing log messages to + it. Not available on Windows.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-q</option></term> + + <listitem> + <para>Run more quietly. Reduce verbosity level by one. Available + levels are <varname>NOTHING</varname>, <varname>FATAL</varname>, + <varname>ERROR</varname>, <varname>WARNING</varname>, + <varname>NOTICE</varname>, <varname>INFO</varname>, + <varname>TRACE</varname>, <varname>EVERYTHING</varname>. Default + level is <varname>NOTICE</varname> in non-debugging builds. Use + once to drop to <varname>WARNING</varname> level, twice for + <varname>ERROR</varname> level, four times for no logging at + all.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-v</term> + + <listitem> + <para>Run more verbosely. Increase verbosity level by one. Use + once to raise to <varname>INFO</varname> level, twice for + <varname>TRACE</varname> level, three times for + <varname>EVERYTHING</varname> (currently the same as + <varname>TRACE</varname>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-V</option></term> + + <listitem> + <para>Run at maximum verbosity (<varname>EVERYTHING</varname> + level).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-t</option> tag</term> + + <listitem> + <para>Tag each console message with specified marker. Mainly + useful in testing when running multiple daemons on the same + console.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-T</option></term> + + <listitem> + <para>Timestamp each line of console output.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + </refsection> + + <refsection> + <title>Files</title> + + <para><filename>/etc/box/bbackupd.conf</filename></para> + </refsection> + + <refsection> + <title>See Also</title> + + <para><citerefentry> + <refentrytitle>bbackupd.conf</refentrytitle> + + <manvolnum>5</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> diff --git a/docs/docbook/bbackupquery.xml b/docs/docbook/bbackupquery.xml new file mode 100644 index 00000000..016d5c7d --- /dev/null +++ b/docs/docbook/bbackupquery.xml @@ -0,0 +1,506 @@ +<?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>bbackupquery</refentrytitle> + + <manvolnum>8</manvolnum> + + <refmiscinfo class="manual">Box Backup</refmiscinfo> + + <refmiscinfo class="source">Box Backup</refmiscinfo> + + <refmiscinfo class="version">0.11</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>bbackupquery</refname> + + <refpurpose>Box Backup store query and file retrieval</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>bbackupquery</command> + + <arg>-q</arg> + + <arg>-c configfile</arg> + + <arg>command ...</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para><command>bbackupquery</command> is the main way of interacting with + the backup store from a Box Backup client machine. It supports both + interactive and batch modes of operation.</para> + + <para>It can be used to reviewing the status of a client machine's backup + store, getting status from the store server. The main use is to retrieve + files and directories when needed.</para> + + <para><command>bbackupquery</command> supports interactive and batch modes + of operation. Interactive mode allows for interaction with the server much + like an interactive FTP client.</para> + + <para>Batch mode is invoked by putting commands into the invocation of + <command>bbackupquery</command>. Example:</para> + + <para><programlisting>bbackupquery "list home-dirs" quit</programlisting></para> + + <para>Note that commands that contain spaces are enclosed in double + quotes. If the <command>quit</command> command is omitted, after the + preceding commands are completed, <command>bbackupquery</command> will + enter interactive mode.</para> + </refsection> + + <refsection> + <title>Options</title> + + <para><variablelist> + <varlistentry> + <term><option>-q</option></term> + + <listitem> + <para>Quiet. Suppresses status output while running.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-c</option> <option>configfile</option></term> + + <listitem> + <para>Use configfile instead of the default bbackupd.conf file. + Can be a relative or full path.</para> + </listitem> + </varlistentry> + </variablelist></para> + </refsection> + + <refsection> + <title>Commands</title> + + <para>The commands that can be used in bbackupquery are listed + below.</para> + + <variablelist> + <varlistentry> + <term><command>help</command></term> + + <listitem> + <para>Displays the basic help message, which gives information about + the commands available in <command>bbackupquery</command>. Use the + form <command>help command</command> to get help on a specific + command.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>quit</command></term> + + <listitem> + <para>End the session with the store server, and quit + bbackupquery.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>cd</command> <optional>options</optional> + <varname>directory-name</varname></term> + + <listitem> + <para>Change directory. Options: <variablelist> + <varlistentry> + <term><option>-d</option></term> + + <listitem> + <para>consider deleted directories for traversal</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-o</option></term> + + <listitem> + <para>consider old versions of directories for traversal. + This option should never be useful in a correctly formed + store.</para> + </listitem> + </varlistentry> + </variablelist></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>lcd</command> + <varname>local-directory-name</varname></term> + + <listitem> + <para>Change directory on the client machine. To list the contents + of the local directory, type <command>sh ls</command> (on Unix-like + machines).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>list</command> <optional>options</optional> + <optional>directory-name</optional></term> + + <listitem> + <para>The list (or its synonym <command>ls</command>) command lists + the content of the current, or specified, directory. The options are + as follows:</para> + + <para><variablelist> + <varlistentry> + <term><option>-r</option></term> + + <listitem> + <para>recursively list all files</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-d</option></term> + + <listitem> + <para>list deleted files and directories</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-o</option></term> + + <listitem> + <para>list old versions of files and directories</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-I</option></term> + + <listitem> + <para>don't display object IDs</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-F</option></term> + + <listitem> + <para>don't display flags</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-t</option></term> + + <listitem> + <para>show file modification time (and attr mod time, if the + object has attributes).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-s</option></term> + + <listitem> + <para>show file size in blocks used on server. Note that + this is only a very approximate indication of local file + size.</para> + </listitem> + </varlistentry> + </variablelist></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>ls</command> <optional>options</optional> + <optional>directory-name</optional></term> + + <listitem> + <para>Synonym for <command>list</command>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>pwd</command></term> + + <listitem> + <para>Print current directory, always relative to the backup store + root.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>sh</command> <varname>shell-command</varname></term> + + <listitem> + <para>Everything after the sh is passed to a shell and run. All + output from the command is displayed in the client.</para> + + <para>Example: to list the contents of the current directory on the + client machine type <command>sh ls</command>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>compare -a</command></term> + + <listitem> + <para></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>compare -l</command> + <varname>location-name</varname></term> + + <listitem> + <para></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>compare</command> <varname>store-dir-name</varname> + <varname>local-dir-name</varname></term> + + <listitem> + <para>Compare the current data in the store with the data on the + disc. Please note that all the data will be downloaded from the + store, so this can be a very lengthy process depending on the size + of the store, and the size of the part you are comparing.</para> + + <para>Options:</para> + + <para><variablelist> + <varlistentry> + <term><option>-a</option></term> + + <listitem> + <para>compare all locations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-l</option></term> + + <listitem> + <para>compare one backup location as specified in the + configuration file. This compares one of the top level store + directories.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-c</option></term> + + <listitem> + <para>set return code. The return code is set to the + following values, if quit is the next command. So, if + another command is run after the compare, the return code + will not refer to the compare. This option is very useful + for automating compares. Return code values:<itemizedlist> + <listitem> + <para><option>1</option> -- no differences were + found</para> + </listitem> + + <listitem> + <para><option>2</option> -- differences were + found</para> + </listitem> + + <listitem> + <para><option>3</option> -- an error occured</para> + </listitem> + </itemizedlist></para> + </listitem> + </varlistentry> + </variablelist></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>get</command> <varname>object-filename</varname> + <optional>local-filename</optional></term> + + <listitem> + <para></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>get -i</command> <varname>object-id</varname> + <varname>local-filename</varname></term> + + <listitem> + <para>Gets a file from the store. Object is specified as the + filename within the current directory. Local filename is optional. + Ignores old and deleted files when searching the directory for the + file to retrieve.</para> + + <para>To get an old or deleted file, use the <option>-i</option> + option and select the object as a hex object ID (first column in + listing). The local filename must be specified.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>getobject</command> <varname>object-id</varname> + <varname>local-filename</varname></term> + + <listitem> + <para>Gets the object specified by the object id (in hex) and stores + the raw contents in the local file specified. Note: This is only + useful for debugging as it does not decode files from the stored + format, which is encrypted and compressed.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>restore</command> <optional>-d</optional> + <varname>directory-name</varname> + <varname>local-directory-name</varname></term> + + <listitem> + <para></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>restore -r</command></term> + + <listitem> + <para>Restores a directory to the local disc. The local directory + specified must not exist (unless a previous restore is being + restarted). The root cannot be restored -- restore locations + individually.</para> + + <para>Options:</para> + + <para><variablelist> + <varlistentry> + <term><option>-d</option></term> + + <listitem> + <para>restore a deleted directory</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-r</option></term> + + <listitem> + <para>resume an interrupted restore</para> + </listitem> + </varlistentry> + </variablelist>If a restore operation is interrupted for any + reason, it can be restarted using the <option>-r</option> switch. + Restore progress information is saved in a file at regular intervals + during the restore operation to allow restarts.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>usage</command> <optional>-m</optional></term> + + <listitem> + <para>Show space used on the server for this account. Display + fields:<itemizedlist> + <listitem> + <para><property>Used</property>: Total amount of space used on + the server</para> + </listitem> + + <listitem> + <para><property>Old files</property>: Space used by old + files</para> + </listitem> + + <listitem> + <para><property>Deleted files</property>: Space used by + deleted files</para> + </listitem> + + <listitem> + <para><property>Directories</property>: Space used by the + directory structure</para> + </listitem> + </itemizedlist></para> + + <para>When <property>Used</property> exceeds the soft limit, the + server will start to remove old and deleted files until the usage + drops below the soft limit. After a while, you should expect to see + the usage stay at just below the soft limit. You only need more + space if the space used by old and deleted files is near + zero.</para> + + <para>The <option>-m</option> option displays output in + machine-readable form.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + + <refsection> + <title>Bugs</title> + + <para>If you find a bug in Box Backup and you want to let us know about + it, join the <link + xlink:href="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing + list</link> and send us a description of the problem there.</para> + + <para>To report a bug, give us at least the following information:</para> + + <itemizedlist> + <listitem> + <para>The version of Box Backup you are running</para> + </listitem> + + <listitem> + <para>The platform you are running on (hardware and OS), for both + client and server.</para> + </listitem> + + <listitem> + <para>If possible attach your config files (bbstored.conf, + bbackupd.conf) to the bug report.</para> + </listitem> + + <listitem> + <para>Also attach any log file output that helps shed light on the + problem you are seeing.</para> + </listitem> + + <listitem> + <para>And last but certainly not least, a description of what you are + seeing, in as much detail as possible.</para> + </listitem> + </itemizedlist> + </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> diff --git a/docs/docbook/bbstoreaccounts.xml b/docs/docbook/bbstoreaccounts.xml new file mode 100644 index 00000000..08092acf --- /dev/null +++ b/docs/docbook/bbstoreaccounts.xml @@ -0,0 +1,386 @@ +<?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>bbstoreaccounts</refentrytitle> + + <manvolnum>8</manvolnum> + + <refmiscinfo class="manual">Box Backup</refmiscinfo> + + <refmiscinfo class="source">Box Backup</refmiscinfo> + + <refmiscinfo class="version">0.11</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>bbstoreaccounts</refname> + + <refpurpose>Box Backup store accounts manager</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>bbstoreaccounts</command> + + <arg>-c config-file</arg> + + <arg choice="plain">command</arg> + + <arg choice="plain">account-id</arg> + + <arg>command-specific arguments</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para><command>bbstoreaccounts</command> is the tool for managing accounts + on the store server. It can be used to view information related to + accounts, as well as create, change and delete accounts on the store + server.</para> + + <para><command>bbstoreaccounts</command> always takes at least 2 + parameters: the command name and the account ID. Some commands require + additional parameters, and some commands have optional parameters.</para> + + <refsection> + <title>Options</title> + + <para><variablelist> + <varlistentry> + <term><option>-c config-file</option></term> + + <listitem> + <para>The configfile to use for connecting to the store. Default + is <filename>/etc/box/bbstored.conf</filename>.</para> + </listitem> + </varlistentry> + </variablelist></para> + </refsection> + + <refsection> + <title>Commands</title> + + <para>The commands tells bbstoreaccounts what action to perform.</para> + + <para><variablelist> + <varlistentry> + <term><command>check</command> <varname>account-id</varname> + <optional>fix</optional></term> + + <listitem> + <para>The <command>check</command> command verifies the + integrity of the store account given, and optionally fixes any + corruptions. <emphasis role="bold">Note</emphasis>: It is + recommended to run the 'simple' check command (without + <command>fix</command>) before using the <command>fix</command> + option. This gives an overview of the extent of any problems, + before attempting to fix them.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>create</command> <varname>account-id</varname> + <varname>disc-set</varname> <varname>soft-limit</varname> + <varname>hard-limit</varname></term> + + <listitem> + <para>Creates a new store account with the parameters given. The + parameters are as follows:</para> + + <para><variablelist> + <varlistentry> + <term><option>account-id</option></term> + + <listitem> + <para>The ID of the new account to be created. A 32-bit + hexadecimal number. Cannot already exist on the + server.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>disc-set</option></term> + + <listitem> + <para>The disc set from <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry> where the backups for this client will + be stored. A number. Each RAID-file set has a number in + raidfile.conf. This number is what's used.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>soft-limit</option></term> + + <listitem> + <para>The soft limit is the amount of storage that the + server will guarantee to be available for + storage.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>hard-limit</option></term> + + <listitem> + <para>The amount of storage that the the server will + allow, before rejecting uploads, and starting to + eliminate old and deleted files to get back down to + soft-limit.</para> + </listitem> + </varlistentry> + </variablelist></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>delete</command> <varname>account-id</varname> + <optional>yes</optional></term> + + <listitem> + <para>Deletes the account from the store server completely. + Removes all backups and deletes all references to the account in + the config files.</para> + + <para><command>delete</command> will ask for confirmation from + the user, when called. Using the <option>yes</option> flag, + eliminates that need. This is useful when deleting accounts from + within a script or some other automated means. 0</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>info</command> <varname>account-id</varname></term> + + <listitem> + <para>Display information about the given account. + Example:<programlisting>[root]# bbstoreaccounts info 1 + Account ID: 00000001 + Last object ID: 58757 + Blocks used: 9864063 (38531.50Mb) + Blocks used by old files: 62058 (242.41Mb) +Blocks used by deleted files: 34025 (132.91Mb) + Blocks used by directories: 6679 (26.09Mb) + Block soft limit: 11796480 (46080.00Mb) + Block hard limit: 13107200 (51200.00Mb) + Client store marker: 1139559852000000</programlisting></para> + + <para>Explanation:</para> + + <para><variablelist> + <varlistentry> + <term>Account ID</term> + + <listitem> + <para>The account ID being displayed.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Last Object ID</term> + + <listitem> + <para>A counter that keeps track of the objects that + have been backed up. This number refers to the last file + that was written to the store. The ID is displayed as a + decimal number, and the object ID can be converted to a + path name to a file as follows: convert the number to + hex (e.g.: 58757 => 0xE585); The last backed up file + will be (relative from the client's store root): + <filename>e5/o85.rfw</filename>. Longer numbers infer + more directories in the structure, so as an example + 3952697264 as the last object ID gives 0xEB995FB0, which + translates to a backup pathname of + <filename>eb/99/5f/ob0.rfw</filename>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Blocks used</term> + + <listitem> + <para>The number of blocks used by the store. The size + in Mb depends on the number of blocks, as well as the + block size for the disc set given in <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry>. In this case the block size is + 4096.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Blocks used by old files</term> + + <listitem> + <para>The number of blocks occupied by files that have + newer versions in the store. This data is at risk for + being removed during housekeeping.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Blocks used by deleted files</term> + + <listitem> + <para>The number of blocks used by files that have been + deleted on the client. This data is at risk for being + removed during housekeeping.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Blocks used by directories</term> + + <listitem> + <para>The number of blocks used by directories in the + store.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Block soft limit</term> + + <listitem> + <para>The soft limit in blocks. The soft limit is the + maximum guaranteed storage space available to the + account. When housekeeping starts, and the old and + deleted files are removed, they are removed in + chronological order (oldest first), until the data used + is less than the soft limit.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Block hard limit</term> + + <listitem> + <para>The hard limit in blocks. The hard limit is the + most amount of storage the server will allow in an + account. Any data above this amount will be rejected. + Housekeeping will reduce the storage use, so more data + can be uploaded.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Client store marker</term> + + <listitem> + <para><citerefentry> + <refentrytitle>bbstored</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry> uses this number to determine if it + needs to rescan the entire store. If this number is + different from the last time it checked, a rescan will + take place.</para> + </listitem> + </varlistentry> + </variablelist></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>setlimit</command> <varname>account-id</varname> + <varname>soft-limit</varname> <varname>hard-limit</varname></term> + + <listitem> + <para>Changes the storage space allocation for the given + account. No server restart is needed.</para> + + <para>Parameters:</para> + + <para><variablelist> + <varlistentry> + <term><option>account-id</option></term> + + <listitem> + <para>The ID of the account to be modified.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>soft-limit</option></term> + + <listitem> + <para>The soft limit is the amount of storage that the + server will guarantee to be available for + storage.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>hard-limit</option></term> + + <listitem> + <para>The amount of storage that the the server will + allow before rejecting uploads and starting to eliminate + old and deleted files to get back down to + <option>soft-limit</option>.</para> + </listitem> + </varlistentry> + </variablelist></para> + </listitem> + </varlistentry> + </variablelist></para> + </refsection> + </refsection> + + <refsection> + <title>Examples</title> + + <para>Create an account with ID 3af on disc set 0, with a 20GB soft-limit + and a 22GB hard-limit:<programlisting>bbstoreaccounts create 3af 0 20G 22G</programlisting>Alter + existing account ID 20 to have a 50GB soft-limit and a 55GB + hard-limit:<programlisting>bbstoreaccounts setlimit 20 50G 55G</programlisting></para> + </refsection> + + <refsection> + <title>Files</title> + + <para><filename>/etc/box/bbstored/accounts.txt</filename></para> + </refsection> + + <refsection> + <title>See Also</title> + + <para><citerefentry> + <refentrytitle>bbstored</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbstored-config</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> diff --git a/docs/docbook/bbstored-certs.xml b/docs/docbook/bbstored-certs.xml new file mode 100644 index 00000000..79308089 --- /dev/null +++ b/docs/docbook/bbstored-certs.xml @@ -0,0 +1,180 @@ +<?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>bbstored-certs</refentrytitle> + + <manvolnum>8</manvolnum> + + <refmiscinfo class="manual">Box Backup</refmiscinfo> + + <refmiscinfo class="source">Box Backup</refmiscinfo> + + <refmiscinfo class="version">0.11</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>bbstored-certs</refname> + + <refpurpose>Manage certificates for the Box Backup system</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>bbstored-certs</command> + + <arg choice="plain">certs-dir</arg> + + <arg choice="plain">command</arg> + + <arg>arguments</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para><command>bbstored-certs</command> 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.</para> + + <para>All commands must be followed by the <varname>certs-dir</varname>, + which is the directory in which the certificates are stored.</para> + + <refsection> + <title>Commands</title> + + <para>There are 3 commands:</para> + + <variablelist> + <varlistentry> + <term><command>init</command></term> + + <listitem> + <para>Create the <varname>certs-dir</varname>, and generate the + server keys for bbstored. <varname>certs-dir</varname> cannot + exist before running the command.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>sign-server</command> + <varname>servercsrfile</varname></term> + + <listitem> + <para>Sign the server certificate. The + <varname>servercsrfile</varname> is the file generated by the + <command>init</command> command.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>sign</command> + <varname>clientcsrfile</varname></term> + + <listitem> + <para>Sign a client certificate. The + <varname>clientcsrfile</varname> is generated during client setup. + See <citerefentry> + <refentrytitle>bbackupd-config</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>. Send the signed certificate back to the client, + and install according to the instructions given by + <command>bbackupd-config</command>.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + </refsection> + + <refsection> + <title>Files</title> + + <para><citerefentry> + <refentrytitle>raidfile-config</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry> generates the <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry> file.</para> + </refsection> + + <refsection> + <title>Bugs</title> + + <para>If you find a bug in Box Backup, and you want to let us know about + it, join the <ulink + url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing + list</ulink>, and send a description of the problem there.</para> + + <para>To report a bug, give us at least the following information:</para> + + <itemizedlist> + <listitem> + <para>The version of Box Backup you are running</para> + </listitem> + + <listitem> + <para>The platform you are running on (hardware and OS), for both + client and server.</para> + </listitem> + + <listitem> + <para>If possible attach your config files (bbstored.conf, + bbackupd.conf) to the bug report.</para> + </listitem> + + <listitem> + <para>Also attach any log file output that helps shed light on the + problem you are seeing.</para> + </listitem> + + <listitem> + <para>And last but certainly not least, a description of what you are + seeing, in as much detail as possible.</para> + </listitem> + </itemizedlist> + </refsection> + + <refsection> + <title>See Also</title> + + <para><citerefentry> + <refentrytitle>bbstored-config</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbstored.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbstoreaccounts</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> diff --git a/docs/docbook/bbstored-config.xml b/docs/docbook/bbstored-config.xml new file mode 100644 index 00000000..6d0113c1 --- /dev/null +++ b/docs/docbook/bbstored-config.xml @@ -0,0 +1,148 @@ +<?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>bbstored-config</refentrytitle> + + <manvolnum>8</manvolnum> + + <refmiscinfo class="manual">Box Backup</refmiscinfo> + + <refmiscinfo class="source">Box Backup</refmiscinfo> + + <refmiscinfo class="version">0.11</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>bbstored-config</refname> + + <refpurpose>Box Backup store daemon configuration file + generator</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>bbstored-config</command> + + <arg choice="plain">configdir</arg> + + <arg choice="plain">servername</arg> + + <arg choice="plain">username</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>The bbstored-config script creates configuration files and server + certificates for a bbstored instance. It takes three parameters:</para> + + <variablelist> + <varlistentry> + <term>configdir</term> + + <listitem> + <para>The directory where config files will reside. A + <filename>bbstored</filename> subdirectory will be created where + several config files will reside. The + <filename>bbstored.conf</filename> file will be created in + <varname>configdir</varname>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>servername</term> + + <listitem> + <para>The name of the server that is being configured. Usually the + fully qualified domain name of the machine in question.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>username</term> + + <listitem> + <para>The name of the user that should be running the + <command>bbstored</command> process. Recommended name: + _bbstored.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>A valid <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry> must be found in configdir. Several steps are taken + during the run of <command>bbstored-config</command>:</para> + + <itemizedlist> + <listitem> + <para>Server certificates are created. This requires interaction from + the operator.</para> + </listitem> + + <listitem> + <para>The RAID volumes are checked to ensure that the configuration is + consistent and will work.</para> + </listitem> + + <listitem> + <para>Instructions for next steps to take are shown. These steps may + be different for different OS platforms, so pay close attention to + these instructions.</para> + </listitem> + </itemizedlist> + </refsection> + + <refsection> + <title>Files</title> + + <para><filename>/etc/box/bbstored.conf</filename></para> + </refsection> + + <refsection> + <title>See Also</title> + + <para><citerefentry> + <refentrytitle>bbstored.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbstored</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbstored-certs</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>raidfile-config</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> diff --git a/docs/docbook/bbstored.conf.xml b/docs/docbook/bbstored.conf.xml new file mode 100644 index 00000000..136b1bd0 --- /dev/null +++ b/docs/docbook/bbstored.conf.xml @@ -0,0 +1,211 @@ +<?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>bbstored.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>bbstored.conf</refname> + + <refpurpose>Box Backup store daemon configuration file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>/etc/box/bbstored.conf</command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>The following configuration options are valid:</para> + + <variablelist> + <varlistentry> + <term><varname>RaidFileConf</varname></term> + + <listitem> + <para>Specifies the path to the <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry>. This is normally + <filename>/etc/box/raidfile.conf</filename>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>AccountDatabase</varname></term> + + <listitem> + <para>Specifies the path to the account database created by + <citerefentry> + <refentrytitle>bbstoreaccounts</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>. This is usually + <filename>/etc/box/bbstored/accounts.txt</filename>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ExtendedLogging</varname></term> + + <listitem> + <para>Specifies whether extended logging should be enabled to show + what commands are being received from clients.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>TimeBetweenHousekeeping</varname></term> + + <listitem> + <para>How long between scanning for files which need + deleting.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>Server</varname></term> + + <listitem> + <para>These options relate to the actual daemon.<variablelist> + <varlistentry> + <term><varname>PidFile</varname></term> + + <listitem> + <para>The location of the pidfile, where the daemon's + process ID is kept.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>User</varname></term> + + <listitem> + <para>The user to run as.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ListenAddresses</varname></term> + + <listitem> + <para>The interface addresses to listen on. Hostnames may be + used instead of IP addresses. The format is: + <option>inet:hostname</option> or + <option>inet:10.0.0.1</option>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>CertificateFile</varname></term> + + <listitem> + <para>The path to the server's public certificate.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>PrivateKeyFile</varname></term> + + <listitem> + <para>The path to the server's private key. This should only + be readable by root and/or the <option>User</option>.</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> + </variablelist></para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + + <refsection> + <title>Examples</title> + + <para>The following is an example bbstored.conf:</para> + + <para><programlisting>RaidFileConf = /etc/box/raidfile.conf +AccountDatabase = /etc/box/bbstored/accounts.txt + +TimeBetweenHousekeeping = 900 + +Server +{ + PidFile = /var/run/bbstored.pid + User = _bbstored + ListenAddresses = inet:server.example.com + CertificateFile = /etc/box/bbstored/server.example.com-cert.pem + PrivateKeyFile = /etc/box/bbstored/server.example.com-key.pem + TrustedCAsFile = /etc/box/bbstored/clientCA.pem +}</programlisting></para> + </refsection> + + <refsection> + <title>Files</title> + + <para><filename>/etc/box/bbstored.conf</filename></para> + </refsection> + + <refsection> + <title>See Also</title> + + <para><citerefentry> + <refentrytitle>bbstored</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbstored-config</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>raidfile-config</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> diff --git a/docs/docbook/bbstored.xml b/docs/docbook/bbstored.xml new file mode 100644 index 00000000..81891a8d --- /dev/null +++ b/docs/docbook/bbstored.xml @@ -0,0 +1,90 @@ +<?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>bbstored</refentrytitle> + + <manvolnum>8</manvolnum> + + <refmiscinfo class="manual">Box Backup</refmiscinfo> + + <refmiscinfo class="source">Box Backup</refmiscinfo> + + <refmiscinfo class="version">0.11</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>bbstored</refname> + + <refpurpose>Box Backup store daemon</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>bbstored</command> + + <arg>config-file</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para><command>bbstored</command> runs on a central server. Clients + running <command>bbackupd</command> connect to the server and upload + files.</para> + + <para>The only argument is optional and specifies a non-default + configuration file. By default it will look for the configuration file as + <filename>/etc/box/bbstored.conf</filename>.</para> + </refsection> + + <refsection> + <title>Files</title> + + <para><filename>/etc/box/bbstored.conf</filename></para> + </refsection> + + <refsection> + <title>See Also</title> + + <para><citerefentry> + <refentrytitle>bbstored.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbstored-config</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>raidfile-config</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> + + <manvolnum>5</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> diff --git a/docs/docbook/html/bbdoc-man.css b/docs/docbook/html/bbdoc-man.css new file mode 100644 index 00000000..0345560e --- /dev/null +++ b/docs/docbook/html/bbdoc-man.css @@ -0,0 +1,104 @@ +body { + font-family: Verdana, Geneva, Arial, sans-serif; + background-color: #edeef3; + font-size: .75em; + line-height: 180%; + text-align: left; + margin-top: 20px; + margin-right: 100px; + margin-left: 250px; + position: relative; + width: auto; } + +table { + font-family: Verdana, Geneva, Arial, sans-serif; + background-color: #edeef3; + font-size: 10pt; + line-height: 100%; } + + +code { + font-size: 11pt; } + + + +div.navheader { + font-family: Verdana, Geneva, Arial, sans-serif; + background-color: #edeef3; + line-height: 100%; } + +#header { + background-color: #e4e6ed; + text-align: left; + padding-top: 10px; + margin-right: -100px; + margin-left: -250px; + top: 20px; + border-top: 1px solid #c4c4d5; + border-bottom: 1px solid white } + +#logo { + position: relative; + margin-left: 200px } + + +#page { + font-size: .75em; + line-height: 180%; + text-align: left; + margin-top: 50px; + margin-right: 100px; + margin-left: 250px; + position: relative; + width: auto } + +#disc { } + +.informaltable td,tr {font-size: 1em; + line-height: 140%; + text-align: left; + background-color: #e4e6ed; + padding: 4px } + +tr,td {font-size: 1em; + line-height: 100%; + background-color: #edeef3; } + +pre, tt { font-size: 1.3em; + color: #088; + letter-spacing: 1px; + word-spacing: 2px} + +h1 { + color: #c00; + font-size: 16pt; + margin-bottom: 2em; + margin-left: -50px } + +h2 { + color: #324e95; + font-size: 12pt; + margin-top: 2em; + margin-left: -50px } + +h3 { + color: #324e95; + font-size: 10pt; + margin-top: 2em; + margin-left: -50px } + +dt { font-weight: bold } + +a:link { + color: #324e95; + text-decoration: none; + background-color: transparent } + +a:visited { + color: #90c; + text-decoration: none } + +a:hover { + color: #c00; + text-decoration: underline; + background-color: transparent } diff --git a/docs/docbook/html/bbdoc.css b/docs/docbook/html/bbdoc.css new file mode 100644 index 00000000..d3b4a1c2 --- /dev/null +++ b/docs/docbook/html/bbdoc.css @@ -0,0 +1,112 @@ +body { + font-family: Verdana, Geneva, Arial, sans-serif; + background-color: #edeef3; + font-size: .75em; + line-height: 180%; + text-align: left; + margin-top: 20px; + margin-right: 100px; + margin-left: 250px; + position: relative; + width: auto; } + +table { + font-family: Verdana, Geneva, Arial, sans-serif; + background-color: #edeef3; + font-size: 10pt; + line-height: 100%; } + + + + +div.navheader { + font-family: Verdana, Geneva, Arial, sans-serif; + background-color: #edeef3; + line-height: 100%; } + +#header { + background-color: #e4e6ed; + text-align: left; + padding-top: 10px; + margin-right: -100px; + margin-left: -250px; + top: 20px; + border-top: 1px solid #c4c4d5; + border-bottom: 1px solid white } + +#logo { + position: relative; + margin-left: 200px } + + +#page { + font-size: .75em; + line-height: 180%; + text-align: left; + margin-top: 50px; + margin-right: 100px; + margin-left: 250px; + position: relative; + width: auto } + +#disc { } + +.informaltable td,tr {font-size: 1em; + line-height: 140%; + text-align: left; + background-color: #e4e6ed; + padding: 4px } + +tr,td {font-size: 1em; + line-height: 100%; + background-color: #edeef3; } + +pre, tt { font-size: 1.3em; + color: #088; + letter-spacing: 1px; + word-spacing: 2px} + +h1 { + color: #c00; + font-size: 16pt; + margin-bottom: 2em; + margin-left: -50px } + +h2 { + color: #324e95; + font-size: 12pt; + margin-top: 2em; + margin-left: -50px } + +h3 { + color: #324e95; + font-size: 10pt; + margin-top: 2em; + margin-left: -50px } + +dt { font-weight: bold } + +ul { + list-style-image: url(images/arrow.png) } + +ul li { + background-color: #e4e6ed; + margin: 1em 6em 1em -2em; + padding: 0.2em 0.5em 0.2em 1em; + border-style: solid; + border-width: 1px; + border-color: #c4c4d5 #fff #fff #c4c4d5 } + +a:link { + color: #324e95; + text-decoration: none; + background-color: transparent } + +a:visited { + color: #90c; + text-decoration: none } + +a:hover { + color: #c00; + text-decoration: underline; + background-color: transparent } diff --git a/docs/docbook/html/favicon.ico b/docs/docbook/html/favicon.ico Binary files differnew file mode 100644 index 00000000..f8cbb3b3 --- /dev/null +++ b/docs/docbook/html/favicon.ico diff --git a/docs/docbook/html/images/arrow.png b/docs/docbook/html/images/arrow.png Binary files differnew file mode 100644 index 00000000..4c60805d --- /dev/null +++ b/docs/docbook/html/images/arrow.png diff --git a/docs/docbook/html/images/bblogo.png b/docs/docbook/html/images/bblogo.png Binary files differnew file mode 100644 index 00000000..b33230b4 --- /dev/null +++ b/docs/docbook/html/images/bblogo.png diff --git a/docs/docbook/html/images/stepahead.png b/docs/docbook/html/images/stepahead.png Binary files differnew file mode 100644 index 00000000..9ac05b8c --- /dev/null +++ b/docs/docbook/html/images/stepahead.png diff --git a/docs/docbook/instguide.xml b/docs/docbook/instguide.xml new file mode 100644 index 00000000..addef297 --- /dev/null +++ b/docs/docbook/instguide.xml @@ -0,0 +1,766 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> +<book> + <title>Box Backup Build and Installation Guide</title> + + <preface> + <title>License</title> + + <para>Copyright © 2003 - 2007, Ben Summers and contributors. + All rights reserved.</para> + + <para>Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are + met:</para> + + <itemizedlist> + <listitem> + <para>Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer.</para> + </listitem> + + <listitem> + <para>Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following disclaimer + in the documentation and/or other materials provided with the + distribution.</para> + </listitem> + + <listitem> + <para>All use of this software and associated advertising materials + must display the following acknowledgement: This product includes + software developed by Ben Summers.</para> + </listitem> + + <listitem> + <para>The names of the Authors may not be used to endorse or promote + products derived from this software without specific prior written + permission.</para> + </listitem> + </itemizedlist> + + + <para>[Where legally impermissible the Authors do not disclaim liability + for direct physical injury or death caused solely by defects in the + software unless it is modified by a third party.]</para> + + <para>THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS + OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR + ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + POSSIBILITY OF SUCH DAMAGE.</para> + </preface> + + <chapter> + <title>Introduction</title> + + <para>The backup daemon, bbackupd, runs on all machines to be backed up. + The store server daemon, bbstored runs on a central server. Data is sent + to the store server, which stores all data on local filesystems, that is, + only on local hard drives. Tape or other archive media is not used.</para> + + <para>The system is designed to be easy to set up and run, and cheap to + use. Once set up, there should be no need for user or administrative + intervention, apart from usual system maintenance.</para> + + <section> + <title>Client daemon</title> + + <para>bbackupd is configured with a list of directories to back up. It + has a lazy approach to backing up data. Every so often, the directories + are scanned, and new data is uploaded to the server. This new data must + be over a set age before it is uploaded. This prevents rapid revisions + of a file resulting in many uploads of the same file in a short period + of time.</para> + + <para>It can also operate in a snapshot mode, which behaves like + traditional backup software. When instructed by an external bbackupctl + program, it will upload all changed files to the server.</para> + + <para>The daemon is always running, although sleeping most of the time. + In lazy mode, it is completely self contained -- scripts running under + cron jobs are not used. The objective is to keep files backed up, not to + make snapshots of the filesystem at particular points in time + available.</para> + + <para>If an old version of the file is present on the server, a modified + version of the rsync algorithm is used to upload only the changed + portions of the file.</para> + + <para>After a new version is uploaded, the old version is still + available (subject to disc space on the server). Similarly, a deleted + file is still available. The only limit to their availability is space + allocated to this account on the server</para> + + <para>Future versions will add the ability to mark the current state of + files on the server, and restore from this mark. This will emulate the + changing of tapes in a tape backup system.</para> + + <section> + <title>Restoration</title> + + <para>Restoring files is performed using a query tool, bbackupquery. + This can be used to restore entire directories, or as an 'FTP-like' + tool to list and retrieve individual files. Old versions and deleted + files can be retrieved using this tool for as long as they are kept on + the server.</para> + </section> + + <section> + <title>Client Resource Usage</title> + + <para>bbackupd uses only a minimal amount of disc space to store + records on uploaded files -- less than 32 bytes per directory and file + over a set size threshold. However, it minimises the amount of queries + it must make to the server by storing, in memory, a data structure + which allows it to determine what data is new. It does not need to + store a record of all files, essentially just the directory names and + last modification times. This is not a huge amount of memory.</para> + + <para>If there are no changes to the directories, then the client will + not even connect to the server.</para> + </section> + </section> + + <section> + <title>Security</title> + + <para>Box Backup is designed to be secure in several ways. The data + stored on the backup store server is encrypted using secret-key + cryptography. Additionally, the transport layer is encrypted using TLS, + to ensure that the communications can't be snooped.</para> + + <section> + <title>Encryption</title> + + <para>The files, directories, filenames and file attributes are all + encrypted. By examining the stored files on the server, it is only + possible to determine the approximate sizes of a files and the tree + structure of the disc (not names, just number of files and + subdirectories in a directory). By monitoring the actions performed by + a client, it is possible to determine the frequency and approximate + scope of changes to files and directories.</para> + + <para>The connections between the server and client are encrypted + using TLS (latest version of SSL). Traffic analysis is possible to + some degree, but limited in usefulness.</para> + + <para>An attacker will not be able to recover the backed up data + without the encryption keys. Of course, you won't be able to recover + your files without the keys either, so you must make a conventional, + secure, backup of these keys.</para> + </section> + + <section> + <title>Authentication</title> + + <para>SSL certificates are used to authenticate clients. UNIX user + accounts are not used to minimise the dependence on the configuration + of the operating system hosting the server.</para> + + <para>A script is provided to run the necessary certification + authority with minimal effort.</para> + </section> + </section> + + <section> + <title>Server daemon</title> + + <para>The server daemon is designed to be simple to deploy, and run on + the cheapest hardware possible. To avoid the necessity to use expensive + hardware RAID or software RAID with complex setup, it (optionally) + stores files using RAID techniques.</para> + + <para>It does not need to run as a privileged user.</para> + + <para>Each account has a set amount of disc space allocated, with a soft + and a hard limit. If the account exceeds the soft limit, a housekeeping + process will start deleting old versions and deleted files to reduce the + space used to below the soft limit. If the backup client attempts to + upload a file which causes the store to exceed the hard limit, the + upload will be refused.</para> + </section> + </chapter> + + <chapter> + <title>Building and installing</title> + + <section> + <title>Before you start</title> + + <para>Firstly, check that all the clocks on your clients, servers and + signing machines are accurate and in sync. A disagreement in time + between a client and a server is the biggest cause of installation + difficulties, as the times in the generated certificates will cause + login failures if the start date is in the future.</para> + </section> + + <section> + <title>Box Backup compile</title> + + <para>In the following instructions, replace 0.00 with the actual + version number of the archive you have downloaded.</para> + + <para>For help building on Windows, see the <link linkend="AppB">Windows + Compile Appendix</link>. And if you want to build a Linux RPM, <link + linkend="AppC">look here</link>.</para> + + <para>You need the latest version of OpenSSL, as some of the extra APIs + it provides are required. You should have this anyway, as earlier + versions have security flaws. (If you have an earlier version installed, + the configuration script will give you instructions on enabling + experimental support for older versions.)</para> + + <para>See <link linkend="AppA">OpenSSL notes</link> for more information + on OpenSSL issues.</para> + + <para>There are some notes in the archive about compiling on various + platforms within the boxbackup-0.00 directory -- read them first. For + example, if you are compiling under Linux, look for LINUX.txt as + boxbackup-0.00/LINUX.txt after untaring the archive.</para> + + <para>Download the archive, then in that directory type</para> + + <programlisting>tar xvzf boxbackup-0.00.tgz +cd boxbackup-0.00 +./configure +make</programlisting> + + <para>The server and client will be built and packaged up for + installation on this machine, or ready to be transferred as tar files to + another machine for installation.</para> + + <para>This builds two parcels of binaries and scripts, 'backup-client' + and 'backup-server'. The generated installation scripts assumes you want + everything installed in <emphasis + role="bold">/usr/local/bin</emphasis></para> + + <para>Optionally, type <emphasis role="bold">make test</emphasis> to run + all the tests.</para> + </section> + + <section> + <title>Local installation</title> + + <para>Type <emphasis role="bold">make install-backup-client</emphasis> + to install the backup client.</para> + + <para>Type <emphasis role="bold">make install-backup-server</emphasis> + to install the backup server.</para> + </section> + + <section> + <title>Remote installation</title> + + <para>In the parcels directory, there are tar files for each parcel. The + name reflects the version and platform you have built it for.</para> + + <para>Transfer this tar file to the remote server, and unpack it, then + run the install script. For example:</para> + + <programlisting>tar xvzf boxbackup-0.00-backup-server-OpenBSD.tgz +cd boxbackup-0.00-backup-server-OpenBSD +./install-backup-server</programlisting> + </section> + + <section> + <title>Configure options</title> + + <para>You can use arguments to the configure script to adjust the + compile and link lines in the generated Makefiles, should this be + necessary for your platform. The configure script takes the usual GNU + autoconf arguments, a full list of which can be obtained with <emphasis + role="bold">--help</emphasis>. Additional options for Box Backup + include:</para> + + <informaltable> + <tgroup cols="2"> + <tbody> + <row> + <entry char="-">--enable-gnu-readline</entry> + + <entry>Use GNU readline if present. Linking Box Backup against + GNU readline may create licence implications if you then + distribute the binaries. libeditline is also supported as a safe + alternative, and is used by default if available.</entry> + </row> + + <row> + <entry>--disable-largefile</entry> + + <entry>Omit support for large files</entry> + </row> + + <row> + <entry>--with-bdb-lib=DIR</entry> + + <entry>Specify Berkeley DB library location</entry> + </row> + + <row> + <entry>--with-bdb-headers=DIR</entry> + + <entry>Specify Berkeley DB headers location</entry> + </row> + + <row> + <entry>--with-random=FILE</entry> + + <entry>Use FILE as random number seed (normally + auto-detected)</entry> + </row> + + <row> + <entry>--with-tmp-dir=DIR</entry> + + <entry>Directory for temporary files (normally /tmp)</entry> + </row> + </tbody> + </tgroup> + </informaltable> + + <para>See <link linkend="AppA">OpenSSL notes</link> for the OpenSSL + specific options.</para> + </section> + + <section> + <title>Tests</title> + + <para>There are a number of unit tests provided. To compile and run one + type:</para> + + <programlisting>./runtest.pl bbackupd release +./runtest.pl common debug +./runtest.pl ALL</programlisting> + + <para>The runtest.pl script will compile and run the test. The first + argument is the test name, and the second the type of build. Use ALL as + a test name to run all the tests.</para> + + <para>The output from the tests is slightly muddled using this script. + If you're developing, porting or trying out new things, it might be + better to use the following scheme:</para> + + <programlisting>cd test/bbackupd +make +cd ../../debug/test/bbackupd +./t</programlisting> + + <para>or in release mode...</para> + + <programlisting>cd test/bbackupd +make -D RELEASE +cd ../../release/test/bbackupd +./t</programlisting> + + <para>(use RELEASE=1 with GNU make)</para> + + <para>I tend to use two windows, one for compilation, and one for + running tests.</para> + </section> + </chapter> + + <appendix> + <title id="AppA">Box Backup and SSL</title> + + <section> + <title>General notes</title> + + <para>Ideally, you need to use version 0.9.7 or later of OpenSSL. If + this is installed on your system by default (and it is on most recent + releases of UNIX like OSes) then everything should just work.</para> + + <para>However, if it isn't, you have a few options.</para> + + <section> + <title>Upgrade your installation</title> + + <para>The best option is to upgrade your installation to use 0.9.7. + Hopefully your package manager will make this easy for you. This may + require reinstallation of lots of software which depends on OpenSSL, + so may not be ideal.</para> + + <para>(But as there have been a few security flaws in OpenSSL + recently, you probably want to upgrade it anyway.)</para> + </section> + + <section> + <title>Install another OpenSSL</title> + + <para>The second best option is to install another copy. If you + download and install from source, it will probably install into + /usr/local/ssl. You can then configure Box Backup to use it + using:</para> + + <programlisting>./configure --with-ssl-headers=/usr/local/ssl/include --with-ssl-lib=/usr/local/ssl/lib</programlisting> + + <para>which will set up the various includes and libraries for + you.</para> + + <para>The configuration scripts may be a problem, depending on your + installation. See below for more information.</para> + </section> + + <section> + <title>Use the old version of OpenSSL</title> + + <para>If you have an old version installed, the configuration script + will give you instructions on how to enable support for older + versions. Read the warnings, and please, whatever you do, don't + release binary packages or ports which enable this option.</para> + + <para>You may have issues with the configuration scripts, see + below.</para> + </section> + </section> + + <section> + <title>If you have problems with the config scripts</title> + + <para>If you get OpenSSL related errors with the configuration scripts, + there are two things to check:</para> + + <itemizedlist> + <listitem> + <para>The bin directory within your OpenSSL directory is in the path + (if you have installed another version)</para> + </listitem> + + <listitem> + <para>You have an openssl.cnf file which works and can be + found.</para> + </listitem> + </itemizedlist> + + <section> + <title>OpenSSL config file</title> + + <para>You need to have an openssl.cnf file. The default will generally + work well (see example at end). Make sure the openssl utility can find + it, either set the OPENSSL_CONF environment variable, or install it + into the location that is mentioned in the error messages.</para> + + <para>Example OpenSSL config file:</para> + + <programlisting id="openssl.cnf" xreflabel="openssl.cnf"># +# OpenSSL example configuration file. +# This is mostly being used for generation of certificate requests. +# + +RANDFILE = /dev/arandom + +#################################################################### +[ req ] +default_bits = 1024 +default_keyfile = privkey.pem +distinguished_name = req_distinguished_name +attributes = req_attributes + +[ req_distinguished_name ] +countryName = Country Name (2 letter code) +#countryName_default = AU +countryName_min = 2 +countryName_max = 2 + +stateOrProvinceName = State or Province Name (full name) +#stateOrProvinceName_default = Some-State + +localityName = Locality Name (eg, city) + +0.organizationName = Organization Name (eg, company) +#0.organizationName_default = Internet Widgits Pty Ltd + +# we can do this but it is not needed normally :-) +#1.organizationName = Second Organization Name (eg, company) +#1.organizationName_default = CryptSoft Pty Ltd + +organizationalUnitName = Organizational Unit Name (eg, section) +#organizationalUnitName_default = + +commonName = Common Name (eg, fully qualified host name) +commonName_max = 64 + +emailAddress = Email Address +emailAddress_max = 64 + +[ req_attributes ] +challengePassword = A challenge password +challengePassword_min = 4 +challengePassword_max = 20 + +unstructuredName = An optional company name + +[ x509v3_extensions ] + +nsCaRevocationUrl = http://www.cryptsoft.com/ca-crl.pem +nsComment = "This is a comment" + +# under ASN.1, the 0 bit would be encoded as 80 +nsCertType = 0x40</programlisting> + </section> + </section> + </appendix> + + <appendix> + <title id="AppB">Compiling bbackupd on Windows using Visual C++</title> + + <para>This Appendix explains how to build the bbackupd daemon for Windows + using the Visual C++ compiler.</para> + + <para>If you have any problems following these instructions, please sign + up to the <ulink + url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing + lis</ulink>t and report them to us, or send an email to <ulink + url="mailto:bbwiki@qwirx.com">Chris Wilson</ulink>. Thanks!</para> + + <para><emphasis role="bold">Note</emphasis>: bbstored will not be built + with this process. bbstored is not currently supported on Windows. There + are no plans for bbstored support on Windows.</para> + + <section> + <title>Tools</title> + + <para>You will need quite a bit of software to make this work. All of it + is available for free on the Internet, although Visual C++ Express has + license restrictions and a time limit.</para> + + <section> + <title>Visual C++</title> + + <para>Microsoft's Visual C++ compiler and development environment are + part of their commercial product <ulink + url="http://msdn.microsoft.com/vstudio/">Visual Studio</ulink>. Visual + Studio 2005 is supported, and 2003 should work as well.</para> + + <para>You can also <ulink + url="http://msdn.microsoft.com/vstudio/express/visualc/download/">download</ulink> + a free copy of Visual C++ 2005 Express. This copy must be registered + (activated) within 30 days, and is free for one year.</para> + + <para>You will need the <ulink + url="http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/">Platform + SDK</ulink> to allow you to compile Windows applications.</para> + </section> + + <section> + <title>Perl</title> + + <para>Download and install <ulink + url="http://www.activestate.com/Products/ActivePerl/">ActivePerl for + Windows</ulink>, which you can probably find <ulink + url="http://downloads.activestate.com/ActivePerl/Windows/5.6/ActivePerl-5.6.1.638-MSWin32-x86.msi">here</ulink>.</para> + </section> + + <section> + <title>Libraries</title> + + <para>You will need to download and install several libraries. They + must all be built in the same directory, to be able to link + properly.</para> + + <para>Choose a directory where you will unpack and compile OpenSSL, + Zlib and Box Backup. We will call this the base directory. An example + might be:</para> + + <programlisting>C:\Documents and Settings\Your Username\Desktop\Box</programlisting> + + <para>Make sure you know the full path to this directory.</para> + + <section> + <title>OpenSSL</title> + + <para>You will need to compile OpenSSL using Visual C++. The latest + release at this time, OpenSSL 0.9.8a, does not compile with Visual + C++ 2005 out of the box, so you need <ulink + url="http://www.boxbackup.org/svn/box/chris/win32/support/openssl-0.9.8a-vc2005.zip">a + patched version</ulink>. The <ulink + url="http://www.openssl.org/source/openssl-0.9.8a.tar.gz">original + source</ulink> and <ulink + url="http://www.boxbackup.org/svn/box/chris/win32/support/openssl-0.9.8a-win32fix.patch">patch</ulink> + are also available.</para> + + <para>To compile OpenSSL:</para> + + <itemizedlist> + <listitem> + <para>Use a Windows unzipper such as <ulink + url="http://www.winzip.com/">WinZip (free trial)</ulink> to + extract the <emphasis + role="bold">openssl-0.9.8a-vc2005.tar.gz</emphasis> archive, + which you just downloaded, into the base directory.</para> + </listitem> + + <listitem> + <para>Rename the folder from <emphasis + role="bold">openssl-0.9.8a-vc2005</emphasis> to <emphasis + role="bold">openssl</emphasis></para> + </listitem> + + <listitem> + <para>Open a command shell (run <emphasis + role="bold">cmd.exe</emphasis>) and <emphasis + role="bold">cd</emphasis> to the openssl directory</para> + </listitem> + + <listitem> + <para>Run the following commands:</para> + + <programlisting>perl Configure VC-WIN32 +ms\do_ms +"c:\program files\Microsoft Visual Studio 8\Common7\Tools\vsvars32.bat" +nmake -f ms\ntdll.mak</programlisting> + </listitem> + </itemizedlist> + </section> + + <section> + <title>Zlib</title> + + <para>You will need to download the <ulink + url="http://www.zlib.net/zlib123-dll.zip">Zlib compiled DLL</ulink>. + Create a directory called <emphasis role="bold">zlib</emphasis> in + the base directory, and unzip the file you just downloaded into that + directory. You don't need to compile anything.</para> + </section> + </section> + + <section> + <title>Download Box Backup</title> + + <para>The first version of Box Backup that's known to compile and with + Visual C++ 2005 is available on the <ulink + url="http://www.boxbackup.org/svn/box/chris/win32/vc2005-compile-fixes/">Subversion + server</ulink>. However, this version has not been extensively tested + and may be out of date.</para> + + <para>The changes are expected to be merged into the <ulink + url="http://www.boxbackup.org/svn/box/trunk">Subversion trunk</ulink> + at some point, and this page should then be updated. If in doubt, + please sign up to the <ulink + url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing + list</ulink> and ask us.</para> + + <para>To get the source code out of Subversion you will need a <ulink + url="http://subversion.tigris.org/files/documents/15/25364/svn-1.2.3-setup.exe">Subversion + client for Windows</ulink>. After installing it, open a new command + prompt, go to the base directory, and type:</para> + + <programlisting>svn co http://www.boxbackup.org/svn/box/chris/win32/vc2005-compile-fixes/ boxbackup</programlisting> + + <para>This should create a directory called <emphasis + role="bold">boxbackup</emphasis> inside the base directory.</para> + </section> + + <section> + <title>Configure Box Backup</title> + + <para>Open a command prompt, change to the base directory then + <emphasis role="bold">boxbackup</emphasis>, and run <emphasis + role="bold">win32.bat</emphasis> to configure the sources. Otherwise, + Visual C++ will complain about missing files whose names start with + <emphasis role="bold">autogen</emphasis>, and missing <emphasis + role="bold">config.h</emphasis>.</para> + </section> + + <section> + <title>Compile Box Backup</title> + + <para>Open Visual C++. Choose "File/Open/Project", navigate to the + base directory, then to <emphasis + role="bold">boxbackup\infrastructure\msvc\2005</emphasis> (or + <emphasis role="bold">2003</emphasis> if using Visual Studio 2003), + and open any project or solution file in that directory.</para> + + <para>Press F7 to compile Box Backup. If the compilation is + successful, <emphasis + role="bold">boxbackup\Debug\bbackupd.exe</emphasis> will be + created.</para> + </section> + + <section> + <title>Install Box Backup</title> + + <para>Create the destination directory, <emphasis + role="bold">C:\Program Files\Box Backup\bbackupd</emphasis>.</para> + + <para>Write a configuration file, keys and certificate on a Unix + machine, and copy them into the <emphasis role="bold">Box + Backup</emphasis> directory, together with the following files from + the base directory:</para> + + <itemizedlist> + <listitem> + <para>boxbackup\Debug\bbackupd.exe</para> + </listitem> + + <listitem> + <para>openssl\out32dll\libeay32.dll</para> + </listitem> + + <listitem> + <para>openssl\out32dll\ssleay32.dll</para> + </listitem> + + <listitem> + <para>zlib\zlib1.dll</para> + </listitem> + </itemizedlist> + + <para>Ensure that the user running Box Backup can read from the + <emphasis role="bold">Box Backup</emphasis> directory, and write to + the <emphasis role="bold">bbackupd</emphasis> directory inside + it.</para> + + <para>Run Box Backup by double-clicking on it, and check that it + connects to the server. If the window opens and closes immediately, + it's probably due to a problem with the configuration file - check the + Windows Event Viewer for details.</para> + </section> + + <section> + <title>Windows Service</title> + + <para>Box Backup can also run as a Windows service, in which case it + will be automatically started at boot time in the background. To + install this, open a command prompt, and run:</para> + + <programlisting>cd "C:\Program Files\Box Backup" +bbackupd.exe -i</programlisting> + + <para>This should output Box Backup service installed.</para> + </section> + </section> + </appendix> + + <appendix> + <title id="AppC">Compilation and installation by building an RPM on + Linux</title> + + <para>It is very easy to build an RPM of Box Backup on Linux platforms. + This should work on all Red Hat distributions (including Fedora), SuSE, + and probably others too.</para> + + <para>Given that you have the correct development packages installed + simply execute this command (replacing the version number):</para> + + <programlisting>rpmbuild -ta boxbackup-0.00.tgz</programlisting> + + <para>rpmbuild will report where the packages have been written to, and + these can be installed in the normal manner.</para> + + <para>If you have never built an RPM before you should set up a convenient + build area as described in the <ulink + url="http://www.rpm.org/max-rpm/s1-rpm-anywhere-different-build-area.html">RPM + book</ulink>.</para> + + <para>If you wish to customise the package you can find the spec file in + the contrib/rpm directory.</para> + </appendix> +</book> diff --git a/docs/docbook/raidfile-config.xml b/docs/docbook/raidfile-config.xml new file mode 100644 index 00000000..78a3e94c --- /dev/null +++ b/docs/docbook/raidfile-config.xml @@ -0,0 +1,198 @@ +<?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>raidfile-config</refentrytitle> + + <manvolnum>8</manvolnum> + + <refmiscinfo class="manual">Box Backup</refmiscinfo> + + <refmiscinfo class="source">Box Backup</refmiscinfo> + + <refmiscinfo class="version">0.11</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>raidfile-config</refname> + + <refpurpose>Configure Box Backup's RAID files</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>raidfile-config</command> + + <arg choice="plain">config-dir</arg> + + <arg choice="plain">blocksize</arg> + + <arg choice="plain">dir1 <arg>dir2 <arg>dir3</arg></arg></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>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) <ulink + url="http://en.wikipedia.org/wiki/Redundant_array_of_independent_disks#RAID_5">here</ulink>.</para> + + <refsection> + <title>Parameters</title> + + <para>The parameters are as follows:</para> + + <variablelist> + <varlistentry> + <term><varname>config-dir</varname></term> + + <listitem> + <para>The directory path where configuration files are located. + Usually this is <filename>/etc/box</filename>. + <filename>raidfile.conf</filename> will be written in this + directory.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>blocksize</varname></term> + + <listitem> + <para>The block size used for file storage in the system, in + bytes. Using a multiple 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.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>dir1</varname></term> + + <listitem> + <para>The first directory in the built-in RAID array.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>dir2</varname></term> + + <listitem> + <para>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 if you have a + hardware RAID solution or if you're using another type of software + RAID (like md on Linux).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>dir3</varname></term> + + <listitem> + <para>The third directory in the built-in RAID array. The same + notes that apply to <varname>dir2</varname> also apply to + <varname>dir3</varname>.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>Note that there are currently no way to add multiple disk sets to + the raidfile.conf file using command line tools, etc. See <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry> for details on adding more disks.</para> + </refsection> + </refsection> + + <refsection> + <title>Bugs</title> + + <para>If you find a bug in Box Backup, and you want to let us know about + it, join the <ulink + url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing + list</ulink>, and send a description of the problem there.</para> + + <para>To report a bug, give us at least the following information:</para> + + <itemizedlist> + <listitem> + <para>The version of Box Backup you are running</para> + </listitem> + + <listitem> + <para>The platform you are running on (hardware and OS), for both + client and server.</para> + </listitem> + + <listitem> + <para>If possible attach your config files (bbstored.conf, + bbackupd.conf) to the bug report.</para> + </listitem> + + <listitem> + <para>Also attach any log file output that helps shed light on the + problem you are seeing.</para> + </listitem> + + <listitem> + <para>And last but certainly not least, a description of what you are + seeing, in as much detail as possible.</para> + </listitem> + </itemizedlist> + </refsection> + + <refsection> + <title>Files</title> + + <para><command>raidfile-config</command> generates the <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry> file.</para> + </refsection> + + <refsection> + <title>See Also</title> + + <para><citerefentry> + <refentrytitle>bbstored-config</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbstored.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> + + <manvolnum>5</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> diff --git a/docs/docbook/raidfile.conf.xml b/docs/docbook/raidfile.conf.xml new file mode 100644 index 00000000..7a8b6410 --- /dev/null +++ b/docs/docbook/raidfile.conf.xml @@ -0,0 +1,143 @@ +<?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>raidfile.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>raidfile.conf</refname> + + <refpurpose>Userland RAID for Box Backup</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>/etc/box/raidfile.conf</command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>The raidfile.conf is usually generated by <citerefentry> + <refentrytitle>raidfile-config</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry> but may be manually edited if the store locations move + or if more than one disc set is required.</para> + + <para><variablelist> + <varlistentry> + <term>disc<varname>X</varname></term> + + <listitem> + <para>Specifies a set of discs.</para> + + <para><variablelist> + <varlistentry> + <term><varname>SetNumber</varname></term> + + <listitem> + <para>The set number of the RAID disc, referenced by each + account.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>BlockSize</varname></term> + + <listitem> + <para>The block size of the file system (usually 2048). + Under BSD with FFS, set this to your file system's + fragment size (most likely an 8th of the block + size).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>Dir0</varname></term> + + <listitem> + <para>The first directory in the RAID array.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>Dir1</varname></term> + + <listitem> + <para>The second directory in the RAID array. If you do + not wish to use the built-in RAID functionality, this + field should be set to the same as + <varname>Dir0</varname>. You should not use the built-in + RAID if you have a hardware RAID solution or if you're + using another type of software RAID (like md on + Linux).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>Dir2</varname></term> + + <listitem> + <para>The third directory in the RAID array. The same + notes that apply to <varname>Dir2</varname> also apply to + <varname>Dir3</varname>.</para> + </listitem> + </varlistentry> + </variablelist></para> + </listitem> + </varlistentry> + </variablelist></para> + </refsection> + + <refsection> + <title>Files</title> + + <para><filename>/etc/box/raidfile.conf</filename></para> + </refsection> + + <refsection> + <title>See Also</title> + + <para><citerefentry> + <refentrytitle>raidfile-config</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbstored.conf</refentrytitle> + + <manvolnum>5</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> diff --git a/docs/images/bblogo-alpha.xcf b/docs/images/bblogo-alpha.xcf Binary files differnew file mode 100644 index 00000000..18f494f9 --- /dev/null +++ b/docs/images/bblogo-alpha.xcf diff --git a/docs/tools/generate_except_xml.pl b/docs/tools/generate_except_xml.pl new file mode 100644 index 00000000..38ee9074 --- /dev/null +++ b/docs/tools/generate_except_xml.pl @@ -0,0 +1,74 @@ +#!/usr/bin/perl -w +use strict; + +open (EXCEPT, "< $ARGV[0]") or die "Can't open $ARGV[0]: $!\n"; +open (DOCBOOK, "> $ARGV[1]") or die "Can't open $ARGV[1] for writing: $!\n"; + +print DOCBOOK <<EOD; +<?xml version="1.0" encoding="UTF-8"?> + +<appendix> + <title>Exception codes</title> + +EOD +my $sectionName; +my $sectionNum; +my $sectionDesc; +my $exceptionCode; +my $exceptionShortDesc; +my $exceptionLongDesc; +while(<EXCEPT>) +{ + next if(m/^#/); + chomp; + if(m/^EXCEPTION TYPE (\w+) (\d+)/) + { + $sectionName = ucfirst(lc($1)); + $sectionNum = $2; + if($sectionName ne "Common") + { + $sectionDesc = "the " . $sectionName; + } + else + { + $sectionDesc = "any"; + } + print DOCBOOK <<EOD; + <section> + <title>$sectionName Exceptions ($sectionNum)</title> + + <para>These are exceptions that can occur in $sectionDesc module + of the system.</para> + + <itemizedlist> +EOD + } + + # The END TYPE line + if(m/^END TYPE$/) + { + print DOCBOOK " </itemizedlist>\n </section>\n"; + } + + # The actual exceptions + if(m/(\(\d+\/\d+\)) - (\w+ \w+)(?: - )?(.*)$/) + { + $exceptionCode = $1; + $exceptionShortDesc = $2; + $exceptionLongDesc = $3; + + print DOCBOOK " <listitem>\n <para><emphasis role=\"bold\">"; + print DOCBOOK $exceptionCode . ": " . $exceptionShortDesc . "</emphasis>"; + if($exceptionLongDesc ne "") + { + print DOCBOOK " -- " . $exceptionLongDesc; + } + print DOCBOOK "</para>\n </listitem>\n"; + } +} + +print DOCBOOK "</appendix>\n"; + +close EXCEPT; +close DOCBOOK; + |
