2ead4d8498411abef23e1c1a7e331245789c372a
[debian/amanda] / example / config.site
1 ######################################################################
2 #
3 # Site dependend configuration.  Please edit this file for your
4 # local site and place it in $prefix/share or $prefix/etc.
5 #
6 # For those options that need to replace the default configuration,
7 # remove the beginning # at beginning of the line and set the
8 # options to how you like it.
9 #
10 # These options can also be set on the command line for the configure
11 # script.  The appropriate option for the option is listed along with
12 # the option.
13 #
14 ######################################################################
15
16 # These are the directories for the Amanda programs and files.
17 #
18 # Let $prefix be the location of the root Amanda directory, commonly
19 # /usr/local or /opt/amanda.  $prefix is set by using configure --prefix=.
20 # Other directories are setable:
21 #    $prefix            --prefix=               Default:/usr/local
22 #    $exec_prefix       --exec-prefix=          Default:$prefix
23 #    $sbindir           --sbindir=              Default:$exec_prefix/sbin
24 #    $libexecdir        --libexecdir=           Default:$exec_prefix/libexec
25 #    $libdir            --libdir=               Default:$exec_prefix/lib
26 #    $sysconfdir        --sysconfdir=           Default:$prefix/etc
27 #    $localstatedir     --localstatedir=        Default:$prefix/var
28 #    $mandir            --mandir=               Default:$prefix/man
29
30 # sbindir               --sbindir=DIR
31 #                       Default: $exec_prefix/sbin = /usr/local/sbin
32 #                       Directory containing the server side binaries.
33 # sbindir=/usr/local/sbin
34
35
36 # libexecdir            --libexecdir=DIR
37 #                       Default: $exec_prefix/libexec = /usr/local/libexec
38 #                       Directory containing the client side binaries.
39 # libexecdir=/usr/local/lib/amanda
40
41
42 # lib                   --libdir=DIR
43 #                       Default: $exec_prefix/lib = /usr/local/lib
44 #                       Directory containing the amanda (shared) libraries.
45 # libdir=/usr/local/lib/amanda
46
47
48 # mandir                --mandir=DIR
49 #                       Default: $prefix/man = /usr/local/man
50 #                       Directory containing the manual pages.
51 # mandir=/local/man
52
53
54 # INCLUDE_DIRS          --with-includes="DIR DIR ..."
55 #                       Default: empty
56 #                       Non-standard directories where include files should
57 #                       be looked for.
58 # INCLUDE_DIRS="/opt/gnu/readline/include /opt/gnu/gdbm/include"
59
60
61 # LIBRARY_DIRS          --with-libraries="DIR DIR ..."
62 #                       Default: empty
63 #                       Non-standard directories where libraries should
64 #                       be looked for.
65 # LIBRARY_DIRS="/opt/gnu/readline/lib /opt/gnu/gdbm/lib"
66
67
68 # CONFIG_DIR            --with-configdir=DIR
69 #                       Default: $sysconfdir/amanda = /usr/local/etc/amanda
70 #                       Directory where the runtime files are to be
71 #                       found.  Amanda supports multiple
72 #                       configurations per site; these are contained
73 #                       in subdirectories of CONFIG_DIR.
74 # CONFIG_DIR=/usr/local/etc/amanda
75
76
77 # USE_VERSION_SUFFIXES  --with-suffixes
78 #                       Default: no
79 #                       All the Amanda binaries will be installed with a
80 #                       version string appended to the command name, for
81 #                       example "amdump-2.3.0.4".  You must then set up
82 #                       symlinks from "amdump" to the correct version of
83 #                       the binary, or use them with the version suffixes
84 #                       directly.
85 #                       This is mostly useful when you want multiple
86 #                       versions online for testing purposes.  I recommend
87 #                       it if you are doing a major version upgrade and
88 #                       wish to try out the new version in parallel with
89 #                       the old.
90 # USE_VERSION_SUFFIXES=yes
91
92
93 # NO_SERVER_MODE        --without-server
94 #                       Default: false
95 #                       if true, disables building server stuff.
96 #                       Note: setting NO_SERVER_MODE=true implies
97 #                       --without-restore, i.e. NO_RESTORE_MODE=true,
98 #                       and it is an error to try to force a mismatch
99 # NO_SERVER_MODE=true
100
101
102 # NO_CLIENT_MODE        --without-client
103 #                       Default: false
104 #                       if true, disables building client stuff.
105 # NO_CLIENT_MODE=true
106
107
108 # NO_RESTORE_MODE       --without-restore
109 #                       Default: false
110 #                       if true, disables building amrestore and amidxtaped
111 # NO_RESTORE_MODE=true
112
113
114 # NO_RECOVER_MODE       --without-amrecover
115 #                       Default: false
116 #                       if true, disables building amrecover.
117 # NO_RECOVER_MODE=true
118
119
120 # DEFAULT_SERVER        --with-index-server=HOST
121 #                       Default: name of the machine configure is run on
122 #                       The default server for the index of files dumped
123 #                       database.
124 # DEFAULT_SERVER=kipuka
125
126
127 # FORCE_USERID          --with-dont-force-uid
128 #                       Default: yes
129 #                       FORCE_USERID controls whether or not the Amanda
130 #                       client-side should suid to a non-priveledged user
131 #                       when inetd runs it as root.  Most older inetds do
132 #                       not allow you to specify which user to run a daemon
133 #                       as in inetd.conf; all daemons are just run as root.
134 #                       We prefer to not do anything as root that can be
135 #                       done as a normal user, so unless FORCE_USERID is set
136 #                       to no, Amanda will switch to the user specified by
137 #                       CLIENT_LOGIN for all further operations on the slave
138 #                       host.  This type of operation normally requires that
139 #                       the CLIENT_LOGIN be in some group that has read
140 #                       permissions on the raw disk devices, and read/write
141 #                       permissions on /etc/dumpdates.
142 # FORCE_USERID=no
143
144
145 # CLIENT_LOGIN          --with-user=USERNAME
146 #                       This flag *must* be specified
147 #                       The user to install as the owner of all Amanda
148 #                       programs and the user to switch to on client
149 #                       machines.
150 # CLIENT_LOGIN=amanda
151
152
153 # SETUID_GROUP          --with-group=GROUPNAME
154 #                       This flag *must* be specified
155 #                       The name of the group to install all files under.
156 # SETUID_GROUP=bin
157
158
159 # USE_RUNDUMP           --with-rundump
160 #                       Default: no (unless xfsdump or vdump are found)
161 #                       Enables the usage of the rundump setuid-root
162 #                       program, that invokes dump as root.
163 # USE_RUNDUMP=yes
164
165
166 # DEFAULT_CONFIG        --with-config=CONFIG
167 #                       Default: DailySet1
168 #                       The default configuration name of the default
169 #                       dump set up.  This gets used throughout the
170 #                       configuration of Amanda.
171 # DEFAULT_CONFIG=DailySet1
172
173
174 # DEFAULT_TAPE_SERVER   --with-tape-server=TAPE_SERVER
175 #                       Default: DEFAULT_SERVER or [--with-index-server]
176 #                       This is the name of the machine which serves as the
177 #                       default machine to recover files from tape using
178 #                       amrecover.  The default machine is the one used
179 #                       for DEFAULT_SERVER.
180 # DEFAULT_TAPE_SERVER=kipuka
181
182
183 # DEFAULT_TAPE_DEVICE   --with-tape-device=TAPE_DEVICE
184 #                       Default: /dev/rmt/[0-9]bn or /dev/nrst[0-9]
185 #                       This sets the default no rewinding tape device.  The
186 #                       configure script will search for the lowest numbered
187 #                       /dev/rmt/[0-9]bn device and if none exist, it will
188 #                       use the lowest numbered /dev/nrst[0-9] device.  If
189 #                       no tape device is found, /dev/null is used.
190 #
191 #                       This is also the name of the no rewinding tape device
192 #                       on the the DEFAULT_TAPE_SERVER machine for
193 #                       restoring backups.
194 # DEFAULT_TAPE_DEVICE=/dev/rmt/0bn
195 # DEFAULT_TAPE_DEVICE=/dev/nrst0
196
197
198 # DEFAULT_RAW_TAPE_DEVICE  --with-ftape-rawdevice=RAW_TAPE_DEVICE
199 #           Default: /dev/rawft[0-3]
200 #           This sets the default raw tape device for use with the Linux 
201 #           floppy tape driver ftape (version 3.04d).
202 #           The configure script will search for the lowest numbered
203 #           /dev/rawft[0-3] device. If no device is found, /dev/null is used.
204 #
205 #           This device is needed for QIC volume table operations with 
206 #           floppy tapes.
207 # DEFAULT_RAW_TAPE_DEVICE=/dev/rawft0
208
209
210 # DEFAULT_CHANGER_DEVICE --with-changer-device=CHANGER_DEVICE
211 #                       Default: /dev/ch0 or /dev/null
212 #                       This sets the default tape changer device.
213 #                       If /dev/ch0 exists, it is used, otherwise, no
214 #                       changer device is defined.
215 # DEFAULT_CHANGER_DEVICE=/dev/ch0
216
217
218 # USE_FQDN              --with-fqdn
219 #                       Default: no
220 #                       Allow Amanda to backup systems in different
221 #                       domains.  This requires that the disklist file
222 #                       have the fully qualified domain names (FQDNs)
223 #                       listed.
224 # USE_FQDN=yes
225
226
227 # SAMBA_CLIENT          --with-smbclient=PROG
228 #                       Default: no
229 #                       Tell Amanda where to find the smbclient program,
230 #                       which does the backing up of Samba PC clients.
231 #                       Look in the patches/ directory for patches to
232 #                       apply to Samba for this to work properly.
233 # SAMBA_CLIENT=/usr/local/bin/smbclient
234
235
236 # GNUTAR                --with-gnutar=PROG
237 #                       Default: look for program named gtar, gnutar or tar
238 #                       that prints GNU tar when run with --version.
239 # GNUTAR=/usr/local/bin/gnutar
240
241 # GNUTAR_LISTDIR        --with-gnutar-listdir[=DIR]
242 #                       Default: $localstatedir/amanda/gnutar-lists =
243 #                               /usr/local/var/amanda/gnutar-lists
244 #                       This specifies the directory where gnutar should
245 #                       place the listed incrementals directory lists it 
246 #                       uses to do incremental backups.
247 # GNUTAR_LISTDIR=/usr/local/var/amanda/gnutar-lists
248
249
250 # DEV_PREFIX
251 #                       Default: system specific
252 #                       Define DEV_PREFIX is the configure script can not
253 #                       figure out the correct device prefix for the disk
254 #                       devices.
255 # DEV_PREFIX="/dev/"
256
257
258 # RDEV_PREFIX
259 #                       Default: system specific
260 #                       Define DEV_PREFIX is the configure script can not
261 #                       figure out the correct device prefix for the raw
262 #                       disk devices.
263 # RDEV_PREFIX="/dev/r"
264
265
266 # BSD_SECURITY          --without-bsd-security
267 #                       Default: yes
268 #                       BSD_SECURITY selects BSD rsh/rlogin style security,
269 #                       which is not great, but is in common use, and its
270 #                       strengths and weaknesses are well known.  Under
271 #                       BSD_SECURITY, the Amanda backup client hosts will
272 #                       check .rhosts (or .amandahosts, see below)
273 #                       files before sending any dump data.
274 # BSD_SECURITY=no
275
276
277 # USE_AMANDAHOSTS       --without-amandahosts
278 #                       Default: yes
279 #                       When BSD_SECURITY is used, by default it will use
280 #                       the .amandahosts file to make sure that the remote
281 #                       user can tell the Amanda client what to do.  If you
282 #                       wish to use the more standard .rhosts and
283 #                       /etc/hosts.equiv files instead, then define this to
284 #                       no.  Unlike .rhosts, .amandahosts cannot contain
285 #                       lines with hostnames only; the username must always
286 #                       be specified.
287 # USE_AMANDAHOSTS=no
288
289
290 # PORTRANGE             --with-portrange=min,max
291 #                       Default: unlimited
292 #                       Limits the range of ports that TCP server
293 #                       sockets will be bound to.  It does not affect
294 #                       reserved (<1024) ports, though.  This is useful 
295 #                       for backing up hosts behind firewalls: they can
296 #                       be configured to use this limited range of
297 #                       ports for data, message and index connections.
298 # PORTRANGE=50000,50100
299
300
301 # UDPPORTRANGE          --with-udpportrange=min,max
302 #                       Default: unlimited
303 #                       Limits the range of ports that UDP sockets
304 #                       will be bound to.  This one *does* affect
305 #                       reserved (<1024) ports, except those handed to
306 #                       amandad by inetd, of course.  This is useful 
307 #                       for backing up hosts behind firewalls: they can
308 #                       be configured to use this limited range of
309 #                       ports for requests.
310 # UDPPORTRANGE=512,520
311
312
313 # KRB4_SECURITY         --with-krb4-security
314 #                       Default: no
315 #                       KRB4_SECURITY selects MIT Kerberos version 4 style
316 #                       security, which is significantly better than
317 #                       BSD_SECURITY, providing for mutual authentication
318 #                       and (optionally) encryption of backup data over the
319 #                       network.  Both BSD_SECURITY and KRB4_SECURITY may be
320 #                       defined at the same time: the type of security to be
321 #                       used can be selected on a per-client-host basis (in
322 #                       the disklist file).
323 #                       NOTE: Due to stupid USA export restrictions, use of
324 #                       KRB4_SECURITY requires source files from the separate
325 #                       "amanda-krb4" package.  See the KERBEROS.HOW-TO-GET
326 #                       instructions on the Amanda home ftp site,
327 #                       ftp.amanda.org.
328 # KRB4_SECURITY=yes
329
330 # If you turn on KRB4_SECURITY, you must set all these options below.
331 #
332 # You can set the principle, instance, and keyfile to use seperately for
333 # both the client and server.
334 #
335 # The instance can either be a string constant, or `HOSTNAME_INSTANCE' if
336 # you want the local hostname used as the instance (ala krb_get_phost).
337 #
338 # The keyfile name can be either a string constant, or `KEYFILE' to use the
339 # default keyfile defined in <krb.h>.
340 # SERVER_HOST_PRINCIPLE="amanda"
341 # SERVER_HOST_INSTANCE="amanda"
342 # SERVER_HOST_KEY_FILE="/.amanda"
343 # CLIENT_HOST_PRINCIPAL="rcmd"
344 # CLIENT_HOST_INSTANCE=HOSTNAME_INSTANCE
345 # CLIENT_HOST_KEY_FILE=KEYFILE
346 # TICKET_LIFETIME=128
347
348
349 # DB_STYLE              --with-db={text,db,dbm,gdbm,ndbm}
350 #                       Default: text
351 #                       This allows the user to force Amanda to use a
352 #                       particular database library.
353 # DB_STYLE=text
354
355 # FORCE_MMAP            --with-mmap
356 #                       Default: no
357 #                       Force the use of mmap() instead of shared memory
358 #                       support.
359 # FORCE_MMAP=yes
360
361
362 # DUMPER_SOCKET_BUFFERIING --with-buffered-dump
363 #                       Default: no
364 #                       Dumping sockets are buffered in the server.  This
365 #                       may improve dumping speed.
366 # DUMPER_SOCKET_BUFFERING=yes
367
368
369 # ASSERTIONS            --with-assertions
370 #                       Default: no
371 #                       Turns on assertion checking, which makes Amanda a
372 #                       bit bigger and slower, but will help catch errors
373 #                       earlier.
374 # ASSERTIONS=yes
375
376
377 # DEBUGGING             --with-debugging
378 #                       Default: /tmp/amanda
379 #                       Turning off debugging prevents that each
380 #                       program saves a transcript of what it did to a
381 #                       file in /tmp/amanda for debugging purposes.  An
382 #                       alternate directory can be specified too.
383 # DEBUGGING=no
384 # DEBUGGING=/var/amanda/debug
385
386 # DEBUG_FILE_WITH_PID   --with-pid-debug-files
387 #                       Default: no
388 #                       Have the Amanda debugging files that are placed
389 #                       in /tmp/amanda have the process ID appended to their
390 #                       filename.
391 # DEBUG_FILE_WITH_PID=yes
392
393
394 # TESTING               --with-testing[=suffix]
395 #                       Default: no
396 #                       Ues alternate service names so that a new
397 #                       version of amanda can be tested without preventing
398 #                       a production one from being run successfully.
399 #                       The used service names will have `-test' appended
400 #                       to the original names, i.e., service `amanda'
401 #                       will become `amanda-test'.
402 #                       If anything different from `n', `no', `y', `ye' or
403 #                       `yes' is specified as suffix, after the equal sign,
404 #                       this suffix will be appended to the service names
405 #                       after a hyphen, i.e., --with-testing=test2 will
406 #                       cause service `amanda-test2' to be used.
407 # TESTING=yes
408
409
410 # USE_LIBTOOL           --disable-libtool
411 #                       Default: yes
412 #                       By default, libtool to create static/shared
413 #                       libraries.  If USE_LIBTOOL is set to no, or
414 #                       --disable-libtool is specified, only static
415 #                       libraries will be created, and the libtool
416 #                       script will only be used to link and install
417 #                       programs.
418 #                       A drawback of using libtool is that it will
419 #                       always install libraries, even static ones,
420 #                       which are not necessary for the execution of
421 #                       programs.  The advantage of using libtool is
422 #                       that shared libraries may be created, which
423 #                       saves disk space.
424 # USE_LIBTOOL=yes
425
426 # with_gnu_ld           --with-gnu-ld
427 #                       Default: no
428 #                       Use GNU ld in order to build shared libraries
429 # with_gnu_ld=yes
430
431
432 # libtool_shared        --enable-shared
433 #                       Default: (enabled)
434 #                       Enable the creation of shared libraries
435 # libtool_shared=--disable-shared
436
437
438 # libtool_static        --enable-static
439 #                       Default: (enabled)
440 #                       Enable the creation of static libraries
441 # libtool_static=--disable-static
442
443
444 #
445 ######################################################################