4 \section*{Installing Bacula}
5 \label{_ChapterStart17}
6 \index[general]{Bacula!Installing }
7 \index[general]{Installing Bacula }
8 \addcontentsline{toc}{section}{Installing Bacula}
11 \index[general]{General }
12 \addcontentsline{toc}{subsection}{General}
14 In general, you will need the Bacula source release, and if you want to run a
15 Windows client, you will need the Bacula Windows binary release. However,
16 Bacula needs certain third party packages (such as {\bf SQLite}, {\bf MySQL}, or
18 to build properly depending on the options you specify. To simplify your task,
19 we have combined a number of these packages into two {\bf depkgs} releases
20 (Dependency Packages). This can vastly simplify your life by providing you
21 with all the necessary packages rather than requiring you to find them on the
22 Web, load them, and install them.
25 \subsection*{Upgrading Bacula}
26 \index[general]{Bacula!Upgrading }
27 \index[general]{Upgrading Bacula }
28 \addcontentsline{toc}{subsection}{Upgrading Bacula}
30 If you are upgrading from one Bacula version to another, you should first
31 carefully read the ReleaseNotes of all versions between your current version
32 and the version to which you are upgrading. If the Bacula catalog database has
33 been upgraded, you will either need to reinitialize your database starting
34 from scratch, or save an ASCII copy of your database, then proceed to upgrade
35 it. If there are several database upgrades between your version and the
36 version to which you are upgrading, you will need to apply each database
37 upgrade script. For your convenience, you can find all the old upgrade scripts
38 in the {\bf upgradedb} directory of the source code. You will need to edit the
39 scripts to correspond to your system configuration. The final upgrade script,
40 if any, will be in the {\bf src/cats} directory as described in the
43 If you are upgrading from one major version to another, you will need to
44 replace all your components at the same time as generally the inter-daemon
45 protocol will change. However, within any particular release (e.g. version
46 1.32.x) unless there is an oversight or bug, the daemon protocol will not
47 change. If this is confusing, simply read the ReleaseNotes very carefully as
48 they will note if all daemons must be upgraded at the same time.
50 Finally, please note that in general it is not necessary to do a
51 {\bf make uninstall} before doing an upgrade. In fact, if you do so, you will
52 most likely delete all your conf files, which could be disastrous.
53 For additional information on upgrading, please see the \ilink{Upgrading Bacula
54 Versions}{upgrading} in the Tips chapter of this manual.
57 \subsection*{Dependency Packages}
59 \index[general]{Dependency Packages }
60 \index[general]{Packages!Dependency }
61 \addcontentsline{toc}{subsection}{Dependency Packages}
63 As discussed above, we have combined a number of third party packages that
64 Bacula might need into the {\bf depkgs} and {\bf depkgs1} releases. You can,
65 of course, get the latest packages from the original authors. The locations of
66 where we obtained the packages are in the README file in each package.
67 However, be aware that the packages in the depkgs files have been tested by us
68 for compatibility with Bacula.
70 Typically, a dependency package will be named {\bf depkgs-ddMMMyy.tar.gz} and
71 {\bf depkgs1-ddMMyy.tar.gz} where {\bf dd} is the day we release it, {\bf MMM}
72 is the abbreviated month (e.g. Jan), and {\bf yy} is the year. An actual
73 example is: {\bf depkgs-07Apr02.tar.gz}. To install and build this package (if
74 needed), you do the following:
77 \item Create a {\bf bacula} directory, into which you will place both the
78 Bacula source as well as the dependency package.
79 \item Detar the {\bf depkg} into the {\bf bacula} directory.
80 \item cd bacula/depkgs
84 Although the exact composition of the dependency packages may change from time
85 to time, the current makeup is the following:
87 \addcontentsline{lot}{table}{Dependency Packages}
88 \begin{longtable}{|l|l|l|l|}
90 \multicolumn{1}{|c| }{\bf 3rd Party Package } & \multicolumn{1}{c| }{\bf
91 depkgs } & \multicolumn{1}{c| }{\bf depkgs1 } & \multicolumn{1}{c| }{\bf
93 \hline {SQLite } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } &
94 \multicolumn{1}{c| }{- } \\
95 \hline {mtx } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } &
96 \multicolumn{1}{c| }{- } \\
97 \hline {readline } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{X } &
98 \multicolumn{1}{c| }{- } \\
99 \hline {pthreads } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } &
100 \multicolumn{1}{c| }{X } \\
101 \hline {zlib } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } &
102 \multicolumn{1}{c| }{X } \\
103 \hline {wxWidgits } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } &
104 \multicolumn{1}{c| }{X }
109 Note, some of these packages are quite large, so that building them can be a
110 bit time consuming. The above instructions will build all the packages
111 contained in the directory. However, when building Bacula, it will take only
112 those pieces that it actually needs.
114 Alternatively, you can make just the packages that are needed. For example,
123 will configure and build only the SQLite package.
125 You should build the packages that you will require in {\bf depkgs} and/or
126 {\bf depkgs1} prior to configuring and building Bacula, since Bacula will need
127 them during the build process.
129 Even if you do not use SQLite, you might find it worthwhile to build {\bf mtx}
130 because the {\bf tapeinfo} program that comes with it can often provide you
131 with valuable information about your SCSI tape drive (e.g. compression,
132 min/max block sizes, ...).
134 The {\bf depkgs-win32} package contains the source code for the pthreads,
135 zlib, and wxWidgets libraries used by the native Win32 client program.
136 It will only be needed
137 if you intend to build the Win32 client from source.
139 \subsection*{Supported Operating Systems}
141 \index[general]{Systems!Supported Operating }
142 \index[general]{Supported Operating Systems }
143 \addcontentsline{toc}{subsection}{Supported Operating Systems}
146 \ilink{ Supported Operating Systems}{SupportedOSes} section
147 of the QuickStart chapter of this manual.
149 \subsection*{Building Bacula from Source}
151 \index[general]{Source!Building Bacula from }
152 \index[general]{Building Bacula from Source }
153 \addcontentsline{toc}{subsection}{Building Bacula from Source}
155 The basic installation is rather simple.
158 \item Install and build any {\bf depkgs} as noted above.
159 \item Configure and install MySQL or PostgreSQL (if desired).
160 \ilink{Installing and Configuring MySQL Phase I}{_ChapterStart} or
161 \ilink{Installing and Configuring PostgreSQL Phase
162 I}{_ChapterStart10}. If you are installing from rpms, and are
163 using MySQL, please be sure to install {\bf mysql-devel}, so that the MySQL
164 header files are available while compiling Bacula. In addition, the MySQL
165 client library {\bf mysqlclient} requires the gzip compression library {\bf
166 libz.a} or {\bf libz.so}. If you are using rpm packages, these libraries are
167 in the {\bf libz-devel} package. On Debian systems, you will need to load the
168 {\bf zlib1g-dev} package. If you are not using rpms or debs, you will need to
169 find the appropriate package for your system.
170 Note, if you already have a running MySQL or PostgreSQL on your system, you
171 can skip this phase provided that you have built the thread safe libraries.
172 And you have already installed the additional rpms noted above.
173 \item As an alternative to MySQL and PostgreSQL, configure and install SQLite,
174 which is part of the {\bf depkgs}.
175 \ilink{Installing and Configuring SQLite}{_ChapterStart33}.
176 \item Detar the Bacula source code preferably into the {\bf bacula} directory
178 \item {\bf cd} to the directory containing the source code.
179 \item ./configure (with appropriate options as described below)
180 \item Check the output of ./configure very carefully, especially the Install
181 binaries and Install config directories. If they are not correct,
182 please rerun ./configure until they are. The output from ./configure is
183 stored in {\bf config.out} and can be re-displayed at any time without
184 rerunning the ./configure by doing {\bf cat config.out}.
185 \item If after running ./configure once, you decide to change options and
186 re-run it, that is perfectly fine, but before re-running it, you should run:
196 so that you are sure to start from scratch and not have a mixture of the two
197 options. This is because ./configure caches much of the information. The {\bf
198 make distclean} is also critical if you move the source directory from one
199 machine to another. If the {\bf make distclean} fails, just ignore it and
203 If you get errors while linking in the Storage daemon directory (src/stored),
204 it is probably because you have not loaded the static libraries on your
205 system. I noticed this problem on a Solaris system. To correct it, make sure
206 that you have not added {\bf \verb:--:enable-static-tools} to the {\bf ./configure}
209 \item If you are new to Bacula, we {\bf strongly} recommend that you skip the
210 next step and use the default configuration files, then run the example
211 program in the next chapter, then come back and modify your configuration
212 files to suit your particular needs.
213 \item Customize the configuration files for each of the three daemons
214 (Directory, File, Storage) and for the Console program. For the details of
215 how to do this, please see
216 \ilink{Setting Up Bacula Configuration Files}{_ChapterStart16} in
217 the Configuration chapter of this manual. We recommend that you start by
218 modifying the default configuration files supplied, making the minimum
219 changes necessary. Complete customization can be done after you have Bacula
220 up and running. Please take care when modifying passwords, which were
221 randomly generated, and the {\bf Name}s as the passwords and names must agree
222 between the configuration files for security reasons.
223 \item Create the Bacula MySQL database and tables (if using MySQL)
224 \ilink{Installing and Configuring MySQL Phase II}{mysql_phase2} or
225 create the Bacula PostgreSQL database and tables
226 \ilink{Installing and Configuring PostgreSQL Phase
227 II}{PostgreSQL_phase2} or alternatively if you are using
229 \ilink{Installing and Configuring SQLite Phase II}{phase2}.
230 \item Start Bacula ({\bf ./bacula start}) Note. the next chapter shows you
231 how to do this in detail.
232 \item Interface with Bacula using the Console program
233 \item For the previous two items, please follow the instructions in the
234 \ilink{Running Bacula}{_ChapterStart1} chapter of this manual,
235 where you will run a simple backup and do a restore. Do this before you make
236 heavy modifications to the configuration files so that you are sure that
237 Bacula works and are familiar with it. After that changing the conf files
239 \item If after installing Bacula, you decide to "move it", that is to
240 install it in a different set of directories, proceed as follows:
246 ./configure (your-new-options)
255 If all goes well, the {\bf ./configure} will correctly determine which
256 operating system you are running and configure the source code appropriately.
257 Currently, FreeBSD, Linux (RedHat), and Solaris are supported. MacOS X 10.3 is
258 reported to work with the Client only as long as readline support is disabled.
261 If you install Bacula on more than one system, and they are identical, you can
262 simply transfer the source tree to that other system and do a "make
263 install". However, if there are differences in the libraries or OS versions,
264 or you wish to install on a different OS, you should start from the original
265 compress tar file. If you do transfer the source tree, and you have previously
266 done a ./configure command, you MUST do:
274 prior to doing your new ./configure. This is because the GNU autoconf tools
275 cache the configuration, and if you re-use a configuration for a Linux machine
276 on a Solaris, you can be sure your build will fail. To avoid this, as
277 mentioned above, either start from the tar file, or do a "make distclean".
279 In general, you will probably want to supply a more complicated {\bf
280 configure} statement to ensure that the modules you want are built and that
281 everything is placed into the correct directories.
283 For example, on RedHat, one could use the following:
289 --sbindir=$HOME/bacula/bin \
290 --sysconfdir=$HOME/bacula/bin \
291 --with-pid-dir=$HOME/bacula/bin/working \
292 --with-subsys-dir=$HOME/bacula/bin/working \
293 --with-mysql=$HOME/mysql \
294 --with-working-dir=$HOME/bacula/bin/working \
295 --with-dump-email=$USER
299 Note, the advantage of using the above configuration to start is that
300 everything will be put into a single directory, which you can later delete
301 once you have run the examples in the next chapter and learned how Bacula
302 works. In addition, the above can be installed and run as non-root.
304 For the developer's convenience, I have added a {\bf defaultconfig} script to
305 the {\bf examples} directory. This script contains the statements that you
306 would normally use, and each developer/user may modify them to suit his needs.
307 You should find additional useful examples in this directory as well.
309 The {\bf \verb:--:enable-conio} or {\bf \verb:--:enable-readline} options are useful because
310 they provide a command line history and editing capability for the Console
311 program. If you have included either option in the build, either the {\bf
312 termcap} or the {\bf ncurses} package will be needed to link. On some systems,
313 such as SuSE, the termcap library is not in the standard library directory. As
314 a consequence, the option may be disabled or you may get an error message such
319 /usr/lib/gcc-lib/i586-suse-linux/3.3.1/.../ld:
320 cannot find -ltermcap
321 collect2: ld returned 1 exit status
325 while building the Bacula Console. In that case, you will need to set the {\bf
326 LDFLAGS} environment variable prior to building.
330 export LDFLAGS="-L/usr/lib/termcap"
334 The same library requirements apply if you wish to use the readline
335 subroutines for command line editing and history or
336 if you are using a MySQL library that requires encryption. If you need encryption,
337 you can either export the appropriate additional library options as shown
338 above or, alternatively, you can include them directly on the ./configure line
343 LDFLAGS="-lssl -lcyrpto" \
349 On some systems such as Mandriva, readline tends to
350 gobble up prompts, which makes it totally useless. If this happens to you, use
351 the disable option, or if you are using version 1.33 and above try using {\bf
352 \verb:--:enable-conio} to use a built-in readline replacement. You will still need
353 either the termcap or the ncurses library, but it is unlikely that the {\bf conio}
354 package will gobble up prompts.
356 readline is no longer supported after version 1.34. The code is still
357 available and if users submit patches for it, I will be happy to apply them.
358 However, due to the fact that each version of readline seems to be
359 incompatible with previous versions, and that there are significant
360 differences between systems, I can no longer afford to support it.
362 \subsection*{What Database to Use?}
364 \index[general]{What Database to Use? }
365 \index[general]{Use!What Database to }
366 \addcontentsline{toc}{subsection}{What Database to Use?}
368 Before building Bacula you need to decide if you want to use SQLite, MySQL, or
369 PostgreSQL. If you are not already running MySQL or PostgreSQL, you might
370 want to start by testing with SQLite. This will greatly simplify the setup for you
371 because SQLite is compiled into Bacula an requires no administration. It
372 performs well and is suitable for small to medium sized installations (maximum
373 10-20 machines). However, we should note that a number of users have
374 had unexplained database corruption with SQLite. For that reason, we
375 recommend that you install either MySQL or PostgreSQL for production
378 If you wish to use MySQL as the Bacula catalog, please see the
379 \ilink{Installing and Configuring MySQL}{_ChapterStart} chapter of
380 this manual. You will need to install MySQL prior to continuing with the
381 configuration of Bacula. MySQL is a high quality database that is very
382 efficient and is suitable for any sized installation. It is slightly more
383 complicated than SQLite to setup and administer because it has a number of
384 sophisticated features such as userids and passwords. It runs as a separate
385 process, is truly professional and can manage a database of any size.
387 If you wish to use PostgreSQL as the Bacula catalog, please see the
388 \ilink{Installing and Configuring PostgreSQL}{_ChapterStart10}
389 chapter of this manual. You will need to install PostgreSQL prior to
390 continuing with the configuration of Bacula. PostgreSQL is very similar to
391 MySQL, though it tends to be slightly more SQL92 compliant and has many more
392 advanced features such as transactions, stored procedures, and the such. It
393 requires a certain knowledge to install and maintain. There are some important
394 performance problems with PostgreSQL in Bacula versions prior to 1.35.5.
396 If you wish to use SQLite as the Bacula catalog, please see
397 \ilink{Installing and Configuring SQLite}{_ChapterStart33} chapter of
400 \subsection*{Quick Start}
401 \index[general]{Quick Start }
402 \index[general]{Start!Quick }
403 \addcontentsline{toc}{subsection}{Quick Start}
405 There are a number of options and important considerations given below
406 that you can skip for the moment if you have not had any problems building
407 Bacula with a simplified configuration as shown above.
409 If you want to dive right into it, we recommend you skip to the next chapter,
410 and run the example program. It will teach you a lot about Bacula and as an
411 example can be installed into a single directory (for easy removal) and run as
412 non-root. If you have any problems or when you want to do a real installation,
413 come back to this chapter and read the details presented below.
415 \subsection*{Configure Options}
417 \index[general]{Options!Configure }
418 \index[general]{Configure Options }
419 \addcontentsline{toc}{subsection}{Configure Options}
421 The following command line options are available for {\bf configure} to
422 customize your installation.
426 \item [ {-}{-}sysbindir=\lt{}binary-path\gt{}]
427 \index[general]{{-}{-}sysbindir }
428 Defines where the Bacula binary (executable) files will be placed during a
429 {\bf make install} command.
431 \item [ {-}{-}sysconfdir=\lt{}config-path\gt{}]
432 \index[general]{{-}{-}sysconfdir }
433 Defines where the Bacula configuration files should be placed during a {\bf
434 make install} command.
436 \item [ {-}{-}enable-smartalloc ]
437 \index[general]{{-}{-}enable-smartalloc }
438 This enables the inclusion of the Smartalloc orphaned buffer detection code.
439 This option is highly recommended. Because we never build without this
440 option, you may experience problems if it is not enabled. In this case,
441 simply re-enable the option. We strongly recommend keeping this option
442 enabled as it helps detect memory leaks. This configuration parameter is used
443 while building Bacula
445 \item [ {-}{-}enable-gnome ]
446 \index[general]{{-}{-}enable-gnome }
447 If you have GNOME installed on your computer and you want to use the GNOME
448 GUI Console interface to Bacula, you must specify this option. Doing so will
449 build everything in the {\bf src/gnome-console} directory.
451 \item [ {-}{-}enable-wx-console ]
452 \index[general]{{-}{-}enable-wx-console }
453 If you have wxWidgets installed on your computer and you want to use the
454 wxWidgets GUI Console interface to Bacula, you must specify this option.
455 Doing so will build everything in the {\bf src/wx-console} directory. This
456 could also be useful to users who want a GUI Console and don't want to
457 install Gnome, as wxWidgets can work with GTK+, Motif or even X11 libraries.
460 \item [ {-}{-}enable-tray-monitor ]
461 \index[general]{{-}{-}enable-tray-monitor }
462 If you have GTK installed on your computer, you run a graphical environment
463 or a window manager compatible with the FreeDesktop system tray standard
464 (like KDE and GNOME) and you want to use a GUI to monitor Bacula daemons, you
465 must specify this option. Doing so will build everything in the {\bf
466 src/tray-monitor} directory.
468 \item [ {-}{-}enable-static-tools]
469 \index[general]{{-}{-}enable-static-tools }
470 This option causes the linker to link the Storage daemon utility tools ({\bf
471 bls}, {\bf bextract}, and {\bf bscan}) statically. This permits using them
472 without having the shared libraries loaded. If you have problems linking in
473 the {\bf src/stored} directory, make sure you have not enabled this option,
474 or explicitly disable static linking by adding {\bf \verb:--:disable-static-tools}.
477 \item [ {-}{-}enable-static-fd]
478 \index[general]{{-}{-}enable-static-fd }
479 This option causes the make process to build a {\bf static-bacula-fd} in
480 addition to the standard File daemon. This static version will include
481 statically linked libraries and is required for the Bare Metal recovery. This
482 option is largely superseded by using {\bf make static-bacula-fd} from with
483 in the {\bf src/filed} directory. Also, the {\bf \verb:--:enable-client-only} option
484 described below is useful for just building a client so that all the other
485 parts of the program are not compiled.
487 \item [ {-}{-}enable-static-sd]
488 \index[general]{{-}{-}enable-static-sd }
489 This option causes the make process to build a {\bf static-bacula-sd} in
490 addition to the standard Storage daemon. This static version will include
491 statically linked libraries and could be useful during a Bare Metal recovery.
494 \item [ {-}{-}enable-static-dir]
495 \index[general]{{-}{-}enable-static-dir }
496 This option causes the make process to build a {\bf static-bacula-dir} in
497 addition to the standard Director. This static version will include
498 statically linked libraries and could be useful during a Bare Metal recovery.
501 \item [ {-}{-}enable-static-cons]
502 \index[general]{{-}{-}enable-static-cons }
503 This option causes the make process to build a {\bf static-console} and a
504 {\bf static-gnome-console} in addition to the standard console. This static
505 version will include statically linked libraries and could be useful during a
508 \item [ {-}{-}enable-client-only]
509 \index[general]{{-}{-}enable-client-only }
510 This option causes the make process to build only the File daemon and the
511 libraries that it needs. None of the other daemons, storage tools, nor the
512 console will be built. Likewise a {\bf make install} will then only install
513 the File daemon. To cause all daemons to be built, you will need to do a
514 configuration without this option. This option greatly facilitates building a
515 Client on a client only machine.
517 \item [ {-}{-}enable-largefile]
518 \index[general]{{-}{-}enable-largefile }
519 This option (default) causes Bacula to be built with 64 bit file address
520 support if it is available on your system. This permits Bacula to read and
521 write files greater than 2 GBytes in size. You may disable this feature and
522 revert to 32 bit file addresses by using {\bf \verb:--:disable-largefile}.
524 \item [ {-}{-}with-sqlite=\lt{}sqlite-path\gt{}]
525 \index[general]{{-}{-}with-sqlite }
526 This enables use of the SQLite version 2.8.x database. The {\bf sqlite-path} is not
527 normally specified as Bacula looks for the necessary components in a
528 standard location ({\bf depkgs/sqlite}). See
529 \ilink{Installing and Configuring SQLite}{_ChapterStart33} chapter of
530 this manual for more details.
532 \item [ {-}{-}with-sqlite3=\lt{}sqlite3-path\gt{}]
533 \index[general]{{-}{-}with-sqlite3 }
534 This enables use of the SQLite version 3.x database. The {\bf sqlite3-path} is not
535 normally specified as Bacula looks for the necessary components in a
536 standard location ({\bf depkgs/sqlite3}). Although Bacula will run
537 with SQLite version 3.x, our testing shows that it is 4 to 10 times
538 slower than version 2.8.x and consequently, we do not recommend using
540 \ilink{Installing and Configuring SQLite}{_ChapterStart33} chapter of
541 this manual for more details.
543 \item [ {-}{-}with-mysql=\lt{}mysql-path\gt{}]
544 \index[general]{{-}{-}with-mysql }
545 This enables building of the Catalog services for Bacula. It assumes that
546 MySQL is running on your system, and expects it to be installed in the {\bf
547 mysql-path} that you specify. If this option is not present, the build will
548 automatically include the internal Bacula database code. We recommend that
549 you use this option if possible. If you do use this option, please proceed to
550 installing MySQL in the
551 \ilink{Installing and Configuring MySQL}{_ChapterStart} chapter
552 before proceeding with the configuration.
554 \item [ {-}{-}with-openssl=\lt{}path\gt{}]
555 This configuration option is necessary if you want to enable TLS (ssl)
556 in Bacula. Normally, the {\bf path} specification is not necessary since
557 the configuration searches for the OpenSSL libraries in standard system
558 locations. Enabling OpenSSL in Bacula permits secure communications
559 between the daemons. For more information on using TLS, please see the
560 \ilink{Bacula TLS}{_ChapterStart61} chapter of this manual.
562 \item [ {-}{-}with-postgresql=\lt{}path\gt{}]
563 \index[general]{{-}{-}with-postgresql }
564 This provides an explicit path to the PostgreSQL libraries if Bacula cannot
567 \item [ {-}{-}with-python=\lt{}path\gt{}]
568 \index[general]{{-}{-}with-python }
569 This option enables Bacula support for Python. If no path is
570 supplied, configure will search the
571 standard library locations for Python 2.2, 2.3, or 2.4. If it cannot
572 find the library, you will need to supply a path to your Python
573 library directory. Please see the
574 \ilink{Python chapter}{_ChapterStart60} for the details of using
577 \item [ {-}{-}enable-conio]
578 \index[general]{{-}{-}enable-conio }
579 Tells Bacula to enable building the small, light weight readline replacement
580 routine. It is generally much easier to configure than readline, although,
581 like readline, it needs either the termcap or ncurses library.
583 \item [ {-}{-}with-readline=\lt{}readline-path\gt{}]
584 \index[general]{{-}{-}with-readline }
585 Tells Bacula where {\bf readline} is installed. Normally, Bacula will find
586 readline if it is in a standard library. If it is not found and no
587 \verb:--:with-readline is specified, readline will be disabled. This option affects
588 the Bacula build. Readline provides the Console program with a command line
589 history and editing capability and is no longer supported, so you are on your
590 own if you have problems.
592 \item [ {-}{-}enable-readline]
593 \index[general]{{-}{-}enable-readline }
594 Tells Bacula to enable readline support. It is normally disabled due to the
595 large number of configuration problems and the fact that the package seems to
596 change in incompatible ways from version to version.
598 \item [ {-}{-}with-tcp-wrappers=\lt{}path\gt{}]
599 \index[general]{{-}{-}with-tcp-wrappers }
600 This specifies that you want TCP wrappers (man hosts\_access(5)) compiled in.
601 The path is optional since Bacula will normally find the libraries in the
602 standard locations. This option affects the Bacula build. In specifying your
603 restrictions in the {\bf /etc/hosts.allow} or {\bf /etc/hosts.deny} files, do
604 not use the {\bf twist} option (hosts\_options(5)) or the Bacula process will
605 be terminated. Note, when setting up your {\bf /etc/hosts.allow}
606 or {\bf /etc/hosts.deny}, you must identify the Bacula daemon in
607 question with the name you give it in your conf file rather than the
608 name of the executable.
610 For more information on configuring and testing TCP wrappers, please see the
611 \ilink{Configuring and Testing TCP Wrappers}{wrappers} section
612 in the Security Chapter.
614 \item [ {-}{-}with-working-dir=\lt{}working-directory-path\gt{} ]
615 \index[general]{{-}{-}with-working-dir }
616 This option is mandatory and specifies a directory into which Bacula may
617 safely place files that will remain between Bacula executions. For example,
618 if the internal database is used, Bacula will keep those files in this
619 directory. This option is only used to modify the daemon configuration
620 files. You may also accomplish the same thing by directly editing them later.
621 The working directory is not automatically created by the install process, so
622 you must ensure that it exists before using Bacula for the first time.
624 \item [ {-}{-}with-base-port=\lt{}port=number\gt{}]
625 \index[general]{{-}{-}with-base-port }
626 In order to run, Bacula needs three TCP/IP ports (one for the Bacula
627 Console, one for the Storage daemon, and one for the File daemon). The {\bf
628 \verb:--:with-baseport} option will automatically assign three ports beginning at
629 the base port address specified. You may also change the port number in the
630 resulting configuration files. However, you need to take care that the
631 numbers correspond correctly in each of the three daemon configuration
632 files. The default base port is 9101, which assigns ports 9101 through 9103.
633 These ports (9101, 9102, and 9103) have been officially assigned to Bacula by
634 IANA. This option is only used to modify the daemon configuration files. You
635 may also accomplish the same thing by directly editing them later.
637 \item [ {-}{-}with-dump-email=\lt{}email-address\gt{}]
638 \index[general]{{-}{-}with-dump-email }
639 This option specifies the email address where any core dumps should be set.
640 This option is normally only used by developers.
642 \item [ {-}{-}with-pid-dir=\lt{}PATH\gt{} ]
643 \index[general]{{-}{-}with-pid-dir }
644 This specifies where Bacula should place the process id file during
645 execution. The default is: {\bf /var/run}. This directory is not created by
646 the install process, so you must ensure that it exists before using Bacula
649 \item [ {-}{-}with-subsys-dir=\lt{}PATH\gt{}]
650 \index[general]{{-}{-}with-subsys-dir }
651 This specifies where Bacula should place the subsystem lock file during
652 execution. The default is {\bf /var/run/subsys}. Please make sure that you do
653 not specify the same directory for this directory and for the {\bf sbindir}
654 directory. This directory is used only within the autostart scripts. The
655 subsys directory is not created by the Bacula install, so you must be sure to
656 create it before using Bacula.
658 \item [ {-}{-}with-dir-password=\lt{}Password\gt{}]
659 \index[general]{{-}{-}with-dir-password }
660 This option allows you to specify the password used to access the Directory
661 (normally from the Console program). If it is not specified, configure will
662 automatically create a random password.
664 \item [ {-}{-}with-fd-password=\lt{}Password\gt{} ]
665 \index[general]{{-}{-}with-fd-password }
666 This option allows you to specify the password used to access the File daemon
667 (normally called from the Director). If it is not specified, configure will
668 automatically create a random password.
670 \item [ {-}{-}with-sd-password=\lt{}Password\gt{} ]
671 \index[general]{{-}{-}with-sd-password }
672 This option allows you to specify the password used to access the Directory
673 (normally called from the Director). If it is not specified, configure will
674 automatically create a random password.
676 \item [ {-}{-}with-dir-user=\lt{}User\gt{} ]
677 \index[general]{{-}{-}with-dir-user }
678 This option allows you to specify the Userid used to run the Director. The
679 Director must be started as root, but doesn't need to run as root, and after
680 doing preliminary initializations, it can "drop" to the UserId specified on
683 \item [ {-}{-}with-dir-group=\lt{}Group\gt{} ]
684 \index[general]{{-}{-}with-dir-group }
685 This option allows you to specify the GroupId used to run the Director. The
686 Director must be started as root, but doesn't need to run as root, and after
687 doing preliminary initializations, it can "drop" to the GroupId specified
690 \item [ {-}{-}with-sd-user=\lt{}User\gt{} ]
691 \index[general]{{-}{-}with-sd-user }
692 This option allows you to specify the Userid used to run the Storage daemon.
693 The Storage daemon must be started as root, but doesn't need to run as root,
694 and after doing preliminary initializations, it can "drop" to the UserId
695 specified on this option. If you use this option, you will need to take care
696 that the Storage daemon has access to all the devices (tape drives, ...) that
699 \item [ {-}{-}with-sd-group=\lt{}Group\gt{} ]
700 \index[general]{{-}{-}with-sd-group }
701 This option allows you to specify the GroupId used to run the Storage daemon.
702 The Storage daemon must be started as root, but doesn't need to run as root,
703 and after doing preliminary initializations, it can "drop" to the GroupId
704 specified on this option.
706 \item [ {-}{-}with-fd-user=\lt{}User\gt{} ]
707 \index[general]{{-}{-}with-fd-user }
708 This option allows you to specify the Userid used to run the File daemon. The
709 File daemon must be started as root, and in most cases, it needs to run as
710 root, so this option is used only in very special cases, after doing
711 preliminary initializations, it can "drop" to the UserId specified on this
714 \item [ {-}{-}with-fd-group=\lt{}Group\gt{} ]
715 \index[general]{{-}{-}with-fd-group }
716 This option allows you to specify the GroupId used to run the File daemon.
717 The File daemon must be started as root, and in most cases, it must be run as
718 root, however, after doing preliminary initializations, it can "drop" to
719 the GroupId specified on this option.
723 Note, many other options are presented when you do a {\bf ./configure \verb:--:help},
724 but they are not implemented.
726 \subsection*{Recommended Options for most Systems}
727 \index[general]{Systems!Recommended Options for most }
728 \index[general]{Recommended Options for most Systems }
729 \addcontentsline{toc}{subsection}{Recommended Options for most Systems}
731 For most systems, we recommend starting with the following options:
736 --enable-smartalloc \
737 --sbindir=$HOME/bacula/bin \
738 --sysconfdir=$HOME/bacula/bin \
739 --with-pid-dir=$HOME/bacula/bin/working \
740 --with-subsys-dir=$HOME/bacula/bin/working \
741 --with-mysql=$HOME/mysql \
742 --with-working-dir=$HOME/bacula/working
746 If you want to install Bacula in an installation directory rather than run it
747 out of the build directory (as developers will do most of the time), you
748 should also include the \verb:--:sbindir and \verb:--:sysconfdir options with appropriate
749 paths. Neither are necessary if you do not use "make install" as is the case
750 for most development work. The install process will create the sbindir and
751 sysconfdir if they do not exist, but it will not automatically create the
752 pid-dir, subsys-dir, or working-dir, so you must ensure that they exist before
753 running Bacula for the first time. See below for an example of how Kern does
757 \index[general]{RedHat }
758 \addcontentsline{toc}{subsection}{RedHat}
765 CFLAGS="-g -Wall" ./configure \
766 --sbindir=$HOME/bacula/bin \
767 --sysconfdir=$HOME/bacula/bin \
768 --enable-smartalloc \
769 --with-sqlite=$HOME/bacula/depkgs/sqlite \
770 --with-working-dir=$HOME/bacula/working \
771 --with-pid-dir=$HOME/bacula/bin/working \
772 --with-subsys-dir=$HOME/bacula/bin/working \
783 CFLAGS="-g -Wall" ./configure \
784 --sbindir=$HOME/bacula/bin \
785 --sysconfdir=$HOME/bacula/bin \
786 --enable-smartalloc \
787 --with-mysql=$HOME/mysql \
788 --with-working-dir=$HOME/bacula/working
789 --with-pid-dir=$HOME/bacula/bin/working \
790 --with-subsys-dir=$HOME/bacula/bin/working
796 or finally, a completely traditional RedHat Linux install:
800 CFLAGS="-g -Wall" ./configure \
802 --sbindir=/usr/sbin \
803 --sysconfdir=/etc/bacula \
804 --with-scriptdir=/etc/bacula \
805 --enable-smartalloc \
808 --with-working-dir=/var/bacula \
809 --with-pid-dir=/var/run \
810 --with-subsys-dir=/var/lock/subsys \
815 Note, Bacula assumes that /var/bacula, /var/run, and /var/loc/subsys exist so
816 it will not automatically create them during the install process.
818 \subsection*{Solaris}
819 \index[general]{Solaris }
820 \addcontentsline{toc}{subsection}{Solaris}
822 To build Bacula from source, you will need the following installed on your
823 system (they are not by default): libiconv, gcc 3.3.2, stdc++, libgcc (for
824 stdc++ and gcc\_s libraries), make 3.8 or later.
826 You will probably also need to: Add /usr/local/bin to PATH and Add
827 /usr/ccs/bin to PATH for ar.
832 CFLAGS="-g" ./configure \
833 --sbindir=$HOME/bacula/bin \
834 --sysconfdir=$HOME/bacula/bin \
835 --with-mysql=$HOME/mysql \
836 --enable-smartalloc \
837 --with-pid-dir=$HOME/bacula/bin/working \
838 --with-subsys-dir=$HOME/bacula/bin/working \
839 --with-working-dir=$HOME/bacula/working
843 As mentioned above, the install process will create the sbindir and sysconfdir
844 if they do not exist, but it will not automatically create the pid-dir,
845 subsys-dir, or working-dir, so you must ensure that they exist before running
846 Bacula for the first time.
848 \subsection*{FreeBSD}
849 \index[general]{FreeBSD }
850 \addcontentsline{toc}{subsection}{FreeBSD}
853 \elink{The FreeBSD Diary}{http://www.freebsddiary.org/bacula.php} for a
854 detailed description on how to make Bacula work on your system. In addition,
855 users of FreeBSD prior to 4.9-STABLE dated Mon Dec 29 15:18:01 2003 UTC who
856 plan to use tape devices, please see the
857 \ilink{Tape Testing Chapter}{FreeBSDTapes} of this manual for
858 {\bf important} information on how to configure your tape drive for
859 compatibility with Bacula.
861 If you are using Bacula with MySQL, you should take care to compile MySQL with
862 FreeBSD native threads rather than LinuxThreads, since Bacula is normally built
863 with FreeBSD native threads rather than LinuxTreads. Mixing the two will
867 \index[general]{Win32 }
868 \addcontentsline{toc}{subsection}{Win32}
870 To install the binary Win32 version of the File daemon please see the
871 \ilink{Win32 Installation Chapter}{_ChapterStart7} in this document.
873 \subsection*{Windows Systems with CYGWIN Installed}
875 \index[general]{Windows Systems with CYGWIN Installed }
876 \index[general]{Installed!Windows Systems with CYGWIN }
877 \addcontentsline{toc}{subsection}{Windows Systems with CYGWIN Installed}
879 As of version 1.34, Bacula no longer uses CYGWIN for the Win32 File daemon.
880 However, it is still built under a CYGWIN build environment -- though you can
881 probably do it with VC Studio only. If you wish to build the Win32 File daemon
882 from the source, you will need Microsoft C++ version 6.0 or greater. In Bacula
883 prior to version 1.33, CYGWIN was used. Details for building it are in the
884 README.win32 file of the src/win32 directory.
886 Note, although most parts of Bacula build on Windows systems, the only part
887 that we have tested and used is the File daemon.
889 Finally, you should follow the installation instructions in the
890 \ilink{Win32 Installation}{_ChapterStart7} section of this document.
892 \subsection*{Kern's Configure Script}
893 \index[general]{Script!Kern's Configure }
894 \index[general]{Kern's Configure Script }
895 \addcontentsline{toc}{subsection}{Kern's Configure Script}
897 The script that I use for building on my "production" Linux machines is:
902 # This is Kern's configure script for Bacula
905 --sbindir=$HOME/bacula/bin \
906 --sysconfdir=$HOME/bacula/bin \
907 --enable-smartalloc \
909 --with-pid-dir=$HOME/bacula/bin/working \
910 --with-subsys-dir=$HOME/bacula/bin/working \
911 --with-mysql=$HOME/mysql \
912 --with-working-dir=$HOME/bacula/bin/working \
913 --with-dump-email=$USER \
914 --with-smtp-host=mail.your-site.com \
920 Note that I define the base port as 9101, which means that Bacula will use
921 port 9101 for the Director console, port 9102 for the File daemons, and port
922 9103 for the Storage daemons. These ports should be available on all systems
923 because they have been officially assigned to Bacula by IANA (Internet
924 Assigned Numbers Authority). We strongly recommend that you use only these
925 ports to prevent any conflicts with other programs. This is in fact the
926 default if you do not specify a {\bf \verb:--:with-baseport} option.
928 You may also want to put the following entries in your {\bf /etc/services}
929 file as it will make viewing the connections made by Bacula easier to
930 recognize (i.e. netstat -a):
940 \subsection*{Installing Bacula}
941 \index[general]{Bacula!Installing }
942 \index[general]{Installing Bacula }
943 \addcontentsline{toc}{subsection}{Installing Bacula}
945 Before setting up your configuration files, you will want to install Bacula in
946 its final location. Simply enter:
954 If you have previously installed Bacula, the old binaries will be overwritten,
955 but the old configuration files will remain unchanged, and the "new"
956 configuration files will be appended with a {\bf .new}. Generally if you have
957 previously installed and run Bacula you will want to discard or ignore the
958 configuration files with the appended {\bf .new}.
960 \subsection*{Building a File Daemon or Client}
961 \index[general]{Client!Building a File Daemon or }
962 \index[general]{Building a File Daemon or Client }
963 \addcontentsline{toc}{subsection}{Building a File Daemon or Client}
965 If you run the Director and the Storage daemon on one machine and you wish to
966 back up another machine, you must have a copy of the File daemon for that
967 machine. If the machine and the Operating System are identical, you can simply
968 copy the Bacula File daemon binary file {\bf bacula-fd} as well as its
969 configuration file {\bf bacula-fd.conf} then modify the name and password in
970 the conf file to be unique. Be sure to make corresponding additions to the
971 Director's configuration file ({\bf bacula-dir.conf}).
973 If the architecture or the O/S level are different, you will need to build a
974 File daemon on the Client machine. To do so, you can use the same {\bf
975 ./configure} command as you did for your main program, starting either from a
976 fresh copy of the source tree, or using {\bf make\ distclean} before the {\bf
979 Since the File daemon does not access the Catalog database, you can remove the
980 {\bf \verb:--:with-mysql} or {\bf \verb:--:with-sqlite} options, then add {\bf
981 \verb:--:enable-client-only}. This will compile only the necessary libraries and the
982 client programs and thus avoids the necessity of installing one or another of
983 those database programs to build the File daemon. With the above option, you
984 simply enter {\bf make} and just the client will be built.
987 \subsection*{Auto Starting the Daemons}
988 \index[general]{Daemons!Auto Starting the }
989 \index[general]{Auto Starting the Daemons }
990 \addcontentsline{toc}{subsection}{Auto Starting the Daemons}
992 If you wish the daemons to be automatically started and stopped when your
993 system is booted (a good idea), one more step is necessary. First, the
994 ./configure process must recognize your system -- that is it must be a
995 supported platform and not {\bf unknown}, then you must install the platform
996 dependent files by doing:
1001 make install-autostart
1005 Please note, that the auto-start feature is implemented only on systems that
1006 we officially support (currently, FreeBSD, RedHat/Fedora Linux, and Solaris), and has
1007 only been fully tested on Fedora Linux.
1009 The {\bf make install-autostart} will cause the appropriate startup scripts to
1010 be installed with the necessary symbolic links. On RedHat/Fedora Linux systems, these
1011 scripts reside in {\bf /etc/rc.d/init.d/bacula-dir} {\bf
1012 /etc/rc.d/init.d/bacula-fd}, and {\bf /etc/rc.d/init.d/bacula-sd}. However the
1013 exact location depends on what operating system you are using.
1015 If you only wish to install the File daemon, you may do so with:
1019 make install-autostart-fd
1023 \subsection*{Other Make Notes}
1024 \index[general]{Notes!Other Make }
1025 \index[general]{Other Make Notes }
1026 \addcontentsline{toc}{subsection}{Other Make Notes}
1028 To simply build a new executable in any directory, enter:
1036 To clean out all the objects and binaries (including the files named 1, 2, or
1037 3, which Kern uses as temporary files), enter:
1045 To really clean out everything for distribution, enter:
1053 note, this cleans out the Makefiles and is normally done from the top level
1054 directory to prepare for distribution of the source. To recover from this
1055 state, you must redo the {\bf ./configure} in the top level directory, since
1056 all the Makefiles will be deleted.
1058 To add a new file in a subdirectory, edit the Makefile.in in that directory,
1059 then simply do a {\bf make}. In most cases, the make will rebuild the Makefile
1060 from the new Makefile.in. In some case, you may need to issue the {\bf make} a
1061 second time. In extreme cases, cd to the top level directory and enter: {\bf
1064 To add dependencies:
1072 The {\bf make depend} appends the header file dependencies for each of the
1073 object files to Makefile and Makefile.in. This command should be done in each
1074 directory where you change the dependencies. Normally, it only needs to be run
1075 when you add or delete source or header files. {\bf make depend} is normally
1076 automatically invoked during the configuration process.
1086 This not normally done if you are developing Bacula, but is used if you are
1087 going to run it to backup your system.
1089 After doing a {\bf make install} the following files will be installed on your
1090 system (more or less). The exact files and location (directory) for each file
1091 depends on your {\bf ./configure} command (e.g. gnome-console and
1092 gnome-console.conf are not installed if you do not configure GNOME. Also, if
1093 you are using SQLite instead of mysql, some of the files will be different).
1114 create_mysql_database
1116 delete_catalog_backup
1137 \subsection*{Installing Tray Monitor}
1138 \index[general]{Monitor!Installing Tray }
1139 \index[general]{Installing Tray Monitor }
1140 \addcontentsline{toc}{subsection}{Installing Tray Monitor}
1142 The Tray Monitor is already installed if you used the {\bf
1143 \verb:--:enable-tray-monitor} configure option and ran {\bf make install}.
1145 As you don't run your graphical environment as root (if you do, you should
1146 change that bad habit), don't forget to allow your user to read {\bf
1147 tray-monitor.conf}, and to execute {\bf bacula-tray-monitor} (this is not a
1150 Then log into your graphical environment (KDE, Gnome or something else), run
1151 {\bf bacula-tray-monitor} as your user, and see if a cassette icon appears
1152 somewhere on the screen, usually on the task bar.
1153 If it doesn't, follow the instructions below related to your environment or
1156 \subsubsection*{GNOME}
1157 \index[general]{GNOME }
1158 \addcontentsline{toc}{subsubsection}{GNOME}
1160 System tray, or notification area if you use the GNOME terminology, has been
1161 supported in GNOME since version 2.2. To activate it, right-click on one of
1162 your panels, open the menu {\bf Add to this Panel}, then {\bf Utility} and
1163 finally click on {\bf Notification Area}.
1165 \subsubsection*{KDE}
1166 \index[general]{KDE }
1167 \addcontentsline{toc}{subsubsection}{KDE}
1169 System tray has been supported in KDE since version 3.1. To activate it,
1170 right-click on one of your panels, open the menu {\bf Add}, then {\bf Applet}
1171 and finally click on {\bf System Tray}.
1173 \subsubsection*{Other window managers}
1174 \index[general]{Managers!Other window }
1175 \index[general]{Other window managers }
1176 \addcontentsline{toc}{subsubsection}{Other window managers}
1178 Read the documentation to know if the Freedesktop system tray standard is
1179 supported by your window manager, and if applicable, how to activate it.
1181 \subsection*{Modifying the Bacula Configuration Files}
1182 \index[general]{Modifying the Bacula Configuration Files }
1183 \index[general]{Files!Modifying the Bacula Configuration }
1184 \addcontentsline{toc}{subsection}{Modifying the Bacula Configuration Files}
1187 \ilink{Configuring Bacula}{_ChapterStart16} in this manual for
1188 instructions on how to set Bacula configuration files.