1ZARAFA-ICAL.CFG(5) Zarafa user reference ZARAFA-ICAL.CFG(5)
2
6 zarafa-ical.cfg - The Zarafa iCal/CalDAV gateway configuration file
7
9 ical.cfg
10
12 The ical.cfg is a configuration file for the Zarafa iCal/CalDAV
13 Gateway. ical.cfg contains instructions for the software to set up the
14 logging system and to enable or disable the normal or SSL part of the
15 service.
16
18 The file consists of one big section, but parameters can be grouped by
19 functionality.
20 The parameters are written in the form:
22 name = value
24 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 Directives are written in the form:
31 !directive [argument(s)]
33 The following directives exist:
35 include
37 Include and process argument
38 Example: !include common.cfg
40
42 server_bind
43 IP address to bind to. 0.0.0.0 for any address.
44 Default: 0.0.0.0
46 ical_enable
48 Enable iCal/CalDAV service with value yes. All other values disable
49 the service.
50 Default: yes
52 ical_port
54 The iCal/CalDAV service will listen on this port for incoming
55 connections.
56 Default: 8080
58 icals_enable
60 Enable SSL iCal/CalDAV service with value yes. All other values
61 disable the service.
62 Default: yes
64 icals_port
66 The SSL iCal/CalDAV service will listen on this port for incoming
67 connections.
68 Default: 8443
70 server_socket
72 The http address of the Zarafa server.
73 Default: http://localhost:236/zarafa
75 It is not advised to specify the UNIX socket here, but the http
77 address instead. In default configuration the gateway will then be
78 trusted by the Zarafa server (as set in its local_admin_users
79 configuration setting). Unless is run as an untrusted user, by
80 specifying the run_as_user, the gateway always authenticates users
81 even if they provide no or wrong credentials!
82 run_as_user
84 After correctly starting, the iCal/CalDAV gateway process will
85 become this user, dropping root privileges. Note that the log file
86 needs to be writeable by this user, and the directory too to create
87 new logfiles after logrotation. This can also be achieved by
88 setting the correct group and permissions.
89 Default value is empty, not changing the user after starting.
91 run_as_group
93 After correctly starting, the iCal/CalDAV gateway process will
94 become this group, dropping root privileges.
95 Default value is empty, not changing the group after starting.
97 pid_file
99 Write the process ID number to this file. This is used by the
100 init.d script to correctly stop/restart the service.
101 Default: /var/run/zarafa-ical.pid
103 running_path
105 Change directory to this path when running in daemonize mode. When
106 using the -F switch to run in the foreground the directory will not
107 be changed.
108 Default: /
110 process_model
112 You can change the process model between fork and thread. The
113 forked model uses somewhat more resources, but if a crash is
114 triggered, this will only affect one user. In the threaded model, a
115 crash means all users are affected, and will not be able to use the
116 service.
117 Default: fork
119 ssl_private_key_file
121 The iCal/CalDAV gateway will use this file as private key for SSL
122 TLS. This file can be created with: openssl genrsa -out
123 /etc/zarafa/ical/privkey.pem 2048.
124 Default: /etc/zarafa/ical/privkey.pem
126 ssl_certificate_file
128 The iCal/CalDAV gateway will use this file as certificate for SSL
129 TLS. A self-signed certificate can be created with: openssl req
130 -new -x509 -key /etc/zarafa/ical/privkey.pem -out
131 /etc/zarafa/ical/cert.pem -days 1095.
132 Default: /etc/zarafa/ical/cert.pem
134 ssl_verify_client
136 Enable client certificate verification with value yes. All other
137 values disable the verification.
138 Default: no
140 ssl_verify_file
142 The file to verify the clients certificates with.
143 Default: value not set.
145 ssl_verify_path
147 The path with the files to verify the clients certificates with.
148 Default: value not set.
150 log_method
152 The method which should be used for logging. Valid values are:
153 syslog
155 Use the Linux system log. All messages will be written to the
156 mail facility. See also syslog.conf(5).
157 file
159 Log to a file. The filename will be specified in log_file.
160 Default: file
162 log_file
164 When logging to a file, specify the filename in this parameter. Use
165 - (minus sign) for stderr output.
166 Default: -
168 log_level
170 The level of output for logging in the range from 0 to 5. 0=no
171 logging, 5=full logging.
172 Default: 2
174 log_timestamp
176 Specify whether to prefix each log line with a timestamp in ´file´
177 logging mode.
178 Default: 1
180 enable_ical_get
182 Enable the ical GET method to download an entire calendar. When set
183 to ´yes´, the GET method is enabled and allowed. If not, then
184 calendars can only be retrieved with the CalDAV PROPFIND method,
185 which is much more efficient. This option allows you to force the
186 use of CalDAV which lowers load on your server.
187
189 The following options are reloadable by sending the zarafa-ical process
190 a HUP signal:
191 log_level
193
195 /etc/zarafa/ical.cfg
196 The Zarafa iCal/CalDAV gateway configuration file.
197
199 Written by Zarafa.
200
202 zarafa-ical(1)
203Zarafa 7.0 August 2011 ZARAFA-ICAL.CFG(5)