]> git.sur5r.net Git - bacula/docs/blob - docs/manual/install.tex
Final changes
[bacula/docs] / docs / manual / install.tex
1 %%
2 %%
3
4 \section*{Installing Bacula}
5 \label{_ChapterStart17}
6 \index[general]{Bacula!Installing }
7 \index[general]{Installing Bacula }
8 \addcontentsline{toc}{section}{Installing Bacula}
9
10 \subsection*{General}
11 \index[general]{General }
12 \addcontentsline{toc}{subsection}{General}
13
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
17 {\bf PostgreSQL}
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. 
23
24 \subsection*{Source Release Files}
25 \index[general]{Source Files}
26 \index[general]{Release Files}
27 \addcontentsline{toc}{subsection}{Source Release File}
28 Beginning with Bacula 1.38.0, the source code has been broken into
29 four separate tar files each corresponding to a different module in
30 the Bacula CVS. The released files are:
31
32 \begin{description}
33 \item [bacula-1.38.0.tar.gz]
34   This is the primary source code release for Bacula. On each
35   release the version number (1.38.0) will be updated.
36
37 \item [bacula-docs-1.38.0.tar.gz]
38   This file contains a copy of the docs directory with the
39   documents prebuild. English html directory, single html
40   file, and pdf file. The French and German translations
41   are in progress, but are not built.
42
43 \item [bacula-gui-1.38.0.tar.gz]
44   This file contains the non-core GUI programs. Currently,
45   it contains bacula-web, a PHP program for producing management
46   viewing of your Bacula job status in a browser; and bimagemgr
47   a browser program for burning CDROM images with Bacula Volumes.
48
49 \item [bacula-rescue-1.8.1.tar.gz]
50   This is the Bacula Rescue CDROM code. Note, the version number
51   of this package is not tied to the Bacula release version, so
52   it will be different.  Using this code, you can burn a CDROM
53   with your system configuration and containing a statically
54   linked version of the File daemon. This can permit you to easily
55   repartition and reformat your hard disks and reload your
56   system with Bacula in the case of a hard disk failure.
57
58 \end{description}
59
60 \label{upgrading1}
61 \subsection*{Upgrading Bacula}
62 \index[general]{Bacula!Upgrading }
63 \index[general]{Upgrading Bacula }
64 \addcontentsline{toc}{subsection}{Upgrading Bacula}
65
66 If you are upgrading from one Bacula version to another, you should first
67 carefully read the ReleaseNotes of all versions between your current version
68 and the version to which you are upgrading. If the Bacula catalog database has
69 been upgraded, you will either need to reinitialize your database starting
70 from scratch, or save an ASCII copy of your database, then proceed to upgrade
71 it. This is normally done after Bacula is build and installed by:
72
73 \begin{verbatim}
74 cd <installed-scripts-dir> (default /etc/bacula)
75 ./update_bacula_tables
76 \end{verbatim}
77
78 This update script can also be find in the Bacula source src/cats
79 directory.
80
81 If there are several database upgrades between your version and the
82 version to which you are upgrading, you will need to apply each database
83 upgrade script. For your convenience, you can find all the old upgrade scripts
84 in the {\bf upgradedb} directory of the source code. You will need to edit the
85 scripts to correspond to your system configuration. The final upgrade script,
86 if any, can be applied as noted above.
87
88 If you are upgrading from one major version to another, you will need to
89 replace all your components at the same time as generally the inter-daemon
90 protocol will change. However, within any particular release (e.g. version
91 1.32.x) unless there is an oversight or bug, the daemon protocol will not
92 change. If this is confusing, simply read the ReleaseNotes very carefully as
93 they will note if all daemons must be upgraded at the same time. 
94
95 Finally, please note that in general it is not necessary to do a 
96 {\bf make uninstall} before doing an upgrade. In fact, if you do so, you will 
97 most likely delete all your conf files, which could be disastrous.
98 The normal procedure during an upgrade is simply {\bf make install}.
99 In general none of your existing .conf or .sql files will be overwritten.
100
101 For additional information on upgrading, please see the \ilink{Upgrading Bacula
102 Versions}{upgrading} in the Tips chapter of this manual.
103
104
105 \subsection*{Dependency Packages}
106 \label{Dependency}
107 \index[general]{Dependency Packages }
108 \index[general]{Packages!Dependency }
109 \addcontentsline{toc}{subsection}{Dependency Packages}
110
111 As discussed above, we have combined a number of third party packages that
112 Bacula might need into the {\bf depkgs} and {\bf depkgs1} releases. You can,
113 of course, get the latest packages from the original authors. The locations of
114 where we obtained the packages are in the README file in each package.
115 However, be aware that the packages in the depkgs files have been tested by us
116 for compatibility with Bacula. 
117
118 Typically, a dependency package will be named {\bf depkgs-ddMMMyy.tar.gz} and
119 {\bf depkgs1-ddMMyy.tar.gz} where {\bf dd} is the day we release it, {\bf MMM}
120 is the abbreviated month (e.g. Jan), and {\bf yy} is the year. An actual
121 example is: {\bf depkgs-07Apr02.tar.gz}. To install and build this package (if
122 needed), you do the following: 
123
124 \begin{enumerate}
125 \item Create a {\bf bacula} directory, into which you will place  both the
126    Bacula source as well as the dependency package.  
127 \item Detar the {\bf depkg} into the {\bf bacula} directory.  
128 \item cd bacula/depkgs  
129 \item make 
130 \end{enumerate}
131
132 Although the exact composition of the dependency packages may change from time
133 to time, the current makeup is the following: 
134
135 \addcontentsline{lot}{table}{Dependency Packages}
136 \begin{longtable}{|l|l|l|l|}
137  \hline 
138 \multicolumn{1}{|c| }{\bf 3rd Party Package } & \multicolumn{1}{c| }{\bf
139 depkgs } & \multicolumn{1}{c| }{\bf depkgs1 } & \multicolumn{1}{c| }{\bf
140 depkgs-win32  } \\
141  \hline {SQLite } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } &
142 \multicolumn{1}{c| }{-  } \\
143  \hline {mtx } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } &
144 \multicolumn{1}{c| }{-  } \\
145  \hline {readline } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{X } &
146 \multicolumn{1}{c| }{-  } \\
147  \hline {pthreads } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } &
148 \multicolumn{1}{c| }{X  } \\
149  \hline {zlib } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } &
150 \multicolumn{1}{c| }{X  } \\
151  \hline {wxWidgets } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } &
152 \multicolumn{1}{c| }{X }
153 \\ \hline 
154
155 \end{longtable}
156
157 Note, some of these packages are quite large, so that building them can be a
158 bit time consuming. The above instructions will build all the packages
159 contained in the directory. However, when building Bacula, it will take only
160 those pieces that it actually needs. 
161
162 Alternatively, you can make just the packages that are needed. For example, 
163
164 \footnotesize
165 \begin{verbatim}
166 cd bacula/depkgs
167 make sqlite
168 \end{verbatim}
169 \normalsize
170
171 will configure and build only the SQLite package. 
172
173 You should build the packages that you will require in {\bf depkgs} and/or
174 {\bf depkgs1} prior to configuring and building Bacula, since Bacula will need
175 them during the build process. 
176
177 Even if you do not use SQLite, you might find it worthwhile to build {\bf mtx}
178 because the {\bf tapeinfo} program that comes with it can often provide you
179 with valuable information about your SCSI tape drive (e.g. compression,
180 min/max block sizes, ...). 
181
182 The {\bf depkgs-win32} package contains the source code for the pthreads,
183 zlib, and wxWidgets libraries used by the native Win32 client program.  It
184 will only be needed if you intend to build the Win32 client from source.
185
186 \subsection*{Supported Operating Systems}
187 \label{Systems}
188 \index[general]{Systems!Supported Operating }
189 \index[general]{Supported Operating Systems }
190 \addcontentsline{toc}{subsection}{Supported Operating Systems}
191
192 Please see the 
193 \ilink{ Supported Operating Systems}{SupportedOSes} section
194 of the QuickStart chapter of this manual. 
195
196 \subsection*{Building Bacula from Source}
197 \label{Building}
198 \index[general]{Source!Building Bacula from }
199 \index[general]{Building Bacula from Source }
200 \addcontentsline{toc}{subsection}{Building Bacula from Source}
201
202 The basic installation is rather simple. 
203
204 \begin{enumerate}
205 \item Install and build any {\bf depkgs} as noted above.  
206 \item Configure and install MySQL or PostgreSQL (if desired). 
207    \ilink{Installing and Configuring MySQL Phase I}{_ChapterStart} or  
208    \ilink{Installing and Configuring PostgreSQL Phase
209    I}{_ChapterStart10}.  If you are installing from rpms, and are
210    using MySQL, please be sure to install  {\bf mysql-devel}, so that the MySQL
211    header files are available  while compiling Bacula. In addition, the MySQL
212    client  library {\bf mysqlclient} requires the gzip compression library  {\bf
213    libz.a} or {\bf libz.so}. If you are using rpm packages,  these libraries are
214    in the {\bf libz-devel} package. On Debian  systems, you will need to load the
215    {\bf zlib1g-dev} package. If  you are not using rpms or debs, you will need to
216    find the  appropriate package for your system.  
217
218    Note, if you already have a running MySQL or PostgreSQL on your system, you 
219    can skip this phase provided that you have built the thread  safe libraries.
220    And you have already installed the additional  rpms noted above.  
221
222 \item As an alternative to MySQL and PostgreSQL, configure and install SQLite,
223     which is part of the {\bf depkgs}.  
224    \ilink{Installing and Configuring SQLite}{_ChapterStart33}.  
225
226 \item Detar the Bacula source code preferably into the {\bf bacula}  directory
227    discussed above.  
228
229 \item {\bf cd} to the directory containing the source code.  
230
231 \item ./configure (with appropriate options as described below)  
232
233 \item Check the output of ./configure very carefully, especially  the Install
234    binaries and Install config directories.  If they are not correct,
235    please rerun ./configure until they  are. The output from ./configure is
236    stored in {\bf config.out}  and can be re-displayed at any time without
237    rerunning the  ./configure by doing {\bf cat config.out}.  
238
239 \item If after running ./configure once, you decide to change options  and
240    re-run it, that is perfectly fine, but before re-running it,  you should run: 
241
242
243 \footnotesize
244 \begin{verbatim}
245       make distclean
246 \end{verbatim}
247 \normalsize
248
249 so that you are sure to start from scratch and not have a  mixture of the two
250 options. This is because ./configure  caches much of the information. The {\bf
251 make distclean}  is also critical if you move the source directory from one 
252 machine to another. If the {\bf make distclean} fails,  just ignore it and
253 continue on.  
254
255 \item make  
256 \begin{verbatim}
257
258 \end{verbatim}
259    If you get errors while linking in the Storage daemon directory
260    (src/stored), it is probably because you have not loaded the static
261    libraries on your system.  I noticed this problem on a Solaris system.
262    To correct it, make sure that you have not added {\bf
263    {-}{-}enable-static-tools} to the {\bf ./configure} command.
264
265    If you skip this step ({\bf make}) and proceed immediately to the {\bf
266    make install} you are making two serious errors: 1.  your install will
267    fail because Bacula requires a {\bf make} before a {\bf make install}.
268    2.  you are depriving yourself of the chance to make sure there are no
269    errors before beginning to write files to your system directories.
270                                  
271
272 \item make install  
273                                                                   
274
275 \item If you are new to Bacula, we {\bf strongly} recommend that you skip
276    the next step and use the default configuration files, then run the
277    example program in the next chapter, then come back and modify your
278    configuration files to suit your particular needs.
279
280 \item Customize the configuration files for each of the three daemons 
281    (Directory, File, Storage) and for the Console program.  For the details
282    of how to do this, please see \ilink{Setting Up Bacula Configuration
283    Files}{_ChapterStart16} in the Configuration chapter of this manual.  We
284    recommend that you start by modifying the default configuration files
285    supplied, making the minimum changes necessary.  Complete customization
286    can be done after you have Bacula up and running.  Please take care when
287    modifying passwords, which were randomly generated, and the {\bf Name}s
288    as the passwords and names must agree between the configuration files
289    for security reasons.  
290
291 \item Create the Bacula MySQL database and tables
292    (if using MySQL)
293       \ilink{Installing and Configuring MySQL Phase II}{mysql_phase2} or 
294       create the Bacula PostgreSQL database and tables  
295    \ilink{Installing and Configuring PostgreSQL Phase
296    II}{PostgreSQL_phase2} or alternatively  if you are using
297    SQLite  
298    \ilink{Installing and Configuring SQLite Phase II}{phase2}.  
299
300 \item Start Bacula ({\bf ./bacula start}) Note. the next chapter  shows you
301    how to do this in detail.  
302
303 \item Interface with Bacula using the Console program  
304
305 \item For the previous two items, please follow the instructions  in the 
306    \ilink{Running Bacula}{_ChapterStart1} chapter of  this manual,
307    where you will run a simple backup and do a  restore. Do this before you make
308    heavy modifications to the  configuration files so that you are sure that
309    Bacula works  and are familiar with it. After that changing the conf files 
310    will be easier.  
311
312 \item If after installing Bacula, you decide to "move it", that is  to
313    install it in a different set of directories, proceed  as follows:  
314
315 \footnotesize
316 \begin{verbatim}
317       make uninstall
318       make distclean
319       ./configure (your-new-options)
320       make
321       make install
322       
323 \end{verbatim}
324 \normalsize
325
326 \end{enumerate}
327
328 If all goes well, the {\bf ./configure} will correctly determine which
329 operating system you are running and configure the source code appropriately.
330 Currently, FreeBSD, Linux (RedHat), and Solaris are supported. MacOS X 10.3 is
331 reported to work with the Client only as long as readline support is disabled.
332
333
334 If you install Bacula on more than one system, and they are identical, you can
335 simply transfer the source tree to that other system and do a "make
336 install". However, if there are differences in the libraries or OS versions,
337 or you wish to install on a different OS, you should start from the original
338 compress tar file. If you do transfer the source tree, and you have previously
339 done a ./configure command, you MUST do: 
340
341 \footnotesize
342 \begin{verbatim}
343 make distclean
344 \end{verbatim}
345 \normalsize
346
347 prior to doing your new ./configure. This is because the GNU autoconf tools
348 cache the configuration, and if you re-use a configuration for a Linux machine
349 on a Solaris, you can be sure your build will fail. To avoid this, as
350 mentioned above, either start from the tar file, or do a "make distclean". 
351
352 In general, you will probably want to supply a more complicated {\bf
353 configure} statement to ensure that the modules you want are built and that
354 everything is placed into the correct directories. 
355
356 For example, on RedHat, one could use the following: 
357
358 \footnotesize
359 \begin{verbatim}
360 CFLAGS="-g -Wall" \
361   ./configure \
362     --sbindir=$HOME/bacula/bin \
363     --sysconfdir=$HOME/bacula/bin \
364     --with-pid-dir=$HOME/bacula/bin/working \
365     --with-subsys-dir=$HOME/bacula/bin/working \
366     --with-mysql=$HOME/mysql \
367     --with-working-dir=$HOME/bacula/bin/working \
368     --with-dump-email=$USER
369 \end{verbatim}
370 \normalsize
371
372 Note, the advantage of using the above configuration to start is that
373 everything will be put into a single directory, which you can later delete
374 once you have run the examples in the next chapter and learned how Bacula
375 works. In addition, the above can be installed and run as non-root. 
376
377 For the developer's convenience, I have added a {\bf defaultconfig} script to
378 the {\bf examples} directory. This script contains the statements that you
379 would normally use, and each developer/user may modify them to suit his needs.
380 You should find additional useful examples in this directory as well. 
381
382 The {\bf \verb:--:enable-conio} or {\bf \verb:--:enable-readline} options are useful because
383 they provide a command line history and editing capability for the Console
384 program. If you have included either option in the build, either the {\bf
385 termcap} or the {\bf ncurses} package will be needed to link. On some systems,
386 such as SuSE, the termcap library is not in the standard library directory. As
387 a consequence, the option may be disabled or you may get an error message such
388 as: 
389
390 \footnotesize
391 \begin{verbatim}
392 /usr/lib/gcc-lib/i586-suse-linux/3.3.1/.../ld:
393 cannot find -ltermcap
394 collect2: ld returned 1 exit status
395 \end{verbatim}
396 \normalsize
397
398 while building the Bacula Console. In that case, you will need to set the {\bf
399 LDFLAGS} environment variable prior to building. 
400
401 \footnotesize
402 \begin{verbatim}
403 export LDFLAGS="-L/usr/lib/termcap"
404 \end{verbatim}
405 \normalsize
406
407 The same library requirements apply if you wish to use the readline
408 subroutines for command line editing and history or
409  if you are using a MySQL library that requires encryption. If you need encryption,
410 you can either export the appropriate additional library options as shown
411 above or, alternatively, you can include them directly on the ./configure line
412 as in: 
413
414 \footnotesize
415 \begin{verbatim}
416 LDFLAGS="-lssl -lcyrpto" \
417    ./configure \
418       <your-options>
419 \end{verbatim}
420 \normalsize
421
422 On some systems such as Mandriva, readline tends to
423 gobble up prompts, which makes it totally useless. If this happens to you, use
424 the disable option, or if you are using version 1.33 and above try using {\bf
425 \verb:--:enable-conio} to use a built-in readline replacement. You will still need
426 either the termcap or the ncurses library, but it is unlikely that the {\bf conio}
427 package will gobble up prompts. 
428
429 readline is no longer supported after version 1.34.  The code within Bacula
430 remains, so it should be usable, and if users submit patches for it, I will
431 be happy to apply them.  However, due to the fact that each version of
432 readline seems to be incompatible with previous versions, and that there
433 are significant differences between systems, I can no longer afford to
434 support it.
435
436 \subsection*{What Database to Use?}
437 \label{DB}
438 \index[general]{What Database to Use? }
439 \index[general]{Use!What Database to }
440 \addcontentsline{toc}{subsection}{What Database to Use?}
441
442 Before building Bacula you need to decide if you want to use SQLite, MySQL, or
443 PostgreSQL. If you are not already running MySQL or PostgreSQL, you might
444 want to start by testing with SQLite. This will greatly simplify the setup for you
445 because SQLite is compiled into Bacula an requires no administration. It
446 performs well and is suitable for small to medium sized installations (maximum
447 10-20 machines). However, we should note that a number of users have
448 had unexplained database corruption with SQLite. For that reason, we
449 recommend that you install either MySQL or PostgreSQL for production
450 work.
451
452 If you wish to use MySQL as the Bacula catalog, please see the 
453 \ilink{Installing and Configuring MySQL}{_ChapterStart} chapter of
454 this manual. You will need to install MySQL prior to continuing with the
455 configuration of Bacula. MySQL is a high quality database that is very
456 efficient and is suitable for any sized installation. It is slightly more
457 complicated than SQLite to setup and administer because it has a number of
458 sophisticated features such as userids and passwords. It runs as a separate
459 process, is truly professional and can manage a database of any size. 
460
461 If you wish to use PostgreSQL as the Bacula catalog, please see the 
462 \ilink{Installing and Configuring PostgreSQL}{_ChapterStart10}
463 chapter of this manual. You will need to install PostgreSQL prior to
464 continuing with the configuration of Bacula. PostgreSQL is very similar to
465 MySQL, though it tends to be slightly more SQL92 compliant and has many more
466 advanced features such as transactions, stored procedures, and the such. It
467 requires a certain knowledge to install and maintain. 
468
469 If you wish to use SQLite as the Bacula catalog, please see 
470 \ilink{Installing and Configuring SQLite}{_ChapterStart33} chapter of
471 this manual. 
472
473 \subsection*{Quick Start}
474 \index[general]{Quick Start }
475 \index[general]{Start!Quick }
476 \addcontentsline{toc}{subsection}{Quick Start}
477
478 There are a number of options and important considerations given below
479 that you can skip for the moment if you have not had any problems building
480 Bacula with a simplified configuration as shown above. 
481       
482 If the ./configure process is unable to find specific libraries (e.g.    
483 libintl, you should ensure that the appropriate package is installed on
484 your system. Alternatively, if the package is installed in a non-standard
485 location (as far as Bacula is concerned), then there is generally an
486 option listed below (or listed with "./configure {-}{-}help" that will
487 permit you to specify the directory that should be searched. In other
488 cases, there are options that will permit you to disable to feature 
489 (e.g. {-}{-}disable-nls).
490
491 If you want to dive right into it, we recommend you skip to the next chapter,
492 and run the example program. It will teach you a lot about Bacula and as an
493 example can be installed into a single directory (for easy removal) and run as
494 non-root. If you have any problems or when you want to do a real installation,
495 come back to this chapter and read the details presented below. 
496
497 \subsection*{Configure Options}
498 \label{Options}
499 \index[general]{Options!Configure }
500 \index[general]{Configure Options }
501 \addcontentsline{toc}{subsection}{Configure Options}
502
503 The following command line options are available for {\bf configure} to
504 customize your installation. 
505
506 \begin{description}
507 \item [ {-}{-}sysbindir=\lt{}binary-path\gt{}]
508    \index[general]{{-}{-}sysbindir }
509    Defines where the Bacula  binary (executable) files will be placed during a
510    {\bf make  install} command.  
511
512 \item [ {-}{-}sysconfdir=\lt{}config-path\gt{}]
513    \index[general]{{-}{-}sysconfdir }
514    Defines where the Bacula configuration files should be placed during a
515    {\bf make install} command.
516
517 \item [ {-}{-}mandir=\lt{}path\gt{}]
518    \index[general]{{-}{-}mandir}
519    By default, Bacula will install a simple Unix man page in 
520    /usr/share/man.  If you wish the man page to be installed in
521    a different location, use this option to specify the path.
522    Note, the main HTML and PDF Bacula documents are in a separate
523    tar file that is not part of the source distribution.
524
525 \item [ {-}{-}datadir=\lt{}path\gt{}]
526    \index[general]{{-}{-}datadir}
527    If you translate Bacula or parts of Bacula into a different language
528    you may specify the location of the po files using the {\bf
529    {-}{-}datadir} option. You must manually install any po files as
530    Bacula does not (yet) automatically do so.
531
532
533 \item [ {-}{-}enable-smartalloc ]
534    \index[general]{{-}{-}enable-smartalloc }
535    This enables the inclusion of the Smartalloc orphaned buffer detection
536    code.  This option is highly recommended.  Because we never build
537    without this option, you may experience problems if it is not enabled.
538    In this case, simply re-enable the option.  We strongly recommend
539    keeping this option enabled as it helps detect memory leaks.  This
540    configuration parameter is used while building Bacula
541
542 \item [ {-}{-}enable-gnome ]
543    \index[general]{{-}{-}enable-gnome }
544    If you have GNOME installed on your computer including the
545    gnome development libraries, and you want to use the
546    GNOME GUI Console interface to Bacula, you must specify this option.
547    Doing so will build everything in the {\bf src/gnome-console} directory.
548
549 \item [ {-}{-}enable-wx-console ]
550    \index[general]{{-}{-}enable-wx-console }
551    If you have wxWidgets installed on your computer and you want to use the
552    wxWidgets GUI Console interface to Bacula, you must specify this option.
553    Doing so will build everything in the {\bf src/wx-console} directory.
554    This could also be useful to users who want a GUI Console and don't want
555    to install Gnome, as wxWidgets can work with GTK+, Motif or even X11
556    libraries.
557
558
559 \item [ {-}{-}enable-tray-monitor ]
560    \index[general]{{-}{-}enable-tray-monitor }
561    If you have GTK installed on your computer, you run a graphical
562    environment or a window manager compatible with the FreeDesktop system
563    tray standard (like KDE and GNOME) and you want to use a GUI to monitor
564    Bacula daemons, you must specify this option.  Doing so will build
565    everything in the {\bf src/tray-monitor} directory.
566
567 \item [ {-}{-}enable-static-tools]
568    \index[general]{{-}{-}enable-static-tools }
569    This option causes the linker to link the Storage daemon utility tools
570    ({\bf bls}, {\bf bextract}, and {\bf bscan}) statically.  This permits
571    using them without having the shared libraries loaded.  If you have
572    problems linking in the {\bf src/stored} directory, make sure you have
573    not enabled this option, or explicitly disable static linking by adding
574    {\bf \verb:--:disable-static-tools}.
575
576
577 \item [ {-}{-}enable-static-fd]
578    \index[general]{{-}{-}enable-static-fd }
579    This option causes the make process to build a {\bf static-bacula-fd} in
580    addition to the standard File daemon.  This static version will include
581    statically linked libraries and is required for the Bare Metal recovery.
582    This option is largely superseded by using {\bf make static-bacula-fd}
583    from with in the {\bf src/filed} directory.  Also, the {\bf
584    \verb:--:enable-client-only} option described below is useful for just
585    building a client so that all the other parts of the program are not
586    compiled.   
587      
588    When linking a static binary, the linker needs the static versions
589    of all the libraries that are used, so frequently users will 
590    experience linking errors when this option is used. The first 
591    thing to do is to make sure you have the static glibc library 
592    installed on your system. The second thing to do is the make sure
593    you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
594    on your ./configure statement as these options require additional
595    libraries. You may be able to enable those options, but you will
596    need to load additional static libraries.
597
598
599 \item [ {-}{-}enable-static-sd]
600    \index[general]{{-}{-}enable-static-sd }
601    This option causes the make process to build a {\bf static-bacula-sd} in
602    addition to the standard Storage daemon.  This static version will
603    include statically linked libraries and could be useful during a Bare
604    Metal recovery.
605
606    When linking a static binary, the linker needs the static versions
607    of all the libraries that are used, so frequently users will 
608    experience linking errors when this option is used. The first 
609    thing to do is to make sure you have the static glibc library 
610    installed on your system. The second thing to do is the make sure
611    you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
612    on your ./configure statement as these options require additional
613    libraries. You may be able to enable those options, but you will
614    need to load additional static libraries.
615
616  
617
618 \item [ {-}{-}enable-static-dir]
619    \index[general]{{-}{-}enable-static-dir }
620    This option causes the make process to build a {\bf static-bacula-dir}
621    in addition to the standard Director.  This static version will include
622    statically linked libraries and could be useful during a Bare Metal
623    recovery.
624
625    When linking a static binary, the linker needs the static versions
626    of all the libraries that are used, so frequently users will 
627    experience linking errors when this option is used. The first 
628    thing to do is to make sure you have the static glibc library 
629    installed on your system. The second thing to do is the make sure
630    you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
631    on your ./configure statement as these options require additional
632    libraries. You may be able to enable those options, but you will
633    need to load additional static libraries.
634
635
636 \item [ {-}{-}enable-static-cons]
637    \index[general]{{-}{-}enable-static-cons }
638    This option causes the make process to build a {\bf static-console} and
639    a {\bf static-gnome-console} in addition to the standard console.  This
640    static version will include statically linked libraries and could be
641    useful during a Bare Metal recovery.
642
643    When linking a static binary, the linker needs the static versions
644    of all the libraries that are used, so frequently users will 
645    experience linking errors when this option is used. The first 
646    thing to do is to make sure you have the static glibc library 
647    installed on your system. The second thing to do is the make sure
648    you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
649    on your ./configure statement as these options require additional
650    libraries. You may be able to enable those options, but you will
651    need to load additional static libraries.
652
653
654 \item [ {-}{-}enable-client-only]
655    \index[general]{{-}{-}enable-client-only }
656    This option causes the make process to build only the File daemon and
657    the libraries that it needs.  None of the other daemons, storage tools,
658    nor the console will be built.  Likewise a {\bf make install} will then
659    only install the File daemon.  To cause all daemons to be built, you
660    will need to do a configuration without this option.  This option
661    greatly facilitates building a Client on a client only machine.
662
663    When linking a static binary, the linker needs the static versions
664    of all the libraries that are used, so frequently users will 
665    experience linking errors when this option is used. The first 
666    thing to do is to make sure you have the static glibc library 
667    installed on your system. The second thing to do is the make sure
668    you do not specify {\bf {-}{-}openssl} or {\bf {-}{-}with-python}
669    on your ./configure statement as these options require additional
670    libraries. You may be able to enable those options, but you will
671    need to load additional static libraries.
672
673
674 \item [ {-}{-}enable-largefile]
675    \index[general]{{-}{-}enable-largefile }
676    This option (default) causes  Bacula to be built with 64 bit file address
677    support if it  is available on your system. This permits Bacula to read and 
678    write files greater than 2 GBytes in size. You may disable this  feature and
679    revert to 32 bit file addresses by using  {\bf \verb:--:disable-largefile}.  
680
681 \item [ {-}{-}disable-nls]
682    \index[general]{{-}{-}disable-nls}
683    By default, Bacula uses the GNU Native Language Support (NLS) libraries. On
684    some machines, these libraries may not be present or may not function 
685    correctly (especially on non-Linux implementations). In such cases, you
686    may specify {\bf {-}{-}disable-nls} to disable use of those libraries.
687    In such a case, Bacula will revert to using English.
688
689 \item [ {-}{-}with-sqlite=\lt{}sqlite-path\gt{}]
690    \index[general]{{-}{-}with-sqlite }
691    This enables use of the SQLite version 2.8.x database. The {\bf sqlite-path} is not
692    normally  specified as Bacula looks for the necessary components in  a
693    standard location ({\bf depkgs/sqlite}). See 
694    \ilink{Installing and Configuring SQLite}{_ChapterStart33} chapter of
695     this manual for more details.  
696
697    See the note below under the {-}{-}with-postgresql item.
698
699 \item [ {-}{-}with-sqlite3=\lt{}sqlite3-path\gt{}]
700    \index[general]{{-}{-}with-sqlite3 }
701    This enables use of the SQLite version 3.x database.  The {\bf
702    sqlite3-path} is not normally specified as Bacula looks for the
703    necessary components in a standard location ({\bf depkgs/sqlite3}).  See
704    \ilink{Installing and Configuring SQLite}{_ChapterStart33} chapter of
705    this manual for more details.
706
707 \item [ {-}{-}with-mysql=\lt{}mysql-path\gt{}]
708    \index[general]{{-}{-}with-mysql }
709    This enables building of the Catalog services for Bacula.  It assumes
710    that MySQL is running on your system, and expects it to be installed in
711    the {\bf mysql-path} that you specify.  Normally, if MySQL is installed
712    in a standard system location, you can simply use {\bf {-}{-}with-mysql}
713    with no path specification.  If you do use this option, please proceed
714    to installing MySQL in the \ilink{Installing and Configuring
715    MySQL}{_ChapterStart} chapter before proceeding with the configuration.
716
717    See the note below under the {-}{-}with-postgresql item.
718
719 \item [ {-}{-}with-postgresql=\lt{}path\gt{}]
720    \index[general]{{-}{-}with-postgresql }
721    This provides an explicit path to the PostgreSQL libraries if Bacula
722    cannot find it by default.  Normally to build with PostgreSQL, you would
723    simply use {\bf {-}{-}with-postgresql}.
724
725    Note, for Bacula to be configured properly, you must specify one
726    of the four database options supported.  That is:
727    {-}{-}with-sqlite, {-}{-}with-sqlite3, {-}{-}with-mysql, or
728    {-}{-}with-postgresql, otherwise the ./configure will fail.
729
730 \item [ {-}{-}with-openssl=\lt{}path\gt{}]
731    This configuration option is necessary if you want to enable TLS (ssl)
732    in Bacula. Normally, the {\bf path} specification is not necessary since
733    the configuration searches for the OpenSSL libraries in standard system
734    locations. Enabling OpenSSL in Bacula permits secure communications
735    between the daemons. For more information on using TLS, please see the
736    \ilink{Bacula TLS}{_ChapterStart61} chapter of this manual.
737
738
739 \item [ {-}{-}with-python=\lt{}path\gt{}]
740    \index[general]{{-}{-}with-python }
741    This option enables Bacula support for Python. If no path is 
742    supplied, configure will search the     
743    standard library locations for Python 2.2, 2.3, or 2.4. If it cannot
744    find the library, you will need to supply a path to your Python
745    library directory.  Please see the 
746    \ilink{Python chapter}{_ChapterStart60} for the details of using
747    Python scripting.
748
749 \item [ {-}{-}with-libintl-prefix=\lt{}DIR\gt{}]
750    \index[general]{{-}{-}with-libintl-prefix}
751    This option may be used to tell Bacula to search DIR/include and
752    DIR/lib for the libintl headers and libraries needed for Native
753    Language Support (NLS).
754
755 \item [ {-}{-}enable-conio]
756    \index[general]{{-}{-}enable-conio }
757    Tells Bacula to enable building the small, light weight readline
758    replacement routine.  It is generally much easier to configure than
759    readline, although, like readline, it needs either the termcap or
760    ncurses library.
761
762 \item [ {-}{-}with-readline=\lt{}readline-path\gt{}]
763    \index[general]{{-}{-}with-readline }
764    Tells Bacula where {\bf readline} is installed.  Normally, Bacula will
765    find readline if it is in a standard library.  If it is not found and no
766    {-}{-}with-readline is specified, readline will be disabled.  This
767    option affects the Bacula build.  Readline provides the Console program
768    with a command line history and editing capability and is no longer
769    supported, so you are on your own if you have problems.
770
771 \item [ {-}{-}enable-readline]
772    \index[general]{{-}{-}enable-readline }
773    Tells Bacula to enable readline support.  It is normally disabled due to the
774    large number of configuration  problems and the fact that the package seems to
775    change in incompatible  ways from version to version.  
776
777 \item [ {-}{-}with-tcp-wrappers=\lt{}path\gt{}]
778    \index[general]{{-}{-}with-tcp-wrappers }
779    This specifies that you  want TCP wrappers (man hosts\_access(5)) compiled in.
780    The path is optional since  Bacula will normally find the libraries in the
781    standard locations.  This option affects the Bacula build.  In specifying your
782    restrictions in the {\bf /etc/hosts.allow}  or {\bf /etc/hosts.deny} files, do
783    not use the {\bf twist}  option (hosts\_options(5)) or the Bacula process will
784    be terminated. Note, when setting up your {\bf /etc/hosts.allow}
785    or {\bf /etc/hosts.deny}, you must identify the Bacula daemon in
786    question with the name you give it in your conf file rather than the
787    name of the executable.
788    
789    For more information on configuring and testing TCP wrappers, please  see the 
790    \ilink{Configuring and Testing TCP Wrappers}{wrappers}  section
791    in the Security Chapter.  
792
793 \item [ {-}{-}with-working-dir=\lt{}working-directory-path\gt{} ]
794    \index[general]{{-}{-}with-working-dir }
795    This option is mandatory and specifies a directory  into which Bacula may
796    safely place files that  will remain between Bacula executions. For example, 
797    if the internal database is used, Bacula will keep  those files in this
798    directory.  This option is only used to modify the daemon  configuration
799    files. You may also accomplish the same  thing by directly editing them later.
800    The working directory  is not automatically created by the install process, so
801    you  must ensure that it exists before using Bacula for the  first time. 
802
803 \item [ {-}{-}with-base-port=\lt{}port=number\gt{}]
804    \index[general]{{-}{-}with-base-port }
805    In order to run,  Bacula needs three TCP/IP ports (one for the Bacula 
806    Console, one for the Storage daemon, and one for the File daemon).  The {\bf
807    \verb:--:with-baseport} option will automatically assign three  ports beginning at
808    the base port address specified. You may  also change the port number in the
809    resulting configuration  files. However, you need to take care that the
810    numbers  correspond correctly in each of the three daemon configuration 
811    files. The default base port is 9101, which assigns ports 9101  through 9103.
812    These ports (9101, 9102, and 9103) have been  officially assigned to Bacula by
813    IANA.  This option is only used  to modify the daemon configuration files. You
814    may also accomplish  the same thing by directly editing them later. 
815
816 \item [ {-}{-}with-dump-email=\lt{}email-address\gt{}]
817    \index[general]{{-}{-}with-dump-email }
818    This option specifies  the email address where any core dumps should be set.
819    This option  is normally only used by developers.  
820
821 \item [ {-}{-}with-pid-dir=\lt{}PATH\gt{}  ]
822    \index[general]{{-}{-}with-pid-dir }
823    This specifies where Bacula should place the process id  file during
824    execution. The default is: {\bf /var/run}.  This directory is not created by
825    the install process, so  you must ensure that it exists before using Bacula
826    the  first time.  
827
828 \item [ {-}{-}with-subsys-dir=\lt{}PATH\gt{}]
829    \index[general]{{-}{-}with-subsys-dir }
830    This specifies where Bacula should place the subsystem lock  file during
831    execution. The default is {\bf /var/run/subsys}.  Please make sure that you do
832    not specify the same directory  for this directory and for the {\bf sbindir}
833    directory.  This directory is used only within the autostart scripts.  The
834    subsys directory is not created by the Bacula install,  so you must be sure to
835    create it before using Bacula. 
836
837 \item [ {-}{-}with-dir-password=\lt{}Password\gt{}]
838    \index[general]{{-}{-}with-dir-password }
839    This option allows you to specify the password used to  access the Directory
840    (normally from the Console program).  If it is not specified, configure will
841    automatically create a random  password.  
842
843 \item [ {-}{-}with-fd-password=\lt{}Password\gt{} ]
844    \index[general]{{-}{-}with-fd-password }
845    This option allows you to specify the password used to  access the File daemon
846    (normally called from the Director).  If it is not specified, configure will
847    automatically create a random  password.  
848
849 \item [ {-}{-}with-sd-password=\lt{}Password\gt{} ]
850    \index[general]{{-}{-}with-sd-password }
851    This option allows you to specify the password used to  access the Directory
852    (normally called from the Director).  If it is not specified, configure will
853    automatically create a random  password.  
854
855 \item [ {-}{-}with-dir-user=\lt{}User\gt{} ]
856    \index[general]{{-}{-}with-dir-user }
857    This option allows you to specify the Userid used to run the Director.  The
858    Director must be started as root, but doesn't need to run as root, and
859    after doing preliminary initializations, it can "drop" to the UserId
860    specified on this option.  
861    If you specify this option, you must
862    create the User prior to running {\bf make install}, because the
863    working directory owner will be set to {\bf User}.
864                        
865
866 \item [ {-}{-}with-dir-group=\lt{}Group\gt{} ]
867    \index[general]{{-}{-}with-dir-group }
868    This option allows you to specify the GroupId used to  run the Director. The
869    Director must be started as root, but  doesn't need to run as root, and  after
870    doing preliminary initializations, it can "drop"  to the GroupId specified
871    on this option. 
872    If you specify this option, you must
873    create the Group prior to running {\bf make install}, because the
874    working directory group will be set to {\bf Group}.
875
876 \item [ {-}{-}with-sd-user=\lt{}User\gt{} ]
877    \index[general]{{-}{-}with-sd-user }
878    This option allows you to specify the Userid used to  run the Storage daemon.
879    The Storage daemon must be started as root, but  doesn't need to run as root,
880    and  after doing preliminary initializations, it can "drop"  to the UserId
881    specified on this option. If you use this option,  you will need to take care
882    that the Storage daemon has access  to all the devices (tape drives, ...) that
883    it needs. 
884
885 \item [ {-}{-}with-sd-group=\lt{}Group\gt{} ]
886    \index[general]{{-}{-}with-sd-group }
887    This option allows you to specify the GroupId used to  run the Storage daemon.
888    The Storage daemon must be started as root, but  doesn't need to run as root,
889    and  after doing preliminary initializations, it can "drop"  to the GroupId
890    specified on this option. 
891
892 \item [ {-}{-}with-fd-user=\lt{}User\gt{} ]
893    \index[general]{{-}{-}with-fd-user }
894    This option allows you to specify the Userid used to  run the File daemon. The
895    File daemon must be started as root,  and in most cases, it needs to run as
896    root, so this option is  used only in very special cases,  after doing
897    preliminary initializations, it can "drop"  to the UserId specified on this
898    option. 
899
900 \item [ {-}{-}with-fd-group=\lt{}Group\gt{} ]
901    \index[general]{{-}{-}with-fd-group }
902    This option allows you to specify the GroupId used to  run the File daemon.
903    The File daemon must be started as root, and  in most cases, it must be run as
904    root, however,  after doing preliminary initializations, it can "drop"  to
905    the GroupId specified on this option. 
906
907 \end{description}
908
909 Note, many other options are presented when you do a {\bf ./configure
910 \verb:--:help}, but they are not implemented.
911
912 \subsection*{Recommended Options for most Systems}
913 \index[general]{Systems!Recommended Options for most }
914 \index[general]{Recommended Options for most Systems }
915 \addcontentsline{toc}{subsection}{Recommended Options for most Systems}
916
917 For most systems, we recommend starting with the following options: 
918
919 \footnotesize
920 \begin{verbatim}
921 ./configure \
922   --enable-smartalloc \
923   --sbindir=$HOME/bacula/bin \
924   --sysconfdir=$HOME/bacula/bin \
925   --with-pid-dir=$HOME/bacula/bin/working \
926   --with-subsys-dir=$HOME/bacula/bin/working \
927   --with-mysql=$HOME/mysql \
928   --with-working-dir=$HOME/bacula/working
929 \end{verbatim}
930 \normalsize
931
932 If you want to install Bacula in an installation directory rather than run it
933 out of the build directory (as developers will do most of the time), you
934 should also include the \verb:--:sbindir and \verb:--:sysconfdir options with appropriate
935 paths. Neither are necessary if you do not use "make install" as is the case
936 for most development work. The install process will create the sbindir and
937 sysconfdir if they do not exist, but it will not automatically create the
938 pid-dir, subsys-dir, or working-dir, so you must ensure that they exist before
939 running Bacula for the first time. See below for an example of how Kern does
940 it. 
941
942 \subsection*{RedHat}
943 \index[general]{RedHat }
944 \addcontentsline{toc}{subsection}{RedHat}
945
946 Using SQLite: 
947
948 \footnotesize
949 \begin{verbatim}
950  
951 CFLAGS="-g -Wall" ./configure \
952   --sbindir=$HOME/bacula/bin \
953   --sysconfdir=$HOME/bacula/bin \
954   --enable-smartalloc \
955   --with-sqlite=$HOME/bacula/depkgs/sqlite \
956   --with-working-dir=$HOME/bacula/working \
957   --with-pid-dir=$HOME/bacula/bin/working \
958   --with-subsys-dir=$HOME/bacula/bin/working \
959   --enable-gnome \
960   --enable-conio
961 \end{verbatim}
962 \normalsize
963
964 or 
965
966 \footnotesize
967 \begin{verbatim}
968  
969 CFLAGS="-g -Wall" ./configure \
970   --sbindir=$HOME/bacula/bin \
971   --sysconfdir=$HOME/bacula/bin \
972   --enable-smartalloc \
973   --with-mysql=$HOME/mysql \
974   --with-working-dir=$HOME/bacula/working
975   --with-pid-dir=$HOME/bacula/bin/working \
976   --with-subsys-dir=$HOME/bacula/bin/working
977   --enable-gnome \
978   --enable-conio
979 \end{verbatim}
980 \normalsize
981
982 or finally, a completely traditional RedHat Linux install: 
983
984 \footnotesize
985 \begin{verbatim}
986 CFLAGS="-g -Wall" ./configure \
987   --prefix=/usr \
988   --sbindir=/usr/sbin \
989   --sysconfdir=/etc/bacula \
990   --with-scriptdir=/etc/bacula \
991   --enable-smartalloc \
992   --enable-gnome \
993   --with-mysql \
994   --with-working-dir=/var/bacula \
995   --with-pid-dir=/var/run \
996   --with-subsys-dir=/var/lock/subsys \
997   --enable-conio
998 \end{verbatim}
999 \normalsize
1000
1001 Note, Bacula assumes that /var/bacula, /var/run, and /var/loc/subsys exist so
1002 it will not automatically create them during the install process. 
1003
1004 Note, with gcc (GCC) 4.0.1 20050727 (Red Hat 4.0.1-5) on
1005 an AMD64 CPU running 64 bit CentOS4, there is a compiler bug that generates
1006 bad code that causes Bacula to segment fault.  Typically you will see this
1007 in the Storage daemon first.  The solution is to compile Bacula ensuring
1008 that no optimization is turned on (normally it is -O2).
1009
1010 \subsection*{Solaris}
1011 \index[general]{Solaris }
1012 \addcontentsline{toc}{subsection}{Solaris}
1013
1014 To build Bacula from source, you will need the following installed on your
1015 system (they are not by default): libiconv, gcc 3.3.2, stdc++, libgcc (for
1016 stdc++ and gcc\_s libraries), make 3.8 or later. 
1017
1018 You will probably also need to: Add /usr/local/bin to PATH and Add
1019 /usr/ccs/bin to PATH for ar. 
1020
1021 \footnotesize
1022 \begin{verbatim}
1023 #!/bin/sh
1024 CFLAGS="-g" ./configure \
1025   --sbindir=$HOME/bacula/bin \
1026   --sysconfdir=$HOME/bacula/bin \
1027   --with-mysql=$HOME/mysql \
1028   --enable-smartalloc \
1029   --with-pid-dir=$HOME/bacula/bin/working \
1030   --with-subsys-dir=$HOME/bacula/bin/working \
1031   --with-working-dir=$HOME/bacula/working
1032 \end{verbatim}
1033 \normalsize
1034
1035 As mentioned above, the install process will create the sbindir and sysconfdir
1036 if they do not exist, but it will not automatically create the pid-dir,
1037 subsys-dir, or working-dir, so you must ensure that they exist before running
1038 Bacula for the first time.
1039
1040 Note, you may need to install the following packages to build Bacula
1041 from source:
1042 \footnotesize
1043 \begin{verbatim}
1044 SUNWbinutils,
1045 SUNWarc,
1046 SUNWhea,
1047 SUNWGcc,
1048 SUNWGnutls
1049 SUNWGnutls-devel
1050 SUNWGmake
1051 SUNWgccruntime
1052 SUNWlibgcrypt
1053 SUNWzlib
1054 SUNWzlibs
1055 SUNWbinutilsS
1056 SUNWGmakeS
1057 SUNWlibm
1058
1059 export 
1060 PATH=/usr/bin::/usr/ccs/bin:/etc:/usr/openwin/bin:/usr/local/bin:/usr/sfw/bin:/opt/sfw/bin:/usr/ucb:/usr/sbin
1061 \end{verbatim}
1062 \normalsize
1063
1064 \subsection*{FreeBSD}
1065 \index[general]{FreeBSD }
1066 \addcontentsline{toc}{subsection}{FreeBSD}
1067
1068 Please see: 
1069 \elink{The FreeBSD Diary}{http://www.freebsddiary.org/bacula.php} for a
1070 detailed description on how to make Bacula work on your system. In addition,
1071 users of FreeBSD prior to 4.9-STABLE dated Mon Dec 29 15:18:01 2003 UTC who
1072 plan to use tape devices, please see the 
1073 \ilink{Tape Testing Chapter}{FreeBSDTapes} of this manual for
1074 {\bf important} information on how to configure your tape drive for
1075 compatibility with Bacula. 
1076
1077 If you are using Bacula with MySQL, you should take care to compile MySQL with
1078 FreeBSD native threads rather than LinuxThreads, since Bacula is normally built
1079 with FreeBSD native threads rather than LinuxTreads. Mixing the two will
1080 probably not work. 
1081
1082 \subsection*{Win32}
1083 \index[general]{Win32 }
1084 \addcontentsline{toc}{subsection}{Win32}
1085
1086 To install the binary Win32 version of the File daemon please see the 
1087 \ilink{Win32 Installation Chapter}{_ChapterStart7} in this document. 
1088
1089 \subsection*{Windows Systems with CYGWIN Installed}
1090 \label{Win32}
1091 \index[general]{Windows Systems with CYGWIN Installed }
1092 \index[general]{Installed!Windows Systems with CYGWIN }
1093 \addcontentsline{toc}{subsection}{Windows Systems with CYGWIN Installed}
1094
1095 As of version 1.34, Bacula no longer uses CYGWIN for the Win32 File daemon.
1096 However, it is still built under a CYGWIN build environment -- though you
1097 can probably do it with VC Studio only.  If you wish to build the Win32
1098 File daemon from the source, you will need Microsoft C++ version 7.1.
1099 Details for building the Win32 FD are in the README.win32 file of the
1100 src/win32 directory.
1101
1102 Note, although most parts of Bacula build on Windows systems, the only part
1103 that we have tested and used is the File daemon. 
1104
1105 Finally, you should follow the installation instructions in the 
1106 \ilink{Win32 Installation}{_ChapterStart7} section of this document. 
1107
1108 \subsection*{Kern's Configure Script}
1109 \index[general]{Script!Kern's Configure }
1110 \index[general]{Kern's Configure Script }
1111 \addcontentsline{toc}{subsection}{Kern's Configure Script}
1112
1113 The script that I use for building on my "production" Linux machines is: 
1114
1115 \footnotesize
1116 \begin{verbatim}
1117 #!/bin/sh
1118 # This is Kern's configure script for Bacula
1119 CFLAGS="-g -Wall" \
1120   ./configure \
1121     --sbindir=$HOME/bacula/bin \
1122     --sysconfdir=$HOME/bacula/bin \
1123     --enable-smartalloc \
1124     --enable-gnome \
1125     --with-pid-dir=$HOME/bacula/bin/working \
1126     --with-subsys-dir=$HOME/bacula/bin/working \
1127     --with-mysql=$HOME/mysql \
1128     --with-working-dir=$HOME/bacula/bin/working \
1129     --with-dump-email=$USER \
1130     --with-smtp-host=mail.your-site.com \
1131     --with-baseport=9101
1132 exit 0
1133 \end{verbatim}
1134 \normalsize
1135
1136 Note that I define the base port as 9101, which means that Bacula will use
1137 port 9101 for the Director console, port 9102 for the File daemons, and port
1138 9103 for the Storage daemons. These ports should be available on all systems
1139 because they have been officially assigned to Bacula by IANA (Internet
1140 Assigned Numbers Authority). We strongly recommend that you use only these
1141 ports to prevent any conflicts with other programs. This is in fact the
1142 default if you do not specify a {\bf \verb:--:with-baseport} option. 
1143
1144 You may also want to put the following entries in your {\bf /etc/services}
1145 file as it will make viewing the connections made by Bacula easier to
1146 recognize (i.e. netstat -a): 
1147
1148 \footnotesize
1149 \begin{verbatim}
1150 bacula-dir      9101/tcp
1151 bacula-fd       9102/tcp
1152 bacula-sd       9103/tcp
1153 \end{verbatim}
1154 \normalsize
1155
1156 \subsection*{Installing Bacula}
1157 \index[general]{Bacula!Installing }
1158 \index[general]{Installing Bacula }
1159 \addcontentsline{toc}{subsection}{Installing Bacula}
1160
1161 Before setting up your configuration files, you will want to install Bacula in
1162 its final location. Simply enter: 
1163
1164 \footnotesize
1165 \begin{verbatim}
1166 make install
1167 \end{verbatim}
1168 \normalsize
1169
1170 If you have previously installed Bacula, the old binaries will be overwritten,
1171 but the old configuration files will remain unchanged, and the "new"
1172 configuration files will be appended with a {\bf .new}. Generally if you have
1173 previously installed and run Bacula you will want to discard or ignore the
1174 configuration files with the appended {\bf .new}. 
1175
1176 \subsection*{Building a File Daemon or Client}
1177 \index[general]{Client!Building a File Daemon or }
1178 \index[general]{Building a File Daemon or Client }
1179 \addcontentsline{toc}{subsection}{Building a File Daemon or Client}
1180
1181 If you run the Director and the Storage daemon on one machine and you wish to
1182 back up another machine, you must have a copy of the File daemon for that
1183 machine. If the machine and the Operating System are identical, you can simply
1184 copy the Bacula File daemon binary file {\bf bacula-fd} as well as its
1185 configuration file {\bf bacula-fd.conf} then modify the name and password in
1186 the conf file to be unique. Be sure to make corresponding additions to the
1187 Director's configuration file ({\bf bacula-dir.conf}). 
1188
1189 If the architecture or the O/S level are different, you will need to build a
1190 File daemon on the Client machine. To do so, you can use the same {\bf
1191 ./configure} command as you did for your main program, starting either from a
1192 fresh copy of the source tree, or using {\bf make\ distclean} before the {\bf
1193 ./configure}. 
1194
1195 Since the File daemon does not access the Catalog database, you can remove
1196 the {\bf \verb:--:with-mysql} or {\bf \verb:--:with-sqlite} options, then
1197 add {\bf \verb:--:enable-client-only}.  This will compile only the
1198 necessary libraries and the client programs and thus avoids the necessity
1199 of installing one or another of those database programs to build the File
1200 daemon.  With the above option, you simply enter {\bf make} and just the
1201 client will be built.
1202
1203 \label{autostart}
1204 \subsection*{Auto Starting the Daemons}
1205 \index[general]{Daemons!Auto Starting the }
1206 \index[general]{Auto Starting the Daemons }
1207 \addcontentsline{toc}{subsection}{Auto Starting the Daemons}
1208
1209 If you wish the daemons to be automatically started and stopped when your
1210 system is booted (a good idea), one more step is necessary. First, the
1211 ./configure process must recognize your system -- that is it must be a
1212 supported platform and not {\bf unknown}, then you must install the platform
1213 dependent files by doing: 
1214
1215 \footnotesize
1216 \begin{verbatim}
1217 (become root)
1218 make install-autostart
1219 \end{verbatim}
1220 \normalsize
1221
1222 Please note, that the auto-start feature is implemented only on systems
1223 that we officially support (currently, FreeBSD, RedHat/Fedora Linux, and
1224 Solaris), and has only been fully tested on Fedora Linux.
1225
1226 The {\bf make install-autostart} will cause the appropriate startup scripts
1227 to be installed with the necessary symbolic links.  On RedHat/Fedora Linux
1228 systems, these scripts reside in {\bf /etc/rc.d/init.d/bacula-dir} {\bf
1229 /etc/rc.d/init.d/bacula-fd}, and {\bf /etc/rc.d/init.d/bacula-sd}.  However
1230 the exact location depends on what operating system you are using.
1231
1232 If you only wish to install the File daemon, you may do so with: 
1233
1234 \footnotesize
1235 \begin{verbatim}
1236 make install-autostart-fd
1237 \end{verbatim}
1238 \normalsize
1239
1240 \subsection*{Other Make Notes}
1241 \index[general]{Notes!Other Make }
1242 \index[general]{Other Make Notes }
1243 \addcontentsline{toc}{subsection}{Other Make Notes}
1244
1245 To simply build a new executable in any directory, enter: 
1246
1247 \footnotesize
1248 \begin{verbatim}
1249 make
1250 \end{verbatim}
1251 \normalsize
1252
1253 To clean out all the objects and binaries (including the files named 1, 2, or
1254 3, which Kern uses as temporary files), enter: 
1255
1256 \footnotesize
1257 \begin{verbatim}
1258 make clean
1259 \end{verbatim}
1260 \normalsize
1261
1262 To really clean out everything for distribution, enter: 
1263
1264 \footnotesize
1265 \begin{verbatim}
1266 make distclean
1267 \end{verbatim}
1268 \normalsize
1269
1270 note, this cleans out the Makefiles and is normally done from the top level
1271 directory to prepare for distribution of the source. To recover from this
1272 state, you must redo the {\bf ./configure} in the top level directory, since
1273 all the Makefiles will be deleted. 
1274
1275 To add a new file in a subdirectory, edit the Makefile.in in that directory,
1276 then simply do a {\bf make}. In most cases, the make will rebuild the Makefile
1277 from the new Makefile.in. In some case, you may need to issue the {\bf make} a
1278 second time. In extreme cases, cd to the top level directory and enter: {\bf
1279 make Makefiles}. 
1280
1281 To add dependencies: 
1282
1283 \footnotesize
1284 \begin{verbatim}
1285 make depend
1286 \end{verbatim}
1287 \normalsize
1288
1289 The {\bf make depend} appends the header file dependencies for each of the
1290 object files to Makefile and Makefile.in. This command should be done in each
1291 directory where you change the dependencies. Normally, it only needs to be run
1292 when you add or delete source or header files. {\bf make depend} is normally
1293 automatically invoked during the configuration process. 
1294
1295 To install: 
1296
1297 \footnotesize
1298 \begin{verbatim}
1299 make install
1300 \end{verbatim}
1301 \normalsize
1302
1303 This not normally done if you are developing Bacula, but is used if you are
1304 going to run it to backup your system. 
1305
1306 After doing a {\bf make install} the following files will be installed on your
1307 system (more or less). The exact files and location (directory) for each file
1308 depends on your {\bf ./configure} command (e.g. gnome-console and
1309 gnome-console.conf are not installed if you do not configure GNOME. Also, if
1310 you are using SQLite instead of mysql, some of the files will be different). 
1311
1312 \footnotesize
1313 \begin{verbatim}
1314 bacula
1315 bacula-dir
1316 bacula-dir.conf
1317 bacula-fd
1318 bacula-fd.conf
1319 bacula-sd
1320 bacula-sd.conf
1321 bacula-tray-monitor
1322 tray-monitor.conf
1323 bextract
1324 bls
1325 bscan
1326 btape
1327 btraceback
1328 btraceback.gdb
1329 bconsole
1330 bconsole.conf
1331 create_mysql_database
1332 dbcheck
1333 delete_catalog_backup
1334 drop_bacula_tables
1335 drop_mysql_tables
1336 fd
1337 gnome-console
1338 gnome-console.conf
1339 make_bacula_tables
1340 make_catalog_backup
1341 make_mysql_tables
1342 mtx-changer
1343 query.sql
1344 bsmtp
1345 startmysql
1346 stopmysql
1347 wx-console
1348 wx-console.conf
1349 \end{verbatim}
1350 \normalsize
1351
1352 \label{monitor}
1353
1354 \subsection*{Installing Tray Monitor}
1355 \index[general]{Monitor!Installing Tray }
1356 \index[general]{Installing Tray Monitor }
1357 \addcontentsline{toc}{subsection}{Installing Tray Monitor}
1358
1359 The Tray Monitor is already installed if you used the {\bf
1360 \verb:--:enable-tray-monitor} configure option and ran {\bf make install}.
1361
1362 As you don't run your graphical environment as root (if you do, you should
1363 change that bad habit), don't forget to allow your user to read {\bf
1364 tray-monitor.conf}, and to execute {\bf bacula-tray-monitor} (this is not a
1365 security issue).
1366
1367 Then log into your graphical environment (KDE, Gnome or something else), run
1368 {\bf bacula-tray-monitor} as your user, and see if a cassette icon appears
1369 somewhere on the screen, usually on the task bar.
1370 If it doesn't, follow the instructions below related to your environment or
1371 window manager. 
1372
1373 \subsubsection*{GNOME}
1374 \index[general]{GNOME }
1375 \addcontentsline{toc}{subsubsection}{GNOME}
1376
1377 System tray, or notification area if you use the GNOME terminology, has been
1378 supported in GNOME since version 2.2. To activate it, right-click on one of
1379 your panels, open the menu {\bf Add to this Panel}, then {\bf Utility} and
1380 finally click on {\bf Notification Area}. 
1381
1382 \subsubsection*{KDE}
1383 \index[general]{KDE }
1384 \addcontentsline{toc}{subsubsection}{KDE}
1385
1386 System tray has been supported in KDE since version 3.1. To activate it,
1387 right-click on one of your panels, open the menu {\bf Add}, then {\bf Applet}
1388 and finally click on {\bf System Tray}. 
1389
1390 \subsubsection*{Other window managers}
1391 \index[general]{Managers!Other window }
1392 \index[general]{Other window managers }
1393 \addcontentsline{toc}{subsubsection}{Other window managers}
1394
1395 Read the documentation to know if the Freedesktop system tray standard is
1396 supported by your window manager, and if applicable, how to activate it. 
1397
1398 \subsection*{Modifying the Bacula Configuration Files}
1399 \index[general]{Modifying the Bacula Configuration Files }
1400 \index[general]{Files!Modifying the Bacula Configuration }
1401 \addcontentsline{toc}{subsection}{Modifying the Bacula Configuration Files}
1402
1403 See the chapter 
1404 \ilink{Configuring Bacula}{_ChapterStart16} in this manual for
1405 instructions on how to set Bacula configuration files.