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 properly depending on the
13 options you specify. Normally, {\bf MySQL} and {\bf PostgreSQL} are
14 packages that can be installed on your distribution. However, if you do
15 not have them, to simplify your task, we have combined a number of these
16 packages into two {\bf depkgs} releases (Dependency Packages). This can
17 vastly simplify your life by providing you with all the necessary packages
18 rather than requiring you to find them on the Web, load them, and install
21 \section{Source Release Files}
22 \index[general]{Source Files}
23 \index[general]{Release Files}
24 Beginning with Bacula 1.38.0, the source code has been broken into
25 four separate tar files each corresponding to a different module in
26 the Bacula CVS. The released files are:
29 \item [bacula-1.38.0.tar.gz]
30 This is the primary source code release for Bacula. On each
31 release the version number (1.38.0) will be updated.
33 \item [bacula-docs-1.38.0.tar.gz]
34 This file contains a copy of the docs directory with the
35 documents prebuild. English HTML directory, single HTML
36 file, and pdf file. The French and German translations
37 are in progress, but are not built.
39 \item [bacula-gui-1.38.0.tar.gz]
40 This file contains the non-core GUI programs. Currently,
41 it contains bacula-web, a PHP program for producing management
42 viewing of your Bacula job status in a browser; and bimagemgr
43 a browser program for burning CDROM images with Bacula Volumes.
45 \item [bacula-rescue-1.8.1.tar.gz]
46 This is the Bacula Rescue CDROM code. Note, the version number
47 of this package is not tied to the Bacula release version, so
48 it will be different. Using this code, you can burn a CDROM
49 with your system configuration and containing a statically
50 linked version of the File daemon. This can permit you to easily
51 repartition and reformat your hard disks and reload your
52 system with Bacula in the case of a hard disk failure.
54 \item [winbacula-1.38.0.exe]
55 This file is the 32 bit Windows installer for installing
56 the Windows client (File daemon) on a Windows machine.
57 Beginning with Bacula version 1.39.20, this executable will
58 also load the Win32 Director and the Win32 Storage daemon.
63 \section{Upgrading Bacula}
64 \index[general]{Bacula!Upgrading}
65 \index[general]{Upgrading Bacula}
67 If you are upgrading from one Bacula version to another, you should first
68 carefully read the ReleaseNotes of all versions between your current
69 version and the version to which you are upgrading. If the Bacula catalog
70 database has been upgraded (as it is almost every major release), you will
71 either need to reinitialize your database starting from scratch (not
72 normally a good idea), or save an ASCII copy of your database, then proceed
73 to upgrade it. This is normally done after Bacula is build and installed
77 cd <installed-scripts-dir> (default /etc/bacula)
78 ./update_bacula_tables
81 This update script can also be find in the Bacula source src/cats
84 If there are several database upgrades between your version and the
85 version to which you are upgrading, you will need to apply each database
86 upgrade script. For your convenience, you can find all the old upgrade scripts
87 in the {\bf upgradedb} directory of the source code. You will need to edit the
88 scripts to correspond to your system configuration. The final upgrade script,
89 if any, can be applied as noted above.
91 If you are upgrading from one major version to another, you will need to
92 replace all your components at the same time as generally the inter-daemon
93 protocol will change. However, within any particular release (e.g. version
94 1.32.x) unless there is an oversight or bug, the daemon protocol will not
95 change. If this is confusing, simply read the ReleaseNotes very carefully as
96 they will note if all daemons must be upgraded at the same time.
98 Finally, please note that in general it is not necessary to do a
99 {\bf make uninstall} before doing an upgrade. In fact, if you do so, you will
100 most likely delete all your conf files, which could be disastrous.
101 The normal procedure during an upgrade is simply:
104 ./configure (your options)
109 In general none of your existing .conf or .sql files will be overwritten,
110 and you must do both the {\bf make} and {\bf make install} commands, a
111 {\bf make install} without the preceding {\bf make} will not work.
113 For additional information on upgrading, please see the \ilink{Upgrading Bacula
114 Versions}{upgrading} in the Tips chapter of this manual.
116 \section{Releases Numbering}
117 \index[general]{Release Numbering}
118 \index[general]{Version Numbering}
119 Every Bacula release whether beta or production has a different number
120 as well as the date of the release build. The numbering system follows
121 traditional Open Source conventions in that it is of the form.
132 where each component (major, minor, patch) is a number.
133 The major number is currently 1 and normally does not change
134 very frequently. The minor number starts at 0 and increases
135 each for each production release by 2 (i.e. it is always an
136 even number for a production release), and the patch number is
137 starts at zero each time the minor number changes. The patch
138 number is increased each time a bug fix (or fixes) is released
141 So, as of this date (10 September 2006), the current production Bacula
142 release is version 1.38.11. If there are bug fixes, the next release
143 will be 1.38.12 (i.e. the patch number has increased by one).
145 For all patch releases where the minor version number does not change,
146 the database and all the daemons will be compatible. That means that
147 you can safely run a 1.38.0 Director with a 1.38.11 Client. Of course,
148 in this case, the Director may have bugs that are not fixed. Generally,
149 within a minor release (some minor releases are not so minor), all
150 patch numbers are officially released to production. This means that while
151 the current Bacula version is 1.38.11, versions 1.38.0, 1.38.1, ... 1.38.10
152 have all been previously released.
154 When the minor number is odd, it indicates that the package is under
155 development and thus may not be stable. For example, while the current
156 production release of Bacula is currently 1.38.11, the current development
157 version is 1.39.22. All patch versions of the development code are
158 available in the CVS (source repository). However, not all patch versions
159 of the development code (odd minor version) are officially released. When
160 they are released, they are released as beta versions (see below for a
161 definition of what beta means for Bacula releases).
163 In general when the minor number increases from one production release
164 to the next (i.e. 1.38.x to 1.40.0), the catalog database must be upgraded,
165 the Director and Storage daemon must always be on the same minor release
166 number, and often (not always), the Clients must also be on the same minor
167 release. As often as possible, we attempt to make new releases that are
168 downwards compatible with prior clients, but this is not always possible.
169 You must check the release notes. In general, you will have fewer problems
170 if you always run all the components on the same minor version number (i.e.
171 all either 1.38.x or 1.40.x but not mixed).
174 \section{Beta Releases}
175 \index[general]{Beta Releases}
176 Towards the end of the development cycle, which typically runs
177 one year from a major release to another, there will be several beta
178 releases of the development code prior to a production release.
179 As noted above, beta versions always have odd minor version numbers
180 (e.g 1.37.x or 1.39.x).
181 The purpose of the beta releases is to allow early adopter users to test
182 the new code. Beta releases are made with the following considerations:
185 \item The code passes the regression testing on Linux,
186 FreeBSD, and Solaris machines. Including tape drive testing
187 on Linux and FreeBSD (not currently on Solaris).
188 \item There are no known major bugs, or on the rare occasion that
189 there are, they will be documented.
190 \item Some of the new code/features may not yet be tested.
191 \item Bugs are expected to be found, especially in the new
192 code before the final production release.
193 \item The code will have been run in production in at least one small
195 \item The Win32 client will have been run in production at least
196 one night at that small site.
197 \item The documentation in the manual is unlikely to be complete especially
198 for the new features, and the Release Notes may not be fully
200 \item Beta code is not generally recommended for everyone, but
201 rather for early adopters.
206 \section{Dependency Packages}
207 \index[general]{Dependency Packages}
208 \index[general]{Packages!Dependency}
210 As discussed above, we have combined a number of third party packages that
211 Bacula might need into the {\bf depkgs} release. You can,
212 of course, get the latest packages from the original authors or
213 from your operating system supplier. The locations of
214 where we obtained the packages are in the README file in each package.
215 However, be aware that the packages in the depkgs files have been tested by us
216 for compatibility with Bacula.
218 Typically, a dependency package will be named {\bf depkgs-ddMMMyy.tar.gz}
219 where {\bf dd} is the day we release it, {\bf MMM}
220 is the abbreviated month (e.g. Jan), and {\bf yy} is the year. An actual
221 example is: {\bf depkgs-07Apr02.tar.gz}. To install and build this package (if
222 needed), you do the following:
225 \item Create a {\bf bacula} directory, into which you will place both the
226 Bacula source as well as the dependency package.
227 \item Detar the {\bf depkg} into the {\bf bacula} directory.
228 \item cd bacula/depkgs
232 Although the exact composition of the dependency packages may change from time
233 to time, the current makeup is the following:
235 \addcontentsline{lot}{table}{Dependency Packages}
236 \begin{longtable}{|l|l|}
238 \multicolumn{1}{|c| }{\bf 3rd Party Package} & \multicolumn{1}{c| }{\bf depkgs} \\
239 \hline {SQLite } & \multicolumn{1}{c| }{X } \\
240 \hline {SQLite3 } & \multicolumn{1}{c| }{X } \\
241 \hline {mtx } & \multicolumn{1}{c| }{X } \\
245 Note, some of these packages are quite large, so that building them can be a
246 bit time consuming. The above instructions will build all the packages
247 contained in the directory. However, when building Bacula, it will take only
248 those pieces that it actually needs.
250 Alternatively, you can make just the packages that are needed. For example,
259 will configure and build only the SQLite package.
261 You should build the packages that you will require in {\bf depkgs} a
262 prior to configuring and building Bacula, since Bacula will need
263 them during the build process.
265 Even if you do not use SQLite, you might find it worthwhile to build {\bf mtx}
266 because the {\bf tapeinfo} program that comes with it can often provide you
267 with valuable information about your SCSI tape drive (e.g. compression,
268 min/max block sizes, ...). Note, most distros provide {\bf mtx} as part of
271 The {\bf depkgs1} package is depreciated and previously contained
272 readline, which should be available on all operating systems.
274 The {\bf depkgs-win32} package is deprecated and no longer used in
275 Bacula version 1.39.x and later. It was previously used to build
276 the native Win32 client program, but this program is now built on Linux
277 systems using cross-compiling. All the tools and third party libraries
278 are automatically downloaded by executing the appropriate scripts. See
279 src/win32/README.mingw32 for more details.
281 \section{Supported Operating Systems}
283 \index[general]{Systems!Supported Operating}
284 \index[general]{Supported Operating Systems}
287 \ilink{ Supported Operating Systems}{SupportedOSes} section
288 of the QuickStart chapter of this manual.
290 \section{Building Bacula from Source}
292 \index[general]{Source!Building Bacula from}
293 \index[general]{Building Bacula from Source}
295 The basic installation is rather simple.
298 \item Install and build any {\bf depkgs} as noted above. This
299 should be unnecessary on most modern Operating Systems.
300 \item Configure and install MySQL or PostgreSQL (if desired).
301 \ilink{Installing and Configuring MySQL Phase I}{MySqlChapter} or
302 \ilink{Installing and Configuring PostgreSQL Phase
303 I}{PostgreSqlChapter}. If you are installing from rpms, and are
304 using MySQL, please be sure to install {\bf mysql-devel}, so that the MySQL
305 header files are available while compiling Bacula. In addition, the MySQL
306 client library {\bf mysqlclient} requires the gzip compression library {\bf
307 libz.a} or {\bf libz.so}. If you are using rpm packages, these libraries are
308 in the {\bf libz-devel} package. On Debian systems, you will need to load the
309 {\bf zlib1g-dev} package. If you are not using rpms or debs, you will need to
310 find the appropriate package for your system.
312 Note, if you already have a running MySQL or PostgreSQL on your system, you
313 can skip this phase provided that you have built the thread safe libraries.
314 And you have already installed the additional rpms noted above.
316 \item As an alternative to MySQL and PostgreSQL, configure and install SQLite,
317 which is part of the {\bf depkgs} and also available with most modern
319 \ilink{Installing and Configuring SQLite}{SqlLiteChapter}. SQLite is
320 probably not suited to a fair size production environment because it
321 tends to be slow compared to MySQL and it has few or poor tools for
322 repairing database damage.
324 \item Detar the Bacula source code preferably into the {\bf bacula} directory
327 \item {\bf cd} to the directory containing the source code.
329 \item ./configure (with appropriate options as described below)
331 \item Check the output of ./configure very carefully, especially the Install
332 binaries and Install config directories. If they are not correct,
333 please rerun ./configure until they are. The output from ./configure is
334 stored in {\bf config.out} and can be re-displayed at any time without
335 rerunning the ./configure by doing {\bf cat config.out}.
337 \item If after running ./configure once, you decide to change options and
338 re-run it, that is perfectly fine, but before re-running it, you should run:
347 so that you are sure to start from scratch and not have a mixture of the two
348 options. This is because ./configure caches much of the information. The {\bf
349 make distclean} is also critical if you move the source directory from one
350 machine to another. If the {\bf make distclean} fails, just ignore it and
357 If you get errors while linking in the Storage daemon directory
358 (src/stored), it is probably because you have not loaded the static
359 libraries on your system. I noticed this problem on a Solaris system.
360 To correct it, make sure that you have not added {\bf
361 {-}{-}enable-static-tools} to the {\bf ./configure} command.
363 If you skip this step ({\bf make}) and proceed immediately to the {\bf
364 make install} you are making two serious errors: 1. your install will
365 fail because Bacula requires a {\bf make} before a {\bf make install}.
366 2. you are depriving yourself of the chance to make sure there are no
367 errors before beginning to write files to your system directories.
371 Please be sure you have done a {\bf make} before entering this command,
372 and that everything has properly compiled and linked without errors.
375 \item If you are new to Bacula, we {\bf strongly} recommend that you skip
376 the next step and use the default configuration files, then run the
377 example program in the next chapter, then come back and modify your
378 configuration files to suit your particular needs.
380 \item Customize the configuration files for each of the three daemons
381 (Directory, File, Storage) and for the Console program. For the details
382 of how to do this, please see \ilink{Setting Up Bacula Configuration
383 Files}{ConfigureChapter} in the Configuration chapter of this manual. We
384 recommend that you start by modifying the default configuration files
385 supplied, making the minimum changes necessary. Complete customization
386 can be done after you have Bacula up and running. Please take care when
387 modifying passwords, which were randomly generated, and the {\bf Name}s
388 as the passwords and names must agree between the configuration files
389 for security reasons.
391 \item Create the Bacula MySQL database and tables
393 \ilink{Installing and Configuring MySQL Phase II}{mysql_phase2} or
394 create the Bacula PostgreSQL database and tables
395 \ilink{Configuring PostgreSQL
396 II}{PostgreSQL_configure} or alternatively if you are using
398 \ilink{Installing and Configuring SQLite Phase II}{phase2}.
400 \item Start Bacula ({\bf ./bacula start}) Note. the next chapter shows you
401 how to do this in detail.
403 \item Interface with Bacula using the Console program
405 \item For the previous two items, please follow the instructions in the
406 \ilink{Running Bacula}{TutorialChapter} chapter of this manual,
407 where you will run a simple backup and do a restore. Do this before you make
408 heavy modifications to the configuration files so that you are sure that
409 Bacula works and are familiar with it. After that changing the conf files
412 \item If after installing Bacula, you decide to "move it", that is to
413 install it in a different set of directories, proceed as follows:
419 ./configure (your-new-options)
428 If all goes well, the {\bf ./configure} will correctly determine which
429 operating system you are running and configure the source code appropriately.
430 Currently, FreeBSD, Linux (Red Hat), and Solaris are supported. The Bacula
431 client (File daemon) is reported to work with MacOS X 10.3 is if
432 readline support is not enabled (default) when building the client.
434 If you install Bacula on more than one system, and they are identical, you can
435 simply transfer the source tree to that other system and do a "make
436 install". However, if there are differences in the libraries or OS versions,
437 or you wish to install on a different OS, you should start from the original
438 compress tar file. If you do transfer the source tree, and you have previously
439 done a ./configure command, you MUST do:
447 prior to doing your new ./configure. This is because the GNU autoconf tools
448 cache the configuration, and if you re-use a configuration for a Linux machine
449 on a Solaris, you can be sure your build will fail. To avoid this, as
450 mentioned above, either start from the tar file, or do a "make distclean".
452 In general, you will probably want to supply a more complicated {\bf
453 configure} statement to ensure that the modules you want are built and that
454 everything is placed into the correct directories.
456 For example, on Fedora, Red Hat, or SuSE one could use the following:
462 --sbindir=$HOME/bacula/bin \
463 --sysconfdir=$HOME/bacula/bin \
464 --with-pid-dir=$HOME/bacula/bin/working \
465 --with-subsys-dir=$HOME/bacula/bin/working \
467 --with-working-dir=$HOME/bacula/bin/working \
468 --with-dump-email=$USER
472 Note, the advantage of using the above configuration to start is that
473 everything will be put into a single directory, which you can later delete
474 once you have run the examples in the next chapter and learned how Bacula
475 works. In addition, the above can be installed and run as non-root.
477 For the developer's convenience, I have added a {\bf defaultconfig} script to
478 the {\bf examples} directory. This script contains the statements that you
479 would normally use, and each developer/user may modify them to suit his needs.
480 You should find additional useful examples in this directory as well.
482 The {\bf \verb:--:enable-conio} or {\bf \verb:--:enable-readline} options are useful because
483 they provide a command line history and editing capability for the Console
484 program. If you have included either option in the build, either the {\bf
485 termcap} or the {\bf ncurses} package will be needed to link. On most
486 systems, including Red Hat and SuSE, you should include the ncurses package.
487 If Bacula's configure process finds the ncurses libraries, it will use
488 those rather than the termcap library.
489 On some systems, such as SuSE, the termcap library is not in the standard
490 library directory. As a consequence, the option may be disabled or you may
491 get an error message such as:
495 /usr/lib/gcc-lib/i586-suse-linux/3.3.1/.../ld:
496 cannot find -ltermcap
497 collect2: ld returned 1 exit status
501 while building the Bacula Console. In that case, you will need to set the {\bf
502 LDFLAGS} environment variable prior to building.
506 export LDFLAGS="-L/usr/lib/termcap"
510 The same library requirements apply if you wish to use the readline
511 subroutines for command line editing and history or
512 if you are using a MySQL library that requires encryption. If you need encryption,
513 you can either export the appropriate additional library options as shown
514 above or, alternatively, you can include them directly on the ./configure line
519 LDFLAGS="-lssl -lcyrpto" \
520 ./configure <your-options>
524 On some systems such as Mandriva, readline tends to
525 gobble up prompts, which makes it totally useless. If this happens to you, use
526 the disable option, or if you are using version 1.33 and above try using {\bf
527 \verb:--:enable-conio} to use a built-in readline replacement. You will still need
528 either the termcap or the ncurses library, but it is unlikely that the {\bf conio}
529 package will gobble up prompts.
531 readline is no longer supported after version 1.34. The code within Bacula
532 remains, so it should be usable, and if users submit patches for it, we will
533 be happy to apply them. However, due to the fact that each version of
534 readline seems to be incompatible with previous versions, and that there
535 are significant differences between systems, we can no longer afford to
538 \section{What Database to Use?}
540 \index[general]{What Database to Use?}
541 \index[general]{Use!What Database to}
543 Before building Bacula you need to decide if you want to use SQLite, MySQL, or
544 PostgreSQL. If you are not already running MySQL or PostgreSQL, you might
545 want to start by testing with SQLite. This will greatly simplify the setup for you
546 because SQLite is compiled into Bacula an requires no administration. It
547 performs well and is suitable for small to medium sized installations (maximum
548 10-20 machines). However, we should note that a number of users have
549 had unexplained database corruption with SQLite. For that reason, we
550 recommend that you install either MySQL or PostgreSQL for production
553 If you wish to use MySQL as the Bacula catalog, please see the
554 \ilink{Installing and Configuring MySQL}{MySqlChapter} chapter of
555 this manual. You will need to install MySQL prior to continuing with the
556 configuration of Bacula. MySQL is a high quality database that is very
557 efficient and is suitable for any sized installation. It is slightly more
558 complicated than SQLite to setup and administer because it has a number of
559 sophisticated features such as userids and passwords. It runs as a separate
560 process, is truly professional and can manage a database of any size.
562 If you wish to use PostgreSQL as the Bacula catalog, please see the
563 \ilink{Installing and Configuring PostgreSQL}{PostgreSqlChapter}
564 chapter of this manual. You will need to install PostgreSQL prior to
565 continuing with the configuration of Bacula. PostgreSQL is very similar to
566 MySQL, though it tends to be slightly more SQL92 compliant and has many more
567 advanced features such as transactions, stored procedures, and the such. It
568 requires a certain knowledge to install and maintain.
570 If you wish to use SQLite as the Bacula catalog, please see
571 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
574 \section{Quick Start}
575 \index[general]{Quick Start}
576 \index[general]{Start!Quick}
578 There are a number of options and important considerations given below
579 that you can skip for the moment if you have not had any problems building
580 Bacula with a simplified configuration as shown above.
582 If the ./configure process is unable to find specific libraries (e.g.
583 libintl, you should ensure that the appropriate package is installed on
584 your system. Alternatively, if the package is installed in a non-standard
585 location (as far as Bacula is concerned), then there is generally an
586 option listed below (or listed with "./configure {-}{-}help" that will
587 permit you to specify the directory that should be searched. In other
588 cases, there are options that will permit you to disable to feature
589 (e.g. {-}{-}disable-nls).
591 If you want to dive right into it, we recommend you skip to the next chapter,
592 and run the example program. It will teach you a lot about Bacula and as an
593 example can be installed into a single directory (for easy removal) and run as
594 non-root. If you have any problems or when you want to do a real installation,
595 come back to this chapter and read the details presented below.
597 \section{Configure Options}
599 \index[general]{Options!Configure}
600 \index[general]{Configure Options}
602 The following command line options are available for {\bf configure} to
603 customize your installation.
606 \item [ {-}{-}sysbindir=\lt{}binary-path\gt{}]
607 \index[general]{{-}{-}sysbindir}
608 Defines where the Bacula binary (executable) files will be placed during a
609 {\bf make install} command.
611 \item [ {-}{-}sysconfdir=\lt{}config-path\gt{}]
612 \index[general]{{-}{-}sysconfdir}
613 Defines where the Bacula configuration files should be placed during a
614 {\bf make install} command.
616 \item [ {-}{-}mandir=\lt{}path\gt{}]
617 \index[general]{{-}{-}mandir}
618 Note, as of Bacula version 1.39.14, the meaning of any path
619 specified on this option is change from prior versions. It
620 now specifies the top level man directory.
621 Previously the mandir specified the full path to where you
622 wanted the man files installed.
623 The man files will be installed in gzip'ed format under
624 mandir/man1 and mandir/man8 as appropriate.
625 For the install to succeed you must have {\bf gzip} installed
628 By default, Bacula will install the Unix man pages in
629 /usr/share/man/man1 and /usr/share/man/man8.
630 If you wish the man page to be installed in
631 a different location, use this option to specify the path.
632 Note, the main HTML and PDF Bacula documents are in a separate
633 tar file that is not part of the source distribution.
635 \item [ {-}{-}datadir=\lt{}path\gt{}]
636 \index[general]{{-}{-}datadir}
637 If you translate Bacula or parts of Bacula into a different language
638 you may specify the location of the po files using the {\bf
639 {-}{-}datadir} option. You must manually install any po files as
640 Bacula does not (yet) automatically do so.
642 \item [ {-}{-}disable-ipv6 ]
643 \index[general]{{-}{-}disable-ipv6}
645 \item [ {-}{-}enable-smartalloc ]
646 \index[general]{{-}{-}enable-smartalloc}
647 This enables the inclusion of the Smartalloc orphaned buffer detection
648 code. This option is highly recommended. Because we never build
649 without this option, you may experience problems if it is not enabled.
650 In this case, simply re-enable the option. We strongly recommend
651 keeping this option enabled as it helps detect memory leaks. This
652 configuration parameter is used while building Bacula
654 \item [ {-}{-}enable-gnome ]
655 \index[general]{{-}{-}enable-gnome}
656 If you have GNOME installed on your computer including the
657 gnome development libraries, and you want to use the
658 GNOME GUI Console interface to Bacula, you must specify this option.
659 Doing so will build everything in the {\bf src/gnome-console} directory.
661 \item [ {-}{-}enable-wx-console ]
662 \index[general]{{-}{-}enable-wx-console}
663 If you have wxWidgets installed on your computer and you want to use the
664 wxWidgets GUI Console interface to Bacula, you must specify this option.
665 Doing so will build everything in the {\bf src/wx-console} directory.
666 This could also be useful to users who want a GUI Console and don't want
667 to install Gnome, as wxWidgets can work with GTK+, Motif or even X11
671 \item [ {-}{-}enable-tray-monitor ]
672 \index[general]{{-}{-}enable-tray-monitor}
673 If you have GTK installed on your computer, you run a graphical
674 environment or a window manager compatible with the FreeDesktop system
675 tray standard (like KDE and GNOME) and you want to use a GUI to monitor
676 Bacula daemons, you must specify this option. Doing so will build
677 everything in the {\bf src/tray-monitor} directory.
679 \item [ {-}{-}enable-static-tools]
680 \index[general]{{-}{-}enable-static-tools}
681 This option causes the linker to link the Storage daemon utility tools
682 ({\bf bls}, {\bf bextract}, and {\bf bscan}) statically. This permits
683 using them without having the shared libraries loaded. If you have
684 problems linking in the {\bf src/stored} directory, make sure you have
685 not enabled this option, or explicitly disable static linking by adding
686 {\bf \verb:--:disable-static-tools}.
689 \item [ {-}{-}enable-static-fd]
690 \index[general]{{-}{-}enable-static-fd}
691 This option causes the make process to build a {\bf static-bacula-fd} in
692 addition to the standard File daemon. This static version will include
693 statically linked libraries and is required for the Bare Metal recovery.
694 This option is largely superseded by using {\bf make static-bacula-fd}
695 from with in the {\bf src/filed} directory. Also, the {\bf
696 \verb:--:enable-client-only} option described below is useful for just
697 building a client so that all the other parts of the program are not
700 When linking a static binary, the linker needs the static versions
701 of all the libraries that are used, so frequently users will
702 experience linking errors when this option is used. The first
703 thing to do is to make sure you have the static glibc library
704 installed on your system. The second thing to do is the make sure
705 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
706 on your ./configure statement as these options require additional
707 libraries. You may be able to enable those options, but you will
708 need to load additional static libraries.
711 \item [ {-}{-}enable-static-sd]
712 \index[general]{{-}{-}enable-static-sd}
713 This option causes the make process to build a {\bf static-bacula-sd} in
714 addition to the standard Storage daemon. This static version will
715 include statically linked libraries and could be useful during a Bare
718 When linking a static binary, the linker needs the static versions
719 of all the libraries that are used, so frequently users will
720 experience linking errors when this option is used. The first
721 thing to do is to make sure you have the static glibc library
722 installed on your system. The second thing to do is the make sure
723 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
724 on your ./configure statement as these options require additional
725 libraries. You may be able to enable those options, but you will
726 need to load additional static libraries.
730 \item [ {-}{-}enable-static-dir]
731 \index[general]{{-}{-}enable-static-dir}
732 This option causes the make process to build a {\bf static-bacula-dir}
733 in addition to the standard Director. This static version will include
734 statically linked libraries and could be useful during a Bare Metal
737 When linking a static binary, the linker needs the static versions
738 of all the libraries that are used, so frequently users will
739 experience linking errors when this option is used. The first
740 thing to do is to make sure you have the static glibc library
741 installed on your system. The second thing to do is the make sure
742 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
743 on your ./configure statement as these options require additional
744 libraries. You may be able to enable those options, but you will
745 need to load additional static libraries.
748 \item [ {-}{-}enable-static-cons]
749 \index[general]{{-}{-}enable-static-cons}
750 This option causes the make process to build a {\bf static-console} and
751 a {\bf static-gnome-console} in addition to the standard console. This
752 static version will include statically linked libraries and could be
753 useful during a Bare Metal recovery.
755 When linking a static binary, the linker needs the static versions
756 of all the libraries that are used, so frequently users will
757 experience linking errors when this option is used. The first
758 thing to do is to make sure you have the static glibc library
759 installed on your system. The second thing to do is the make sure
760 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
761 on your ./configure statement as these options require additional
762 libraries. You may be able to enable those options, but you will
763 need to load additional static libraries.
766 \item [ {-}{-}enable-client-only]
767 \index[general]{{-}{-}enable-client-only}
768 This option causes the make process to build only the File daemon and
769 the libraries that it needs. None of the other daemons, storage tools,
770 nor the console will be built. Likewise a {\bf make install} will then
771 only install the File daemon. To cause all daemons to be built, you
772 will need to do a configuration without this option. This option
773 greatly facilitates building a Client on a client only machine.
775 When linking a static binary, the linker needs the static versions
776 of all the libraries that are used, so frequently users will
777 experience linking errors when this option is used. The first
778 thing to do is to make sure you have the static glibc library
779 installed on your system. The second thing to do is the make sure
780 you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
781 on your ./configure statement as these options require additional
782 libraries. You may be able to enable those options, but you will
783 need to load additional static libraries.
785 \item [ {-}{-}enable-build-dird]
786 \index[general]{{-}{-}enable-build-dird}
787 This option causes the make process to build the Director and the
788 Director's tools. By default, this option is on, but you may turn
789 it off by using {\bf {-}{-}disable-build-dird} to prevent the
790 Director from being built.
792 \item [ {-}{-}enable-build-stored]
793 \index[general]{{-}{-}enable-build-stored}
794 This option causes the make process to build the Storage daemon.
795 By default, this option is on, but you may turn
796 it off by using {\bf {-}{-}disable-build-stored} to prevent the
797 Storage daemon from being built.
800 \item [ {-}{-}enable-largefile]
801 \index[general]{{-}{-}enable-largefile}
802 This option (default) causes Bacula to be built with 64 bit file address
803 support if it is available on your system. This permits Bacula to read and
804 write files greater than 2 GBytes in size. You may disable this feature and
805 revert to 32 bit file addresses by using {\bf \verb:--:disable-largefile}.
807 \item [ {-}{-}disable-nls]
808 \index[general]{{-}{-}disable-nls}
809 By default, Bacula uses the GNU Native Language Support (NLS) libraries. On
810 some machines, these libraries may not be present or may not function
811 correctly (especially on non-Linux implementations). In such cases, you
812 may specify {\bf {-}{-}disable-nls} to disable use of those libraries.
813 In such a case, Bacula will revert to using English.
815 \item [ {-}{-}disable-ipv6 ]
816 \index[general]{{-}{-}disable-ipv6}
817 By default, Bacula enables IPv6 protocol. On some systems, the files
818 for IPv6 may exist, but the functionality could be turned off in the
819 kernel. In that case, in order to correctly build Bacula, you will
820 explicitly need to use this option so that Bacula does not attempt
821 to reference OS function calls that do not exist.
823 \item [ {-}{-}with-sqlite=\lt{}sqlite-path\gt{}]
824 \index[general]{{-}{-}with-sqlite}
825 This enables use of the SQLite version 2.8.x database. The {\bf sqlite-path} is not
826 normally specified as Bacula looks for the necessary components in a
827 standard location ({\bf depkgs/sqlite}). See
828 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
829 this manual for more details.
831 See the note below under the {-}{-}with-postgresql item.
833 \item [ {-}{-}with-sqlite3=\lt{}sqlite3-path\gt{}]
834 \index[general]{{-}{-}with-sqlite3}
835 This enables use of the SQLite version 3.x database. The {\bf
836 sqlite3-path} is not normally specified as Bacula looks for the
837 necessary components in a standard location ({\bf depkgs/sqlite3}). See
838 \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of
839 this manual for more details.
841 \item [ {-}{-}with-mysql=\lt{}mysql-path\gt{}]
842 \index[general]{{-}{-}with-mysql}
843 This enables building of the Catalog services for Bacula. It assumes
844 that MySQL is running on your system, and expects it to be installed in
845 the {\bf mysql-path} that you specify. Normally, if MySQL is installed
846 in a standard system location, you can simply use {\bf {-}{-}with-mysql}
847 with no path specification. If you do use this option, please proceed
848 to installing MySQL in the \ilink{Installing and Configuring
849 MySQL}{MySqlChapter} chapter before proceeding with the configuration.
851 See the note below under the {-}{-}with-postgresql item.
853 \item [ {-}{-}with-postgresql=\lt{}path\gt{}]
854 \index[general]{{-}{-}with-postgresql}
855 This provides an explicit path to the PostgreSQL libraries if Bacula
856 cannot find it by default. Normally to build with PostgreSQL, you would
857 simply use {\bf {-}{-}with-postgresql}.
859 Note, for Bacula to be configured properly, you must specify one
860 of the four database options supported. That is:
861 {-}{-}with-sqlite, {-}{-}with-sqlite3, {-}{-}with-mysql, or
862 {-}{-}with-postgresql, otherwise the ./configure will fail.
864 \item [ {-}{-}with-openssl=\lt{}path\gt{}]
865 This configuration option is necessary if you want to enable TLS (ssl),
866 which encrypts the communications within
867 Bacula or if you want to use File Daemon PKI data encryption.
868 Normally, the {\bf path} specification is not necessary since
869 the configuration searches for the OpenSSL libraries in standard system
870 locations. Enabling OpenSSL in Bacula permits secure communications
871 between the daemons and/or data encryption in the File daemon.
872 For more information on using TLS, please see the
873 \ilink{Bacula TLS -- Communications Encryption}{CommEncryption} chapter
875 For more information on using PKI data encryption, please see the
876 \ilink{Bacula PKI -- Data Encryption}{DataEncryption}
877 chapter of this manual.
881 \item [ {-}{-}with-python=\lt{}path\gt{}]
882 \index[general]{{-}{-}with-python}
883 This option enables Bacula support for Python. If no path is
884 supplied, configure will search the
885 standard library locations for Python 2.2, 2.3, or 2.4. If it cannot
886 find the library, you will need to supply a path to your Python
887 library directory. Please see the
888 \ilink{Python chapter}{PythonChapter} for the details of using
891 \item [ {-}{-}with-libintl-prefix=\lt{}DIR\gt{}]
892 \index[general]{{-}{-}with-libintl-prefix}
893 This option may be used to tell Bacula to search DIR/include and
894 DIR/lib for the libintl headers and libraries needed for Native
895 Language Support (NLS).
897 \item [ {-}{-}enable-conio]
898 \index[general]{{-}{-}enable-conio}
899 Tells Bacula to enable building the small, light weight readline
900 replacement routine. It is generally much easier to configure than
901 readline, although, like readline, it needs either the termcap or
904 \item [ {-}{-}with-readline=\lt{}readline-path\gt{}]
905 \index[general]{{-}{-}with-readline}
906 Tells Bacula where {\bf readline} is installed. Normally, Bacula will
907 find readline if it is in a standard library. If it is not found and no
908 {-}{-}with-readline is specified, readline will be disabled. This
909 option affects the Bacula build. Readline provides the Console program
910 with a command line history and editing capability and is no longer
911 supported, so you are on your own if you have problems.
913 \item [ {-}{-}enable-readline]
914 \index[general]{{-}{-}enable-readline}
915 Tells Bacula to enable readline support. It is normally disabled due to the
916 large number of configuration problems and the fact that the package seems to
917 change in incompatible ways from version to version.
919 \item [ {-}{-}with-tcp-wrappers=\lt{}path\gt{}]
920 \index[general]{{-}{-}with-tcp-wrappers}
921 \index[general]{TCP Wrappers}
922 \index[general]{Wrappers!TCP}
923 \index[general]{libwrappers}
924 This specifies that you want TCP wrappers (man hosts\_access(5)) compiled in.
925 The path is optional since Bacula will normally find the libraries in the
926 standard locations. This option affects the Bacula build. In specifying your
927 restrictions in the {\bf /etc/hosts.allow} or {\bf /etc/hosts.deny} files, do
928 not use the {\bf twist} option (hosts\_options(5)) or the Bacula process will
929 be terminated. Note, when setting up your {\bf /etc/hosts.allow}
930 or {\bf /etc/hosts.deny}, you must identify the Bacula daemon in
931 question with the name you give it in your conf file rather than the
932 name of the executable.
934 For more information on configuring and testing TCP wrappers, please see the
935 \ilink{Configuring and Testing TCP Wrappers}{wrappers} section
936 in the Security Chapter.
938 On SuSE, the libwrappers libraries needed to link Bacula are
939 contained in the tcpd-devel package. On Red Hat, the package is named
942 \item [ {-}{-}with-working-dir=\lt{}working-directory-path\gt{} ]
943 \index[general]{{-}{-}with-working-dir}
944 This option is mandatory and specifies a directory into which Bacula may
945 safely place files that will remain between Bacula executions. For example,
946 if the internal database is used, Bacula will keep those files in this
947 directory. This option is only used to modify the daemon configuration
948 files. You may also accomplish the same thing by directly editing them later.
949 The working directory is not automatically created by the install process, so
950 you must ensure that it exists before using Bacula for the first time.
952 \item [ {-}{-}with-base-port=\lt{}port=number\gt{}]
953 \index[general]{{-}{-}with-base-port}
954 In order to run, Bacula needs three TCP/IP ports (one for the Bacula
955 Console, one for the Storage daemon, and one for the File daemon). The {\bf
956 \verb:--:with-baseport} option will automatically assign three ports beginning at
957 the base port address specified. You may also change the port number in the
958 resulting configuration files. However, you need to take care that the
959 numbers correspond correctly in each of the three daemon configuration
960 files. The default base port is 9101, which assigns ports 9101 through 9103.
961 These ports (9101, 9102, and 9103) have been officially assigned to Bacula by
962 IANA. This option is only used to modify the daemon configuration files. You
963 may also accomplish the same thing by directly editing them later.
965 \item [ {-}{-}with-dump-email=\lt{}email-address\gt{}]
966 \index[general]{{-}{-}with-dump-email}
967 This option specifies the email address where any core dumps should be set.
968 This option is normally only used by developers.
970 \item [ {-}{-}with-pid-dir=\lt{}PATH\gt{} ]
971 \index[general]{{-}{-}with-pid-dir}
972 This specifies where Bacula should place the process id file during
973 execution. The default is: {\bf /var/run}. This directory is not created by
974 the install process, so you must ensure that it exists before using Bacula
977 \item [ {-}{-}with-subsys-dir=\lt{}PATH\gt{}]
978 \index[general]{{-}{-}with-subsys-dir}
979 This specifies where Bacula should place the subsystem lock file during
980 execution. The default is {\bf /var/run/subsys}. Please make sure that you do
981 not specify the same directory for this directory and for the {\bf sbindir}
982 directory. This directory is used only within the autostart scripts. The
983 subsys directory is not created by the Bacula install, so you must be sure to
984 create it before using Bacula.
986 \item [ {-}{-}with-dir-password=\lt{}Password\gt{}]
987 \index[general]{{-}{-}with-dir-password}
988 This option allows you to specify the password used to access the Directory
989 (normally from the Console program). If it is not specified, configure will
990 automatically create a random password.
992 \item [ {-}{-}with-fd-password=\lt{}Password\gt{} ]
993 \index[general]{{-}{-}with-fd-password}
994 This option allows you to specify the password used to access the File daemon
995 (normally called from the Director). If it is not specified, configure will
996 automatically create a random password.
998 \item [ {-}{-}with-sd-password=\lt{}Password\gt{} ]
999 \index[general]{{-}{-}with-sd-password}
1000 This option allows you to specify the password used to access the Directory
1001 (normally called from the Director). If it is not specified, configure will
1002 automatically create a random password.
1004 \item [ {-}{-}with-dir-user=\lt{}User\gt{} ]
1005 \index[general]{{-}{-}with-dir-user}
1006 This option allows you to specify the Userid used to run the Director. The
1007 Director must be started as root, but doesn't need to run as root, and
1008 after doing preliminary initializations, it can "drop" to the UserId
1009 specified on this option.
1010 If you specify this option, you must
1011 create the User prior to running {\bf make install}, because the
1012 working directory owner will be set to {\bf User}.
1015 \item [ {-}{-}with-dir-group=\lt{}Group\gt{} ]
1016 \index[general]{{-}{-}with-dir-group}
1017 This option allows you to specify the GroupId used to run the Director. The
1018 Director must be started as root, but doesn't need to run as root, and after
1019 doing preliminary initializations, it can "drop" to the GroupId specified
1021 If you specify this option, you must
1022 create the Group prior to running {\bf make install}, because the
1023 working directory group will be set to {\bf Group}.
1025 \item [ {-}{-}with-sd-user=\lt{}User\gt{} ]
1026 \index[general]{{-}{-}with-sd-user}
1027 This option allows you to specify the Userid used to run the Storage daemon.
1028 The Storage daemon must be started as root, but doesn't need to run as root,
1029 and after doing preliminary initializations, it can "drop" to the UserId
1030 specified on this option. If you use this option, you will need to take care
1031 that the Storage daemon has access to all the devices (tape drives, ...) that
1034 \item [ {-}{-}with-sd-group=\lt{}Group\gt{} ]
1035 \index[general]{{-}{-}with-sd-group}
1036 This option allows you to specify the GroupId used to run the Storage daemon.
1037 The Storage daemon must be started as root, but doesn't need to run as root,
1038 and after doing preliminary initializations, it can "drop" to the GroupId
1039 specified on this option.
1041 \item [ {-}{-}with-fd-user=\lt{}User\gt{} ]
1042 \index[general]{{-}{-}with-fd-user}
1043 This option allows you to specify the Userid used to run the File daemon. The
1044 File daemon must be started as root, and in most cases, it needs to run as
1045 root, so this option is used only in very special cases, after doing
1046 preliminary initializations, it can "drop" to the UserId specified on this
1049 \item [ {-}{-}with-fd-group=\lt{}Group\gt{} ]
1050 \index[general]{{-}{-}with-fd-group}
1051 This option allows you to specify the GroupId used to run the File daemon.
1052 The File daemon must be started as root, and in most cases, it must be run as
1053 root, however, after doing preliminary initializations, it can "drop" to
1054 the GroupId specified on this option.
1058 Note, many other options are presented when you do a {\bf ./configure
1059 \verb:--:help}, but they are not implemented.
1061 \section{Recommended Options for Most Systems}
1062 \index[general]{Systems!Recommended Options for Most}
1063 \index[general]{Recommended Options for Most Systems}
1065 For most systems, we recommend starting with the following options:
1070 --enable-smartalloc \
1071 --sbindir=$HOME/bacula/bin \
1072 --sysconfdir=$HOME/bacula/bin \
1073 --with-pid-dir=$HOME/bacula/bin/working \
1074 --with-subsys-dir=$HOME/bacula/bin/working \
1075 --with-mysql=$HOME/mysql \
1076 --with-working-dir=$HOME/bacula/working
1080 If you want to install Bacula in an installation directory rather than run it
1081 out of the build directory (as developers will do most of the time), you
1082 should also include the \verb:--:sbindir and \verb:--:sysconfdir options with appropriate
1083 paths. Neither are necessary if you do not use "make install" as is the case
1084 for most development work. The install process will create the sbindir and
1085 sysconfdir if they do not exist, but it will not automatically create the
1086 pid-dir, subsys-dir, or working-dir, so you must ensure that they exist before
1087 running Bacula for the first time.
1090 \index[general]{Red Hat}
1097 CFLAGS="-g -Wall" ./configure \
1098 --sbindir=$HOME/bacula/bin \
1099 --sysconfdir=$HOME/bacula/bin \
1100 --enable-smartalloc \
1101 --with-sqlite=$HOME/bacula/depkgs/sqlite \
1102 --with-working-dir=$HOME/bacula/working \
1103 --with-pid-dir=$HOME/bacula/bin/working \
1104 --with-subsys-dir=$HOME/bacula/bin/working \
1115 CFLAGS="-g -Wall" ./configure \
1116 --sbindir=$HOME/bacula/bin \
1117 --sysconfdir=$HOME/bacula/bin \
1118 --enable-smartalloc \
1119 --with-mysql=$HOME/mysql \
1120 --with-working-dir=$HOME/bacula/working
1121 --with-pid-dir=$HOME/bacula/bin/working \
1122 --with-subsys-dir=$HOME/bacula/bin/working
1128 or finally, a completely traditional Red Hat Linux install:
1132 CFLAGS="-g -Wall" ./configure \
1134 --sbindir=/usr/sbin \
1135 --sysconfdir=/etc/bacula \
1136 --with-scriptdir=/etc/bacula \
1137 --enable-smartalloc \
1140 --with-working-dir=/var/bacula \
1141 --with-pid-dir=/var/run \
1142 --with-subsys-dir=/var/lock/subsys \
1147 Note, Bacula assumes that /var/bacula, /var/run, and /var/loc/subsys exist so
1148 it will not automatically create them during the install process.
1150 Note, with gcc (GCC) 4.0.1 20050727 (Red Hat 4.0.1-5) on
1151 an AMD64 CPU running 64 bit CentOS4, there is a compiler bug that generates
1152 bad code that causes Bacula to segment fault. Typically you will see this
1153 in the Storage daemon first. The solution is to compile Bacula ensuring
1154 that no optimization is turned on (normally it is -O2).
1157 \index[general]{Solaris}
1159 To build Bacula from source, you will need the following installed on your
1160 system (they are not by default): libiconv, gcc 3.3.2, stdc++, libgcc (for
1161 stdc++ and gcc\_s libraries), make 3.8 or later.
1163 You will probably also need to: Add /usr/local/bin to PATH and Add
1164 /usr/ccs/bin to PATH for ar.
1169 CFLAGS="-g" ./configure \
1170 --sbindir=$HOME/bacula/bin \
1171 --sysconfdir=$HOME/bacula/bin \
1172 --with-mysql=$HOME/mysql \
1173 --enable-smartalloc \
1174 --with-pid-dir=$HOME/bacula/bin/working \
1175 --with-subsys-dir=$HOME/bacula/bin/working \
1176 --with-working-dir=$HOME/bacula/working
1180 As mentioned above, the install process will create the sbindir and sysconfdir
1181 if they do not exist, but it will not automatically create the pid-dir,
1182 subsys-dir, or working-dir, so you must ensure that they exist before running
1183 Bacula for the first time.
1185 Note, you may need to install the following packages to build Bacula
1205 PATH=/usr/bin::/usr/ccs/bin:/etc:/usr/openwin/bin:/usr/local/bin:/usr/sfw/bin:/opt/sfw/bin:/usr/ucb:/usr/sbin
1210 \index[general]{FreeBSD}
1213 \elink{The FreeBSD Diary}{http://www.freebsddiary.org/bacula.php} for a
1214 detailed description on how to make Bacula work on your system. In addition,
1215 users of FreeBSD prior to 4.9-STABLE dated Mon Dec 29 15:18:01 2003 UTC who
1216 plan to use tape devices, please see the
1217 \ilink{Tape Testing Chapter}{FreeBSDTapes} of this manual for
1218 {\bf important} information on how to configure your tape drive for
1219 compatibility with Bacula.
1221 If you are using Bacula with MySQL, you should take care to compile MySQL with
1222 FreeBSD native threads rather than LinuxThreads, since Bacula is normally built
1223 with FreeBSD native threads rather than LinuxTreads. Mixing the two will
1227 \index[general]{Win32}
1229 To install the binary Win32 version of the File daemon please see the
1230 \ilink{Win32 Installation Chapter}{Win32Chapter} in this document.
1232 \section{One File Configure Script}
1233 \index[general]{Script!One File Configure}
1234 \index[general]{One Files Configure Script}
1236 The following script could be used if you want to put everything
1244 --sbindir=$HOME/bacula/bin \
1245 --sysconfdir=$HOME/bacula/bin \
1246 --mandir=$HOME/bacula/bin \
1247 --enable-smartalloc \
1249 --enable-wx-console \
1250 --enable-tray-monitor \
1251 --with-pid-dir=$HOME/bacula/bin/working \
1252 --with-subsys-dir=$HOME/bacula/bin/working \
1254 --with-working-dir=$HOME/bacula/bin/working \
1255 --with-dump-email=$USER@your-site.com \
1256 --with-job-email=$USER@your-site.com \
1257 --with-smtp-host=mail.your-site.com
1262 You may also want to put the following entries in your {\bf /etc/services}
1263 file as it will make viewing the connections made by Bacula easier to
1264 recognize (i.e. netstat -a):
1274 \section{Installing Bacula}
1275 \index[general]{Bacula!Installing}
1276 \index[general]{Installing Bacula}
1278 Before setting up your configuration files, you will want to install Bacula in
1279 its final location. Simply enter:
1287 If you have previously installed Bacula, the old binaries will be overwritten,
1288 but the old configuration files will remain unchanged, and the "new"
1289 configuration files will be appended with a {\bf .new}. Generally if you have
1290 previously installed and run Bacula you will want to discard or ignore the
1291 configuration files with the appended {\bf .new}.
1293 \section{Building a File Daemon or Client}
1294 \index[general]{Client!Building a File Daemon or}
1295 \index[general]{Building a File Daemon or Client}
1297 If you run the Director and the Storage daemon on one machine and you wish to
1298 back up another machine, you must have a copy of the File daemon for that
1299 machine. If the machine and the Operating System are identical, you can simply
1300 copy the Bacula File daemon binary file {\bf bacula-fd} as well as its
1301 configuration file {\bf bacula-fd.conf} then modify the name and password in
1302 the conf file to be unique. Be sure to make corresponding additions to the
1303 Director's configuration file ({\bf bacula-dir.conf}).
1305 If the architecture or the OS level are different, you will need to build a
1306 File daemon on the Client machine. To do so, you can use the same {\bf
1307 ./configure} command as you did for your main program, starting either from a
1308 fresh copy of the source tree, or using {\bf make\ distclean} before the {\bf
1311 Since the File daemon does not access the Catalog database, you can remove
1312 the {\bf \verb:--:with-mysql} or {\bf \verb:--:with-sqlite} options, then
1313 add {\bf \verb:--:enable-client-only}. This will compile only the
1314 necessary libraries and the client programs and thus avoids the necessity
1315 of installing one or another of those database programs to build the File
1316 daemon. With the above option, you simply enter {\bf make} and just the
1317 client will be built.
1320 \section{Auto Starting the Daemons}
1321 \index[general]{Daemons!Auto Starting the}
1322 \index[general]{Auto Starting the Daemons}
1324 If you wish the daemons to be automatically started and stopped when your
1325 system is booted (a good idea), one more step is necessary. First, the
1326 ./configure process must recognize your system -- that is it must be a
1327 supported platform and not {\bf unknown}, then you must install the platform
1328 dependent files by doing:
1333 make install-autostart
1337 Please note, that the auto-start feature is implemented only on systems
1338 that we officially support (currently, FreeBSD, Red Hat/Fedora Linux, and
1339 Solaris), and has only been fully tested on Fedora Linux.
1341 The {\bf make install-autostart} will cause the appropriate startup scripts
1342 to be installed with the necessary symbolic links. On Red Hat/Fedora Linux
1343 systems, these scripts reside in {\bf /etc/rc.d/init.d/bacula-dir} {\bf
1344 /etc/rc.d/init.d/bacula-fd}, and {\bf /etc/rc.d/init.d/bacula-sd}. However
1345 the exact location depends on what operating system you are using.
1347 If you only wish to install the File daemon, you may do so with:
1351 make install-autostart-fd
1355 \section{Other Make Notes}
1356 \index[general]{Notes!Other Make}
1357 \index[general]{Other Make Notes}
1359 To simply build a new executable in any directory, enter:
1367 To clean out all the objects and binaries (including the files named 1, 2, or
1368 3, which are development temporary files), enter:
1376 To really clean out everything for distribution, enter:
1384 note, this cleans out the Makefiles and is normally done from the top level
1385 directory to prepare for distribution of the source. To recover from this
1386 state, you must redo the {\bf ./configure} in the top level directory, since
1387 all the Makefiles will be deleted.
1389 To add a new file in a subdirectory, edit the Makefile.in in that directory,
1390 then simply do a {\bf make}. In most cases, the make will rebuild the Makefile
1391 from the new Makefile.in. In some case, you may need to issue the {\bf make} a
1392 second time. In extreme cases, cd to the top level directory and enter: {\bf
1395 To add dependencies:
1403 The {\bf make depend} appends the header file dependencies for each of the
1404 object files to Makefile and Makefile.in. This command should be done in each
1405 directory where you change the dependencies. Normally, it only needs to be run
1406 when you add or delete source or header files. {\bf make depend} is normally
1407 automatically invoked during the configuration process.
1417 This not normally done if you are developing Bacula, but is used if you are
1418 going to run it to backup your system.
1420 After doing a {\bf make install} the following files will be installed on your
1421 system (more or less). The exact files and location (directory) for each file
1422 depends on your {\bf ./configure} command (e.g. gnome-console and
1423 gnome-console.conf are not installed if you do not configure GNOME. Also, if
1424 you are using SQLite instead of mysql, some of the files will be different).
1445 create_mysql_database
1447 delete_catalog_backup
1469 \section{Installing Tray Monitor}
1470 \index[general]{Monitor!Installing Tray}
1471 \index[general]{Installing Tray Monitor}
1473 The Tray Monitor is already installed if you used the {\bf
1474 \verb:--:enable-tray-monitor} configure option and ran {\bf make install}.
1476 As you don't run your graphical environment as root (if you do, you should
1477 change that bad habit), don't forget to allow your user to read {\bf
1478 tray-monitor.conf}, and to execute {\bf bacula-tray-monitor} (this is not a
1481 Then log into your graphical environment (KDE, Gnome or something else), run
1482 {\bf bacula-tray-monitor} as your user, and see if a cassette icon appears
1483 somewhere on the screen, usually on the task bar.
1484 If it doesn't, follow the instructions below related to your environment or
1488 \index[general]{GNOME}
1490 System tray, or notification area if you use the GNOME terminology, has been
1491 supported in GNOME since version 2.2. To activate it, right-click on one of
1492 your panels, open the menu {\bf Add to this Panel}, then {\bf Utility} and
1493 finally click on {\bf Notification Area}.
1496 \index[general]{KDE}
1498 System tray has been supported in KDE since version 3.1. To activate it,
1499 right-click on one of your panels, open the menu {\bf Add}, then {\bf Applet}
1500 and finally click on {\bf System Tray}.
1502 \subsection{Other window managers}
1503 \index[general]{Managers!Other window}
1504 \index[general]{Other window managers}
1506 Read the documentation to know if the Freedesktop system tray standard is
1507 supported by your window manager, and if applicable, how to activate it.
1509 \section{Modifying the Bacula Configuration Files}
1510 \index[general]{Modifying the Bacula Configuration Files}
1511 \index[general]{Files!Modifying the Bacula Configuration}
1514 \ilink{Configuring Bacula}{ConfigureChapter} in this manual for
1515 instructions on how to set Bacula configuration files.