<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2008 (1.71)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Client/File daemon Configuration</TITLE>
<META NAME="description" CONTENT="Client/File daemon Configuration">
<META NAME="keywords" CONTENT="main">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2008">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="main.css">
<LINK REL="next" HREF="Storage_Daemon_Configuratio.html">
<LINK REL="previous" HREF="Configuring_Director.html">
<LINK REL="up" HREF="Bacula_Main_Reference.html">
<LINK REL="next" HREF="Storage_Daemon_Configuratio.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html1484"
HREF="Storage_Daemon_Configuratio.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1478"
HREF="Bacula_Main_Reference.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1472"
HREF="Configuring_Director.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1480"
HREF="Contents.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html1482"
HREF="Thanks.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1485"
HREF="Storage_Daemon_Configuratio.html">Storage Daemon Configuration</A>
<B> Up:</B> <A NAME="tex2html1479"
HREF="Bacula_Main_Reference.html">Bacula Main Reference</A>
<B> Previous:</B> <A NAME="tex2html1473"
HREF="Configuring_Director.html">Configuring the Director</A>
<B> <A NAME="tex2html1481"
HREF="Contents.html">Contents</A></B>
<B> <A NAME="tex2html1483"
HREF="Thanks.html">Index</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<UL>
<LI><A NAME="tex2html1486"
HREF="Client_File_daemon_Configur.html#SECTION001910000000000000000">The Client Resource</A>
<LI><A NAME="tex2html1487"
HREF="Client_File_daemon_Configur.html#SECTION001920000000000000000">The Director Resource</A>
<LI><A NAME="tex2html1488"
HREF="Client_File_daemon_Configur.html#SECTION001930000000000000000">The Message Resource</A>
<LI><A NAME="tex2html1489"
HREF="Client_File_daemon_Configur.html#SECTION001940000000000000000">Example Client Configuration File</A>
</UL>
<!--End of Table of Child-Links-->
<HR>
<H1><A NAME="SECTION001900000000000000000"></A>
<A NAME="FiledConfChapter"></A>
<BR>
Client/File daemon Configuration
</H1>
<A NAME="11119"></A>
<A NAME="11120"></A>
<P>
The Client (or File Daemon) Configuration is one of the simpler ones to
specify. Generally, other than changing the Client name so that error messages
are easily identified, you will not need to modify the default Client
configuration file.
<P>
For a general discussion of configuration file and resources including the
data types recognized by <B>Bacula</B>, please see the
ConfigurationConfigureChapter chapter of this manual. The
following Client Resource definitions must be defined:
<P>
<UL>
<LI>ClientClientResource - to define what Clients are to
be backed up.
</LI>
<LI>DirectorDirectorResource - to define the Director's
name and its access password.
</LI>
<LI>MessagesMessagesChapter - to define where error and
information messages are to be sent.
</LI>
</UL>
<P>
<H1><A NAME="SECTION001910000000000000000"></A>
<A NAME="ClientResource"></A>
<BR>
The Client Resource
</H1>
<A NAME="11134"></A>
<A NAME="11135"></A>
<P>
The Client Resource (or FileDaemon) resource defines the name of the Client
(as used by the Director) as well as the port on which the Client listens for
Director connections.
<P>
<DL>
<DT><STRONG>Client (or FileDaemon)</STRONG></DT>
<DD><A NAME="11137"></A>
<A NAME="11138"></A>
Start of the Client records. There must be one and only one Client resource
in the configuration file, since it defines the properties of the current
client program.
<P>
</DD>
<DT><STRONG>Name = name</STRONG></DT>
<DD><A NAME="11141"></A>
<A NAME="11142"></A>
The client name that must be used by the Director when connecting. Generally,
it is a good idea to use a name related to the machine so that error messages
can be easily identified if you have multiple Clients. This directive is
required.
<P>
</DD>
<DT><STRONG>Working Directory = Directory</STRONG></DT>
<DD><A NAME="11145"></A>
<A NAME="11146"></A>
This directive is mandatory and specifies a directory in which the File
daemon may put its status files. This directory should be used only by <B> Bacula</B>, but may be shared by other Bacula daemons provided the daemon
names on the <B>Name</B> definition are unique for each daemon. This directive
is required.
<P>
On Win32 systems, in some circumstances you may need to specify a drive
letter in the specified working directory path. Also, please be sure
that this directory is writable by the SYSTEM user otherwise restores
may fail (the bootstrap file that is transferred to the File daemon from
the Director is temporarily put in this directory before being passed
to the Storage daemon).
<P>
</DD>
<DT><STRONG>Pid Directory = Directory</STRONG></DT>
<DD><A NAME="11151"></A>
<A NAME="11152"></A>
This directive is mandatory and specifies a directory in which the Director
may put its process Id file files. The process Id file is used to shutdown
Bacula and to prevent multiple copies of Bacula from running simultaneously.
This record is required. Standard shell expansion of the <B>Directory</B> is
done when the configuration file is read so that values such as <B>$HOME</B>
will be properly expanded.
<P>
Typically on Linux systems, you will set this to: <B>/var/run</B>. If you are
not installing Bacula in the system directories, you can use the <B>Working
Directory</B> as defined above.
<P>
</DD>
<DT><STRONG>Heartbeat Interval = time-interval</STRONG></DT>
<DD><A NAME="11159"></A>
<A NAME="11160"></A>
<A NAME="11161"></A>
<A NAME="11162"></A>
<A NAME="11163"></A>
<A NAME="11164"></A>
This record defines an interval of time in seconds. For each heartbeat that the
File daemon receives from the Storage daemon, it will forward it to the
Director. In addition, if no heartbeat has been received from the
Storage daemon and thus forwarded the File daemon will send a heartbeat
signal to the Director and to the Storage daemon to keep the channels
active. The default interval is zero which disables the heartbeat.
This feature is particularly useful if you have a router such as 3Com
that does not follow Internet standards and times out a valid
connection after a short duration despite the fact that keepalive is
set. This usually results in a broken pipe error message.
<P>
If you continue getting broken pipe error messages despite using the
Heartbeat Interval, and you are using Windows, you should consider
upgrading your ethernet driver. This is a known problem with NVidia
NForce 3 drivers (4.4.2 17/05/2004), or try the following workaround
suggested by Thomas Simmons for Win32 machines:
<P>
Browse to:
Start Control Panel Network Connections
<P>
Right click the connection for the nvidia adapter and select properties.
Under the General tab, click "Configure...". Under the Advanced tab set
"Checksum Offload" to disabled and click OK to save the change.
<P>
Lack of communications, or communications that get interrupted can
also be caused by Linux firewalls where you have a rule that throttles
connections or traffic.
<P>
</DD>
<DT><STRONG>Maximum Concurrent Jobs = number</STRONG></DT>
<DD><A NAME="11169"></A>
<A NAME="11170"></A>
where number is the maximum number of Jobs that should run
concurrently. The default is set to 2, but you may set it to a larger
number. Each contact from the Director (e.g. status request, job start
request) is considered as a Job, so if you want to be able to do a <B> status</B> request in the console at the same time as a Job is running, you
will need to set this value greater than 1.
<P>
</DD>
<DT><STRONG>FDAddresses = IP-address-specification</STRONG></DT>
<DD><A NAME="11176"></A>
<A NAME="11177"></A>
Specify the ports and addresses on which the File daemon listens for
Director connections. Probably the simplest way to explain is to show
an example:
<P>
<PRE>
FDAddresses = {
ip = { addr = 1.2.3.4; port = 1205; }
ipv4 = {
addr = 1.2.3.4; port = http; }
ipv6 = {
addr = 1.2.3.4;
port = 1205;
}
ip = {
addr = 1.2.3.4
port = 1205
}
ip = { addr = 1.2.3.4 }
ip = {
addr = 201:220:222::2
}
ip = {
addr = bluedot.thun.net
}
}
</PRE>
<P>
where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
can be specified as either a dotted quadruple, or IPv6 colon notation, or as
a symbolic name (only in the ip specification). Also, port can be specified
as a number or as the mnemonic value from the /etc/services file. If a port
is not specified, the default will be used. If an ip section is specified,
the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
only IPv4 resolutions will be permitted, and likewise with ip6.
<P>
</DD>
<DT><STRONG>FDPort = port-number</STRONG></DT>
<DD><A NAME="11182"></A>
<A NAME="11183"></A>
This specifies the port number on which the Client listens for Director
connections. It must agree with the FDPort specified in the Client resource
of the Director's configuration file. The default is 9102.
<P>
</DD>
<DT><STRONG>FDAddress = IP-Address</STRONG></DT>
<DD><A NAME="11186"></A>
<A NAME="11187"></A>
This record is optional, and if it is specified, it will cause the File
daemon server (for Director connections) to bind to the specified <B> IP-Address</B>, which is either a domain name or an IP address specified as a
dotted quadruple. If this record is not specified, the File daemon will bind
to any available address (the default).
<P>
</DD>
<DT><STRONG>FDSourceAddress = IP-Address</STRONG></DT>
<DD><A NAME="11191"></A>
<A NAME="11192"></A>
This record is optional, and if it is specified, it will cause the File
daemon server (for Storage connections) to bind to the specified <B> IP-Address</B>, which is either a domain name or an IP address specified as a
dotted quadruple. If this record is not specified, the kernel will choose
the best address according to the routing table (the default).
<P>
</DD>
<DT><STRONG>SDConnectTimeout = time-interval</STRONG></DT>
<DD><A NAME="11196"></A>
<A NAME="11197"></A>
This record defines an interval of time that the File daemon will try to
connect to the Storage daemon. The default is 30 minutes. If no connection
is made in the specified time interval, the File daemon cancels the Job.
<P>
</DD>
<DT><STRONG>Maximum Network Buffer Size = bytes</STRONG></DT>
<DD><A NAME="11200"></A>
<A NAME="11201"></A>
where bytes specifies the initial network buffer size to use with
the File daemon. This size will be adjusted down if it is too large until it
is accepted by the OS. Please use care in setting this value since if it is
too large, it will be trimmed by 512 bytes until the OS is happy, which may
require a large number of system calls. The default value is 65,536 bytes.
<P>
Note, on certain Windows machines, there are reports that the
transfer rates are very slow and this seems to be related to
the default 65,536 size. On systems where the transfer rates
seem abnormally slow compared to other systems, you might try
setting the Maximum Network Buffer Size to 32,768 in both the
File daemon and in the Storage daemon.
<P>
</DD>
<DT><STRONG>Heartbeat Interval = time-interval</STRONG></DT>
<DD><A NAME="11206"></A>
<A NAME="11207"></A>
This directive is optional and if specified will cause the File daemon to
set a keepalive interval (heartbeat) in seconds on each of the sockets
to communicate with the Storage daemon. It is implemented only on systems
(Linux, ...) that provide the <B>setsockopt</B> TCP_KEEPIDLE function.
The default value is zero, which means no change is made to the socket.
<P>
</DD>
<DT><STRONG>PKI Encryption</STRONG></DT>
<DD>See the Data EncryptionDataEncryption chapter of this manual.
<P>
</DD>
<DT><STRONG>PKI Signatures</STRONG></DT>
<DD>See the Data EncryptionDataEncryption chapter of this manual.
<P>
</DD>
<DT><STRONG>PKI Keypair</STRONG></DT>
<DD>See the Data EncryptionDataEncryption chapter of this manual.
<P>
</DD>
<DT><STRONG>PKI Master Key</STRONG></DT>
<DD>See the Data EncryptionDataEncryption chapter of this manual.
<P>
</DD>
</DL>
<P>
The following is an example of a valid Client resource definition:
<P>
<PRE>
Client { # this is me
Name = rufus-fd
WorkingDirectory = $HOME/bacula/bin/working
Pid Directory = $HOME/bacula/bin/working
}
</PRE>
<P>
<H1><A NAME="SECTION001920000000000000000"></A>
<A NAME="DirectorResource"></A>
<BR>
The Director Resource
</H1>
<A NAME="11222"></A>
<A NAME="11223"></A>
<P>
The Director resource defines the name and password of the Directors that are
permitted to contact this Client.
<P>
<DL>
<DT><STRONG>Director</STRONG></DT>
<DD><A NAME="11225"></A>
<A NAME="11226"></A>
Start of the Director records. There may be any number of Director resources
in the Client configuration file. Each one specifies a Director that is
allowed to connect to this Client.
<P>
</DD>
<DT><STRONG>Name = name</STRONG></DT>
<DD><A NAME="11229"></A>
<A NAME="11230"></A>
The name of the Director that may contact this Client. This name must be the
same as the name specified on the Director resource in the Director's
configuration file. Note, the case (upper/lower) of the characters in
the name are significant (i.e. S is not the same as s). This directive
is required.
<P>
</DD>
<DT><STRONG>Password = password</STRONG></DT>
<DD><A NAME="11233"></A>
<A NAME="11234"></A>
Specifies the password that must be supplied for a Director to be authorized.
This password must be the same as the password specified in the Client
resource in the Director's configuration file. This directive is required.
<P>
</DD>
<DT><STRONG>Monitor = yesno</STRONG></DT>
<DD><A NAME="11238"></A>
<A NAME="11239"></A>
If Monitor is set to <B>no</B> (default), this director will have full access
to this Client. If Monitor is set to <B>yes</B>, this director will only be
able to fetch the current status of this Client.
<P>
Please note that if this director is being used by a Monitor, we highly
recommend to set this directive to <B>yes</B> to avoid serious security
problems.
</DD>
</DL>
<P>
Thus multiple Directors may be authorized to use this Client's services. Each
Director will have a different name, and normally a different password as
well.
<P>
The following is an example of a valid Director resource definition:
<P>
<PRE>
#
# List Directors who are permitted to contact the File daemon
#
Director {
Name = HeadMan
Password = very_good # password HeadMan must supply
}
Director {
Name = Worker
Password = not_as_good
Monitor = Yes
}
</PRE>
<P>
<H1><A NAME="SECTION001930000000000000000"></A>
<A NAME="MessagesResource3"></A>
<BR>
The Message Resource
</H1>
<A NAME="11248"></A>
<A NAME="11249"></A>
<P>
Please see the
Messages ResourceMessagesChapter Chapter of this
manual for the details of the Messages Resource.
<P>
There must be at least one Message resource in the Client configuration file.
<P>
<H1><A NAME="SECTION001940000000000000000"></A>
<A NAME="SampleClientConfiguration"></A>
<BR>
Example Client Configuration File
</H1>
<A NAME="11254"></A>
<A NAME="11255"></A>
<P>
An example File Daemon configuration file might be the following:
<P>
<PRE>
#
# Default Bacula File Daemon Configuration file
#
# For Bacula release 1.35.2 (16 August 2004) -- gentoo 1.4.16
#
# There is not much to change here except perhaps to
# set the Director's name and File daemon's name
# to something more appropriate for your site.
#
#
# List Directors who are permitted to contact this File daemon
#
Director {
Name = rufus-dir
Password = "/LqPRkX++saVyQE7w7mmiFg/qxYc1kufww6FEyY/47jU"
}
#
# Restricted Director, used by tray-monitor to get the
# status of the file daemon
#
Director {
Name = rufus-mon
Password = "FYpq4yyI1y562EMS35bA0J0QC0M2L3t5cZObxT3XQxgxppTn"
Monitor = yes
}
#
# "Global" File daemon configuration specifications
#
FileDaemon { # this is me
Name = rufus-fd
WorkingDirectory = $HOME/bacula/bin/working
Pid Directory = $HOME/bacula/bin/working
}
# Send all messages except skipped files back to Director
Messages {
Name = Standard
director = rufus-dir = all, !skipped
}
</PRE>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html1484"
HREF="Storage_Daemon_Configuratio.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1478"
HREF="Bacula_Main_Reference.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1472"
HREF="Configuring_Director.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1480"
HREF="Contents.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html1482"
HREF="Thanks.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1485"
HREF="Storage_Daemon_Configuratio.html">Storage Daemon Configuration</A>
<B> Up:</B> <A NAME="tex2html1479"
HREF="Bacula_Main_Reference.html">Bacula Main Reference</A>
<B> Previous:</B> <A NAME="tex2html1473"
HREF="Configuring_Director.html">Configuring the Director</A>
<B> <A NAME="tex2html1481"
HREF="Contents.html">Contents</A></B>
<B> <A NAME="tex2html1483"
HREF="Thanks.html">Index</A></B>
<!--End of Navigation Panel-->
<ADDRESS>
2012-01-24
</ADDRESS>
</BODY>
</HTML>
