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-2.2.8.tar.gz]
31 This is the primary source code release for Bacula. On each
32 release the version number (2.2.8) will be updated.
34 \item [bacula-docs-2.2.8.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-2.2.8.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-2.0.0.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 2.2.8, the rescue package may still be at version
63 2.0.0 if there were no updates.
65 \item [winbacula-2.2.8.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
76 \section{Upgrading Bacula}
77 \index[general]{Bacula!Upgrading}
78 \index[general]{Upgrading Bacula}
79 \index[general]{Upgrading}
81 If you are upgrading from one Bacula version to another, you should first
82 carefully read the ReleaseNotes of all major versions between your current
83 version and the version to which you are upgrading. If the Bacula catalog
84 database has been upgraded (as it is almost every major release), you will
85 either need to reinitialize your database starting from scratch (not
86 normally a good idea), or save an ASCII copy of your database, then proceed
87 to upgrade it. If you are upgrading two major versions (e.g. 1.36 to 2.0)
88 then life will be more complicated because you must do two database
89 upgrades. See below for more on this.
91 Upgrading the catalog is normally done after Bacula is build and installed
95 cd <installed-scripts-dir> (default /etc/bacula)
96 ./update_bacula_tables
99 This update script can also be find in the Bacula source src/cats
102 If there are several database upgrades between your version and the
103 version to which you are upgrading, you will need to apply each database
104 upgrade script. For your convenience, you can find all the old upgrade scripts
105 in the {\bf upgradedb} directory of the source code. You will need to edit the
106 scripts to correspond to your system configuration. The final upgrade script,
107 if any, can be applied as noted above.
109 If you are upgrading from one major version to another, you will need to
110 replace all your components at the same time as generally the inter-daemon
111 protocol will change. However, within any particular release (e.g. version
112 1.32.x) unless there is an oversight or bug, the daemon protocol will not
113 change. If this is confusing, simply read the ReleaseNotes very carefully as
114 they will note if all daemons must be upgraded at the same time.
116 Finally, please note that in general it is not necessary or desirable
117 to do a {\bf make uninstall} before doing an upgrade providing you are careful
118 not to change the installation directories. In fact, if you do so, you will
119 most likely delete all your conf files, which could be disastrous.
120 The normal procedure during an upgrade is simply:
123 ./configure (your options)
128 In general none of your existing .conf or .sql files will be overwritten,
129 and you must do both the {\bf make} and {\bf make install} commands, a
130 {\bf make install} without the preceding {\bf make} will not work.
132 For additional information on upgrading, please see the \ilink{Upgrading Bacula
133 Versions}{upgrading} in the Tips chapter of this manual.
135 \section{Releases Numbering}
136 \index[general]{Release Numbering}
137 \index[general]{Version Numbering}
138 Every Bacula release whether beta or production has a different number
139 as well as the date of the release build. The numbering system follows
140 traditional Open Source conventions in that it is of the form.
151 where each component (major, minor, patch) is a number.
152 The major number is currently 1 and normally does not change
153 very frequently. The minor number starts at 0 and increases
154 each for each production release by 2 (i.e. it is always an
155 even number for a production release), and the patch number is
156 starts at zero each time the minor number changes. The patch
157 number is increased each time a bug fix (or fixes) is released
160 So, as of this date (10 September 2006), the current production Bacula
161 release is version 1.38.11. If there are bug fixes, the next release
162 will be 1.38.12 (i.e. the patch number has increased by one).
164 For all patch releases where the minor version number does not change,
165 the database and all the daemons will be compatible. That means that
166 you can safely run a 1.38.0 Director with a 1.38.11 Client. Of course,
167 in this case, the Director may have bugs that are not fixed. Generally,
168 within a minor release (some minor releases are not so minor), all
169 patch numbers are officially released to production. This means that while
170 the current Bacula version is 1.38.11, versions 1.38.0, 1.38.1, ... 1.38.10
171 have all been previously released.
173 When the minor number is odd, it indicates that the package is under
174 development and thus may not be stable. For example, while the current
175 production release of Bacula is currently 1.38.11, the current development
176 version is 1.39.22. All patch versions of the development code are
177 available in the SVN (source repository). However, not all patch versions
178 of the development code (odd minor version) are officially released. When
179 they are released, they are released as beta versions (see below for a
180 definition of what beta means for Bacula releases).
182 In general when the minor number increases from one production release
183 to the next (i.e. 1.38.x to 1.40.0), the catalog database must be upgraded,
184 the Director and Storage daemon must always be on the same minor release
185 number, and often (not always), the Clients must also be on the same minor
186 release. As often as possible, we attempt to make new releases that are
187 downwards compatible with prior clients, but this is not always possible.
188 You must check the release notes. In general, you will have fewer problems
189 if you always run all the components on the same minor version number (i.e.
190 all either 1.38.x or 1.40.x but not mixed).
194 \section*{Beta Releases}
195 \index[general]{Beta Releases}
196 Towards the end of the development cycle, which typically runs
197 one year from a major release to another, there will be several beta
198 releases of the development code prior to a production release.
199 As noted above, beta versions always have odd minor version numbers
200 (e.g 1.37.x or 1.39.x).
201 The purpose of the beta releases is to allow early adopter users to test
202 the new code. Beta releases are made with the following considerations:
205 \item The code passes the regression testing on FreeBSD, Linux, and Solaris
208 \item There are no known major bugs, or on the rare occasion that
209 there are, they will be documented or already in the bugs database.
211 \item Some of the new code/features may not yet be tested.
213 \item Bugs are expected to be found, especially in the new
214 code before the final production release.
216 \item The code will have been run in production in at least one small
219 \item The Win32 client will have been run in production at least
220 one night at that small site.
222 \item The documentation in the manual is unlikely to be complete especially
223 for the new features, and the Release Notes may not be fully
226 \item Beta code is not generally recommended for everyone, but
227 rather for early adopters.
232 \section{Dependency Packages}
233 \index[general]{Dependency Packages}
234 \index[general]{Packages!Dependency}
236 As discussed above, we have combined a number of third party packages that
237 Bacula might need into the {\bf depkgs} release. You can,
238 of course, get the latest packages from the original authors or
239 from your operating system supplier. The locations of
240 where we obtained the packages are in the README file in each package.
241 However, be aware that the packages in the depkgs files have been tested by us
242 for compatibility with Bacula.
244 Typically, a dependency package will be named {\bf depkgs-ddMMMyy.tar.gz}
245 where {\bf dd} is the day we release it, {\bf MMM}
246 is the abbreviated month (e.g. Jan), and {\bf yy} is the year. An actual
247 example is: {\bf depkgs-07Apr02.tar.gz}. To install and build this package (if
248 needed), you do the following:
251 \item Create a {\bf bacula} directory, into which you will place both the
252 Bacula source as well as the dependency package.
253 \item Detar the {\bf depkgs} into the {\bf bacula} directory.
254 \item cd bacula/depkgs
258 Although the exact composition of the dependency packages may change from time
259 to time, the current makeup is the following:
261 \addcontentsline{lot}{table}{Dependency Packages}
262 \begin{longtable}{|l|l|l|}
264 \multicolumn{1}{|c| }{\bf 3rd Party Package} & \multicolumn{1}{c| }{\bf depkgs}
265 & \multicolumn{1}{c| }{\bf depkgs-qt} \\
266 \hline {SQLite } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ }\\
267 \hline {SQLite3 } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ }\\
268 \hline {mtx } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ } \\
269 \hline {qt4 } & \multicolumn{1}{c| }{ } & \multicolumn{1}{c| }{X } \\
270 \hline {qwt } & \multicolumn{1}{c| }{ } & \multicolumn{1}{c| }{X } \\
274 Note, some of these packages are quite large, so that building them can be a
275 bit time consuming. The above instructions will build all the packages
276 contained in the directory. However, when building Bacula, it will take only
277 those pieces that it actually needs.
279 Alternatively, you can make just the packages that are needed. For example,
288 will configure and build only the SQLite package.
290 You should build the packages that you will require in {\bf depkgs} a
291 prior to configuring and building Bacula, since Bacula will need
292 them during the build process.
294 For more information on the {\bf depkgs-qt} package, please read the
295 INSTALL file in the main directory of that package. If you are going to
296 build Qt4 using {\bf depkgs-qt}, you must source the {\bf qt4-paths} file
297 included in the package prior to building Bacula. Please read the INSTALL
298 file for more details.
300 Even if you do not use SQLite, you might find it worthwhile to build {\bf mtx}
301 because the {\bf tapeinfo} program that comes with it can often provide you
302 with valuable information about your SCSI tape drive (e.g. compression,
303 min/max block sizes, ...). Note, most distros provide {\bf mtx} as part of
306 The {\bf depkgs1} package is depreciated and previously contained
307 readline, which should be available on all operating systems.
309 The {\bf depkgs-win32} package is deprecated and no longer used in
310 Bacula version 1.39.x and later. It was previously used to build
311 the native Win32 client program, but this program is now built on Linux
312 systems using cross-compiling. All the tools and third party libraries
313 are automatically downloaded by executing the appropriate scripts. See
314 src/win32/README.mingw32 for more details.
316 \section{Supported Operating Systems}
318 \index[general]{Systems!Supported Operating}
319 \index[general]{Supported Operating Systems}
322 \ilink{ Supported Operating Systems}{SupportedOSes} section
323 of the QuickStart chapter of this manual.
325 \section{Building Bacula from Source}
327 \index[general]{Source!Building Bacula from}
328 \index[general]{Building Bacula from Source}
330 The basic installation is rather simple.
333 \item Install and build any {\bf depkgs} as noted above. This
334 should be unnecessary on most modern Operating Systems.
336 \item Configure and install MySQL or PostgreSQL (if desired).
337 \ilink{Installing and Configuring MySQL Phase I}{MySqlChapter} or
338 \ilink{Installing and Configuring PostgreSQL Phase
339 I}{PostgreSqlChapter}. If you are installing from rpms, and are
340 using MySQL, please be sure to install {\bf mysql-devel}, so that the MySQL
341 header files are available while compiling Bacula. In addition, the MySQL
342 client library {\bf mysqlclient} requires the gzip compression library {\bf
343 libz.a} or {\bf libz.so}. If you are using rpm packages, these libraries are
344 in the {\bf libz-devel} package. On Debian systems, you will need to load the
345 {\bf zlib1g-dev} package. If you are not using rpms or debs, you will need to
346 find the appropriate package for your system.
348 Note, if you already have a running MySQL or PostgreSQL on your system, you
349 can skip this phase provided that you have built the thread safe libraries.
350 And you have already installed the additional rpms noted above.
352 SQLite is not supported on Solaris. This is because it
353 frequently fails with bus errors. However SQLite3 may work.
355 \item Detar the Bacula source code preferably into the {\bf bacula} directory
358 \item {\bf cd} to the directory containing the source code.
360 \item ./configure (with appropriate options as described below). Any
361 path names you specify as options on the ./configure command line
362 must be absolute paths and not relative.
364 \item Check the output of ./configure very carefully, especially the Install
365 binaries and Install config directories. If they are not correct,
366 please rerun ./configure until they are. The output from ./configure is
367 stored in {\bf config.out} and can be re-displayed at any time without
368 rerunning the ./configure by doing {\bf cat config.out}.
370 \item If after running ./configure once, you decide to change options and
371 re-run it, that is perfectly fine, but before re-running it, you should run:
379 so that you are sure to start from scratch and not have a mixture of the two
380 options. This is because ./configure caches much of the information. The {\bf
381 make distclean} is also critical if you move the source directory from one
382 machine to another. If the {\bf make distclean} fails, just ignore it and
386 If you get errors while linking in the Storage daemon directory
387 (src/stored), it is probably because you have not loaded the static
388 libraries on your system. I noticed this problem on a Solaris system.
389 To correct it, make sure that you have not added {\bf
390 {-}{-}enable-static-tools} to the {\bf ./configure} command.
392 If you skip this step ({\bf make}) and proceed immediately to the {\bf
393 make install} you are making two serious errors: 1. your install will
394 fail because Bacula requires a {\bf make} before a {\bf make install}.
395 2. you are depriving yourself of the chance to make sure there are no
396 errors before beginning to write files to your system directories.
400 Please be sure you have done a {\bf make} before entering this command,
401 and that everything has properly compiled and linked without errors.
404 \item If you are new to Bacula, we {\bf strongly} recommend that you skip
405 the next step and use the default configuration files, then run the
406 example program in the next chapter, then come back and modify your
407 configuration files to suit your particular needs.
409 \item Customize the configuration files for each of the three daemons
410 (Directory, File, Storage) and for the Console program. For the details
411 of how to do this, please see \ilink{Setting Up Bacula Configuration
412 Files}{ConfigureChapter} in the Configuration chapter of this manual. We
413 recommend that you start by modifying the default configuration files
414 supplied, making the minimum changes necessary. Complete customization
415 can be done after you have Bacula up and running. Please take care when
416 modifying passwords, which were randomly generated, and the {\bf Name}s
417 as the passwords and names must agree between the configuration files
418 for security reasons.
420 \label{CreateDatabase}
421 \item Create the Bacula MySQL database and tables
423 \ilink{Installing and Configuring MySQL Phase II}{mysql_phase2} or
424 create the Bacula PostgreSQL database and tables
425 \ilink{Configuring PostgreSQL
426 II}{PostgreSQL_configure} or alternatively if you are using
427 SQLite \ilink{Installing and Configuring SQLite Phase II}{phase2}.
429 \item Start Bacula ({\bf ./bacula start}) Note. the next chapter shows you
430 how to do this in detail.
432 \item Interface with Bacula using the Console program
434 \item For the previous two items, please follow the instructions in the
435 \ilink{Running Bacula}{TutorialChapter} chapter of this manual,
436 where you will run a simple backup and do a restore. Do this before you make
437 heavy modifications to the configuration files so that you are sure that
438 Bacula works and are familiar with it. After that changing the conf files
441 \item If after installing Bacula, you decide to "move it", that is to
442 install it in a different set of directories, proceed as follows:
448 ./configure (your-new-options)
457 If all goes well, the {\bf ./configure} will correctly determine which
458 operating system you are running and configure the source code appropriately.
459 Currently, FreeBSD, Linux (Red Hat), and Solaris are supported. The Bacula
460 client (File daemon) is reported to work with MacOS X 10.3 is if
461 readline support is not enabled (default) when building the client.
463 If you install Bacula on more than one system, and they are identical, you can
464 simply transfer the source tree to that other system and do a "make
465 install". However, if there are differences in the libraries or OS versions,
466 or you wish to install on a different OS, you should start from the original
467 compress tar file. If you do transfer the source tree, and you have previously
468 done a ./configure command, you MUST do:
476 prior to doing your new ./configure. This is because the GNU autoconf tools
477 cache the configuration, and if you re-use a configuration for a Linux machine
478 on a Solaris, you can be sure your build will fail. To avoid this, as
479 mentioned above, either start from the tar file, or do a "make distclean".
481 In general, you will probably want to supply a more complicated {\bf
482 configure} statement to ensure that the modules you want are built and that
483 everything is placed into the correct directories.
485 For example, on Fedora, Red Hat, or SuSE one could use the following:
491 --sbindir=$HOME/bacula/bin \
492 --sysconfdir=$HOME/bacula/bin \
493 --with-pid-dir=$HOME/bacula/bin/working \
494 --with-subsys-dir=$HOME/bacula/bin/working \
496 --with-working-dir=$HOME/bacula/bin/working \
497 --with-dump-email=$USER
501 The advantage of using the above configuration to start is that
502 everything will be put into a single directory, which you can later delete
503 once you have run the examples in the next chapter and learned how Bacula
504 works. In addition, the above can be installed and run as non-root.
506 For the developer's convenience, I have added a {\bf defaultconfig} script to
507 the {\bf examples} directory. This script contains the statements that you
508 would normally use, and each developer/user may modify them to suit his needs.
509 You should find additional useful examples in this directory as well.
511 The {\bf \verb:--:enable-conio} or {\bf \verb:--:enable-readline} options are useful because
512 they provide a command line history and editing capability for the Console
513 program. If you have included either option in the build, either the {\bf
514 termcap} or the {\bf ncurses} package will be needed to link. On most
515 systems, including Red Hat and SuSE, you should include the ncurses package.
516 If Bacula's configure process finds the ncurses libraries, it will use
517 those rather than the termcap library.
518 On some systems, such as SuSE, the termcap library is not in the standard
519 library directory. As a consequence, the option may be disabled or you may
520 get an error message such as:
524 /usr/lib/gcc-lib/i586-suse-linux/3.3.1/.../ld:
525 cannot find -ltermcap
526 collect2: ld returned 1 exit status
530 while building the Bacula Console. In that case, you will need to set the {\bf
531 LDFLAGS} environment variable prior to building.
535 export LDFLAGS="-L/usr/lib/termcap"
539 The same library requirements apply if you wish to use the readline
540 subroutines for command line editing and history or
541 if you are using a MySQL library that requires encryption. If you need encryption,
542 you can either export the appropriate additional library options as shown
543 above or, alternatively, you can include them directly on the ./configure line
548 LDFLAGS="-lssl -lcyrpto" \
549 ./configure <your-options>
553 On some systems such as Mandriva, readline tends to
554 gobble up prompts, which makes it totally useless. If this happens to you, use
555 the disable option, or if you are using version 1.33 and above try using {\bf
556 \verb:--:enable-conio} to use a built-in readline replacement. You will still need
557 either the termcap or the ncurses library, but it is unlikely that the {\bf conio}
558 package will gobble up prompts.
560 readline is no longer supported after version 1.34. The code within Bacula
561 remains, so it should be usable, and if users submit patches for it, we will
562 be happy to apply them. However, due to the fact that each version of
563 readline seems to be incompatible with previous versions, and that there
564 are significant differences between systems, we can no longer afford to
567 \section{What Database to Use?}
569 \index[general]{What Database to Use?}
570 \index[general]{Use!What Database to}
572 Before building Bacula you need to decide if you want to use SQLite, MySQL, or
573 PostgreSQL. If you are not already running MySQL or PostgreSQL, you might
574 want to start by testing with SQLite (not supported on Solaris).
575 This will greatly simplify the setup for you
576 because SQLite is compiled into Bacula an requires no administration. It
577 performs well and is suitable for small to medium sized installations (maximum
578 10-20 machines). However, we should note that a number of users have
579 had unexplained database corruption with SQLite. For that reason, we
580 recommend that you install either MySQL or PostgreSQL for production
583 If you wish to use MySQL as the Bacula catalog, please see the
584 \ilink{Installing and Configuring MySQL}{MySqlChapter} chapter of
585 this manual. You will need to install MySQL prior to continuing with the
586 configuration of Bacula. MySQL is a high quality database that is very
587 efficient and is suitable for any sized installation. It is slightly more
588 complicated than SQLite to setup and administer because it has a number of
589 sophisticated features such as userids and passwords. It runs as a separate
590 process, is truly professional and can manage a database of any size.
592 If you wish to use PostgreSQL as the Bacula catalog, please see the
593 \ilink{Installing and Configuring PostgreSQL}{PostgreSqlChapter}
594 chapter of this manual. You will need to install PostgreSQL prior to
595 continuing with the configuration of Bacula. PostgreSQL is very similar to
596 MySQL, though it tends to be slightly more SQL92 compliant and has many more
597 advanced features such as transactions, stored procedures, and the such. It
598 requires a certain knowledge to install and maintain.
600 If you wish to use SQLite as the Bacula catalog, please see
601 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
602 this manual. SQLite is not supported on Solaris.
604 \section{Quick Start}
605 \index[general]{Quick Start}
606 \index[general]{Start!Quick}
608 There are a number of options and important considerations given below
609 that you can skip for the moment if you have not had any problems building
610 Bacula with a simplified configuration as shown above.
612 If the ./configure process is unable to find specific libraries (e.g.
613 libintl, you should ensure that the appropriate package is installed on
614 your system. Alternatively, if the package is installed in a non-standard
615 location (as far as Bacula is concerned), then there is generally an
616 option listed below (or listed with "./configure {-}{-}help" that will
617 permit you to specify the directory that should be searched. In other
618 cases, there are options that will permit you to disable to feature
619 (e.g. {-}{-}disable-nls).
621 If you want to dive right into it, we recommend you skip to the next chapter,
622 and run the example program. It will teach you a lot about Bacula and as an
623 example can be installed into a single directory (for easy removal) and run as
624 non-root. If you have any problems or when you want to do a real installation,
625 come back to this chapter and read the details presented below.
627 \section{Configure Options}
629 \index[general]{Options!Configure}
630 \index[general]{Configure Options}
632 The following command line options are available for {\bf configure} to
633 customize your installation.
636 \item [ {-}prefix=\lt{}patch\gt{}]
637 \index[general]{{-}prefix}
638 This option is meant to allow you to direct where the architecture
639 independent files should be placed. However, we find this a somewhat
640 vague concept, and so we have not implemented this option other than
641 what ./configure does by default. As a consequence, we suggest that
642 you avoid it. We have provided options that allow you to explicitly
643 specify the directories for each of the major categories of installation
645 \item [ {-}{-}sbindir=\lt{}binary-path\gt{}]
646 \index[general]{{-}{-}sbindir}
647 Defines where the Bacula binary (executable) files will be placed during a
648 {\bf make install} command.
650 \item [ {-}{-}sysconfdir=\lt{}config-path\gt{}]
651 \index[general]{{-}{-}sysconfdir}
652 Defines where the Bacula configuration files should be placed during a
653 {\bf make install} command.
655 \item [ {-}{-}mandir=\lt{}path\gt{}]
656 \index[general]{{-}{-}mandir}
657 Note, as of Bacula version 1.39.14, the meaning of any path
658 specified on this option is change from prior versions. It
659 now specifies the top level man directory.
660 Previously the mandir specified the full path to where you
661 wanted the man files installed.
662 The man files will be installed in gzip'ed format under
663 mandir/man1 and mandir/man8 as appropriate.
664 For the install to succeed you must have {\bf gzip} installed
667 By default, Bacula will install the Unix man pages in
668 /usr/share/man/man1 and /usr/share/man/man8.
669 If you wish the man page to be installed in
670 a different location, use this option to specify the path.
671 Note, the main HTML and PDF Bacula documents are in a separate
672 tar file that is not part of the source distribution.
674 \item [ {-}{-}datadir=\lt{}path\gt{} ]
675 \index[general]{{-}{-}datadir}
676 If you translate Bacula or parts of Bacula into a different language
677 you may specify the location of the po files using the {\bf
678 {-}{-}datadir} option. You must manually install any po files as
679 Bacula does not (yet) automatically do so.
681 \item [ {-}{-}disable-ipv6 ]
682 \index[general]{{-}{-}disable-ipv6}
684 \item [ {-}{-}enable-smartalloc ]
685 \index[general]{{-}{-}enable-smartalloc}
686 This enables the inclusion of the Smartalloc orphaned buffer detection
687 code. This option is highly recommended. Because we never build
688 without this option, you may experience problems if it is not enabled.
689 In this case, simply re-enable the option. We strongly recommend
690 keeping this option enabled as it helps detect memory leaks. This
691 configuration parameter is used while building Bacula
693 \item [ {-}{-}enable-bat ]
695 \index[general]{{-}{-}enable-bat}
696 If you have Qt4 >= 4.3 installed on your computer including the
697 libqt4 and libqt4-devel (libqt4-dev on Debian) libraries, and you want
698 to use the Bacula Administration Tool (bat) GUI Console interface to
699 Bacula, you must specify this option. Doing so will build everything in
700 the {\bf src/qt-console} directory. The build with enable-bat will work
701 only with a full Bacula build (i.e. it will not work with a client-only
704 Qt4 is available on OpenSUSE 10.2, CentOS 5, Fedora, and Debian. If it
705 is not available on your system, you can download the {\bf depkgs-qt}
706 package from the Bacula Source Forge download area and build it and
707 the qwt package, both of which are needed to build bat. See the
708 INSTALL file in that package for more details. In particular to use
709 the Qt4 built by {\bf depkgs-qt} you {bf must} source the file
712 \item [ {-}{-}with-qwt=\lt{}path\gt{} ]
713 \index[general]{{-}{-}with-qwt}
714 The qwt package is a graphics library for Qt. If it is included
715 during the building of bat, you will get one extra graphical function.
716 At the current time, we recommend not including this option when
717 building bat. The path specified must be an absolute path and
720 The qwt package is available for download from
721 the qwt project on Source Forge. If you wish, you may build and
722 install it on your system (by default in /usr/lib).
723 If you have done so, you would specify:
726 --with-qwt=/usr/lib/qwt-5.0.2
729 Alternatively, you can download the Bacula depkgs-qt package (currently
730 version 28Jul09) and build it, then assuming that you have put it
731 into a directory named bacula, you would specify:
734 --with-qwt=$HOME/bacula/depkgs-qt/qwt
737 Some packages such as Debian do not adhere to the standard of
738 naming the library libqwt.a or libqwt.so, and you will either need
739 to manually add a soft link to the name they use or use the
740 depkgs version, which handles the naming correctly.
743 \item [ {-}{-}enable-batch-insert ]
744 \index[general]{{-}{-}enable-batch-insert}
745 This option enables batch inserts of the attribute records (default) in
746 the catalog database, which is much faster (10 times or more) than
747 without this option for large numbers of files. However, this option
748 will automatically be disabled if your SQL libraries are not
749 thread safe. If you find that batch mode is not enabled on your Bacula
750 installation, then your database most likely does not support threads.
752 SQLite2 is not thread safe. Batch insert cannot be enabled when using
755 On most systems, MySQL, PostgreSQL and SQLite3 are thread safe.
757 To verify that your PostgreSQL is thread safe, you can try this
758 (change the path to point to your particular installed libpq.a;
759 these commands were issued on FreeBSD 6.2):
762 $ nm /usr/local/lib/libpq.a | grep PQputCopyData
763 00001b08 T PQputCopyData
764 $ nm /usr/local/lib/libpq.a | grep mutex
766 U pthread_mutex_unlock
769 U pthread_mutex_unlock
772 The above example shows a libpq that contains the required function
773 PQputCopyData and is thread enabled (i.e. the pthread\_mutex* entries).
774 If you do not see PQputCopyData, your version of PostgreSQL is too old
775 to allow batch insert. If you do not see the mutex entries, then thread
776 support has not been enabled. Our tests indicate you usually need to
777 change the configuration options and recompile/reinstall the PostgreSQL
778 client software to get thread support.
780 Bacula always links to the thread safe MySQL libraries.
782 As a default, Bacula runs SQLite3 with {\bf PRAGMA synchronous=OFF}
783 because it improves performance by more than 30 times. However, it
784 increases the possibility of a corrupted database. If you want more
785 security, please modify src/version.h appropriately (it should be
786 obvious when you look at the file).
788 Running with Batch Insert turned on is recommended because it can
789 significantly improve attribute insertion times. However, it does
790 put a significantly larger part of the work on your SQL engine, so
791 you may need to pay more attention to tuning it. In particular,
792 Batch Insert can require large temporary table space, and consequently,
793 the default location (often /tmp) may run out of space causing errors.
794 For MySQL, the location is set in my.conf with "tmpdir". You may also
795 want to increase the memory available to your SQL engine to further
796 improve performance during Batch Inserts.
798 \item [ {-}{-}enable-gnome ]
799 \index[general]{{-}{-}enable-gnome}
800 If you have GNOME installed on your computer including the
801 GNOME development libraries, and you want to use the
802 GNOME GUI Console interface to Bacula, you must specify this option.
803 Doing so will build everything in the {\bf src/gnome2-console} directory.
805 \item [ {-}{-}enable-bwx-console ]
806 \index[general]{{-}{-}enable-bwx-console}
807 If you have wxWidgets installed on your computer and you want to use the
808 wxWidgets GUI Console interface to Bacula, you must specify this option.
809 Doing so will build everything in the {\bf src/wx-console} directory.
810 This could also be useful to users who want a GUI Console and don't want
811 to install GNOME, as wxWidgets can work with GTK+, Motif or even X11
814 \item [ {-}{-}enable-tray-monitor ]
815 \index[general]{{-}{-}enable-tray-monitor}
816 If you have GTK installed on your computer, you run a graphical
817 environment or a window manager compatible with the FreeDesktop system
818 tray standard (like KDE and GNOME) and you want to use a GUI to monitor
819 Bacula daemons, you must specify this option. Doing so will build
820 everything in the {\bf src/tray-monitor} directory. Note, due to
821 restrictions on what can be linked with GPLed code, we were forced to
822 remove the egg code that dealt with the tray icons and replace it by
823 calls to the GTK+ API, and unfortunately, the tray icon API necessary
824 was not implemented until GTK version 2.10 or later.
826 \item [ {-}{-}enable-static-tools]
827 \index[general]{{-}{-}enable-static-tools}
828 This option causes the linker to link the Storage daemon utility tools
829 ({\bf bls}, {\bf bextract}, and {\bf bscan}) statically. This permits
830 using them without having the shared libraries loaded. If you have
831 problems linking in the {\bf src/stored} directory, make sure you have
832 not enabled this option, or explicitly disable static linking by adding
833 {\bf \verb:--:disable-static-tools}.
835 \item [ {-}{-}enable-static-fd]
836 \index[general]{{-}{-}enable-static-fd}
837 This option causes the make process to build a {\bf static-bacula-fd} in
838 addition to the standard File daemon. This static version will include
839 statically linked libraries and is required for the Bare Metal recovery.
840 This option is largely superseded by using {\bf make static-bacula-fd}
841 from with in the {\bf src/filed} directory. Also, the {\bf
842 \verb:--:enable-client-only} option described below is useful for just
843 building a client so that all the other parts of the program are not
846 When linking a static binary, the linker needs the static versions
847 of all the libraries that are used, so frequently users will
848 experience linking errors when this option is used. The first
849 thing to do is to make sure you have the static glibc library
850 installed on your system. The second thing to do is the make sure
851 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
852 on your ./configure statement as these options require additional
853 libraries. You may be able to enable those options, but you will
854 need to load additional static libraries.
857 \item [ {-}{-}enable-static-sd]
858 \index[general]{{-}{-}enable-static-sd}
859 This option causes the make process to build a {\bf static-bacula-sd} in
860 addition to the standard Storage daemon. This static version will
861 include statically linked libraries and could be useful during a Bare
864 When linking a static binary, the linker needs the static versions
865 of all the libraries that are used, so frequently users will
866 experience linking errors when this option is used. The first
867 thing to do is to make sure you have the static glibc library
868 installed on your system. The second thing to do is the make sure
869 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
870 on your ./configure statement as these options require additional
871 libraries. You may be able to enable those options, but you will
872 need to load additional static libraries.
875 \item [ {-}{-}enable-static-dir]
876 \index[general]{{-}{-}enable-static-dir}
877 This option causes the make process to build a {\bf static-bacula-dir}
878 in addition to the standard Director. This static version will include
879 statically linked libraries and could be useful during a Bare Metal
882 When linking a static binary, the linker needs the static versions
883 of all the libraries that are used, so frequently users will
884 experience linking errors when this option is used. The first
885 thing to do is to make sure you have the static glibc library
886 installed on your system. The second thing to do is the make sure
887 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
888 on your ./configure statement as these options require additional
889 libraries. You may be able to enable those options, but you will
890 need to load additional static libraries.
893 \item [ {-}{-}enable-static-cons]
894 \index[general]{{-}{-}enable-static-cons}
895 This option causes the make process to build a {\bf static-console} and
896 a {\bf static-gnome-console} in addition to the standard console. This
897 static version will include statically linked libraries and could be
898 useful during a Bare Metal recovery.
900 When linking a static binary, the linker needs the static versions
901 of all the libraries that are used, so frequently users will
902 experience linking errors when this option is used. The first
903 thing to do is to make sure you have the static glibc library
904 installed on your system. The second thing to do is the make sure
905 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
906 on your ./configure statement as these options require additional
907 libraries. You may be able to enable those options, but you will
908 need to load additional static libraries.
911 \item [ {-}{-}enable-client-only]
912 \index[general]{{-}{-}enable-client-only}
913 This option causes the make process to build only the File daemon and
914 the libraries that it needs. None of the other daemons, storage tools,
915 nor the console will be built. Likewise a {\bf make install} will then
916 only install the File daemon. To cause all daemons to be built, you
917 will need to do a configuration without this option. This option
918 greatly facilitates building a Client on a client only machine.
920 When linking a static binary, the linker needs the static versions
921 of all the libraries that are used, so frequently users will
922 experience linking errors when this option is used. The first
923 thing to do is to make sure you have the static glibc library
924 installed on your system. The second thing to do is the make sure
925 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
926 on your ./configure statement as these options require additional
927 libraries. You may be able to enable those options, but you will
928 need to load additional static libraries.
930 \item [ {-}{-}enable-build-dird]
931 \index[general]{{-}{-}enable-build-dird}
932 This option causes the make process to build the Director and the
933 Director's tools. By default, this option is on, but you may turn
934 it off by using {\bf {-}{-}disable-build-dird} to prevent the
935 Director from being built.
937 \item [ {-}{-}enable-build-stored]
938 \index[general]{{-}{-}enable-build-stored}
939 This option causes the make process to build the Storage daemon.
940 By default, this option is on, but you may turn
941 it off by using {\bf {-}{-}disable-build-stored} to prevent the
942 Storage daemon from being built.
945 \item [ {-}{-}enable-largefile]
946 \index[general]{{-}{-}enable-largefile}
947 This option (default) causes Bacula to be built with 64 bit file address
948 support if it is available on your system. This permits Bacula to read and
949 write files greater than 2 GBytes in size. You may disable this feature and
950 revert to 32 bit file addresses by using {\bf \verb:--:disable-largefile}.
952 \item [ {-}{-}disable-nls]
953 \index[general]{{-}{-}disable-nls}
954 By default, Bacula uses the GNU Native Language Support (NLS) libraries. On
955 some machines, these libraries may not be present or may not function
956 correctly (especially on non-Linux implementations). In such cases, you
957 may specify {\bf {-}{-}disable-nls} to disable use of those libraries.
958 In such a case, Bacula will revert to using English.
960 \item [ {-}{-}disable-ipv6 ]
961 \index[general]{{-}{-}disable-ipv6}
962 By default, Bacula enables IPv6 protocol. On some systems, the files
963 for IPv6 may exist, but the functionality could be turned off in the
964 kernel. In that case, in order to correctly build Bacula, you will
965 explicitly need to use this option so that Bacula does not attempt
966 to reference OS function calls that do not exist.
968 \item [ {-}{-}with-sqlite=\lt{}sqlite-path\gt{}]
969 \index[general]{{-}{-}with-sqlite}
970 This enables use of the SQLite version 2.8.x database. The {\bf
971 sqlite-path} is not normally specified as Bacula looks for the necessary
972 components in a standard location ({\bf depkgs/sqlite}). See
973 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
974 this manual for more details. SQLite is not supported on Solaris.
976 See the note below under the {-}{-}with-postgresql item.
978 \item [ {-}{-}with-sqlite3=\lt{}sqlite3-path\gt{}]
979 \index[general]{{-}{-}with-sqlite3}
980 This enables use of the SQLite version 3.x database. The {\bf
981 sqlite3-path} is not normally specified as Bacula looks for the
982 necessary components in a standard location ({\bf depkgs/sqlite3}). See
983 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
984 this manual for more details. SQLite3 is not supported on Solaris.
986 \item [ {-}{-}with-mysql=\lt{}mysql-path\gt{}]
987 \index[general]{{-}{-}with-mysql}
988 This enables building of the Catalog services for Bacula. It assumes
989 that MySQL is running on your system, and expects it to be installed in
990 the {\bf mysql-path} that you specify. Normally, if MySQL is installed
991 in a standard system location, you can simply use {\bf {-}{-}with-mysql}
992 with no path specification. If you do use this option, please proceed
993 to installing MySQL in the \ilink{Installing and Configuring
994 MySQL}{MySqlChapter} chapter before proceeding with the configuration.
996 See the note below under the {-}{-}with-postgresql item.
998 \item [ {-}{-}with-postgresql=\lt{}path\gt{}]
999 \index[general]{{-}{-}with-postgresql}
1000 This provides an explicit path to the PostgreSQL libraries if Bacula
1001 cannot find it by default. Normally to build with PostgreSQL, you would
1002 simply use {\bf {-}{-}with-postgresql}.
1004 Note, for Bacula to be configured properly, you must specify one
1005 of the four database options supported. That is:
1006 {-}{-}with-sqlite, {-}{-}with-sqlite3, {-}{-}with-mysql, or
1007 {-}{-}with-postgresql, otherwise the ./configure will fail.
1009 \item [ {-}{-}with-openssl=\lt{}path\gt{}]
1010 This configuration option is necessary if you want to enable TLS (ssl),
1011 which encrypts the communications within
1012 Bacula or if you want to use File Daemon PKI data encryption.
1013 Normally, the {\bf path} specification is not necessary since
1014 the configuration searches for the OpenSSL libraries in standard system
1015 locations. Enabling OpenSSL in Bacula permits secure communications
1016 between the daemons and/or data encryption in the File daemon.
1017 For more information on using TLS, please see the
1018 \ilink{Bacula TLS -- Communications Encryption}{CommEncryption} chapter
1020 For more information on using PKI data encryption, please see the
1021 \ilink{Bacula PKI -- Data Encryption}{DataEncryption}
1022 chapter of this manual.
1024 \item [ {-}{-}with-python=\lt{}path\gt{}]
1025 \index[general]{{-}{-}with-python}
1026 This option enables Bacula support for Python. If no path is supplied,
1027 configure will search the standard library locations for Python 2.2,
1028 2.3, 2.4, or 2.5. If it cannot find the library, you will need to
1029 supply a path to your Python library directory. Please see the
1030 \ilink{Python chapter}{PythonChapter} for the details of using Python
1033 \item [ {-}{-}with-libintl-prefix=\lt{}DIR\gt{}]
1034 \index[general]{{-}{-}with-libintl-prefix}
1035 This option may be used to tell Bacula to search DIR/include and
1036 DIR/lib for the libintl headers and libraries needed for Native
1037 Language Support (NLS).
1039 \item [ {-}{-}enable-conio]
1040 \index[general]{{-}{-}enable-conio}
1041 Tells Bacula to enable building the small, light weight readline
1042 replacement routine. It is generally much easier to configure than
1043 readline, although, like readline, it needs either the termcap or
1046 \item [ {-}{-}with-readline=\lt{}readline-path\gt{}]
1047 \index[general]{{-}{-}with-readline}
1048 Tells Bacula where {\bf readline} is installed. Normally, Bacula will
1049 find readline if it is in a standard library. If it is not found and no
1050 {-}{-}with-readline is specified, readline will be disabled. This
1051 option affects the Bacula build. Readline provides the Console program
1052 with a command line history and editing capability and is no longer
1053 supported, so you are on your own if you have problems.
1055 \item [ {-}{-}enable-readline]
1056 \index[general]{{-}{-}enable-readline}
1057 Tells Bacula to enable readline support. It is normally disabled due to the
1058 large number of configuration problems and the fact that the package seems to
1059 change in incompatible ways from version to version.
1061 \item [ {-}{-}with-tcp-wrappers=\lt{}path\gt{}]
1062 \index[general]{{-}{-}with-tcp-wrappers}
1063 \index[general]{TCP Wrappers}
1064 \index[general]{Wrappers!TCP}
1065 \index[general]{libwrappers}
1066 This specifies that you want TCP wrappers (man hosts\_access(5)) compiled in.
1067 The path is optional since Bacula will normally find the libraries in the
1068 standard locations. This option affects the Bacula build. In specifying your
1069 restrictions in the {\bf /etc/hosts.allow} or {\bf /etc/hosts.deny} files, do
1070 not use the {\bf twist} option (hosts\_options(5)) or the Bacula process will
1071 be terminated. Note, when setting up your {\bf /etc/hosts.allow}
1072 or {\bf /etc/hosts.deny}, you must identify the Bacula daemon in
1073 question with the name you give it in your conf file rather than the
1074 name of the executable.
1076 For more information on configuring and testing TCP wrappers, please see the
1077 \ilink{Configuring and Testing TCP Wrappers}{wrappers} section
1078 in the Security Chapter.
1080 On SuSE, the libwrappers libraries needed to link Bacula are
1081 contained in the tcpd-devel package. On Red Hat, the package is named
1084 \item [ {-}{-}with-archivedir=\lt{}path\gt{} ]
1085 \index[general]{{-}{-}with-archivedir}
1086 The directory used for disk-based backups. Default value is /tmp.
1087 This parameter sets the default values in the bacula-dir.conf and bacula-sd.conf
1088 configuration files. For example, it sets the Where directive for the
1089 default restore job and the Archive Device directive for the FileStorage
1092 This option is designed primarily for use in regression testing.
1093 Most users can safely ignore this option.
1095 \item [ {-}{-}with-working-dir=\lt{}working-directory-path\gt{} ]
1096 \index[general]{{-}{-}with-working-dir}
1097 This option is mandatory and specifies a directory into which Bacula may
1098 safely place files that will remain between Bacula executions. For example,
1099 if the internal database is used, Bacula will keep those files in this
1100 directory. This option is only used to modify the daemon configuration
1101 files. You may also accomplish the same thing by directly editing them later.
1102 The working directory is not automatically created by the install process, so
1103 you must ensure that it exists before using Bacula for the first time.
1105 \item [ {-}{-}with-base-port=\lt{}port=number\gt{}]
1106 \index[general]{{-}{-}with-base-port}
1107 In order to run, Bacula needs three TCP/IP ports (one for the Bacula
1108 Console, one for the Storage daemon, and one for the File daemon). The {\bf
1109 \verb:--:with-baseport} option will automatically assign three ports beginning at
1110 the base port address specified. You may also change the port number in the
1111 resulting configuration files. However, you need to take care that the
1112 numbers correspond correctly in each of the three daemon configuration
1113 files. The default base port is 9101, which assigns ports 9101 through 9103.
1114 These ports (9101, 9102, and 9103) have been officially assigned to Bacula by
1115 IANA. This option is only used to modify the daemon configuration files. You
1116 may also accomplish the same thing by directly editing them later.
1118 \item [ {-}{-}with-dump-email=\lt{}email-address\gt{}]
1119 \index[general]{{-}{-}with-dump-email}
1120 This option specifies the email address where any core dumps should be set.
1121 This option is normally only used by developers.
1123 \item [ {-}{-}with-pid-dir=\lt{}PATH\gt{} ]
1124 \index[general]{{-}{-}with-pid-dir}
1125 This specifies where Bacula should place the process id file during
1126 execution. The default is: {\bf /var/run}. This directory is not created by
1127 the install process, so you must ensure that it exists before using Bacula
1130 \item [ {-}{-}with-subsys-dir=\lt{}PATH\gt{}]
1131 \index[general]{{-}{-}with-subsys-dir}
1132 This specifies where Bacula should place the subsystem lock file during
1133 execution. The default is {\bf /var/run/subsys}. Please make sure that you do
1134 not specify the same directory for this directory and for the {\bf sbindir}
1135 directory. This directory is used only within the autostart scripts. The
1136 subsys directory is not created by the Bacula install, so you must be sure to
1137 create it before using Bacula.
1139 \item [ {-}{-}with-dir-password=\lt{}Password\gt{}]
1140 \index[general]{{-}{-}with-dir-password}
1141 This option allows you to specify the password used to access the Director
1142 (normally from the Console program). If it is not specified, configure will
1143 automatically create a random password.
1145 \item [ {-}{-}with-fd-password=\lt{}Password\gt{} ]
1146 \index[general]{{-}{-}with-fd-password}
1147 This option allows you to specify the password used to access the File daemon
1148 (normally called from the Director). If it is not specified, configure will
1149 automatically create a random password.
1151 \item [ {-}{-}with-sd-password=\lt{}Password\gt{} ]
1152 \index[general]{{-}{-}with-sd-password}
1153 This option allows you to specify the password used to access the Storage daemon
1154 (normally called from the Director). If it is not specified, configure will
1155 automatically create a random password.
1157 \item [ {-}{-}with-dir-user=\lt{}User\gt{} ]
1158 \index[general]{{-}{-}with-dir-user}
1159 This option allows you to specify the Userid used to run the Director. The
1160 Director must be started as root, but doesn't need to run as root, and
1161 after doing preliminary initializations, it can "drop" to the UserId
1162 specified on this option.
1163 If you specify this option, you must
1164 create the User prior to running {\bf make install}, because the
1165 working directory owner will be set to {\bf User}.
1167 \item [ {-}{-}with-dir-group=\lt{}Group\gt{} ]
1168 \index[general]{{-}{-}with-dir-group}
1169 This option allows you to specify the GroupId used to run the Director. The
1170 Director must be started as root, but doesn't need to run as root, and after
1171 doing preliminary initializations, it can "drop" to the GroupId specified
1173 If you specify this option, you must
1174 create the Group prior to running {\bf make install}, because the
1175 working directory group will be set to {\bf Group}.
1177 \item [ {-}{-}with-sd-user=\lt{}User\gt{} ]
1178 \index[general]{{-}{-}with-sd-user}
1179 This option allows you to specify the Userid used to run the Storage daemon.
1180 The Storage daemon must be started as root, but doesn't need to run as root,
1181 and after doing preliminary initializations, it can "drop" to the UserId
1182 specified on this option. If you use this option, you will need to take care
1183 that the Storage daemon has access to all the devices (tape drives, ...) that
1186 \item [ {-}{-}with-sd-group=\lt{}Group\gt{} ]
1187 \index[general]{{-}{-}with-sd-group}
1188 This option allows you to specify the GroupId used to run the Storage daemon.
1189 The Storage daemon must be started as root, but doesn't need to run as root,
1190 and after doing preliminary initializations, it can "drop" to the GroupId
1191 specified on this option.
1193 \item [ {-}{-}with-fd-user=\lt{}User\gt{} ]
1194 \index[general]{{-}{-}with-fd-user}
1195 This option allows you to specify the Userid used to run the File daemon. The
1196 File daemon must be started as root, and in most cases, it needs to run as
1197 root, so this option is used only in very special cases, after doing
1198 preliminary initializations, it can "drop" to the UserId specified on this
1201 \item [ {-}{-}with-fd-group=\lt{}Group\gt{} ]
1202 \index[general]{{-}{-}with-fd-group}
1203 This option allows you to specify the GroupId used to run the File daemon.
1204 The File daemon must be started as root, and in most cases, it must be run as
1205 root, however, after doing preliminary initializations, it can "drop" to
1206 the GroupId specified on this option.
1208 \item [ {-}{-}with-mon-dir-password=\lt{}Password\gt{}]
1209 \index[general]{{-}{-}with-mon-dir-password}
1210 This option allows you to specify the password used to access the Directory
1211 from the monitor. If it is not specified, configure will
1212 automatically create a random password.
1214 \item [ {-}{-}with-mon-fd-password=\lt{}Password\gt{} ]
1215 \index[general]{{-}{-}with-mon-fd-password}
1216 This option allows you to specify the password used to access the File daemon
1217 from the Monitor. If it is not specified, configure will
1218 automatically create a random password.
1220 \item [ {-}{-}with-mon-sd-password=\lt{}Password\gt{} ]
1221 \index[general]{{-}{-}with-mon-sd-password}
1222 This option allows you to specify the password used to access the
1223 Storage daemon from the Monitor. If it is not specified, configure will
1224 automatically create a random password.
1226 \item [ {-}{-}with-db-name=\lt{}database-name\gt{} ]
1227 \index[general]{{-}{-}with-db-name}
1228 This option allows you to specify the database name to be used in
1229 the conf files. The default is bacula.
1231 \item [ {-}{-}with-db-user=\lt{}database-user\gt{} ]
1232 \index[general]{{-}{-}with-db-user}
1233 This option allows you to specify the database user name to be used in
1234 the conf files. The default is bacula.
1238 Note, many other options are presented when you do a {\bf ./configure
1239 \verb:--:help}, but they are not implemented.
1241 \section{Recommended Options for Most Systems}
1242 \index[general]{Systems!Recommended Options for Most}
1243 \index[general]{Recommended Options for Most Systems}
1245 For most systems, we recommend starting with the following options:
1250 --enable-smartalloc \
1251 --sbindir=$HOME/bacula/bin \
1252 --sysconfdir=$HOME/bacula/bin \
1253 --with-pid-dir=$HOME/bacula/bin/working \
1254 --with-subsys-dir=$HOME/bacula/bin/working \
1255 --with-mysql=$HOME/mysql \
1256 --with-working-dir=$HOME/bacula/working
1260 If you want to install Bacula in an installation directory rather than run it
1261 out of the build directory (as developers will do most of the time), you
1262 should also include the \verb:--:sbindir and \verb:--:sysconfdir options with appropriate
1263 paths. Neither are necessary if you do not use "make install" as is the case
1264 for most development work. The install process will create the sbindir and
1265 sysconfdir if they do not exist, but it will not automatically create the
1266 pid-dir, subsys-dir, or working-dir, so you must ensure that they exist before
1267 running Bacula for the first time.
1270 \index[general]{Red Hat}
1277 CFLAGS="-g -Wall" ./configure \
1278 --sbindir=$HOME/bacula/bin \
1279 --sysconfdir=$HOME/bacula/bin \
1280 --enable-smartalloc \
1281 --with-sqlite=$HOME/bacula/depkgs/sqlite \
1282 --with-working-dir=$HOME/bacula/working \
1283 --with-pid-dir=$HOME/bacula/bin/working \
1284 --with-subsys-dir=$HOME/bacula/bin/working \
1286 --with-qwt=$HOME/bacula/depkgs/qwt \
1296 CFLAGS="-g -Wall" ./configure \
1297 --sbindir=$HOME/bacula/bin \
1298 --sysconfdir=$HOME/bacula/bin \
1299 --enable-smartalloc \
1300 --with-mysql=$HOME/mysql \
1301 --with-working-dir=$HOME/bacula/working
1302 --with-pid-dir=$HOME/bacula/bin/working \
1303 --with-subsys-dir=$HOME/bacula/bin/working
1309 or finally, a completely traditional Red Hat Linux install:
1313 CFLAGS="-g -Wall" ./configure \
1314 --sbindir=/usr/sbin \
1315 --sysconfdir=/etc/bacula \
1316 --with-scriptdir=/etc/bacula \
1317 --enable-smartalloc \
1319 --with-qwt=$HOME/bacula/depkgs/qwt \
1321 --with-working-dir=/var/bacula \
1322 --with-pid-dir=/var/run \
1327 Note, Bacula assumes that /var/bacula, /var/run, and /var/lock/subsys exist so
1328 it will not automatically create them during the install process.
1331 \index[general]{Solaris}
1333 To build Bacula from source, you will need the following installed on your
1334 system (they are not by default): libiconv, gcc 3.3.2, stdc++, libgcc (for
1335 stdc++ and gcc\_s libraries), make 3.8 or later.
1337 You will probably also need to: Add /usr/local/bin to PATH and Add
1338 /usr/ccs/bin to PATH for ar.
1340 It is possible to build Bacula on Solaris with the Solaris compiler, but
1341 we recommend using GNU C++ if possible.
1343 A typical configuration command might look like:
1348 CFLAGS="-g" ./configure \
1349 --sbindir=$HOME/bacula/bin \
1350 --sysconfdir=$HOME/bacula/bin \
1351 --with-mysql=$HOME/mysql \
1352 --enable-smartalloc \
1353 --with-pid-dir=$HOME/bacula/bin/working \
1354 --with-subsys-dir=$HOME/bacula/bin/working \
1355 --with-working-dir=$HOME/bacula/working
1359 As mentioned above, the install process will create the sbindir and sysconfdir
1360 if they do not exist, but it will not automatically create the pid-dir,
1361 subsys-dir, or working-dir, so you must ensure that they exist before running
1362 Bacula for the first time.
1364 Note, you may need to install the following packages to build Bacula
1384 PATH=/usr/bin::/usr/ccs/bin:/etc:/usr/openwin/bin:/usr/local/bin:/usr/sfw/bin:/opt/sfw/bin:/usr/ucb:/usr/sbin
1388 If you have installed special software not normally in the Solaris
1389 libraries, such as OpenSSL, or the packages shown above, then you may need
1390 to add {\bf /usr/sfw/lib} to the library search path. Probably the
1391 simplest way to do so is to run:
1395 setenv LDFLAGS "-L/usr/sfw/lib -R/usr/sfw/lib"
1399 Prior to running the ./configure command.
1401 Alternatively, you can set the LD\_LIBARY\_PATH and/or the LD\_RUN\_PATH
1402 environment variables appropriately.
1404 It is also possible to use the {\bf crle} program to set the library
1405 search path. However, this should be used with caution.
1408 \index[general]{FreeBSD}
1411 \elink{The FreeBSD Diary}{http://www.freebsddiary.org/bacula.php} for a
1412 detailed description on how to make Bacula work on your system. In addition,
1413 users of FreeBSD prior to 4.9-STABLE dated Mon Dec 29 15:18:01 2003 UTC who
1414 plan to use tape devices, please see the
1415 \ilink{Tape Testing Chapter}{FreeBSDTapes} of this manual for
1416 {\bf important} information on how to configure your tape drive for
1417 compatibility with Bacula.
1419 If you are using Bacula with MySQL, you should take care to compile MySQL with
1420 FreeBSD native threads rather than LinuxThreads, since Bacula is normally built
1421 with FreeBSD native threads rather than LinuxTreads. Mixing the two will
1425 \index[general]{Win32}
1427 To install the binary Win32 version of the File daemon please see the
1428 \ilink{Win32 Installation Chapter}{Win32Chapter} in this document.
1430 \section{One File Configure Script}
1431 \index[general]{Script!One File Configure}
1432 \index[general]{One Files Configure Script}
1434 The following script could be used if you want to put everything
1442 --sbindir=$HOME/bacula/bin \
1443 --sysconfdir=$HOME/bacula/bin \
1444 --mandir=$HOME/bacula/bin \
1445 --enable-smartalloc \
1448 --with-qwt=$HOME/bacula/depkgs/qwt \
1449 --enable-bwx-console \
1450 --enable-tray-monitor \
1451 --with-pid-dir=$HOME/bacula/bin/working \
1452 --with-subsys-dir=$HOME/bacula/bin/working \
1454 --with-working-dir=$HOME/bacula/bin/working \
1455 --with-dump-email=$USER@your-site.com \
1456 --with-job-email=$USER@your-site.com \
1457 --with-smtp-host=mail.your-site.com
1462 You may also want to put the following entries in your {\bf /etc/services}
1463 file as it will make viewing the connections made by Bacula easier to
1464 recognize (i.e. netstat -a):
1474 \section{Installing Bacula}
1475 \index[general]{Bacula!Installing}
1476 \index[general]{Installing Bacula}
1478 Before setting up your configuration files, you will want to install Bacula in
1479 its final location. Simply enter:
1487 If you have previously installed Bacula, the old binaries will be overwritten,
1488 but the old configuration files will remain unchanged, and the "new"
1489 configuration files will be appended with a {\bf .new}. Generally if you have
1490 previously installed and run Bacula you will want to discard or ignore the
1491 configuration files with the appended {\bf .new}.
1493 \section{Building a File Daemon or Client}
1494 \index[general]{Client!Building a File Daemon or}
1495 \index[general]{Building a File Daemon or Client}
1497 If you run the Director and the Storage daemon on one machine and you wish to
1498 back up another machine, you must have a copy of the File daemon for that
1499 machine. If the machine and the Operating System are identical, you can simply
1500 copy the Bacula File daemon binary file {\bf bacula-fd} as well as its
1501 configuration file {\bf bacula-fd.conf} then modify the name and password in
1502 the conf file to be unique. Be sure to make corresponding additions to the
1503 Director's configuration file ({\bf bacula-dir.conf}).
1505 If the architecture or the OS level are different, you will need to build a
1506 File daemon on the Client machine. To do so, you can use the same {\bf
1507 ./configure} command as you did for your main program, starting either from a
1508 fresh copy of the source tree, or using {\bf make\ distclean} before the {\bf
1511 Since the File daemon does not access the Catalog database, you can remove
1512 the {\bf \verb:--:with-mysql} or {\bf \verb:--:with-sqlite} options, then
1513 add {\bf \verb:--:enable-client-only}. This will compile only the
1514 necessary libraries and the client programs and thus avoids the necessity
1515 of installing one or another of those database programs to build the File
1516 daemon. With the above option, you simply enter {\bf make} and just the
1517 client will be built.
1520 \section{Auto Starting the Daemons}
1521 \index[general]{Daemons!Auto Starting the}
1522 \index[general]{Auto Starting the Daemons}
1524 If you wish the daemons to be automatically started and stopped when your
1525 system is booted (a good idea), one more step is necessary. First, the
1526 ./configure process must recognize your system -- that is it must be a
1527 supported platform and not {\bf unknown}, then you must install the platform
1528 dependent files by doing:
1533 make install-autostart
1537 Please note, that the auto-start feature is implemented only on systems
1538 that we officially support (currently, FreeBSD, Red Hat/Fedora Linux, and
1539 Solaris), and has only been fully tested on Fedora Linux.
1541 The {\bf make install-autostart} will cause the appropriate startup scripts
1542 to be installed with the necessary symbolic links. On Red Hat/Fedora Linux
1543 systems, these scripts reside in {\bf /etc/rc.d/init.d/bacula-dir} {\bf
1544 /etc/rc.d/init.d/bacula-fd}, and {\bf /etc/rc.d/init.d/bacula-sd}. However
1545 the exact location depends on what operating system you are using.
1547 If you only wish to install the File daemon, you may do so with:
1551 make install-autostart-fd
1555 \section{Other Make Notes}
1556 \index[general]{Notes!Other Make}
1557 \index[general]{Other Make Notes}
1559 To simply build a new executable in any directory, enter:
1567 To clean out all the objects and binaries (including the files named 1, 2, or
1568 3, which are development temporary files), enter:
1576 To really clean out everything for distribution, enter:
1584 note, this cleans out the Makefiles and is normally done from the top level
1585 directory to prepare for distribution of the source. To recover from this
1586 state, you must redo the {\bf ./configure} in the top level directory, since
1587 all the Makefiles will be deleted.
1589 To add a new file in a subdirectory, edit the Makefile.in in that directory,
1590 then simply do a {\bf make}. In most cases, the make will rebuild the Makefile
1591 from the new Makefile.in. In some case, you may need to issue the {\bf make} a
1592 second time. In extreme cases, cd to the top level directory and enter: {\bf
1595 To add dependencies:
1603 The {\bf make depend} appends the header file dependencies for each of the
1604 object files to Makefile and Makefile.in. This command should be done in each
1605 directory where you change the dependencies. Normally, it only needs to be run
1606 when you add or delete source or header files. {\bf make depend} is normally
1607 automatically invoked during the configuration process.
1617 This not normally done if you are developing Bacula, but is used if you are
1618 going to run it to backup your system.
1620 After doing a {\bf make install} the following files will be installed on your
1621 system (more or less). The exact files and location (directory) for each file
1622 depends on your {\bf ./configure} command (e.g. bgnome-console and
1623 bgnome-console.conf are not installed if you do not configure GNOME. Also, if
1624 you are using SQLite instead of MySQL, some of the files will be different).
1626 NOTE: it is quite probable that this list is out of date. But it is a
1648 create_mysql_database
1650 delete_catalog_backup
1671 \section{Installing Tray Monitor}
1672 \index[general]{Monitor!Installing Tray}
1673 \index[general]{Installing Tray Monitor}
1675 The Tray Monitor is already installed if you used the {\bf
1676 \verb:--:enable-tray-monitor} configure option and ran {\bf make install}.
1678 As you don't run your graphical environment as root (if you do, you should
1679 change that bad habit), don't forget to allow your user to read {\bf
1680 tray-monitor.conf}, and to execute {\bf bacula-tray-monitor} (this is not a
1683 Then log into your graphical environment (KDE, GNOME or something else), run
1684 {\bf bacula-tray-monitor} as your user, and see if a cassette icon appears
1685 somewhere on the screen, usually on the task bar.
1686 If it doesn't, follow the instructions below related to your environment or
1690 \index[general]{GNOME}
1692 System tray, or notification area if you use the GNOME terminology, has been
1693 supported in GNOME since version 2.2. To activate it, right-click on one of
1694 your panels, open the menu {\bf Add to this Panel}, then {\bf Utility} and
1695 finally click on {\bf Notification Area}.
1698 \index[general]{KDE}
1700 System tray has been supported in KDE since version 3.1. To activate it,
1701 right-click on one of your panels, open the menu {\bf Add}, then {\bf Applet}
1702 and finally click on {\bf System Tray}.
1704 \subsection{Other window managers}
1705 \index[general]{Managers!Other window}
1706 \index[general]{Other window managers}
1708 Read the documentation to know if the Freedesktop system tray standard is
1709 supported by your window manager, and if applicable, how to activate it.
1711 \section{Modifying the Bacula Configuration Files}
1712 \index[general]{Modifying the Bacula Configuration Files}
1713 \index[general]{Files!Modifying the Bacula Configuration}
1716 \ilink{Configuring Bacula}{ConfigureChapter} in this manual for
1717 instructions on how to set Bacula configuration files.