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 Start of the Client records. There must be one and only one Client resource
51 in the configuration file, since it defines the properties of the current
54 \item [Name = \lt{}name\gt{}]
56 The client name that must be used by the Director when connecting. Generally,
57 it is a good idea to use a name related to the machine so that error messages
58 can be easily identified if you have multiple Clients. This record is
61 \item [Working Directory = \lt{}Directory\gt{}]
62 \index[fd]{Working Directory }
63 This directive is mandatory and specifies a directory in which the File
64 daemon may put its status files. This directory should be used only by {\bf
65 Bacula}, but may be shared by other Bacula daemons. This record is required.
67 On Win32 systems, in some circumstances you may need to specify a drive
68 letter in the specified working directory path. Also, please be sure
69 that this directory is writable by the SYSTEM user otherwise restores
70 may fail (the bootstrap file that is transferred to the File daemon from
71 the Director is temporarily put in this directory before being passed
72 to the Storage daemon).
74 \item [Pid Directory = \lt{}Directory\gt{}]
75 \index[fd]{Pid Directory }
76 This directive is mandatory and specifies a directory in which the Director
77 may put its process Id file files. The process Id file is used to shutdown
78 Bacula and to prevent multiple copies of Bacula from running simultaneously.
79 This record is required. Standard shell expansion of the {\bf Directory} is
80 done when the configuration file is read so that values such as {\bf \$HOME}
81 will be properly expanded.
83 Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
84 not installing Bacula in the system directories, you can use the {\bf Working
85 Directory} as defined above.
87 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
88 \index[fd]{Heartbeat Interval }
89 \index[general]{Heartbeat Interval}
90 \index[general]{Broken pipe}
91 This record defines an interval of time. For each heartbeat that the
92 File daemon receives from the Storage daemon, it will forward it to the
93 Director. In addition, if no heartbeat has been received from the
94 Storage daemon and thus forwarded the File daemon will send a heartbeat
95 signal to the Director and to the Storage daemon to keep the channels
96 active. The default interval is zero which disables the heartbeat.
97 This feature is particularly useful if you have a router such as 3Com
98 that does not follow Internet standards and times out a valid
99 connection after a short duration despite the fact that keepalive is
100 set. This usually results in a broken pipe error message.
102 If you continue getting broken pipe error messages despite using the
103 Heartbeat Interval, and you are using Windows, you should consider
104 upgrading your ethernet driver. This is a known problem with NVidia
105 NForce 3 drivers (4.4.2 17/05/2004).
107 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
108 \index[fd]{Maximum Concurrent Jobs }
109 where \lt{}number\gt{} is the maximum number of Jobs that should run
110 concurrently. The default is set to 2, but you may set it to a larger
111 number. Each contact from the Director (e.g. status request, job start
112 request) is considered as a Job, so if you want to be able to do a {\bf
113 status} request in the console at the same time as a Job is running, you
114 will need to set this value greater than 1.
116 \item [FDAddresses = \lt{}IP-address-specification\gt{}]
117 \index[console]{FDAddresses }
118 Specify the ports and addresses on which the Director daemon will listen
119 for Bacula Console connections. Probably the simplest way to explain is
124 FDAddresses = { ip = {
125 addr = 1.2.3.4; port = 1205; }
127 addr = 1.2.3.4; port = http; }
140 addr = 201:220:222::2
143 addr = bluedot.thun.net
149 where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
150 can be specified as either a dotted quadruple, or IPv6 colon notation, or as
151 a symbolic name (only in the ip specification). Also, port can be specified
152 as a number or as the mnemonic value from the /etc/services file. If a port
153 is not specified, the default will be used. If an ip section is specified,
154 the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
155 only IPv4 resolutions will be permitted, and likewise with ip6.
157 \item [FDPort = \lt{}port-number\gt{}]
158 \index[console]{FDPort }
159 This specifies the port number on which the Client listens for Director
160 connections. It must agree with the FDPort specified in the Client resource
161 of the Director's configuration file. The default is 9102.
163 \item [FDAddress = \lt{}IP-Address\gt{}]
164 \index[console]{FDAddress }
165 This record is optional, and if it is specified, it will cause the File
166 daemon server (for Director connections) to bind to the specified {\bf
167 IP-Address}, which is either a domain name or an IP address specified as a
168 dotted quadruple. If this record is not specified, the File daemon will bind
169 to any available address (the default).
171 \item [SDConnectTimeout = \lt{}time-interval\gt{}]
172 \index[console]{SDConnectTimeout }
173 This record defines an interval of time that the File daemon will try to
174 connect to the Storage daemon. The default is 30 minutes. If no connection
175 is made in the specified time interval, the File daemon cancels the Job.
177 \item [Maximum Network Buffer Size = \lt{}bytes\gt{}]
178 \index[console]{Maximum Network Buffer Size }
179 where \lt{}bytes\gt{} specifies the initial network buffer size to use with
180 the File daemon. This size will be adjusted down if it is too large until it
181 is accepted by the OS. Please use care in setting this value since if it is
182 too large, it will be trimmed by 512 bytes until the OS is happy, which may
183 require a large number of system calls. The default value is 32,768 bytes.
186 The following is an example of a valid Client resource definition:
190 Client { # this is me
192 WorkingDirectory = $HOME/bacula/bin/working
193 Pid Directory = $HOME/bacula/bin/working
198 \subsection*{The Director Resource}
199 \label{DirectorResource}
200 \index[general]{Director Resource }
201 \index[general]{Resource!Director }
202 \addcontentsline{toc}{subsection}{Director Resource}
204 The Director resource defines the name and password of the Directors that are
205 permitted to contact this Client.
210 \index[fd]{Director }
211 Start of the Director records. There may be any number of Director resources
212 in the Client configuration file. Each one specifies a Director that is
213 allowed to connect to this Client.
215 \item [Name = \lt{}name\gt{}]
217 The name of the Director that may contact this Client. This name must be the
218 same as the name specified on the Director resource in the Director's
219 configuration file. This record is required.
221 \item [Password = \lt{}password\gt{}]
222 \index[fd]{Password }
223 Specifies the password that must be supplied for a Director to be authorized.
224 This password must be the same as the password specified in the Client
225 resource in the Director's configuration file. This record is required.
227 \item [Monitor = \lt{}yes|no\gt{}]
229 If Monitor is set to {\bf no} (default), this director will have full access
230 to this Client. If Monitor is set to {\bf yes}, this director will only be
231 able to fetch the current status of this Client.
233 Please note that if this director is being used by a Monitor, we highly
234 recommend to set this directive to {\bf yes} to avoid serious security
238 Thus multiple Directors may be authorized to use this Client's services. Each
239 Director will have a different name, and normally a different password as
242 The following is an example of a valid Director resource definition:
247 # List Directors who are permitted to contact the File daemon
251 Password = very_good # password HeadMan must supply
255 Password = not_as_good
261 \subsection*{The Message Resource}
262 \label{MessagesResource}
263 \index[general]{Message Resource }
264 \index[general]{Resource!Message }
265 \addcontentsline{toc}{subsection}{Message Resource}
268 \ilink{Messages Resource}{_ChapterStart15} Chapter of this
269 manual for the details of the Messages Resource.
271 There must be at least one Message resource in the Client configuration file.
273 \subsection*{Example Client Configuration File}
274 \label{SampleClientConfiguration}
275 \index[general]{Example Client Configuration File }
276 \index[general]{File!Example Client Configuration }
277 \addcontentsline{toc}{subsection}{Example Client Configuration File}
279 An example File Daemon configuration file might be the following:
284 # Default Bacula File Daemon Configuration file
286 # For Bacula release 1.35.2 (16 August 2004) -- gentoo 1.4.16
288 # There is not much to change here except perhaps to
289 # set the Director's name and File daemon's name
290 # to something more appropriate for your site.
293 # List Directors who are permitted to contact this File daemon
297 Password = "/LqPRkX++saVyQE7w7mmiFg/qxYc1kufww6FEyY/47jU"
300 # Restricted Director, used by tray-monitor to get the
301 # status of the file daemon
305 Password = "FYpq4yyI1y562EMS35bA0J0QC0M2L3t5cZObxT3XQxgxppTn"
309 # "Global" File daemon configuration specifications
311 FileDaemon { # this is me
313 WorkingDirectory = $HOME/bacula/bin/working
314 Pid Directory = $HOME/bacula/bin/working
316 # Send all messages except skipped files back to Director
319 director = rufus-dir = all, !skipped