1ZARAFA-DAGENT.CFG(5) Zarafa user reference ZARAFA-DAGENT.CFG(5)
2
6 zarafa-dagent.cfg - The Zarafa dagent configuration file
7
9 dagent.cfg
10
12 The dagent.cfg is a configuration file for the Zarafa Dagent.
13 dagent.cfg contains instructions for the software to set up the logging
14 system and LMTP settings.
15
17 The file consists of one big section, but parameters can be grouped by
18 functionality.
19 The parameters are written in the form:
21 name = value
23 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 Directives are written in the form:
30 !directive [argument(s)]
32 The following directives exist:
34 include
36 Include and process argument
37 Example: !include common.cfg
39
41 server_bind
42 IP address to bind to. 0.0.0.0 for any address.
43 Default: 0.0.0.0
45 server_socket
47 Unix socket to find the connection to the Zarafa server.
48 Default: file:///var/run/zarafa
50 run_as_user
52 After correctly starting, the dagent process will become this user,
53 dropping root privileges. Note that the log file needs to be
54 writeable by this user, and the directory too to create new
55 logfiles after logrotation. This can also be achieved by setting
56 the correct group and permissions.
57 Default value is empty, not changing the user after starting.
59 run_as_group
61 After correctly starting, the dagent process will become this
62 group, dropping root privileges.
63 Default value is empty, not changing the group after starting.
65 pid_file
67 Write the process ID number to this file. This is used by the
68 init.d script to correctly stop/restart the service.
69 Default: /var/run/zarafa-dagent.pid
71 sslkey_file
73 Use this file as key to logon to the server. This is only used when
74 server_socket is set to an HTTPS transport. See the zarafa-
75 server(1) manual page on how to setup SSL keys.
76 Default: value not set.
78 sslkey_pass
80 The password of the SSL key file that is set in sslkey_file.
81 Default: value not set.
83 process_model
85 You can change the process model between fork and thread. The
86 forked model uses somewhat more resources, but if a crash is
87 triggered, this will only affect one user. In the threaded model, a
88 crash means all users are affected, and will not be able to use the
89 service.
90 Default: fork
92 lmtp_port
94 Port to listen to for LMTP requests
95 Default: 2003
97 lmtp_max_threads
99 The maximum number of LMTP threads that can be running
100 simultaneously. This is also limited by your SMTP server. (20 is
101 the postfix default concurrency limit)
102 Default: 20
104 spam_header_name
106 To detect if the receiving mail is spam, the DAgent can check this
107 header for a value that is in there. This name is case insensitive.
108 If this option is empty, the detection method will be turned off.
109 You can also force a delivery to the Junk Mail folder using the -j
110 commandline option.
111 Default: X-Spam-Status
113 spam_header_value
115 When this value is found in the spam_header_name, the mail will be
116 considered spam, and will be delivered in the user´s Junk Mail
117 folder. The value can be anywhere in the header, not just the
118 start. The value is case insensitive.
119 Default: Yes,
121 log_method
123 The method which should be used for logging. Valid values are:
124 syslog
126 Use the Linux system log. All messages will be written to the
127 mail facility. See also syslog.conf(5).
128 file
130 Log to a file. The filename will be specified in log_file.
131 Default: file
133 log_file
135 When logging to a file, specify the filename in this parameter. Use
136 - (minus sign) for stderr output.
137 Default: -
139 log_timestamp
141 Specify whether to prefix each log line with a timestamp in ´file´
142 logging mode.
143 Default: 1
145 log_level
147 The level of output for logging in the range from 0 to 5. 0 means
148 no logging, 5 means full logging.
149 Default: 2
151 log_raw_message
153 Log the raw message to a file. The file is saved to the location
154 specifed in log_raw_message_path.
155 Default: no
157 log_raw_message_path
159 Path to save the raw message.
160 Default: /tmp
162 archive_on_delivery
164 Archive incoming message on delivery. If an archive is attached to
165 the target mailbox, the message will immediately be archived upon
166 delivery.
167 Rules will be processed before the message is archived, so when a
169 rule moves the message to an alternate location, the archived
170 message will be placed in the correct location in the archive. When
171 the incoming message is copied by a rule, only the original message
172 is archived.
173 Default: no
175 mr_autoaccepter
177 Zarafa-dagent can auto-accept meeting requests if the mr-accept
178 option is enabled for a user. When this option is enabled and a
179 meeting request or meeting cancellation is received, this script is
180 started with the following parameters: /usr/bin/zarafa-mr-accept
181 <username> </path/to/dagent.cfg> [<ENTRYID>].
182 If the script is successful (exitcode is 0), then no other actions
184 are performed (eg rules or vacation messages) and the message is
185 not delivered in the inbox. If the script exits with a non-zero
186 exit code, rules and vacation messages are run as usual, and the
187 message is delivered in the inbox (or other folder, depending on
188 rules or options).
189 Default: /usr/bin/zarafa-mr-accept
191
193 The following options are reloadable by sending the zarafa-dagent
194 process a HUP signal:
195 log_level
197 archive_on_delivery
199 mr_autoaccepter
201
203 /etc/zarafa/dagent.cfg
204 The Zarafa dagent configuration file.
205
207 Written by Zarafa.
208
210 zarafa-dagent(1)
211Zarafa 7.0 August 2011 ZARAFA-DAGENT.CFG(5)