1ZARAFA-INDEXER.CF(5) Zarafa user reference ZARAFA-INDEXER.CF(5)
2
6 zarafa-indexer.cfg - The Zarafa Indexer configuration file
7
9 indexer.cfg
10
12 The indexer.cfg is a configuration file for the Zarafa Indexer Service.
13 indexer.cfg contains instructions for the software to set up the
14 connection, indexing and logging systems.
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_socket
42 Socket to find the connection to the Zarafa server.
43 Default: file:///var/run/zarafa
45 run_as_user
47 After correctly starting, the server process will become this user,
48 dropping root privileges. Note that the log file needs to be
49 writeable by this user, and the directory too to create new
50 logfiles after logrotation. This can also be achieved by setting
51 the correct group and permissions.
52 Default value is empty, not changing the user after starting.
54 run_as_group
56 After correctly starting, the server process will become this
57 group, dropping root privileges.
58 Default value is empty, not changing the group after starting.
60 pid_file
62 Write the process ID number to this file. This is used by the
63 init.d script to correctly stop/restart the service.
64 Default: /var/run/zarafa-indexer.pid
66 running_path
68 Change directory to this path when running in daemonize mode. When
69 using the -F switch to run in the foreground the directory will not
70 be changed.
71 Default: /
73 cleanup_lockfiles
75 If for some unfortunate reason the zarafa-indexer is not cleanly
76 stopped, it may leave lockfiles behind on stores it was processing.
77 To continue the indexing on this possibly corrupt index, you need
78 to remove the lockfile. To restart the index of the store, you need
79 to remove the complete index directory. This directory will be
80 mentioned in the log. You may choose to automatically remove the
81 lockfiles by setting this option to yes. The index will be left on
82 disk.
83 Default: no
85 limit_results
87 Limit the number of results returned to the server. If set to a
88 nonzero value, only the N most relevant results will be returned to
89 the server. This in turn limits the number of results that the user
90 will see. If the limit is set to 0, all results will be returned.
91 Default:0
93
95 ssl_key_file
96 The file containing the private key and certificate. Please read
97 the SSL section in the zarafa-server(1) manual on how to create
98 this file.
99 Default: /etc/zarafa/ssl/indexer.pem
101 ssl_key_pass
103 Enter you password here when your key file contains a password to
104 be readable.
105 No default set.
107 ssl_private_key_file
109 The indexer will use this file as private key for SSL TLS. This
110 file can be created with: openssl genrsa -out
111 /etc/zarafa/indexer/privkey.pem 2048.
112 Default: /etc/zarafa/indexer/privkey.pem
114 ssl_certificate_file
116 The indexer will use this file as certificate for SSL TLS. A
117 self-signed certificate can be created with: openssl req -new -x509
118 -key /etc/zarafa/indexer/privkey.pem -out
119 /etc/zarafa/indexer/cert.pem -days 1095.
120 Default: /etc/zarafa/indexer/cert.pem
122
124 log_method
125 The method which should be used for logging. Valid values are:
126 syslog
128 Use the Linux system log. All messages will be written to the
129 mail facility. See also syslog.conf(5).
130 file
132 Log to a file. The filename will be specified in log_file.
133 Default: file
135 log_file
137 When logging to a file, specify the filename in this parameter. Use
138 - (minus sign) for stderr output.
139 Default: -
141 log_level
143 The level of output for logging in the range from 0 to 5. 0 means
144 no logging, 5 means full logging.
145 Default: 2
147 log_timestamp
149 Specify whether to prefix each log line with a timestamp in ´file´
150 logging mode.
151 Default: 1
153
155 server_bind_name
156 Connection path to which other processes can connect with the
157 zarafa-indexer for performing search queries.
158 Use http://0.0.0.0:port to listen as an HTTP service on all network
160 interfaces on the given port number.
161 Default: file:///var/run/zarafa-indexer
163 index_path
165 Base directory under which all index files will be placed, the
166 hierarchy below this folder will be:
167 ${index_path}/${server}/${user}/index
168 Default: /var/lib/zarafa/index/
170 index_sync_stream
172 Enable streaming synchronization. This can increase synchronization
173 speed depending on the setup. During streaming synchronization all
174 messages which will be synchronized will be downloaded in a single
175 call requiring more overall memory. When index_attachments is
176 disabled streaming will cause overhead because all attachments will
177 be downloaded to the client even though they will not be indexed.
178 This option requires enable_enhanced_ics to be enabled in the
180 zarafa-server.cfg(5), otherwise the indexing will still fallback to
181 the slower synchronization.
182 Default: yes
184 index_interval
186 Interval (in minutes) for indexing. During every interval the
187 zarafa-indexer will synchronize with the zarafa-server to collect
188 all changes for each store and update the index files for the
189 stores accordingly.
190 Default: 5 minutes
192 index_threads
194 Maximum number if indexing threads. In a multi-server environment
195 it is possible to distribute the work for different zarafa-servers
196 over different indexing threads. Note that the work for a single
197 server will be exclusively assigned to a single thread, thus the
198 number of started indexing threads will never exceed the number of
199 zarafa-servers.
200 Default: 1
202 index_max_field_length
204 Maximum number of words from a single message to index. Only the
205 first index_max_field_length from a single message will be indexed,
206 all words above this value will be discarded.
207 This value is used to control the amount of required memory during
209 the indexing process. More memory will be required during indexing
210 when index_max_field_length is set to a higher value.
211 Default: 10000
213 index_merge_factor
215 Number of index file segments per store before Lucene merges the
216 segments into a single file.
217 A low value will cause less memory to be used during indexing, but
219 the increased IO access to disk causes the indexing process to be
220 slower, while searching will be faster. A high value will speed up
221 the indexing process while searching will be slower
222 Batch indexing
224 If index_interval is set to a high value, set
225 index_merge_factor to a high value (> 10).
226 Interactive indexing
228 If index_interval is set to a low value, set index_merge_factor
229 to a low value (< 10).
230 Default: 10
232 index_max_buffered_docs
234 Max number of documents kept in memory before CLucene will write a
235 new index file segment to disk.
236 Larger values will increase memory usage but makes the indexing
238 process faster.
239 Default: 10
241 index_min_merge_docs
243 Minumum number of messages in a single store which are indexed in
244 memory before the index writer flushes the index to disk as new
245 index file segment.
246 Creating new index file segments often increases IO access to disk
248 but reduces the amount of memory required during the indexing
249 process.
250 Default: 10
252 index_max_merge_docs
254 Maximum number of documents in a index file segment, when an index
255 file segment contains index_max_merge_docs documents it will no
256 longer be merged with other index file segments.
257 This will limit the total size of an index file segment but will
259 trigger more index file segments to be created.
260 Batch indexing
262 If index_interval is set to a high value, set
263 index_max_merge_docs to a high value (> 10000).
264 Interactive indexing
266 If index_interval is set to a low value, set
267 index_max_merge_docs to a low value (< 10000).
268 Default: 2147483647 (INT32_MAX)
270 index_term_interval
272 The fraction of terms in the "dictionary" which should be stored in
273 memory. Smaller values use more memory, but make searching slightly
274 faster, while larger values use less memory and make searching
275 slightly slower. Searching is typically not dominated by dictionary
276 lookup, so tweaking this is rarely useful.
277 Default: 128
279 index_cache_timeout
281 Timeout value (in seconds) for purging all caches used during the
282 indexing process. If set to 0 caching will be disabled.
283 Default: 0
285
287 index_attachments
288 Enable indexing of attachments. When attachments are being indexed,
289 searching for keywords in the body of a message will automatically
290 cause the attachment to be searched as well.
291 This will slow down the indexing process, require more system
293 memory and increases index file size.
294 Default: yes
296 index_attachment_max_size
298 Maxiumum file size for attachments to be indexed. Any attachment
299 larger then this amount (in kilobytes) will not be indexed.
300 Default: 5120
302 index_attachment_parser
304 For indexing attachment each file must be converted into plain-text
305 by a parser. For this purpose the attachments_parser script has
306 been installed which can be configured to parse specific
307 mime-types.
308 It is highly advisable to check the attachments_parser.db file to
310 add or remove parser command for specific mime-types and/or
311 file-extensions.
312 Default: /etc/zarafa/indexerscripts/attachments_parser
314 index_attachment_parser_max_memory
316 Limit the maximum amount of memory (in bytes) the parser may use
317 for converting the attachment into plain-text. If this limit is
318 exceeded the parser will be killed and the attachment will not be
319 completely converted. If the value is set to 0 the limit is
320 considered as infinite.
321 The attachment parser depends on external tools to convert
323 attachments to plain-text, by limiting the amount of resources the
324 parser is allowed to use problems can be prevented when the
325 selected external tool misbehaves with certain attachments.
326 Default: 0 bytes
328 index_attachment_parser_max_cputime
330 Limit the maximum cpu time (in seconds) the parser may use for
331 converting the attachment into plain-text. If this limit is
332 exceeded the parser will be killed and the attachment will not be
333 completely converted. If the value is set to 0 the limit is
334 considered as infinite.
335 The attachment parser depends on external tools to convert
337 attachments to plain-text, by limiting the amount of resources the
338 parser is allowed to use problems can be prevented when the
339 selected external tool misbehaves with certain attachments.
340 Default: 0 seconds
342 index_attachment_mime_filter
344 Some attachments are not intresting to run through the parser. With
345 this option you can filter out attachment which have a specific
346 mimetype. Only the first part of the mimetype should be given here.
347 Good examples of a mimetype to filter is ´image´, ´audio´ and
348 ´video´. This field is space separated.
349 Default:
351 index_attachment_extension_filter
353 As the mime filter above, but works on the attachment extension.
354 This is only tested if the mimetype of an attachment was unknown.
355 Good examples of an extension to filter is ´gif´, ´jpeg´, ´jpg´ and
356 ´png´. This field is space separated.
357 Default:
359 index_max_clauses
361 This is the maximum number of clauses that can be present in a
362 Lucene search query, after expansion. You can raise this limit if
363 you are experiencing a Too Many Clauses error during searches.
364 Default: 50000 clauses
366
368 index_block_users
369 A list of usernames which should not be indexed by the indexing
370 service. Fields in the list are seperated by a SPACE.
371 Default: empty
373 index_block_companies
375 A list of tentants which should not be indexed by the indexing
376 service. All users and the public store belonging to these tentants
377 will not be indexed. Fields in the list are seperated by a SPACE.
378 Default: empty
380 index_allow_servers
382 A list of server names which should be indexed by the indexing
383 service. All stores located on these servers will be indexed, all
384 other servers will be ignored. If kept empty, no filtering is
385 applied and all detected servers are indexed. Fields in the list
386 are seperated by a SPACE.
387 Default: empty
389
391 The following options are reloadable by sending the zarafa-indexer
392 process a HUP signal:
393 log_level
395 index_threads
397 index_max_field_length
399 index_merge_factor
401 index_max_buffered_docs
403 index_min_merge_docs
405 index_max_merge_docs
407 index_term_interval
409 index_attachments
411 index_attachment_max_size
413 index_attachment_parser
415 index_attachment_parser_max_memory
417 index_attachment_parser_max_cputime
419 index_attachment_mime_filter
421 index_attachment_extension_filter
423
425 Written by Zarafa.
426
428 zarafa-indexer(1)
429Zarafa 7.0 August 2011 ZARAFA-INDEXER.CF(5)