zarafa-monitor.cfg(5)

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

NAME

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

SYNOPSIS

9       monitor.cfg
10

DESCRIPTION

12       The monitor.cfg is a configuration file for the Zarafa Monitor.
13       monitor.cfg contains instructions for the software to set up the
14       logging system.
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
40       The types of parameters for the spooler are: server, smtp and log.
41

EXPLANATION OF EACH PARAMETER

43       quota_check_interval
44           Set the interval (in minutes) for checking the quota for all Zarafa
45           users.
46
47           Default: 15
48
49       mailquota_resend_interval
50           Send interval of a quota mail in days when a user reache his
51           warning, soft or hard quota.
52
53           Default: 1
54
55       server_socket
56           Connection URL to find the connection to the Zarafa server.
57
58           Default: file:///var/run/zarafa
59
60       run_as_user
61           After correctly starting, the monitor process will become this
62           user, dropping root privileges. Note that the log file needs to be
63           writeable by this user, and the directory too to create new
64           logfiles after logrotation. This can also be achieved by setting
65           the correct group and permissions.
66
67           Default value is empty, not changing the user after starting.
68
69       run_as_group
70           After correctly starting, the monitor process will become this
71           group, dropping root privileges.
72
73           Default value is empty, not changing the group after starting.
74
75       pid_file
76           Write the process ID number to this file. This is used by the
77           init.d script to correctly stop/restart the service.
78
79           Default value: /var/run/zarafa-monitor.pid
80
81       running_path
82           Change directory to this path when running in daemonize mode. When
83           using the -F switch to run in the foreground the directory will not
84           be changed.
85
86           Default: /
87
88       sslkey_file
89           Use this file as key to logon to the server. This is only used when
90           server_socket is set to an HTTPS transport. See the zarafa-
91           server(1) manual page on how to setup SSL keys.
92
93           Default: value not set.
94
95       sslkey_pass
96           The password of the SSL key file that is set in sslkey_file.
97
98           Default: value not set.
99
100       log_method
101           The method which should be used for logging. Valid values are:
102
103           syslog
104               Use the Linux system log. All messages will be written to the
105               mail facility. See also syslog.conf(5).
106
107           file
108               Log to a file. The filename will be specified in log_file.
109
110           Default: file
111
112       log_file
113           When logging to a file, specify the filename in this parameter. Use
114           - (minus sign) for stderr output.
115
116           Default: -
117
118       log_timestamp
119           Specify whether to prefix each log line with a timestamp in ´file´
120           logging mode.
121
122           Default: 1
123
124       log_level
125           The level of output for logging in the range from 0 to 5. 0 means
126           no logging, 5 means full logging.
127
128           Default: 2
129
130       userquota_warning_template, userquota_soft_template,
131       userquota_hard_template, companyquota_warning_template,
132       companyquota_soft_template, companyquota_hard_template
133           These templates are read by the zarafa-monitor when a user or
134           tenant exceeds a particular quota level. In these templates
135           multiple variables can be used which will be replaced before
136           sending the quota warning email.
137
138           These files should be saved in the UTF-8 charset. UTF-8 is
139           compatible with US-ASCII, so if you only use western characters,
140           there is no need for special measurements.
141
142           ${ZARAFA_QUOTA_NAME}
143               userquota template: The name of the user who exceeded his quota
144
145               companyquota template: The name of the tenant which exceeded
146               its quota
147
148           ${ZARAFA_QUOTA_FULLNAME}
149               userquota template: The fullname for the user who exceeded his
150               quota
151
152               tenantquota template: The name of the tenant which exceeded its
153               quota
154
155           ${ZARAFA_QUOTA_COMPANY}
156               userquota template: The name of the tenant to which the user
157               belongs
158
159               tentantquota template: The name of the tenant which exceeded
160               its quota
161
162           ${ZARAFA_QUOTA_STORE_SIZE}
163               userquota template: The total size of the user´s store
164
165               companyquota template: The total size of all stores (including
166               the public store) which belong to this tenant
167
168               Note: The size unit (KB,MB) is part of the variable
169
170           ${ZARAFA_QUOTA_WARN_SIZE}
171               The quota warning level
172
173               Note: The size unit (KB,MB) is part of the variable
174
175           ${ZARAFA_QUOTA_SOFT_SIZE}
176               The quota soft level
177
178               Note: The size unit (KB,MB) is part of the variable
179
180           ${ZARAFA_QUOTA_HARD_SIZE}
181               The quota hard limit
182
183               Note: The size unit (KB,MB) is part of the variable
184

RELOADING

186       The following options are reloadable by sending the zarafa-monitor
187       process a HUP signal:
188
189       log_level, mailquota_resend_interval, userquota_warning_template,
190       userquota_soft_template, userquota_hard_template
191

FILES

193       /etc/zarafa/monitor.cfg
194           The Zarafa monitor configuration file.
195

AUTHOR

197       Written by Zarafa.
198