Imported Upstream version 2.5.1
[debian/amanda] / example / amanda.conf.in
index 1baa5095eeb9cb6e8ca4fc756d80a194ac61a94c..1a2891ccaff867f87b222594a182d5b1e8147305 100644 (file)
@@ -1,23 +1,8 @@
-###  !!! WARNING !!!  !!! WARNING !!!  !!! WARNING !!!  !!! WARNING !!!  ###
-###                                                                      ###
-###  This file is not meant to be installed "as is", and in fact, it     ###
-###  WILL NOT WORK!  You must go through it and make changes appropriate ###
-###  to your own situation.  See the documentation in this file, in the  ###
-###  "man amanda" man page, in the "docs" directory and at the Amanda    ###
-###  web page (www.amanda.org).                                          ###
-###                                                                      ###
-###  !!! WARNING !!!  !!! WARNING !!!  !!! WARNING !!!  !!! WARNING !!!  ###
+# amanda.conf - sample Amanda configuration file. See amanda.conf(5) for 
+# details
 
-#
-# amanda.conf - sample Amanda configuration file.  This started off life as
-#               the actual config file in use at CS.UMD.EDU.
-#
-# If your configuration is called, say, "csd", then this file normally goes
-# in @CONFIG_DIR@/csd/amanda.conf.
-#
-
-org "@DEFAULT_CONFIG@"         # your organization name for reports
-mailto "@CLIENT_LOGIN@"                # space separated list of operators at your site
+org     "@DEFAULT_CONFIG@"     # your organization name for reports
+mailto          "@CLIENT_LOGIN@"       # space separated list of operators at your site
 dumpuser "@CLIENT_LOGIN@"      # the user to run dumps under
 
 inparallel 4           # maximum dumpers that will run in parallel (max 63)
@@ -35,14 +20,15 @@ dumporder "sssS"    # specify the priority order of each dumper
 
 taperalgo first                # The algorithm used to choose which dump image to send
                        # to the taper.
-
-                       # Possible values: [first|firstfit|largest|largestfit|smallest|last]
+                       # Possible values: 
+                       # [first|firstfit|largest|largestfit|smallest|last]
                        # Default: first. 
-
                        # first         First in - first out.
-                       # firstfit      The first dump image that will fit on the current tape.
+                       # firstfit      The first dump image that will fit 
+                        #               on the current tape.
                        # largest       The largest dump image.
-                       # largestfit    The largest dump image that will fit on the current tape.
+                       # largestfit    The largest dump image that will fit 
+                        #               on the current tape.
                        # smallest      The smallest dump image.
                        # last          Last in - first out.
 
@@ -69,20 +55,20 @@ bumpdays 1          # minimum days at each level
 bumpmult 4             # threshold = bumpsize * bumpmult^(level-1)
 
 etimeout 300           # number of seconds per filesystem for estimates.
-#etimeout -600         # total number of seconds for estimates.
-# a positive number will be multiplied by the number of filesystems on
-# each host; a negative number will be taken as an absolute total time-out.
-# The default is 5 minutes per filesystem.
-
 dtimeout 1800          # number of idle seconds before a dump is aborted.
-
 ctimeout 30            # maximum number of seconds that amcheck waits
                        # for each client host
  
-tapebufs 20
-# A positive integer telling taper how many 32k buffers to allocate.
-# WARNING! If this is set too high, taper will not be able to allocate
-# the memory and will die.  The default is 20 (640k).
+tapebufs 20             # A positive integer telling taper how many 
+                        # 32k buffers to allocate.  The default is 20 (640k).
+
+# By default, Amanda can only track at most one run per calendar day. When
+# the usetimestamps option is enabled, however, Amanda can track as many
+# runs as you care to make.
+# WARNING: This option is not backward-compatible. Do not enable it if you
+#          intend to downgrade your server installation to Amanda community 
+#          edition 2.5
+usetimestamps yes
 
 
 # Specify tape device and/or tape changer.  If you don't have a tape
@@ -95,16 +81,15 @@ tapebufs 20
 # parameter.  Some rely on a configuration file (changerfile) to
 # obtain more information about tape devices, number of slots, etc;
 # others just need to store some data in files, whose names will start
-# with changerfile.  For more information about individual tape
-# changers, read docs/TAPE.CHANGERS.
+# with changerfile.  
 
 # At most one changerfile entry must be defined; select the most
 # appropriate one for your configuration.  If you select man-changer,
 # keep the first one; if you decide not to use a tape changer, you may
 # comment them all out.
 
-runtapes 1             # number of tapes to be used in a single run of amdump
-tpchanger "chg-manual" # the tape-changer glue script
+runtapes 1                     # number of tapes to be used in a single run of amdump
+tpchanger "chg-manual"         # the tape-changer glue script
 tapedev "@DEFAULT_TAPE_DEVICE@"        # the no-rewind tape device to be used
 rawtapedev "@DEFAULT_RAW_TAPE_DEVICE@" # the raw device to be used (ftape only)
 #changerfile "@CONFIG_DIR@/@DEFAULT_CONFIG@/changer"
