zarafa-gateway.cfg(5)

1ZARAFA-GATEWAY.CF(5)         Zarafa user reference        ZARAFA-GATEWAY.CF(5)
2
3
4

NAME

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

SYNOPSIS

9       gateway.cfg
10

DESCRIPTION

12       The gateway.cfg is a configuration file for the Zarafa Gateway.
13       gateway.cfg contains instructions for the software to set up the
14       logging system and to enable or disable the POP3, POP3S, IMAP or IMAPS
15       part of the service.
16

FILE FORMAT

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

EXPLANATION OF EACH PARAMETER

42       server_bind
43           IP address to bind to. 0.0.0.0 for any address.
44
45           Default: 0.0.0.0
46
47       server_hostname
48           Hostname of the server to print to a client in the logon greeting.
49           Leave empty to use DNS to find the hostname.
50
51           Default:
52
53       server_hostname_greeting
54           Whether to show the hostname in the logon greeting to clients. This
55           config option is reloadable using the HUP signal.
56
57           Default: no
58
59       pop3_enable
60           Enable POP3 service with value yes. All other values disable the
61           service.
62
63           Default: yes
64
65       pop3_port
66           The POP3 service will listen on this port for incoming connections.
67
68           Default: 110
69
70       pop3s_enable
71           Enable POP3S service with value yes. All other values disable the
72           service.
73
74           Default: yes
75
76       pop3s_port
77           The POP3S service will listen on this port for incoming
78           connections.
79
80           Default: 995
81
82       imap_enable
83           Enable IMAP service with value yes. All other values disable the
84           service.
85
86           Default: yes
87
88       imap_port
89           The IMAP service will listen on this port for incoming connections.
90
91           Default: 143
92
93       imaps_enable
94           Enable IMAPS service with value yes. All other values disable the
95           service.
96
97           Default: yes
98
99       imaps_port
100           The IMAPS service will listen on this port for incoming
101           connections.
102
103           Default: 993
104
105       server_socket
106           The http address of the Zarafa server.
107
108           Default: http://localhost:236/zarafa
109
110           It is not advised to specify the UNIX socket here, but the http
111           address instead. In default configuration the gateway will then be
112           trusted by the Zarafa server (as set in its local_admin_users
113           configuration setting). Unless is run as an untrusted user, by
114           specifying the run_as_user, the gateway always authenticates users
115           even if they provide no or wrong credentials!
116
117       run_as_user
118           After correctly starting, the gateway process will become this
119           user, dropping root privileges. Note that the log file needs to be
120           writeable by this user, and the directory too to create new
121           logfiles after logrotation. This can also be achieved by setting
122           the correct group and permissions.
123
124           Default value is empty, not changing the user after starting.
125
126       run_as_group
127           After correctly starting, the gateway process will become this
128           group, dropping root privileges.
129
130           Default value is empty, not changing the group after starting.
131
132       pid_file
133           Write the process ID number to this file. This is used by the
134           init.d script to correctly stop/restart the service.
135
136           Default: /var/run/zarafa-gateway.pid
137
138       running_path
139           Change directory to this path when running in daemonize mode. When
140           using the -F switch to run in the foreground the directory will not
141           be changed.
142
143           Default: /
144
145       process_model
146           You can change the process model between fork and thread. The
147           forked model uses somewhat more resources, but if a crash is
148           triggered, this will only affect one user. In the threaded model, a
149           crash means all users are affected, and will not be able to use the
150           service.
151
152           Default: fork
153
154       imap_only_mailfolders
155           Enable the IMAP and IMAPS service to only show the mailfolders.
156           This is the default behaviour. When this option is set to ´no´, you
157           will also be able to select you calendar and contacts and such.
158           These views will not contain all information, since these items
159           cannot be converted to a rfc-822 mail item.
160
161           Default: yes
162
163       imap_public_folders
164           Enable the IMAP and IMAPS service to also show the public store
165           with subfolders. This is the default behaviour. When this option is
166           set to ´no´, IMAP clients will only see the users´ folder.
167
168           Default: yes
169
170       imap_capability_idle
171           Allow IMAP clients to issue the IDLE command. When an IMAP client
172           is idle, it may receive notifications from the server about changes
173           of the selected folder. This may increase load on the server when
174           many users are using the IMAP service.
175
176           Default: yes
177
178       imap_generate_utf8
179           Normally e-mails specify the correct charset for their contents.
180           This may be altered to make it always UTF-8. This will only happen
181           on e-mails that do not have the extra imap data properties, which
182           is true for users without the ´imap´ feature enabled.
183
184           Default: no
185
186       imap_max_messagesize
187           Limit the maximum message size (in bytes) which can be created by
188           an IMAP client. The maximum of this value is 4GB although this is
189           not recommended. If the value is too high it will cause a
190           segmentation fault.
191
192           Default: 134217728
193
194       imap_expunge_on_delete
195           Normally when you delete an e-mail in an IMAP client, it will only
196           be marked as deleted, and not removed from the folder. The client
197           should send the EXPUNGE command to actually remove the item from
198           the folder (where Zarafa will place it in the soft-delete system).
199           When this option is set to yes, the zarafa-gateway will issue the
200           expunge command itself directly after a ´mark as delete´ command
201           was received.
202
203           Default: no
204
205       imap_store_rfc822
206           Store the rfc822 data with the message in MAPI. The Zarafa Gateway
207           stores the original rfc822 data of an APPENDed message in the
208           database for later retrieval. This makes sure that the exact
209           message that was delivered into the Zarafa gateway is available for
210           retrieval later, which is the behaviour when set to yes. If set to
211           no, the zarafa-gateway will not store the original rfc822 text.
212           This means that the rfc822 data must be re-created when retrieved.
213           This may cause changes in encoding or charset and some loss of
214           fidelity. This will also invalidate any signatures in the stored
215           messages.
216
217           Default: yes
218
219       ssl_private_key_file
220           The gateway will use this file as private key for SSL TLS. This
221           file can be created with: openssl genrsa -out
222           /etc/zarafa/gateway/privkey.pem 2048.
223
224           Default: /etc/zarafa/gateway/privkey.pem
225
226       ssl_certificate_file
227           The gateway will use this file as certificate for SSL TLS. A
228           self-signed certificate can be created with: openssl req -new -x509
229           -key /etc/zarafa/gateway/privkey.pem -out
230           /etc/zarafa/gateway/cert.pem -days 1095.
231
232           Default: /etc/zarafa/gateway/cert.pem
233
234       ssl_verify_client
235           Enable client certificate verification with value yes. All other
236           values disable the verification.
237
238           Default: no
239
240       ssl_verify_file
241           The file to verify the clients certificates with.
242
243           Default: value not set.
244
245       ssl_verify_path
246           The path with the files to verify the clients certificates with.
247
248           Default: value not set.
249
250       log_method
251           The method which should be used for logging. Valid values are:
252
253           syslog
254               Use the Linux system log. All messages will be written to the
255               mail facility. See also syslog.conf(5).
256
257           file
258               Log to a file. The filename will be specified in log_file.
259
260           Default: file
261
262       log_file
263           When logging to a file, specify the filename in this parameter. Use
264           - (minus sign) for stderr output.
265
266           Default: -
267
268       log_level
269           The level of output for logging in the range from 0 to 5. 0=no
270           logging, 5=full logging.
271
272           Default: 2
273
274       log_timestamp
275           Specify whether to prefix each log line with a timestamp in ´file´
276           logging mode.
277
278           Default: 1
279

RELOADING

281       The following options are reloadable by sending the zarafa-gateway
282       process a HUP signal:
283
284       log_level
285

FILES

287       /etc/zarafa/gateway.cfg
288           The Zarafa gateway configuration file.
289

AUTHOR

291       Written by Zarafa.
292