'\" t
.\"     Title: kopano-unix.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\-UNIX.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-unix.cfg \- The Kopano Unix user plugin configuration file
.SH "SYNOPSIS"
.PP
\fBunix.cfg\fR
.SH "DESCRIPTION"
.PP
The
unix.cfg
is a configuration file for the unix user plugin. All options to correctly retrieve user and group information can be set here.
.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
.PP
Example: !include common.cfg
.RE
.SH "EXPLANATION OF EACH PARAMETER"
.SS fullname_charset
.PP
The charset that is used in /etc/passwd for the fullname of a user. In most setups, us\-ascii is used, but may also be iso\-8859\-15. All charsets supported by the system iconv() are supported here. Since iso\-8859\-15 is an extension on us\-ascii, this is used as the default to support high characters for most latin languages. If your default shell is in UTF\-8 (see your locales settings), enter utf\-8 here.
.PP
Default:
\fIiso\-8859\-15\fR
.SS default_domain
.PP
The default domain name to set as e\-mail address. When a user is created, its email address will be set to
\fIusername@default_domain\fR.
.PP
Default:
\fIno default present\fR.
.SS min_user_uid
.PP
This is the minimal uid a user must have to be created as a Kopano user. This is to skip system users present in the /etc/passwd file. Normally, users start at 1000.
.PP
Default:
\fI1000\fR
.SS max_user_uid
.PP
This is the maximum uid a user may have to be created as a Kopano user. This is to skip system users present in the /etc/passwd file with a high uid, as user nobody does.
.PP
Default:
\fI10000\fR
.SS except_user_uids
.PP
A whitespace separated list of uids that are within the min_user_uid and max_user_uid range, but shouldn\*(Aqt be considered as users.
.PP
Default:
\fIempty\fR
.SS min_group_gid
.PP
This is the minimal gid a group must have to be created as a Kopano group. This is to skip system groups present in the /etc/group file. Normally, groups start at 1000.
.PP
Default:
\fI1000\fR
.SS max_group_gid
.PP
This is the maximum gid a group may have to be created as a Kopano group. This is to skip system groups present in the /etc/group file with a high gid, as group nogroup does.
.PP
Default:
\fI10000\fR
.SS except_group_gids
.PP
A whitespace separated list of gids that are within the min_group_gid and max_group_gid range, but shouldn\*(Aqt be considered as groups.
.PP
Default:
\fIempty\fR
.SS non_login_shell
.PP
A space-separated list of shells that, if a user account has one of them set as
login shell, marks the corresponding Kopano user account as locked. Mail can be
delivered to that user's inbox, but the user cannot directly login with this
username.
.PP
Default:
\fI/bin/false\fR
.RE
.SH "USER ATTRIBUTES"
.PP
Not all Kopano attributes can be used from the system files. The following attributes are used from the system files:
.PP
username
.RS 4
The login name of the user.
.RE
.PP
fullname
.RS 4
The fullname of the user.
.RE
.PP
password
.RS 4
The password is in the /etc/shadow file. Kopano needs reads access to this file to correctly work with the Unix plugin.
.RE
.PP
Other attributes like quota settings, admin setting and e\-mail address are kept in the database like the db user plugin does.
.SH "FILES"
.PP
/etc/kopano/server.cfg
.RS 4
The server configuration file.
.RE
.PP
/etc/kopano/unix.cfg
.RS 4
The Kopano Unix user plugin configuration file.
.RE
.SH "AUTHOR"
.PP
Written by Kopano.
.SH "SEE ALSO"
.PP
\fBkopano-server\fR(8),
\fBkopano-server.cfg\fR(5)