4 \chapter{Customizing the Configuration Files}
5 \label{ConfigureChapter}
6 \index[general]{Files!Customizing the Configuration }
7 \index[general]{Customizing the Configuration Files }
9 When each of the Bacula programs starts, it reads a configuration file
10 specified on the command line or the default {\bf bacula-dir.conf}, {\bf
11 bacula-fd.conf}, {\bf bacula-sd.conf}, or {\bf console.conf} for the Director
12 daemon, the File daemon, the Storage daemon, and the Console program
15 Each service (Director, Client, Storage, Console) has its own configuration
16 file containing a set of Resource definitions. These resources are very
17 similar from one service to another, but may contain different directives
18 (records) depending on the service. For example, in the Director's resource
19 file, the {\bf Director} resource defines the name of the Director, a number
20 of global Director parameters and his password. In the File daemon
21 configuration file, the {\bf Director} resource specifies which Directors are
22 permitted to use the File daemon.
24 Before running Bacula for the first time, you must customize the configuration
25 files for each daemon. Default configuration files will have been created by
26 the installation process, but you will need to modify them to correspond to
27 your system. An overall view of the resources can be seen in the following:
29 \addcontentsline{lof}{figure}{Bacula Objects}
30 \includegraphics{./bacula-objects.eps}
32 (thanks to Aristides Maniatis for the above graphic)
35 \section{Character Sets}
36 \index[general]{Character Sets}
37 Bacula is designed to handle most character sets of the world,
38 US ASCII, German, French, Chinese, ... However, it does this by
39 encoding everything in UTF-8, and it expects all configuration files
40 (including those read on Win32 machines) to be in UTF-8 format.
41 UTF-8 is typically the default on Linux machines, but not on all
42 Unix machines, nor on Windows, so you must take some care to ensure
43 that your locale is set properly before starting Bacula.
45 To ensure that Bacula configuration files can be correctly read including
46 foreign characters the {bf LANG} environment variable
47 must end in {\bf .UTF-8}. An full example is {\bf en\_US.UTF-8}. The
48 exact syntax may vary a bit from OS to OS, and exactly how you define
49 it will also vary. On most newer Win32 machines, you can use {\bf notepad}
50 to edit the conf files, then choose output encoding UTF-8.
52 Bacula assumes that all filenames are in UTF-8 format on Linux and
53 Unix machines. On Win32 they are in Unicode (UTF-16), and will
54 be automatically converted to UTF-8 format.
56 \section{Resource Directive Format}
57 \index[general]{Resource Directive Format }
58 \index[general]{Format!Resource Directive }
60 Although, you won't need to know the details of all the directives a basic
61 knowledge of Bacula resource directives is essential. Each directive contained
62 within the resource (within the braces) is composed of a keyword followed by
63 an equal sign (=) followed by one or more values. The keywords must be one of
64 the known Bacula resource record keywords, and it may be composed of upper or
65 lower case characters and spaces.
67 Each resource definition MUST contain a Name directive, and may optionally
68 contain a Description directive. The Name directive is used to
69 uniquely identify the resource. The Description directive is (will be) used
70 during display of the Resource to provide easier human recognition. For
77 Description = "Main Bacula Director"
78 WorkingDirectory = "$HOME/bacula/bin/working"
83 Defines the Director resource with the name "MyDir" and a working directory
84 \$HOME/bacula/bin/working. In general, if you want spaces in a name to the
85 right of the first equal sign (=), you must enclose that name within double
86 quotes. Otherwise quotes are not generally necessary because once defined,
87 quoted strings and unquoted strings are all equal.
91 \index[general]{Comments}
93 When reading the configuration file, blank lines are ignored and everything
94 after a hash sign (\#) until the end of the line is taken to be a comment. A
95 semicolon (;) is a logical end of line, and anything after the semicolon is
96 considered as the next statement. If a statement appears on a line by itself,
97 a semicolon is not necessary to terminate it, so generally in the examples in
98 this manual, you will not see many semicolons.
101 \subsection{Upper and Lower Case and Spaces}
102 \index[general]{Spaces!Upper/Lower Case}
103 \index[general]{Upper and Lower Case and Spaces}
105 Case (upper/lower) and spaces are totally ignored in the resource directive
106 keywords (the part before the equal sign).
108 Within the keyword (i.e. before the equal sign), spaces are not significant.
109 Thus the keywords: {\bf name}, {\bf Name}, and {\bf N a m e} are all
112 Spaces after the equal sign and before the first character of the value are
115 In general, spaces within a value are significant (not ignored), and if the
116 value is a name, you must enclose the name in double quotes for the spaces to
117 be accepted. Names may contain up to 127 characters. Currently, a name may
118 contain any ASCII character. Within a quoted string, any character following a
119 backslash (\textbackslash{}) is taken as itself (handy for inserting
120 backslashes and double quotes (").
122 Please note, however, that Bacula resource names as well as certain other
123 names (e.g. Volume names) must contain only letters (including ISO accented
124 letters), numbers, and a few special characters (space, underscore, ...).
125 All other characters and punctuation are invalid.
128 \subsection{Including other Configuration Files}
129 \index[general]{Including other Configuration Files }
130 \index[general]{Files!Including other Configuration }
131 \index[general]{Using @ to include other files}
132 \index[general]{@{\bf filename}}
134 If you wish to break your configuration file into smaller pieces, you can do
135 so by including other files using the syntax @{\bf filename} where {\bf
136 filename} is the full path and filename of another file. The @filename
137 specification can be given anywhere a primitive token would appear.
140 \subsection{Recognized Primitive Data Types}
141 \index[general]{Types!Recognized Primitive Data }
142 \index[general]{Recognized Primitive Data Types }
144 When parsing the resource directives, Bacula classifies the data according to
145 the types listed below. The first time you read this, it may appear a bit
146 overwhelming, but in reality, it is all pretty logical and straightforward.
152 A keyword or name consisting of alphanumeric characters, including the
153 hyphen, underscore, and dollar characters. The first character of a {\bf
154 name} must be a letter. A name has a maximum length currently set to 127
155 bytes. Typically keywords appear on the left side of an equal (i.e. they are
156 Bacula keywords -- i.e. Resource names or directive names). Keywords may not
160 \index[fd]{name-string}
161 A name-string is similar to a name, except that the name may be quoted and
162 can thus contain additional characters including spaces. Name strings are
163 limited to 127 characters in length. Name strings are typically used on the
164 right side of an equal (i.e. they are values to be associated with a keyword.
169 A quoted string containing virtually any character including spaces, or a
170 non-quoted string. A string may be of any length. Strings are typically
171 values that correspond to filenames, directories, or system command names. A
172 backslash (\textbackslash{}) turns the next character into itself, so to
173 include a double quote in a string, you precede the double quote with a
174 backslash. Likewise to include a backslash.
177 \index[dir]{directory}
178 A directory is either a quoted or non-quoted string. A directory will be
179 passed to your standard shell for expansion when it is scanned. Thus
180 constructs such as {\bf \$HOME} are interpreted to be their correct values.
183 \index[dir]{password}
184 This is a Bacula password and it is stored internally in MD5 hashed format.
188 A 32 bit integer value. It may be positive or negative.
190 \item [positive integer]
191 \index[dir]{positive integer }
192 A 32 bit positive integer value.
195 \index[dir]{long integer}
196 A 64 bit integer value. Typically these are values such as bytes that can
197 exceed 4 billion and thus require a 64 bit value.
200 \index[dir]{yes or no }
201 Either a {\bf yes} or a {\bf no}.
206 A size specified as bytes. Typically, this is a floating point scientific
207 input format followed by an optional modifier. The floating point input is
208 stored as a 64 bit integer value. If a modifier is present, it must
209 immediately follow the value with no intervening spaces. The following
210 modifiers are permitted:
220 1,048,576 (megabytes)
223 1,000,000 (megabytes)
226 1,073,741,824 (gigabytes)
229 1,000,000,000 (gigabytes)
235 A time or duration specified in seconds. The time is stored internally as
236 a 64 bit integer value, but it is specified in two parts: a number part and
237 a modifier part. The number can be an integer or a floating point number.
238 If it is entered in floating point notation, it will be rounded to the
239 nearest integer. The modifier is mandatory and follows the number part,
240 either with or without intervening spaces. The following modifiers are
259 days (3600*24 seconds)
263 weeks (3600*24*7 seconds)
267 months (3600*24*30 seconds)
270 \index[dir]{quarters }
271 quarters (3600*24*91 seconds)
275 years (3600*24*365 seconds)
278 Any abbreviation of these modifiers is also permitted (i.e. {\bf seconds}
279 may be specified as {\bf sec} or {\bf s}. A specification of {\bf m} will
282 The specification of a time may have as many number/modifier parts as you
287 1 week 2 days 3 hours 10 mins
288 1 month 2 days 30 sec
293 are valid date specifications.
298 \section{Resource Types}
299 \index[general]{Types!Resource }
300 \index[general]{Resource Types }
302 The following table lists all current Bacula resource types. It shows what
303 resources must be defined for each service (daemon). The default configuration
304 files will already contain at least one example of each permitted resource, so
305 you need not worry about creating all these kinds of resources from scratch.
307 \addcontentsline{lot}{table}{Resource Types}
308 \begin{longtable}{|l|l|l|l|l|}
310 \multicolumn{1}{|c| }{\bf Resource } & \multicolumn{1}{c| }{\bf Director } &
311 \multicolumn{1}{c| }{\bf Client } & \multicolumn{1}{c| }{\bf Storage } &
312 \multicolumn{1}{c| }{\bf Console } \\
314 {Autochanger } & {No } & {No } & {Yes } & {No } \\
316 {Catalog } & {Yes } & {No } & {No } & {No } \\
318 {Client } & {Yes } & {Yes } & {No } & {No } \\
320 {Console } & {Yes } & {No } & {No } & {Yes } \\
322 {Device } & {No } & {No } & {Yes } & {No } \\
324 {Director } & {Yes } & {Yes } & {Yes } & {Yes } \\
326 {FileSet } & {Yes } & {No } & {No } & {No } \\
328 {Job } & {Yes } & {No } & {No } & {No } \\
330 {JobDefs } & {Yes } & {No } & {No } & {No } \\
332 {Message } & {Yes } & {Yes } & {Yes } & {No } \\
334 {Pool } & {Yes } & {No } & {No } & {No } \\
336 {Schedule } & {Yes } & {No } & {No } & {No } \\
338 {Storage } & {Yes } & {No } & {Yes } & {No }
343 \section{Names, Passwords and Authorization}
345 \index[general]{Authorization!Names Passwords and }
346 \index[general]{Names, Passwords and Authorization }
347 \index[general]{Passwords}
349 In order for one daemon to contact another daemon, it must authorize itself
350 with a password. In most cases, the password corresponds to a particular name,
351 so both the name and the password must match to be authorized.
353 The default configuration files are automatically defined for correct
354 authorization with random passwords. If you add to or modify these files, you
355 will need to take care to keep them consistent.
357 Here is sort of a picture of what names/passwords in which files/Resources
360 \includegraphics{./Conf-Diagram.eps}
362 In the left column, you will find the Director, Storage, and Client resources,
363 with their names and passwords -- these are all in {\bf bacula-dir.conf}. In
364 the right column are where the corresponding values should be found in the
365 Console, Storage daemon (SD), and File daemon (FD) configuration files.
367 Please note that the Address, {\bf fd-sd}, that appears in the Storage
368 resource of the Director, preceded with and asterisk in the above example, is
369 passed to the File daemon in symbolic form. The File daemon then resolves it
370 to an IP address. For this reason, you must use either an IP address or a
371 fully qualified name. A name such as {\bf localhost}, not being a fully
372 qualified name, will resolve in the File daemon to the localhost of the File
373 daemon, which is most likely not what is desired. The password used for the
374 File daemon to authorize with the Storage daemon is a temporary password
375 unique to each Job created by the daemons and is not specified in any .conf
378 \section{Detailed Information for each Daemon}
379 \index[general]{Detailed Information for each Daemon }
380 \index[general]{Daemon!Detailed Information for each }
382 The details of each Resource and the directives permitted therein are
383 described in the following chapters.
385 The following configuration files must be defined:
389 \ilink{Console}{ConsoleConfChapter} -- to define the resources for
390 the Console program (user interface to the Director). It defines which
391 Directors are available so that you may interact with them.
393 \ilink{Director}{DirectorChapter} -- to define the resources
394 necessary for the Director. You define all the Clients and Storage daemons
395 that you use in this configuration file.
397 \ilink{Client}{FiledConfChapter} -- to define the resources for
398 each client to be backed up. That is, you will have a separate Client
399 resource file on each machine that runs a File daemon.
401 \ilink{Storage}{StoredConfChapter} -- to define the resources to
402 be used by each Storage daemon. Normally, you will have a single Storage
403 daemon that controls your tape drive or tape drives. However, if you have
404 tape drives on several machines, you will have at least one Storage daemon