kopano-core/doc/kopano-dagent.cfg.5

'\" t
.\"     Title: kopano-dagent.cfg
.\"    Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: November 2016
.\"    Manual: Kopano Core user reference
.\"    Source: Kopano 8
.\"  Language: English
.\"
.TH "KOPANO\-DAGENT\&.CFG" "5" "November 2016" "Kopano 8" "Kopano Core user reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
kopano-dagent.cfg \- The Kopano dagent configuration file
.SH "SYNOPSIS"
.PP
\fBdagent\&.cfg\fR
.SH "DESCRIPTION"
.PP
The
dagent\&.cfg
is a configuration file for the Kopano Dagent\&.
dagent\&.cfg
contains instructions for the software to set up the logging system and LMTP settings\&.
.SH "FILE FORMAT"
.PP
The file consists of one big section, but parameters can be grouped by functionality\&.
.PP
The parameters are written in the form:
.PP
\fBname\fR
=
\fIvalue\fR
.PP
The file is line\-based\&. Each newline\-terminated line represents either a comment, nothing, a parameter or a directive\&. A line beginning with `#\*(Aq is considered a comment, and will be ignored by Kopano\&. Parameter names are case sensitive\&. Lines beginning with `!\*(Aq are directives\&.
.PP
Directives are written in the form:
.PP
!\fBdirective\fR
\fI[argument(s)] \fR
.PP
The following directives exist:
.PP
\fBinclude\fR
.RS 4
Include and process
\fIargument\fR
.sp
Example: !include common\&.cfg
.RE
.SH "EXPLANATION OF EACH PARAMETER"
.PP
\fBserver_bind\fR
.RS 4
Bind to a particular IP address\&. Leave empty to bind to all addresses\&.
.sp
Default: (empty)
.RE
.PP
\fBserver_socket\fR
.RS 4
Unix socket to find the connection to the Kopano server\&.
.sp
Default:
\fIfile:///var/run/kopano/server\&.sock\fR
.RE
.PP
\fBrun_as_user\fR
.RS 4
After correctly starting, the dagent process will become this user, dropping root privileges\&. Note that the log file needs to be writeable by this user, and the directory too to create new logfiles after logrotation\&. This can also be achieved by setting the correct group and permissions\&.
.sp
Default value is empty, not changing the user after starting\&.
.RE
.PP
\fBrun_as_group\fR
.RS 4
After correctly starting, the dagent process will become this group, dropping root privileges\&.
.sp
Default value is empty, not changing the group after starting\&.
.RE
.PP
\fBpid_file\fR
.RS 4
Write the process ID number to this file\&. This is used by the init\&.d script to correctly stop/restart the service\&.
.sp
Default:
\fI/var/run/kopano/dagent\&.pid\fR
.RE
.PP
\fBsslkey_file\fR
.RS 4
Use this file as key to logon to the server\&. This is only used when server_socket is set to an HTTPS transport\&. See the
\fBkopano-server\fR(8)
manual page on how to setup SSL keys\&.
.sp
Default: value not set\&.
.RE
.PP
\fBsslkey_pass\fR
.RS 4
The password of the SSL key file that is set in sslkey_file\&.
.sp
Default: value not set\&.
.RE
.PP
\fBlmtp_port\fR
.RS 4
Port to listen to for LMTP requests
.sp
Default:
\fI2003\fR
.RE
.PP
\fBlmtp_max_threads\fR
.RS 4
The maximum number of LMTP threads that can be running simultaneously\&. This is also limited by your SMTP server\&. (20 is the postfix default concurrency limit)
.sp
Default:
\fI20\fR
.RE
.PP
\fBspam_header_name\fR
.RS 4
To detect if the receiving mail is spam, the DAgent can check this header for a value that is in there\&. This name is case insensitive\&. If this option is empty, the detection method will be turned off\&. You can also force a delivery to the Junk Mail folder using the
\fI\-j\fR
commandline option\&.
.sp
Default:
\fIX\-Spam\-Status\fR
.RE
.PP
\fBspam_header_value\fR
.RS 4
When this value is found in the
\fIspam_header_name\fR, the mail will be considered spam, and will be delivered in the user\*(Aqs Junk Mail folder\&. The value can be anywhere in the header, not just the start\&. The value is case insensitive\&.
.sp
Default:
\fIYes,\fR
.RE
.PP
\fBlog_method\fR
.RS 4
The method which should be used for logging\&. Valid values are:
.PP
\fIsyslog\fR
.RS 4
Use the Linux system log\&. All messages will be written to the mail facility\&. See also
\fBsyslog.conf\fR(5)\&.
.RE
.PP
\fIfile\fR
.RS 4
Log to a file\&. The filename will be specified in
\fBlog_file\fR\&.
.RE
.sp
Default:
\fIfile\fR
.RE
.PP
\fBlog_file\fR
.RS 4
When logging to a file, specify the filename in this parameter\&. Use
\fI\-\fR
(minus sign) for stderr output\&.
.sp
Default:
\fI/var/log/kopano/dagent\&.log\fR
.RE
.PP
\fBlog_timestamp\fR
.RS 4
Specify whether to prefix each log line with a timestamp in \*(Aqfile\*(Aq logging mode\&.
.sp
Default:
\fI1\fR
.RE
.PP
\fBlog_buffer_size\fR
.RS 4
Buffer logging in what sized blocks\&. The special value 0 selects line buffering\&.
.sp
Default:
\fI0\fR
.RE
.PP
\fBlog_level\fR
.RS 4
The level of output for logging in the range from 0 to 5\&. 0 means no logging, 5 means full logging\&.
.sp
Default:
\fI2\fR
.RE
.PP
\fBlog_raw_message\fR
.RS 4
Log the raw message to a file\&. The file is saved to the location specified in
\fBlog_raw_message_path\fR\&.
.sp
Default:
\fIno\fR
.RE
.PP
\fBlog_raw_message_path\fR
.RS 4
Path to save the raw message\&.
.sp
Default:
\fI/tmp\fR
.RE
.PP
\fBarchive_on_delivery\fR
.RS 4
Archive incoming message on delivery\&. If an archive is attached to the target mailbox, the message will immediately be archived upon delivery\&.
.sp
Rules will be processed before the message is archived, so when a rule moves the message to an alternate location, the archived message will be placed in the correct location in the archive\&. When the incoming message is copied by a rule, only the original message is archived\&.
.sp
Default:
\fIno\fR
.RE
.PP
\fBmr_autoaccepter\fR
.RS 4
Kopano\-dagent can auto\-accept meeting requests if the mr\-accept option is enabled for a user\&. When this option is enabled and a meeting request or meeting cancellation is received, this script is started with the following parameters: /usr/sbin/kopano\-mr\-accept <username> </path/to/dagent\&.cfg> [<ENTRYID>]\&.
.sp
If the script is successful (exitcode is 0), then no other actions are performed (eg rules or vacation messages) and the message is not delivered in the inbox\&. If the script exits with a non\-zero exit code, rules and vacation messages are run as usual, and the message is delivered in the inbox (or other folder, depending on rules or options)\&.
.sp
Default:
\fI/usr/sbin/kopano\-mr\-accept\fR
.RE
.PP
\fBmr_autoprocessor\fR
.RS 4
Kopano\-dagent can auto\-process meeting requests\&. When this is enabled and a meeting request, response or meeting cancellation is received, this script is started with the following parameters: /usr/bin/kopano\-mr\-process <username> </path/to/dagent\&.cfg> [<ENTRYID>]\&.
.sp
Default:
\fI/usr/bin/kopano\-mr\-process\fR
.RE
.PP
\fBplugin_enabled\fR
.RS 4
Enable or disable the dagent plugin framework\&.
.sp
Default:
\fIyes\fR
.RE
.PP
\fBplugin_manager_path\fR
.RS 4
The path to the dagent plugin manager\&.
.sp
Default:
\fI/usr/share/kopano\-dagent/python\fR
.RE
.PP
\fBplugin_path\fR
.RS 4
Path to the activated dagent plugins\&. This folder contains symlinks to the kopano plugins and custom scripts\&. The plugins are installed in
\fI/usr/share/kopano\-dagent/python/plugins\fR\&. To activate a plugin create a symbolic link in the
\fIplugin_path\fR
directory\&.
.sp
Example:
.sp
\fBln\fR
\fB\-s\fR
\fI/usr/share/kopano\-dagent/python/plugins/BMP2PNG\&.py\fR
\fI/var/lib/kopano/dagent/plugins/BMP2PNG\&.py\fR
.sp
Default:
\fI/var/lib/kopano/dagent/plugins\fR
.RE
.PP
\fBdefault_charset\fR
.RS 4
Some emails do not contain any charset information or specify us\-ascii even though it isn\*(Aqt\&. In both cases, dagent will assume the following charset is used\&. Note that this implies that the given charset should be a superset of us\-ascii (most charsets are)\&.
.sp
Default:
\fIiso\-8859\-15\fR
.RE
.PP
\fBset_rule_headers\fR
.RS 4
Enable the addition of X\-Kopano\-Rule\-Action headers on messages that have been forwarded or replied by a rule\&.
.sp
Default:
\fIyes\fR
.RE
.PP
\fBno_double_forward\fR
.RS 4
Enable this option to prevent rules to cause a loop\&. An e\-mail can only be forwarded once\&. When this option is enabled, the set_rule_headers option must also be enabled\&.
.sp
Default:
\fIno\fR
.RE
.PP
\fBforward_whitelist_domains\fR
.RS 4
A list of space\-separated domains to which forwarding via a rule is allowed\&. The "*" matches zero or more characters (including dots, i\&.e\&. subdomains at multiple levels)\&. Do not use "*kopano.com" to permit both "@kopano.com" and "@sub.kopano.com", as that would also allow "@notkopano.com"\&.
.sp
Default:
\fI*\fR
.RE
.SH "RELOADING"
.PP
The following options are reloadable by sending the kopano\-dagent process a HUP signal:
.PP
log_level
.RS 4
.RE
.PP
archive_on_delivery
.RS 4
.RE
.PP
mr_autoaccepter
.RS 4
.RE
.SH "FILES"
.PP
/etc/kopano/dagent\&.cfg
.RS 4
The Kopano dagent configuration file\&.
.RE
.SH "AUTHOR"
.PP
Written by Kopano\&.
.SH "SEE ALSO"
.PP
\fBkopano-dagent\fR(8)