zarafa-archiver.cfg(5)

1ZARAFA-ARCHIVER.C(5)         Zarafa user reference        ZARAFA-ARCHIVER.C(5)
2
3
4

NAME

6       zarafa-archiver.cfg - The Zarafa archiver configuration file
7

SYNOPSIS

9       archiver.cfg
10

DESCRIPTION

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

FILE FORMAT

17       The file consists of one big section, but parameters can be grouped by
18       functionality.
19
20       The parameters are written in the form:
21
22       name = value
23
24       The file is line-based. Each newline-terminated line represents either
25       a comment, nothing, a parameter or a directive. A line beginning with
26       `#´ is considered a comment, and will be ignored by Zarafa. Parameter
27       names are case sensitive. Lines beginning with `!´ are directives.
28
29       Directives are written in the form:
30
31       !directive [argument(s)]
32
33       The following directives exist:
34
35       include
36           Include and process argument
37
38           Example: !include common.cfg
39

EXPLANATION OF EACH PARAMETER

41       server_socket
42           Unix socket to find the connection to the Zarafa server.
43
44           Default: file:///var/run/zarafa
45
46       sslkey_file
47           Use this file as key to logon to the server. This is only used when
48           server_socket is set to an HTTPS transport. See the zarafa-
49           server(1) manual page on how to setup SSL keys.
50
51           Default: value not set.
52
53       sslkey_pass
54           The password of the SSL key file that is set in sslkey_file.
55
56           Default: value not set.
57
58       archive_enable
59           Specifies if the archive step will be performed. The archive step
60           is basically the copy to the archive.
61
62           Default: yes
63
64       archive_after
65           Specifies the age in days of a message before it will be archived.
66
67           Default: 30
68
69       stub_enable
70           Specifies if the stub step will be performed. Stubbing is the
71           process of removing the data from a message and only leaving a
72           reference to one or more archived versions of that message. When
73           such a message is opened it will be de-stubbed on the fly, leaving
74           the user with a normal message to work with.
75
76           A message will never be stubbed if it´s not yet archived.
77
78           Default: no
79
80       stub_unread
81           Specifies if unread messages will be stubbed.
82
83           Default: no
84
85       stub_after
86           Specifies the age in days of a message before it will be stubbed.
87
88           Default: 0
89
90       delete_enable
91           Specifies if the delete step will be performed. The delete step
92           deletes messages from the users store if they´re old enough. This
93           way even more space is freed.
94
95           A message will never be deleted if it´s not yet archived.
96
97           A message will never be deleted from the archive.
98
99           Default: no
100
101       delete_unread
102           Specifies if unread messages will be deleted.
103
104           Default: no
105
106       delete_after
107           Specifies the age in days of a message before it will be deleted.
108
109           Default: 0
110
111       purge_enable
112           Specifies if message will be purged from the archive after a
113           certain amount of time.
114
115           Default: no
116
117       purge_after
118           Specifies the age in days of a message before it will be purged.
119           *Note that the age is measured from the time it was originally
120           delivered in the primay store.
121
122           Default: 0
123
124       track_history
125           Specifies the behaviour of the archiver when re-archiving messages
126           that were changed after they were archived. When track_history is
127           set to no, the archived version will be updated to contain the most
128           actual information. When track_history is set to yes, a new copy of
129           the message will be created in the archive, and the previous
130           version is linked to it. This way the change history can be
131           tracked.
132
133           Default: no
134
135       cleanup_action
136           Specify what action should be taken on archive messages whose
137           primary message has been deleted. The options are ´store´ and
138           ´delete´, meaning store the archived message in a special ´Deleted´
139           folder or delete the archived messages respectively.
140
141           Default: store
142
143       log_method
144           The method which should be used for logging. Valid values are:
145
146           syslog
147               Use the Linux system log. All messages will be written to the
148               mail facility. See also syslog.conf(5).
149
150           file
151               Log to a file. The filename will be specified in log_file.
152
153           Default: file
154
155       log_file
156           When logging to a file, specify the filename in this parameter. Use
157           - (minus sign) for stderr output.
158
159           Default: -
160
161       log_timestamp
162           Specify whether to prefix each log line with a timestamp in ´file´
163           logging mode.
164
165           Default: 1
166
167       log_level
168           The level of output for logging in the range from 0 to 5. 0 means
169           no logging, 5 means full logging.
170
171           Default: 2
172

FILES

174       /etc/zarafa/archiver.cfg
175           The Zarafa archiver configuration file.
176

AUTHOR

178       Written by Zarafa.
179