In general, you will need the Bacula source release, and if you want to run a Windows client, you will need the Bacula Windows binary release. However, Bacula needs certain third party packages (such as SQLite, MySQL to build properly depending on the options you specify. To simplify your task, we have combined a number of these packages into two depkgs releases (Dependency Packages). This can vastly simplify your life by providing you with all the necessary packages rather than requiring you to find them on the Web, load them, and install them.
If you are upgrading from one Bacula version to another, you should first carefully read the ReleaseNotes of all versions between your current version and the version to which you are upgrading. If the Bacula catalog database has been upgraded, you will either need to reinitialize your database starting from scratch, or save an ASCII copy of your database, then proceed to upgrade it. If there are several database upgrades between your version and the version to which you are upgradding, you will need to apply each database upgrade script. For your convenience, you can find all the old upgrade scripts in the upgradedb directory of the source code. You will need to edit the scripts to correspond to your system configuration. The final upgrade script, if any, will be in the src/cats directory as described in the ReleaseNotes.
If you are upgrading from one major version to another, you will need to replace all your components at the same time as generally the inter-daemon protocol will change. However, within any particular release (e.g. version 1.32.x) unless there is an oversight or bug, the daemon protocol will not change. If this is confusing, simply read the ReleaseNotes very carefully as they will note if all daemons must be upgraded at the same time.
Finally, please note that in general it is not necessary to do a make uninstall before doing an upgrade. In fact, if you do so, you will most likely delete all your conf files, which could be disasterous. For additional information on upgrading, please see the Upgrading Bacula Versions in the Tips chapter of this manual.
As discussed above, we have combined a number of third party packages that Bacula might need into the depkgs and depkgs1 releases. You can, of course, get the latest packages from the original authors. The locations of where we obtained the packages are in the README file in each package. However, be aware that the packages in the depkgs files have been tested by us for compatibility with Bacula.
Typically, a dependency package will be named depkgs-ddMMMyy.tar.gz and depkgs1-ddMMyy.tar.gz where dd is the day we release it, MMM is the abbreviated month (e.g. Jan), and yy is the year. An actual example is: depkgs-07Apr02.tar.gz. To install and build this package (if needed), you do the following:
Although the exact composition of the dependency packages may change from time to time, the current makeup is the following:
| 3rd Party Package | depkgs | depkgs1 | depkgs-win32 |
| SQLite | X | - | - |
| mtx | X | - | - |
| readline | - | X | - |
| pthreads | - | - | X |
| zlib | - | - | X |
| wxWidgits | - | - | X |
Note, some of these packages are quite large, so that building them can be a bit time consuming. The above instructions will build all the packages contained in the directory. However, when building Bacula, it will take only those pieces that it actually needs.
Alternatively, you can make just the packages that are needed. For example,
cd bacula/depkgs make sqlite
will configure and build only the SQLite package.
You should build the packages that you will require in depkgs and/or depkgs1 prior to configuring and building Bacula, since Bacula will need them during the build process.
Even if you do not use SQLite, you might find it worthwhile to build mtx because the tapeinfo program that comes with it can often provide you with valuable information about your SCSI tape drive (e.g. compression, min/max block sizes, ...).
The depkgs-win32 package contains the source code for the pthreads and zlib libraries used by the native Win32 client program. It will only be needed if you intend to build the Win32 client from source.
Please see the Supported Operating Systems section of the QuickStart chapter of this manual.
The basic installation is rather simple.
make distclean
so that you are sure to start from scratch and not have a mixture of the two options. This is because ./configure caches much of the information. The make distclean is also critical if you move the source file from one machine to another. If the make distclean fails, just ignore it and continue on.
If you get errors while linking in the Storage daemon directory (src/stored),
it is probably because you have not loaded the static libraries on your
system. I noticed this problem on a Solaris system. To correct it, make sure
that you have not added --enable-static-tools to the ./configure
command.
make uninstall
make distclean
./configure (your-new-options)
make
make install
If all goes well, the ./configure will correctly determine which operating system you are running and configure the source code appropriately. Currently, FreeBSD, Linux (RedHat), and Solaris are supported. MacOS X 10.3 is reported to work with the Client only as long as readline support is disabled.
If you install Bacula on more than one system, and they are identical, you can simply transfer the source tree to that other system and do a ``make install''. However, if there are differences in the libraries or OS versions, or you wish to install on a different OS, you should start from the original compress tar file. If you do transfer the source tree, and you have previously done a ./configure command, you MUST do:
make distclean
prior to doing your new ./configure. This is because the GNU autoconf tools cache the configuration, and if you re-use a configuration for a Linux machine on a Solaris, you can be sure your build will fail. To avoid this, as mentioned above, either start from the tar file, or do a ``make distclean''.
In general, you will probably want to supply a more complicated configure statement to ensure that the modules you want are built and that everything is placed into the correct directories.
For example, on RedHat, one could use the following:
CFLAGS="-g -Wall" \
./configure \
--sbindir=$HOME/bacula/bin \
--sysconfdir=$HOME/bacula/bin \
--with-pid-dir=$HOME/bacula/bin/working \
--with-subsys-dir=$HOME/bacula/bin/working \
--with-mysql=$HOME/mysql \
--with-working-dir=$HOME/bacula/bin/working \
--with-dump-email=$USER
Note, the advantage of using the above configuration to start is that everything will be put into a single directory, which you can later delete once you have run the examples in the next chapter and learned how Bacula works. In addition, the above can be installed and run as non-root.
For the developer's convenience, I have added a defaultconfig script to the examples directory. This script contains the statements that you would normally use, and each developer/user may modify them to suit his needs. You should find additional useful examples in this directory as well.
The --enable-conio or --enable-readline options are useful because
they provide a command line history and editing capability for the Console
program. If you have included either option in the build, either the termcap or the ncurses package will be needed to link. On some systems,
such as SuSE, the termcap library is not in the standard library directory. As
a consequence, the option may be disabled or you may get an error message such
as:
/usr/lib/gcc-lib/i586-suse-linux/3.3.1/.../ld: cannot find -ltermcap collect2: ld returned 1 exit status
while building the Bacula Console. In that case, you will need to set the LDFLAGS environment variable prior to building.
export LDFLAGS="-L/usr/lib/termcap"
The same library requirements apply if you wish to use the readline subroutines for command line editing and history or if you are using a MySQL library that requires encryption. If you need encryption, you can either export the appropriate additional library options as shown above or, alternatively, you can include them directly on the ./configure line as in:
LDFLAGS="-lssl -lcyrpto" \
./configure \
<your-options>
On some systems such as Mandrake, readline tends to
gobble up prompts, which makes it totally useless. If this happens to you, use
the disable option, or if you are using version 1.33 and above try using --enable-conio to use a built-in readline replacement. You will still need
the either termcap or ncurses library, but it is unlikely that the conio
package will gobble up prompts.
readline is no longer supported after version 1.34. The code is still available and if users submit patches for it, I will be happy to apply them. However, due to the fact that each version of readline seems to be incompatible with previous versions, and that there are significant differences between systems, I can no longer afford to support it.
Before building Bacula you need to decide if you want to use SQLite, MySQL, or PostgreSQL. If you are not already running MySQL or PostgreSQL, we recommend that you start by using SQLite. This will greatly simplify the setup for you because SQLite is compiled into Bacula an requires no administration. It performs well and is suitable for small to medium sized installations (maximum 10-20 machines).
If you wish to use MySQL as the Bacula catalog, please see the Installing and Configuring MySQL chapter of this manual. You will need to install MySQL prior to continuing with the configuration of Bacula. MySQL is a high quality database that is very efficient and is suitable for any sized installation. It is slightly more complicated than SQLite to setup and administer because it has a number of sophisticated features such as userids and passwords. It runs as a separate process, is truly professional and can manage a database of any size.
If you wish to use PostgreSQL as the Bacula catalog, please see the Installing and Configuring PostgreSQL chapter of this manual. You will need to install PostgreSQL prior to continuing with the configuration of Bacula. PostgreSQL is very similar to MySQL, though it tends to be slightly more SQL92 compliant and has many more advanced features such as transactions, stored procedures, and the such. It requires a certain knowledge to install and maintain. There are some important performance problems with PostgreSQL in Bacula versions prior to 1.35.5.
If you wish to use SQLite as the Bacula catalog, please see Installing and Configuring SQLite chapter of this manual.
There are a number of options and important considerations given below that you can skip for the moment if you have not had any problems building Bacula with a simplified configuration as shown above.
If you want to dive right into it, we recommend you skip to the next chapter, and run the example program. It will teach you a lot about Bacula and as an example can be installed into a single directory (for easy removal) and run as non-root. If you have any problems or when you want to do a real installation, come back to this chapter and read the details presented below.
The following command line options are available for configure to customize your installation.
--sysbindir=<binary-path>
--sysconfdir=<config-path>
--enable-smartalloc
--enable-gnome
--enable-wx-console
--enable-tray-monitor
--enable-static-tools--disable-static-tools.
--enable-static-fd--enable-client-only option
described below is useful for just building a client so that all the other
parts of the program are not compiled.
--enable-static-sd
--enable-static-dir
--enable-static-cons
--enable-client-only
--enable-largefile--disable-largefile.
--with-sqlite=<sqlite-path>
--with-mysql=<mysql-path>
--with-postgresql=<path>
--enable-conio
--with-readline=<readline-path>--with-readline is specified, readline will be disabled. This option affects
the Bacula build. Readline provides the Console program with a command line
history and editing capability and is no longer supports, so you are on your
own if you have problems.
--enable-readline
--with-tcp-wrappers=<path>For more information on configuring and testing TCP wrappers, please see the Configuring and Testing TCP Wrappers section in the Security Capter.
--with-working-dir=<working-directory-path>
--with-base-port=<port=number>--with-baseport option will automatically assign three ports beginning at
the base port address specified. You may also change the port number in the
resulting configuration files. However, you need to take care that the
numbers correspond correctly in each of the three daemon configuration
files. The default base port is 9101, which assigns ports 9101 through 9103.
These ports (9101, 9102, and 9103) have been officially assigned to Bacula by
IANA. This option is only used to modify the daemon configuration files. You
may also accomplish the same thing by directly editing them later.
--with-dump-email=<email-address>
--with-pid-dir=<PATH>
--with-subsys-dir=<PATH>
--with-dir-password=<Password>
--with-fd-password=<Password>
--with-sd-password=<Password>
--with-dir-user=<User>
--with-dir-group=<Group>
--with-sd-user=<User>
--with-sd-group=<Group>
--with-fd-user=<User>
--with-fd-group=<Group>
Note, many other options are presented when you do a ./configure --help,
but they are not implemented.
For most systems, we recommend starting with the following options:
./configure \ --enable-smartalloc \ --sbindir=$HOME/bacula/bin \ --sysconfdir=$HOME/bacula/bin \ --with-pid-dir=$HOME/bacula/bin/working \ --with-subsys-dir=$HOME/bacula/bin/working \ --with-mysql=$HOME/mysql \ --with-working-dir=$HOME/bacula/working
If you want to install Bacula in an installation directory rather than run it
out of the build directory (as developers will do most of the time), you
should also include the --sbindir and --sysconfdir options with appropriate
paths. Neither are necessary if you do not use ``make install'' as is the case
for most development work. The install process will create the sbindir and
sysconfdir if they do not exist, but it will not automatically create the
pid-dir, subsys-dir, or working-dir, so you must ensure that they exist before
running Bacula for the first time. See below for an example of how Kern does
it.
Using SQLite:
CFLAGS="-g -Wall" ./configure \ --sbindir=$HOME/bacula/bin \ --sysconfdir=$HOME/bacula/bin \ --enable-smartalloc \ --with-sqlite=$HOME/bacula/depkgs/sqlite \ --with-working-dir=$HOME/bacula/working \ --with-pid-dir=$HOME/bacula/bin/working \ --with-subsys-dir=$HOME/bacula/bin/working \ --enable-gnome \ --enable-conio
or
CFLAGS="-g -Wall" ./configure \ --sbindir=$HOME/bacula/bin \ --sysconfdir=$HOME/bacula/bin \ --enable-smartalloc \ --with-mysql=$HOME/mysql \ --with-working-dir=$HOME/bacula/working --with-pid-dir=$HOME/bacula/bin/working \ --with-subsys-dir=$HOME/bacula/bin/working --enable-gnome \ --enable-conio
or finally, a completely traditional RedHat Linux install:
CFLAGS="-g -Wall" ./configure \ --prefix=/usr \ --sbindir=/usr/sbin \ --sysconfdir=/etc/bacula \ --with-scriptdir=/etc/bacula \ --enable-smartalloc \ --enable-gnome \ --with-mysql \ --with-working-dir=/var/bacula \ --with-pid-dir=/var/run \ --with-subsys-dir=/var/lock/subsys \ --enable-conio
Note, Bacula assumes that /var/bacula, /var/run, and /var/loc/subsys exist so it will not automatically create them during the install process.
To build Bacula from source, you will need the following installed on your system (they are not by default): libiconv, gcc 3.3.2, stdc++, libgcc (for stdc++ and gcc_s libraries), make 3.8 or later.
You will probably also need to: Add /usr/local/bin to PATH and Add /usr/ccs/bin to PATH for ar.
#!/bin/sh CFLAGS="-g" ./configure \ --sbindir=$HOME/bacula/bin \ --sysconfdir=$HOME/bacula/bin \ --with-mysql=$HOME/mysql \ --enable-smartalloc \ --with-pid-dir=$HOME/bacula/bin/working \ --with-subsys-dir=$HOME/bacula/bin/working \ --with-working-dir=$HOME/bacula/working
As mentioned above, the install process will create the sbindir and sysconfdir if they do not exist, but it will not automatically create the pid-dir, subsys-dir, or working-dir, so you must ensure that they exist before running Bacula for the first
Please see: The FreeBSD Diary for a detailed description on how to make Bacula work on your system. In addition, users of FreeBSD prior to 4.9-STABLE dated Mon Dec 29 15:18:01 2003 UTC who plan to use tape devices, please see the Tape Testing Chapter of this manual for important information on how to configure your tape drive for compatibility with Bacula.
If you are using Bacula with MySQL, you should take care to compile MySQL with FreeBSD native threads rather than LinuxThreads, since Bacula is normal built with FreeBSD native threads rather than LinuxTreads. Mixing the two will probably not work.
To install the binary Win32 version of the File daemon please see the Win32 Installation Chapter in this document.
As of version 1.34, Bacula no longer uses CYGWIN for the Win32 File daemon. However, it is still built under a CYGWIN build environment - though you can probably do it with VC Studio only. If you wish to build the Win32 File daemon from the source, you will need Microsoft C++ version 6.0 or greater. In Bacula prior to version 1.33, CYGWIN was used. Details for building it are in the README file of the src/win32 directory.
Note, although most parts of Bacula build on Windows systems, the only part that we have tested and used is the File daemon.
Finally, you should follow the installation instructions in the Win32 Installation section of this document.
The script that I use for building on my ``production'' Linux machines is:
#!/bin/sh
# This is Kern's configure script for Bacula
CFLAGS="-g -Wall" \
./configure \
--sbindir=$HOME/bacula/bin \
--sysconfdir=$HOME/bacula/bin \
--enable-smartalloc \
--enable-gnome \
--with-pid-dir=$HOME/bacula/bin/working \
--with-subsys-dir=$HOME/bacula/bin/working \
--with-mysql=$HOME/mysql \
--with-working-dir=$HOME/bacula/bin/working \
--with-dump-email=$USER \
--with-smtp-host=mail.your-site.com \
--with-baseport=9101
exit 0
Note that I define the base port as 9101, which means that Bacula will use
port 9101 for the Director console, port 9102 for the File daemons, and port
9103 for the Storage daemons. These ports should be available on all systems
because they have been officially assigned to Bacula by IANA (Internet
Assigned Numbers Authority). We strongly recommend that you use only these
ports to prevent any conflicts with other programs. This is in fact the
default if you do not specify a --with-baseport option.
You may also want to put the following entries in your /etc/services file as it will make viewing the connections made by Bacula easier to recognize (i.e. netstat -a):
bacula-dir 9101/tcp bacula-fd 9102/tcp bacula-sd 9103/tcp
Before setting up your configuration files, you will want to install Bacula in its final location. Simply enter:
make install
If you have previously installed Bacula, the old binaries will be overwritten, but the old configuration files will remain unchanged, and the ``new'' configuration files will be appended with a .new. Generally if you have previously installed and run Bacula you will want to discard or ignore the configuration files with the appended .new.
If you run the Director and the Storage daemon on one machine and you wish to back up another machine, you must have a copy of the File daemon for that machine. If the machine and the Operating System are identical, you can simply copy the Bacula File daemon binary file bacula-fd as well as its configuration file bacula-fd.conf then modify the name and password in the conf file to be unique. Be sure to make corresponding additions to the Director's configuration file (bacula-dir.conf).
If the architecture or the O/S level are different, you will need to build a File daemon on the Client machine. To do so, you can use the same ./configure command as you did for your main program, starting either from a fresh copy of the source tree, or using make distclean before the ./configure.
Since the File daemon does not access the Catalog database, you can remove the
--with-mysql or --with-sqlite options, then add --enable-client-only. This will compile only the necessary libraries and the
client programs and thus avoids the necessity of installing one or another of
those database programs to build the File daemon. With the above option, you
simply enter make and just the client will be built.
If you wish the daemons to be automatically started and stopped when your system is booted (a good idea), one more step is necessary. First, the ./configure process must recognize your system - that is it must be a supported platform and not unknown, then you must install the platform dependent files by doing:
(become root) make install-autostart
Please note, that the auto-start feature is implemented only on systems that we officially support (currently, FreeBSD, RedHat Linux, and Solaris), and has only been fully tested on RedHat Linux.
The make install-autostart will cause the appropriate startup scripts to be installed with the necessary symbolic links. On RedHat Linux systems, these scripts reside in /etc/rc.d/init.d/bacula-dir /etc/rc.d/init.d/bacula-fd, and /etc/rc.d/init.d/bacula-sd. However the exact location depends on what operating system you are using.
If you only wish to install the File daemon, you may do so with:
make install-autostart-fd
To simply build a new executable in any directory, enter:
make
To clean out all the objects and binaries (including the files named 1, 2, or 3, which Kern uses as temporary files), enter:
make clean
To really clean out everything for distribution, enter:
make distclean
note, this cleans out the Makefiles and is normally done from the top level directory to prepare for distribution of the source. To recover from this state, you must redo the ./configure in the top level directory, since all the Makefiles will be deleted.
To add a new file in a subdirectory, edit the Makefile.in in that directory, then simply do a make. In most cases, the make will rebuild the Makefile from the new Makefile.in. In some case, you may need to issue the make a second time. In extreme cases, cd to the top level directory and enter: make Makefiles.
To add dependencies:
make depend
The make depend appends the header file dependencies for each of the object files to Makefile and Makefile.in. This command should be done in each directory where you change the dependencies. Normally, it only needs to be run when you add or delete source or header files. make depend is normally automatically invoked during the configuration process.
To install:
make install
This not normally done if you are developing Bacula, but is used if you are going to run it to backup your system.
After doing a make install the following files will be installed on your system (more or less). The exact files and location (directory) for each file depends on your ./configure command (e.g. gnome-console and gnome-console.conf are not installed if you do not configure GNOME. Also, if you are using SQLite instead of mysql, some of the files will be different).
bacula bacula-dir bacula-dir.conf bacula-fd bacula-fd.conf bacula-sd bacula-sd.conf bacula-tray-monitor tray-monitor.conf bextract bls bscan btape btraceback btraceback.gdb bconsole bconsole.conf create_mysql_database dbcheck delete_catalog_backup drop_bacula_tables drop_mysql_tables fd gnome-console gnome-console.conf make_bacula_tables make_catalog_backup make_mysql_tables mtx-changer query.sql bsmtp startmysql stopmysql wx-console wx-console.conf
The Tray Monitor is already installed if you used the --enable-tray-monitor configure option and ran make install.
As you don't run your graphical environment as root (if you do, you should change that bad habit), don't forget to allow your user to read tray-monitor.conf, and to execute bacula-tray-monitor (this is not a security issue).
Then log into your graphical environment (KDE, Gnome or something else), run bacula-tray-monitor as your user, and see if a cassette icon appear somewhere on the screen, usually on the task bar. If it doesn't, follow the instructions below related to your environment or window manager.
System tray, or notification area if you use the GNOME terminology, has been supported in GNOME since version 2.2. To activate it, right-click on one of your panels, open the menu Add to this Panel, then Utility and finally click on Notification Area.
System tray has been supported in KDE since version 3.1. To activate it, right-click on one of your panels, open the menu Add, then Applet and finally click on System Tray.
Read the documentation to know if the Freedesktop system tray standard is supported by your window manager, and if applicable, how to activate it.
See the chapter Configuring Bacula in this manual for instructions on how to set Bacula configuration files.