zarafa-unix.cfg(5)

1ZARAFA-UNIX.CFG(5)           Zarafa user reference          ZARAFA-UNIX.CFG(5)
2
3
4

NAME

6       zarafa-unix.cfg - The Zarafa Unix user plugin configuration file
7

SYNOPSIS

9       unix.cfg
10

DESCRIPTION

12       The unix.cfg is a configuration file for the unix user plugin. All
13       options to correctly retrieve user and group information can be set
14       here.
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

EXPLANATION OF EACH PARAMETER

41       fullname_charset
42           The charset that is used in /etc/passwd for the fullname of a user.
43           In most setups, us-ascii is used, but may also be iso-8859-15. All
44           charsets supported by the system iconv() are supported here. Since
45           iso-8859-15 is an extension on us-ascii, this is used as the
46           default to support high characters for most latin languages. If
47           your default shell is in UTF-8 (see your locales settings), enter
48           utf-8 here.
49
50           Default: iso-8859-15
51
52       default_domain
53           The default domain name to set as e-mail address. When a user is
54           created, it´s email address will be set to username@default_domain.
55
56           Default: no default present.
57
58       min_user_uid
59           This is the minimal uid a user must have to be created as a Zarafa
60           user. This is to skip system users present in the /etc/passwd file.
61           Normally, users start at 1000.
62
63           Default: 1000
64
65       max_user_uid
66           This is the maximum uid a user may have to be created as a Zarafa
67           user. This is to skip system users present in the /etc/passwd file
68           with a high uid, as user nobody does.
69
70           Default: 10000
71
72       except_user_uids
73           A whitespace seperated list of uids that are within the
74           min_user_uid and max_user_uid range, but shouldn´t be considered as
75           users.
76
77           Default: empty
78
79       min_group_gid
80           This is the minimal gid a group must have to be created as a Zarafa
81           group. This is to skip system groups present in the /etc/group
82           file. Normally, groups start at 1000.
83
84           Default: 1000
85
86       max_group_gid
87           This is the maximum gid a group may have to be created as a Zarafa
88           group. This is to skip system groups present in the /etc/group file
89           with a high gid, as group nogroup does.
90
91           Default: 10000
92
93       except_group_gids
94           A whitespace seperated list of gids that are within the
95           min_group_gid and max_group_gid range, but shouldn´t be considered
96           as groups.
97
98           Default: empty
99
100       non_login_shell
101           This this the shell a user has to be created as a non-login box.
102           Mail can be delivered to this box, but you cannot directly login
103           with this username. The uid must be within the defined limits.
104
105           Default: /bin/false
106

USER ATTRIBUTES

108       Not all Zarafa attributes can be used from the system files. The
109       following attibutes are used from the system files:
110
111       username
112           The login name of the user.
113
114       fullname
115           The fullname of the user.
116
117       password
118           The password is in the /etc/shadow file. Zarafa needs reads access
119           to this file to correctly work with the Unix plugin.
120
121       Other attributes like quota settings, admin setting and e-mail address
122       are kept in the database like the db user plugin does.
123

FILES

125       /etc/zarafa/server.cfg
126           The server configuration file.
127
128       /etc/zarafa/unix.cfg
129           The Zarafa Unix user plugin configuration file.
130

AUTHOR

132       Written by Zarafa.
133