4 \chapter{Installing Bacula}
6 \index[general]{Bacula!Installing}
7 \index[general]{Installing Bacula}
9 In general, you will need the Bacula source release, and if you want to run
10 a Windows client, you will need the Bacula Windows binary release.
11 However, Bacula needs certain third party packages (such as {\bf MySQL},
12 {\bf PostgreSQL}, or {\bf SQLite} to build and run
13 properly depending on the
14 options you specify. Normally, {\bf MySQL} and {\bf PostgreSQL} are
15 packages that can be installed on your distribution. However, if you do
16 not have them, to simplify your task, we have combined a number of these
17 packages into three {\bf depkgs} releases (Dependency Packages). This can
18 vastly simplify your life by providing you with all the necessary packages
19 rather than requiring you to find them on the Web, load them, and install
22 \section{Source Release Files}
23 \index[general]{Source Files}
24 \index[general]{Release Files}
25 Beginning with Bacula 1.38.0, the source code has been broken into
26 four separate tar files each corresponding to a different module in
27 the Bacula SVN. The released files are:
30 \item [bacula-3.0.3.tar.gz]
31 This is the primary source code release for Bacula. On each
32 release the version number (3.0.3) will be updated.
34 \item [bacula-docs-3.0.3.tar.gz]
35 This file contains a copy of the docs directory with the
36 documents prebuild. English HTML directory, single HTML
37 file, and pdf file. The French and German translations
38 are in progress, but are not built.
40 \item [bacula-gui-3.0.3.tar.gz]
41 This file contains the non-core GUI programs. Currently,
42 it contains bacula-web, a PHP program for producing management
43 viewing of your Bacula job status in a browser; and bimagemgr
44 a browser program for burning CDROM images with Bacula Volumes.
46 \item [bacula-rescue-3.0.3.tar.gz]
47 This is the Bacula Rescue CDROM code. Note, the version number
48 of this package is not tied to the Bacula release version, so
49 it will be different. Using this code, you can burn a CDROM
50 with your system configuration and containing a statically
51 linked version of the File daemon. This can permit you to easily
52 repartition and reformat your hard disks and reload your
53 system with Bacula in the case of a hard disk failure.
54 Unfortunately this rescue disk does not properly boot for
55 all Linux distributions. The problem is that the boot procedure
56 can vary significantly between distributions, and even within
57 a distribution, they are a moving target.
59 This package evolves slower than the Bacula source code,
60 so there may not always be a new release of the rescue package when
61 making minor updates to the Bacula code. For example, when releasing
62 Bacula version 3.0.3, the rescue package may still be at a prior
63 version if there were no updates.
65 \item [winbacula-3.0.3.exe]
66 This file is the 32 bit Windows installer for installing
67 the Windows client (File daemon) on a Windows machine.
68 This client will also run on 64 bit Windows machines.
69 Beginning with Bacula version 1.39.20, this executable will
70 also optionally load the Win32 Director and the Win32
73 \item [win64bacula-3.0.3.exe]
74 This file is the 64 bit Windows installer for installing
75 the Windows client (File daemon) on a Windows machine.
76 This client will only run on 64 bit Windows OS machines.
77 It will not run on 32 bit machines or 32 bit Windows OSes.
78 The win64bacula release is necessary for Volume Shadow
79 Copy (VSS) to work on Win64 OSes. This installer
80 installs only the FD, the Director and Storage daemon
86 \section{Upgrading Bacula}
87 \index[general]{Bacula!Upgrading}
88 \index[general]{Upgrading Bacula}
89 \index[general]{Upgrading}
91 If you are upgrading from one Bacula version to another, you should first
92 carefully read the ReleaseNotes of all major versions between your current
93 version and the version to which you are upgrading. In many upgrades,
94 especially for minor patch upgrades (e.g. between 3.0.0 and 3.0.1) there
95 will be no database upgrade, and hence the process is rather simple.
97 With version 3.0.0 and later, you {\bf must} ensure that on any one
98 machine that all components of Bacula are running on exactly the
99 same version. Prior to version 3.0.0, it was possible to run a
100 lower level FD with a newer Director and SD. This is no longer the
103 As always, we attempt to support older File daemons. This avoids the
104 need to do a simultaneous upgrade of many machines. For exactly what
105 older versions of the FD are supported, please see the ReleaseNotes
106 for the new version. In any case, you must always upgrade both the
107 Director and the Storage daemon at the same time, and you must also
108 upgrade any File daemon that is running on the same machine as a Director
109 or a Storage daemon (see the prior paragraph).
111 If the Bacula catalog
112 database has been upgraded (as it is almost every major release), you will
113 either need to reinitialize your database starting from scratch (not
114 normally a good idea), or save an ASCII copy of your database, then proceed
115 to upgrade it. If you are upgrading two major versions (e.g. 1.36 to 2.0)
116 then life will be more complicated because you must do two database
117 upgrades. See below for more on this.
119 Upgrading the catalog is normally done after Bacula is build and installed
123 cd <installed-scripts-dir> (default /etc/bacula)
124 ./update_bacula_tables
127 This update script can also be find in the Bacula source src/cats
130 If there are several database upgrades between your version and the
131 version to which you are upgrading, you will need to apply each database
132 upgrade script. For your convenience, you can find all the old upgrade scripts
133 in the {\bf upgradedb} directory of the source code. You will need to edit the
134 scripts to correspond to your system configuration. The final upgrade script,
135 if any, can be applied as noted above.
137 If you are upgrading from one major version to another, you will need to
138 replace all your components at the same time as generally the inter-daemon
139 protocol will change. However, within any particular release (e.g. version
140 1.32.x) unless there is an oversight or bug, the daemon protocol will not
141 change. If this is confusing, simply read the ReleaseNotes very carefully as
142 they will note if all daemons must be upgraded at the same time.
144 Finally, please note that in general it is not necessary or desirable
145 to do a {\bf make uninstall} before doing an upgrade providing you are careful
146 not to change the installation directories. In fact, if you do so, you will
147 most likely delete all your conf files, which could be disastrous.
148 The normal procedure during an upgrade is simply:
151 ./configure (your options)
156 In general none of your existing .conf or .sql files will be overwritten,
157 and you must do both the {\bf make} and {\bf make install} commands, a
158 {\bf make install} without the preceding {\bf make} will not work.
160 For additional information on upgrading, please see the \ilink{Upgrading Bacula
161 Versions}{upgrading} in the Tips chapter of this manual.
163 \section{Releases Numbering}
164 \index[general]{Release Numbering}
165 \index[general]{Version Numbering}
166 Every Bacula release whether beta or production has a different number
167 as well as the date of the release build. The numbering system follows
168 traditional Open Source conventions in that it is of the form.
179 where each component (major, minor, patch) is a number.
180 The major number is currently 1 and normally does not change
181 very frequently. The minor number starts at 0 and increases
182 each for each production release by 2 (i.e. it is always an
183 even number for a production release), and the patch number is
184 starts at zero each time the minor number changes. The patch
185 number is increased each time a bug fix (or fixes) is released
188 So, as of this date (10 September 2006), the current production Bacula
189 release is version 1.38.11. If there are bug fixes, the next release
190 will be 1.38.12 (i.e. the patch number has increased by one).
192 For all patch releases where the minor version number does not change,
193 the database and all the daemons will be compatible. That means that
194 you can safely run a 1.38.0 Director with a 1.38.11 Client. Of course,
195 in this case, the Director may have bugs that are not fixed. Generally,
196 within a minor release (some minor releases are not so minor), all
197 patch numbers are officially released to production. This means that while
198 the current Bacula version is 1.38.11, versions 1.38.0, 1.38.1, ... 1.38.10
199 have all been previously released.
201 When the minor number is odd, it indicates that the package is under
202 development and thus may not be stable. For example, while the current
203 production release of Bacula is currently 1.38.11, the current development
204 version is 1.39.22. All patch versions of the development code are
205 available in the SVN (source repository). However, not all patch versions
206 of the development code (odd minor version) are officially released. When
207 they are released, they are released as beta versions (see below for a
208 definition of what beta means for Bacula releases).
210 In general when the minor number increases from one production release
211 to the next (i.e. 1.38.x to 1.40.0), the catalog database must be upgraded,
212 the Director and Storage daemon must always be on the same minor release
213 number, and often (not always), the Clients must also be on the same minor
214 release. As often as possible, we attempt to make new releases that are
215 downwards compatible with prior clients, but this is not always possible.
216 You must check the release notes. In general, you will have fewer problems
217 if you always run all the components on the same minor version number (i.e.
218 all either 1.38.x or 1.40.x but not mixed).
222 \section*{Beta Releases}
223 \index[general]{Beta Releases}
224 Towards the end of the development cycle, which typically runs
225 one year from a major release to another, there will be several beta
226 releases of the development code prior to a production release.
227 As noted above, beta versions always have odd minor version numbers
228 (e.g 1.37.x or 1.39.x).
229 The purpose of the beta releases is to allow early adopter users to test
230 the new code. Beta releases are made with the following considerations:
233 \item The code passes the regression testing on FreeBSD, Linux, and Solaris
236 \item There are no known major bugs, or on the rare occasion that
237 there are, they will be documented or already in the bugs database.
239 \item Some of the new code/features may not yet be tested.
241 \item Bugs are expected to be found, especially in the new
242 code before the final production release.
244 \item The code will have been run in production in at least one small
247 \item The Win32 client will have been run in production at least
248 one night at that small site.
250 \item The documentation in the manual is unlikely to be complete especially
251 for the new features, and the Release Notes may not be fully
254 \item Beta code is not generally recommended for everyone, but
255 rather for early adopters.
260 \section{Dependency Packages}
261 \index[general]{Dependency Packages}
262 \index[general]{Packages!Dependency}
264 As discussed above, we have combined a number of third party packages that
265 Bacula might need into the {\bf depkgs} release. You can,
266 of course, get the latest packages from the original authors or
267 from your operating system supplier. The locations of
268 where we obtained the packages are in the README file in each package.
269 However, be aware that the packages in the depkgs files have been tested by us
270 for compatibility with Bacula.
272 Typically, a dependency package will be named {\bf depkgs-ddMMMyy.tar.gz}
273 where {\bf dd} is the day we release it, {\bf MMM}
274 is the abbreviated month (e.g. Jan), and {\bf yy} is the year. An actual
275 example is: {\bf depkgs-24Jul09.tar.gz}. To install and build this package (if
276 needed), you do the following:
279 \item Create a {\bf bacula} directory, into which you will place both the
280 Bacula source as well as the dependency package.
281 \item Detar the {\bf depkgs} into the {\bf bacula} directory.
282 \item cd bacula/depkgs
286 Although the exact composition of the dependency packages may change from time
287 to time, the current makeup is the following:
289 \addcontentsline{lot}{table}{Dependency Packages}
290 \begin{longtable}{|l|l|l|}
292 \multicolumn{1}{|c| }{\bf 3rd Party Package} & \multicolumn{1}{c| }{\bf depkgs}
293 & \multicolumn{1}{c| }{\bf depkgs-qt} \\
294 \hline {SQLite } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ }\\
295 \hline {SQLite3 } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ }\\
296 \hline {mtx } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ } \\
297 \hline {qt4 } & \multicolumn{1}{c| }{ } & \multicolumn{1}{c| }{X } \\
298 \hline {qwt } & \multicolumn{1}{c| }{ } & \multicolumn{1}{c| }{X } \\
302 Note, some of these packages are quite large, so that building them can be a
303 bit time consuming. The above instructions will build all the packages
304 contained in the directory. However, when building Bacula, it will take only
305 those pieces that it actually needs.
307 Alternatively, you can make just the packages that are needed. For example,
316 will configure and build only the SQLite package.
318 You should build the packages that you will require in {\bf depkgs} a
319 prior to configuring and building Bacula, since Bacula will need
320 them during the build process.
322 For more information on the {\bf depkgs-qt} package, please read the
323 INSTALL file in the main directory of that package. If you are going to
324 build Qt4 using {\bf depkgs-qt}, you must source the {\bf qt4-paths} file
325 included in the package prior to building Bacula. Please read the INSTALL
326 file for more details.
328 Even if you do not use SQLite, you might find it worthwhile to build {\bf mtx}
329 because the {\bf tapeinfo} program that comes with it can often provide you
330 with valuable information about your SCSI tape drive (e.g. compression,
331 min/max block sizes, ...). Note, most distros provide {\bf mtx} as part of
334 The {\bf depkgs1} package is depreciated and previously contained
335 readline, which should be available on all operating systems.
337 The {\bf depkgs-win32} package is deprecated and no longer used in
338 Bacula version 1.39.x and later. It was previously used to build
339 the native Win32 client program, but this program is now built on Linux
340 systems using cross-compiling. All the tools and third party libraries
341 are automatically downloaded by executing the appropriate scripts. See
342 src/win32/README.mingw32 for more details.
344 \section{Supported Operating Systems}
346 \index[general]{Systems!Supported Operating}
347 \index[general]{Supported Operating Systems}
350 \ilink{ Supported Operating Systems}{SupportedOSes} section
351 of the QuickStart chapter of this manual.
353 \section{Building Bacula from Source}
355 \index[general]{Source!Building Bacula from}
356 \index[general]{Building Bacula from Source}
358 The basic installation is rather simple.
361 \item Install and build any {\bf depkgs} as noted above. This
362 should be unnecessary on most modern Operating Systems.
364 \item Configure and install MySQL or PostgreSQL (if desired).
365 \ilink{Installing and Configuring MySQL Phase I}{MySqlChapter} or
366 \ilink{Installing and Configuring PostgreSQL Phase
367 I}{PostgreSqlChapter}. If you are installing from rpms, and are
368 using MySQL, please be sure to install {\bf mysql-devel}, so that the MySQL
369 header files are available while compiling Bacula. In addition, the MySQL
370 client library {\bf mysqlclient} requires the gzip compression library {\bf
371 libz.a} or {\bf libz.so}. If you are using rpm packages, these libraries are
372 in the {\bf libz-devel} package. On Debian systems, you will need to load the
373 {\bf zlib1g-dev} package. If you are not using rpms or debs, you will need to
374 find the appropriate package for your system.
376 Note, if you already have a running MySQL or PostgreSQL on your system, you
377 can skip this phase provided that you have built the thread safe libraries.
378 And you have already installed the additional rpms noted above.
380 SQLite is not supported on Solaris. This is because it
381 frequently fails with bus errors. However SQLite3 may work.
383 \item Detar the Bacula source code preferably into the {\bf bacula} directory
386 \item {\bf cd} to the directory containing the source code.
388 \item ./configure (with appropriate options as described below). Any
389 path names you specify as options on the ./configure command line
390 must be absolute paths and not relative.
392 \item Check the output of ./configure very carefully, especially the Install
393 binaries and Install config directories. If they are not correct,
394 please rerun ./configure until they are. The output from ./configure is
395 stored in {\bf config.out} and can be re-displayed at any time without
396 rerunning the ./configure by doing {\bf cat config.out}.
398 \item If after running ./configure once, you decide to change options and
399 re-run it, that is perfectly fine, but before re-running it, you should run:
407 so that you are sure to start from scratch and not have a mixture of the two
408 options. This is because ./configure caches much of the information. The {\bf
409 make distclean} is also critical if you move the source directory from one
410 machine to another. If the {\bf make distclean} fails, just ignore it and
414 If you get errors while linking in the Storage daemon directory
415 (src/stored), it is probably because you have not loaded the static
416 libraries on your system. I noticed this problem on a Solaris system.
417 To correct it, make sure that you have not added {\bf
418 {-}{-}enable-static-tools} to the {\bf ./configure} command.
420 If you skip this step ({\bf make}) and proceed immediately to the {\bf
421 make install} you are making two serious errors: 1. your install will
422 fail because Bacula requires a {\bf make} before a {\bf make install}.
423 2. you are depriving yourself of the chance to make sure there are no
424 errors before beginning to write files to your system directories.
428 Please be sure you have done a {\bf make} before entering this command,
429 and that everything has properly compiled and linked without errors.
432 \item If you are new to Bacula, we {\bf strongly} recommend that you skip
433 the next step and use the default configuration files, then run the
434 example program in the next chapter, then come back and modify your
435 configuration files to suit your particular needs.
437 \item Customize the configuration files for each of the three daemons
438 (Directory, File, Storage) and for the Console program. For the details
439 of how to do this, please see \ilink{Setting Up Bacula Configuration
440 Files}{ConfigureChapter} in the Configuration chapter of this manual. We
441 recommend that you start by modifying the default configuration files
442 supplied, making the minimum changes necessary. Complete customization
443 can be done after you have Bacula up and running. Please take care when
444 modifying passwords, which were randomly generated, and the {\bf Name}s
445 as the passwords and names must agree between the configuration files
446 for security reasons.
448 \label{CreateDatabase}
449 \item Create the Bacula MySQL database and tables
451 \ilink{Installing and Configuring MySQL Phase II}{mysql_phase2} or
452 create the Bacula PostgreSQL database and tables
453 \ilink{Configuring PostgreSQL
454 II}{PostgreSQL_configure} or alternatively if you are using
455 SQLite \ilink{Installing and Configuring SQLite Phase II}{phase2}.
457 \item Start Bacula ({\bf ./bacula start}) Note. the next chapter shows you
458 how to do this in detail.
460 \item Interface with Bacula using the Console program
462 \item For the previous two items, please follow the instructions in the
463 \ilink{Running Bacula}{TutorialChapter} chapter of this manual,
464 where you will run a simple backup and do a restore. Do this before you make
465 heavy modifications to the configuration files so that you are sure that
466 Bacula works and are familiar with it. After that changing the conf files
469 \item If after installing Bacula, you decide to "move it", that is to
470 install it in a different set of directories, proceed as follows:
476 ./configure (your-new-options)
485 If all goes well, the {\bf ./configure} will correctly determine which
486 operating system you are running and configure the source code appropriately.
487 Currently, FreeBSD, Linux (Red Hat), and Solaris are supported. The Bacula
488 client (File daemon) is reported to work with MacOS X 10.3 is if
489 readline support is not enabled (default) when building the client.
491 If you install Bacula on more than one system, and they are identical, you can
492 simply transfer the source tree to that other system and do a "make
493 install". However, if there are differences in the libraries or OS versions,
494 or you wish to install on a different OS, you should start from the original
495 compress tar file. If you do transfer the source tree, and you have previously
496 done a ./configure command, you MUST do:
504 prior to doing your new ./configure. This is because the GNU autoconf tools
505 cache the configuration, and if you re-use a configuration for a Linux machine
506 on a Solaris, you can be sure your build will fail. To avoid this, as
507 mentioned above, either start from the tar file, or do a "make distclean".
509 In general, you will probably want to supply a more complicated {\bf
510 configure} statement to ensure that the modules you want are built and that
511 everything is placed into the correct directories.
513 For example, on Fedora, Red Hat, or SuSE one could use the following:
519 --sbindir=$HOME/bacula/bin \
520 --sysconfdir=$HOME/bacula/bin \
521 --with-pid-dir=$HOME/bacula/bin/working \
522 --with-subsys-dir=$HOME/bacula/bin/working \
524 --with-working-dir=$HOME/bacula/bin/working \
525 --with-dump-email=$USER
529 The advantage of using the above configuration to start is that
530 everything will be put into a single directory, which you can later delete
531 once you have run the examples in the next chapter and learned how Bacula
532 works. In addition, the above can be installed and run as non-root.
534 For the developer's convenience, I have added a {\bf defaultconfig} script to
535 the {\bf examples} directory. This script contains the statements that you
536 would normally use, and each developer/user may modify them to suit his needs.
537 You should find additional useful examples in this directory as well.
539 The {\bf \verb:--:enable-conio} or {\bf \verb:--:enable-readline} options are useful because
540 they provide a command line history and editing capability for the Console
541 program. If you have included either option in the build, either the {\bf
542 termcap} or the {\bf ncurses} package will be needed to link. On most
543 systems, including Red Hat and SuSE, you should include the ncurses package.
544 If Bacula's configure process finds the ncurses libraries, it will use
545 those rather than the termcap library.
546 On some systems, such as SuSE, the termcap library is not in the standard
547 library directory. As a consequence, the option may be disabled or you may
548 get an error message such as:
552 /usr/lib/gcc-lib/i586-suse-linux/3.3.1/.../ld:
553 cannot find -ltermcap
554 collect2: ld returned 1 exit status
558 while building the Bacula Console. In that case, you will need to set the {\bf
559 LDFLAGS} environment variable prior to building.
563 export LDFLAGS="-L/usr/lib/termcap"
567 The same library requirements apply if you wish to use the readline
568 subroutines for command line editing and history or
569 if you are using a MySQL library that requires encryption. If you need encryption,
570 you can either export the appropriate additional library options as shown
571 above or, alternatively, you can include them directly on the ./configure line
576 LDFLAGS="-lssl -lcyrpto" \
577 ./configure <your-options>
581 On some systems such as Mandriva, readline tends to
582 gobble up prompts, which makes it totally useless. If this happens to you, use
583 the disable option, or if you are using version 1.33 and above try using {\bf
584 \verb:--:enable-conio} to use a built-in readline replacement. You will still need
585 either the termcap or the ncurses library, but it is unlikely that the {\bf conio}
586 package will gobble up prompts.
588 readline is no longer supported after version 1.34. The code within Bacula
589 remains, so it should be usable, and if users submit patches for it, we will
590 be happy to apply them. However, due to the fact that each version of
591 readline seems to be incompatible with previous versions, and that there
592 are significant differences between systems, we can no longer afford to
595 \section{What Database to Use?}
597 \index[general]{What Database to Use?}
598 \index[general]{Use!What Database to}
600 Before building Bacula you need to decide if you want to use SQLite, MySQL, or
601 PostgreSQL. If you are not already running MySQL or PostgreSQL, you might
602 want to start by testing with SQLite (not supported on Solaris).
603 This will greatly simplify the setup for you
604 because SQLite is compiled into Bacula an requires no administration. It
605 performs well and is suitable for small to medium sized installations (maximum
606 10-20 machines). However, we should note that a number of users have
607 had unexplained database corruption with SQLite. For that reason, we
608 recommend that you install either MySQL or PostgreSQL for production
611 If you wish to use MySQL as the Bacula catalog, please see the
612 \ilink{Installing and Configuring MySQL}{MySqlChapter} chapter of
613 this manual. You will need to install MySQL prior to continuing with the
614 configuration of Bacula. MySQL is a high quality database that is very
615 efficient and is suitable for any sized installation. It is slightly more
616 complicated than SQLite to setup and administer because it has a number of
617 sophisticated features such as userids and passwords. It runs as a separate
618 process, is truly professional and can manage a database of any size.
620 If you wish to use PostgreSQL as the Bacula catalog, please see the
621 \ilink{Installing and Configuring PostgreSQL}{PostgreSqlChapter}
622 chapter of this manual. You will need to install PostgreSQL prior to
623 continuing with the configuration of Bacula. PostgreSQL is very similar to
624 MySQL, though it tends to be slightly more SQL92 compliant and has many more
625 advanced features such as transactions, stored procedures, and the such. It
626 requires a certain knowledge to install and maintain.
628 If you wish to use SQLite as the Bacula catalog, please see
629 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
630 this manual. SQLite is not supported on Solaris.
632 \section{Quick Start}
633 \index[general]{Quick Start}
634 \index[general]{Start!Quick}
636 There are a number of options and important considerations given below
637 that you can skip for the moment if you have not had any problems building
638 Bacula with a simplified configuration as shown above.
640 If the ./configure process is unable to find specific libraries (e.g.
641 libintl, you should ensure that the appropriate package is installed on
642 your system. Alternatively, if the package is installed in a non-standard
643 location (as far as Bacula is concerned), then there is generally an
644 option listed below (or listed with "./configure {-}{-}help" that will
645 permit you to specify the directory that should be searched. In other
646 cases, there are options that will permit you to disable to feature
647 (e.g. {-}{-}disable-nls).
649 If you want to dive right into it, we recommend you skip to the next chapter,
650 and run the example program. It will teach you a lot about Bacula and as an
651 example can be installed into a single directory (for easy removal) and run as
652 non-root. If you have any problems or when you want to do a real installation,
653 come back to this chapter and read the details presented below.
655 \section{Configure Options}
657 \index[general]{Options!Configure}
658 \index[general]{Configure Options}
660 The following command line options are available for {\bf configure} to
661 customize your installation.
664 \item [ {-}prefix=\lt{}patch\gt{}]
665 \index[general]{{-}prefix}
666 This option is meant to allow you to direct where the architecture
667 independent files should be placed. However, we find this a somewhat
668 vague concept, and so we have not implemented this option other than
669 what ./configure does by default. As a consequence, we suggest that
670 you avoid it. We have provided options that allow you to explicitly
671 specify the directories for each of the major categories of installation
673 \item [ {-}{-}sbindir=\lt{}binary-path\gt{}]
674 \index[general]{{-}{-}sbindir}
675 Defines where the Bacula binary (executable) files will be placed during a
676 {\bf make install} command.
678 \item [ {-}{-}sysconfdir=\lt{}config-path\gt{}]
679 \index[general]{{-}{-}sysconfdir}
680 Defines where the Bacula configuration files should be placed during a
681 {\bf make install} command.
683 \item [ {-}{-}mandir=\lt{}path\gt{}]
684 \index[general]{{-}{-}mandir}
685 Note, as of Bacula version 1.39.14, the meaning of any path
686 specified on this option is change from prior versions. It
687 now specifies the top level man directory.
688 Previously the mandir specified the full path to where you
689 wanted the man files installed.
690 The man files will be installed in gzip'ed format under
691 mandir/man1 and mandir/man8 as appropriate.
692 For the install to succeed you must have {\bf gzip} installed
695 By default, Bacula will install the Unix man pages in
696 /usr/share/man/man1 and /usr/share/man/man8.
697 If you wish the man page to be installed in
698 a different location, use this option to specify the path.
699 Note, the main HTML and PDF Bacula documents are in a separate
700 tar file that is not part of the source distribution.
702 \item [ {-}{-}datadir=\lt{}path\gt{} ]
703 \index[general]{{-}{-}datadir}
704 If you translate Bacula or parts of Bacula into a different language
705 you may specify the location of the po files using the {\bf
706 {-}{-}datadir} option. You must manually install any po files as
707 Bacula does not (yet) automatically do so.
709 \item [ {-}{-}disable-ipv6 ]
710 \index[general]{{-}{-}disable-ipv6}
712 \item [ {-}{-}enable-smartalloc ]
713 \index[general]{{-}{-}enable-smartalloc}
714 This enables the inclusion of the Smartalloc orphaned buffer detection
715 code. This option is highly recommended. Because we never build
716 without this option, you may experience problems if it is not enabled.
717 In this case, simply re-enable the option. We strongly recommend
718 keeping this option enabled as it helps detect memory leaks. This
719 configuration parameter is used while building Bacula
721 \item [ {-}{-}enable-bat ]
723 \index[general]{{-}{-}enable-bat}
724 If you have Qt4 >= 4.3 installed on your computer including the
725 libqt4 and libqt4-devel (libqt4-dev on Debian) libraries, and you want
726 to use the Bacula Administration Tool (bat) GUI Console interface to
727 Bacula, you must specify this option. Doing so will build everything in
728 the {\bf src/qt-console} directory. The build with enable-bat will work
729 only with a full Bacula build (i.e. it will not work with a client-only
732 Qt4 is available on OpenSUSE 10.2, CentOS 5, Fedora, and Debian. If it
733 is not available on your system, you can download the {\bf depkgs-qt}
734 package from the Bacula Source Forge download area and build it and
735 the qwt package, both of which are needed to build bat. See the
736 INSTALL file in that package for more details. In particular to use
737 the Qt4 built by {\bf depkgs-qt} you {bf must} source the file
740 \item [ {-}{-}with-qwt=\lt{}path\gt{} ]
741 \index[general]{{-}{-}with-qwt}
742 The qwt package is a graphics library for Qt. If it is included
743 during the building of bat, you will get one extra graphical function.
744 At the current time, we recommend not including this option when
745 building bat. The path specified must be an absolute path and
748 The qwt package is available for download from
749 the qwt project on Source Forge. If you wish, you may build and
750 install it on your system (by default in /usr/lib).
751 If you have done so, you would specify:
754 --with-qwt=/usr/lib/qwt-5.0.2
757 Alternatively, you can download the Bacula depkgs-qt package (currently
758 version 28Jul09) and build it, then assuming that you have put it
759 into a directory named bacula, you would specify:
762 --with-qwt=$HOME/bacula/depkgs-qt/qwt
765 Some packages such as Debian do not adhere to the standard of
766 naming the library libqwt.a or libqwt.so, and you will either need
767 to manually add a soft link to the name they use or use the
768 depkgs version, which handles the naming correctly.
771 \item [ {-}{-}enable-batch-insert ]
772 \index[general]{{-}{-}enable-batch-insert}
773 This option enables batch inserts of the attribute records (default) in
774 the catalog database, which is much faster (10 times or more) than
775 without this option for large numbers of files. However, this option
776 will automatically be disabled if your SQL libraries are not
777 thread safe. If you find that batch mode is not enabled on your Bacula
778 installation, then your database most likely does not support threads.
780 SQLite2 is not thread safe. Batch insert cannot be enabled when using
783 On most systems, MySQL, PostgreSQL and SQLite3 are thread safe.
785 To verify that your PostgreSQL is thread safe, you can try this
786 (change the path to point to your particular installed libpq.a;
787 these commands were issued on FreeBSD 6.2):
790 $ nm /usr/local/lib/libpq.a | grep PQputCopyData
791 00001b08 T PQputCopyData
792 $ nm /usr/local/lib/libpq.a | grep mutex
794 U pthread_mutex_unlock
797 U pthread_mutex_unlock
800 The above example shows a libpq that contains the required function
801 PQputCopyData and is thread enabled (i.e. the pthread\_mutex* entries).
802 If you do not see PQputCopyData, your version of PostgreSQL is too old
803 to allow batch insert. If you do not see the mutex entries, then thread
804 support has not been enabled. Our tests indicate you usually need to
805 change the configuration options and recompile/reinstall the PostgreSQL
806 client software to get thread support.
808 Bacula always links to the thread safe MySQL libraries.
810 As a default, Bacula runs SQLite3 with {\bf PRAGMA synchronous=OFF}
811 because it improves performance by more than 30 times. However, it
812 increases the possibility of a corrupted database. If you want more
813 security, please modify src/version.h appropriately (it should be
814 obvious when you look at the file).
816 Running with Batch Insert turned on is recommended because it can
817 significantly improve attribute insertion times. However, it does
818 put a significantly larger part of the work on your SQL engine, so
819 you may need to pay more attention to tuning it. In particular,
820 Batch Insert can require large temporary table space, and consequently,
821 the default location (often /tmp) may run out of space causing errors.
822 For MySQL, the location is set in my.conf with "tmpdir". You may also
823 want to increase the memory available to your SQL engine to further
824 improve performance during Batch Inserts.
826 \item [ {-}{-}enable-gnome ]
827 \index[general]{{-}{-}enable-gnome}
828 If you have GNOME installed on your computer including the
829 GNOME development libraries, and you want to use the
830 GNOME GUI Console interface to Bacula, you must specify this option.
831 Doing so will build everything in the {\bf src/gnome2-console} directory.
833 \item [ {-}{-}enable-bwx-console ]
834 \index[general]{{-}{-}enable-bwx-console}
835 If you have wxWidgets installed on your computer and you want to use the
836 wxWidgets GUI Console interface to Bacula, you must specify this option.
837 Doing so will build everything in the {\bf src/wx-console} directory.
838 This could also be useful to users who want a GUI Console and don't want
839 to install GNOME, as wxWidgets can work with GTK+, Motif or even X11
842 \item [ {-}{-}enable-tray-monitor ]
843 \index[general]{{-}{-}enable-tray-monitor}
844 If you have GTK installed on your computer, you run a graphical
845 environment or a window manager compatible with the FreeDesktop system
846 tray standard (like KDE and GNOME) and you want to use a GUI to monitor
847 Bacula daemons, you must specify this option. Doing so will build
848 everything in the {\bf src/tray-monitor} directory. Note, due to
849 restrictions on what can be linked with GPLed code, we were forced to
850 remove the egg code that dealt with the tray icons and replace it by
851 calls to the GTK+ API, and unfortunately, the tray icon API necessary
852 was not implemented until GTK version 2.10 or later.
854 \item [ {-}{-}enable-static-tools]
855 \index[general]{{-}{-}enable-static-tools}
856 This option causes the linker to link the Storage daemon utility tools
857 ({\bf bls}, {\bf bextract}, and {\bf bscan}) statically. This permits
858 using them without having the shared libraries loaded. If you have
859 problems linking in the {\bf src/stored} directory, make sure you have
860 not enabled this option, or explicitly disable static linking by adding
861 {\bf \verb:--:disable-static-tools}.
863 \item [ {-}{-}enable-static-fd]
864 \index[general]{{-}{-}enable-static-fd}
865 This option causes the make process to build a {\bf static-bacula-fd} in
866 addition to the standard File daemon. This static version will include
867 statically linked libraries and is required for the Bare Metal recovery.
868 This option is largely superseded by using {\bf make static-bacula-fd}
869 from with in the {\bf src/filed} directory. Also, the {\bf
870 \verb:--:enable-client-only} option described below is useful for just
871 building a client so that all the other parts of the program are not
874 When linking a static binary, the linker needs the static versions
875 of all the libraries that are used, so frequently users will
876 experience linking errors when this option is used. The first
877 thing to do is to make sure you have the static glibc library
878 installed on your system. The second thing to do is the make sure
879 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
880 on your ./configure statement as these options require additional
881 libraries. You may be able to enable those options, but you will
882 need to load additional static libraries.
885 \item [ {-}{-}enable-static-sd]
886 \index[general]{{-}{-}enable-static-sd}
887 This option causes the make process to build a {\bf static-bacula-sd} in
888 addition to the standard Storage daemon. This static version will
889 include statically linked libraries and could be useful during a Bare
892 When linking a static binary, the linker needs the static versions
893 of all the libraries that are used, so frequently users will
894 experience linking errors when this option is used. The first
895 thing to do is to make sure you have the static glibc library
896 installed on your system. The second thing to do is the make sure
897 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
898 on your ./configure statement as these options require additional
899 libraries. You may be able to enable those options, but you will
900 need to load additional static libraries.
903 \item [ {-}{-}enable-static-dir]
904 \index[general]{{-}{-}enable-static-dir}
905 This option causes the make process to build a {\bf static-bacula-dir}
906 in addition to the standard Director. This static version will include
907 statically linked libraries and could be useful during a Bare Metal
910 When linking a static binary, the linker needs the static versions
911 of all the libraries that are used, so frequently users will
912 experience linking errors when this option is used. The first
913 thing to do is to make sure you have the static glibc library
914 installed on your system. The second thing to do is the make sure
915 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
916 on your ./configure statement as these options require additional
917 libraries. You may be able to enable those options, but you will
918 need to load additional static libraries.
921 \item [ {-}{-}enable-static-cons]
922 \index[general]{{-}{-}enable-static-cons}
923 This option causes the make process to build a {\bf static-console} and
924 a {\bf static-gnome-console} in addition to the standard console. This
925 static version will include statically linked libraries and could be
926 useful during a Bare Metal recovery.
928 When linking a static binary, the linker needs the static versions
929 of all the libraries that are used, so frequently users will
930 experience linking errors when this option is used. The first
931 thing to do is to make sure you have the static glibc library
932 installed on your system. The second thing to do is the make sure
933 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
934 on your ./configure statement as these options require additional
935 libraries. You may be able to enable those options, but you will
936 need to load additional static libraries.
939 \item [ {-}{-}enable-client-only]
940 \index[general]{{-}{-}enable-client-only}
941 This option causes the make process to build only the File daemon and
942 the libraries that it needs. None of the other daemons, storage tools,
943 nor the console will be built. Likewise a {\bf make install} will then
944 only install the File daemon. To cause all daemons to be built, you
945 will need to do a configuration without this option. This option
946 greatly facilitates building a Client on a client only machine.
948 When linking a static binary, the linker needs the static versions
949 of all the libraries that are used, so frequently users will
950 experience linking errors when this option is used. The first
951 thing to do is to make sure you have the static glibc library
952 installed on your system. The second thing to do is the make sure
953 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
954 on your ./configure statement as these options require additional
955 libraries. You may be able to enable those options, but you will
956 need to load additional static libraries.
958 \item [ {-}{-}enable-build-dird]
959 \index[general]{{-}{-}enable-build-dird}
960 This option causes the make process to build the Director and the
961 Director's tools. By default, this option is on, but you may turn
962 it off by using {\bf {-}{-}disable-build-dird} to prevent the
963 Director from being built.
965 \item [ {-}{-}enable-build-stored]
966 \index[general]{{-}{-}enable-build-stored}
967 This option causes the make process to build the Storage daemon.
968 By default, this option is on, but you may turn
969 it off by using {\bf {-}{-}disable-build-stored} to prevent the
970 Storage daemon from being built.
973 \item [ {-}{-}enable-largefile]
974 \index[general]{{-}{-}enable-largefile}
975 This option (default) causes Bacula to be built with 64 bit file address
976 support if it is available on your system. This permits Bacula to read and
977 write files greater than 2 GBytes in size. You may disable this feature and
978 revert to 32 bit file addresses by using {\bf \verb:--:disable-largefile}.
980 \item [ {-}{-}disable-nls]
981 \index[general]{{-}{-}disable-nls}
982 By default, Bacula uses the GNU Native Language Support (NLS) libraries. On
983 some machines, these libraries may not be present or may not function
984 correctly (especially on non-Linux implementations). In such cases, you
985 may specify {\bf {-}{-}disable-nls} to disable use of those libraries.
986 In such a case, Bacula will revert to using English.
988 \item [ {-}{-}disable-ipv6 ]
989 \index[general]{{-}{-}disable-ipv6}
990 By default, Bacula enables IPv6 protocol. On some systems, the files
991 for IPv6 may exist, but the functionality could be turned off in the
992 kernel. In that case, in order to correctly build Bacula, you will
993 explicitly need to use this option so that Bacula does not attempt
994 to reference OS function calls that do not exist.
996 \item [ {-}{-}with-sqlite=\lt{}sqlite-path\gt{}]
997 \index[general]{{-}{-}with-sqlite}
998 This enables use of the SQLite version 2.8.x database. The {\bf
999 sqlite-path} is not normally specified as Bacula looks for the necessary
1000 components in a standard location ({\bf depkgs/sqlite}). See
1001 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
1002 this manual for more details. SQLite is not supported on Solaris.
1004 See the note below under the {-}{-}with-postgresql item.
1006 \item [ {-}{-}with-sqlite3=\lt{}sqlite3-path\gt{}]
1007 \index[general]{{-}{-}with-sqlite3}
1008 This enables use of the SQLite version 3.x database. The {\bf
1009 sqlite3-path} is not normally specified as Bacula looks for the
1010 necessary components in a standard location ({\bf depkgs/sqlite3}). See
1011 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
1012 this manual for more details. SQLite3 is not supported on Solaris.
1014 \item [ {-}{-}with-mysql=\lt{}mysql-path\gt{}]
1015 \index[general]{{-}{-}with-mysql}
1016 This enables building of the Catalog services for Bacula. It assumes
1017 that MySQL is running on your system, and expects it to be installed in
1018 the {\bf mysql-path} that you specify. Normally, if MySQL is installed
1019 in a standard system location, you can simply use {\bf {-}{-}with-mysql}
1020 with no path specification. If you do use this option, please proceed
1021 to installing MySQL in the \ilink{Installing and Configuring
1022 MySQL}{MySqlChapter} chapter before proceeding with the configuration.
1024 See the note below under the {-}{-}with-postgresql item.
1026 \item [ {-}{-}with-postgresql=\lt{}path\gt{}]
1027 \index[general]{{-}{-}with-postgresql}
1028 This provides an explicit path to the PostgreSQL libraries if Bacula
1029 cannot find it by default. Normally to build with PostgreSQL, you would
1030 simply use {\bf {-}{-}with-postgresql}.
1032 Note, for Bacula to be configured properly, you must specify one
1033 of the four database options supported. That is:
1034 {-}{-}with-sqlite, {-}{-}with-sqlite3, {-}{-}with-mysql, or
1035 {-}{-}with-postgresql, otherwise the ./configure will fail.
1037 \item [ {-}{-}with-openssl=\lt{}path\gt{}]
1038 This configuration option is necessary if you want to enable TLS (ssl),
1039 which encrypts the communications within
1040 Bacula or if you want to use File Daemon PKI data encryption.
1041 Normally, the {\bf path} specification is not necessary since
1042 the configuration searches for the OpenSSL libraries in standard system
1043 locations. Enabling OpenSSL in Bacula permits secure communications
1044 between the daemons and/or data encryption in the File daemon.
1045 For more information on using TLS, please see the
1046 \ilink{Bacula TLS -- Communications Encryption}{CommEncryption} chapter
1048 For more information on using PKI data encryption, please see the
1049 \ilink{Bacula PKI -- Data Encryption}{DataEncryption}
1050 chapter of this manual.
1052 \item [ {-}{-}with-python=\lt{}path\gt{}]
1053 \index[general]{{-}{-}with-python}
1054 This option enables Bacula support for Python. If no path is supplied,
1055 configure will search the standard library locations for Python 2.2,
1056 2.3, 2.4, or 2.5. If it cannot find the library, you will need to
1057 supply a path to your Python library directory. Please see the
1058 \ilink{Python chapter}{PythonChapter} for the details of using Python
1061 \item [ {-}{-}with-libintl-prefix=\lt{}DIR\gt{}]
1062 \index[general]{{-}{-}with-libintl-prefix}
1063 This option may be used to tell Bacula to search DIR/include and
1064 DIR/lib for the libintl headers and libraries needed for Native
1065 Language Support (NLS).
1067 \item [ {-}{-}enable-conio]
1068 \index[general]{{-}{-}enable-conio}
1069 Tells Bacula to enable building the small, light weight readline
1070 replacement routine. It is generally much easier to configure than
1071 readline, although, like readline, it needs either the termcap or
1074 \item [ {-}{-}with-readline=\lt{}readline-path\gt{}]
1075 \index[general]{{-}{-}with-readline}
1076 Tells Bacula where {\bf readline} is installed. Normally, Bacula will
1077 find readline if it is in a standard library. If it is not found and no
1078 {-}{-}with-readline is specified, readline will be disabled. This
1079 option affects the Bacula build. Readline provides the Console program
1080 with a command line history and editing capability and is no longer
1081 supported, so you are on your own if you have problems.
1083 \item [ {-}{-}enable-readline]
1084 \index[general]{{-}{-}enable-readline}
1085 Tells Bacula to enable readline support. It is normally disabled due to the
1086 large number of configuration problems and the fact that the package seems to
1087 change in incompatible ways from version to version.
1089 \item [ {-}{-}with-tcp-wrappers=\lt{}path\gt{}]
1090 \index[general]{{-}{-}with-tcp-wrappers}
1091 \index[general]{TCP Wrappers}
1092 \index[general]{Wrappers!TCP}
1093 \index[general]{libwrappers}
1094 This specifies that you want TCP wrappers (man hosts\_access(5)) compiled in.
1095 The path is optional since Bacula will normally find the libraries in the
1096 standard locations. This option affects the Bacula build. In specifying your
1097 restrictions in the {\bf /etc/hosts.allow} or {\bf /etc/hosts.deny} files, do
1098 not use the {\bf twist} option (hosts\_options(5)) or the Bacula process will
1099 be terminated. Note, when setting up your {\bf /etc/hosts.allow}
1100 or {\bf /etc/hosts.deny}, you must identify the Bacula daemon in
1101 question with the name you give it in your conf file rather than the
1102 name of the executable.
1104 For more information on configuring and testing TCP wrappers, please see the
1105 \ilink{Configuring and Testing TCP Wrappers}{wrappers} section
1106 in the Security Chapter.
1108 On SuSE, the libwrappers libraries needed to link Bacula are
1109 contained in the tcpd-devel package. On Red Hat, the package is named
1112 \item [ {-}{-}with-archivedir=\lt{}path\gt{} ]
1113 \index[general]{{-}{-}with-archivedir}
1114 The directory used for disk-based backups. Default value is /tmp.
1115 This parameter sets the default values in the bacula-dir.conf and bacula-sd.conf
1116 configuration files. For example, it sets the Where directive for the
1117 default restore job and the Archive Device directive for the FileStorage
1120 This option is designed primarily for use in regression testing.
1121 Most users can safely ignore this option.
1123 \item [ {-}{-}with-working-dir=\lt{}working-directory-path\gt{} ]
1124 \index[general]{{-}{-}with-working-dir}
1125 This option is mandatory and specifies a directory into which Bacula may
1126 safely place files that will remain between Bacula executions. For example,
1127 if the internal database is used, Bacula will keep those files in this
1128 directory. This option is only used to modify the daemon configuration
1129 files. You may also accomplish the same thing by directly editing them later.
1130 The working directory is not automatically created by the install process, so
1131 you must ensure that it exists before using Bacula for the first time.
1133 \item [ {-}{-}with-base-port=\lt{}port=number\gt{}]
1134 \index[general]{{-}{-}with-base-port}
1135 In order to run, Bacula needs three TCP/IP ports (one for the Bacula
1136 Console, one for the Storage daemon, and one for the File daemon). The {\bf
1137 \verb:--:with-baseport} option will automatically assign three ports beginning at
1138 the base port address specified. You may also change the port number in the
1139 resulting configuration files. However, you need to take care that the
1140 numbers correspond correctly in each of the three daemon configuration
1141 files. The default base port is 9101, which assigns ports 9101 through 9103.
1142 These ports (9101, 9102, and 9103) have been officially assigned to Bacula by
1143 IANA. This option is only used to modify the daemon configuration files. You
1144 may also accomplish the same thing by directly editing them later.
1146 \item [ {-}{-}with-dump-email=\lt{}email-address\gt{}]
1147 \index[general]{{-}{-}with-dump-email}
1148 This option specifies the email address where any core dumps should be set.
1149 This option is normally only used by developers.
1151 \item [ {-}{-}with-pid-dir=\lt{}PATH\gt{} ]
1152 \index[general]{{-}{-}with-pid-dir}
1153 This specifies where Bacula should place the process id file during
1154 execution. The default is: {\bf /var/run}. This directory is not created by
1155 the install process, so you must ensure that it exists before using Bacula
1158 \item [ {-}{-}with-subsys-dir=\lt{}PATH\gt{}]
1159 \index[general]{{-}{-}with-subsys-dir}
1160 This specifies where Bacula should place the subsystem lock file during
1161 execution. The default is {\bf /var/run/subsys}. Please make sure that you do
1162 not specify the same directory for this directory and for the {\bf sbindir}
1163 directory. This directory is used only within the autostart scripts. The
1164 subsys directory is not created by the Bacula install, so you must be sure to
1165 create it before using Bacula.
1167 \item [ {-}{-}with-dir-password=\lt{}Password\gt{}]
1168 \index[general]{{-}{-}with-dir-password}
1169 This option allows you to specify the password used to access the Director
1170 (normally from the Console program). If it is not specified, configure will
1171 automatically create a random password.
1173 \item [ {-}{-}with-fd-password=\lt{}Password\gt{} ]
1174 \index[general]{{-}{-}with-fd-password}
1175 This option allows you to specify the password used to access the File daemon
1176 (normally called from the Director). If it is not specified, configure will
1177 automatically create a random password.
1179 \item [ {-}{-}with-sd-password=\lt{}Password\gt{} ]
1180 \index[general]{{-}{-}with-sd-password}
1181 This option allows you to specify the password used to access the Storage daemon
1182 (normally called from the Director). If it is not specified, configure will
1183 automatically create a random password.
1185 \item [ {-}{-}with-dir-user=\lt{}User\gt{} ]
1186 \index[general]{{-}{-}with-dir-user}
1187 This option allows you to specify the Userid used to run the Director. The
1188 Director must be started as root, but doesn't need to run as root, and
1189 after doing preliminary initializations, it can "drop" to the UserId
1190 specified on this option.
1191 If you specify this option, you must
1192 create the User prior to running {\bf make install}, because the
1193 working directory owner will be set to {\bf User}.
1195 \item [ {-}{-}with-dir-group=\lt{}Group\gt{} ]
1196 \index[general]{{-}{-}with-dir-group}
1197 This option allows you to specify the GroupId used to run the Director. The
1198 Director must be started as root, but doesn't need to run as root, and after
1199 doing preliminary initializations, it can "drop" to the GroupId specified
1201 If you specify this option, you must
1202 create the Group prior to running {\bf make install}, because the
1203 working directory group will be set to {\bf Group}.
1205 \item [ {-}{-}with-sd-user=\lt{}User\gt{} ]
1206 \index[general]{{-}{-}with-sd-user}
1207 This option allows you to specify the Userid used to run the Storage daemon.
1208 The Storage daemon must be started as root, but doesn't need to run as root,
1209 and after doing preliminary initializations, it can "drop" to the UserId
1210 specified on this option. If you use this option, you will need to take care
1211 that the Storage daemon has access to all the devices (tape drives, ...) that
1214 \item [ {-}{-}with-sd-group=\lt{}Group\gt{} ]
1215 \index[general]{{-}{-}with-sd-group}
1216 This option allows you to specify the GroupId used to run the Storage daemon.
1217 The Storage daemon must be started as root, but doesn't need to run as root,
1218 and after doing preliminary initializations, it can "drop" to the GroupId
1219 specified on this option.
1221 \item [ {-}{-}with-fd-user=\lt{}User\gt{} ]
1222 \index[general]{{-}{-}with-fd-user}
1223 This option allows you to specify the Userid used to run the File daemon. The
1224 File daemon must be started as root, and in most cases, it needs to run as
1225 root, so this option is used only in very special cases, after doing
1226 preliminary initializations, it can "drop" to the UserId specified on this
1229 \item [ {-}{-}with-fd-group=\lt{}Group\gt{} ]
1230 \index[general]{{-}{-}with-fd-group}
1231 This option allows you to specify the GroupId used to run the File daemon.
1232 The File daemon must be started as root, and in most cases, it must be run as
1233 root, however, after doing preliminary initializations, it can "drop" to
1234 the GroupId specified on this option.
1236 \item [ {-}{-}with-mon-dir-password=\lt{}Password\gt{}]
1237 \index[general]{{-}{-}with-mon-dir-password}
1238 This option allows you to specify the password used to access the Directory
1239 from the monitor. If it is not specified, configure will
1240 automatically create a random password.
1242 \item [ {-}{-}with-mon-fd-password=\lt{}Password\gt{} ]
1243 \index[general]{{-}{-}with-mon-fd-password}
1244 This option allows you to specify the password used to access the File daemon
1245 from the Monitor. If it is not specified, configure will
1246 automatically create a random password.
1248 \item [ {-}{-}with-mon-sd-password=\lt{}Password\gt{} ]
1249 \index[general]{{-}{-}with-mon-sd-password}
1250 This option allows you to specify the password used to access the
1251 Storage daemon from the Monitor. If it is not specified, configure will
1252 automatically create a random password.
1254 \item [ {-}{-}with-db-name=\lt{}database-name\gt{} ]
1255 \index[general]{{-}{-}with-db-name}
1256 This option allows you to specify the database name to be used in
1257 the conf files. The default is bacula.
1259 \item [ {-}{-}with-db-user=\lt{}database-user\gt{} ]
1260 \index[general]{{-}{-}with-db-user}
1261 This option allows you to specify the database user name to be used in
1262 the conf files. The default is bacula.
1266 Note, many other options are presented when you do a {\bf ./configure
1267 \verb:--:help}, but they are not implemented.
1269 \section{Recommended Options for Most Systems}
1270 \index[general]{Systems!Recommended Options for Most}
1271 \index[general]{Recommended Options for Most Systems}
1273 For most systems, we recommend starting with the following options:
1278 --enable-smartalloc \
1279 --sbindir=$HOME/bacula/bin \
1280 --sysconfdir=$HOME/bacula/bin \
1281 --with-pid-dir=$HOME/bacula/bin/working \
1282 --with-subsys-dir=$HOME/bacula/bin/working \
1283 --with-mysql=$HOME/mysql \
1284 --with-working-dir=$HOME/bacula/working
1288 If you want to install Bacula in an installation directory rather than run it
1289 out of the build directory (as developers will do most of the time), you
1290 should also include the \verb:--:sbindir and \verb:--:sysconfdir options with appropriate
1291 paths. Neither are necessary if you do not use "make install" as is the case
1292 for most development work. The install process will create the sbindir and
1293 sysconfdir if they do not exist, but it will not automatically create the
1294 pid-dir, subsys-dir, or working-dir, so you must ensure that they exist before
1295 running Bacula for the first time.
1298 \index[general]{Red Hat}
1305 CFLAGS="-g -Wall" ./configure \
1306 --sbindir=$HOME/bacula/bin \
1307 --sysconfdir=$HOME/bacula/bin \
1308 --enable-smartalloc \
1309 --with-sqlite=$HOME/bacula/depkgs/sqlite \
1310 --with-working-dir=$HOME/bacula/working \
1311 --with-pid-dir=$HOME/bacula/bin/working \
1312 --with-subsys-dir=$HOME/bacula/bin/working \
1314 --with-qwt=$HOME/bacula/depkgs/qwt \
1324 CFLAGS="-g -Wall" ./configure \
1325 --sbindir=$HOME/bacula/bin \
1326 --sysconfdir=$HOME/bacula/bin \
1327 --enable-smartalloc \
1328 --with-mysql=$HOME/mysql \
1329 --with-working-dir=$HOME/bacula/working
1330 --with-pid-dir=$HOME/bacula/bin/working \
1331 --with-subsys-dir=$HOME/bacula/bin/working
1337 or finally, a completely traditional Red Hat Linux install:
1341 CFLAGS="-g -Wall" ./configure \
1342 --sbindir=/usr/sbin \
1343 --sysconfdir=/etc/bacula \
1344 --with-scriptdir=/etc/bacula \
1345 --enable-smartalloc \
1347 --with-qwt=$HOME/bacula/depkgs/qwt \
1349 --with-working-dir=/var/bacula \
1350 --with-pid-dir=/var/run \
1355 Note, Bacula assumes that /var/bacula, /var/run, and /var/lock/subsys exist so
1356 it will not automatically create them during the install process.
1359 \index[general]{Solaris}
1361 To build Bacula from source, you will need the following installed on your
1362 system (they are not by default): libiconv, gcc 3.3.2, stdc++, libgcc (for
1363 stdc++ and gcc\_s libraries), make 3.8 or later.
1365 You will probably also need to: Add /usr/local/bin to PATH and Add
1366 /usr/ccs/bin to PATH for ar.
1368 It is possible to build Bacula on Solaris with the Solaris compiler, but
1369 we recommend using GNU C++ if possible.
1371 A typical configuration command might look like:
1376 CFLAGS="-g" ./configure \
1377 --sbindir=$HOME/bacula/bin \
1378 --sysconfdir=$HOME/bacula/bin \
1379 --with-mysql=$HOME/mysql \
1380 --enable-smartalloc \
1381 --with-pid-dir=$HOME/bacula/bin/working \
1382 --with-subsys-dir=$HOME/bacula/bin/working \
1383 --with-working-dir=$HOME/bacula/working
1387 As mentioned above, the install process will create the sbindir and sysconfdir
1388 if they do not exist, but it will not automatically create the pid-dir,
1389 subsys-dir, or working-dir, so you must ensure that they exist before running
1390 Bacula for the first time.
1392 Note, you may need to install the following packages to build Bacula
1412 PATH=/usr/bin::/usr/ccs/bin:/etc:/usr/openwin/bin:/usr/local/bin:/usr/sfw/bin:/opt/sfw/bin:/usr/ucb:/usr/sbin
1416 If you have installed special software not normally in the Solaris
1417 libraries, such as OpenSSL, or the packages shown above, then you may need
1418 to add {\bf /usr/sfw/lib} to the library search path. Probably the
1419 simplest way to do so is to run:
1423 setenv LDFLAGS "-L/usr/sfw/lib -R/usr/sfw/lib"
1427 Prior to running the ./configure command.
1429 Alternatively, you can set the LD\_LIBARY\_PATH and/or the LD\_RUN\_PATH
1430 environment variables appropriately.
1432 It is also possible to use the {\bf crle} program to set the library
1433 search path. However, this should be used with caution.
1436 \index[general]{FreeBSD}
1439 \elink{The FreeBSD Diary}{http://www.freebsddiary.org/bacula.php} for a
1440 detailed description on how to make Bacula work on your system. In addition,
1441 users of FreeBSD prior to 4.9-STABLE dated Mon Dec 29 15:18:01 2003 UTC who
1442 plan to use tape devices, please see the
1443 \ilink{Tape Testing Chapter}{FreeBSDTapes} of this manual for
1444 {\bf important} information on how to configure your tape drive for
1445 compatibility with Bacula.
1447 If you are using Bacula with MySQL, you should take care to compile MySQL with
1448 FreeBSD native threads rather than LinuxThreads, since Bacula is normally built
1449 with FreeBSD native threads rather than LinuxTreads. Mixing the two will
1453 \index[general]{Win32}
1455 To install the binary Win32 version of the File daemon please see the
1456 \ilink{Win32 Installation Chapter}{Win32Chapter} in this document.
1458 \section{One File Configure Script}
1459 \index[general]{Script!One File Configure}
1460 \index[general]{One Files Configure Script}
1462 The following script could be used if you want to put everything
1470 --sbindir=$HOME/bacula/bin \
1471 --sysconfdir=$HOME/bacula/bin \
1472 --mandir=$HOME/bacula/bin \
1473 --enable-smartalloc \
1476 --with-qwt=$HOME/bacula/depkgs/qwt \
1477 --enable-bwx-console \
1478 --enable-tray-monitor \
1479 --with-pid-dir=$HOME/bacula/bin/working \
1480 --with-subsys-dir=$HOME/bacula/bin/working \
1482 --with-working-dir=$HOME/bacula/bin/working \
1483 --with-dump-email=$USER@your-site.com \
1484 --with-job-email=$USER@your-site.com \
1485 --with-smtp-host=mail.your-site.com
1490 You may also want to put the following entries in your {\bf /etc/services}
1491 file as it will make viewing the connections made by Bacula easier to
1492 recognize (i.e. netstat -a):
1502 \section{Installing Bacula}
1503 \index[general]{Bacula!Installing}
1504 \index[general]{Installing Bacula}
1506 Before setting up your configuration files, you will want to install Bacula in
1507 its final location. Simply enter:
1515 If you have previously installed Bacula, the old binaries will be overwritten,
1516 but the old configuration files will remain unchanged, and the "new"
1517 configuration files will be appended with a {\bf .new}. Generally if you have
1518 previously installed and run Bacula you will want to discard or ignore the
1519 configuration files with the appended {\bf .new}.
1521 \section{Building a File Daemon or Client}
1522 \index[general]{Client!Building a File Daemon or}
1523 \index[general]{Building a File Daemon or Client}
1525 If you run the Director and the Storage daemon on one machine and you wish to
1526 back up another machine, you must have a copy of the File daemon for that
1527 machine. If the machine and the Operating System are identical, you can simply
1528 copy the Bacula File daemon binary file {\bf bacula-fd} as well as its
1529 configuration file {\bf bacula-fd.conf} then modify the name and password in
1530 the conf file to be unique. Be sure to make corresponding additions to the
1531 Director's configuration file ({\bf bacula-dir.conf}).
1533 If the architecture or the OS level are different, you will need to build a
1534 File daemon on the Client machine. To do so, you can use the same {\bf
1535 ./configure} command as you did for your main program, starting either from a
1536 fresh copy of the source tree, or using {\bf make\ distclean} before the {\bf
1539 Since the File daemon does not access the Catalog database, you can remove
1540 the {\bf \verb:--:with-mysql} or {\bf \verb:--:with-sqlite} options, then
1541 add {\bf \verb:--:enable-client-only}. This will compile only the
1542 necessary libraries and the client programs and thus avoids the necessity
1543 of installing one or another of those database programs to build the File
1544 daemon. With the above option, you simply enter {\bf make} and just the
1545 client will be built.
1548 \section{Auto Starting the Daemons}
1549 \index[general]{Daemons!Auto Starting the}
1550 \index[general]{Auto Starting the Daemons}
1552 If you wish the daemons to be automatically started and stopped when your
1553 system is booted (a good idea), one more step is necessary. First, the
1554 ./configure process must recognize your system -- that is it must be a
1555 supported platform and not {\bf unknown}, then you must install the platform
1556 dependent files by doing:
1561 make install-autostart
1565 Please note, that the auto-start feature is implemented only on systems
1566 that we officially support (currently, FreeBSD, Red Hat/Fedora Linux, and
1567 Solaris), and has only been fully tested on Fedora Linux.
1569 The {\bf make install-autostart} will cause the appropriate startup scripts
1570 to be installed with the necessary symbolic links. On Red Hat/Fedora Linux
1571 systems, these scripts reside in {\bf /etc/rc.d/init.d/bacula-dir} {\bf
1572 /etc/rc.d/init.d/bacula-fd}, and {\bf /etc/rc.d/init.d/bacula-sd}. However
1573 the exact location depends on what operating system you are using.
1575 If you only wish to install the File daemon, you may do so with:
1579 make install-autostart-fd
1583 \section{Other Make Notes}
1584 \index[general]{Notes!Other Make}
1585 \index[general]{Other Make Notes}
1587 To simply build a new executable in any directory, enter:
1595 To clean out all the objects and binaries (including the files named 1, 2, or
1596 3, which are development temporary files), enter:
1604 To really clean out everything for distribution, enter:
1612 note, this cleans out the Makefiles and is normally done from the top level
1613 directory to prepare for distribution of the source. To recover from this
1614 state, you must redo the {\bf ./configure} in the top level directory, since
1615 all the Makefiles will be deleted.
1617 To add a new file in a subdirectory, edit the Makefile.in in that directory,
1618 then simply do a {\bf make}. In most cases, the make will rebuild the Makefile
1619 from the new Makefile.in. In some case, you may need to issue the {\bf make} a
1620 second time. In extreme cases, cd to the top level directory and enter: {\bf
1623 To add dependencies:
1631 The {\bf make depend} appends the header file dependencies for each of the
1632 object files to Makefile and Makefile.in. This command should be done in each
1633 directory where you change the dependencies. Normally, it only needs to be run
1634 when you add or delete source or header files. {\bf make depend} is normally
1635 automatically invoked during the configuration process.
1645 This not normally done if you are developing Bacula, but is used if you are
1646 going to run it to backup your system.
1648 After doing a {\bf make install} the following files will be installed on your
1649 system (more or less). The exact files and location (directory) for each file
1650 depends on your {\bf ./configure} command (e.g. bgnome-console and
1651 bgnome-console.conf are not installed if you do not configure GNOME. Also, if
1652 you are using SQLite instead of MySQL, some of the files will be different).
1654 NOTE: it is quite probable that this list is out of date. But it is a
1676 create_mysql_database
1678 delete_catalog_backup
1699 \section{Installing Tray Monitor}
1700 \index[general]{Monitor!Installing Tray}
1701 \index[general]{Installing Tray Monitor}
1703 The Tray Monitor is already installed if you used the {\bf
1704 \verb:--:enable-tray-monitor} configure option and ran {\bf make install}.
1706 As you don't run your graphical environment as root (if you do, you should
1707 change that bad habit), don't forget to allow your user to read {\bf
1708 tray-monitor.conf}, and to execute {\bf bacula-tray-monitor} (this is not a
1711 Then log into your graphical environment (KDE, GNOME or something else), run
1712 {\bf bacula-tray-monitor} as your user, and see if a cassette icon appears
1713 somewhere on the screen, usually on the task bar.
1714 If it doesn't, follow the instructions below related to your environment or
1718 \index[general]{GNOME}
1720 System tray, or notification area if you use the GNOME terminology, has been
1721 supported in GNOME since version 2.2. To activate it, right-click on one of
1722 your panels, open the menu {\bf Add to this Panel}, then {\bf Utility} and
1723 finally click on {\bf Notification Area}.
1726 \index[general]{KDE}
1728 System tray has been supported in KDE since version 3.1. To activate it,
1729 right-click on one of your panels, open the menu {\bf Add}, then {\bf Applet}
1730 and finally click on {\bf System Tray}.
1732 \subsection{Other window managers}
1733 \index[general]{Managers!Other window}
1734 \index[general]{Other window managers}
1736 Read the documentation to know if the Freedesktop system tray standard is
1737 supported by your window manager, and if applicable, how to activate it.
1739 \section{Modifying the Bacula Configuration Files}
1740 \index[general]{Modifying the Bacula Configuration Files}
1741 \index[general]{Files!Modifying the Bacula Configuration}
1744 \ilink{Configuring Bacula}{ConfigureChapter} in this manual for
1745 instructions on how to set Bacula configuration files.