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.0.3.tar.gz]
31 This is the primary source code release for Bacula. On each
32 release the version number (2.0.3) will be updated.
34 \item [bacula-docs-2.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-2.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-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.
55 Note, this package evolves slower than the Bacula source code,
56 so there may not always be a new release of the rescue package when
57 making minor updates to the Bacula code. For example, when releasing
58 Bacula version 2.0.3, the rescue package may still be at version
59 2.0.0 if there were no updates.
61 \item [winbacula-2.0.3.exe]
62 This file is the 32 bit Windows installer for installing
63 the Windows client (File daemon) on a Windows machine.
64 This client will also run on 64 bit Windows machines.
65 Beginning with Bacula version 1.39.20, this executable will
66 also optionally load the Win32 Director and the Win32
72 \section{Upgrading Bacula}
73 \index[general]{Bacula!Upgrading}
74 \index[general]{Upgrading Bacula}
75 \index[general]{Upgrading}
77 If you are upgrading from one Bacula version to another, you should first
78 carefully read the ReleaseNotes of all major versions between your current
79 version and the version to which you are upgrading. If the Bacula catalog
80 database has been upgraded (as it is almost every major release), you will
81 either need to reinitialize your database starting from scratch (not
82 normally a good idea), or save an ASCII copy of your database, then proceed
83 to upgrade it. If you are upgrading two major versions (e.g. 1.36 to 2.0)
84 then life will be more complicated because you must do two database
85 upgrades. See below for more on this.
87 Upgrading the catalog is normally done after Bacula is build and installed
91 cd <installed-scripts-dir> (default /etc/bacula)
92 ./update_bacula_tables
95 This update script can also be find in the Bacula source src/cats
98 If there are several database upgrades between your version and the
99 version to which you are upgrading, you will need to apply each database
100 upgrade script. For your convenience, you can find all the old upgrade scripts
101 in the {\bf upgradedb} directory of the source code. You will need to edit the
102 scripts to correspond to your system configuration. The final upgrade script,
103 if any, can be applied as noted above.
105 If you are upgrading from one major version to another, you will need to
106 replace all your components at the same time as generally the inter-daemon
107 protocol will change. However, within any particular release (e.g. version
108 1.32.x) unless there is an oversight or bug, the daemon protocol will not
109 change. If this is confusing, simply read the ReleaseNotes very carefully as
110 they will note if all daemons must be upgraded at the same time.
112 Finally, please note that in general it is not necessary to do a
113 {\bf make uninstall} before doing an upgrade providing you are careful
114 not to change the installation directories. In fact, if you do so, you will
115 most likely delete all your conf files, which could be disastrous.
116 The normal procedure during an upgrade is simply:
119 ./configure (your options)
124 In general none of your existing .conf or .sql files will be overwritten,
125 and you must do both the {\bf make} and {\bf make install} commands, a
126 {\bf make install} without the preceding {\bf make} will not work.
128 For additional information on upgrading, please see the \ilink{Upgrading Bacula
129 Versions}{upgrading} in the Tips chapter of this manual.
131 \section{Releases Numbering}
132 \index[general]{Release Numbering}
133 \index[general]{Version Numbering}
134 Every Bacula release whether beta or production has a different number
135 as well as the date of the release build. The numbering system follows
136 traditional Open Source conventions in that it is of the form.
147 where each component (major, minor, patch) is a number.
148 The major number is currently 1 and normally does not change
149 very frequently. The minor number starts at 0 and increases
150 each for each production release by 2 (i.e. it is always an
151 even number for a production release), and the patch number is
152 starts at zero each time the minor number changes. The patch
153 number is increased each time a bug fix (or fixes) is released
156 So, as of this date (10 September 2006), the current production Bacula
157 release is version 1.38.11. If there are bug fixes, the next release
158 will be 1.38.12 (i.e. the patch number has increased by one).
160 For all patch releases where the minor version number does not change,
161 the database and all the daemons will be compatible. That means that
162 you can safely run a 1.38.0 Director with a 1.38.11 Client. Of course,
163 in this case, the Director may have bugs that are not fixed. Generally,
164 within a minor release (some minor releases are not so minor), all
165 patch numbers are officially released to production. This means that while
166 the current Bacula version is 1.38.11, versions 1.38.0, 1.38.1, ... 1.38.10
167 have all been previously released.
169 When the minor number is odd, it indicates that the package is under
170 development and thus may not be stable. For example, while the current
171 production release of Bacula is currently 1.38.11, the current development
172 version is 1.39.22. All patch versions of the development code are
173 available in the SVN (source repository). However, not all patch versions
174 of the development code (odd minor version) are officially released. When
175 they are released, they are released as beta versions (see below for a
176 definition of what beta means for Bacula releases).
178 In general when the minor number increases from one production release
179 to the next (i.e. 1.38.x to 1.40.0), the catalog database must be upgraded,
180 the Director and Storage daemon must always be on the same minor release
181 number, and often (not always), the Clients must also be on the same minor
182 release. As often as possible, we attempt to make new releases that are
183 downwards compatible with prior clients, but this is not always possible.
184 You must check the release notes. In general, you will have fewer problems
185 if you always run all the components on the same minor version number (i.e.
186 all either 1.38.x or 1.40.x but not mixed).
190 \section*{Beta Releases}
191 \index[general]{Beta Releases}
192 Towards the end of the development cycle, which typically runs
193 one year from a major release to another, there will be several beta
194 releases of the development code prior to a production release.
195 As noted above, beta versions always have odd minor version numbers
196 (e.g 1.37.x or 1.39.x).
197 The purpose of the beta releases is to allow early adopter users to test
198 the new code. Beta releases are made with the following considerations:
201 \item The code passes the regression testing on FreeBSD, Linux, and Solaris
204 \item There are no known major bugs, or on the rare occasion that
205 there are, they will be documented or already in the bugs database.
207 \item Some of the new code/features may not yet be tested.
209 \item Bugs are expected to be found, especially in the new
210 code before the final production release.
212 \item The code will have been run in production in at least one small
215 \item The Win32 client will have been run in production at least
216 one night at that small site.
218 \item The documentation in the manual is unlikely to be complete especially
219 for the new features, and the Release Notes may not be fully
222 \item Beta code is not generally recommended for everyone, but
223 rather for early adopters.
228 \section{Dependency Packages}
229 \index[general]{Dependency Packages}
230 \index[general]{Packages!Dependency}
232 As discussed above, we have combined a number of third party packages that
233 Bacula might need into the {\bf depkgs} release. You can,
234 of course, get the latest packages from the original authors or
235 from your operating system supplier. The locations of
236 where we obtained the packages are in the README file in each package.
237 However, be aware that the packages in the depkgs files have been tested by us
238 for compatibility with Bacula.
240 Typically, a dependency package will be named {\bf depkgs-ddMMMyy.tar.gz}
241 where {\bf dd} is the day we release it, {\bf MMM}
242 is the abbreviated month (e.g. Jan), and {\bf yy} is the year. An actual
243 example is: {\bf depkgs-07Apr02.tar.gz}. To install and build this package (if
244 needed), you do the following:
247 \item Create a {\bf bacula} directory, into which you will place both the
248 Bacula source as well as the dependency package.
249 \item Detar the {\bf depkgs} into the {\bf bacula} directory.
250 \item cd bacula/depkgs
254 Although the exact composition of the dependency packages may change from time
255 to time, the current makeup is the following:
257 \addcontentsline{lot}{table}{Dependency Packages}
258 \begin{longtable}{|l|l|l|}
260 \multicolumn{1}{|c| }{\bf 3rd Party Package} & \multicolumn{1}{c| }{\bf depkgs}
261 & \multicolumn{1}{c| }{\bf depkgs-qt} \\
262 \hline {SQLite } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ }\\
263 \hline {SQLite3 } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ }\\
264 \hline {mtx } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ } \\
265 \hline {qt4 } & \multicolumn{1}{c| }{ } & \multicolumn{1}{c| }{X } \\
266 \hline {qwt } & \multicolumn{1}{c| }{ } & \multicolumn{1}{c| }{X } \\
270 Note, some of these packages are quite large, so that building them can be a
271 bit time consuming. The above instructions will build all the packages
272 contained in the directory. However, when building Bacula, it will take only
273 those pieces that it actually needs.
275 Alternatively, you can make just the packages that are needed. For example,
284 will configure and build only the SQLite package.
286 You should build the packages that you will require in {\bf depkgs} a
287 prior to configuring and building Bacula, since Bacula will need
288 them during the build process.
290 For more information on the {\bf depkgs-qt} package, please read the
291 INSTALL file in the main directory of that package. If you are going to
292 build Qt4 using {\bf depkgs-qt}, you must source the {\bf qt4-paths} file
293 included in the package prior to building Bacula. Please read the INSTALL
294 file for more details.
296 Even if you do not use SQLite, you might find it worthwhile to build {\bf mtx}
297 because the {\bf tapeinfo} program that comes with it can often provide you
298 with valuable information about your SCSI tape drive (e.g. compression,
299 min/max block sizes, ...). Note, most distros provide {\bf mtx} as part of
302 The {\bf depkgs1} package is depreciated and previously contained
303 readline, which should be available on all operating systems.
305 The {\bf depkgs-win32} package is deprecated and no longer used in
306 Bacula version 1.39.x and later. It was previously used to build
307 the native Win32 client program, but this program is now built on Linux
308 systems using cross-compiling. All the tools and third party libraries
309 are automatically downloaded by executing the appropriate scripts. See
310 src/win32/README.mingw32 for more details.
312 \section{Supported Operating Systems}
314 \index[general]{Systems!Supported Operating}
315 \index[general]{Supported Operating Systems}
318 \ilink{ Supported Operating Systems}{SupportedOSes} section
319 of the QuickStart chapter of this manual.
321 \section{Building Bacula from Source}
323 \index[general]{Source!Building Bacula from}
324 \index[general]{Building Bacula from Source}
326 The basic installation is rather simple.
329 \item Install and build any {\bf depkgs} as noted above. This
330 should be unnecessary on most modern Operating Systems.
332 \item Configure and install MySQL or PostgreSQL (if desired).
333 \ilink{Installing and Configuring MySQL Phase I}{MySqlChapter} or
334 \ilink{Installing and Configuring PostgreSQL Phase
335 I}{PostgreSqlChapter}. If you are installing from rpms, and are
336 using MySQL, please be sure to install {\bf mysql-devel}, so that the MySQL
337 header files are available while compiling Bacula. In addition, the MySQL
338 client library {\bf mysqlclient} requires the gzip compression library {\bf
339 libz.a} or {\bf libz.so}. If you are using rpm packages, these libraries are
340 in the {\bf libz-devel} package. On Debian systems, you will need to load the
341 {\bf zlib1g-dev} package. If you are not using rpms or debs, you will need to
342 find the appropriate package for your system.
344 Note, if you already have a running MySQL or PostgreSQL on your system, you
345 can skip this phase provided that you have built the thread safe libraries.
346 And you have already installed the additional rpms noted above.
348 SQLite is not supported on Solaris. This is because it
349 frequently fails with bus errors. However SQLite3 may work.
351 \item Detar the Bacula source code preferably into the {\bf bacula} directory
354 \item {\bf cd} to the directory containing the source code.
356 \item ./configure (with appropriate options as described below). Any
357 path names you specify as options on the ./configure command line
358 must be absolute paths and not relative.
360 \item Check the output of ./configure very carefully, especially the Install
361 binaries and Install config directories. If they are not correct,
362 please rerun ./configure until they are. The output from ./configure is
363 stored in {\bf config.out} and can be re-displayed at any time without
364 rerunning the ./configure by doing {\bf cat config.out}.
366 \item If after running ./configure once, you decide to change options and
367 re-run it, that is perfectly fine, but before re-running it, you should run:
375 so that you are sure to start from scratch and not have a mixture of the two
376 options. This is because ./configure caches much of the information. The {\bf
377 make distclean} is also critical if you move the source directory from one
378 machine to another. If the {\bf make distclean} fails, just ignore it and
382 If you get errors while linking in the Storage daemon directory
383 (src/stored), it is probably because you have not loaded the static
384 libraries on your system. I noticed this problem on a Solaris system.
385 To correct it, make sure that you have not added {\bf
386 {-}{-}enable-static-tools} to the {\bf ./configure} command.
388 If you skip this step ({\bf make}) and proceed immediately to the {\bf
389 make install} you are making two serious errors: 1. your install will
390 fail because Bacula requires a {\bf make} before a {\bf make install}.
391 2. you are depriving yourself of the chance to make sure there are no
392 errors before beginning to write files to your system directories.
396 Please be sure you have done a {\bf make} before entering this command,
397 and that everything has properly compiled and linked without errors.
400 \item If you are new to Bacula, we {\bf strongly} recommend that you skip
401 the next step and use the default configuration files, then run the
402 example program in the next chapter, then come back and modify your
403 configuration files to suit your particular needs.
405 \item Customize the configuration files for each of the three daemons
406 (Directory, File, Storage) and for the Console program. For the details
407 of how to do this, please see \ilink{Setting Up Bacula Configuration
408 Files}{ConfigureChapter} in the Configuration chapter of this manual. We
409 recommend that you start by modifying the default configuration files
410 supplied, making the minimum changes necessary. Complete customization
411 can be done after you have Bacula up and running. Please take care when
412 modifying passwords, which were randomly generated, and the {\bf Name}s
413 as the passwords and names must agree between the configuration files
414 for security reasons.
416 \label{CreateDatabase}
417 \item Create the Bacula MySQL database and tables
419 \ilink{Installing and Configuring MySQL Phase II}{mysql_phase2} or
420 create the Bacula PostgreSQL database and tables
421 \ilink{Configuring PostgreSQL
422 II}{PostgreSQL_configure} or alternatively if you are using
423 SQLite \ilink{Installing and Configuring SQLite Phase II}{phase2}.
425 \item Start Bacula ({\bf ./bacula start}) Note. the next chapter shows you
426 how to do this in detail.
428 \item Interface with Bacula using the Console program
430 \item For the previous two items, please follow the instructions in the
431 \ilink{Running Bacula}{TutorialChapter} chapter of this manual,
432 where you will run a simple backup and do a restore. Do this before you make
433 heavy modifications to the configuration files so that you are sure that
434 Bacula works and are familiar with it. After that changing the conf files
437 \item If after installing Bacula, you decide to "move it", that is to
438 install it in a different set of directories, proceed as follows:
444 ./configure (your-new-options)
453 If all goes well, the {\bf ./configure} will correctly determine which
454 operating system you are running and configure the source code appropriately.
455 Currently, FreeBSD, Linux (Red Hat), and Solaris are supported. The Bacula
456 client (File daemon) is reported to work with MacOS X 10.3 is if
457 readline support is not enabled (default) when building the client.
459 If you install Bacula on more than one system, and they are identical, you can
460 simply transfer the source tree to that other system and do a "make
461 install". However, if there are differences in the libraries or OS versions,
462 or you wish to install on a different OS, you should start from the original
463 compress tar file. If you do transfer the source tree, and you have previously
464 done a ./configure command, you MUST do:
472 prior to doing your new ./configure. This is because the GNU autoconf tools
473 cache the configuration, and if you re-use a configuration for a Linux machine
474 on a Solaris, you can be sure your build will fail. To avoid this, as
475 mentioned above, either start from the tar file, or do a "make distclean".
477 In general, you will probably want to supply a more complicated {\bf
478 configure} statement to ensure that the modules you want are built and that
479 everything is placed into the correct directories.
481 For example, on Fedora, Red Hat, or SuSE one could use the following:
487 --sbindir=$HOME/bacula/bin \
488 --sysconfdir=$HOME/bacula/bin \
489 --with-pid-dir=$HOME/bacula/bin/working \
490 --with-subsys-dir=$HOME/bacula/bin/working \
492 --with-working-dir=$HOME/bacula/bin/working \
493 --with-dump-email=$USER
497 Note, the advantage of using the above configuration to start is that
498 everything will be put into a single directory, which you can later delete
499 once you have run the examples in the next chapter and learned how Bacula
500 works. In addition, the above can be installed and run as non-root.
502 For the developer's convenience, I have added a {\bf defaultconfig} script to
503 the {\bf examples} directory. This script contains the statements that you
504 would normally use, and each developer/user may modify them to suit his needs.
505 You should find additional useful examples in this directory as well.
507 The {\bf \verb:--:enable-conio} or {\bf \verb:--:enable-readline} options are useful because
508 they provide a command line history and editing capability for the Console
509 program. If you have included either option in the build, either the {\bf
510 termcap} or the {\bf ncurses} package will be needed to link. On most
511 systems, including Red Hat and SuSE, you should include the ncurses package.
512 If Bacula's configure process finds the ncurses libraries, it will use
513 those rather than the termcap library.
514 On some systems, such as SuSE, the termcap library is not in the standard
515 library directory. As a consequence, the option may be disabled or you may
516 get an error message such as:
520 /usr/lib/gcc-lib/i586-suse-linux/3.3.1/.../ld:
521 cannot find -ltermcap
522 collect2: ld returned 1 exit status
526 while building the Bacula Console. In that case, you will need to set the {\bf
527 LDFLAGS} environment variable prior to building.
531 export LDFLAGS="-L/usr/lib/termcap"
535 The same library requirements apply if you wish to use the readline
536 subroutines for command line editing and history or
537 if you are using a MySQL library that requires encryption. If you need encryption,
538 you can either export the appropriate additional library options as shown
539 above or, alternatively, you can include them directly on the ./configure line
544 LDFLAGS="-lssl -lcyrpto" \
545 ./configure <your-options>
549 On some systems such as Mandriva, readline tends to
550 gobble up prompts, which makes it totally useless. If this happens to you, use
551 the disable option, or if you are using version 1.33 and above try using {\bf
552 \verb:--:enable-conio} to use a built-in readline replacement. You will still need
553 either the termcap or the ncurses library, but it is unlikely that the {\bf conio}
554 package will gobble up prompts.
556 readline is no longer supported after version 1.34. The code within Bacula
557 remains, so it should be usable, and if users submit patches for it, we will
558 be happy to apply them. However, due to the fact that each version of
559 readline seems to be incompatible with previous versions, and that there
560 are significant differences between systems, we can no longer afford to
563 \section{What Database to Use?}
565 \index[general]{What Database to Use?}
566 \index[general]{Use!What Database to}
568 Before building Bacula you need to decide if you want to use SQLite, MySQL, or
569 PostgreSQL. If you are not already running MySQL or PostgreSQL, you might
570 want to start by testing with SQLite (not supported on Solaris).
571 This will greatly simplify the setup for you
572 because SQLite is compiled into Bacula an requires no administration. It
573 performs well and is suitable for small to medium sized installations (maximum
574 10-20 machines). However, we should note that a number of users have
575 had unexplained database corruption with SQLite. For that reason, we
576 recommend that you install either MySQL or PostgreSQL for production
579 If you wish to use MySQL as the Bacula catalog, please see the
580 \ilink{Installing and Configuring MySQL}{MySqlChapter} chapter of
581 this manual. You will need to install MySQL prior to continuing with the
582 configuration of Bacula. MySQL is a high quality database that is very
583 efficient and is suitable for any sized installation. It is slightly more
584 complicated than SQLite to setup and administer because it has a number of
585 sophisticated features such as userids and passwords. It runs as a separate
586 process, is truly professional and can manage a database of any size.
588 If you wish to use PostgreSQL as the Bacula catalog, please see the
589 \ilink{Installing and Configuring PostgreSQL}{PostgreSqlChapter}
590 chapter of this manual. You will need to install PostgreSQL prior to
591 continuing with the configuration of Bacula. PostgreSQL is very similar to
592 MySQL, though it tends to be slightly more SQL92 compliant and has many more
593 advanced features such as transactions, stored procedures, and the such. It
594 requires a certain knowledge to install and maintain.
596 If you wish to use SQLite as the Bacula catalog, please see
597 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
598 this manual. SQLite is not supported on Solaris.
600 \section{Quick Start}
601 \index[general]{Quick Start}
602 \index[general]{Start!Quick}
604 There are a number of options and important considerations given below
605 that you can skip for the moment if you have not had any problems building
606 Bacula with a simplified configuration as shown above.
608 If the ./configure process is unable to find specific libraries (e.g.
609 libintl, you should ensure that the appropriate package is installed on
610 your system. Alternatively, if the package is installed in a non-standard
611 location (as far as Bacula is concerned), then there is generally an
612 option listed below (or listed with "./configure {-}{-}help" that will
613 permit you to specify the directory that should be searched. In other
614 cases, there are options that will permit you to disable to feature
615 (e.g. {-}{-}disable-nls).
617 If you want to dive right into it, we recommend you skip to the next chapter,
618 and run the example program. It will teach you a lot about Bacula and as an
619 example can be installed into a single directory (for easy removal) and run as
620 non-root. If you have any problems or when you want to do a real installation,
621 come back to this chapter and read the details presented below.
623 \section{Configure Options}
625 \index[general]{Options!Configure}
626 \index[general]{Configure Options}
628 The following command line options are available for {\bf configure} to
629 customize your installation.
632 \item [ {-}{-}sbindir=\lt{}binary-path\gt{}]
633 \index[general]{{-}{-}sbindir}
634 Defines where the Bacula binary (executable) files will be placed during a
635 {\bf make install} command.
637 \item [ {-}{-}sysconfdir=\lt{}config-path\gt{}]
638 \index[general]{{-}{-}sysconfdir}
639 Defines where the Bacula configuration files should be placed during a
640 {\bf make install} command.
642 \item [ {-}{-}mandir=\lt{}path\gt{}]
643 \index[general]{{-}{-}mandir}
644 Note, as of Bacula version 1.39.14, the meaning of any path
645 specified on this option is change from prior versions. It
646 now specifies the top level man directory.
647 Previously the mandir specified the full path to where you
648 wanted the man files installed.
649 The man files will be installed in gzip'ed format under
650 mandir/man1 and mandir/man8 as appropriate.
651 For the install to succeed you must have {\bf gzip} installed
654 By default, Bacula will install the Unix man pages in
655 /usr/share/man/man1 and /usr/share/man/man8.
656 If you wish the man page to be installed in
657 a different location, use this option to specify the path.
658 Note, the main HTML and PDF Bacula documents are in a separate
659 tar file that is not part of the source distribution.
661 \item [ {-}{-}datadir=\lt{}path\gt{} ]
662 \index[general]{{-}{-}datadir}
663 If you translate Bacula or parts of Bacula into a different language
664 you may specify the location of the po files using the {\bf
665 {-}{-}datadir} option. You must manually install any po files as
666 Bacula does not (yet) automatically do so.
668 \item [ {-}{-}disable-ipv6 ]
669 \index[general]{{-}{-}disable-ipv6}
671 \item [ {-}{-}enable-smartalloc ]
672 \index[general]{{-}{-}enable-smartalloc}
673 This enables the inclusion of the Smartalloc orphaned buffer detection
674 code. This option is highly recommended. Because we never build
675 without this option, you may experience problems if it is not enabled.
676 In this case, simply re-enable the option. We strongly recommend
677 keeping this option enabled as it helps detect memory leaks. This
678 configuration parameter is used while building Bacula
680 \item [ {-}{-}enable-bat ]
682 \index[general]{{-}{-}enable-bat}
683 If you have Qt4 >= 4.2 installed on your computer including the
684 libqt4 and libqt4-devel (libqt4-dev on Debian) libraries, and you want
685 to use the Bacula Administration Tool (bat) GUI Console interface to
686 Bacula, you must specify this option. Doing so will build everything in
687 the {\bf src/qt-console} directory. The build with enable-bat will work
688 only with a full Bacula build (i.e. it will not work with a client-only
689 build). In addition to the Qt4 libraries, linking bat requires
690 the qwt package installed on your system. Please see the next
691 configure option (with-qwt) for how to build the qwt package.
693 Qt4 is available on OpenSUSE 10.2, CentOS 5, Fedora, and Debian. If it
694 is not available on your system, you can download the {\bf depkgs-qt}
695 package from the Bacula Source Forge download area and build it and
696 the qwt package, both of which are needed to build bat. See the
697 INSTALL file in that package for more details. In particular to use
698 the Qt4 built by {\bf depkgs-qt} you {bf must} source the file
701 \item [ {-}{-}with-qwt=\lt{}path\gt{} ]
702 \index[general]{{-}{-}with-qwt}
703 To build bat, you need the qwt graphics package installed on
704 your system. The path specified must be an absolute path and
707 The qwt package is available for download from
708 the qwt project on Source Forge. If you wish, you may build and
709 install it on your system (by default in /usr/lib).
710 If you have done so, you would specify:
713 --with-qwt=/usr/lib/qwt-5.0.2
716 Alternatively, you can download the Bacula depkgs package (currently
717 version 11Jul07) and build it, then assuming that you have put it
718 into a directory named bacula, you would specify:
721 --with-qwt=$HOME/bacula/depkgs/qwt
724 Some packages such as Debian do not adhere to the standard of
725 naming the library libqwt.a or libqwt.so, and you will either need
726 to manually add a soft link to the name they use or use the
727 depkgs version, which handles the naming correctly.
730 \item [ {-}{-}enable-batch-insert ]
731 \index[general]{{-}{-}enable-batch-insert}
732 This option enables batch inserts of the attribute records (default) in
733 the catalog database, which is much faster (10 times or more) than
734 without this option for large numbers of files. However, this option
735 will automatically be disabled if your SQL libraries are not
736 thread safe. If you find that batch mode is not enabled on your Bacula
737 installation, then your database most likely does not support threads.
739 SQLite2 is not thread safe. Batch insert cannot be enabled when using
742 On most systems, MySQL, PostgreSQL and SQLite3 are thread safe.
744 To verify that your PostgreSQL is thread safe, you can try this
745 (change the path to point to your particular installed libpq.a;
746 these commands were issued on FreeBSD 6.2):
749 $ nm /usr/local/lib/libpq.a | grep PQputCopyData
750 00001b08 T PQputCopyData
751 $ nm /usr/local/lib/libpq.a | grep mutex
753 U pthread_mutex_unlock
756 U pthread_mutex_unlock
759 The above example shows a libpq that contains the required function
760 PQputCopyData and is thread enabled (i.e. the pthread\_mutex* entries).
761 If you do not see PQputCopyData, your version of PostgreSQL is too old
762 to allow batch insert. If you do not see the mutex entries, then thread
763 support has not been enabled. Our tests indicate you usually need to
764 change the configuration options and recompile/reinstall the PostgreSQL
765 client software to get thread support.
767 Bacula always links to the thread safe MySQL libraries.
769 As a default, Bacula runs SQLite3 with {\bf PRAGMA synchronous=OFF}
770 because it improves performance by more than 30 times. However, it
771 increases the possibility of a corrupted database. If you want more
772 security, please modify src/version.h appropriately (it should be
773 obvious when you look at the file).
775 \item [ {-}{-}enable-gnome ]
776 \index[general]{{-}{-}enable-gnome}
777 If you have GNOME installed on your computer including the
778 GNOME development libraries, and you want to use the
779 GNOME GUI Console interface to Bacula, you must specify this option.
780 Doing so will build everything in the {\bf src/gnome2-console} directory.
782 \item [ {-}{-}enable-bwx-console ]
783 \index[general]{{-}{-}enable-bwx-console}
784 If you have wxWidgets installed on your computer and you want to use the
785 wxWidgets GUI Console interface to Bacula, you must specify this option.
786 Doing so will build everything in the {\bf src/wx-console} directory.
787 This could also be useful to users who want a GUI Console and don't want
788 to install GNOME, as wxWidgets can work with GTK+, Motif or even X11
791 \item [ {-}{-}enable-tray-monitor ]
792 \index[general]{{-}{-}enable-tray-monitor}
793 If you have GTK installed on your computer, you run a graphical
794 environment or a window manager compatible with the FreeDesktop system
795 tray standard (like KDE and GNOME) and you want to use a GUI to monitor
796 Bacula daemons, you must specify this option. Doing so will build
797 everything in the {\bf src/tray-monitor} directory. Note, due to
798 restrictions on what can be linked with GPLed code, we were forced to
799 remove the egg code that dealt with the tray icons and replace it by
800 calls to the GTK+ API, and unfortunately, the tray icon API necessary
801 was not implemented until GTK version 2.10 or later.
803 \item [ {-}{-}enable-static-tools]
804 \index[general]{{-}{-}enable-static-tools}
805 This option causes the linker to link the Storage daemon utility tools
806 ({\bf bls}, {\bf bextract}, and {\bf bscan}) statically. This permits
807 using them without having the shared libraries loaded. If you have
808 problems linking in the {\bf src/stored} directory, make sure you have
809 not enabled this option, or explicitly disable static linking by adding
810 {\bf \verb:--:disable-static-tools}.
812 \item [ {-}{-}enable-static-fd]
813 \index[general]{{-}{-}enable-static-fd}
814 This option causes the make process to build a {\bf static-bacula-fd} in
815 addition to the standard File daemon. This static version will include
816 statically linked libraries and is required for the Bare Metal recovery.
817 This option is largely superseded by using {\bf make static-bacula-fd}
818 from with in the {\bf src/filed} directory. Also, the {\bf
819 \verb:--:enable-client-only} option described below is useful for just
820 building a client so that all the other parts of the program are not
823 When linking a static binary, the linker needs the static versions
824 of all the libraries that are used, so frequently users will
825 experience linking errors when this option is used. The first
826 thing to do is to make sure you have the static glibc library
827 installed on your system. The second thing to do is the make sure
828 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
829 on your ./configure statement as these options require additional
830 libraries. You may be able to enable those options, but you will
831 need to load additional static libraries.
834 \item [ {-}{-}enable-static-sd]
835 \index[general]{{-}{-}enable-static-sd}
836 This option causes the make process to build a {\bf static-bacula-sd} in
837 addition to the standard Storage daemon. This static version will
838 include statically linked libraries and could be useful during a Bare
841 When linking a static binary, the linker needs the static versions
842 of all the libraries that are used, so frequently users will
843 experience linking errors when this option is used. The first
844 thing to do is to make sure you have the static glibc library
845 installed on your system. The second thing to do is the make sure
846 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
847 on your ./configure statement as these options require additional
848 libraries. You may be able to enable those options, but you will
849 need to load additional static libraries.
852 \item [ {-}{-}enable-static-dir]
853 \index[general]{{-}{-}enable-static-dir}
854 This option causes the make process to build a {\bf static-bacula-dir}
855 in addition to the standard Director. This static version will include
856 statically linked libraries and could be useful during a Bare Metal
859 When linking a static binary, the linker needs the static versions
860 of all the libraries that are used, so frequently users will
861 experience linking errors when this option is used. The first
862 thing to do is to make sure you have the static glibc library
863 installed on your system. The second thing to do is the make sure
864 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
865 on your ./configure statement as these options require additional
866 libraries. You may be able to enable those options, but you will
867 need to load additional static libraries.
870 \item [ {-}{-}enable-static-cons]
871 \index[general]{{-}{-}enable-static-cons}
872 This option causes the make process to build a {\bf static-console} and
873 a {\bf static-gnome-console} in addition to the standard console. This
874 static version will include statically linked libraries and could be
875 useful during a Bare Metal recovery.
877 When linking a static binary, the linker needs the static versions
878 of all the libraries that are used, so frequently users will
879 experience linking errors when this option is used. The first
880 thing to do is to make sure you have the static glibc library
881 installed on your system. The second thing to do is the make sure
882 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
883 on your ./configure statement as these options require additional
884 libraries. You may be able to enable those options, but you will
885 need to load additional static libraries.
888 \item [ {-}{-}enable-client-only]
889 \index[general]{{-}{-}enable-client-only}
890 This option causes the make process to build only the File daemon and
891 the libraries that it needs. None of the other daemons, storage tools,
892 nor the console will be built. Likewise a {\bf make install} will then
893 only install the File daemon. To cause all daemons to be built, you
894 will need to do a configuration without this option. This option
895 greatly facilitates building a Client on a client only machine.
897 When linking a static binary, the linker needs the static versions
898 of all the libraries that are used, so frequently users will
899 experience linking errors when this option is used. The first
900 thing to do is to make sure you have the static glibc library
901 installed on your system. The second thing to do is the make sure
902 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
903 on your ./configure statement as these options require additional
904 libraries. You may be able to enable those options, but you will
905 need to load additional static libraries.
907 \item [ {-}{-}enable-build-dird]
908 \index[general]{{-}{-}enable-build-dird}
909 This option causes the make process to build the Director and the
910 Director's tools. By default, this option is on, but you may turn
911 it off by using {\bf {-}{-}disable-build-dird} to prevent the
912 Director from being built.
914 \item [ {-}{-}enable-build-stored]
915 \index[general]{{-}{-}enable-build-stored}
916 This option causes the make process to build the Storage daemon.
917 By default, this option is on, but you may turn
918 it off by using {\bf {-}{-}disable-build-stored} to prevent the
919 Storage daemon from being built.
922 \item [ {-}{-}enable-largefile]
923 \index[general]{{-}{-}enable-largefile}
924 This option (default) causes Bacula to be built with 64 bit file address
925 support if it is available on your system. This permits Bacula to read and
926 write files greater than 2 GBytes in size. You may disable this feature and
927 revert to 32 bit file addresses by using {\bf \verb:--:disable-largefile}.
929 \item [ {-}{-}disable-nls]
930 \index[general]{{-}{-}disable-nls}
931 By default, Bacula uses the GNU Native Language Support (NLS) libraries. On
932 some machines, these libraries may not be present or may not function
933 correctly (especially on non-Linux implementations). In such cases, you
934 may specify {\bf {-}{-}disable-nls} to disable use of those libraries.
935 In such a case, Bacula will revert to using English.
937 \item [ {-}{-}disable-ipv6 ]
938 \index[general]{{-}{-}disable-ipv6}
939 By default, Bacula enables IPv6 protocol. On some systems, the files
940 for IPv6 may exist, but the functionality could be turned off in the
941 kernel. In that case, in order to correctly build Bacula, you will
942 explicitly need to use this option so that Bacula does not attempt
943 to reference OS function calls that do not exist.
945 \item [ {-}{-}with-sqlite=\lt{}sqlite-path\gt{}]
946 \index[general]{{-}{-}with-sqlite}
947 This enables use of the SQLite version 2.8.x database. The {\bf
948 sqlite-path} is not normally specified as Bacula looks for the necessary
949 components in a standard location ({\bf depkgs/sqlite}). See
950 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
951 this manual for more details. SQLite is not supported on Solaris.
953 See the note below under the {-}{-}with-postgresql item.
955 \item [ {-}{-}with-sqlite3=\lt{}sqlite3-path\gt{}]
956 \index[general]{{-}{-}with-sqlite3}
957 This enables use of the SQLite version 3.x database. The {\bf
958 sqlite3-path} is not normally specified as Bacula looks for the
959 necessary components in a standard location ({\bf depkgs/sqlite3}). See
960 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
961 this manual for more details. SQLite3 is not supported on Solaris.
963 \item [ {-}{-}with-mysql=\lt{}mysql-path\gt{}]
964 \index[general]{{-}{-}with-mysql}
965 This enables building of the Catalog services for Bacula. It assumes
966 that MySQL is running on your system, and expects it to be installed in
967 the {\bf mysql-path} that you specify. Normally, if MySQL is installed
968 in a standard system location, you can simply use {\bf {-}{-}with-mysql}
969 with no path specification. If you do use this option, please proceed
970 to installing MySQL in the \ilink{Installing and Configuring
971 MySQL}{MySqlChapter} chapter before proceeding with the configuration.
973 See the note below under the {-}{-}with-postgresql item.
975 \item [ {-}{-}with-postgresql=\lt{}path\gt{}]
976 \index[general]{{-}{-}with-postgresql}
977 This provides an explicit path to the PostgreSQL libraries if Bacula
978 cannot find it by default. Normally to build with PostgreSQL, you would
979 simply use {\bf {-}{-}with-postgresql}.
981 Note, for Bacula to be configured properly, you must specify one
982 of the four database options supported. That is:
983 {-}{-}with-sqlite, {-}{-}with-sqlite3, {-}{-}with-mysql, or
984 {-}{-}with-postgresql, otherwise the ./configure will fail.
986 \item [ {-}{-}with-openssl=\lt{}path\gt{}]
987 This configuration option is necessary if you want to enable TLS (ssl),
988 which encrypts the communications within
989 Bacula or if you want to use File Daemon PKI data encryption.
990 Normally, the {\bf path} specification is not necessary since
991 the configuration searches for the OpenSSL libraries in standard system
992 locations. Enabling OpenSSL in Bacula permits secure communications
993 between the daemons and/or data encryption in the File daemon.
994 For more information on using TLS, please see the
995 \ilink{Bacula TLS -- Communications Encryption}{CommEncryption} chapter
997 For more information on using PKI data encryption, please see the
998 \ilink{Bacula PKI -- Data Encryption}{DataEncryption}
999 chapter of this manual.
1001 \item [ {-}{-}with-python=\lt{}path\gt{}]
1002 \index[general]{{-}{-}with-python}
1003 This option enables Bacula support for Python. If no path is supplied,
1004 configure will search the standard library locations for Python 2.2,
1005 2.3, 2.4, or 2.5. If it cannot find the library, you will need to
1006 supply a path to your Python library directory. Please see the
1007 \ilink{Python chapter}{PythonChapter} for the details of using Python
1010 \item [ {-}{-}with-libintl-prefix=\lt{}DIR\gt{}]
1011 \index[general]{{-}{-}with-libintl-prefix}
1012 This option may be used to tell Bacula to search DIR/include and
1013 DIR/lib for the libintl headers and libraries needed for Native
1014 Language Support (NLS).
1016 \item [ {-}{-}enable-conio]
1017 \index[general]{{-}{-}enable-conio}
1018 Tells Bacula to enable building the small, light weight readline
1019 replacement routine. It is generally much easier to configure than
1020 readline, although, like readline, it needs either the termcap or
1023 \item [ {-}{-}with-readline=\lt{}readline-path\gt{}]
1024 \index[general]{{-}{-}with-readline}
1025 Tells Bacula where {\bf readline} is installed. Normally, Bacula will
1026 find readline if it is in a standard library. If it is not found and no
1027 {-}{-}with-readline is specified, readline will be disabled. This
1028 option affects the Bacula build. Readline provides the Console program
1029 with a command line history and editing capability and is no longer
1030 supported, so you are on your own if you have problems.
1032 \item [ {-}{-}enable-readline]
1033 \index[general]{{-}{-}enable-readline}
1034 Tells Bacula to enable readline support. It is normally disabled due to the
1035 large number of configuration problems and the fact that the package seems to
1036 change in incompatible ways from version to version.
1038 \item [ {-}{-}with-tcp-wrappers=\lt{}path\gt{}]
1039 \index[general]{{-}{-}with-tcp-wrappers}
1040 \index[general]{TCP Wrappers}
1041 \index[general]{Wrappers!TCP}
1042 \index[general]{libwrappers}
1043 This specifies that you want TCP wrappers (man hosts\_access(5)) compiled in.
1044 The path is optional since Bacula will normally find the libraries in the
1045 standard locations. This option affects the Bacula build. In specifying your
1046 restrictions in the {\bf /etc/hosts.allow} or {\bf /etc/hosts.deny} files, do
1047 not use the {\bf twist} option (hosts\_options(5)) or the Bacula process will
1048 be terminated. Note, when setting up your {\bf /etc/hosts.allow}
1049 or {\bf /etc/hosts.deny}, you must identify the Bacula daemon in
1050 question with the name you give it in your conf file rather than the
1051 name of the executable.
1053 For more information on configuring and testing TCP wrappers, please see the
1054 \ilink{Configuring and Testing TCP Wrappers}{wrappers} section
1055 in the Security Chapter.
1057 On SuSE, the libwrappers libraries needed to link Bacula are
1058 contained in the tcpd-devel package. On Red Hat, the package is named
1061 \item [ {-}{-}with-archivedir=\lt{}path\gt{} ]
1062 \index[general]{{-}{-}with-archivedir}
1063 The directory used for disk-based backups. Default value is /tmp.
1064 This parameter sets the default values in the bacula-dir.conf and bacula-sd.conf
1065 configuration files. For example, it sets the Where directive for the
1066 default restore job and the Archive Device directive for the FileStorage
1069 This option is designed primarily for use in regression testing.
1070 Most users can safely ignore this option.
1072 \item [ {-}{-}with-working-dir=\lt{}working-directory-path\gt{} ]
1073 \index[general]{{-}{-}with-working-dir}
1074 This option is mandatory and specifies a directory into which Bacula may
1075 safely place files that will remain between Bacula executions. For example,
1076 if the internal database is used, Bacula will keep those files in this
1077 directory. This option is only used to modify the daemon configuration
1078 files. You may also accomplish the same thing by directly editing them later.
1079 The working directory is not automatically created by the install process, so
1080 you must ensure that it exists before using Bacula for the first time.
1082 \item [ {-}{-}with-base-port=\lt{}port=number\gt{}]
1083 \index[general]{{-}{-}with-base-port}
1084 In order to run, Bacula needs three TCP/IP ports (one for the Bacula
1085 Console, one for the Storage daemon, and one for the File daemon). The {\bf
1086 \verb:--:with-baseport} option will automatically assign three ports beginning at
1087 the base port address specified. You may also change the port number in the
1088 resulting configuration files. However, you need to take care that the
1089 numbers correspond correctly in each of the three daemon configuration
1090 files. The default base port is 9101, which assigns ports 9101 through 9103.
1091 These ports (9101, 9102, and 9103) have been officially assigned to Bacula by
1092 IANA. This option is only used to modify the daemon configuration files. You
1093 may also accomplish the same thing by directly editing them later.
1095 \item [ {-}{-}with-dump-email=\lt{}email-address\gt{}]
1096 \index[general]{{-}{-}with-dump-email}
1097 This option specifies the email address where any core dumps should be set.
1098 This option is normally only used by developers.
1100 \item [ {-}{-}with-pid-dir=\lt{}PATH\gt{} ]
1101 \index[general]{{-}{-}with-pid-dir}
1102 This specifies where Bacula should place the process id file during
1103 execution. The default is: {\bf /var/run}. This directory is not created by
1104 the install process, so you must ensure that it exists before using Bacula
1107 \item [ {-}{-}with-subsys-dir=\lt{}PATH\gt{}]
1108 \index[general]{{-}{-}with-subsys-dir}
1109 This specifies where Bacula should place the subsystem lock file during
1110 execution. The default is {\bf /var/run/subsys}. Please make sure that you do
1111 not specify the same directory for this directory and for the {\bf sbindir}
1112 directory. This directory is used only within the autostart scripts. The
1113 subsys directory is not created by the Bacula install, so you must be sure to
1114 create it before using Bacula.
1116 \item [ {-}{-}with-dir-password=\lt{}Password\gt{}]
1117 \index[general]{{-}{-}with-dir-password}
1118 This option allows you to specify the password used to access the Director
1119 (normally from the Console program). If it is not specified, configure will
1120 automatically create a random password.
1122 \item [ {-}{-}with-fd-password=\lt{}Password\gt{} ]
1123 \index[general]{{-}{-}with-fd-password}
1124 This option allows you to specify the password used to access the File daemon
1125 (normally called from the Director). If it is not specified, configure will
1126 automatically create a random password.
1128 \item [ {-}{-}with-sd-password=\lt{}Password\gt{} ]
1129 \index[general]{{-}{-}with-sd-password}
1130 This option allows you to specify the password used to access the Storage daemon
1131 (normally called from the Director). If it is not specified, configure will
1132 automatically create a random password.
1134 \item [ {-}{-}with-dir-user=\lt{}User\gt{} ]
1135 \index[general]{{-}{-}with-dir-user}
1136 This option allows you to specify the Userid used to run the Director. The
1137 Director must be started as root, but doesn't need to run as root, and
1138 after doing preliminary initializations, it can "drop" to the UserId
1139 specified on this option.
1140 If you specify this option, you must
1141 create the User prior to running {\bf make install}, because the
1142 working directory owner will be set to {\bf User}.
1144 \item [ {-}{-}with-dir-group=\lt{}Group\gt{} ]
1145 \index[general]{{-}{-}with-dir-group}
1146 This option allows you to specify the GroupId used to run the Director. The
1147 Director must be started as root, but doesn't need to run as root, and after
1148 doing preliminary initializations, it can "drop" to the GroupId specified
1150 If you specify this option, you must
1151 create the Group prior to running {\bf make install}, because the
1152 working directory group will be set to {\bf Group}.
1154 \item [ {-}{-}with-sd-user=\lt{}User\gt{} ]
1155 \index[general]{{-}{-}with-sd-user}
1156 This option allows you to specify the Userid used to run the Storage daemon.
1157 The Storage daemon must be started as root, but doesn't need to run as root,
1158 and after doing preliminary initializations, it can "drop" to the UserId
1159 specified on this option. If you use this option, you will need to take care
1160 that the Storage daemon has access to all the devices (tape drives, ...) that
1163 \item [ {-}{-}with-sd-group=\lt{}Group\gt{} ]
1164 \index[general]{{-}{-}with-sd-group}
1165 This option allows you to specify the GroupId used to run the Storage daemon.
1166 The Storage daemon must be started as root, but doesn't need to run as root,
1167 and after doing preliminary initializations, it can "drop" to the GroupId
1168 specified on this option.
1170 \item [ {-}{-}with-fd-user=\lt{}User\gt{} ]
1171 \index[general]{{-}{-}with-fd-user}
1172 This option allows you to specify the Userid used to run the File daemon. The
1173 File daemon must be started as root, and in most cases, it needs to run as
1174 root, so this option is used only in very special cases, after doing
1175 preliminary initializations, it can "drop" to the UserId specified on this
1178 \item [ {-}{-}with-fd-group=\lt{}Group\gt{} ]
1179 \index[general]{{-}{-}with-fd-group}
1180 This option allows you to specify the GroupId used to run the File daemon.
1181 The File daemon must be started as root, and in most cases, it must be run as
1182 root, however, after doing preliminary initializations, it can "drop" to
1183 the GroupId specified on this option.
1185 \item [ {-}{-}with-mon-dir-password=\lt{}Password\gt{}]
1186 \index[general]{{-}{-}with-mon-dir-password}
1187 This option allows you to specify the password used to access the Directory
1188 from the monitor. If it is not specified, configure will
1189 automatically create a random password.
1191 \item [ {-}{-}with-mon-fd-password=\lt{}Password\gt{} ]
1192 \index[general]{{-}{-}with-mon-fd-password}
1193 This option allows you to specify the password used to access the File daemon
1194 from the Monitor. If it is not specified, configure will
1195 automatically create a random password.
1197 \item [ {-}{-}with-mon-sd-password=\lt{}Password\gt{} ]
1198 \index[general]{{-}{-}with-mon-sd-password}
1199 This option allows you to specify the password used to access the
1200 Storage daemon from the Monitor. If it is not specified, configure will
1201 automatically create a random password.
1203 \item [ {-}{-}with-db-name=\lt{}database-name\gt{} ]
1204 \index[general]{{-}{-}with-db-name}
1205 This option allows you to specify the database name to be used in
1206 the conf files. The default is bacula.
1208 \item [ {-}{-}with-db-user=\lt{}database-user\gt{} ]
1209 \index[general]{{-}{-}with-db-user}
1210 This option allows you to specify the database user name to be used in
1211 the conf files. The default is bacula.
1215 Note, many other options are presented when you do a {\bf ./configure
1216 \verb:--:help}, but they are not implemented.
1218 \section{Recommended Options for Most Systems}
1219 \index[general]{Systems!Recommended Options for Most}
1220 \index[general]{Recommended Options for Most Systems}
1222 For most systems, we recommend starting with the following options:
1227 --enable-smartalloc \
1228 --sbindir=$HOME/bacula/bin \
1229 --sysconfdir=$HOME/bacula/bin \
1230 --with-pid-dir=$HOME/bacula/bin/working \
1231 --with-subsys-dir=$HOME/bacula/bin/working \
1232 --with-mysql=$HOME/mysql \
1233 --with-working-dir=$HOME/bacula/working
1237 If you want to install Bacula in an installation directory rather than run it
1238 out of the build directory (as developers will do most of the time), you
1239 should also include the \verb:--:sbindir and \verb:--:sysconfdir options with appropriate
1240 paths. Neither are necessary if you do not use "make install" as is the case
1241 for most development work. The install process will create the sbindir and
1242 sysconfdir if they do not exist, but it will not automatically create the
1243 pid-dir, subsys-dir, or working-dir, so you must ensure that they exist before
1244 running Bacula for the first time.
1247 \index[general]{Red Hat}
1254 CFLAGS="-g -Wall" ./configure \
1255 --sbindir=$HOME/bacula/bin \
1256 --sysconfdir=$HOME/bacula/bin \
1257 --enable-smartalloc \
1258 --with-sqlite=$HOME/bacula/depkgs/sqlite \
1259 --with-working-dir=$HOME/bacula/working \
1260 --with-pid-dir=$HOME/bacula/bin/working \
1261 --with-subsys-dir=$HOME/bacula/bin/working \
1263 --with-qwt=$HOME/bacula/depkgs/qwt \
1273 CFLAGS="-g -Wall" ./configure \
1274 --sbindir=$HOME/bacula/bin \
1275 --sysconfdir=$HOME/bacula/bin \
1276 --enable-smartalloc \
1277 --with-mysql=$HOME/mysql \
1278 --with-working-dir=$HOME/bacula/working
1279 --with-pid-dir=$HOME/bacula/bin/working \
1280 --with-subsys-dir=$HOME/bacula/bin/working
1286 or finally, a completely traditional Red Hat Linux install:
1290 CFLAGS="-g -Wall" ./configure \
1292 --sbindir=/usr/sbin \
1293 --sysconfdir=/etc/bacula \
1294 --with-scriptdir=/etc/bacula \
1295 --enable-smartalloc \
1297 --with-qwt=$HOME/bacula/depkgs/qwt \
1299 --with-working-dir=/var/bacula \
1300 --with-pid-dir=/var/run \
1305 Note, Bacula assumes that /var/bacula, /var/run, and /var/lock/subsys exist so
1306 it will not automatically create them during the install process.
1309 \index[general]{Solaris}
1311 To build Bacula from source, you will need the following installed on your
1312 system (they are not by default): libiconv, gcc 3.3.2, stdc++, libgcc (for
1313 stdc++ and gcc\_s libraries), make 3.8 or later.
1315 You will probably also need to: Add /usr/local/bin to PATH and Add
1316 /usr/ccs/bin to PATH for ar.
1318 It is possible to build Bacula on Solaris with the Solaris compiler, but
1319 we recommend using GNU C++ if possible.
1321 A typical configuration command might look like:
1326 CFLAGS="-g" ./configure \
1327 --sbindir=$HOME/bacula/bin \
1328 --sysconfdir=$HOME/bacula/bin \
1329 --with-mysql=$HOME/mysql \
1330 --enable-smartalloc \
1331 --with-pid-dir=$HOME/bacula/bin/working \
1332 --with-subsys-dir=$HOME/bacula/bin/working \
1333 --with-working-dir=$HOME/bacula/working
1337 As mentioned above, the install process will create the sbindir and sysconfdir
1338 if they do not exist, but it will not automatically create the pid-dir,
1339 subsys-dir, or working-dir, so you must ensure that they exist before running
1340 Bacula for the first time.
1342 Note, you may need to install the following packages to build Bacula
1362 PATH=/usr/bin::/usr/ccs/bin:/etc:/usr/openwin/bin:/usr/local/bin:/usr/sfw/bin:/opt/sfw/bin:/usr/ucb:/usr/sbin
1366 If you have installed special software not normally in the Solaris
1367 libraries, such as OpenSSL, or the packages shown above, then you may need
1368 to add {\bf /usr/sfw/lib} to the library search path. Probably the
1369 simplest way to do so is to run:
1373 setenv LDFLAGS "-L/usr/sfw/lib -R/usr/sfw/lib"
1377 Prior to running the ./configure command.
1379 Alternatively, you can set the LD\_LIBARY\_PATH and/or the LD\_RUN\_PATH
1380 environment variables appropriately.
1382 It is also possible to use the {\bf crle} program to set the library
1383 search path. However, this should be used with caution.
1386 \index[general]{FreeBSD}
1389 \elink{The FreeBSD Diary}{http://www.freebsddiary.org/bacula.php} for a
1390 detailed description on how to make Bacula work on your system. In addition,
1391 users of FreeBSD prior to 4.9-STABLE dated Mon Dec 29 15:18:01 2003 UTC who
1392 plan to use tape devices, please see the
1393 \ilink{Tape Testing Chapter}{FreeBSDTapes} of this manual for
1394 {\bf important} information on how to configure your tape drive for
1395 compatibility with Bacula.
1397 If you are using Bacula with MySQL, you should take care to compile MySQL with
1398 FreeBSD native threads rather than LinuxThreads, since Bacula is normally built
1399 with FreeBSD native threads rather than LinuxTreads. Mixing the two will
1403 \index[general]{Win32}
1405 To install the binary Win32 version of the File daemon please see the
1406 \ilink{Win32 Installation Chapter}{Win32Chapter} in this document.
1408 \section{One File Configure Script}
1409 \index[general]{Script!One File Configure}
1410 \index[general]{One Files Configure Script}
1412 The following script could be used if you want to put everything
1420 --sbindir=$HOME/bacula/bin \
1421 --sysconfdir=$HOME/bacula/bin \
1422 --mandir=$HOME/bacula/bin \
1423 --enable-smartalloc \
1426 --with-qwt=$HOME/bacula/depkgs/qwt \
1427 --enable-bwx-console \
1428 --enable-tray-monitor \
1429 --with-pid-dir=$HOME/bacula/bin/working \
1430 --with-subsys-dir=$HOME/bacula/bin/working \
1432 --with-working-dir=$HOME/bacula/bin/working \
1433 --with-dump-email=$USER@your-site.com \
1434 --with-job-email=$USER@your-site.com \
1435 --with-smtp-host=mail.your-site.com
1440 You may also want to put the following entries in your {\bf /etc/services}
1441 file as it will make viewing the connections made by Bacula easier to
1442 recognize (i.e. netstat -a):
1452 \section{Installing Bacula}
1453 \index[general]{Bacula!Installing}
1454 \index[general]{Installing Bacula}
1456 Before setting up your configuration files, you will want to install Bacula in
1457 its final location. Simply enter:
1465 If you have previously installed Bacula, the old binaries will be overwritten,
1466 but the old configuration files will remain unchanged, and the "new"
1467 configuration files will be appended with a {\bf .new}. Generally if you have
1468 previously installed and run Bacula you will want to discard or ignore the
1469 configuration files with the appended {\bf .new}.
1471 \section{Building a File Daemon or Client}
1472 \index[general]{Client!Building a File Daemon or}
1473 \index[general]{Building a File Daemon or Client}
1475 If you run the Director and the Storage daemon on one machine and you wish to
1476 back up another machine, you must have a copy of the File daemon for that
1477 machine. If the machine and the Operating System are identical, you can simply
1478 copy the Bacula File daemon binary file {\bf bacula-fd} as well as its
1479 configuration file {\bf bacula-fd.conf} then modify the name and password in
1480 the conf file to be unique. Be sure to make corresponding additions to the
1481 Director's configuration file ({\bf bacula-dir.conf}).
1483 If the architecture or the OS level are different, you will need to build a
1484 File daemon on the Client machine. To do so, you can use the same {\bf
1485 ./configure} command as you did for your main program, starting either from a
1486 fresh copy of the source tree, or using {\bf make\ distclean} before the {\bf
1489 Since the File daemon does not access the Catalog database, you can remove
1490 the {\bf \verb:--:with-mysql} or {\bf \verb:--:with-sqlite} options, then
1491 add {\bf \verb:--:enable-client-only}. This will compile only the
1492 necessary libraries and the client programs and thus avoids the necessity
1493 of installing one or another of those database programs to build the File
1494 daemon. With the above option, you simply enter {\bf make} and just the
1495 client will be built.
1498 \section{Auto Starting the Daemons}
1499 \index[general]{Daemons!Auto Starting the}
1500 \index[general]{Auto Starting the Daemons}
1502 If you wish the daemons to be automatically started and stopped when your
1503 system is booted (a good idea), one more step is necessary. First, the
1504 ./configure process must recognize your system -- that is it must be a
1505 supported platform and not {\bf unknown}, then you must install the platform
1506 dependent files by doing:
1511 make install-autostart
1515 Please note, that the auto-start feature is implemented only on systems
1516 that we officially support (currently, FreeBSD, Red Hat/Fedora Linux, and
1517 Solaris), and has only been fully tested on Fedora Linux.
1519 The {\bf make install-autostart} will cause the appropriate startup scripts
1520 to be installed with the necessary symbolic links. On Red Hat/Fedora Linux
1521 systems, these scripts reside in {\bf /etc/rc.d/init.d/bacula-dir} {\bf
1522 /etc/rc.d/init.d/bacula-fd}, and {\bf /etc/rc.d/init.d/bacula-sd}. However
1523 the exact location depends on what operating system you are using.
1525 If you only wish to install the File daemon, you may do so with:
1529 make install-autostart-fd
1533 \section{Other Make Notes}
1534 \index[general]{Notes!Other Make}
1535 \index[general]{Other Make Notes}
1537 To simply build a new executable in any directory, enter:
1545 To clean out all the objects and binaries (including the files named 1, 2, or
1546 3, which are development temporary files), enter:
1554 To really clean out everything for distribution, enter:
1562 note, this cleans out the Makefiles and is normally done from the top level
1563 directory to prepare for distribution of the source. To recover from this
1564 state, you must redo the {\bf ./configure} in the top level directory, since
1565 all the Makefiles will be deleted.
1567 To add a new file in a subdirectory, edit the Makefile.in in that directory,
1568 then simply do a {\bf make}. In most cases, the make will rebuild the Makefile
1569 from the new Makefile.in. In some case, you may need to issue the {\bf make} a
1570 second time. In extreme cases, cd to the top level directory and enter: {\bf
1573 To add dependencies:
1581 The {\bf make depend} appends the header file dependencies for each of the
1582 object files to Makefile and Makefile.in. This command should be done in each
1583 directory where you change the dependencies. Normally, it only needs to be run
1584 when you add or delete source or header files. {\bf make depend} is normally
1585 automatically invoked during the configuration process.
1595 This not normally done if you are developing Bacula, but is used if you are
1596 going to run it to backup your system.
1598 After doing a {\bf make install} the following files will be installed on your
1599 system (more or less). The exact files and location (directory) for each file
1600 depends on your {\bf ./configure} command (e.g. bgnome-console and
1601 bgnome-console.conf are not installed if you do not configure GNOME. Also, if
1602 you are using SQLite instead of MySQL, some of the files will be different).
1604 NOTE: it is quite probable that this list is out of date. But it is a
1626 create_mysql_database
1628 delete_catalog_backup
1649 \section{Installing Tray Monitor}
1650 \index[general]{Monitor!Installing Tray}
1651 \index[general]{Installing Tray Monitor}
1653 The Tray Monitor is already installed if you used the {\bf
1654 \verb:--:enable-tray-monitor} configure option and ran {\bf make install}.
1656 As you don't run your graphical environment as root (if you do, you should
1657 change that bad habit), don't forget to allow your user to read {\bf
1658 tray-monitor.conf}, and to execute {\bf bacula-tray-monitor} (this is not a
1661 Then log into your graphical environment (KDE, GNOME or something else), run
1662 {\bf bacula-tray-monitor} as your user, and see if a cassette icon appears
1663 somewhere on the screen, usually on the task bar.
1664 If it doesn't, follow the instructions below related to your environment or
1668 \index[general]{GNOME}
1670 System tray, or notification area if you use the GNOME terminology, has been
1671 supported in GNOME since version 2.2. To activate it, right-click on one of
1672 your panels, open the menu {\bf Add to this Panel}, then {\bf Utility} and
1673 finally click on {\bf Notification Area}.
1676 \index[general]{KDE}
1678 System tray has been supported in KDE since version 3.1. To activate it,
1679 right-click on one of your panels, open the menu {\bf Add}, then {\bf Applet}
1680 and finally click on {\bf System Tray}.
1682 \subsection{Other window managers}
1683 \index[general]{Managers!Other window}
1684 \index[general]{Other window managers}
1686 Read the documentation to know if the Freedesktop system tray standard is
1687 supported by your window manager, and if applicable, how to activate it.
1689 \section{Modifying the Bacula Configuration Files}
1690 \index[general]{Modifying the Bacula Configuration Files}
1691 \index[general]{Files!Modifying the Bacula Configuration}
1694 \ilink{Configuring Bacula}{ConfigureChapter} in this manual for
1695 instructions on how to set Bacula configuration files.