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 directive 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 provided the daemon
66
names on the {\bf Name} definition are unique for each daemon. This directive
69
On Win32 systems, in some circumstances you may need to specify a drive
70
letter in the specified working directory path. Also, please be sure
71
that this directory is writable by the SYSTEM user otherwise restores
72
may fail (the bootstrap file that is transferred to the File daemon from
73
the Director is temporarily put in this directory before being passed
74
to the Storage daemon).
76
\item [Pid Directory = \lt{}Directory\gt{}]
77
\index[fd]{Pid Directory }
78
This directive is mandatory and specifies a directory in which the Director
79
may put its process Id file files. The process Id file is used to shutdown
80
Bacula and to prevent multiple copies of Bacula from running simultaneously.
81
This record is required. Standard shell expansion of the {\bf Directory} is
82
done when the configuration file is read so that values such as {\bf \$HOME}
83
will be properly expanded.
85
Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
86
not installing Bacula in the system directories, you can use the {\bf Working
87
Directory} as defined above.
89
\item [Heartbeat Interval = \lt{}time-interval\gt{}]
90
\index[fd]{Heartbeat Interval }
91
\index[general]{Heartbeat Interval}
92
\index[general]{Broken pipe}
93
This record defines an interval of time. For each heartbeat that the
94
File daemon receives from the Storage daemon, it will forward it to the
95
Director. In addition, if no heartbeat has been received from the
96
Storage daemon and thus forwarded the File daemon will send a heartbeat
97
signal to the Director and to the Storage daemon to keep the channels
98
active. The default interval is zero which disables the heartbeat.
99
This feature is particularly useful if you have a router such as 3Com
100
that does not follow Internet standards and times out a valid
101
connection after a short duration despite the fact that keepalive is
102
set. This usually results in a broken pipe error message.
104
If you continue getting broken pipe error messages despite using the
105
Heartbeat Interval, and you are using Windows, you should consider
106
upgrading your ethernet driver. This is a known problem with NVidia
107
NForce 3 drivers (4.4.2 17/05/2004), or try the following workaround
108
suggested by Thomas Simmons for Win32 machines:
111
Start \gt{} Control Panel \gt{} Network Connections
113
Right click the connection for the nvidia adapter and select properties.
114
Under the General tab, click "Configure...". Under the Advanced tab set
115
"Checksum Offload" to disabled and click OK to save the change.
117
Lack of communications, or communications that get interrupted can
118
also be caused by Linux firewalls where you have a rule that throttles
119
connections or traffic.
122
\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
123
\index[fd]{Maximum Concurrent Jobs }
124
where \lt{}number\gt{} is the maximum number of Jobs that should run
125
concurrently. The default is set to 2, but you may set it to a larger
126
number. Each contact from the Director (e.g. status request, job start
127
request) is considered as a Job, so if you want to be able to do a {\bf
128
status} request in the console at the same time as a Job is running, you
129
will need to set this value greater than 1.
131
\item [FDAddresses = \lt{}IP-address-specification\gt{}]
132
\index[console]{FDAddresses }
133
Specify the ports and addresses on which the Director daemon will listen
134
for Bacula Console connections. Probably the simplest way to explain is
139
FDAddresses = { ip = {
140
addr = 1.2.3.4; port = 1205; }
142
addr = 1.2.3.4; port = http; }
155
addr = 201:220:222::2
158
addr = bluedot.thun.net
164
where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
165
can be specified as either a dotted quadruple, or IPv6 colon notation, or as
166
a symbolic name (only in the ip specification). Also, port can be specified
167
as a number or as the mnemonic value from the /etc/services file. If a port
168
is not specified, the default will be used. If an ip section is specified,
169
the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
170
only IPv4 resolutions will be permitted, and likewise with ip6.
172
\item [FDPort = \lt{}port-number\gt{}]
173
\index[console]{FDPort }
174
This specifies the port number on which the Client listens for Director
175
connections. It must agree with the FDPort specified in the Client resource
176
of the Director's configuration file. The default is 9102.
178
\item [FDAddress = \lt{}IP-Address\gt{}]
179
\index[console]{FDAddress }
180
This record is optional, and if it is specified, it will cause the File
181
daemon server (for Director connections) to bind to the specified {\bf
182
IP-Address}, which is either a domain name or an IP address specified as a
183
dotted quadruple. If this record is not specified, the File daemon will bind
184
to any available address (the default).
186
\item [SDConnectTimeout = \lt{}time-interval\gt{}]
187
\index[console]{SDConnectTimeout }
188
This record defines an interval of time that the File daemon will try to
189
connect to the Storage daemon. The default is 30 minutes. If no connection
190
is made in the specified time interval, the File daemon cancels the Job.
192
\item [Maximum Network Buffer Size = \lt{}bytes\gt{}]
193
\index[console]{Maximum Network Buffer Size }
194
where \lt{}bytes\gt{} specifies the initial network buffer size to use with
195
the File daemon. This size will be adjusted down if it is too large until it
196
is accepted by the OS. Please use care in setting this value since if it is
197
too large, it will be trimmed by 512 bytes until the OS is happy, which may
198
require a large number of system calls. The default value is 32,768 bytes.
201
The following is an example of a valid Client resource definition:
205
Client { # this is me
207
WorkingDirectory = $HOME/bacula/bin/working
208
Pid Directory = $HOME/bacula/bin/working
213
\subsection*{The Director Resource}
214
\label{DirectorResource}
215
\index[general]{Director Resource }
216
\index[general]{Resource!Director }
217
\addcontentsline{toc}{subsection}{Director Resource}
219
The Director resource defines the name and password of the Directors that are
220
permitted to contact this Client.
225
\index[fd]{Director }
226
Start of the Director records. There may be any number of Director resources
227
in the Client configuration file. Each one specifies a Director that is
228
allowed to connect to this Client.
230
\item [Name = \lt{}name\gt{}]
232
The name of the Director that may contact this Client. This name must be the
233
same as the name specified on the Director resource in the Director's
234
configuration file. This record is required.
236
\item [Password = \lt{}password\gt{}]
237
\index[fd]{Password }
238
Specifies the password that must be supplied for a Director to be authorized.
239
This password must be the same as the password specified in the Client
240
resource in the Director's configuration file. This record is required.
242
\item [Monitor = \lt{}yes|no\gt{}]
244
If Monitor is set to {\bf no} (default), this director will have full access
245
to this Client. If Monitor is set to {\bf yes}, this director will only be
246
able to fetch the current status of this Client.
248
Please note that if this director is being used by a Monitor, we highly
249
recommend to set this directive to {\bf yes} to avoid serious security
253
Thus multiple Directors may be authorized to use this Client's services. Each
254
Director will have a different name, and normally a different password as
257
The following is an example of a valid Director resource definition:
262
# List Directors who are permitted to contact the File daemon
266
Password = very_good # password HeadMan must supply
270
Password = not_as_good
276
\subsection*{The Message Resource}
277
\label{MessagesResource}
278
\index[general]{Message Resource }
279
\index[general]{Resource!Message }
280
\addcontentsline{toc}{subsection}{Message Resource}
283
\ilink{Messages Resource}{_ChapterStart15} Chapter of this
284
manual for the details of the Messages Resource.
286
There must be at least one Message resource in the Client configuration file.
288
\subsection*{Example Client Configuration File}
289
\label{SampleClientConfiguration}
290
\index[general]{Example Client Configuration File }
291
\index[general]{File!Example Client Configuration }
292
\addcontentsline{toc}{subsection}{Example Client Configuration File}
294
An example File Daemon configuration file might be the following:
299
# Default Bacula File Daemon Configuration file
301
# For Bacula release 1.35.2 (16 August 2004) -- gentoo 1.4.16
303
# There is not much to change here except perhaps to
304
# set the Director's name and File daemon's name
305
# to something more appropriate for your site.
308
# List Directors who are permitted to contact this File daemon
312
Password = "/LqPRkX++saVyQE7w7mmiFg/qxYc1kufww6FEyY/47jU"
315
# Restricted Director, used by tray-monitor to get the
316
# status of the file daemon
320
Password = "FYpq4yyI1y562EMS35bA0J0QC0M2L3t5cZObxT3XQxgxppTn"
324
# "Global" File daemon configuration specifications
326
FileDaemon { # this is me
328
WorkingDirectory = $HOME/bacula/bin/working
329
Pid Directory = $HOME/bacula/bin/working
331
# Send all messages except skipped files back to Director
334
director = rufus-dir = all, !skipped
added
removed
manual-de/filedconf.tex
