This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 20 and 21
Revision 20 as of 2010-03-27 05:46:02
Size: 3821
Editor: TimoSirainen
Comment:
Revision 21 as of 2010-11-05 14:54:26
Size: 2783
Editor: TimoSirainen
Comment:
Deletions are marked like this. Additions are marked like this.
Line 8: Line 8:
  * This field is called '''system_user''' in v1.1 and older.
* '''userdb_import''': This allows returning multiple extra fields in one TAB-separated field. It's useful for userdbs which are a bit less flexible for returning a variable number of fields (e.g. SQL). (v1.2+)
 * '''uidgid_file''': Get uid and gid for user based on the given filename. (v1.1+)
 * '''userdb_import''': This allows returning multiple extra fields in one TAB-separated field. It's useful for userdbs which are a bit less flexible for returning a variable number of fields (e.g. SQL).
 * '''uidgid_file''': Get uid and gid for user based on the gi
ven filename.
Line 21: Line 20:
 1. All actual settings are first placed into environment variables. The environment name may be different than the setting name.
 1. Everything inside plugin section is placed into environment variables. [[Variables|%variables]] in values are expanded first.
 1. Everything from userdb lookup is placed into environment variables.
 1. At this point if [[PostLoginScripting|post-login scripting is used]], it may modify the environment if wanted.
 1. imap/pop3 reads the settings from environment variables. It doesn't matter how they got there, they're read the exact same way.

At each step if the environment variable already exists, it's replaced with the new value (ie. the setting is overridden).

Note that

 * If you want to override a setting from userdb you must use its environment name, not the setting name. See PostLoginScripting for how to find out what the environment is named.
 * Boolean settings are checked simply by the environment variables' existence and their values are ignored. For example having a userdb lookup return {{{mmap_disable=no}}} would still enable it.
 1. First all actual settings are first read into memory.
 1. Next if [[PostLoginScripting|post-login scripting is used]], it may modify the settings if wanted.
 1. Last all the extra fields returned by userdb lookup are used to override the settings. Any unknown setting is placed into plugin {} section (e.g. foo=bar will be parsed as if it were plugin { foo=bar }).
Line 40: Line 30:
# NOTE: \ line splitting works only with v1.1+. The quota_rule is also for v1.1+.
Line 58: Line 47:
# v1.0 quota format:
user:{plain}pass:1000:1000::/home/user::userdb_mail=mbox:~/mail userdb_quota=maildir:storage=102400
# v1.1 quota format:

User database extra fields

A user database lookup typically returns uid, gid, home and mail fields. Other possibilities are:

  • nice: Set the mail process's priority to be the given value.

  • chroot: Chroot to given directory. Overrides mail_chroot setting in dovecot.conf.

  • system_groups_user: Specifies the username whose groups are read from /etc/group (or wherever NSS is configured to taken them from). The logged in user has access to those groups. This may be useful for shared mailboxes.

  • userdb_import: This allows returning multiple extra fields in one TAB-separated field. It's useful for userdbs which are a bit less flexible for returning a variable number of fields (e.g. SQL).

  • uidgid_file: Get uid and gid for user based on the given filename.

  • It's possible to override settings from dovecot.conf.

These fields can be returned the exact same way as uid, gid, home and mail fields. Below are examples for some user databases.

Overriding settings

Most commonly settings are overridden from plugin section. For example if your plugin section has quota=maildir:storage=1024 value and the userdb lookup returns quota=maildir:storage=2048, the original quota setting gets overridden. In fact if the lookup always returns a quota field, there's no point in having the quota setting in plugin section at all, because it always gets overridden anyway.

To understand how imap and pop3 processes see their settings, it may be helpful to know how Dovecot internally passes them:

  1. First all actual settings are first read into memory.
  2. Next if post-login scripting is used, it may modify the settings if wanted.

  3. Last all the extra fields returned by userdb lookup are used to override the settings. Any unknown setting is placed into plugin {} section (e.g. foo=bar will be parsed as if it were plugin { foo=bar }).

Examples

SQL

dovecot-sql.conf:

user_query = SELECT home, uid, gid, \
  '*:storage=100M' as quota_rule, mail_plugins \
  FROM users WHERE userid = '%u'

LDAP

dovecot-ldap.conf:

user_attrs = homeDirectory=home,uidNumber=uid,gidNumber=gid,quotaDovecot=quota,mail_plugins

passwd-file

Below are examples that show how to give two userdb extra fields ("mail" and "quota"). Note that all userdb extra fields must be prefixed with "userdb_", otherwise they're treated as passdb extra fields.

user:{plain}pass:1000:1000::/home/user::userdb_mail=mbox:~/mail userdb_quota_rule=*:storage=100M
user2:{plain}pass2:1001:1001::/home/user2::userdb_mail=maildir:~/Maildir userdb_quota_rule=*:storage=200M

UserDatabase/ExtraFields (last edited 2018-01-05 15:58:25 by AkiTuomi)