1 ##VERSION: $Id: c6a82fc8c0bd0e858ca7c133640ed14769e3e04c-20160501082012$
3 # Copyright 2000-2004 Double Precision, Inc. See COPYING for
4 # distribution information.
6 # Do not alter lines that begin with ##, they are used when upgrading
9 # authpgsqlrc created from authpgsqlrc.dist by sysconftool
11 # DO NOT INSTALL THIS FILE with world read permissions. This file
12 # might contain the PostgreSQL admin password!
14 # Each line in this file must follow the following format:
16 # field[spaces|tabs]value
18 # That is, the name of the field, followed by spaces or tabs, followed by
19 # field value. Trailing spaces are prohibited.
24 # The server hostname, port, userid, and password used to log in.
26 # See Postgresql's documenation for PQconnectdb(), for other options that
30 host=pgsql.example.com \
35 ##NAME: PGSQL_DATABASE:0
37 # The name of the PostgreSQL database we will open:
39 PGSQL_DATABASE template1
41 ##NAME: PGSQL_CHARACTER_SET:0
43 # Optionally install a character set mapping. Restart authdaemond, send a test
44 # query using authtest and check for error messages in syslog/maillog.
46 # PGSQL_CHARACTER_SET UTF8
48 ##NAME: PGSQL_USER_TABLE:0
50 # The name of the table containing your user data. See README.authmysqlrc
51 # for the required fields in this table (both MySQL and Postgress use the
52 # same suggested layout.
54 PGSQL_USER_TABLE passwd
56 ##NAME: PGSQL_CRYPT_PWFIELD:0
58 # Either PGSQL_CRYPT_PWFIELD or PGSQL_CLEAR_PWFIELD must be defined. Both
59 # are OK too. crypted passwords go into PGSQL_CRYPT_PWFIELD, cleartext
60 # passwords go into PGSQL_CLEAR_PWFIELD. Cleartext passwords allow
61 # CRAM-MD5 authentication to be implemented.
63 PGSQL_CRYPT_PWFIELD crypt
65 ##NAME: PGSQL_CLEAR_PWFIELD:0
68 # PGSQL_CLEAR_PWFIELD clear
70 ##NAME: PGSQL_DEFAULT_DOMAIN:0
72 # If DEFAULT_DOMAIN is defined, and someone tries to log in as 'user',
73 # we will look up 'user@DEFAULT_DOMAIN' instead.
76 # DEFAULT_DOMAIN example.com
78 ##NAME: PGSQL_UID_FIELD:0
80 # Other fields in the mysql table:
82 # PGSQL_UID_FIELD - contains the numerical userid of the account
86 ##NAME: PGSQL_GID_FIELD:0
88 # Numerical groupid of the account
92 ##NAME: PGSQL_LOGIN_FIELD:0
94 # The login id, default is id. Basically the query is:
96 # SELECT PGSQL_UID_FIELD, PGSQL_GID_FIELD, ... WHERE id='loginid'
101 ##NAME: PGSQL_HOME_FIELD:0
104 PGSQL_HOME_FIELD home
106 ##NAME: PGSQL_NAME_FIELD:0
108 # The user's name (optional)
110 PGSQL_NAME_FIELD name
112 ##NAME: PGSQL_MAILDIR_FIELD:0
114 # This is an optional field, and can be used to specify an arbitrary
115 # location of the maildir for the account, which normally defaults to
116 # $HOME/Maildir (where $HOME is read from PGSQL_HOME_FIELD).
118 # You still need to provide a PGSQL_HOME_FIELD, even if you uncomment this
121 # PGSQL_MAILDIR_FIELD maildir
123 ##NAME: PGSQL_DEFAULTDELIVERY:0
125 # Courier mail server only: optional field specifies custom mail delivery
126 # instructions for this account (if defined) -- essentially overrides
127 # DEFAULTDELIVERY from ${sysconfdir}/courierd
129 # PGSQL_DEFAULTDELIVERY defaultDelivery
131 ##NAME: PGSQL_QUOTA_FIELD:0
133 # Define PGSQL_QUOTA_FIELD to be the name of the field that can optionally
134 # specify a maildir quota. See README.maildirquota for more information
136 # PGSQL_QUOTA_FIELD quota
138 ##NAME: PGSQL_AUXOPTIONS:0
140 # Auxiliary options. The PGSQL_AUXOPTIONS field should be a char field that
141 # contains a single string consisting of comma-separated "ATTRIBUTE=NAME"
142 # pairs. These names are additional attributes that define various per-account
143 # "options", as given in INSTALL's description of the "Account OPTIONS"
146 # PGSQL_AUXOPTIONS_FIELD auxoptions
148 # You might want to try something like this, if you'd like to use a bunch
149 # of individual fields, instead of a single text blob:
151 # PGSQL_AUXOPTIONS_FIELD 'disableimap=' || disableimap || ',disablepop3=' || disablepop3 || ',disablewebmail=' || disablewebmail || ',sharedgroup=' || sharedgroup
153 # This will let you define fields called "disableimap", etc, with the end result
154 # being something that the OPTIONS parser understands.
156 ##NAME: PGSQL_WHERE_CLAUSE:0
158 # This is optional, PGSQL_WHERE_CLAUSE can be basically set to an arbitrary
159 # fixed string that is appended to the WHERE clause of our query
161 # PGSQL_WHERE_CLAUSE server='mailhost.example.com'
163 ##NAME: PGSQL_SELECT_CLAUSE:0
166 # This is optional, PGSQL_SELECT_CLAUSE can be set when you have a database,
167 # which is structuraly different from proposed. The fixed string will
168 # be used to do a SELECT operation on database, which should return fields
169 # in order specified bellow:
171 # username, cryptpw, clearpw, uid, gid, home, maildir, quota, fullname, options
173 # Enabling this option causes ignorance of any other field-related
174 # options, excluding default domain.
176 # There are two variables, which you can use. Substitution will be made
177 # for them, so you can put entered username (local part) and domain name
178 # in the right place of your query. These variables are:
179 # $(local_part), $(domain), and $(service)
181 # If a $(domain) is empty (not given by the remote user) the default domain
182 # name is used in its place.
184 # $(service) will expand out to the service being authenticated: imap, imaps,
185 # pop3 or pop3s. Courier mail server only: service will also expand out to
186 # "courier", when searching for local mail account's location. In this case,
187 # if the "maildir" field is not empty it will be used in place of
188 # DEFAULTDELIVERY. Courier mail server will also use esmtp when doing
189 # authenticated ESMTP.
191 # This example is a little bit modified adaptation of vmail-sql
194 # PGSQL_SELECT_CLAUSE SELECT popbox.local_part, \
195 # '{MD5}' || popbox.password_hash, \
199 # domain.path || '/' || popbox.mbox_name), \
203 # FROM popbox, domain \
204 # WHERE popbox.local_part = '$(local_part)' \
205 # AND popbox.domain_name = '$(domain)' \
206 # AND popbox.domain_name = domain.domain_name
209 ##NAME: PGSQL_ENUMERATE_CLAUSE:1
212 # Optional custom SQL query used to enumerate accounts for authenumerate,
213 # in order to compile a list of accounts for shared folders. The query
214 # should return the following fields: name, uid, gid, homedir, maildir, options
217 # PGSQL_ENUMERATE_CLAUSE SELECT popbox.local_part || '@' || popbox.domain_name, \
220 # domain.path || '/' || popbox.mbox_name, \
222 # 'sharedgroup=' || sharedgroup \
223 # FROM popbox, domain \
224 # WHERE popbox.local_part = '$(local_part)' \
225 # AND popbox.domain_name = '$(domain)' \
226 # AND popbox.domain_name = domain.domain_name
229 ##NAME: PGSQL_CHPASS_CLAUSE:0
232 # This is optional, PGSQL_CHPASS_CLAUSE can be set when you have a database,
233 # which is structuraly different from proposed. The fixed string will
234 # be used to do an UPDATE operation on database. In other words, it is
235 # used, when changing password.
237 # There are four variables, which you can use. Substitution will be made
238 # for them, so you can put entered username (local part) and domain name
239 # in the right place of your query. There variables are:
240 # $(local_part) , $(domain) , $(newpass) , $(newpass_crypt)
242 # If a $(domain) is empty (not given by the remote user) the default domain
243 # name is used in its place.
244 # $(newpass) contains plain password
245 # $(newpass_crypt) contains its crypted form
247 # PGSQL_CHPASS_CLAUSE UPDATE popbox \
248 # SET clearpw='$(newpass)', \
249 # password_hash='$(newpass_crypt)' \
250 # WHERE local_part='$(local_part)' \
251 # AND domain_name='$(domain)'
257 # Do not remove this section from this configuration file. This section
258 # must be present at the end of this file.