@@ -148,9 +133,9 @@ amrecover_changer "@DEFAULT_TAPE_DEVICE@"   # amrecover will use the changer if yo
 holdingdisk hd1 {
     comment "main holding disk"
     directory "/dumps/amanda"  # where the holding disk is
-    use -100 Mb                # how much space can we use on it
-                       # a non-positive value means:
-                       #        use all space but that value
+    use -100 Mb                        # how much space can we use on it
+                               # a non-positive value means:
+                               # use all space but that value
     chunksize 1Gb      # size of chunk if you want big dump to be
                        # dumped on multiple files on holding disks
                        #  N Kb/Mb/Gb split images in chunks of size N
@@ -219,8 +204,8 @@ autoflush no #
 # you have selected some database format other than the `text' default)
 infofile "@CONFIG_DIR@/@DEFAULT_CONFIG@/curinfo"       # database DIRECTORY
 logdir   "@CONFIG_DIR@/@DEFAULT_CONFIG@"               # log directory
-indexdir "@CONFIG_DIR@/@DEFAULT_CONFIG@/index" # index directory
-#tapelist "@CONFIG_DIR/@DEFAULT_CONFIG@/tapelist"      # list of used tapes
+indexdir "@CONFIG_DIR@/@DEFAULT_CONFIG@/index"         # index directory
+#tapelist "@CONFIG_DIR@/@DEFAULT_CONFIG@/tapelist"     # list of used tapes
 # tapelist is stored, by default, in the directory that contains amanda.conf
 
 # tapetypes
@@ -375,7 +360,7 @@ define tapetype MIMSY-MEGATAPE {
 #                              it takes only a few seconds but the result is not 
 #                              accurate if your disk usage changes from day to day.
 #                Default: [client]
-#   encrypt     - specify encryption of the backed up data. Valid values are:
+#   encrypt  - specify encryption of the backed up data. Valid values are:
 #                "none"   - don't encrypt the dump output.
 #                "client" - encrypt on the client using the program specified by 
 #                            client_encrypt "PROG".
@@ -411,7 +396,10 @@ define tapetype MIMSY-MEGATAPE {
 #                going to be backed up.
 #                Default: include all files
 #   holdingdisk        - should the holding disk be used for this dump.  Useful for
-#                dumping the holding disk itself.  Default: [holdingdisk yes]
+#                dumping the holding disk itself.  Default: [holdingdisk auto]
+#                "never"    - Never use the holding disk.
+#                "auto"     - Use the holding disk if possible.
+#                "required" - Always use the holding disk.
 #   ignore     - do not back this filesystem up.  Useful for sharing a single
 #                disklist in several configurations.
 #   index      - keep an index of the files backed up.  Default: [index no]
@@ -429,8 +417,8 @@ define tapetype MIMSY-MEGATAPE {
 #                mode", as many incrementals as will fit on the holding disk
 #                are done, higher priority first, to insure the important
 #                disks are at least dumped.  Default: [priority medium]
-#   program    - specify the dump system to use.  Valid values are "DUMP" and
-#                "GNUTAR".  Default: [program "DUMP"].
+#   program    - specify the dump system to use.  Valid values are "DUMP",
+#                 or "GNUTAR".  Default: [program "DUMP"].
 #   record     - record the backup in the time-stamp-database of the backup
 #                program (e.g. /etc/dumpdates for DUMP or
 #                @GNUTAR_LISTED_INCREMENTAL_DIRX@ for GNUTAR.).
@@ -507,6 +495,7 @@ define dumptype always-full {
     dumpcycle 0
 }
 
+# Dumptypes for gnutar
 define dumptype root-tar {
     global
     program "GNUTAR"
@@ -555,7 +544,7 @@ define dumptype comp-user-tar-span {
 define dumptype holding-disk {
     global
     comment "The master-host holding disk itself"
-    holdingdisk no # do not use the holding disk
+    holdingdisk never # do not use the holding disk
     priority medium
 }
 
@@ -629,21 +618,46 @@ define dumptype comp-test {
 define dumptype custom-compress {
    global
    program "GNUTAR"
-   comment "test dump with custom client compression"
+   comment "custom client compression dumped with tar"
    compress client custom
    client_custom_compress "/usr/bin/bzip2"
 }
 
-define dumptype encrypt-fast {
+define dumptype server-encrypt-fast {
    global
    program "GNUTAR"
-   comment "test dump with fast client compression and server symmetric encryption"
+   comment "fast client compression and server symmetric encryption"
    compress client fast
    encrypt server
-   server_encrypt "/usr/local/sbin/amcrypt"
+   server_encrypt "/usr/sbin/amcrypt"
    server_decrypt_option "-d"
 }
 
+define dumptype client-encrypt-nocomp {
+   global
+   program "GNUTAR"
+   comment "no compression and client symmetric encryption"
+   compress none
+   encrypt client
+   client_encrypt "/usr/sbin/amcrypt"
+   client_decrypt_option "-d"
+}
+
+
+# To use gpg public-key encryption, gpg does compress with zlib by default.
+# Thus, no need to specify compress
+
+#define dumptype gpg-encrypt {
+#    global
+#    program "GNUTAR"
+#    comment "server public-key encryption, dumped with tar"
+#    compress none
+#    encrypt server
+#    server_encrypt "/usr/sbin/amgpgcrypt"
+#    server_decrypt_option "-d"
+#}
+
+
 # network interfaces
 #
 # These are referred to by the disklist file.  They define the attributes