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 {SQLite3 } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ }\\
295 \hline {mtx } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ } \\
296 \hline {qt4 } & \multicolumn{1}{c| }{ } & \multicolumn{1}{c| }{X } \\
300 Note, some of these packages are quite large, so that building them can be a
301 bit time consuming. The above instructions will build all the packages
302 contained in the directory. However, when building Bacula, it will take only
303 those pieces that it actually needs.
305 Alternatively, you can make just the packages that are needed. For example,
314 will configure and build only the SQLite package.
316 You should build the packages that you will require in {\bf depkgs} a
317 prior to configuring and building Bacula, since Bacula will need
318 them during the build process.
320 For more information on the {\bf depkgs-qt} package, please read the
321 INSTALL file in the main directory of that package. If you are going to
322 build Qt4 using {\bf depkgs-qt}, you must source the {\bf qt4-paths} file
323 included in the package prior to building Bacula. Please read the INSTALL
324 file for more details.
326 Even if you do not use SQLite, you might find it worthwhile to build {\bf mtx}
327 because the {\bf tapeinfo} program that comes with it can often provide you
328 with valuable information about your SCSI tape drive (e.g. compression,
329 min/max block sizes, ...). Note, most distros provide {\bf mtx} as part of
332 The {\bf depkgs1} package is depreciated and previously contained
333 readline, which should be available on all operating systems.
335 The {\bf depkgs-win32} package is deprecated and no longer used in
336 Bacula version 1.39.x and later. It was previously used to build
337 the native Win32 client program, but this program is now built on Linux
338 systems using cross-compiling. All the tools and third party libraries
339 are automatically downloaded by executing the appropriate scripts. See
340 src/win32/README.mingw32 for more details.
342 \section{Supported Operating Systems}
344 \index[general]{Systems!Supported Operating}
345 \index[general]{Supported Operating Systems}
348 \ilink{ Supported Operating Systems}{SupportedOSes} section
349 of the QuickStart chapter of this manual.
351 \section{Building Bacula from Source}
353 \index[general]{Source!Building Bacula from}
354 \index[general]{Building Bacula from Source}
356 The basic installation is rather simple.
359 \item Install and build any {\bf depkgs} as noted above. This
360 should be unnecessary on most modern Operating Systems.
362 \item Configure and install MySQL or PostgreSQL (if desired).
363 \ilink{Installing and Configuring MySQL Phase I}{MySqlChapter} or
364 \ilink{Installing and Configuring PostgreSQL Phase
365 I}{PostgreSqlChapter}. If you are installing from rpms, and are
366 using MySQL, please be sure to install {\bf mysql-devel}, so that the MySQL
367 header files are available while compiling Bacula. In addition, the MySQL
368 client library {\bf mysqlclient} requires the gzip compression library {\bf
369 libz.a} or {\bf libz.so}. If you are using rpm packages, these libraries are
370 in the {\bf libz-devel} package. On Debian systems, you will need to load the
371 {\bf zlib1g-dev} package. If you are not using rpms or debs, you will need to
372 find the appropriate package for your system.
374 Note, if you already have a running MySQL or PostgreSQL on your system, you
375 can skip this phase provided that you have built the thread safe libraries.
376 And you have already installed the additional rpms noted above.
378 SQLite is not supported on Solaris. This is because it
379 frequently fails with bus errors. However SQLite3 may work.
381 \item Detar the Bacula source code preferably into the {\bf bacula} directory
384 \item {\bf cd} to the directory containing the source code.
386 \item ./configure (with appropriate options as described below). Any
387 path names you specify as options on the ./configure command line
388 must be absolute paths and not relative.
390 \item Check the output of ./configure very carefully, especially the Install
391 binaries and Install config directories. If they are not correct,
392 please rerun ./configure until they are. The output from ./configure is
393 stored in {\bf config.out} and can be re-displayed at any time without
394 rerunning the ./configure by doing {\bf cat config.out}.
396 \item If after running ./configure once, you decide to change options and
397 re-run it, that is perfectly fine, but before re-running it, you should run:
405 so that you are sure to start from scratch and not have a mixture of the two
406 options. This is because ./configure caches much of the information. The {\bf
407 make distclean} is also critical if you move the source directory from one
408 machine to another. If the {\bf make distclean} fails, just ignore it and
412 If you get errors while linking in the Storage daemon directory
413 (src/stored), it is probably because you have not loaded the static
414 libraries on your system. I noticed this problem on a Solaris system.
415 To correct it, make sure that you have not added {\bf
416 {-} {-}enable-static-tools} to the {\bf ./configure} command.
418 If you skip this step ({\bf make}) and proceed immediately to the {\bf
419 make install} you are making two serious errors: 1. your install will
420 fail because Bacula requires a {\bf make} before a {\bf make install}.
421 2. you are depriving yourself of the chance to make sure there are no
422 errors before beginning to write files to your system directories.
426 Please be sure you have done a {\bf make} before entering this command,
427 and that everything has properly compiled and linked without errors.
430 \item If you are new to Bacula, we {\bf strongly} recommend that you skip
431 the next step and use the default configuration files, then run the
432 example program in the next chapter, then come back and modify your
433 configuration files to suit your particular needs.
435 \item Customize the configuration files for each of the three daemons
436 (Directory, File, Storage) and for the Console program. For the details
437 of how to do this, please see \ilink{Setting Up Bacula Configuration
438 Files}{ConfigureChapter} in the Configuration chapter of this manual. We
439 recommend that you start by modifying the default configuration files
440 supplied, making the minimum changes necessary. Complete customization
441 can be done after you have Bacula up and running. Please take care when
442 modifying passwords, which were randomly generated, and the {\bf Name}s
443 as the passwords and names must agree between the configuration files
444 for security reasons.
446 \label{CreateDatabase}
447 \item Create the Bacula MySQL database and tables
449 \ilink{Installing and Configuring MySQL Phase II}{mysql_phase2} or
450 create the Bacula PostgreSQL database and tables
451 \ilink{Configuring PostgreSQL
452 II}{PostgreSQL_configure} or alternatively if you are using
453 SQLite \ilink{Installing and Configuring SQLite Phase II}{phase2}.
455 \item Start Bacula ({\bf ./bacula start}) Note. the next chapter shows you
456 how to do this in detail.
458 \item Interface with Bacula using the Console program
460 \item For the previous two items, please follow the instructions in the
461 \ilink{Running Bacula}{TutorialChapter} chapter of this manual,
462 where you will run a simple backup and do a restore. Do this before you make
463 heavy modifications to the configuration files so that you are sure that
464 Bacula works and are familiar with it. After that changing the conf files
467 \item If after installing Bacula, you decide to "move it", that is to
468 install it in a different set of directories, proceed as follows:
474 ./configure (your-new-options)
483 If all goes well, the {\bf ./configure} will correctly determine which
484 operating system you are running and configure the source code appropriately.
485 Currently, FreeBSD, Linux (Red Hat), and Solaris are supported. The Bacula
486 client (File daemon) is reported to work with MacOS X 10.3 is if
487 readline support is not enabled (default) when building the client.
489 If you install Bacula on more than one system, and they are identical, you can
490 simply transfer the source tree to that other system and do a "make
491 install". However, if there are differences in the libraries or OS versions,
492 or you wish to install on a different OS, you should start from the original
493 compress tar file. If you do transfer the source tree, and you have previously
494 done a ./configure command, you MUST do:
502 prior to doing your new ./configure. This is because the GNU autoconf tools
503 cache the configuration, and if you re-use a configuration for a Linux machine
504 on a Solaris, you can be sure your build will fail. To avoid this, as
505 mentioned above, either start from the tar file, or do a "make distclean".
507 In general, you will probably want to supply a more complicated {\bf
508 configure} statement to ensure that the modules you want are built and that
509 everything is placed into the correct directories.
511 For example, on Fedora, Red Hat, or SuSE one could use the following:
517 --sbindir=$HOME/bacula/bin \
518 --sysconfdir=$HOME/bacula/bin \
519 --with-pid-dir=$HOME/bacula/bin/working \
520 --with-subsys-dir=$HOME/bacula/bin/working \
522 --with-working-dir=$HOME/bacula/bin/working \
523 --with-dump-email=$USER
527 The advantage of using the above configuration to start is that
528 everything will be put into a single directory, which you can later delete
529 once you have run the examples in the next chapter and learned how Bacula
530 works. In addition, the above can be installed and run as non-root.
532 For the developer's convenience, I have added a {\bf defaultconfig} script to
533 the {\bf examples} directory. This script contains the statements that you
534 would normally use, and each developer/user may modify them to suit his needs.
535 You should find additional useful examples in this directory as well.
537 The {\bf \verb:--:enable-conio} or {\bf \verb:--:enable-readline} options are
538 useful because they provide a command line history, editing capability for the
539 Console program and tab completion on various option. If you have included
540 either option in the build, either the {\bf termcap} or the {\bf ncurses}
541 package will be needed to link. On most systems, including Red Hat and SuSE,
542 you should include the ncurses package. If Bacula's configure process finds
543 the ncurses libraries, it will use those rather than the termcap library. On
544 some systems, such as SuSE, the termcap library is not in the standard library
545 directory. As a consequence, the option may be disabled or you may get an
546 error message such as:
550 /usr/lib/gcc-lib/i586-suse-linux/3.3.1/.../ld:
551 cannot find -ltermcap
552 collect2: ld returned 1 exit status
556 while building the Bacula Console. In that case, you will need to set the {\bf
557 LDFLAGS} environment variable prior to building.
561 export LDFLAGS="-L/usr/lib/termcap"
565 The same library requirements apply if you wish to use the readline subroutines
566 for command line editing, history and tab completion or if you are using a
567 MySQL library that requires encryption. If you need encryption, you can either
568 export the appropriate additional library options as shown above or,
569 alternatively, you can include them directly on the ./configure line as in:
573 LDFLAGS="-lssl -lcyrpto" \
574 ./configure <your-options>
578 On some systems such as Mandriva, readline tends to
579 gobble up prompts, which makes it totally useless. If this happens to you, use
580 the disable option, or if you are using version 1.33 and above try using {\bf
581 \verb:--:enable-conio} to use a built-in readline replacement. You will still need
582 either the termcap or the ncurses library, but it is unlikely that the {\bf conio}
583 package will gobble up prompts.
585 readline is no longer supported after version 1.34. The code within Bacula
586 remains, so it should be usable, and if users submit patches for it, we will
587 be happy to apply them. However, due to the fact that each version of
588 readline seems to be incompatible with previous versions, and that there
589 are significant differences between systems, we can no longer afford to
592 \section{What Database to Use?}
594 \index[general]{What Database to Use?}
595 \index[general]{Use!What Database to}
597 Before building Bacula you need to decide if you want to use SQLite, MySQL, or
598 PostgreSQL. If you are not already running MySQL or PostgreSQL, you might
599 want to start by testing with SQLite (not supported on Solaris).
600 This will greatly simplify the setup for you
601 because SQLite is compiled into Bacula an requires no administration. It
602 performs well and is suitable for small to medium sized installations (maximum
603 10-20 machines). However, we should note that a number of users have
604 had unexplained database corruption with SQLite. For that reason, we
605 recommend that you install either MySQL or PostgreSQL for production
608 If you wish to use MySQL as the Bacula catalog, please see the
609 \ilink{Installing and Configuring MySQL}{MySqlChapter} chapter of
610 this manual. You will need to install MySQL prior to continuing with the
611 configuration of Bacula. MySQL is a high quality database that is very
612 efficient and is suitable for any sized installation. It is slightly more
613 complicated than SQLite to setup and administer because it has a number of
614 sophisticated features such as userids and passwords. It runs as a separate
615 process, is truly professional and can manage a database of any size.
617 If you wish to use PostgreSQL as the Bacula catalog, please see the
618 \ilink{Installing and Configuring PostgreSQL}{PostgreSqlChapter}
619 chapter of this manual. You will need to install PostgreSQL prior to
620 continuing with the configuration of Bacula. PostgreSQL is very similar to
621 MySQL, though it tends to be slightly more SQL92 compliant and has many more
622 advanced features such as transactions, stored procedures, and the such. It
623 requires a certain knowledge to install and maintain.
625 If you wish to use SQLite as the Bacula catalog, please see
626 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
627 this manual. SQLite is not supported on Solaris.
629 \section{Quick Start}
630 \index[general]{Quick Start}
631 \index[general]{Start!Quick}
633 There are a number of options and important considerations given below
634 that you can skip for the moment if you have not had any problems building
635 Bacula with a simplified configuration as shown above.
637 If the ./configure process is unable to find specific libraries (e.g.
638 libintl, you should ensure that the appropriate package is installed on
639 your system. Alternatively, if the package is installed in a non-standard
640 location (as far as Bacula is concerned), then there is generally an
641 option listed below (or listed with "./configure {-} {-}help" that will
642 permit you to specify the directory that should be searched. In other
643 cases, there are options that will permit you to disable to feature
644 (e.g. {-} {-}disable-nls).
646 If you want to dive right into it, we recommend you skip to the next chapter,
647 and run the example program. It will teach you a lot about Bacula and as an
648 example can be installed into a single directory (for easy removal) and run as
649 non-root. If you have any problems or when you want to do a real installation,
650 come back to this chapter and read the details presented below.
652 \section{Configure Options}
654 \index[general]{Options!Configure}
655 \index[general]{Configure Options}
657 The following command line options are available for {\bf configure} to
658 customize your installation.
661 \item [ \--prefix=\lt{}patch\gt{}]
662 \index[general]{{-}prefix}
663 This option is meant to allow you to direct where the architecture
664 independent files should be placed. However, we find this a somewhat
665 vague concept, and so we have not implemented this option other than
666 what ./configure does by default. As a consequence, we suggest that
667 you avoid it. We have provided options that allow you to explicitly
668 specify the directories for each of the major categories of installation
670 \item [ {-}{\-}sbindir=\lt{}binary-path\gt{}]
671 \index[general]{{-}{\-}sbindir}
672 Defines where the Bacula binary (executable) files will be placed during a
673 {\bf make install} command.
675 \item [ {-}{\-}sysconfdir=\lt{}config-path\gt{}]
676 \index[general]{{-}{\-}sysconfdir}
677 Defines where the Bacula configuration files should be placed during a
678 {\bf make install} command.
680 \item [ {-}{\-}mandir=\lt{}path\gt{}]
681 \index[general]{{-}{\-}mandir}
682 Note, as of Bacula version 1.39.14, the meaning of any path
683 specified on this option is change from prior versions. It
684 now specifies the top level man directory.
685 Previously the mandir specified the full path to where you
686 wanted the man files installed.
687 The man files will be installed in gzip'ed format under
688 mandir/man1 and mandir/man8 as appropriate.
689 For the install to succeed you must have {\bf gzip} installed
692 By default, Bacula will install the Unix man pages in
693 /usr/share/man/man1 and /usr/share/man/man8.
694 If you wish the man page to be installed in
695 a different location, use this option to specify the path.
696 Note, the main HTML and PDF Bacula documents are in a separate
697 tar file that is not part of the source distribution.
699 \item [ {-}{\-}datadir=\lt{}path\gt{} ]
700 \index[general]{{-}{\-}datadir}
701 If you translate Bacula or parts of Bacula into a different language
702 you may specify the location of the po files using the {\bf
703 {-}{\-}datadir} option. You must manually install any po files as
704 Bacula does not (yet) automatically do so.
706 \item [ {-}{\-}disable-ipv6 ]
707 \index[general]{{-}{\-}disable-ipv6}
709 \item [ {-}{\-}enable-smartalloc ]
710 \index[general]{{-}{\-}enable-smartalloc}
711 This enables the inclusion of the Smartalloc orphaned buffer detection
712 code. This option is highly recommended. Because we never build
713 without this option, you may experience problems if it is not enabled.
714 In this case, simply re-enable the option. We strongly recommend
715 keeping this option enabled as it helps detect memory leaks. This
716 configuration parameter is used while building Bacula
718 \item [ {-}{\-}enable-bat ]
720 \index[general]{{-}{\-}enable-bat}
721 If you have Qt4 >= 4.3.4 installed on your computer including the
722 libqt4 and libqt4-devel (libqt4-dev on Debian) libraries, and you want
723 to use the Bacula Administration Tool (bat) GUI Console interface to
724 Bacula, you must specify this option. Doing so will build everything in
725 the {\bf src/qt-console} directory. The build with enable-bat will work
726 only with a full Bacula build (i.e. it will not work with a client-only
729 Qt4 is available on OpenSUSE 10.2, CentOS 5, Fedora, and Debian. If it
730 is not available on your system, you can download the {\bf depkgs-qt}
731 package from the Bacula Source Forge download area and build it.
733 INSTALL file in that package for more details. In particular to use
734 the Qt4 built by {\bf depkgs-qt} you {\bf must} source the file
737 \item [ {-}{\-}enable-batch-insert ]
738 \index[general]{{-}{\-}enable-batch-insert}
739 This option enables batch inserts of the attribute records (default) in
740 the catalog database, which is much faster (10 times or more) than
741 without this option for large numbers of files. However, this option
742 will automatically be disabled if your SQL libraries are not
743 thread safe. If you find that batch mode is not enabled on your Bacula
744 installation, then your database most likely does not support threads.
746 SQLite2 is not thread safe. Batch insert cannot be enabled when using
749 On most systems, MySQL, PostgreSQL and SQLite3 are thread safe.
751 To verify that your PostgreSQL is thread safe, you can try this
752 (change the path to point to your particular installed libpq.a;
753 these commands were issued on FreeBSD 6.2):
756 $ nm /usr/local/lib/libpq.a | grep PQputCopyData
757 00001b08 T PQputCopyData
758 $ nm /usr/local/lib/libpq.a | grep mutex
760 U pthread_mutex_unlock
763 U pthread_mutex_unlock
766 The above example shows a libpq that contains the required function
767 PQputCopyData and is thread enabled (i.e. the pthread\_mutex* entries).
768 If you do not see PQputCopyData, your version of PostgreSQL is too old
769 to allow batch insert. If you do not see the mutex entries, then thread
770 support has not been enabled. Our tests indicate you usually need to
771 change the configuration options and recompile/reinstall the PostgreSQL
772 client software to get thread support.
774 Bacula always links to the thread safe MySQL libraries.
776 Running with Batch Insert turned on is recommended because it can
777 significantly improve attribute insertion times. However, it does
778 put a significantly larger part of the work on your SQL engine, so
779 you may need to pay more attention to tuning it. In particular,
780 Batch Insert can require large temporary table space, and consequently,
781 the default location (often /tmp) may run out of space causing errors.
782 For MySQL, the location is set in my.conf with "tmpdir". You may also
783 want to increase the memory available to your SQL engine to further
784 improve performance during Batch Inserts.
786 \item [ {-}{\-}enable-bwx-console ]
787 \index[general]{{-}{\-}enable-bwx-console}
788 If you have wxWidgets installed on your computer and you want to use the
789 wxWidgets GUI Console interface to Bacula, you must specify this option.
790 Doing so will build everything in the {\bf src/wx-console} directory.
791 This could also be useful to users who want a GUI Console and don't want
792 to install QT, as wxWidgets can work with GTK+, Motif or even X11
795 \item [ {-}{\-}enable-tray-monitor ]
796 \index[general]{{-}{\-}enable-tray-monitor}
797 If you have GTK installed on your computer, you run a graphical
798 environment or a window manager compatible with the FreeDesktop system
799 tray standard (like KDE and GNOME) and you want to use a GUI to monitor
800 Bacula daemons, you must specify this option. Doing so will build
801 everything in the {\bf src/tray-monitor} directory. Note, due to
802 restrictions on what can be linked with GPLed code, we were forced to
803 remove the egg code that dealt with the tray icons and replace it by
804 calls to the GTK+ API, and unfortunately, the tray icon API necessary
805 was not implemented until GTK version 2.10 or later.
807 \item [ {-}{\-}enable-static-tools]
808 \index[general]{{-}{\-}enable-static-tools}
809 This option causes the linker to link the Storage daemon utility tools
810 ({\bf bls}, {\bf bextract}, and {\bf bscan}) statically. This permits
811 using them without having the shared libraries loaded. If you have
812 problems linking in the {\bf src/stored} directory, make sure you have
813 not enabled this option, or explicitly disable static linking by adding
814 {\bf \verb:--:disable-static-tools}.
816 \item [ {-}{\-}enable-static-fd]
817 \index[general]{{-}{\-}enable-static-fd}
818 This option causes the make process to build a {\bf static-bacula-fd} in
819 addition to the standard File daemon. This static version will include
820 statically linked libraries and is required for the Bare Metal recovery.
821 This option is largely superseded by using {\bf make static-bacula-fd}
822 from with in the {\bf src/filed} directory. Also, the {\bf
823 \verb:--:enable-client-only} option described below is useful for just
824 building a client so that all the other parts of the program are not
827 When linking a static binary, the linker needs the static versions
828 of all the libraries that are used, so frequently users will
829 experience linking errors when this option is used. The first
830 thing to do is to make sure you have the static glibc library
831 installed on your system. The second thing to do is the make sure
832 you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
833 on your ./configure statement as these options require additional
834 libraries. You may be able to enable those options, but you will
835 need to load additional static libraries.
838 \item [ {-}{\-}enable-static-sd]
839 \index[general]{{-}{\-}enable-static-sd}
840 This option causes the make process to build a {\bf static-bacula-sd} in
841 addition to the standard Storage daemon. This static version will
842 include statically linked libraries and could be useful during a Bare
845 When linking a static binary, the linker needs the static versions
846 of all the libraries that are used, so frequently users will
847 experience linking errors when this option is used. The first
848 thing to do is to make sure you have the static glibc library
849 installed on your system. The second thing to do is the make sure
850 you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
851 on your ./configure statement as these options require additional
852 libraries. You may be able to enable those options, but you will
853 need to load additional static libraries.
856 \item [ {-}{\-}enable-static-dir]
857 \index[general]{{-}{\-}enable-static-dir}
858 This option causes the make process to build a {\bf static-bacula-dir}
859 in addition to the standard Director. This static version will include
860 statically linked libraries and could be useful during a Bare Metal
863 When linking a static binary, the linker needs the static versions
864 of all the libraries that are used, so frequently users will
865 experience linking errors when this option is used. The first
866 thing to do is to make sure you have the static glibc library
867 installed on your system. The second thing to do is the make sure
868 you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
869 on your ./configure statement as these options require additional
870 libraries. You may be able to enable those options, but you will
871 need to load additional static libraries.
874 \item [ {-}{\-}enable-static-cons]
875 \index[general]{{-}{\-}enable-static-cons}
876 This option causes the make process to build a {\bf static-console} in
877 addition to the standard console. This static version will include
878 statically linked libraries and could be useful during a Bare Metal
881 When linking a static binary, the linker needs the static versions
882 of all the libraries that are used, so frequently users will
883 experience linking errors when this option is used. The first
884 thing to do is to make sure you have the static glibc library
885 installed on your system. The second thing to do is the make sure
886 you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
887 on your ./configure statement as these options require additional
888 libraries. You may be able to enable those options, but you will
889 need to load additional static libraries.
892 \item [ {-}{\-}enable-client-only]
893 \index[general]{{-}{\-}enable-client-only}
894 This option causes the make process to build only the File daemon and
895 the libraries that it needs. None of the other daemons, storage tools,
896 nor the console will be built. Likewise a {\bf make install} will then
897 only install the File daemon. To cause all daemons to be built, you
898 will need to do a configuration without this option. This option
899 greatly facilitates building a Client on a client only machine.
901 When linking a static binary, the linker needs the static versions
902 of all the libraries that are used, so frequently users will
903 experience linking errors when this option is used. The first
904 thing to do is to make sure you have the static glibc library
905 installed on your system. The second thing to do is the make sure
906 you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
907 on your ./configure statement as these options require additional
908 libraries. You may be able to enable those options, but you will
909 need to load additional static libraries.
911 \item [ {-}{\-}enable-build-dird]
912 \index[general]{{-}{\-}enable-build-dird}
913 This option causes the make process to build the Director and the
914 Director's tools. By default, this option is on, but you may turn
915 it off by using {\bf {-}{\-}disable-build-dird} to prevent the
916 Director from being built.
918 \item [ {-}{\-}enable-build-stored]
919 \index[general]{{-}{\-}enable-build-stored}
920 This option causes the make process to build the Storage daemon.
921 By default, this option is on, but you may turn
922 it off by using {\bf {-}{\-}disable-build-stored} to prevent the
923 Storage daemon from being built.
926 \item [ {-}{\-}enable-largefile]
927 \index[general]{{-}{\-}enable-largefile}
928 This option (default) causes Bacula to be built with 64 bit file address
929 support if it is available on your system. This permits Bacula to read and
930 write files greater than 2 GBytes in size. You may disable this feature and
931 revert to 32 bit file addresses by using {\bf \verb:--:disable-largefile}.
933 \item [ {-}{\-}disable-nls]
934 \index[general]{{-}{\-}disable-nls}
935 By default, Bacula uses the GNU Native Language Support (NLS) libraries. On
936 some machines, these libraries may not be present or may not function
937 correctly (especially on non-Linux implementations). In such cases, you
938 may specify {\bf {-}{\-}disable-nls} to disable use of those libraries.
939 In such a case, Bacula will revert to using English.
941 \item [ {-}{\-}disable-ipv6 ]
942 \index[general]{{-}{\-}disable-ipv6}
943 By default, Bacula enables IPv6 protocol. On some systems, the files
944 for IPv6 may exist, but the functionality could be turned off in the
945 kernel. In that case, in order to correctly build Bacula, you will
946 explicitly need to use this option so that Bacula does not attempt
947 to reference OS function calls that do not exist.
949 \item [ {-}{\-}with-sqlite3=\lt{}sqlite3-path\gt{}]
950 \index[general]{{-}{\-}with-sqlite3}
951 This enables use of the SQLite version 3.x database. The {\bf
952 sqlite3-path} is not normally specified as Bacula looks for the
953 necessary components in a standard location ({\bf depkgs/sqlite3}). See
954 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
955 this manual for more details. SQLite3 is not supported on Solaris.
957 \item [ {-}{\-}with-mysql=\lt{}mysql-path\gt{}]
958 \index[general]{{-}{\-}with-mysql}
959 This enables building of the Catalog services for Bacula. It assumes
960 that MySQL is running on your system, and expects it to be installed in
961 the {\bf mysql-path} that you specify. Normally, if MySQL is installed
962 in a standard system location, you can simply use {\bf {-}{\-}with-mysql}
963 with no path specification. If you do use this option, please proceed
964 to installing MySQL in the \ilink{Installing and Configuring
965 MySQL}{MySqlChapter} chapter before proceeding with the configuration.
967 See the note below under the {-}{\-}with-postgresql item.
969 \item [ {-}{\-}with-postgresql=\lt{}path\gt{}]
970 \index[general]{{-}{\-}with-postgresql}
971 This provides an explicit path to the PostgreSQL libraries if Bacula
972 cannot find it by default. Normally to build with PostgreSQL, you would
973 simply use {\bf {-}{\-}with-postgresql}.
975 Note, for Bacula to be configured properly, you must specify one
976 of the four database options supported. That is:
977 {-}{\-}with-sqlite, {-}{\-}with-sqlite3, {-}{\-}with-mysql, or
978 {-}{\-}with-postgresql, otherwise the ./configure will fail.
980 \item [ {-}{\-}with-openssl=\lt{}path\gt{}]
981 This configuration option is necessary if you want to enable TLS (ssl),
982 which encrypts the communications within
983 Bacula or if you want to use File Daemon PKI data encryption.
984 Normally, the {\bf path} specification is not necessary since
985 the configuration searches for the OpenSSL libraries in standard system
986 locations. Enabling OpenSSL in Bacula permits secure communications
987 between the daemons and/or data encryption in the File daemon.
988 For more information on using TLS, please see the
989 \ilink{Bacula TLS -- Communications Encryption}{CommEncryption} chapter
991 For more information on using PKI data encryption, please see the
992 \ilink{Bacula PKI -- Data Encryption}{DataEncryption}
993 chapter of this manual.
995 \item [ {-}{\-}with-python=\lt{}path\gt{}]
996 \index[general]{{-}{\-}with-python}
997 This option enables Bacula support for Python. If no path is supplied,
998 configure will search the standard library locations for Python 2.2,
999 2.3, 2.4, or 2.5. If it cannot find the library, you will need to
1000 supply a path to your Python library directory. Please see the
1001 \ilink{Python chapter}{PythonChapter} for the details of using Python
1004 \item [ {-}{\-}with-libintl-prefix=\lt{}DIR\gt{}]
1005 \index[general]{{-}{\-}with-libintl-prefix}
1006 This option may be used to tell Bacula to search DIR/include and
1007 DIR/lib for the libintl headers and libraries needed for Native
1008 Language Support (NLS).
1010 \item [ {-}{\-}enable-conio]
1011 \index[general]{{-}{\-}enable-conio}
1012 Tells Bacula to enable building the small, light weight readline
1013 replacement routine. It is generally much easier to configure than
1014 readline, although, like readline, it needs either the termcap or
1017 \item [ {-}{\-}with-readline=\lt{}readline-path\gt{}]
1018 \index[general]{{-}{\-}with-readline}
1019 Tells Bacula where {\bf readline} is installed. Normally, Bacula will
1020 find readline if it is in a standard library. If it is not found and no
1021 {-}{\-}with-readline is specified, readline will be disabled. This
1022 option affects the Bacula build. Readline provides the Console program
1023 with a command line history and editing capability and is no longer
1024 supported, so you are on your own if you have problems.
1026 \item [ {-}{\-}enable-readline]
1027 \index[general]{{-}{\-}enable-readline}
1028 Tells Bacula to enable readline support. It is normally disabled due to the
1029 large number of configuration problems and the fact that the package seems to
1030 change in incompatible ways from version to version.
1032 \item [ {-}{\-}with-tcp-wrappers=\lt{}path\gt{}]
1033 \index[general]{{-}{\-}with-tcp-wrappers}
1034 \index[general]{TCP Wrappers}
1035 \index[general]{Wrappers!TCP}
1036 \index[general]{libwrappers}
1037 This specifies that you want TCP wrappers (man hosts\_access(5)) compiled in.
1038 The path is optional since Bacula will normally find the libraries in the
1039 standard locations. This option affects the Bacula build. In specifying your
1040 restrictions in the {\bf /etc/hosts.allow} or {\bf /etc/hosts.deny} files, do
1041 not use the {\bf twist} option (hosts\_options(5)) or the Bacula process will
1042 be terminated. Note, when setting up your {\bf /etc/hosts.allow}
1043 or {\bf /etc/hosts.deny}, you must identify the Bacula daemon in
1044 question with the name you give it in your conf file rather than the
1045 name of the executable.
1047 For more information on configuring and testing TCP wrappers, please see the
1048 \ilink{Configuring and Testing TCP Wrappers}{wrappers} section
1049 in the Security Chapter.
1051 On SuSE, the libwrappers libraries needed to link Bacula are
1052 contained in the tcpd-devel package. On Red Hat, the package is named
1055 \item [ {-}{\-}with-archivedir=\lt{}path\gt{} ]
1056 \index[general]{{-}{\-}with-archivedir}
1057 The directory used for disk-based backups. Default value is /tmp.
1058 This parameter sets the default values in the bacula-dir.conf and bacula-sd.conf
1059 configuration files. For example, it sets the Where directive for the
1060 default restore job and the Archive Device directive for the FileStorage
1063 This option is designed primarily for use in regression testing.
1064 Most users can safely ignore this option.
1066 \item [ {-}{\-}with-working-dir=\lt{}working-directory-path\gt{} ]
1067 \index[general]{{-}{\-}with-working-dir}
1068 This option is mandatory and specifies a directory into which Bacula may
1069 safely place files that will remain between Bacula executions. For example,
1070 if the internal database is used, Bacula will keep those files in this
1071 directory. This option is only used to modify the daemon configuration
1072 files. You may also accomplish the same thing by directly editing them later.
1073 The working directory is not automatically created by the install process, so
1074 you must ensure that it exists before using Bacula for the first time.
1076 \item [ {-}{\-}with-base-port=\lt{}port=number\gt{}]
1077 \index[general]{{-}{\-}with-base-port}
1078 In order to run, Bacula needs three TCP/IP ports (one for the Bacula
1079 Console, one for the Storage daemon, and one for the File daemon). The {\bf
1080 \verb:--:with-baseport} option will automatically assign three ports beginning at
1081 the base port address specified. You may also change the port number in the
1082 resulting configuration files. However, you need to take care that the
1083 numbers correspond correctly in each of the three daemon configuration
1084 files. The default base port is 9101, which assigns ports 9101 through 9103.
1085 These ports (9101, 9102, and 9103) have been officially assigned to Bacula by
1086 IANA. This option is only used to modify the daemon configuration files. You
1087 may also accomplish the same thing by directly editing them later.
1089 \item [ {-}{\-}with-dump-email=\lt{}email-address\gt{}]
1090 \index[general]{{-}{\-}with-dump-email}
1091 This option specifies the email address where any core dumps should be set.
1092 This option is normally only used by developers.
1094 \item [ {-}{\-}with-pid-dir=\lt{}PATH\gt{} ]
1095 \index[general]{{-}{\-}with-pid-dir}
1096 This specifies where Bacula should place the process id file during
1097 execution. The default is: {\bf /var/run}. This directory is not created by
1098 the install process, so you must ensure that it exists before using Bacula
1101 \item [ {-}{\-}with-subsys-dir=\lt{}PATH\gt{}]
1102 \index[general]{{-}{\-}with-subsys-dir}
1103 This specifies where Bacula should place the subsystem lock file during
1104 execution. The default is {\bf /var/run/subsys}. Please make sure that you do
1105 not specify the same directory for this directory and for the {\bf sbindir}
1106 directory. This directory is used only within the autostart scripts. The
1107 subsys directory is not created by the Bacula install, so you must be sure to
1108 create it before using Bacula.
1110 \item [ {-}{\-}with-dir-password=\lt{}Password\gt{}]
1111 \index[general]{{-}{\-}with-dir-password}
1112 This option allows you to specify the password used to access the Director
1113 (normally from the Console program). If it is not specified, configure will
1114 automatically create a random password.
1116 \item [ {-}{\-}with-fd-password=\lt{}Password\gt{} ]
1117 \index[general]{{-}{\-}with-fd-password}
1118 This option allows you to specify the password used to access the File daemon
1119 (normally called from the Director). If it is not specified, configure will
1120 automatically create a random password.
1122 \item [ {-}{\-}with-sd-password=\lt{}Password\gt{} ]
1123 \index[general]{{-}{\-}with-sd-password}
1124 This option allows you to specify the password used to access the Storage daemon
1125 (normally called from the Director). If it is not specified, configure will
1126 automatically create a random password.
1128 \item [ {-}{\-}with-dir-user=\lt{}User\gt{} ]
1129 \index[general]{{-}{\-}with-dir-user}
1130 This option allows you to specify the Userid used to run the Director. The
1131 Director must be started as root, but doesn't need to run as root, and
1132 after doing preliminary initializations, it can "drop" to the UserId
1133 specified on this option.
1134 If you specify this option, you must
1135 create the User prior to running {\bf make install}, because the
1136 working directory owner will be set to {\bf User}.
1138 \item [ {-}{\-}with-dir-group=\lt{}Group\gt{} ]
1139 \index[general]{{-}{\-}with-dir-group}
1140 This option allows you to specify the GroupId used to run the Director. The
1141 Director must be started as root, but doesn't need to run as root, and after
1142 doing preliminary initializations, it can "drop" to the GroupId specified
1144 If you specify this option, you must
1145 create the Group prior to running {\bf make install}, because the
1146 working directory group will be set to {\bf Group}.
1148 \item [ {-}{\-}with-sd-user=\lt{}User\gt{} ]
1149 \index[general]{{-}{\-}with-sd-user}
1150 This option allows you to specify the Userid used to run the Storage daemon.
1151 The Storage daemon must be started as root, but doesn't need to run as root,
1152 and after doing preliminary initializations, it can "drop" to the UserId
1153 specified on this option. If you use this option, you will need to take care
1154 that the Storage daemon has access to all the devices (tape drives, ...) that
1157 \item [ {-}{\-}with-sd-group=\lt{}Group\gt{} ]
1158 \index[general]{{-}{\-}with-sd-group}
1159 This option allows you to specify the GroupId used to run the Storage daemon.
1160 The Storage daemon must be started as root, but doesn't need to run as root,
1161 and after doing preliminary initializations, it can "drop" to the GroupId
1162 specified on this option.
1164 \item [ {-}{\-}with-fd-user=\lt{}User\gt{} ]
1165 \index[general]{{-}{\-}with-fd-user}
1166 This option allows you to specify the Userid used to run the File daemon. The
1167 File daemon must be started as root, and in most cases, it needs to run as
1168 root, so this option is used only in very special cases, after doing
1169 preliminary initializations, it can "drop" to the UserId specified on this
1172 \item [ {-}{\-}with-fd-group=\lt{}Group\gt{} ]
1173 \index[general]{{-}{\-}with-fd-group}
1174 This option allows you to specify the GroupId used to run the File daemon.
1175 The File daemon must be started as root, and in most cases, it must be run as
1176 root, however, after doing preliminary initializations, it can "drop" to
1177 the GroupId specified on this option.
1179 \item [ {-}{\-}with-mon-dir-password=\lt{}Password\gt{}]
1180 \index[general]{{-}{\-}with-mon-dir-password}
1181 This option allows you to specify the password used to access the Directory
1182 from the monitor. If it is not specified, configure will
1183 automatically create a random password.
1185 \item [ {-}{\-}with-mon-fd-password=\lt{}Password\gt{} ]
1186 \index[general]{{-}{\-}with-mon-fd-password}
1187 This option allows you to specify the password used to access the File daemon
1188 from the Monitor. If it is not specified, configure will
1189 automatically create a random password.
1191 \item [ {-}{\-}with-mon-sd-password=\lt{}Password\gt{} ]
1192 \index[general]{{-}{\-}with-mon-sd-password}
1193 This option allows you to specify the password used to access the
1194 Storage daemon from the Monitor. If it is not specified, configure will
1195 automatically create a random password.
1197 \item [ {-}{\-}with-db-name=\lt{}database-name\gt{} ]
1198 \index[general]{{-}{\-}with-db-name}
1199 This option allows you to specify the database name to be used in
1200 the conf files. The default is bacula.
1202 \item [ {-}{\-}with-db-user=\lt{}database-user\gt{} ]
1203 \index[general]{{-}{\-}with-db-user}
1204 This option allows you to specify the database user name to be used in
1205 the conf files. The default is bacula.
1209 Note, many other options are presented when you do a {\bf ./configure
1210 \verb:--:help}, but they are not implemented.
1212 \section{Recommended Options for Most Systems}
1213 \index[general]{Systems!Recommended Options for Most}
1214 \index[general]{Recommended Options for Most Systems}
1216 For most systems, we recommend starting with the following options:
1221 --enable-smartalloc \
1222 --sbindir=$HOME/bacula/bin \
1223 --sysconfdir=$HOME/bacula/bin \
1224 --with-pid-dir=$HOME/bacula/bin/working \
1225 --with-subsys-dir=$HOME/bacula/bin/working \
1226 --with-mysql=$HOME/mysql \
1227 --with-working-dir=$HOME/bacula/working
1231 If you want to install Bacula in an installation directory rather than run it
1232 out of the build directory (as developers will do most of the time), you
1233 should also include the \verb:--:sbindir and \verb:--:sysconfdir options with appropriate
1234 paths. Neither are necessary if you do not use "make install" as is the case
1235 for most development work. The install process will create the sbindir and
1236 sysconfdir if they do not exist, but it will not automatically create the
1237 pid-dir, subsys-dir, or working-dir, so you must ensure that they exist before
1238 running Bacula for the first time.
1241 \index[general]{Red Hat}
1248 CFLAGS="-g -Wall" ./configure \
1249 --sbindir=$HOME/bacula/bin \
1250 --sysconfdir=$HOME/bacula/bin \
1251 --enable-smartalloc \
1252 --with-sqlite=$HOME/bacula/depkgs/sqlite \
1253 --with-working-dir=$HOME/bacula/working \
1254 --with-pid-dir=$HOME/bacula/bin/working \
1255 --with-subsys-dir=$HOME/bacula/bin/working \
1266 CFLAGS="-g -Wall" ./configure \
1267 --sbindir=$HOME/bacula/bin \
1268 --sysconfdir=$HOME/bacula/bin \
1269 --enable-smartalloc \
1270 --with-mysql=$HOME/mysql \
1271 --with-working-dir=$HOME/bacula/working
1272 --with-pid-dir=$HOME/bacula/bin/working \
1273 --with-subsys-dir=$HOME/bacula/bin/working
1278 or finally, a completely traditional Red Hat Linux install:
1282 CFLAGS="-g -Wall" ./configure \
1283 --sbindir=/usr/sbin \
1284 --sysconfdir=/etc/bacula \
1285 --with-scriptdir=/etc/bacula \
1286 --enable-smartalloc \
1289 --with-working-dir=/var/bacula \
1290 --with-pid-dir=/var/run \
1295 Note, Bacula assumes that /var/bacula, /var/run, and /var/lock/subsys exist so
1296 it will not automatically create them during the install process.
1299 \index[general]{Solaris}
1301 To build Bacula from source, you will need the following installed on your
1302 system (they are not by default): libiconv, gcc 3.3.2, stdc++, libgcc (for
1303 stdc++ and gcc\_s libraries), make 3.8 or later.
1305 You will probably also need to: Add /usr/local/bin to PATH and Add
1306 /usr/ccs/bin to PATH for ar.
1308 It is possible to build Bacula on Solaris with the Solaris compiler, but
1309 we recommend using GNU C++ if possible.
1311 A typical configuration command might look like:
1316 CFLAGS="-g" ./configure \
1317 --sbindir=$HOME/bacula/bin \
1318 --sysconfdir=$HOME/bacula/bin \
1319 --with-mysql=$HOME/mysql \
1320 --enable-smartalloc \
1321 --with-pid-dir=$HOME/bacula/bin/working \
1322 --with-subsys-dir=$HOME/bacula/bin/working \
1323 --with-working-dir=$HOME/bacula/working
1327 As mentioned above, the install process will create the sbindir and sysconfdir
1328 if they do not exist, but it will not automatically create the pid-dir,
1329 subsys-dir, or working-dir, so you must ensure that they exist before running
1330 Bacula for the first time.
1332 Note, you may need to install the following packages to build Bacula
1352 PATH=/usr/bin::/usr/ccs/bin:/etc:/usr/openwin/bin:/usr/local/bin:/usr/sfw/bin:/opt/sfw/bin:/usr/ucb:/usr/sbin
1356 If you have installed special software not normally in the Solaris
1357 libraries, such as OpenSSL, or the packages shown above, then you may need
1358 to add {\bf /usr/sfw/lib} to the library search path. Probably the
1359 simplest way to do so is to run:
1363 setenv LDFLAGS "-L/usr/sfw/lib -R/usr/sfw/lib"
1367 Prior to running the ./configure command.
1369 Alternatively, you can set the LD\_LIBARY\_PATH and/or the LD\_RUN\_PATH
1370 environment variables appropriately.
1372 It is also possible to use the {\bf crle} program to set the library
1373 search path. However, this should be used with caution.
1376 \index[general]{FreeBSD}
1379 \elink{The FreeBSD Diary}{http://www.freebsddiary.org/bacula.php} for a
1380 detailed description on how to make Bacula work on your system. In addition,
1381 users of FreeBSD prior to 4.9-STABLE dated Mon Dec 29 15:18:01 2003 UTC who
1382 plan to use tape devices, please see the
1383 \ilink{Tape Testing Chapter}{FreeBSDTapes} of this manual for
1384 {\bf important} information on how to configure your tape drive for
1385 compatibility with Bacula.
1387 If you are using Bacula with MySQL, you should take care to compile MySQL with
1388 FreeBSD native threads rather than LinuxThreads, since Bacula is normally built
1389 with FreeBSD native threads rather than LinuxTreads. Mixing the two will
1393 \index[general]{Win32}
1395 To install the binary Win32 version of the File daemon please see the
1396 \ilink{Win32 Installation Chapter}{Win32Chapter} in this document.
1398 \section{One File Configure Script}
1399 \index[general]{Script!One File Configure}
1400 \index[general]{One Files Configure Script}
1402 The following script could be used if you want to put everything
1410 --sbindir=$HOME/bacula/bin \
1411 --sysconfdir=$HOME/bacula/bin \
1412 --mandir=$HOME/bacula/bin \
1413 --enable-smartalloc \
1415 --enable-bwx-console \
1416 --enable-tray-monitor \
1417 --with-pid-dir=$HOME/bacula/bin/working \
1418 --with-subsys-dir=$HOME/bacula/bin/working \
1420 --with-working-dir=$HOME/bacula/bin/working \
1421 --with-dump-email=$USER@your-site.com \
1422 --with-job-email=$USER@your-site.com \
1423 --with-smtp-host=mail.your-site.com
1428 You may also want to put the following entries in your {\bf /etc/services}
1429 file as it will make viewing the connections made by Bacula easier to
1430 recognize (i.e. netstat -a):
1440 \section{Installing Bacula}
1441 \index[general]{Bacula!Installing}
1442 \index[general]{Installing Bacula}
1444 Before setting up your configuration files, you will want to install Bacula in
1445 its final location. Simply enter:
1453 If you have previously installed Bacula, the old binaries will be overwritten,
1454 but the old configuration files will remain unchanged, and the "new"
1455 configuration files will be appended with a {\bf .new}. Generally if you have
1456 previously installed and run Bacula you will want to discard or ignore the
1457 configuration files with the appended {\bf .new}.
1459 \section{Building a File Daemon or Client}
1460 \index[general]{Client!Building a File Daemon or}
1461 \index[general]{Building a File Daemon or Client}
1463 If you run the Director and the Storage daemon on one machine and you wish to
1464 back up another machine, you must have a copy of the File daemon for that
1465 machine. If the machine and the Operating System are identical, you can simply
1466 copy the Bacula File daemon binary file {\bf bacula-fd} as well as its
1467 configuration file {\bf bacula-fd.conf} then modify the name and password in
1468 the conf file to be unique. Be sure to make corresponding additions to the
1469 Director's configuration file ({\bf bacula-dir.conf}).
1471 If the architecture or the OS level are different, you will need to build a
1472 File daemon on the Client machine. To do so, you can use the same {\bf
1473 ./configure} command as you did for your main program, starting either from a
1474 fresh copy of the source tree, or using {\bf make\ distclean} before the {\bf
1477 Since the File daemon does not access the Catalog database, you can remove
1478 the {\bf \verb:--:with-mysql} or {\bf \verb:--:with-sqlite} options, then
1479 add {\bf \verb:--:enable-client-only}. This will compile only the
1480 necessary libraries and the client programs and thus avoids the necessity
1481 of installing one or another of those database programs to build the File
1482 daemon. With the above option, you simply enter {\bf make} and just the
1483 client will be built.
1486 \section{Auto Starting the Daemons}
1487 \index[general]{Daemons!Auto Starting the}
1488 \index[general]{Auto Starting the Daemons}
1490 If you wish the daemons to be automatically started and stopped when your
1491 system is booted (a good idea), one more step is necessary. First, the
1492 ./configure process must recognize your system -- that is it must be a
1493 supported platform and not {\bf unknown}, then you must install the platform
1494 dependent files by doing:
1499 make install-autostart
1503 Please note, that the auto-start feature is implemented only on systems
1504 that we officially support (currently, FreeBSD, Red Hat/Fedora Linux, and
1505 Solaris), and has only been fully tested on Fedora Linux.
1507 The {\bf make install-autostart} will cause the appropriate startup scripts
1508 to be installed with the necessary symbolic links. On Red Hat/Fedora Linux
1509 systems, these scripts reside in {\bf /etc/rc.d/init.d/bacula-dir} {\bf
1510 /etc/rc.d/init.d/bacula-fd}, and {\bf /etc/rc.d/init.d/bacula-sd}. However
1511 the exact location depends on what operating system you are using.
1513 If you only wish to install the File daemon, you may do so with:
1517 make install-autostart-fd
1521 \section{Other Make Notes}
1522 \index[general]{Notes!Other Make}
1523 \index[general]{Other Make Notes}
1525 To simply build a new executable in any directory, enter:
1533 To clean out all the objects and binaries (including the files named 1, 2, or
1534 3, which are development temporary files), enter:
1542 To really clean out everything for distribution, enter:
1550 note, this cleans out the Makefiles and is normally done from the top level
1551 directory to prepare for distribution of the source. To recover from this
1552 state, you must redo the {\bf ./configure} in the top level directory, since
1553 all the Makefiles will be deleted.
1555 To add a new file in a subdirectory, edit the Makefile.in in that directory,
1556 then simply do a {\bf make}. In most cases, the make will rebuild the Makefile
1557 from the new Makefile.in. In some case, you may need to issue the {\bf make} a
1558 second time. In extreme cases, cd to the top level directory and enter: {\bf
1561 To add dependencies:
1569 The {\bf make depend} appends the header file dependencies for each of the
1570 object files to Makefile and Makefile.in. This command should be done in each
1571 directory where you change the dependencies. Normally, it only needs to be run
1572 when you add or delete source or header files. {\bf make depend} is normally
1573 automatically invoked during the configuration process.
1583 This not normally done if you are developing Bacula, but is used if you are
1584 going to run it to backup your system.
1586 After doing a {\bf make install} the following files will be installed on your
1587 system (more or less). The exact files and location (directory) for each file
1588 depends on your {\bf ./configure} command (e.g. if you are using SQLite instead
1589 of MySQL, some of the files will be different).
1591 NOTE: it is quite probable that this list is out of date. But it is a
1613 create_mysql_database
1615 delete_catalog_backup
1634 \section{Installing Tray Monitor}
1635 \index[general]{Monitor!Installing Tray}
1636 \index[general]{Installing Tray Monitor}
1638 The Tray Monitor is already installed if you used the {\bf
1639 \verb:--:enable-tray-monitor} configure option and ran {\bf make install}.
1641 As you don't run your graphical environment as root (if you do, you should
1642 change that bad habit), don't forget to allow your user to read {\bf
1643 tray-monitor.conf}, and to execute {\bf bacula-tray-monitor} (this is not a
1646 Then log into your graphical environment (KDE, GNOME or something else), run
1647 {\bf bacula-tray-monitor} as your user, and see if a cassette icon appears
1648 somewhere on the screen, usually on the task bar.
1649 If it doesn't, follow the instructions below related to your environment or
1653 \index[general]{GNOME}
1655 System tray, or notification area if you use the GNOME terminology, has been
1656 supported in GNOME since version 2.2. To activate it, right-click on one of
1657 your panels, open the menu {\bf Add to this Panel}, then {\bf Utility} and
1658 finally click on {\bf Notification Area}.
1661 \index[general]{KDE}
1663 System tray has been supported in KDE since version 3.1. To activate it,
1664 right-click on one of your panels, open the menu {\bf Add}, then {\bf Applet}
1665 and finally click on {\bf System Tray}.
1667 \subsection{Other window managers}
1668 \index[general]{Managers!Other window}
1669 \index[general]{Other window managers}
1671 Read the documentation to know if the Freedesktop system tray standard is
1672 supported by your window manager, and if applicable, how to activate it.
1674 \section{Modifying the Bacula Configuration Files}
1675 \index[general]{Modifying the Bacula Configuration Files}
1676 \index[general]{Files!Modifying the Bacula Configuration}
1679 \ilink{Configuring Bacula}{ConfigureChapter} in this manual for
1680 instructions on how to set Bacula configuration files.