4 \section*{Client/File daemon Configuration}
5 \label{_ChapterStart25}
6 \index[general]{Configuration!Client/File daemon }
7 \index[general]{Client/File daemon Configuration }
8 \addcontentsline{toc}{section}{Client/File daemon Configuration}
11 \index[general]{General }
12 \addcontentsline{toc}{subsection}{General}
14 The Client (or File Daemon) Configuration is one of the simpler ones to
15 specify. Generally, other than changing the Client name so that error messages
16 are easily identified, you will not need to modify the default Client
19 For a general discussion of configuration file and resources including the
20 data types recognized by {\bf Bacula}, please see the
21 \ilink{Configuration}{_ChapterStart16} chapter of this manual. The
22 following Client Resource definitions must be defined:
26 \ilink{Client}{ClientResource} -- to define what Clients are to
29 \ilink{Director}{DirectorResource} -- to define the Director's
30 name and its access password.
32 \ilink{Messages}{_ChapterStart15} -- to define where error and
33 information messages are to be sent.
36 \subsection*{The Client Resource}
37 \label{ClientResource}
38 \index[general]{Resource!Client }
39 \index[general]{Client Resource }
40 \addcontentsline{toc}{subsection}{Client Resource}
42 The Client Resource (or FileDaemon) resource defines the name of the Client
43 (as used by the Director) as well as the port on which the Client listens for
48 \item [Client (or FileDaemon)]
49 \index[fd]{Client (or FileDaemon)}
50 \index[fd]{Directive!Client (or FileDaemon)}
51 Start of the Client records. There must be one and only one Client resource
52 in the configuration file, since it defines the properties of the current
55 \item [Name = \lt{}name\gt{}]
57 \index[fd]{Directive!Name}
58 The client name that must be used by the Director when connecting. Generally,
59 it is a good idea to use a name related to the machine so that error messages
60 can be easily identified if you have multiple Clients. This directive is
63 \item [Working Directory = \lt{}Directory\gt{}]
64 \index[fd]{Working Directory}
65 \index[fd]{Directive!Working Directory}
66 This directive is mandatory and specifies a directory in which the File
67 daemon may put its status files. This directory should be used only by {\bf
68 Bacula}, but may be shared by other Bacula daemons provided the daemon
69 names on the {\bf Name} definition are unique for each daemon. This directive
72 On Win32 systems, in some circumstances you may need to specify a drive
73 letter in the specified working directory path. Also, please be sure
74 that this directory is writable by the SYSTEM user otherwise restores
75 may fail (the bootstrap file that is transferred to the File daemon from
76 the Director is temporarily put in this directory before being passed
77 to the Storage daemon).
79 \item [Pid Directory = \lt{}Directory\gt{}]
80 \index[fd]{Pid Directory}
81 \index[fd]{Directive!Pid Directory}
82 This directive is mandatory and specifies a directory in which the Director
83 may put its process Id file files. The process Id file is used to shutdown
84 Bacula and to prevent multiple copies of Bacula from running simultaneously.
85 This record is required. Standard shell expansion of the {\bf Directory} is
86 done when the configuration file is read so that values such as {\bf \$HOME}
87 will be properly expanded.
89 Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
90 not installing Bacula in the system directories, you can use the {\bf Working
91 Directory} as defined above.
93 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
94 \index[fd]{Heartbeat Interval}
95 \index[fd]{Directive!Heartbeat Interval}
96 \index[general]{Heartbeat Interval}
97 \index[general]{Broken pipe}
99 \index[general]{Backups!slow}
100 This record defines an interval of time. For each heartbeat that the
101 File daemon receives from the Storage daemon, it will forward it to the
102 Director. In addition, if no heartbeat has been received from the
103 Storage daemon and thus forwarded the File daemon will send a heartbeat
104 signal to the Director and to the Storage daemon to keep the channels
105 active. The default interval is zero which disables the heartbeat.
106 This feature is particularly useful if you have a router such as 3Com
107 that does not follow Internet standards and times out a valid
108 connection after a short duration despite the fact that keepalive is
109 set. This usually results in a broken pipe error message.
111 If you continue getting broken pipe error messages despite using the
112 Heartbeat Interval, and you are using Windows, you should consider
113 upgrading your ethernet driver. This is a known problem with NVidia
114 NForce 3 drivers (4.4.2 17/05/2004), or try the following workaround
115 suggested by Thomas Simmons for Win32 machines:
118 Start \gt{} Control Panel \gt{} Network Connections
120 Right click the connection for the nvidia adapter and select properties.
121 Under the General tab, click "Configure...". Under the Advanced tab set
122 "Checksum Offload" to disabled and click OK to save the change.
124 Lack of communications, or communications that get interrupted can
125 also be caused by Linux firewalls where you have a rule that throttles
126 connections or traffic.
129 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
130 \index[fd]{Maximum Concurrent Jobs}
131 \index[fd]{Directive!Maximum Concurrent Jobs}
132 where \lt{}number\gt{} is the maximum number of Jobs that should run
133 concurrently. The default is set to 2, but you may set it to a larger
134 number. Each contact from the Director (e.g. status request, job start
135 request) is considered as a Job, so if you want to be able to do a {\bf
136 status} request in the console at the same time as a Job is running, you
137 will need to set this value greater than 1.
139 \item [FDAddresses = \lt{}IP-address-specification\gt{}]
140 \index[fd]{FDAddresses}
141 \index[fd]{Directive!FDAddresses}
142 Specify the ports and addresses on which the File daemon listens for
143 Director connections. Probably the simplest way to explain is to show
149 ip = { addr = 1.2.3.4; port = 1205; }
151 addr = 1.2.3.4; port = http; }
160 ip = { addr = 1.2.3.4 }
162 addr = 201:220:222::2
165 addr = bluedot.thun.net
171 where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
172 can be specified as either a dotted quadruple, or IPv6 colon notation, or as
173 a symbolic name (only in the ip specification). Also, port can be specified
174 as a number or as the mnemonic value from the /etc/services file. If a port
175 is not specified, the default will be used. If an ip section is specified,
176 the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
177 only IPv4 resolutions will be permitted, and likewise with ip6.
179 \item [FDPort = \lt{}port-number\gt{}]
181 \index[fd]{Directive!FDPort}
182 This specifies the port number on which the Client listens for Director
183 connections. It must agree with the FDPort specified in the Client resource
184 of the Director's configuration file. The default is 9102.
186 \item [FDAddress = \lt{}IP-Address\gt{}]
187 \index[fd]{FDAddress}
188 \index[fd]{Directive!FDAddress}
189 This record is optional, and if it is specified, it will cause the File
190 daemon server (for Director connections) to bind to the specified {\bf
191 IP-Address}, which is either a domain name or an IP address specified as a
192 dotted quadruple. If this record is not specified, the File daemon will bind
193 to any available address (the default).
195 \item [SDConnectTimeout = \lt{}time-interval\gt{}]
196 \index[fd]{SDConnectTimeout}
197 \index[fd]{Directive!SDConnectTimeout}
198 This record defines an interval of time that the File daemon will try to
199 connect to the Storage daemon. The default is 30 minutes. If no connection
200 is made in the specified time interval, the File daemon cancels the Job.
202 \item [Maximum Network Buffer Size = \lt{}bytes\gt{}]
203 \index[fd]{Maximum Network Buffer Size}
204 \index[fd]{Directive!Maximum Network Buffer Size}
205 where \lt{}bytes\gt{} specifies the initial network buffer size to use with
206 the File daemon. This size will be adjusted down if it is too large until it
207 is accepted by the OS. Please use care in setting this value since if it is
208 too large, it will be trimmed by 512 bytes until the OS is happy, which may
209 require a large number of system calls. The default value is 32,768 bytes.
212 The following is an example of a valid Client resource definition:
216 Client { # this is me
218 WorkingDirectory = $HOME/bacula/bin/working
219 Pid Directory = $HOME/bacula/bin/working
224 \subsection*{The Director Resource}
225 \label{DirectorResource}
226 \index[general]{Director Resource }
227 \index[general]{Resource!Director }
228 \addcontentsline{toc}{subsection}{Director Resource}
230 The Director resource defines the name and password of the Directors that are
231 permitted to contact this Client.
237 \index[fd]{Directive!Director}
238 Start of the Director records. There may be any number of Director resources
239 in the Client configuration file. Each one specifies a Director that is
240 allowed to connect to this Client.
242 \item [Name = \lt{}name\gt{}]
244 \index[fd]{Directive!Name}
245 The name of the Director that may contact this Client. This name must be the
246 same as the name specified on the Director resource in the Director's
247 configuration file. Note, the case (upper/lower) of the characters in
248 the name are significant (i.e. S is not the same as s). This directive
251 \item [Password = \lt{}password\gt{}]
253 \index[fd]{Directive!Password}
254 Specifies the password that must be supplied for a Director to be authorized.
255 This password must be the same as the password specified in the Client
256 resource in the Director's configuration file. This directive is required.
258 \item [Monitor = \lt{}yes|no\gt{}]
260 \index[fd]{Directive!Monitor}
261 If Monitor is set to {\bf no} (default), this director will have full access
262 to this Client. If Monitor is set to {\bf yes}, this director will only be
263 able to fetch the current status of this Client.
265 Please note that if this director is being used by a Monitor, we highly
266 recommend to set this directive to {\bf yes} to avoid serious security
270 Thus multiple Directors may be authorized to use this Client's services. Each
271 Director will have a different name, and normally a different password as
274 The following is an example of a valid Director resource definition:
279 # List Directors who are permitted to contact the File daemon
283 Password = very_good # password HeadMan must supply
287 Password = not_as_good
293 \subsection*{The Message Resource}
294 \label{MessagesResource}
295 \index[general]{Message Resource }
296 \index[general]{Resource!Message }
297 \addcontentsline{toc}{subsection}{Message Resource}
300 \ilink{Messages Resource}{_ChapterStart15} Chapter of this
301 manual for the details of the Messages Resource.
303 There must be at least one Message resource in the Client configuration file.
305 \subsection*{Example Client Configuration File}
306 \label{SampleClientConfiguration}
307 \index[general]{Example Client Configuration File }
308 \index[general]{File!Example Client Configuration }
309 \addcontentsline{toc}{subsection}{Example Client Configuration File}
311 An example File Daemon configuration file might be the following:
316 # Default Bacula File Daemon Configuration file
318 # For Bacula release 1.35.2 (16 August 2004) -- gentoo 1.4.16
320 # There is not much to change here except perhaps to
321 # set the Director's name and File daemon's name
322 # to something more appropriate for your site.
325 # List Directors who are permitted to contact this File daemon
329 Password = "/LqPRkX++saVyQE7w7mmiFg/qxYc1kufww6FEyY/47jU"
332 # Restricted Director, used by tray-monitor to get the
333 # status of the file daemon
337 Password = "FYpq4yyI1y562EMS35bA0J0QC0M2L3t5cZObxT3XQxgxppTn"
341 # "Global" File daemon configuration specifications
343 FileDaemon { # this is me
345 WorkingDirectory = $HOME/bacula/bin/working
346 Pid Directory = $HOME/bacula/bin/working
348 # Send all messages except skipped files back to Director
351 director = rufus-dir = all, !skipped