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} or
12 {\bf PostgreSQL} 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 The source code has been broken into
26 three separate tar files each corresponding to a different module in
27 the Bacula git repository. The released files are:
30 \item [bacula-7.2.0.tar.gz]
31 This is the primary source code release for Bacula. On each
32 release the version number (7.2.0) will be updated.
34 \item [bacula-docs-7.2.0.tar.bz2]
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, German, Spanish translations
38 are not built, but can be obtained from the git repository.
39 Note that this file is big, it used .bz2 compression which
42 \item [bacula-gui-7.2.0.tar.gz]
43 This file contains the non-core GUI programs. Currently,
44 it contains Baculum, a PHP program for producing management
45 viewing of your Bacula job status in a browser.
47 \item [win32bacula-7.2.0.exe]
48 This file is the 32 bit Windows installer for installing
49 the Windows client (File daemon) on a Windows machine.
50 This client will also run on 64 bit Windows machines, but
51 VSS support is not available if you are running a 64 bit
52 version of Windows. This installer installs only the FD,
53 the Director and Storage daemon are not included.
55 \item [win64bacula-7.2.0.exe]
56 This file is the 64 bit Windows installer for installing
57 the Windows client (File daemon) on a Windows machine.
58 This client will only run on 64 bit Windows OS machines.
59 It will not run on 32 bit machines or 32 bit Windows OSes.
60 The win64bacula release is necessary for Volume Shadow
61 Copy (VSS) to work on Win64 OSes. This installer
62 installs only the FD, the Director and Storage daemon
68 \section{Upgrading Bacula}
69 \index[general]{Bacula!Upgrading}
70 \index[general]{Upgrading Bacula}
71 \index[general]{Upgrading}
73 If you are upgrading from one Bacula version to another, you should first
74 carefully read the ReleaseNotes of all major versions between your current
75 version and the version to which you are upgrading. In many upgrades,
76 especially for minor patch upgrades (e.g. between 3.0.0 and 3.0.1) there
77 will be no database upgrade, and hence the process is rather simple.
79 With version 3.0.0 and later, you {\bf must} ensure that on any one
80 machine that all components of Bacula are running on exactly the
81 same version. Prior to version 3.0.0, it was possible to run a
82 lower level FD with a newer Director and SD. This is no longer the
85 As always, we attempt to support older File daemons. This avoids the
86 need to do a simultaneous upgrade of many machines. For exactly what
87 older versions of the FD are supported, please see the ReleaseNotes
88 for the new version. In any case, you must always upgrade both the
89 Director and the Storage daemon at the same time, and you must also
90 upgrade any File daemon that is running on the same machine as a Director
91 or a Storage daemon (see the prior paragraph).
94 database has been upgraded (as it is almost every major release), you will
95 either need to reinitialize your database starting from scratch (not
96 normally a good idea), or save an ASCII copy of your database, then proceed
97 to upgrade it. If you are upgrading two major versions (e.g. 1.36 to 2.0)
98 then life will be more complicated because you must do two database
99 upgrades. See below for more on this.
101 Upgrading the catalog is normally done after Bacula is build and installed
105 cd <installed-scripts-dir> (default /etc/bacula)
106 ./update_bacula_tables
109 This update script can also be find in the Bacula source src/cats
112 If there are several database upgrades between your version and the
113 version to which you are upgrading, you will need to apply each database
114 upgrade script. For your convenience, you can find all the old upgrade scripts
115 in the {\bf upgradedb} directory of the source code. You will need to edit the
116 scripts to correspond to your system configuration. The final upgrade script,
117 if any, can be applied as noted above.
119 If you are upgrading from one major version to another, you will need to
120 replace all your components at the same time as generally the inter-daemon
121 protocol will change. However, within any particular release (e.g. version
122 1.32.x) unless there is an oversight or bug, the daemon protocol will not
123 change. If this is confusing, simply read the ReleaseNotes very carefully as
124 they will note if all daemons must be upgraded at the same time.
126 Finally, please note that in general it is not necessary or desirable
127 to do a {\bf make uninstall} before doing an upgrade providing you are careful
128 not to change the installation directories. In fact, if you do so, you will
129 most likely delete all your conf files, which could be disastrous.
130 The normal procedure during an upgrade is simply:
133 ./configure (your options)
138 In general none of your existing .conf or .sql files will be overwritten,
139 and you must do both the {\bf make} and {\bf make install} commands, a
140 {\bf make install} without the preceding {\bf make} will not work.
142 For additional information on upgrading, please see the \borgxrlink{Upgrading Bacula Versions}{upgrading}{problems}{section} of the \problemsman{}.
144 \section{Releases Numbering}
145 \index[general]{Release Numbering}
146 \index[general]{Version Numbering}
147 Every Bacula release whether beta or production has a different number
148 as well as the date of the release build. The numbering system follows
149 traditional Open Source conventions in that it is of the form.
160 where each component (major, minor, patch) is a number.
161 The major number is currently 1 and normally does not change
162 very frequently. The minor number starts at 0 and increases
163 each for each production release by 2 (i.e. it is always an
164 even number for a production release), and the patch number is
165 starts at zero each time the minor number changes. The patch
166 number is increased each time a bug fix (or fixes) is released
169 So, as of this date (10 September 2006), the current production Bacula
170 release is version 1.38.11. If there are bug fixes, the next release
171 will be 1.38.12 (i.e. the patch number has increased by one).
173 For all patch releases where the minor version number does not change,
174 the database and all the daemons will be compatible. That means that
175 you can safely run a 1.38.0 Director with a 1.38.11 Client. Of course,
176 in this case, the Director may have bugs that are not fixed. Generally,
177 within a minor release (some minor releases are not so minor), all
178 patch numbers are officially released to production. This means that while
179 the current Bacula version is 1.38.11, versions 1.38.0, 1.38.1, ... 1.38.10
180 have all been previously released.
182 When the minor number is odd, it indicates that the package is under
183 development and thus may not be stable. For example, while the current
184 production release of Bacula is currently 1.38.11, the current development
185 version is 1.39.22. All patch versions of the development code are
186 available in the SVN (source repository). However, not all patch versions
187 of the development code (odd minor version) are officially released. When
188 they are released, they are released as beta versions (see below for a
189 definition of what beta means for Bacula releases).
191 In general when the minor number increases from one production release
192 to the next (i.e. 1.38.x to 1.40.0), the catalog database must be upgraded,
193 the Director and Storage daemon must always be on the same minor release
194 number, and often (not always), the Clients must also be on the same minor
195 release. As often as possible, we attempt to make new releases that are
196 downwards compatible with prior clients, but this is not always possible.
197 You must check the release notes. In general, you will have fewer problems
198 if you always run all the components on the same minor version number (i.e.
199 all either 1.38.x or 1.40.x but not mixed).
203 \section*{Beta Releases}
204 \index[general]{Beta Releases}
205 Towards the end of the development cycle, which typically runs
206 one year from a major release to another, there will be several beta
207 releases of the development code prior to a production release.
208 As noted above, beta versions always have odd minor version numbers
209 (e.g 1.37.x or 1.39.x).
210 The purpose of the beta releases is to allow early adopter users to test
211 the new code. Beta releases are made with the following considerations:
214 \item The code passes the regression testing on FreeBSD, Linux, and Solaris
217 \item There are no known major bugs, or on the rare occasion that
218 there are, they will be documented or already in the bugs database.
220 \item Some of the new code/features may not yet be tested.
222 \item Bugs are expected to be found, especially in the new
223 code before the final production release.
225 \item The code will have been run in production in at least one small
228 \item The Win32 client will have been run in production at least
229 one night at that small site.
231 \item The documentation in the manual is unlikely to be complete especially
232 for the new features, and the Release Notes may not be fully
235 \item Beta code is not generally recommended for everyone, but
236 rather for early adopters.
241 \section{Dependency Packages}
242 \index[general]{Dependency Packages}
243 \index[general]{Packages!Dependency}
245 As discussed above, we have combined a number of third party packages that
246 Bacula might need into the {\bf depkgs} release. You can,
247 of course, get the latest packages from the original authors or
248 from your operating system supplier. The locations of
249 where we obtained the packages are in the README file in each package.
250 However, be aware that the packages in the depkgs files have been tested by us
251 for compatibility with Bacula.
253 Typically, a dependency package will be named {\bf depkgs-ddMMMyy.tar.gz}
254 where {\bf dd} is the day we release it, {\bf MMM}
255 is the abbreviated month (e.g. Jan), and {\bf yy} is the year. An actual
256 example is: {\bf depkgs-18Dec.tar.gz}. To install and build this package (if
257 needed), you do the following:
260 \item Create a {\bf bacula} directory, into which you will place both the
261 Bacula source as well as the dependency package.
262 \item Detar the {\bf depkgs} into the {\bf bacula} directory.
263 \item cd bacula/depkgs
267 Although the exact composition of the dependency packages may change from time
268 to time, the current makeup is the following:
270 \addcontentsline{lot}{table}{Dependency Packages}
271 \begin{longtable}{|l|l|l|}
273 \multicolumn{1}{|c| }{\bf 3rd Party Package} & \multicolumn{1}{c| }{\bf depkgs}
274 & \multicolumn{1}{c| }{\bf depkgs-qt} \\
275 \hline {mtx } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{ } \\
276 \hline {qt4 } & \multicolumn{1}{c| }{ } & \multicolumn{1}{c| }{X } \\
280 Note, some of these packages are quite large, so that building them can be a
281 bit time consuming. The above instructions will build all the packages
282 contained in the directory. However, when building Bacula, it will take only
283 those pieces that it actually needs.
285 Alternatively, you can make just the packages that are needed. For example,
294 will configure and build only the QT4 package.
296 You should build the packages that you will require in {\bf depkgs} a
297 prior to configuring and building Bacula, since Bacula will need
298 them during the build process.
300 Note, the {\bf depkgs-qt} package is required for building bat, because
301 bat is currently built with Qt version 4.3.4. It can be built with other
302 Qt versions, but that almost always creates problems or introduces
305 You can build the depkgs-qt with the following:
310 tar xfvz depkgs-qt-28Jul09.tar.gz
317 Doing the {\bf source qt4-path} defines the following environment
328 Each one should point to a specific location in the depkgs-qt package
329 that you loaded. It also puts the depkgs-qt/qt4/bin directory
330 on your path before all other directories. This ensures that
331 the bat build will use your Qt 4.3.4 library rather than any that
332 might be on your system.
334 Before running your Bacula build, please make sure that
335 {\bf qmake-qt4} is not on your path. If it is please rename it. If
336 you don't do this, Bacula will attempt to build with any Qt4 package
337 installed on your system rather than the one you just built.
338 If you logoff and log back in, you must re-source the depkgs-qt/qt4-patch
339 file before attempting to rebuild the bat part of Bacula.
341 For more information on the {\bf depkgs-qt} package, please read the
342 INSTALL file in the main directory of that package. If you are going to
343 build Qt4 using {\bf depkgs-qt}, you must source the {\bf qt4-paths} file
344 included in the package prior to building Bacula. Please read the INSTALL
345 file for more details.
347 You might find it worthwhile to build {\bf mtx}
348 because the {\bf tapeinfo} program that comes with it can often provide you
349 with valuable information about your SCSI tape drive (e.g. compression,
350 min/max block sizes, ...). Note, most distros provide {\bf mtx} as part of
353 The {\bf depkgs1} package is depreciated and previously contained
354 readline, which should be available on all operating systems.
356 The {\bf depkgs-win32} package is deprecated and no longer used in
357 Bacula version 1.39.x and later. It was previously used to build
358 the native Win32 client program, but this program is now built on Linux
359 systems using cross-compiling. All the tools and third party libraries
360 are automatically downloaded by executing the appropriate scripts. See
361 src/win32/README.mingw32 for more details.
363 \section{Supported Operating Systems}
365 \index[general]{Systems!Supported Operating}
366 \index[general]{Supported Operating Systems}
368 Please see the \ilink{Supported Operating Systems}{SupportedOSes} section
369 of the QuickStart chapter of this manual.
371 \section{Building Bacula from Source}
373 \index[general]{Source!Building Bacula from}
374 \index[general]{Building Bacula from Source}
376 The basic installation is rather simple.
379 \item Install and build any {\bf depkgs} as noted above. This
380 should be unnecessary on most modern Operating Systems.
382 \item Configure and install MySQL or PostgreSQL (if desired).
383 \ilink{Installing and Configuring MySQL Phase I}{MySqlChapter} or
384 \ilink{Installing and Configuring PostgreSQL Phase I}{PostgreSqlChapter}. If you are installing from rpms, and are
385 using MySQL, please be sure to install {\bf mysql-devel}, so that the MySQL
386 header files are available while compiling Bacula. In addition, the MySQL
387 client library {\bf mysqlclient} requires the gzip compression library {\bf
388 libz.a} or {\bf libz.so}. If you are using rpm packages, these libraries are
389 in the {\bf libz-devel} package. On Debian systems, you will need to load the
390 {\bf zlib1g-dev} package. If you are not using rpms or debs, you will need to
391 find the appropriate package for your system.
393 Note, if you already have a running MySQL or PostgreSQL on your system, you
394 can skip this phase provided that you have built the thread safe libraries.
395 And you have already installed the additional rpms noted above.
397 \item Detar the Bacula source code preferably into the {\bf bacula} directory
400 \item {\bf cd} to the directory containing the source code.
402 \item ./configure (with appropriate options as described below). Any
403 path names you specify as options on the ./configure command line
404 must be absolute paths and not relative.
406 \item Check the output of ./configure very carefully, especially the Install
407 binaries and Install config directories. If they are not correct,
408 please rerun ./configure until they are. The output from ./configure is
409 stored in {\bf config.out} and can be re-displayed at any time without
410 rerunning the ./configure by doing {\bf cat config.out}.
412 \item If after running ./configure once, you decide to change options and
413 re-run it, that is perfectly fine, but before re-running it, you should run:
421 so that you are sure to start from scratch and not have a mixture of the two
422 options. This is because ./configure caches much of the information. The {\bf
423 make distclean} is also critical if you move the source directory from one
424 machine to another. If the {\bf make distclean} fails, just ignore it and
428 If you get errors while linking in the Storage daemon directory
429 (src/stored), it is probably because you have not loaded the static
430 libraries on your system. I noticed this problem on a Solaris system.
431 To correct it, make sure that you have not added {\bf
432 {-} {-}enable-static-tools} to the {\bf ./configure} command.
434 If you skip this step ({\bf make}) and proceed immediately to the {\bf
435 make install} you are making two serious errors: 1. your install will
436 fail because Bacula requires a {\bf make} before a {\bf make install}.
437 2. you are depriving yourself of the chance to make sure there are no
438 errors before beginning to write files to your system directories.
442 Please be sure you have done a {\bf make} before entering this command,
443 and that everything has properly compiled and linked without errors.
446 \item If you are new to Bacula, we {\bf strongly} recommend that you skip
447 the next step and use the default configuration files, then run the
448 example program in the next chapter, then come back and modify your
449 configuration files to suit your particular needs.
451 \item Customize the configuration files for each of the three daemons
452 (Directory, File, Storage) and for the Console program. For the details
453 of how to do this, please see \ilink{Setting Up Bacula Configuration Files}{ConfigureChapter} in the Configuration chapter of this manual. We
454 recommend that you start by modifying the default configuration files
455 supplied, making the minimum changes necessary. Complete customization
456 can be done after you have Bacula up and running. Please take care when
457 modifying passwords, which were randomly generated, and the {\bf Name}s
458 as the passwords and names must agree between the configuration files
459 for security reasons.
461 \label{CreateDatabase}
462 \item Create the Bacula MySQL database and tables
464 \ilink{Installing and Configuring MySQL Phase II}{mysql_phase2} or
465 create the Bacula PostgreSQL database and tables
466 \ilink{Configuring PostgreSQL II}{PostgreSQL_configure} or alternatively if you are using
468 \item Start Bacula ({\bf ./bacula start}) Note. the next chapter shows you
469 how to do this in detail.
471 \item Interface with Bacula using the Console program
473 \item For the previous two items, please follow the instructions in the
474 \ilink{Running Bacula}{TutorialChapter} chapter of this manual,
475 where you will run a simple backup and do a restore. Do this before you make
476 heavy modifications to the configuration files so that you are sure that
477 Bacula works and are familiar with it. After that changing the conf files
480 \item If after installing Bacula, you decide to "move it", that is to
481 install it in a different set of directories, proceed as follows:
487 ./configure (your-new-options)
496 If all goes well, the {\bf ./configure} will correctly determine which
497 operating system you are running and configure the source code appropriately.
498 Currently, FreeBSD, Linux (Red Hat), and Solaris are supported. The Bacula
499 client (File daemon) is reported to work with MacOS X 10.3 is if
500 readline support is not enabled (default) when building the client.
502 If you install Bacula on more than one system, and they are identical, you can
503 simply transfer the source tree to that other system and do a "make
504 install". However, if there are differences in the libraries or OS versions,
505 or you wish to install on a different OS, you should start from the original
506 compress tar file. If you do transfer the source tree, and you have previously
507 done a ./configure command, you MUST do:
515 prior to doing your new ./configure. This is because the GNU autoconf tools
516 cache the configuration, and if you re-use a configuration for a Linux machine
517 on a Solaris, you can be sure your build will fail. To avoid this, as
518 mentioned above, either start from the tar file, or do a "make distclean".
520 In general, you will probably want to supply a more complicated {\bf
521 configure} statement to ensure that the modules you want are built and that
522 everything is placed into the correct directories.
524 For example, on Fedora, Red Hat, or SuSE one could use the following:
530 --sbindir=/opt/bacula/bin \
531 --sysconfdir=/opt/bacula/etc \
532 --with-pid-dir=/var/run \
533 --with-subsys-dir=/var/run \
535 --with-working-dir=/opt/bacula/working \
536 --with-dump-email=$USER
540 The advantage of using the above configuration to start is that
541 everything will be put into a single directory, which you can later delete
542 once you have run the examples in the next chapter and learned how Bacula
543 works. In addition, the above can be installed and run as non-root.
545 For the developer's convenience, I have added a {\bf defaultconfig} script to
546 the {\bf examples} directory. This script contains the statements that you
547 would normally use, and each developer/user may modify them to suit his needs.
548 You should find additional useful examples in this directory as well.
550 The {\bf \verb:--:enable-conio} or {\bf \verb:--:enable-readline} options are
551 useful because they provide a command line history, editing capability for the
552 Console program and tab completion on various option. If you have included
553 either option in the build, either the {\bf termcap} or the {\bf ncurses}
554 package will be needed to link. On most systems, including Red Hat and SuSE,
555 you should include the ncurses package. If Bacula's configure process finds
556 the ncurses libraries, it will use those rather than the termcap library. On
557 some systems, such as SuSE, the termcap library is not in the standard library
558 directory. As a consequence, the option may be disabled or you may get an
559 error message such as:
563 /usr/lib/gcc-lib/i586-suse-linux/3.3.1/.../ld:
564 cannot find -ltermcap
565 collect2: ld returned 1 exit status
569 while building the Bacula Console. In that case, you will need to set the {\bf
570 LDFLAGS} environment variable prior to building.
574 export LDFLAGS="-L/usr/lib/termcap"
578 The same library requirements apply if you wish to use the readline subroutines
579 for command line editing, history and tab completion or if you are using a
580 MySQL library that requires encryption. If you need encryption, you can either
581 export the appropriate additional library options as shown above or,
582 alternatively, you can include them directly on the ./configure line as in:
586 LDFLAGS="-lssl -lcyrpto" \
587 ./configure <your-options>
591 On some systems such as Mandriva, readline tends to
592 gobble up prompts, which makes it totally useless. If this happens to you, use
593 the disable option, or if you are using version 1.33 and above try using {\bf
594 \verb:--:enable-conio} to use a built-in readline replacement. You will still need
595 either the termcap or the ncurses library, but it is unlikely that the {\bf conio}
596 package will gobble up prompts.
598 readline is no longer supported after version 1.34. The code within Bacula
599 remains, so it should be usable, and if users submit patches for it, we will
600 be happy to apply them. However, due to the fact that each version of
601 readline seems to be incompatible with previous versions, and that there
602 are significant differences between systems, we can no longer afford to
605 \section{What Database to Use?}
607 \index[general]{What Database to Use?}
608 \index[general]{Use!What Database to}
610 If you wish to use MySQL as the Bacula catalog, please see the
611 \ilink{Installing and Configuring MySQL}{MySqlChapter} chapter of this
612 manual. You will need to install MySQL prior to continuing with the
613 configuration of Bacula. MySQL is a high quality database that is very
614 efficient and is suitable for small and medium sized installation (up to
615 2,000,000 files per job).
617 If you wish to use PostgreSQL as the Bacula catalog, please see the
618 \ilink{Installing and Configuring PostgreSQL}{PostgreSqlChapter} chapter of
619 this manual. You will need to install PostgreSQL prior to continuing with the
620 configuration of Bacula. PostgreSQL is very similar to MySQL, though it tends
621 to be slightly more SQL92 compliant and has many more advanced features such as
622 transactions, stored procedures, and the such. It requires a certain knowledge
623 to install and maintain. PostgreSQL is suitable for any sized installation
624 (some sites have much more than 1 billion objects in the Catalog). Bacula uses
625 many optimized PostgreSQL functions, and can run more than 10 time faster on
626 jobs having millions of files than MySQL (Specially in during restore, accurate
627 mode, bvfs queries and when the database server is not on the same host than
630 \section{Quick Start}
631 \index[general]{Quick Start}
632 \index[general]{Start!Quick}
634 There are a number of options and important considerations given below
635 that you can skip for the moment if you have not had any problems building
636 Bacula with a simplified configuration as shown above.
638 If the ./configure process is unable to find specific libraries (e.g.
639 libintl, you should ensure that the appropriate package is installed on
640 your system. Alternatively, if the package is installed in a non-standard
641 location (as far as Bacula is concerned), then there is generally an
642 option listed below (or listed with "./configure {-} {-}help" that will
643 permit you to specify the directory that should be searched. In other
644 cases, there are options that will permit you to disable to feature
645 (e.g. {-} {-}disable-nls).
647 If you want to dive right into it, we recommend you skip to the next chapter,
648 and run the example program. It will teach you a lot about Bacula and as an
649 example can be installed into a single directory (for easy removal) and run as
650 non-root. If you have any problems or when you want to do a real installation,
651 come back to this chapter and read the details presented below.
653 \section{Configure Options}
655 \index[general]{Options!Configure}
656 \index[general]{Configure Options}
658 The following command line options are available for {\bf configure} to
659 customize your installation.
662 \item [ \--prefix=\lt{}patch\gt{}]
663 \index[general]{{-}prefix}
664 This option is meant to allow you to direct where the architecture
665 independent files should be placed. However, we find this a somewhat
666 vague concept, and so we have not implemented this option other than
667 to use any explicit prefix that you may define. If you do not
668 explicitly specify a prefix, Bacula's configure routine will not use
669 the default value that ./configure --help prints.
670 As a consequence, we suggest that
671 you avoid it. We have provided options that allow you to explicitly
672 specify the directories for each of the major categories of installation
674 \item [ {-}{\-}sbindir=\lt{}binary-path\gt{}]
675 \index[general]{{-}{\-}sbindir}
676 Defines where the Bacula binary (executable) files will be placed during a
677 {\bf make install} command.
679 \item [ {-}{\-}sysconfdir=\lt{}config-path\gt{}]
680 \index[general]{{-}{\-}sysconfdir}
681 Defines where the Bacula configuration files should be placed during a
682 {\bf make install} command. Note, for security reasons,
683 this directory should be unique to Bacula and not read/writable by
684 any other user/group than Bacula is running under.
686 Please note that Bacula attempts to make the configuration directory
689 chmod 770 \lt{}sysconfdir\gt{}
691 So, if you make sysconfdir point to a global directory such as
692 /usr/local/etc, the modes for that directory will be restricted, and
693 this may affect other programs that are installed there. We strongly
694 recommend that you set {\bf sysconfdir} to {\bf /opt/bacula/etc} so
695 that the directory for all Bacula configuration files is unique to
696 Bacula and used only by Bacula.
699 \item [ {-}{\-}mandir=\lt{}path\gt{}]
700 \index[general]{{-}{\-}mandir}
701 Note, as of Bacula version 1.39.14, the meaning of any path
702 specified on this option is change from prior versions. It
703 now specifies the top level man directory.
704 Previously the mandir specified the full path to where you
705 wanted the man files installed.
706 The man files will be installed in gzip'ed format under
707 mandir/man1 and mandir/man8 as appropriate.
708 For the install to succeed you must have {\bf gzip} installed
711 By default, Bacula will install the Unix man pages in
712 /usr/share/man/man1 and /usr/share/man/man8.
713 If you wish the man page to be installed in
714 a different location, use this option to specify the path.
715 Note, the main HTML and PDF Bacula documents are in a separate
716 tar file that is not part of the source distribution.
718 \item [ {-}{\-}datadir=\lt{}path\gt{} ]
719 \index[general]{{-}{\-}datadir}
720 If you translate Bacula or parts of Bacula into a different language
721 you may specify the location of the po files using the {\bf
722 {-}{\-}datadir} option. You must manually install any po files as
723 Bacula does not (yet) automatically do so.
725 \item [ {-}{\-}disable-ipv6 ]
726 \index[general]{{-}{\-}disable-ipv6}
728 \item [ {-}{\-}enable-smartalloc ]
729 \index[general]{{-}{\-}enable-smartalloc}
730 This enables the inclusion of the Smartalloc orphaned buffer detection
731 code. This option is highly recommended. Because we never build
732 without this option, you may experience problems if it is not enabled.
733 In this case, simply re-enable the option. We strongly recommend
734 keeping this option enabled as it helps detect memory leaks. This
735 configuration parameter is used while building Bacula
737 \item [ {-}{\-}enable-bat ]
739 \index[general]{{-}{\-}enable-bat}
740 If you have Qt4 >= 4.3.4 installed on your computer including the
741 libqt4 and libqt4-devel (libqt4-dev on Debian) libraries, and you want
742 to use the Bacula Administration Tool (bat) GUI Console interface to
743 Bacula, you must specify this option. Doing so will build everything in
744 the {\bf src/qt-console} directory. The build with enable-bat will work
745 only with a full Bacula build (i.e. it will not work with a client-only
748 Qt4 is available on OpenSUSE 10.2, CentOS 5, Fedora, and Debian. If it
749 is not available on your system, you can download the {\bf depkgs-qt}
750 package from the Bacula Source Forge download area and build it.
752 INSTALL file in that package for more details. In particular to use
753 the Qt4 built by {\bf depkgs-qt} you {\bf must} source the file
756 \item [ {-}{\-}enable-batch-insert ]
757 \index[general]{{-}{\-}enable-batch-insert}
758 This option enables batch inserts of the attribute records (default) in
759 the catalog database, which is much faster (10 times or more) than
760 without this option for large numbers of files. However, this option
761 will automatically be disabled if your SQL libraries are not
762 thread safe. If you find that batch mode is not enabled on your Bacula
763 installation, then your database most likely does not support threads.
765 On most systems, MySQL and PostgreSQLare thread safe.
767 To verify that your PostgreSQL is thread safe, you can try this
768 (change the path to point to your particular installed libpq.a;
769 these commands were issued on FreeBSD 6.2):
772 $ nm /usr/local/lib/libpq.a | grep PQputCopyData
773 00001b08 T PQputCopyData
774 $ nm /usr/local/lib/libpq.a | grep mutex
776 U pthread_mutex_unlock
779 U pthread_mutex_unlock
782 The above example shows a libpq that contains the required function
783 PQputCopyData and is thread enabled (i.e. the pthread\_mutex* entries).
784 If you do not see PQputCopyData, your version of PostgreSQL is too old
785 to allow batch insert. If you do not see the mutex entries, then thread
786 support has not been enabled. Our tests indicate you usually need to
787 change the configuration options and recompile/reinstall the PostgreSQL
788 client software to get thread support.
790 Bacula always links to the thread safe MySQL libraries.
792 Running with Batch Insert turned on is recommended because it can
793 significantly improve attribute insertion times. However, it does
794 put a significantly larger part of the work on your SQL engine, so
795 you may need to pay more attention to tuning it. In particular,
796 Batch Insert can require large temporary table space, and consequently,
797 the default location (often /tmp) may run out of space causing errors.
798 For MySQL, the location is set in my.conf with "tmpdir". You may also
799 want to increase the memory available to your SQL engine to further
800 improve performance during Batch Inserts.
802 \item [ {-}{\-}enable-bwx-console ]
803 \index[general]{{-}{\-}enable-bwx-console}
804 If you have wxWidgets installed on your computer and you want to use the
805 wxWidgets GUI Console interface to Bacula, you must specify this option.
806 Doing so will build everything in the {\bf src/wx-console} directory.
807 This could also be useful to users who want a GUI Console and don't want
808 to install QT, as wxWidgets can work with GTK+, Motif or even X11
811 \item [ {-}{\-}enable-static-tools]
812 \index[general]{{-}{\-}enable-static-tools}
813 This option causes the linker to link the Storage daemon utility tools
814 ({\bf bls}, {\bf bextract}, and {\bf bscan}) statically. This permits
815 using them without having the shared libraries loaded. If you have
816 problems linking in the {\bf src/stored} directory, make sure you have
817 not enabled this option, or explicitly disable static linking by adding
818 {\bf \verb:--:disable-static-tools}.
820 \item [ {-}{\-}enable-static-fd]
821 \index[general]{{-}{\-}enable-static-fd}
822 This option causes the make process to build a {\bf static-bacula-fd} in
823 addition to the standard File daemon. This static version will include
824 statically linked libraries and is required for the Bare Metal recovery.
825 This option is largely superseded by using {\bf make static-bacula-fd}
826 from with in the {\bf src/filed} directory. Also, the {\bf
827 \verb:--:enable-client-only} option described below is useful for just
828 building a client so that all the other parts of the program are not
831 When linking a static binary, the linker needs the static versions
832 of all the libraries that are used, so frequently users will
833 experience linking errors when this option is used. The first
834 thing to do is to make sure you have the static glibc library
835 installed on your system. The second thing to do is the make sure
836 you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
837 on your ./configure statement as these options require additional
838 libraries. You may be able to enable those options, but you will
839 need to load additional static libraries.
842 \item [ {-}{\-}enable-static-sd]
843 \index[general]{{-}{\-}enable-static-sd}
844 This option causes the make process to build a {\bf static-bacula-sd} in
845 addition to the standard Storage daemon. This static version will
846 include statically linked libraries and could be useful during a Bare
849 When linking a static binary, the linker needs the static versions
850 of all the libraries that are used, so frequently users will
851 experience linking errors when this option is used. The first
852 thing to do is to make sure you have the static glibc library
853 installed on your system. The second thing to do is the make sure
854 you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
855 on your ./configure statement as these options require additional
856 libraries. You may be able to enable those options, but you will
857 need to load additional static libraries.
860 \item [ {-}{\-}enable-static-dir]
861 \index[general]{{-}{\-}enable-static-dir}
862 This option causes the make process to build a {\bf static-bacula-dir}
863 in addition to the standard Director. This static version will include
864 statically linked libraries and could be useful during a Bare Metal
867 When linking a static binary, the linker needs the static versions
868 of all the libraries that are used, so frequently users will
869 experience linking errors when this option is used. The first
870 thing to do is to make sure you have the static glibc library
871 installed on your system. The second thing to do is the make sure
872 you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
873 on your ./configure statement as these options require additional
874 libraries. You may be able to enable those options, but you will
875 need to load additional static libraries.
878 \item [ {-}{\-}enable-static-cons]
879 \index[general]{{-}{\-}enable-static-cons}
880 This option causes the make process to build a {\bf static-console} in
881 addition to the standard console. This static version will include
882 statically linked libraries and could be useful during a Bare Metal
885 When linking a static binary, the linker needs the static versions
886 of all the libraries that are used, so frequently users will
887 experience linking errors when this option is used. The first
888 thing to do is to make sure you have the static glibc library
889 installed on your system. The second thing to do is the make sure
890 you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
891 on your ./configure statement as these options require additional
892 libraries. You may be able to enable those options, but you will
893 need to load additional static libraries.
896 \item [ {-}{\-}enable-client-only]
897 \index[general]{{-}{\-}enable-client-only}
898 This option causes the make process to build only the File daemon and
899 the libraries that it needs. None of the other daemons, storage tools,
900 nor the console will be built. Likewise a {\bf make install} will then
901 only install the File daemon. To cause all daemons to be built, you
902 will need to do a configuration without this option. This option
903 greatly facilitates building a Client on a client only machine.
905 When linking a static binary, the linker needs the static versions
906 of all the libraries that are used, so frequently users will
907 experience linking errors when this option is used. The first
908 thing to do is to make sure you have the static glibc library
909 installed on your system. The second thing to do is the make sure
910 you do not specify {\bf {-}{\-}openssl} or {\bf {-}{\-}with-python}
911 on your ./configure statement as these options require additional
912 libraries. You may be able to enable those options, but you will
913 need to load additional static libraries.
915 \item [ {-}{\-}enable-build-dird]
916 \index[general]{{-}{\-}enable-build-dird}
917 This option causes the make process to build the Director and the
918 Director's tools. By default, this option is on, but you may turn
919 it off by using {\bf {-}{\-}disable-build-dird} to prevent the
920 Director from being built.
922 \item [ {-}{\-}enable-build-stored]
923 \index[general]{{-}{\-}enable-build-stored}
924 This option causes the make process to build the Storage daemon.
925 By default, this option is on, but you may turn
926 it off by using {\bf {-}{\-}disable-build-stored} to prevent the
927 Storage daemon from being built.
930 \item [ {-}{\-}enable-largefile]
931 \index[general]{{-}{\-}enable-largefile}
932 This option (default) causes Bacula to be built with 64 bit file address
933 support if it is available on your system. This permits Bacula to read and
934 write files greater than 2 GBytes in size. You may disable this feature and
935 revert to 32 bit file addresses by using {\bf \verb:--:disable-largefile}.
937 \item [ {-}{\-}disable-nls]
938 \index[general]{{-}{\-}disable-nls}
939 By default, Bacula uses the GNU Native Language Support (NLS) libraries. On
940 some machines, these libraries may not be present or may not function
941 correctly (especially on non-Linux implementations). In such cases, you
942 may specify {\bf {-}{\-}disable-nls} to disable use of those libraries.
943 In such a case, Bacula will revert to using English.
945 \item [ {-}{\-}disable-ipv6 ]
946 \index[general]{{-}{\-}disable-ipv6}
947 By default, Bacula enables IPv6 protocol. On some systems, the files
948 for IPv6 may exist, but the functionality could be turned off in the
949 kernel. In that case, in order to correctly build Bacula, you will
950 explicitly need to use this option so that Bacula does not attempt
951 to reference OS function calls that do not exist.
953 \item [ {-}{\-}with-mysql=\lt{}mysql-path\gt{}]
954 \index[general]{{-}{\-}with-mysql}
955 This enables building of the Catalog services for Bacula. It assumes
956 that MySQL is running on your system, and expects it to be installed in
957 the {\bf mysql-path} that you specify. Normally, if MySQL is installed
958 in a standard system location, you can simply use {\bf {-}{\-}with-mysql}
959 with no path specification. If you do use this option, please proceed
960 to installing MySQL in the \ilink{Installing and Configuring MySQL}{MySqlChapter} chapter before proceeding with the configuration.
962 See the note below under the {-}{\-}with-postgresql item.
964 \item [ {-}{\-}with-postgresql=\lt{}path\gt{}]
965 \index[general]{{-}{\-}with-postgresql}
966 This provides an explicit path to the PostgreSQL libraries if Bacula
967 cannot find it by default. Normally to build with PostgreSQL, you would
968 simply use {\bf {-}{\-}with-postgresql}.
970 Note, for Bacula to be configured properly, you must specify one
971 of the two database options supported. That is:
972 {-}{\-}with-postgresql, otherwise the ./configure will fail.
976 \item [ {-}{\-}with-openssl=\lt{}path\gt{}]
977 This configuration option is necessary if you want to enable TLS (ssl),
978 which encrypts the communications within
979 Bacula or if you want to use File Daemon PKI data encryption.
980 Normally, the {\bf path} specification is not necessary since
981 the configuration searches for the OpenSSL libraries in standard system
982 locations. However, you must ensure that all the libraries are
983 loaded including {\bf libssl-dev} or the equivalent on your
984 system. Enabling OpenSSL in Bacula permits secure communications
985 between the daemons and/or data encryption in the File daemon.
986 For more information on using TLS, please see the
987 \ilink{Bacula TLS -- Communications Encryption}{CommEncryption} chapter
989 For more information on using PKI data encryption, please see the
990 \ilink{Bacula PKI -- Data Encryption}{DataEncryption}
991 chapter of this manual.
993 If you get errors linking, you need to load the development libraries,
994 or you need to disable SSL by setting without-openssl.
997 \item [ {-}{\-}with-python=\lt{}path\gt{}]
998 \index[general]{{-}{\-}with-python}
999 This option enables Bacula support for Python. If no path is supplied,
1000 configure will search the standard library locations for Python 2.2,
1001 2.3, 2.4, or 2.5. If it cannot find the library, you will need to
1002 supply a path to your Python library directory. Please see the
1003 \borgxrlink{Python Scripting}{PythonChapter}{misc}{chapter} of the \miscman{} for the details of using Python
1006 \item [ {-}{\-}with-libintl-prefix=\lt{}DIR\gt{}]
1007 \index[general]{{-}{\-}with-libintl-prefix}
1008 This option may be used to tell Bacula to search DIR/include and
1009 DIR/lib for the libintl headers and libraries needed for Native
1010 Language Support (NLS).
1012 \item [ {-}{\-}enable-conio]
1013 \index[general]{{-}{\-}enable-conio}
1014 Tells Bacula to enable building the small, light weight readline
1015 replacement routine. It is generally much easier to configure than
1016 readline, although, like readline, it needs either the termcap or
1019 \item [ {-}{\-}with-readline=\lt{}readline-path\gt{}]
1020 \index[general]{{-}{\-}with-readline}
1021 Tells Bacula where {\bf readline} is installed. Normally, Bacula will
1022 find readline if it is in a standard library. If it is not found and no
1023 {-}{\-}with-readline is specified, readline will be disabled. This
1024 option affects the Bacula build. Readline provides the Console program
1025 with a command line history and editing capability and is no longer
1026 supported, so you are on your own if you have problems.
1028 \item [ {-}{\-}enable-readline]
1029 \index[general]{{-}{\-}enable-readline}
1030 Tells Bacula to enable readline support. It is normally disabled due to the
1031 large number of configuration problems and the fact that the package seems to
1032 change in incompatible ways from version to version.
1034 \item [ {-}{\-}with-tcp-wrappers=\lt{}path\gt{}]
1035 \index[general]{{-}{\-}with-tcp-wrappers}
1036 \index[general]{TCP Wrappers}
1037 \index[general]{Wrappers!TCP}
1038 \index[general]{libwrappers}
1039 This specifies that you want TCP wrappers (man hosts\_access(5)) compiled in.
1040 The path is optional since Bacula will normally find the libraries in the
1041 standard locations. This option affects the Bacula build. In specifying your
1042 restrictions in the {\bf /etc/hosts.allow} or {\bf /etc/hosts.deny} files, do
1043 not use the {\bf twist} option (hosts\_options(5)) or the Bacula process will
1044 be terminated. Note, when setting up your {\bf /etc/hosts.allow}
1045 or {\bf /etc/hosts.deny}, you must identify the Bacula daemon in
1046 question with the name you give it in your conf file rather than the
1047 name of the executable.
1049 For more information on configuring and testing TCP wrappers, please see the
1050 \ilink{Configuring and Testing TCP Wrappers}{wrappers} section
1051 in the Security Chapter.
1053 On SuSE, the libwrappers libraries needed to link Bacula are
1054 contained in the tcpd-devel package. On Red Hat, the package is named
1057 \item [ {-}{\-}with-archivedir=\lt{}path\gt{} ]
1058 \index[general]{{-}{\-}with-archivedir}
1059 The directory used for disk-based backups. Default value is /tmp.
1060 This parameter sets the default values in the bacula-dir.conf and bacula-sd.conf
1061 configuration files. For example, it sets the Where directive for the
1062 default restore job and the Archive Device directive for the FileStorage
1065 This option is designed primarily for use in regression testing.
1066 Most users can safely ignore this option.
1068 \item [ {-}{\-}with-working-dir=\lt{}working-directory-path\gt{} ]
1069 \index[general]{{-}{\-}with-working-dir}
1070 This option is mandatory and specifies a directory into which Bacula may
1071 safely place files that will remain between Bacula executions. For example,
1072 if the internal database is used, Bacula will keep those files in this
1073 directory. This option is only used to modify the daemon configuration
1074 files. You may also accomplish the same thing by directly editing them later.
1075 The working directory is not automatically created by the install process, so
1076 you must ensure that it exists before using Bacula for the first time.
1078 \item [ {-}{\-}with-baseport=\lt{}port=number\gt{}]
1079 \index[general]{{-}{\-}with-baseport}
1080 In order to run, Bacula needs three TCP/IP ports (one for the Bacula
1081 Console, one for the Storage daemon, and one for the File daemon). The {\bf
1082 \verb:--:with-baseport} option will automatically assign three ports beginning at
1083 the base port address specified. You may also change the port number in the
1084 resulting configuration files. However, you need to take care that the
1085 numbers correspond correctly in each of the three daemon configuration
1086 files. The default base port is 9101, which assigns ports 9101 through 9103.
1087 These ports (9101, 9102, and 9103) have been officially assigned to Bacula by
1088 IANA. This option is only used to modify the daemon configuration files. You
1089 may also accomplish the same thing by directly editing them later.
1091 \item [ {-}{\-}with-dump-email=\lt{}email-address\gt{}]
1092 \index[general]{{-}{\-}with-dump-email}
1093 This option specifies the email address where any core dumps should be set.
1094 This option is normally only used by developers.
1096 \item [ {-}{\-}with-pid-dir=\lt{}PATH\gt{} ]
1097 \index[general]{{-}{\-}with-pid-dir}
1098 This specifies where Bacula should place the process id file during
1099 execution. The default is: {\bf /var/run}. This directory is not created by
1100 the install process, so you must ensure that it exists before using Bacula
1103 \item [ {-}{\-}with-subsys-dir=\lt{}PATH\gt{}]
1104 \index[general]{{-}{\-}with-subsys-dir}
1105 This specifies where Bacula should place the subsystem lock file during
1106 execution. The default is {\bf /var/run/subsys}. Please make sure that you do
1107 not specify the same directory for this directory and for the {\bf sbindir}
1108 directory. This directory is used only within the autostart scripts. The
1109 subsys directory is not created by the Bacula install, so you must be sure to
1110 create it before using Bacula.
1112 \item [ {-}{\-}with-dir-password=\lt{}Password\gt{}]
1113 \index[general]{{-}{\-}with-dir-password}
1114 This option allows you to specify the password used to access the Director
1115 (normally from the Console program). If it is not specified, configure will
1116 automatically create a random password.
1118 \item [ {-}{\-}with-fd-password=\lt{}Password\gt{} ]
1119 \index[general]{{-}{\-}with-fd-password}
1120 This option allows you to specify the password used to access the File daemon
1121 (normally called from the Director). If it is not specified, configure will
1122 automatically create a random password.
1124 \item [ {-}{\-}with-sd-password=\lt{}Password\gt{} ]
1125 \index[general]{{-}{\-}with-sd-password}
1126 This option allows you to specify the password used to access the Storage daemon
1127 (normally called from the Director). If it is not specified, configure will
1128 automatically create a random password.
1130 \item [ {-}{\-}with-dir-user=\lt{}User\gt{} ]
1131 \index[general]{{-}{\-}with-dir-user}
1132 This option allows you to specify the Userid used to run the Director. The
1133 Director must be started as root, but doesn't need to run as root, and
1134 after doing preliminary initializations, it can "drop" to the UserId
1135 specified on this option.
1136 If you specify this option, you must
1137 create the User prior to running {\bf make install}, because the
1138 working directory owner will be set to {\bf User}.
1140 \item [ {-}{\-}with-dir-group=\lt{}Group\gt{} ]
1141 \index[general]{{-}{\-}with-dir-group}
1142 This option allows you to specify the GroupId used to run the Director. The
1143 Director must be started as root, but doesn't need to run as root, and after
1144 doing preliminary initializations, it can "drop" to the GroupId specified
1146 If you specify this option, you must
1147 create the Group prior to running {\bf make install}, because the
1148 working directory group will be set to {\bf Group}.
1150 \item [ {-}{\-}with-sd-user=\lt{}User\gt{} ]
1151 \index[general]{{-}{\-}with-sd-user}
1152 This option allows you to specify the Userid used to run the Storage daemon.
1153 The Storage daemon must be started as root, but doesn't need to run as root,
1154 and after doing preliminary initializations, it can "drop" to the UserId
1155 specified on this option. If you use this option, you will need to take care
1156 that the Storage daemon has access to all the devices (tape drives, ...) that
1159 \item [ {-}{\-}with-sd-group=\lt{}Group\gt{} ]
1160 \index[general]{{-}{\-}with-sd-group}
1161 This option allows you to specify the GroupId used to run the Storage daemon.
1162 The Storage daemon must be started as root, but doesn't need to run as root,
1163 and after doing preliminary initializations, it can "drop" to the GroupId
1164 specified on this option.
1166 \item [ {-}{\-}with-fd-user=\lt{}User\gt{} ]
1167 \index[general]{{-}{\-}with-fd-user}
1168 This option allows you to specify the Userid used to run the File daemon. The
1169 File daemon must be started as root, and in most cases, it needs to run as
1170 root, so this option is used only in very special cases, after doing
1171 preliminary initializations, it can "drop" to the UserId specified on this
1174 \item [ {-}{\-}with-fd-group=\lt{}Group\gt{} ]
1175 \index[general]{{-}{\-}with-fd-group}
1176 This option allows you to specify the GroupId used to run the File daemon.
1177 The File daemon must be started as root, and in most cases, it must be run as
1178 root, however, after doing preliminary initializations, it can "drop" to
1179 the GroupId specified on this option.
1181 \item [ {-}{\-}with-mon-dir-password=\lt{}Password\gt{}]
1182 \index[general]{{-}{\-}with-mon-dir-password}
1183 This option allows you to specify the password used to access the Directory
1184 from the monitor. If it is not specified, configure will
1185 automatically create a random password.
1187 \item [ {-}{\-}with-mon-fd-password=\lt{}Password\gt{} ]
1188 \index[general]{{-}{\-}with-mon-fd-password}
1189 This option allows you to specify the password used to access the File daemon
1190 from the Monitor. If it is not specified, configure will
1191 automatically create a random password.
1193 \item [ {-}{\-}with-mon-sd-password=\lt{}Password\gt{} ]
1194 \index[general]{{-}{\-}with-mon-sd-password}
1195 This option allows you to specify the password used to access the
1196 Storage daemon from the Monitor. If it is not specified, configure will
1197 automatically create a random password.
1199 \item [ {-}{\-}with-db-name=\lt{}database-name\gt{} ]
1200 \index[general]{{-}{\-}with-db-name}
1201 This option allows you to specify the database name to be used in
1202 the conf files. The default is bacula.
1204 \item [ {-}{\-}with-db-user=\lt{}database-user\gt{} ]
1205 \index[general]{{-}{\-}with-db-user}
1206 This option allows you to specify the database user name to be used in
1207 the conf files. The default is bacula.
1211 Note, many other options are presented when you do a {\bf ./configure
1212 \verb:--:help}, but they are not implemented.
1214 \section{Recommended Options for Most Systems}
1215 \index[general]{Systems!Recommended Options for Most}
1216 \index[general]{Recommended Options for Most Systems}
1218 For most systems, we recommend starting with the following options:
1223 --enable-smartalloc \
1224 --sbindir=/opt/bacula/bin \
1225 --sysconfdir=/opt/bacula/etc \
1226 --with-pid-dir=/opt/bacula/working \
1227 --with-subsys-dir=/opt/bacula/working \
1228 --with-working-dir=/opt/bacula/working
1232 If you want to install Bacula in an installation directory rather than run it
1233 out of the build directory (as developers will do most of the time), you
1234 should also include the \verb:--:sbindir and \verb:--:sysconfdir options with appropriate
1235 paths. Neither are necessary if you do not use "make install" as is the case
1236 for most development work. The install process will create the sbindir and
1237 sysconfdir if they do not exist, but it will not automatically create the
1238 pid-dir, subsys-dir, or working-dir, so you must ensure that they exist before
1239 running Bacula for the first time.
1242 \index[general]{Red Hat}
1249 CFLAGS="-g -Wall" ./configure \
1250 --sbindir=/opt/bacula/bin \
1251 --sysconfdir=/opt/bacula/etc \
1252 --enable-smartalloc \
1254 --with-working-dir=/opt/bacula/working
1255 --with-pid-dir=/opt/bacula/working \
1256 --with-subsys-dir=/opt/bacula/working
1261 or finally, a completely traditional Red Hat Linux install,
1262 which we do not recommend, because it make it harder to
1263 backup Bacula for disaster recovery purposes:
1267 CFLAGS="-g -Wall" ./configure \
1268 --sbindir=/usr/sbin \
1269 --sysconfdir=/etc/bacula \
1270 --with-scriptdir=/etc/bacula \
1271 --enable-smartalloc \
1274 --with-working-dir=/var/bacula \
1275 --with-pid-dir=/var/run \
1280 Note, Bacula assumes that /var/bacula, /var/run, and /var/lock/subsys exist so
1281 it will not automatically create them during the install process.
1284 \index[general]{Solaris}
1286 To build Bacula from source, you will need the following installed on your
1287 system (they are not by default): libiconv, gcc 3.3.2, stdc++, libgcc (for
1288 stdc++ and gcc\_s libraries), make 3.8 or later.
1290 You will probably also need to: Add /usr/local/bin to PATH and Add
1291 /usr/ccs/bin to PATH for ar.
1293 It is possible to build Bacula on Solaris with the Solaris compiler, but
1294 we recommend using GNU C++ if possible.
1296 A typical configuration command might look like:
1301 CFLAGS="-g" ./configure \
1302 --sbindir=/opt/bacula/bin \
1303 --sysconfdir=/opt/bacula/etc \
1305 --enable-smartalloc \
1306 --with-pid-dir=/opt/bacula/working \
1307 --with-subsys-dir=/opt/bacula/working \
1308 --with-working-dir=/opt/bacula/working
1312 Note, you may need to install the following packages to build Bacula
1333 PATH=/usr/bin::/usr/ccs/bin:/etc:/usr/openwin/bin:/usr/local/bin:/usr/sfw/bin:/opt/sfw/bin:/usr/ucb:/usr/sbin
1337 If you have installed special software not normally in the Solaris
1338 libraries, such as OpenSSL, or the packages shown above, then you may need
1339 to add {\bf /usr/sfw/lib} to the library search path. Probably the
1340 simplest way to do so is to run:
1344 setenv LDFLAGS "-L/usr/sfw/lib -R/usr/sfw/lib"
1348 Prior to running the ./configure command.
1350 Alternatively, you can set the LD\_LIBARY\_PATH and/or the LD\_RUN\_PATH
1351 environment variables appropriately.
1353 It is also possible to use the {\bf crle} program to set the library
1354 search path. However, this should be used with caution.
1357 \index[general]{FreeBSD}
1360 \elink{The FreeBSD Diary}{http://www.freebsddiary.org/bacula.php} for a
1361 detailed description on how to make Bacula work on your system. In addition,
1362 users of FreeBSD prior to 4.9-STABLE dated Mon Dec 29 15:18:01 2003 UTC who
1363 plan to use tape devices, please see the
1364 \borgxrlink{Tape Testing}{FreeBSDTapes}{problems}{chapter} of the \problemsman{} for
1365 {\bf important} information on how to configure your tape drive for
1366 compatibility with Bacula.
1368 If you are using Bacula with MySQL, you should take care to compile MySQL with
1369 FreeBSD native threads rather than LinuxThreads, since Bacula is normally built
1370 with FreeBSD native threads rather than LinuxTreads. Mixing the two will
1374 \index[general]{Win32}
1376 To install the binary Win32 version of the File daemon please see the
1377 \ilink{Win32 Installation Chapter}{Win32Chapter} in this document.
1379 \section{One File Configure Script}
1380 \index[general]{Script!One File Configure}
1381 \index[general]{One Files Configure Script}
1383 The following script could be used if you want to put everything
1384 in a single directory (except for the working directory):
1391 --sbindir=$HOME/bacula/bin \
1392 --sysconfdir=$HOME/bacula/bin \
1393 --mandir=$HOME/bacula/bin \
1394 --enable-smartalloc \
1396 --with-pid-dir=$HOME/bacula/bin/working \
1397 --with-subsys-dir=$HOME/bacula/bin/working \
1399 --with-working-dir=$HOME/bacula/bin/working \
1400 --with-dump-email=$USER@your-site.com \
1401 --with-job-email=$USER@your-site.com \
1402 --with-smtp-host=mail.your-site.com
1407 You may also want to put the following entries in your {\bf /etc/services}
1408 file as it will make viewing the connections made by Bacula easier to
1409 recognize (i.e. netstat -a):
1419 \section{Installing Bacula}
1420 \index[general]{Bacula!Installing}
1421 \index[general]{Installing Bacula}
1423 Before setting up your configuration files, you will want to install Bacula in
1424 its final location. Simply enter:
1432 If you have previously installed Bacula, the old binaries will be overwritten,
1433 but the old configuration files will remain unchanged, and the "new"
1434 configuration files will be appended with a {\bf .new}. Generally if you have
1435 previously installed and run Bacula you will want to discard or ignore the
1436 configuration files with the appended {\bf .new}.
1438 \section{Building a File Daemon or Client}
1439 \index[general]{Client!Building a File Daemon or}
1440 \index[general]{Building a File Daemon or Client}
1442 If you run the Director and the Storage daemon on one machine and you wish to
1443 back up another machine, you must have a copy of the File daemon for that
1444 machine. If the machine and the Operating System are identical, you can simply
1445 copy the Bacula File daemon binary file {\bf bacula-fd} as well as its
1446 configuration file {\bf bacula-fd.conf} then modify the name and password in
1447 the conf file to be unique. Be sure to make corresponding additions to the
1448 Director's configuration file ({\bf bacula-dir.conf}).
1450 If the architecture or the OS level are different, you will need to build a
1451 File daemon on the Client machine. To do so, you can use the same {\bf
1452 ./configure} command as you did for your main program, starting either from a
1453 fresh copy of the source tree, or using {\bf make\ distclean} before the {\bf
1456 Since the File daemon does not access the Catalog database, you can remove
1457 the {\bf \verb:--:with-mysql} ption, then
1458 add {\bf \verb:--:enable-client-only}. This will compile only the
1459 necessary libraries and the client programs and thus avoids the necessity
1460 of installing one or another of those database programs to build the File
1461 daemon. With the above option, you simply enter {\bf make} and just the
1462 client will be built.
1465 \section{Auto Starting the Daemons}
1466 \index[general]{Daemons!Auto Starting the}
1467 \index[general]{Auto Starting the Daemons}
1469 If you wish the daemons to be automatically started and stopped when your
1470 system is booted (a good idea), one more step is necessary. First, the
1471 ./configure process must recognize your system -- that is it must be a
1472 supported platform and not {\bf unknown}, then you must install the platform
1473 dependent files by doing:
1478 make install-autostart
1482 Please note, that the auto-start feature is implemented only on systems
1483 that we officially support (currently, FreeBSD, Red Hat/Fedora Linux, and
1484 Solaris), and has only been fully tested on Fedora Linux.
1486 The {\bf make install-autostart} will cause the appropriate startup scripts
1487 to be installed with the necessary symbolic links. On Red Hat/Fedora Linux
1488 systems, these scripts reside in {\bf /etc/rc.d/init.d/bacula-dir} {\bf
1489 /etc/rc.d/init.d/bacula-fd}, and {\bf /etc/rc.d/init.d/bacula-sd}. However
1490 the exact location depends on what operating system you are using.
1492 If you only wish to install the File daemon, you may do so with:
1496 make install-autostart-fd
1500 \section{Other Make Notes}
1501 \index[general]{Notes!Other Make}
1502 \index[general]{Other Make Notes}
1504 To simply build a new executable in any directory, enter:
1512 To clean out all the objects and binaries (including the files named 1, 2, or
1513 3, which are development temporary files), enter:
1521 To really clean out everything for distribution, enter:
1529 note, this cleans out the Makefiles and is normally done from the top level
1530 directory to prepare for distribution of the source. To recover from this
1531 state, you must redo the {\bf ./configure} in the top level directory, since
1532 all the Makefiles will be deleted.
1534 To add a new file in a subdirectory, edit the Makefile.in in that directory,
1535 then simply do a {\bf make}. In most cases, the make will rebuild the Makefile
1536 from the new Makefile.in. In some case, you may need to issue the {\bf make} a
1537 second time. In extreme cases, cd to the top level directory and enter: {\bf
1540 To add dependencies:
1548 The {\bf make depend} appends the header file dependencies for each of the
1549 object files to Makefile and Makefile.in. This command should be done in each
1550 directory where you change the dependencies. Normally, it only needs to be run
1551 when you add or delete source or header files. {\bf make depend} is normally
1552 automatically invoked during the configuration process.
1562 This not normally done if you are developing Bacula, but is used if you are
1563 going to run it to backup your system.
1565 After doing a {\bf make install} the following files will be installed on your
1566 system (more or less). The exact files and location (directory) for each file
1567 depends on your {\bf ./configure} command.
1569 NOTE: it is quite probable that this list is out of date. But it is a
1589 create_mysql_database
1591 delete_catalog_backup
1610 \section{Modifying the Bacula Configuration Files}
1611 \index[general]{Modifying the Bacula Configuration Files}
1612 \index[general]{Files!Modifying the Bacula Configuration}
1615 \ilink{Configuring Bacula}{ConfigureChapter} in this manual for
1616 instructions on how to set Bacula configuration files.