1 # This file is opened as root, so it should be owned by root and mode 0600.
3 # http://wiki2.dovecot.org/AuthDatabase/SQL
5 # For the sql passdb module, you'll need a database with a table that
6 # contains fields for at least the username and password. If you want to
7 # use the user@domain syntax, you might want to have a separate domain
10 # If your users all have the same uig/gid, and have predictable home
11 # directories, you can use the static userdb module to generate the home
12 # dir based on the username and domain. In this case, you won't need fields
13 # for home, uid, or gid in the database.
15 # If you prefer to use the sql userdb module, you'll want to add fields
16 # for home, uid, and gid. Here is an example table:
18 # CREATE TABLE users (
19 # username VARCHAR(128) NOT NULL,
20 # domain VARCHAR(128) NOT NULL,
21 # password VARCHAR(64) NOT NULL,
22 # home VARCHAR(255) NOT NULL,
23 # uid INTEGER NOT NULL,
24 # gid INTEGER NOT NULL,
25 # active CHAR(1) DEFAULT 'Y' NOT NULL
28 # Database driver: mysql, pgsql, sqlite
31 # Database connection string. This is driver-specific setting.
33 # HA / round-robin load-balancing is supported by giving multiple host
34 # settings, like: host=sql1.host.org host=sql2.host.org
37 # For available options, see the PostgreSQL documention for the
38 # PQconnectdb function of libpq.
39 # Use maxconns=n (default 5) to change how many connections Dovecot can
43 # Basic options emulate PostgreSQL option names:
44 # host, port, user, password, dbname
46 # But also adds some new settings:
47 # client_flags - See MySQL manual
48 # ssl_ca, ssl_ca_path - Set either one or both to enable SSL
49 # ssl_cert, ssl_key - For sending client-side certificates to server
50 # ssl_cipher - Set minimum allowed cipher security (default: HIGH)
51 # option_file - Read options from the given file instead of
52 # the default my.cnf location
53 # option_group - Read options from the given group (default: client)
55 # You can connect to UNIX sockets by using host: host=/var/run/mysql.sock
56 # Note that currently you can't use spaces in parameters.
59 # The path to the database file.
62 # connect = host=192.168.1.1 dbname=users
63 # connect = host=sql.example.com dbname=virtual user=virtual password=blarg
64 # connect = /etc/dovecot/authdb.sqlite
68 # Default password scheme.
70 # List of supported schemes is in
71 # http://wiki2.dovecot.org/Authentication/PasswordSchemes
73 #default_pass_scheme = MD5
75 # passdb query to retrieve the password. It can return fields:
76 # password - The user's password. This field must be returned.
77 # user - user@domain from the database. Needed with case-insensitive lookups.
78 # username and domain - An alternative way to represent the "user" field.
80 # The "user" field is often necessary with case-insensitive lookups to avoid
81 # e.g. "name" and "nAme" logins creating two different mail directories. If
82 # your user and domain names are in separate fields, you can return "username"
83 # and "domain" fields instead of "user".
85 # The query can also return other fields which have a special meaning, see
86 # http://wiki2.dovecot.org/PasswordDatabase/ExtraFields
88 # Commonly used available substitutions (see http://wiki2.dovecot.org/Variables
90 # %u = entire user@domain
91 # %n = user part of user@domain
92 # %d = domain part of user@domain
94 # Note that these can be used only as input to SQL query. If the query outputs
95 # any of these substitutions, they're not touched. Otherwise it would be
96 # difficult to have eg. usernames containing '%' characters.
99 # password_query = SELECT userid AS user, pw AS password \
100 # FROM users WHERE userid = '%u' AND active = 'Y'
103 # SELECT username, domain, password \
104 # FROM users WHERE username = '%n' AND domain = '%d'
106 # userdb query to retrieve the user information. It can return fields:
107 # uid - System UID (overrides mail_uid setting)
108 # gid - System GID (overrides mail_gid setting)
109 # home - Home directory
110 # mail - Mail location (overrides mail_location setting)
112 # None of these are strictly required. If you use a single UID and GID, and
113 # home or mail directory fits to a template string, you could use userdb static
114 # instead. For a list of all fields that can be returned, see
115 # http://wiki2.dovecot.org/UserDatabase/ExtraFields
118 # user_query = SELECT home, uid, gid FROM users WHERE userid = '%u'
119 # user_query = SELECT dir AS home, user AS uid, group AS gid FROM users where userid = '%u'
120 # user_query = SELECT home, 501 AS uid, 501 AS gid FROM users WHERE userid = '%u'
123 # SELECT home, uid, gid \
124 # FROM users WHERE username = '%n' AND domain = '%d'
126 # If you wish to avoid two SQL lookups (passdb + userdb), you can use
127 # userdb prefetch instead of userdb sql in dovecot.conf. In that case you'll
128 # also have to return userdb fields in password_query prefixed with "userdb_"
129 # string. For example:
131 # SELECT userid AS user, password, \
132 # home AS userdb_home, uid AS userdb_uid, gid AS userdb_gid \
133 # FROM users WHERE userid = '%u'
135 # Query to get a list of all usernames.
136 #iterate_query = SELECT username AS user FROM users