ZARAFA-ARCHIVER.CFG(5)                                  ZARAFA-ARCHIVER.CFG(5)



NAME
       zarafa-archiver.cfg - The Zarafa archiver configuration file

SYNOPSIS
       archiver.cfg


DESCRIPTION




       The archiver.cfg is a configuration file for the Zarafa Archiver.
       archiver.cfg contains instructions for the software to set up the
       logging system and specific actions the archiver can do.



FILE FORMAT




       The file consists of one big section, but parameters can be grouped by
       functionality.




       The parameters are written in the form:




       name = value



       The file is line-based. Each newline-terminated line represents either
       a comment, nothing, a parameter or a directive. A line beginning with
       `#' is considered a comment, and will be ignored by Zarafa. Parameter
       names are case sensitive. Lines beginning with `!' are directives.



       Directives are written in the form:



       !directive  [argument(s)]



       The following directives exist:



       include
              Include and process argument

              Example: !include common.cfg



EXPLANATION OF EACH PARAMETER




       server_socket
              Unix socket to find the connection to the Zarafa server.

              Default: file:///var/run/zarafa


       sslkey_file
              Use this file as key to logon to the server. This is only used
              when server_socket is set to an HTTPS transport. See the
              zarafa-server(1) manual page on how to setup SSL keys.

              Default: value not set.


       sslkey_pass
              The password of the SSL key file that is set in sslkey_file.

              Default: value not set.


       archive_enable
              Specifies if the archive step will be performed. The archive
              step is basically the copy to the archive.

              Default: yes


       archive_after
              Specifies the age in days of a message before it will be
              archived.

              Default: 30


       stub_enable
              Specifies if the stub step will be performed. Stubbing is the
              process of removing the data from a message and only leaving a
              reference to one or more archived versions of that message. When
              such a message is opened it will be de-stubbed on the fly,
              leaving the user with a normal message to work with.

              A message will never be stubbed if it's not yet archived.

              Default: no


       stub_unread
              Specifies if unread messages will be stubbed.

              Default: no


       stub_after
              Specifies the age in days of a message before it will be
              stubbed.

              Default: 0


       delete_enable
              Specifies if the delete step will be performed. The delete step
              deletes messages from the users store if they're old enough.
              This way even more space is freed.

              A message will never be deleted if it's not yet archived.

              A message will never be deleted from the archive.

              Default: no


       delete_unread
              Specifies if unread messages will be deleted.

              Default: no


       delete_after
              Specifies the age in days of a message before it will be
              deleted.

              Default: 0


       purge_enable
              Specifies if message will be purged from the archive after a
              certain amount of time.

              Default: no


       purge_after
              Specifies the age in days of a message before it will be purged.
              *Note that the age is measured from the time it was originally
              delivered in the primay store.

              Default: 0


       track_history
              Specifies the behaviour of the archiver when re-archiving
              messages that were changed after they were archived. When
              track_history is set to no, the archived version will be updated
              to contain the most actual information. When track_history is
              set to yes, a new copy of the message will be created in the
              archive, and the previous version is linked to it. This way the
              change history can be tracked.

              Default: no


       log_method
              The method which should be used for logging. Valid values are:




              syslog Use the Linux system log. All messages will be written to
                     the mail facility. See also syslog.conf(5).


              file   Log to a file. The filename will be specified in
                     log_file.


              Default: file


       log_file
              When logging to a file, specify the filename in this parameter.
              Use - (minus sign) for stderr output.

              Default: -


       log_timestamp
              Specify whether to prefix each log line with a timestamp in
              'file' logging mode.

              Default: 1


       log_level
              The level of output for logging in the range from 0 to 5. 0
              means no logging, 5 means full logging.

              Default: 2



FILES




       /etc/zarafa/archiver.cfg
              The Zarafa archiver configuration file.



AUTHOR


       Written by Zarafa.



SEE ALSO


        zarafa-archiver(1)





                                                        ZARAFA-ARCHIVER.CFG(5)
