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}
17 to build properly depending on the options you specify. To simplify your task,
18 we have combined a number of these packages into two {\bf depkgs} releases
19 (Dependency Packages). This can vastly simplify your life by providing you
20 with all the necessary packages rather than requiring you to find them on the
21 Web, load them, and install them.
24 \subsection*{Upgrading Bacula}
25 \index[general]{Bacula!Upgrading }
26 \index[general]{Upgrading Bacula }
27 \addcontentsline{toc}{subsection}{Upgrading Bacula}
29 If you are upgrading from one Bacula version to another, you should first
30 carefully read the ReleaseNotes of all versions between your current version
31 and the version to which you are upgrading. If the Bacula catalog database has
32 been upgraded, you will either need to reinitialize your database starting
33 from scratch, or save an ASCII copy of your database, then proceed to upgrade
34 it. If there are several database upgrades between your version and the
35 version to which you are upgrading, you will need to apply each database
36 upgrade script. For your convenience, you can find all the old upgrade scripts
37 in the {\bf upgradedb} directory of the source code. You will need to edit the
38 scripts to correspond to your system configuration. The final upgrade script,
39 if any, will be in the {\bf src/cats} directory as described in the
42 If you are upgrading from one major version to another, you will need to
43 replace all your components at the same time as generally the inter-daemon
44 protocol will change. However, within any particular release (e.g. version
45 1.32.x) unless there is an oversight or bug, the daemon protocol will not
46 change. If this is confusing, simply read the ReleaseNotes very carefully as
47 they will note if all daemons must be upgraded at the same time.
49 Finally, please note that in general it is not necessary to do a
50 {\bf make uninstall} before doing an upgrade. In fact, if you do so, you will
51 most likely delete all your conf files, which could be disastrous.
52 For additional information on upgrading, please see the \ilink{Upgrading Bacula
53 Versions}{upgrading} in the Tips chapter of this manual.
56 \subsection*{Dependency Packages}
58 \index[general]{Dependency Packages }
59 \index[general]{Packages!Dependency }
60 \addcontentsline{toc}{subsection}{Dependency Packages}
62 As discussed above, we have combined a number of third party packages that
63 Bacula might need into the {\bf depkgs} and {\bf depkgs1} releases. You can,
64 of course, get the latest packages from the original authors. The locations of
65 where we obtained the packages are in the README file in each package.
66 However, be aware that the packages in the depkgs files have been tested by us
67 for compatibility with Bacula.
69 Typically, a dependency package will be named {\bf depkgs-ddMMMyy.tar.gz} and
70 {\bf depkgs1-ddMMyy.tar.gz} where {\bf dd} is the day we release it, {\bf MMM}
71 is the abbreviated month (e.g. Jan), and {\bf yy} is the year. An actual
72 example is: {\bf depkgs-07Apr02.tar.gz}. To install and build this package (if
73 needed), you do the following:
76 \item Create a {\bf bacula} directory, into which you will place both the
77 Bacula source as well as the dependency package.
78 \item Detar the {\bf depkg} into the {\bf bacula} directory.
79 \item cd bacula/depkgs
83 Although the exact composition of the dependency packages may change from time
84 to time, the current makeup is the following:
86 \addcontentsline{lot}{table}{Depedency Packages}
87 \begin{longtable}{|l|l|l|l|}
89 \multicolumn{1}{|c| }{\bf 3rd Party Package } & \multicolumn{1}{c| }{\bf
90 depkgs } & \multicolumn{1}{c| }{\bf depkgs1 } & \multicolumn{1}{c| }{\bf
92 \hline {SQLite } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } &
93 \multicolumn{1}{c| }{- } \\
94 \hline {mtx } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } &
95 \multicolumn{1}{c| }{- } \\
96 \hline {readline } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{X } &
97 \multicolumn{1}{c| }{- } \\
98 \hline {pthreads } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } &
99 \multicolumn{1}{c| }{X } \\
100 \hline {zlib } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } &
101 \multicolumn{1}{c| }{X } \\
102 \hline {wxWidgits } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } &
103 \multicolumn{1}{c| }{X }
108 Note, some of these packages are quite large, so that building them can be a
109 bit time consuming. The above instructions will build all the packages
110 contained in the directory. However, when building Bacula, it will take only
111 those pieces that it actually needs.
113 Alternatively, you can make just the packages that are needed. For example,
122 will configure and build only the SQLite package.
124 You should build the packages that you will require in {\bf depkgs} and/or
125 {\bf depkgs1} prior to configuring and building Bacula, since Bacula will need
126 them during the build process.
128 Even if you do not use SQLite, you might find it worthwhile to build {\bf mtx}
129 because the {\bf tapeinfo} program that comes with it can often provide you
130 with valuable information about your SCSI tape drive (e.g. compression,
131 min/max block sizes, ...).
133 The {\bf depkgs-win32} package contains the source code for the pthreads and
134 zlib libraries used by the native Win32 client program. It will only be needed
135 if you intend to build the Win32 client from source.
137 \subsection*{Supported Operating Systems}
139 \index[general]{Systems!Supported Operating }
140 \index[general]{Supported Operating Systems }
141 \addcontentsline{toc}{subsection}{Supported Operating Systems}
144 \ilink{ Supported Operating Systems}{SupportedOSes} section
145 of the QuickStart chapter of this manual.
147 \subsection*{Building Bacula from Source}
149 \index[general]{Source!Building Bacula from }
150 \index[general]{Building Bacula from Source }
151 \addcontentsline{toc}{subsection}{Building Bacula from Source}
153 The basic installation is rather simple.
156 \item Install and build any {\bf depkgs} as noted above.
157 \item Configure and install MySQL or PostgreSQL (if desired).
158 \ilink{Installing and Configuring MySQL Phase I}{_ChapterStart} or
159 \ilink{Installing and Configuring PostgreSQL Phase
160 I}{_ChapterStart10}. If you are installing from rpms, and are
161 using MySQL, please be sure to install {\bf mysql-devel}, so that the MySQL
162 header files are available while compiling Bacula. In addition, the MySQL
163 client library {\bf mysqlclient} requires the gzip compression library {\bf
164 libz.a} or {\bf libz.so}. If you are using rpm packages, these libraries are
165 in the {\bf libz-devel} package. On Debian systems, you will need to load the
166 {\bf zlib1g-dev} package. If you are not using rpms or debs, you will need to
167 find the appropriate package for your system.
168 Note, if you already have a running MySQL or PostgreSQL on your system, you
169 can skip this phase provided that you have built the thread safe libraries.
170 And you have already installed the additional rpms noted above.
171 \item As an alternative to MySQL and PostgreSQL, configure and install SQLite,
172 which is part of the {\bf depkgs}.
173 \ilink{Installing and Configuring SQLite}{_ChapterStart33}.
174 \item Detar the Bacula source code preferably into the {\bf bacula} directory
176 \item {\bf cd} to the directory containing the source code.
177 \item ./configure (with appropriate options as described below)
178 \item Check the output of ./configure very carefully, especially the Install
179 binaries and Install config directories. If they are not correct,
180 please rerun ./configure until they are. The output from ./configure is
181 stored in {\bf config.out} and can be re-displayed at any time without
182 rerunning the ./configure by doing {\bf cat config.out}.
183 \item If after running ./configure once, you decide to change options and
184 re-run it, that is perfectly fine, but before re-running it, you should run:
194 so that you are sure to start from scratch and not have a mixture of the two
195 options. This is because ./configure caches much of the information. The {\bf
196 make distclean} is also critical if you move the source dirctory from one
197 machine to another. If the {\bf make distclean} fails, just ignore it and
201 If you get errors while linking in the Storage daemon directory (src/stored),
202 it is probably because you have not loaded the static libraries on your
203 system. I noticed this problem on a Solaris system. To correct it, make sure
204 that you have not added {\bf \verb{--{enable-static-tools} to the {\bf ./configure}
207 \item If you are new to Bacula, we {\bf strongly} recommend that you skip the
208 next step and use the default configuration files, then run the example
209 program in the next chapter, then come back and modify your configuration
210 files to suit your particular needs.
211 \item Customize the configuration files for each of the three daemons
212 (Directory, File, Storage) and for the Console program. For the details of
213 how to do this, please see
214 \ilink{Setting Up Bacula Configuration Files}{_ChapterStart16} in
215 the Configuration chapter of this manual. We recommend that you start by
216 modifying the default configuration files supplied, making the minimum
217 changes necessary. Complete customization can be done after you have Bacula
218 up and running. Please take care when modifying passwords, which were
219 randomly generated, and the {\bf Name}s as the passwords and names must agree
220 between the configuration files for security reasons.
221 \item Create the Bacula MySQL database and tables (if using MySQL)
222 \ilink{Installing and Configuring MySQL Phase II}{mysql_phase2} or
223 create the Bacula PostgreSQL database and tables
224 \ilink{Installing and Configuring PostgreSQL Phase
225 II}{PostgreSQL_phase2} or alternatively if you are using
227 \ilink{Installing and Configuring SQLite Phase II}{phase2}.
228 \item Start Bacula ({\bf ./bacula start}) Note. the next chapter shows you
229 how to do this in detail.
230 \item Interface with Bacula using the Console program
231 \item For the previous two items, please follow the instructions in the
232 \ilink{Running Bacula}{_ChapterStart1} chapter of this manual,
233 where you will run a simple backup and do a restore. Do this before you make
234 heavy modifications to the configuration files so that you are sure that
235 Bacula works and are familiar with it. After that changing the conf files
237 \item If after installing Bacula, you decide to ``move it'', that is to
238 install it in a different set of directories, proceed as follows:
244 ./configure (your-new-options)
253 If all goes well, the {\bf ./configure} will correctly determine which
254 operating system you are running and configure the source code appropriately.
255 Currently, FreeBSD, Linux (RedHat), and Solaris are supported. MacOS X 10.3 is
256 reported to work with the Client only as long as readline support is disabled.
259 If you install Bacula on more than one system, and they are identical, you can
260 simply transfer the source tree to that other system and do a ``make
261 install''. However, if there are differences in the libraries or OS versions,
262 or you wish to install on a different OS, you should start from the original
263 compress tar file. If you do transfer the source tree, and you have previously
264 done a ./configure command, you MUST do:
272 prior to doing your new ./configure. This is because the GNU autoconf tools
273 cache the configuration, and if you re-use a configuration for a Linux machine
274 on a Solaris, you can be sure your build will fail. To avoid this, as
275 mentioned above, either start from the tar file, or do a ``make distclean''.
277 In general, you will probably want to supply a more complicated {\bf
278 configure} statement to ensure that the modules you want are built and that
279 everything is placed into the correct directories.
281 For example, on RedHat, one could use the following:
287 --sbindir=$HOME/bacula/bin \
288 --sysconfdir=$HOME/bacula/bin \
289 --with-pid-dir=$HOME/bacula/bin/working \
290 --with-subsys-dir=$HOME/bacula/bin/working \
291 --with-mysql=$HOME/mysql \
292 --with-working-dir=$HOME/bacula/bin/working \
293 --with-dump-email=$USER
297 Note, the advantage of using the above configuration to start is that
298 everything will be put into a single directory, which you can later delete
299 once you have run the examples in the next chapter and learned how Bacula
300 works. In addition, the above can be installed and run as non-root.
302 For the developer's convenience, I have added a {\bf defaultconfig} script to
303 the {\bf examples} directory. This script contains the statements that you
304 would normally use, and each developer/user may modify them to suit his needs.
305 You should find additional useful examples in this directory as well.
307 The {\bf \verb{--{enable-conio} or {\bf \verb{--{enable-readline} options are useful because
308 they provide a command line history and editing capability for the Console
309 program. If you have included either option in the build, either the {\bf
310 termcap} or the {\bf ncurses} package will be needed to link. On some systems,
311 such as SuSE, the termcap library is not in the standard library directory. As
312 a consequence, the option may be disabled or you may get an error message such
317 /usr/lib/gcc-lib/i586-suse-linux/3.3.1/.../ld:
318 cannot find -ltermcap
319 collect2: ld returned 1 exit status
323 while building the Bacula Console. In that case, you will need to set the {\bf
324 LDFLAGS} environment variable prior to building.
328 export LDFLAGS="-L/usr/lib/termcap"
332 The same library requirements apply if you wish to use the readline
333 subroutines for command line editing and history or
334 if you are using a MySQL library that requires encryption. If you need encryption,
335 you can either export the appropriate additional library options as shown
336 above or, alternatively, you can include them directly on the ./configure line
341 LDFLAGS="-lssl -lcyrpto" \
347 On some systems such as Mandriva, readline tends to
348 gobble up prompts, which makes it totally useless. If this happens to you, use
349 the disable option, or if you are using version 1.33 and above try using {\bf
350 \verb{--{enable-conio} to use a built-in readline replacement. You will still need
351 either the termcap or the ncurses library, but it is unlikely that the {\bf conio}
352 package will gobble up prompts.
354 readline is no longer supported after version 1.34. The code is still
355 available and if users submit patches for it, I will be happy to apply them.
356 However, due to the fact that each version of readline seems to be
357 incompatible with previous versions, and that there are significant
358 differences between systems, I can no longer afford to support it.
360 \subsection*{What Database to Use?}
362 \index[general]{What Database to Use? }
363 \index[general]{Use!What Database to }
364 \addcontentsline{toc}{subsection}{What Database to Use?}
366 Before building Bacula you need to decide if you want to use SQLite, MySQL, or
367 PostgreSQL. If you are not already running MySQL or PostgreSQL, you might
368 want to start by testing with SQLite. This will greatly simplify the setup for you
369 because SQLite is compiled into Bacula an requires no administration. It
370 performs well and is suitable for small to medium sized installations (maximum
371 10-20 machines). However, we should note that a number of users have
372 had unexplained database corruption with SQLite. For that reason, we
373 recommend that you install either MySQL or PostgreSQL for production
376 If you wish to use MySQL as the Bacula catalog, please see the
377 \ilink{Installing and Configuring MySQL}{_ChapterStart} chapter of
378 this manual. You will need to install MySQL prior to continuing with the
379 configuration of Bacula. MySQL is a high quality database that is very
380 efficient and is suitable for any sized installation. It is slightly more
381 complicated than SQLite to setup and administer because it has a number of
382 sophisticated features such as userids and passwords. It runs as a separate
383 process, is truly professional and can manage a database of any size.
385 If you wish to use PostgreSQL as the Bacula catalog, please see the
386 \ilink{Installing and Configuring PostgreSQL}{_ChapterStart10}
387 chapter of this manual. You will need to install PostgreSQL prior to
388 continuing with the configuration of Bacula. PostgreSQL is very similar to
389 MySQL, though it tends to be slightly more SQL92 compliant and has many more
390 advanced features such as transactions, stored procedures, and the such. It
391 requires a certain knowledge to install and maintain. There are some important
392 performance problems with PostgreSQL in Bacula versions prior to 1.35.5.
394 If you wish to use SQLite as the Bacula catalog, please see
395 \ilink{Installing and Configuring SQLite}{_ChapterStart33} chapter of
398 \subsection*{Quick Start}
399 \index[general]{Quick Start }
400 \index[general]{Start!Quick }
401 \addcontentsline{toc}{subsection}{Quick Start}
403 There are a number of options and important considerations given below
404 that you can skip for the moment if you have not had any problems building
405 Bacula with a simplified configuration as shown above.
407 If you want to dive right into it, we recommend you skip to the next chapter,
408 and run the example program. It will teach you a lot about Bacula and as an
409 example can be installed into a single directory (for easy removal) and run as
410 non-root. If you have any problems or when you want to do a real installation,
411 come back to this chapter and read the details presented below.
413 \subsection*{Configure Options}
415 \index[general]{Options!Configure }
416 \index[general]{Configure Options }
417 \addcontentsline{toc}{subsection}{Configure Options}
419 The following command line options are available for {\bf configure} to
420 customize your installation.
424 \item [ \verb?--?sysbindir=\lt{}binary-path\gt{}]
425 \index[dir]{\verb{--{sysbindir }
426 Defines where the Bacula binary (executable) files will be placed during a
427 {\bf make install} command.
429 \item [ \verb?--?sysconfdir=\lt{}config-path\gt{}]
430 \index[dir]{\verb{--{sysconfdir }
431 Defines where the Bacula configuration files should be placed during a {\bf
432 make install} command.
434 \item [ \verb?--?enable-smartalloc ]
435 \index[dir]{\verb{--{enable-smartalloc }
436 This enables the inclusion of the Smartalloc orphaned buffer detection code.
437 This option is highly recommended. Because we never build without this
438 option, you may experience problems if it is not enabled. In this case,
439 simply re-enable the option. We strongly recommend keeping this option
440 enabled as it helps detect memory leaks. This configuration parameter is used
441 while building Bacula
443 \item [ \verb?--?enable-gnome ]
444 \index[dir]{\verb{--{enable-gnome }
445 If you have GNOME installed on your computer and you want to use the GNOME
446 GUI Console interface to Bacula, you must specify this option. Doing so will
447 build everything in the {\bf src/gnome-console} directory.
449 \item [ \verb?--?enable-wx-console ]
450 \index[console]{\verb{--{enable-wx-console }
451 If you have wxWidgets installed on your computer and you want to use the
452 wxWidgets GUI Console interface to Bacula, you must specify this option.
453 Doing so will build everything in the {\bf src/wx-console} directory. This
454 could also be useful to users who want a GUI Console and don't want to
455 install Gnome, as wxWidgets can work with GTK+, Motif or even X11 libraries.
458 \item [ \verb?--?enable-tray-monitor ]
459 \index[dir]{\verb{--{enable-tray-monitor }
460 If you have GTK installed on your computer, you run a graphical environment
461 or a window manager compatible with the FreeDesktop system tray standard
462 (like KDE and GNOME) and you want to use a GUI to monitor Bacula daemons, you
463 must specify this option. Doing so will build everything in the {\bf
464 src/tray-monitor} directory.
466 \item [ \verb?--?enable-static-tools]
467 \index[dir]{\verb{--{enable-static-tools }
468 This option causes the linker to link the Storage daemon utility tools ({\bf
469 bls}, {\bf bextract}, and {\bf bscan}) statically. This permits using them
470 without having the shared libraries loaded. If you have problems linking in
471 the {\bf src/stored} directory, make sure you have not enabled this option,
472 or explicitly disable static linking by adding {\bf \verb{--{disable-static-tools}.
475 \item [ \verb?--?enable-static-fd]
476 \index[fd]{\verb{--{enable-static-fd }
477 This option causes the make process to build a {\bf static-bacula-fd} in
478 addition to the standard File daemon. This static version will include
479 statically linked libraries and is required for the Bare Metal recovery. This
480 option is largely superseded by using {\bf make static-bacula-fd} from with
481 in the {\bf src/filed} directory. Also, the {\bf \verb{--{enable-client-only} option
482 described below is useful for just building a client so that all the other
483 parts of the program are not compiled.
485 \item [ \verb?--?enable-static-sd]
486 \index[sd]{\verb{--{enable-static-sd }
487 This option causes the make process to build a {\bf static-bacula-sd} in
488 addition to the standard Storage daemon. This static version will include
489 statically linked libraries and could be useful during a Bare Metal recovery.
492 \item [ \verb?--?enable-static-dir]
493 \index[dir]{\verb{--{enable-static-dir }
494 This option causes the make process to build a {\bf static-bacula-dir} in
495 addition to the standard Director. This static version will include
496 statically linked libraries and could be useful during a Bare Metal recovery.
499 \item [ \verb?--?enable-static-cons]
500 \index[dir]{\verb{--{enable-static-cons }
501 This option causes the make process to build a {\bf static-console} and a
502 {\bf static-gnome-console} in addition to the standard console. This static
503 version will include statically linked libraries and could be useful during a
506 \item [ \verb?--?enable-client-only]
507 \index[console]{\verb{--{enable-client-only }
508 This option causes the make process to build only the File daemon and the
509 libraries that it needs. None of the other daemons, storage tools, nor the
510 console will be built. Likewise a {\bf make install} will then only install
511 the File daemon. To cause all daemons to be built, you will need to do a
512 configuration without this option. This option greatly facilitates building a
513 Client on a client only machine.
515 \item [ \verb?--?enable-largefile]
516 \index[console]{\verb{--{enable-largefile }
517 This option (default) causes Bacula to be built with 64 bit file address
518 support if it is available on your system. This permits Bacula to read and
519 write files greater than 2 GBytes in size. You may disable this feature and
520 revert to 32 bit file addresses by using {\bf \verb{--{disable-largefile}.
522 \item [ \verb?--?with-sqlite=\lt{}sqlite-path\gt{}]
523 \index[fd]{\verb{--{with-sqlite }
524 This enables use of the SQLite database. The {\bf sqlite-path} is not
525 normally specified as Bacula looks for the necessary components in a
526 standard location ({\bf depkgs/sqlite}). See
527 \ilink{Installing and Configuring SQLite}{_ChapterStart33} chapter of
528 this manual for more details.
530 \item [ \verb?--?with-mysql=\lt{}mysql-path\gt{}]
531 \index[fd]{\verb{--{with-mysql }
532 This enables building of the Catalog services for Bacula. It assumes that
533 MySQL is running on your system, and expects it to be installed in the {\bf
534 mysql-path} that you specify. If this option is not present, the build will
535 automatically include the internal Bacula database code. We recommend that
536 you use this option if possible. If you do use this option, please proceed to
537 installing MySQL in the
538 \ilink{Installing and Configuring MySQL}{_ChapterStart} chapter
539 before proceeding with the configuration.
541 \item [ \verb?--?with-postgresql=\lt{}path\gt{}]
542 \index[fd]{\verb{--{with-postgresql }
543 This provides an explicit path to the PostgreSQL libraries if Bacula cannot
546 \item [ \verb?--?with-python=\lt{}path\gt{}]
547 \index[fd]{\verb{--{with-python }
548 This option enables Bacula support for Python. If no path is
549 supplied, configure will search the
550 standard library locations for Python 2.2, 2.3, or 2.4. If it cannot
551 find the library, you will need to supply a path to your Python
552 library directory. Please see the
553 \ilink{Python chapter}{_ChapterStart60} for the details of using
556 \item [ \verb?--?enable-conio]
557 \index[fd]{\verb{--{enable-conio }
558 Tells Bacula to enable building the small, light weight readline replacement
559 routine. It is generally much easier to configure than readline, although,
560 like readline, it needs either the termcap or ncurses library.
562 \item [ \verb?--?with-readline=\lt{}readline-path\gt{}]
563 \index[fd]{\verb{--{with-readline }
564 Tells Bacula where {\bf readline} is installed. Normally, Bacula will find
565 readline if it is in a standard library. If it is not found and no
566 \verb{--{with-readline is specified, readline will be disabled. This option affects
567 the Bacula build. Readline provides the Console program with a command line
568 history and editing capability and is no longer supported, so you are on your
569 own if you have problems.
571 \item [ \verb?--?enable-readline]
572 \index[fd]{\verb{--{enable-readline }
573 Tells Bacula to enable readline support. It is normally disabled due to the
574 large number of configuration problems and the fact that the package seems to
575 change in incompatible ways from version to version.
577 \item [ \verb?--?with-tcp-wrappers=\lt{}path\gt{}]
578 \index[fd]{\verb{--{with-tcp-wrappers }
579 This specifies that you want TCP wrappers (man hosts\_access(5)) compiled in.
580 The path is optional since Bacula will normally find the libraries in the
581 standard locations. This option affects the Bacula build. In specifying your
582 restrictions in the {\bf /etc/hosts.allow} or {\bf /etc/hosts.deny} files, do
583 not use the {\bf twist} option (hosts\_options(5)) or the Bacula process will
584 be terminated. Note, when setting up your {\bf /etc/hosts.allow}
585 or {\bf /etc/hosts.deny}, you must identify the Bacula daemon in
586 question with the name you give it in your conf file rather than the
587 name of the executable.
589 For more information on configuring and testing TCP wrappers, please see the
590 \ilink{Configuring and Testing TCP Wrappers}{wrappers} section
591 in the Security Chapter.
593 \item [ \verb?--?with-working-dir=\lt{}working-directory-path\gt{} ]
594 \index[dir]{\verb{--{with-working-dir }
595 This option is mandatory and specifies a directory into which Bacula may
596 safely place files that will remain between Bacula executions. For example,
597 if the internal database is used, Bacula will keep those files in this
598 directory. This option is only used to modify the daemon configuration
599 files. You may also accomplish the same thing by directly editing them later.
600 The working directory is not automatically created by the install process, so
601 you must ensure that it exists before using Bacula for the first time.
603 \item [ \verb?--?with-base-port=\lt{}port=number\gt{}]
604 \index[dir]{\verb{--{with-base-port }
605 In order to run, Bacula needs three TCP/IP ports (one for the Bacula
606 Console, one for the Storage daemon, and one for the File daemon). The {\bf
607 \verb{--{with-baseport} option will automatically assign three ports beginning at
608 the base port address specified. You may also change the port number in the
609 resulting configuration files. However, you need to take care that the
610 numbers correspond correctly in each of the three daemon configuration
611 files. The default base port is 9101, which assigns ports 9101 through 9103.
612 These ports (9101, 9102, and 9103) have been officially assigned to Bacula by
613 IANA. This option is only used to modify the daemon configuration files. You
614 may also accomplish the same thing by directly editing them later.
616 \item [ \verb?--?with-dump-email=\lt{}email-address\gt{}]
617 \index[dir]{\verb{--{with-dump-email }
618 This option specifies the email address where any core dumps should be set.
619 This option is normally only used by developers.
621 \item [ \verb?--?with-pid-dir=\lt{}PATH\gt{} ]
622 \index[dir]{\verb{--{with-pid-dir }
623 This specifies where Bacula should place the process id file during
624 execution. The default is: {\bf /var/run}. This directory is not created by
625 the install process, so you must ensure that it exists before using Bacula
628 \item [ \verb?--?with-subsys-dir=\lt{}PATH\gt{}]
629 \index[dir]{\verb{--{with-subsys-dir }
630 This specifies where Bacula should place the subsystem lock file during
631 execution. The default is {\bf /var/run/subsys}. Please make sure that you do
632 not specify the same directory for this directory and for the {\bf sbindir}
633 directory. This directory is used only within the autostart scripts. The
634 subsys directory is not created by the Bacula install, so you must be sure to
635 create it before using Bacula.
637 \item [ \verb?--?with-dir-password=\lt{}Password\gt{}]
638 \index[dir]{\verb{--{with-dir-password }
639 This option allows you to specify the password used to access the Directory
640 (normally from the Console program). If it is not specified, configure will
641 automatically create a random password.
643 \item [ \verb?--?with-fd-password=\lt{}Password\gt{} ]
644 \index[fd]{\verb{--{with-fd-password }
645 This option allows you to specify the password used to access the File daemon
646 (normally called from the Director). If it is not specified, configure will
647 automatically create a random password.
649 \item [ \verb?--?with-sd-password=\lt{}Password\gt{} ]
650 \index[sd]{\verb{--{with-sd-password }
651 This option allows you to specify the password used to access the Directory
652 (normally called from the Director). If it is not specified, configure will
653 automatically create a random password.
655 \item [ \verb?--?with-dir-user=\lt{}User\gt{} ]
656 \index[dir]{\verb{--{with-dir-user }
657 This option allows you to specify the Userid used to run the Director. The
658 Director must be started as root, but doesn't need to run as root, and after
659 doing preliminary initializations, it can ``drop'' to the UserId specified on
662 \item [ \verb?--?with-dir-group=\lt{}Group\gt{} ]
663 \index[dir]{\verb{--{with-dir-group }
664 This option allows you to specify the GroupId used to run the Director. The
665 Director must be started as root, but doesn't need to run as root, and after
666 doing preliminary initializations, it can ``drop'' to the GroupId specified
669 \item [ \verb?--?with-sd-user=\lt{}User\gt{} ]
670 \index[sd]{\verb{--{with-sd-user }
671 This option allows you to specify the Userid used to run the Storage daemon.
672 The Storage daemon must be started as root, but doesn't need to run as root,
673 and after doing preliminary initializations, it can ``drop'' to the UserId
674 specified on this option. If you use this option, you will need to take care
675 that the Storage daemon has access to all the devices (tape drives, ...) that
678 \item [ \verb?--?with-sd-group=\lt{}Group\gt{} ]
679 \index[sd]{\verb{--{with-sd-group }
680 This option allows you to specify the GroupId used to run the Storage daemon.
681 The Storage daemon must be started as root, but doesn't need to run as root,
682 and after doing preliminary initializations, it can ``drop'' to the GroupId
683 specified on this option.
685 \item [ \verb?--?with-fd-user=\lt{}User\gt{} ]
686 \index[fd]{\verb{--{with-fd-user }
687 This option allows you to specify the Userid used to run the File daemon. The
688 File daemon must be started as root, and in most cases, it needs to run as
689 root, so this option is used only in very special cases, after doing
690 preliminary initializations, it can ``drop'' to the UserId specified on this
693 \item [ \verb?--?with-fd-group=\lt{}Group\gt{} ]
694 \index[fd]{\verb{--{with-fd-group }
695 This option allows you to specify the GroupId used to run the File daemon.
696 The File daemon must be started as root, and in most cases, it must be run as
697 root, however, after doing preliminary initializations, it can ``drop'' to
698 the GroupId specified on this option.
702 Note, many other options are presented when you do a {\bf ./configure \verb{--{help},
703 but they are not implemented.
705 \subsection*{Recommended Options for most Systems}
706 \index[general]{Systems!Recommended Options for most }
707 \index[general]{Recommended Options for most Systems }
708 \addcontentsline{toc}{subsection}{Recommended Options for most Systems}
710 For most systems, we recommend starting with the following options:
715 --enable-smartalloc \
716 --sbindir=$HOME/bacula/bin \
717 --sysconfdir=$HOME/bacula/bin \
718 --with-pid-dir=$HOME/bacula/bin/working \
719 --with-subsys-dir=$HOME/bacula/bin/working \
720 --with-mysql=$HOME/mysql \
721 --with-working-dir=$HOME/bacula/working
725 If you want to install Bacula in an installation directory rather than run it
726 out of the build directory (as developers will do most of the time), you
727 should also include the \verb{--{sbindir and \verb{--{sysconfdir options with appropriate
728 paths. Neither are necessary if you do not use ``make install'' as is the case
729 for most development work. The install process will create the sbindir and
730 sysconfdir if they do not exist, but it will not automatically create the
731 pid-dir, subsys-dir, or working-dir, so you must ensure that they exist before
732 running Bacula for the first time. See below for an example of how Kern does
736 \index[general]{RedHat }
737 \addcontentsline{toc}{subsection}{RedHat}
744 CFLAGS="-g -Wall" ./configure \
745 --sbindir=$HOME/bacula/bin \
746 --sysconfdir=$HOME/bacula/bin \
747 --enable-smartalloc \
748 --with-sqlite=$HOME/bacula/depkgs/sqlite \
749 --with-working-dir=$HOME/bacula/working \
750 --with-pid-dir=$HOME/bacula/bin/working \
751 --with-subsys-dir=$HOME/bacula/bin/working \
762 CFLAGS="-g -Wall" ./configure \
763 --sbindir=$HOME/bacula/bin \
764 --sysconfdir=$HOME/bacula/bin \
765 --enable-smartalloc \
766 --with-mysql=$HOME/mysql \
767 --with-working-dir=$HOME/bacula/working
768 --with-pid-dir=$HOME/bacula/bin/working \
769 --with-subsys-dir=$HOME/bacula/bin/working
775 or finally, a completely traditional RedHat Linux install:
779 CFLAGS="-g -Wall" ./configure \
781 --sbindir=/usr/sbin \
782 --sysconfdir=/etc/bacula \
783 --with-scriptdir=/etc/bacula \
784 --enable-smartalloc \
787 --with-working-dir=/var/bacula \
788 --with-pid-dir=/var/run \
789 --with-subsys-dir=/var/lock/subsys \
794 Note, Bacula assumes that /var/bacula, /var/run, and /var/loc/subsys exist so
795 it will not automatically create them during the install process.
797 \subsection*{Solaris}
798 \index[general]{Solaris }
799 \addcontentsline{toc}{subsection}{Solaris}
801 To build Bacula from source, you will need the following installed on your
802 system (they are not by default): libiconv, gcc 3.3.2, stdc++, libgcc (for
803 stdc++ and gcc\_s libraries), make 3.8 or later.
805 You will probably also need to: Add /usr/local/bin to PATH and Add
806 /usr/ccs/bin to PATH for ar.
811 CFLAGS="-g" ./configure \
812 --sbindir=$HOME/bacula/bin \
813 --sysconfdir=$HOME/bacula/bin \
814 --with-mysql=$HOME/mysql \
815 --enable-smartalloc \
816 --with-pid-dir=$HOME/bacula/bin/working \
817 --with-subsys-dir=$HOME/bacula/bin/working \
818 --with-working-dir=$HOME/bacula/working
822 As mentioned above, the install process will create the sbindir and sysconfdir
823 if they do not exist, but it will not automatically create the pid-dir,
824 subsys-dir, or working-dir, so you must ensure that they exist before running
825 Bacula for the first time.
827 \subsection*{FreeBSD}
828 \index[general]{FreeBSD }
829 \addcontentsline{toc}{subsection}{FreeBSD}
832 \elink{The FreeBSD Diary}{http://www.freebsddiary.org/bacula.php} for a
833 detailed description on how to make Bacula work on your system. In addition,
834 users of FreeBSD prior to 4.9-STABLE dated Mon Dec 29 15:18:01 2003 UTC who
835 plan to use tape devices, please see the
836 \ilink{Tape Testing Chapter}{FreeBSDTapes} of this manual for
837 {\bf important} information on how to configure your tape drive for
838 compatibility with Bacula.
840 If you are using Bacula with MySQL, you should take care to compile MySQL with
841 FreeBSD native threads rather than LinuxThreads, since Bacula is normally built
842 with FreeBSD native threads rather than LinuxTreads. Mixing the two will
846 \index[general]{Win32 }
847 \addcontentsline{toc}{subsection}{Win32}
849 To install the binary Win32 version of the File daemon please see the
850 \ilink{Win32 Installation Chapter}{_ChapterStart7} in this document.
852 \subsection*{Windows Systems with CYGWIN Installed}
854 \index[general]{Windows Systems with CYGWIN Installed }
855 \index[general]{Installed!Windows Systems with CYGWIN }
856 \addcontentsline{toc}{subsection}{Windows Systems with CYGWIN Installed}
858 As of version 1.34, Bacula no longer uses CYGWIN for the Win32 File daemon.
859 However, it is still built under a CYGWIN build environment -- though you can
860 probably do it with VC Studio only. If you wish to build the Win32 File daemon
861 from the source, you will need Microsoft C++ version 6.0 or greater. In Bacula
862 prior to version 1.33, CYGWIN was used. Details for building it are in the
863 README.win32 file of the src/win32 directory.
865 Note, although most parts of Bacula build on Windows systems, the only part
866 that we have tested and used is the File daemon.
868 Finally, you should follow the installation instructions in the
869 \ilink{Win32 Installation}{_ChapterStart7} section of this document.
871 \subsection*{Kern's Configure Script}
872 \index[general]{Script!Kern's Configure }
873 \index[general]{Kern's Configure Script }
874 \addcontentsline{toc}{subsection}{Kern's Configure Script}
876 The script that I use for building on my ``production'' Linux machines is:
881 # This is Kern's configure script for Bacula
884 --sbindir=$HOME/bacula/bin \
885 --sysconfdir=$HOME/bacula/bin \
886 --enable-smartalloc \
888 --with-pid-dir=$HOME/bacula/bin/working \
889 --with-subsys-dir=$HOME/bacula/bin/working \
890 --with-mysql=$HOME/mysql \
891 --with-working-dir=$HOME/bacula/bin/working \
892 --with-dump-email=$USER \
893 --with-smtp-host=mail.your-site.com \
899 Note that I define the base port as 9101, which means that Bacula will use
900 port 9101 for the Director console, port 9102 for the File daemons, and port
901 9103 for the Storage daemons. These ports should be available on all systems
902 because they have been officially assigned to Bacula by IANA (Internet
903 Assigned Numbers Authority). We strongly recommend that you use only these
904 ports to prevent any conflicts with other programs. This is in fact the
905 default if you do not specify a {\bf \verb{--{with-baseport} option.
907 You may also want to put the following entries in your {\bf /etc/services}
908 file as it will make viewing the connections made by Bacula easier to
909 recognize (i.e. netstat -a):
919 \subsection*{Installing Bacula}
920 \index[general]{Bacula!Installing }
921 \index[general]{Installing Bacula }
922 \addcontentsline{toc}{subsection}{Installing Bacula}
924 Before setting up your configuration files, you will want to install Bacula in
925 its final location. Simply enter:
933 If you have previously installed Bacula, the old binaries will be overwritten,
934 but the old configuration files will remain unchanged, and the ``new''
935 configuration files will be appended with a {\bf .new}. Generally if you have
936 previously installed and run Bacula you will want to discard or ignore the
937 configuration files with the appended {\bf .new}.
939 \subsection*{Building a File Daemon or Client}
940 \index[general]{Client!Building a File Daemon or }
941 \index[general]{Building a File Daemon or Client }
942 \addcontentsline{toc}{subsection}{Building a File Daemon or Client}
944 If you run the Director and the Storage daemon on one machine and you wish to
945 back up another machine, you must have a copy of the File daemon for that
946 machine. If the machine and the Operating System are identical, you can simply
947 copy the Bacula File daemon binary file {\bf bacula-fd} as well as its
948 configuration file {\bf bacula-fd.conf} then modify the name and password in
949 the conf file to be unique. Be sure to make corresponding additions to the
950 Director's configuration file ({\bf bacula-dir.conf}).
952 If the architecture or the O/S level are different, you will need to build a
953 File daemon on the Client machine. To do so, you can use the same {\bf
954 ./configure} command as you did for your main program, starting either from a
955 fresh copy of the source tree, or using {\bf make\ distclean} before the {\bf
958 Since the File daemon does not access the Catalog database, you can remove the
959 {\bf \verb{--{with-mysql} or {\bf \verb{--{with-sqlite} options, then add {\bf
960 \verb{--{enable-client-only}. This will compile only the necessary libraries and the
961 client programs and thus avoids the necessity of installing one or another of
962 those database programs to build the File daemon. With the above option, you
963 simply enter {\bf make} and just the client will be built.
966 \subsection*{Auto Starting the Daemons}
967 \index[general]{Daemons!Auto Starting the }
968 \index[general]{Auto Starting the Daemons }
969 \addcontentsline{toc}{subsection}{Auto Starting the Daemons}
971 If you wish the daemons to be automatically started and stopped when your
972 system is booted (a good idea), one more step is necessary. First, the
973 ./configure process must recognize your system -- that is it must be a
974 supported platform and not {\bf unknown}, then you must install the platform
975 dependent files by doing:
980 make install-autostart
984 Please note, that the auto-start feature is implemented only on systems that
985 we officially support (currently, FreeBSD, RedHat Linux, and Solaris), and has
986 only been fully tested on RedHat Linux.
988 The {\bf make install-autostart} will cause the appropriate startup scripts to
989 be installed with the necessary symbolic links. On RedHat Linux systems, these
990 scripts reside in {\bf /etc/rc.d/init.d/bacula-dir} {\bf
991 /etc/rc.d/init.d/bacula-fd}, and {\bf /etc/rc.d/init.d/bacula-sd}. However the
992 exact location depends on what operating system you are using.
994 If you only wish to install the File daemon, you may do so with:
998 make install-autostart-fd
1002 \subsection*{Other Make Notes}
1003 \index[general]{Notes!Other Make }
1004 \index[general]{Other Make Notes }
1005 \addcontentsline{toc}{subsection}{Other Make Notes}
1007 To simply build a new executable in any directory, enter:
1015 To clean out all the objects and binaries (including the files named 1, 2, or
1016 3, which Kern uses as temporary files), enter:
1024 To really clean out everything for distribution, enter:
1032 note, this cleans out the Makefiles and is normally done from the top level
1033 directory to prepare for distribution of the source. To recover from this
1034 state, you must redo the {\bf ./configure} in the top level directory, since
1035 all the Makefiles will be deleted.
1037 To add a new file in a subdirectory, edit the Makefile.in in that directory,
1038 then simply do a {\bf make}. In most cases, the make will rebuild the Makefile
1039 from the new Makefile.in. In some case, you may need to issue the {\bf make} a
1040 second time. In extreme cases, cd to the top level directory and enter: {\bf
1043 To add dependencies:
1051 The {\bf make depend} appends the header file dependencies for each of the
1052 object files to Makefile and Makefile.in. This command should be done in each
1053 directory where you change the dependencies. Normally, it only needs to be run
1054 when you add or delete source or header files. {\bf make depend} is normally
1055 automatically invoked during the configuration process.
1065 This not normally done if you are developing Bacula, but is used if you are
1066 going to run it to backup your system.
1068 After doing a {\bf make install} the following files will be installed on your
1069 system (more or less). The exact files and location (directory) for each file
1070 depends on your {\bf ./configure} command (e.g. gnome-console and
1071 gnome-console.conf are not installed if you do not configure GNOME. Also, if
1072 you are using SQLite instead of mysql, some of the files will be different).
1093 create_mysql_database
1095 delete_catalog_backup
1116 \subsection*{Installing Tray Monitor}
1117 \index[general]{Monitor!Installing Tray }
1118 \index[general]{Installing Tray Monitor }
1119 \addcontentsline{toc}{subsection}{Installing Tray Monitor}
1121 The Tray Monitor is already installed if you used the {\bf
1122 \verb{--{enable-tray-monitor} configure option and ran {\bf make install}.
1124 As you don't run your graphical environment as root (if you do, you should
1125 change that bad habit), don't forget to allow your user to read {\bf
1126 tray-monitor.conf}, and to execute {\bf bacula-tray-monitor} (this is not a
1129 Then log into your graphical environment (KDE, Gnome or something else), run
1130 {\bf bacula-tray-monitor} as your user, and see if a cassette icon appears
1131 somewhere on the screen, usually on the task bar.
1132 If it doesn't, follow the instructions below related to your environment or
1135 \subsubsection*{GNOME}
1136 \index[general]{GNOME }
1137 \addcontentsline{toc}{subsubsection}{GNOME}
1139 System tray, or notification area if you use the GNOME terminology, has been
1140 supported in GNOME since version 2.2. To activate it, right-click on one of
1141 your panels, open the menu {\bf Add to this Panel}, then {\bf Utility} and
1142 finally click on {\bf Notification Area}.
1144 \subsubsection*{KDE}
1145 \index[general]{KDE }
1146 \addcontentsline{toc}{subsubsection}{KDE}
1148 System tray has been supported in KDE since version 3.1. To activate it,
1149 right-click on one of your panels, open the menu {\bf Add}, then {\bf Applet}
1150 and finally click on {\bf System Tray}.
1152 \subsubsection*{Other window managers}
1153 \index[general]{Managers!Other window }
1154 \index[general]{Other window managers }
1155 \addcontentsline{toc}{subsubsection}{Other window managers}
1157 Read the documentation to know if the Freedesktop system tray standard is
1158 supported by your window manager, and if applicable, how to activate it.
1160 \subsection*{Modifying the Bacula Configuration Files}
1161 \index[general]{Modifying the Bacula Configuration Files }
1162 \index[general]{Files!Modifying the Bacula Configuration }
1163 \addcontentsline{toc}{subsection}{Modifying the Bacula Configuration Files}
1166 \ilink{Configuring Bacula}{_ChapterStart16} in this manual for
1167 instructions on how to set Bacula configuration files.