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 \item [Pid Directory = \lt{}Directory\gt{}]
68 \index[dir]{Pid Directory }
69 This directive is mandatory and specifies a directory in which the Director
70 may put its process Id file files. The process Id file is used to shutdown
71 Bacula and to prevent multiple copies of Bacula from running simultaneously.
72 This record is required. Standard shell expansion of the {\bf Directory} is
73 done when the configuration file is read so that values such as {\bf \$HOME}
74 will be properly expanded.
76 Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
77 not installing Bacula in the system directories, you can use the {\bf Working
78 Directory} as defined above.
80 \item [Heartbeat Interval = \lt{}time-interval\gt{}]
81 \index[dir]{Heartbeat Interval }
82 This record defines an interval of time. For each heartbeat that the
83 File daemon receives from the Storage daemon, it will forward it to the
84 Director. In addition, if no heartbeat has been received from the
85 Storage daemon and thus forwarded the File daemon will send a heartbeat
86 signal to the Director and to the Storage daemon to keep the channels
87 active. The default interval is zero which disables the heartbeat.
88 This feature is particularly useful if you have a router such as 3Com
89 that does not follow Internet standards and times out an inactive
90 connection after a short duration.
92 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
93 \index[dir]{Maximum Concurrent Jobs }
94 where \lt{}number\gt{} is the maximum number of Jobs that should run
95 concurrently. The default is set to 2, but you may set it to a larger
96 number. Each contact from the Director (e.g. status request, job start
97 request) is considered as a Job, so if you want to be able to do a {\bf
98 status} request in the console at the same time as a Job is running, you
99 will need to set this value greater than 1.
101 \item [FDAddresses = \lt{}IP-address-specification\gt{}]
102 \index[console]{FDAddresses }
103 Specify the ports and addresses on which the Director daemon will listen
104 for Bacula Console connections. Probably the simplest way to explain is
109 FDAddresses = { ip = {
110 addr = 1.2.3.4; port = 1205; }
112 addr = 1.2.3.4; port = http; }
125 addr = 201:220:222::2
128 addr = bluedot.thun.net
134 where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
135 can be specified as either a dotted quadruple, or IPv6 colon notation, or as
136 a symbolic name (only in the ip specification). Also, port can be specified
137 as a number or as the mnemonic value from the /etc/services file. If a port
138 is not specified, the default will be used. If an ip section is specified,
139 the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
140 only IPv4 resolutions will be permitted, and likewise with ip6.
142 \item [FDPort = \lt{}port-number\gt{}]
143 \index[console]{FDPort }
144 This specifies the port number on which the Client listens for Director
145 connections. It must agree with the FDPort specified in the Client resource
146 of the Director's configuration file. The default is 9102.
148 \item [FDAddress = \lt{}IP-Address\gt{}]
149 \index[console]{FDAddress }
150 This record is optional, and if it is specified, it will cause the File
151 daemon server (for Director connections) to bind to the specified {\bf
152 IP-Address}, which is either a domain name or an IP address specified as a
153 dotted quadruple. If this record is not specified, the File daemon will bind
154 to any available address (the default).
156 \item [SDConnectTimeout = \lt{}time-interval\gt{}]
157 \index[console]{SDConnectTimeout }
158 This record defines an interval of time that the File daemon will try to
159 connect to the Storage daemon. The default is 30 minutes. If no connection
160 is made in the specified time interval, the File daemon cancels the Job.
162 \item [Maximum Network Buffer Size = \lt{}bytes\gt{}]
163 \index[console]{Maximum Network Buffer Size }
164 where \lt{}bytes\gt{} specifies the initial network buffer size to use with
165 the File daemon. This size will be adjusted down if it is too large until it
166 is accepted by the OS. Please use care in setting this value since if it is
167 too large, it will be trimmed by 512 bytes until the OS is happy, which may
168 require a large number of system calls. The default value is 32,768 bytes.
171 The following is an example of a valid Client resource definition:
175 Client { # this is me
177 WorkingDirectory = $HOME/bacula/bin/working
178 Pid Directory = $HOME/bacula/bin/working
183 \subsection*{The Director Resource}
184 \label{DirectorResource}
185 \index[general]{Director Resource }
186 \index[general]{Resource!Director }
187 \addcontentsline{toc}{subsection}{Director Resource}
189 The Director resource defines the name and password of the Directors that are
190 permitted to contact this Client.
195 \index[fd]{Director }
196 Start of the Director records. There may be any number of Director resources
197 in the Client configuration file. Each one specifies a Director that is
198 allowed to connect to this Client.
200 \item [Name = \lt{}name\gt{}]
202 The name of the Director that may contact this Client. This name must be the
203 same as the name specified on the Director resource in the Director's
204 configuration file. This record is required.
206 \item [Password = \lt{}password\gt{}]
207 \index[fd]{Password }
208 Specifies the password that must be supplied for a Director to be authorized.
209 This password must be the same as the password specified in the Client
210 resource in the Director's configuration file. This record is required.
212 \item [Monitor = \lt{}yes|no\gt{}]
214 If Monitor is set to {\bf no} (default), this director will have full access
215 to this Client. If Monitor is set to {\bf yes}, this director will only be
216 able to fetch the current status of this Client.
218 Please note that if this director is being used by a Monitor, we highly
219 recommend to set this directive to {\bf yes} to avoid serious security
223 Thus multiple Directors may be authorized to use this Client's services. Each
224 Director will have a different name, and normally a different password as
227 The following is an example of a valid Director resource definition:
232 # List Directors who are permitted to contact the File daemon
236 Password = very_good # password HeadMan must supply
240 Password = not_as_good
246 \subsection*{The Message Resource}
247 \label{MessagesResource}
248 \index[general]{Message Resource }
249 \index[general]{Resource!Message }
250 \addcontentsline{toc}{subsection}{Message Resource}
253 \ilink{Messages Resource}{_ChapterStart15} Chapter of this
254 manual for the details of the Messages Resource.
256 There must be at least one Message resource in the Client configuration file.
258 \subsection*{Example Client Configuration File}
259 \label{SampleClientConfiguration}
260 \index[general]{Example Client Configuration File }
261 \index[general]{File!Example Client Configuration }
262 \addcontentsline{toc}{subsection}{Example Client Configuration File}
264 An example File Daemon configuration file might be the following:
269 # Default Bacula File Daemon Configuration file
271 # For Bacula release 1.35.2 (16 August 2004) -- gentoo 1.4.16
273 # There is not much to change here except perhaps to
274 # set the Director's name and File daemon's name
275 # to something more appropriate for your site.
278 # List Directors who are permitted to contact this File daemon
282 Password = "/LqPRkX++saVyQE7w7mmiFg/qxYc1kufww6FEyY/47jU"
285 # Restricted Director, used by tray-monitor to get the
286 # status of the file daemon
290 Password = "FYpq4yyI1y562EMS35bA0J0QC0M2L3t5cZObxT3XQxgxppTn"
294 # "Global" File daemon configuration specifications
296 FileDaemon { # this is me
298 WorkingDirectory = $HOME/bacula/bin/working
299 Pid Directory = $HOME/bacula/bin/working
301 # Send all messages except skipped files back to Director
304 director = rufus-dir = all, !skipped