From: Kern Sibbald Date: Wed, 1 Jun 2005 10:17:53 +0000 (+0000) Subject: Minor doc changes + add two new screenshots X-Git-Tag: Release-1.38.0~403 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=ffb90de90c70a8bc89328b4ed889fbba49e53b42;p=bacula%2Fdocs Minor doc changes + add two new screenshots for Source Forge --- diff --git a/docs/images/wx-console-restore1.png b/docs/images/wx-console-restore1.png new file mode 100644 index 00000000..a28dd048 Binary files /dev/null and b/docs/images/wx-console-restore1.png differ diff --git a/docs/images/wx-console-restore2.png b/docs/images/wx-console-restore2.png new file mode 100644 index 00000000..f20485b3 Binary files /dev/null and b/docs/images/wx-console-restore2.png differ diff --git a/docs/manual/faq.tex b/docs/manual/faq.tex index fc6f6ca1..6d779c8f 100644 --- a/docs/manual/faq.tex +++ b/docs/manual/faq.tex @@ -116,7 +116,7 @@ of known bugs and solutions. worked, you might try restarting the Bacula service since Windows frequently encounters networking connection problems. - Here is sort of a picture of what names/passwords in which files/Resources + Here is a picture that indicates what names/passwords in which files/Resources must match up: \includegraphics{./Conf-Diagram.eps} @@ -127,6 +127,12 @@ of known bugs and solutions. should be found in the Console, Storage daemon (SD), and File daemon (FD) configuration files. + Another thing to check is to ensure that the Bacula component you are + trying to access has {\bf Maximum Concurrent Jobs} set large enough to + handle each of the Jobs and the Console that want to connect + simultaneously. Once the maximum connections has been reached, each + Bacula component will reject all new connections. + \label{AccessProblems} \item [Bacula Runs Fine but Cannot Access a Client on a Different Machine. diff --git a/docs/manual/general.tex b/docs/manual/general.tex index 18b87e79..1d2c0ed7 100644 --- a/docs/manual/general.tex +++ b/docs/manual/general.tex @@ -29,12 +29,19 @@ not have offsetting experience with a sophisticated backup package, we do not recommend using Bacula as it is much more difficult to setup and use than {\bf tar} or {\bf dump}. +If you want Bacula to behave like the above mentioned simple +programs and write over any tape that you put in the drive, then you will find +working with Bacula difficult. Bacula is designed to protect your data +following the rules you specify, and this means reusing a tape only +as the last resort. It is possible to ``force'' Bacula to write +over any tape in the drive, but it is easier and more efficient to use a +simpler program for that kind of operation. + If you are running {\bf Amanda} and would like a backup program that can write to multiple volumes (i.e. is not limited by your tape drive capacity), Bacula can most likely fill your needs. In addition, quite a number of our users report that Bacula is simpler to setup and use than other equivalent programs. - If you are currently using a sophisticated commercial package such as Legato Networker. ARCserveIT, Arkeia, or PerfectBackup+, you may be interested in Bacula, which provides many of the same features, and is free software @@ -118,8 +125,9 @@ the current Bacula implementation interfaces only to MySQL, PostgreSQL and SQLite. For more details see the \ilink{Catalog Services Design Document}{_ChapterStart30}. -The RPMs for MySQL and PostgreSQL ship as part of the Linux RedHat release, -or building it from the source is quite easy, see the +The RPMs for MySQL and PostgreSQL ship as part of the Linux RedHat +and several other releases, or building the rpms from the source is +quite easy, see the \ilink{ Installing and Configuring MySQL}{_ChapterStart} chapter of this document for the details. For more information on MySQL, please see: \elink{www.mysql.com}{http://www.mysql.com}. Or see the @@ -171,7 +179,7 @@ partially implemented. If you are reading this manual as supplied in a released version of the software, the above paragraph holds true. If you are reading the online version of the manual, -\elink{ www.bacula.org/manual}{http://www.bacula.org/manual}, please bear in +\elink{ www.bacula.org}{http://www.bacula.org}, please bear in mind that this version describes the current version in development (in the CVS) that may contain features not in the released version. Just the same, it generally lags behind the code a bit. @@ -203,16 +211,16 @@ definitions of the terminology that we use. \item [Administrator] \index[fd]{Administrator } - The person or persons responsible for administrating the Bacula system. + The person or persons responsible for administrating the Bacula system. \item [Backup] \index[fd]{Backup } - We use the term {\bf Backup} to refer to a Bacula Job that saves files. + We use the term {\bf Backup} to refer to a Bacula Job that saves files. \item [Bootstrap File] \index[fd]{Bootstrap File } The bootstrap file is an ASCII file containing a compact form of commands -that allow Bacula or the stand-alone file extraction utility ({\bf bextract}) +that allow Bacula or the stand-alone file extraction utility ({\bf bextract}) to restore the contents of one or more Volumes, for example, the current state of a system just backed up. With a bootstrap file, Bacula can restore your system without a Catalog. You can create a bootstrap file from a Catalog @@ -227,7 +235,7 @@ were run, their status as well as the important characteristics of each file that was backed up. The Catalog is an online resource, but does not contain the data for the files backed up. Most of the information stored in the catalog is also stored on the backup volumes (i.e. tapes). Of course, the -tapes will also have a copy of the file in addition to the File Attributes +tapes will also have a copy of the file data in addition to the File Attributes (see below). The catalog feature is one part of Bacula that distinguishes it from simple @@ -253,9 +261,9 @@ systems, daemons are called {\bf Services}. \item [Directive] \index[fd]{Directive } - The term directive is used to refer to a statement or a record within a + The term directive is used to refer to a statement or a record within a Resource in a configuration file that defines one specific thing. For -example, the {\bf Name} directive defines the name of the Resource. +example, the {\bf Name} directive defines the name of the Resource. \item [Director] \index[fd]{Director } @@ -317,9 +325,10 @@ system administrator to monitor Bacula status. \item [Resource] \index[fd]{Resource } - A resource is a part of a configuration file that defines a specific unit of -information that is available to Bacula. For example, the {\bf Job} resource -defines all the properties of a specific Job: name, schedule, Volume pool, + A resource is a part of a configuration file that defines a specific unit of +information that is available to Bacula. It consists of several directives +(individual configuation statements). For example, the {\bf Job} resource +defines all the properties of a specific Job: name, schedule, Volume pool, backup type, backup level, ... \item [Restore] @@ -391,7 +400,7 @@ on an Archived Volume are removed from the Catalog. NOT YET IMPLEMENTED. \item [*Update] \index[fd]{*Update } - An Update operation causes the files on the remote system to be updated to be + An Update operation causes the files on the remote system to be updated to be the same as the host system. This is equivalent to an {\bf rdist} capability. NOT YET IMPLEMENTED. @@ -467,7 +476,7 @@ Bacula} can be a central component of your disaster recovery system. For example, if you have created an emergency boot disk, a Bacula Rescue disk to save the current partitioning information of your hard disk, and maintain a complete Bacula backup, it is possible to completely recover your system from -``bare metal''. +``bare metal'' that is starting from an empty disk. If you have used the {\bf WriteBootstrap} record in your job or some other means to save a valid bootstrap file, you will be able to use it to extract diff --git a/docs/manual/restore.tex b/docs/manual/restore.tex index 3d930b53..2c2ef406 100644 --- a/docs/manual/restore.tex +++ b/docs/manual/restore.tex @@ -522,19 +522,32 @@ entries properly restored. \addcontentsline{toc}{subsection}{Restoring on Windows} If you are restoring on WinNT/2K/XP systems, Bacula will restore the files -with the original ownerships and permissions as would be expected. This is +with the original ownerships and permissions as would be expected. This is also true if you are restoring those files to an alternate directory (using -the Where option in restore). However, if the alternate directory does not -already exist, the Bacula File daemon (Client) will create it, and since the -File daemon runs under the SYSTEM account, the directory will be created with -SYSTEM ownership and permissions. In this case, you may have problems -accessing the newly restored files. - -To avoid this problem, you can create the alternate directory before doing the +the Where option in restore). However, if the alternate directory does not +already exist, the Bacula File daemon (Client) will try to create it. In +some cases, it may not create the directories, and if it does since the +File daemon runs under the SYSTEM account, the directory will be created +with SYSTEM ownership and permissions. In this case, you may have problems +accessing the newly restored files. + +To avoid this problem, you should create any alternate directory before doing the restore. Bacula will not change the ownership and permissions of the directory if it is already created as long as it is not one of the directories being restored (i.e. written to tape). +The default restore location is {\bf /tmp/bacula-restores/} and if you are +restoring from drive {\bf E:}, the default will be +{\bf /tmp/bacula-restores/e/}, so you should ensure that this directory +exists before doing the restore, or use the {\bf mod} option to +select a different {\bf where} directory that does exist. + +Some users have experienced problems restoring files that participate in +the Active Directory. They also report that changing the userid under which +Bacula (bacula-fd.exe) runs, from SYSTEM to a Domain Admin userid, resolves +the problem. + + \subsection*{Restoring Files Can Be Slow} \index[general]{Slow!Restoring Files Can Be } \index[general]{Restoring Files Can Be Slow } diff --git a/docs/manual/thanks.tex b/docs/manual/thanks.tex index c1ed19c9..1bc942ab 100644 --- a/docs/manual/thanks.tex +++ b/docs/manual/thanks.tex @@ -51,11 +51,22 @@ code and for contributing it to the Bacula project. Thanks to Nicolas Boichat for writing wx-console and the bacula-tray-monitor. These are very nice GUI additions to Bacula. +Thanks to Thorsten Engel for his excellent knowledge of Win32 systems, and +for making the Win32 File daemon Unicode compatible, as well as making +the Win32 File daemon interface to Microsoft's Volume Shadow Copy (VSS). +These two are big pluses for Bacula! + Thanks to Nic Bellamy for providing the bacula-dir.conf file that he uses to implement daily tape rotation using multiple Pools. Thanks to Johan Decock for providing numerous corrections to the manual. +Thanks also to Jo Simoens for finding and correcting so many typos and +other problems with the manual. + +Thanks to Arno Lehmann for his excellent and infatigable help and advice +to users. + Thanks to all the Bacula users, especially those of you who have contributed ideas, bug reports, patches, and new features. diff --git a/docs/manual/tls.tex b/docs/manual/tls.tex index 046fc0f9..a5089922 100644 --- a/docs/manual/tls.tex +++ b/docs/manual/tls.tex @@ -46,11 +46,11 @@ Enable TLS support. Require TLS connections. \item [TLS Certificate = \lt{}Directory\gt{}] -Path to PEM encoded TLS certificate. Used as either a client or server -certificate. +Path to a PEM encoded TLS certificate. It can be used as either a client +or server certificate. \item [TLS Key = \lt{}Directory\gt{}] -Path to PEM encoded TLS private key. Must correspond with the TLS +Path to a PEM encoded TLS private key. It must correspond to the TLS certificate. \item [TLS Verify Peer = \lt{}yes|no\gt{}] @@ -60,9 +60,9 @@ will be accepted unless the TLS Allowed CN configuration directive is used. Not valid in a client context. \item [TLS Allowed CN = \lt{}string list\gt{}] -Common name attribute of allowed peer certificates. If directive is +Common name attribute of allowed peer certificates. If this directive is specified, all client certificates will be verified against this list. -This directive may be specified more than once. Not valid in a client +This directive may be specified more than once. It is not valid in a client context. \item [TLS CA Certificate File = \lt{}Directory\gt{}] @@ -96,29 +96,14 @@ context. To generate the parameter file, you may use openssl: \index[general]{Certificate!Creating a Self-signed } \addcontentsline{toc}{subsection}{Creating a Self-signed Certificate} -You may create a self-signed certificate for use with the Bacula TLS -that will permit -you to make it function, but will not allow certificate validation. The .pem -file containing both the certificate and the key can be made with the -following, which I put in a file named {\bf makepem}: +You may create a self-signed certificate for use with the Bacula TLS that +will permit you to make it function, but will not allow certificate +validation. The .pem file containing both the certificate and the key +valid for 10 years can be made with the following: \footnotesize \begin{verbatim} -#!/bin/sh -# -# Simple shell script to make a .pem file that can be used -# with stunnel and Bacula -# -OPENSSL=openssl - umask 77 - PEM1=`/bin/mktemp openssl.XXXXXX` - PEM2=`/bin/mktemp openssl.XXXXXX` - ${OPENSSL} req -newkey rsa:1024 -keyout $PEM1 -nodes \ - -x509 -days 365 -out $PEM2 - cat $PEM1 > stunnel.pem - echo "" >>stunnel.pem - cat $PEM2 >>stunnel.pem - rm $PEM1 $PEM2 + openssl req -new -x509 -nodes -out bacula.pem -keyout bacula.pem -days 3650 \end{verbatim} \normalsize diff --git a/docs/manual/win32.tex b/docs/manual/win32.tex index 181f6679..f58e5a3f 100644 --- a/docs/manual/win32.tex +++ b/docs/manual/win32.tex @@ -29,11 +29,11 @@ Once installed Bacula normally runs as a system service. This means that it is immediately started by the operating system when the system is booted, and runs in the background even if there is no user logged into the system. -\subsubsection*{Win32 Installation} +\subsection*{Win32 Installation} \label{installation} \index[general]{Installation } \index[general]{Win32!Installation } -\addcontentsline{toc}{subsubsection}{Win32 Installation} +\addcontentsline{toc}{subsection}{Win32 Installation} Normally, you will install the Windows version of Bacula from the binaries. This install is standard Windows .exe that runs an install wizard using the @@ -127,29 +127,29 @@ If you are using remote desktop connections between your windows boxes, be warned that that tray icon does not always appear. It will always be visible when you log into the console, but the remote desktop may not display it. -\subsubsection*{Post Win32 Installation} +\subsection*{Post Win32 Installation} \index[general]{Post Win32 Installation } \index[general]{Win32!Post Installation } -\addcontentsline{toc}{subsubsection}{Post Win32 Installation} +\addcontentsline{toc}{subsection}{Post Win32 Installation} After installing Bacula and before running it, you should check the contents of {\bf c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}bacula-fd.conf} to ensure that it corresponds to your configuration. -\subsubsection*{Uninstalling Bacula on Win32} +\subsection*{Uninstalling Bacula on Win32} \index[general]{Win32!Uninstalling Bacula } \index[general]{Uninstalling Bacula on Win32 } -\addcontentsline{toc}{subsubsection}{Uninstalling Bacula on Win32} +\addcontentsline{toc}{subsection}{Uninstalling Bacula on Win32} Once Bacula has been installed, it can be uninstalled using the standard Windows Add/Remove Programs dialog found on the Control panel. -\subsubsection*{Dealing with Win32 Problems} +\subsection*{Dealing with Win32 Problems} \label{problems} \index[general]{Win32!Dealing with Problems } \index[general]{Dealing with Win32 Problems } -\addcontentsline{toc}{subsubsection}{Dealing with Win32 Problems} +\addcontentsline{toc}{subsection}{Dealing with Win32 Problems} The most likely source of problems is authentication when the Director attempts to connect to the File daemon that you installed. This can occur if @@ -230,10 +230,10 @@ is executing. \label{Compatibility} -\subsubsection*{Windows Compatibility Considerations} +\subsection*{Windows Compatibility Considerations} \index[general]{Windows Compatibility Considerations } \index[general]{Considerations!Windows Compatibility } -\addcontentsline{toc}{subsubsection}{Windows Compatibility Considerations} +\addcontentsline{toc}{subsection}{Windows Compatibility Considerations} If any applications are running during the backup and they have files opened exclusively, Bacula will not be able to backup those files, so be @@ -332,10 +332,10 @@ message) } \\ \end{longtable} -\subsubsection*{Windows Firewalls} +\subsection*{Windows Firewalls} \index[general]{Firewalls!Windows } \index[general]{Windows Firewalls } -\addcontentsline{toc}{subsubsection}{Windows Firewalls} +\addcontentsline{toc}{subsection}{Windows Firewalls} If you turn on the firewalling feature on Windows (default in WinXP SP2), you are likely to find that the Bacula ports are blocked and you cannot @@ -355,10 +355,10 @@ netsh firewall set opmode disable is purported to disable the firewall, but this command is not accepted on my WinXP Home machine. -\subsubsection*{Windows Port Usage} +\subsection*{Windows Port Usage} \index[general]{Windows Port Usage } \index[general]{Usage!Windows Port } -\addcontentsline{toc}{subsubsection}{Windows Port Usage} +\addcontentsline{toc}{subsection}{Windows Port Usage} If you want to see if the File daemon has properly opened the port and is listening, you can enter the following command in a shell window: @@ -369,10 +369,10 @@ listening, you can enter the following command in a shell window: \end{verbatim} \normalsize -\subsubsection*{Windows Disaster Recovery} +\subsection*{Windows Disaster Recovery} \index[general]{Recovery!Windows Disaster } \index[general]{Windows Disaster Recovery } -\addcontentsline{toc}{subsubsection}{Windows Disaster Recovery} +\addcontentsline{toc}{subsection}{Windows Disaster Recovery} We don't currently have a good solution for disaster recovery on Windows as we do on Linux. The main piece lacking is a Windows boot floppy or a Windows boot @@ -396,10 +396,19 @@ Environment) Boot-CD, may be just what is needed to build a complete disaster recovery system for Win32. This distribution can be found at \elink{http://www.nu2.nu/pebuilder/ }{http://www.nu2.nu/pebuilder/}. -\subsubsection*{Windows Ownership and Permissions Problems} +\subsection*{Windows Restore Problems} +\index[general]{Problems!Windows Restore} +\index[general]{Windows Restore Problems} +\addcontentsline{toc}{subsection}{Windows Restore Problems} +Please see the +\ilink{Restore Chapter}{Windows} of this manual for problems +that you might encounter doing a restore. + + +\subsection*{Windows Ownership and Permissions Problems} \index[general]{Problems!Windows Ownership and Permissions } \index[general]{Windows Ownership and Permissions Problems } -\addcontentsline{toc}{subsubsection}{Windows Ownership and Permissions +\addcontentsline{toc}{subsection}{Windows Ownership and Permissions Problems} If you restore files backed up from WinNT/XP/2K to an alternate directory, @@ -414,10 +423,16 @@ However, a much better solution to working with and changing Win32 permissions is the program {\bf SetACL}, which can be found at \elink{http://setacl.sourceforge.net/ }{http://setacl.sourceforge.net/}. -\subsubsection*{Manually resetting the Permissions} +Some users have experienced problems restoring files that participate in +the Active Directory. They also report that changing the userid under which +Bacula (bacula-fd.exe) runs, from SYSTEM to a Domain Admin userid, resolves +the problem. + + +\subsection*{Manually resetting the Permissions} \index[general]{Manually resetting the Permissions } \index[general]{Permissions!Manually resetting the } -\addcontentsline{toc}{subsubsection}{Manually resetting the Permissions} +\addcontentsline{toc}{subsection}{Manually resetting the Permissions} The following solution was provided by Dan Langille \lt{}dan at langille in the dot org domain\gt{}. The steps are performed using Windows 2000 Server but @@ -470,10 +485,10 @@ on Yes. With the above procedure, you should now have full control over your restored directory. -\subsubsection*{Backing Up the WinNT/XP/2K System State} +\subsection*{Backing Up the WinNT/XP/2K System State} \index[general]{State!Backing Up the WinNT/XP/2K System } \index[general]{Backing Up the WinNT/XP/2K System State } -\addcontentsline{toc}{subsubsection}{Backing Up the WinNT/XP/2K System State} +\addcontentsline{toc}{subsection}{Backing Up the WinNT/XP/2K System State} A suggestion by Damian Coutts using Microsoft's NTBackup utility in conjunction with Bacula should permit a full restore of any damaged system @@ -502,10 +517,10 @@ documentation says you can't run a command line restore of the systemstate. To the best of my knowledge, this has not yet been tested. If you test it, please report your results to the Bacula email list. -\subsubsection*{Windows Considerations for Filename Specifications} +\subsection*{Windows Considerations for Filename Specifications} \index[general]{Specifications!Windows Considerations for Filename } \index[general]{Windows Considerations for Filename Specifications } -\addcontentsline{toc}{subsubsection}{Windows Considerations for Filename +\addcontentsline{toc}{subsection}{Windows Considerations for Filename Specifications} Please see the @@ -513,13 +528,13 @@ Please see the for important considerations on how to specify Windows paths in Bacula FileSet Include and Exclude directives. -\subsubsection*{Command Line Options Specific to the Bacula Windows File +\subsection*{Command Line Options Specific to the Bacula Windows File Daemon (Client)} \index[general]{Client!Command Line Options Specific to the Bacula Windows File Daemon } \index[general]{Command Line Options Specific to the Bacula Windows File Daemon (Client) } -\addcontentsline{toc}{subsubsection}{Command Line Options Specific to the +\addcontentsline{toc}{subsection}{Command Line Options Specific to the Bacula Windows File Daemon (Client)} These options are not normally seen or used by the user, and are documented @@ -582,10 +597,10 @@ need to use these options as they are normally handled by the system automatically once Bacula is installed. However, you may note these options in some of the .bat files that have been created for your use. -\subsubsection*{Shutting down Windows Systems} +\subsection*{Shutting down Windows Systems} \index[general]{Shutting down Windows Systems } \index[general]{Systems!Shutting down Windows } -\addcontentsline{toc}{subsubsection}{Shutting down Windows Systems} +\addcontentsline{toc}{subsection}{Shutting down Windows Systems} Some users like to shutdown their windows machines after a backup using a Client Run After Job directive. If you want to do something similar, you might