1 ##VERSION: $Id: authpgsqlrc 17 2011-04-04 02:07:37Z mrsam $
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 # To connect to a filesystem socket, delete PGSQL_HOST, and set PGSQL_PORT to
27 # the socket's last component. So, if your pg socket is /tmp/.s.PGSQL.5400
28 # set PGSQL_PORT to 5400.
30 PGSQL_HOST pgsql.example.com
38 # PGSQL_OPT specifies the connection debug options to PQsetdbLogin().
39 # Don't bother with this setting unless you know what you're doing
43 ##NAME: PGSQL_DATABASE:0
45 # The name of the PostgreSQL database we will open:
47 PGSQL_DATABASE template1
49 ##NAME: PGSQL_CHARACTER_SET:0
51 # Optionally install a character set mapping. Restart authdaemond, send a test
52 # query using authtest and check for error messages in syslog/maillog.
54 # PGSQL_CHARACTER_SET UTF8
56 ##NAME: PGSQL_USER_TABLE:0
58 # The name of the table containing your user data. See README.authmysqlrc
59 # for the required fields in this table (both MySQL and Postgress use the
60 # same suggested layout.
62 PGSQL_USER_TABLE passwd
64 ##NAME: PGSQL_CRYPT_PWFIELD:0
66 # Either PGSQL_CRYPT_PWFIELD or PGSQL_CLEAR_PWFIELD must be defined. Both
67 # are OK too. crypted passwords go into PGSQL_CRYPT_PWFIELD, cleartext
68 # passwords go into PGSQL_CLEAR_PWFIELD. Cleartext passwords allow
69 # CRAM-MD5 authentication to be implemented.
71 PGSQL_CRYPT_PWFIELD crypt
73 ##NAME: PGSQL_CLEAR_PWFIELD:0
76 # PGSQL_CLEAR_PWFIELD clear
78 ##NAME: PGSQL_DEFAULT_DOMAIN:0
80 # If DEFAULT_DOMAIN is defined, and someone tries to log in as 'user',
81 # we will look up 'user@DEFAULT_DOMAIN' instead.
84 # DEFAULT_DOMAIN example.com
86 ##NAME: PGSQL_UID_FIELD:0
88 # Other fields in the mysql table:
90 # PGSQL_UID_FIELD - contains the numerical userid of the account
94 ##NAME: PGSQL_GID_FIELD:0
96 # Numerical groupid of the account
100 ##NAME: PGSQL_LOGIN_FIELD:0
102 # The login id, default is id. Basically the query is:
104 # SELECT PGSQL_UID_FIELD, PGSQL_GID_FIELD, ... WHERE id='loginid'
109 ##NAME: PGSQL_HOME_FIELD:0
112 PGSQL_HOME_FIELD home
114 ##NAME: PGSQL_NAME_FIELD:0
116 # The user's name (optional)
118 PGSQL_NAME_FIELD name
120 ##NAME: PGSQL_MAILDIR_FIELD:0
122 # This is an optional field, and can be used to specify an arbitrary
123 # location of the maildir for the account, which normally defaults to
124 # $HOME/Maildir (where $HOME is read from PGSQL_HOME_FIELD).
126 # You still need to provide a PGSQL_HOME_FIELD, even if you uncomment this
129 # PGSQL_MAILDIR_FIELD maildir
131 ##NAME: PGSQL_DEFAULTDELIVERY:0
133 # Courier mail server only: optional field specifies custom mail delivery
134 # instructions for this account (if defined) -- essentially overrides
135 # DEFAULTDELIVERY from ${sysconfdir}/courierd
137 # PGSQL_DEFAULTDELIVERY defaultDelivery
139 ##NAME: PGSQL_QUOTA_FIELD:0
141 # Define PGSQL_QUOTA_FIELD to be the name of the field that can optionally
142 # specify a maildir quota. See README.maildirquota for more information
144 # PGSQL_QUOTA_FIELD quota
146 ##NAME: PGSQL_AUXOPTIONS:0
148 # Auxiliary options. The PGSQL_AUXOPTIONS field should be a char field that
149 # contains a single string consisting of comma-separated "ATTRIBUTE=NAME"
150 # pairs. These names are additional attributes that define various per-account
151 # "options", as given in INSTALL's description of the "Account OPTIONS"
154 # PGSQL_AUXOPTIONS_FIELD auxoptions
156 # You might want to try something like this, if you'd like to use a bunch
157 # of individual fields, instead of a single text blob:
159 # PGSQL_AUXOPTIONS_FIELD 'disableimap=' || disableimap || ',disablepop3=' || disablepop3 || ',disablewebmail=' || disablewebmail || ',sharedgroup=' || sharedgroup
161 # This will let you define fields called "disableimap", etc, with the end result
162 # being something that the OPTIONS parser understands.
164 ##NAME: PGSQL_WHERE_CLAUSE:0
166 # This is optional, PGSQL_WHERE_CLAUSE can be basically set to an arbitrary
167 # fixed string that is appended to the WHERE clause of our query
169 # PGSQL_WHERE_CLAUSE server='mailhost.example.com'
171 ##NAME: PGSQL_SELECT_CLAUSE:0
174 # This is optional, PGSQL_SELECT_CLAUSE can be set when you have a database,
175 # which is structuraly different from proposed. The fixed string will
176 # be used to do a SELECT operation on database, which should return fields
177 # in order specified bellow:
179 # username, cryptpw, clearpw, uid, gid, home, maildir, quota, fullname, options
181 # Enabling this option causes ignorance of any other field-related
182 # options, excluding default domain.
184 # There are two variables, which you can use. Substitution will be made
185 # for them, so you can put entered username (local part) and domain name
186 # in the right place of your query. These variables are:
187 # $(local_part), $(domain), and $(service)
189 # If a $(domain) is empty (not given by the remote user) the default domain
190 # name is used in its place.
192 # $(service) will expand out to the service being authenticated: imap, imaps,
193 # pop3 or pop3s. Courier mail server only: service will also expand out to
194 # "courier", when searching for local mail account's location. In this case,
195 # if the "maildir" field is not empty it will be used in place of
196 # DEFAULTDELIVERY. Courier mail server will also use esmtp when doing
197 # authenticated ESMTP.
199 # This example is a little bit modified adaptation of vmail-sql
202 # PGSQL_SELECT_CLAUSE SELECT popbox.local_part, \
203 # '{MD5}' || popbox.password_hash, \
207 # domain.path || '/' || popbox.mbox_name), \
211 # FROM popbox, domain \
212 # WHERE popbox.local_part = '$(local_part)' \
213 # AND popbox.domain_name = '$(domain)' \
214 # AND popbox.domain_name = domain.domain_name
217 ##NAME: PGSQL_ENUMERATE_CLAUSE:1
220 # Optional custom SQL query used to enumerate accounts for authenumerate,
221 # in order to compile a list of accounts for shared folders. The query
222 # should return the following fields: name, uid, gid, homedir, maildir, options
225 # PGSQL_ENUMERATE_CLAUSE SELECT popbox.local_part || '@' || popbox.domain_name, \
228 # domain.path || '/' || popbox.mbox_name, \
230 # 'sharedgroup=' || sharedgroup \
231 # FROM popbox, domain \
232 # WHERE popbox.local_part = '$(local_part)' \
233 # AND popbox.domain_name = '$(domain)' \
234 # AND popbox.domain_name = domain.domain_name
237 ##NAME: PGSQL_CHPASS_CLAUSE:0
240 # This is optional, PGSQL_CHPASS_CLAUSE can be set when you have a database,
241 # which is structuraly different from proposed. The fixed string will
242 # be used to do an UPDATE operation on database. In other words, it is
243 # used, when changing password.
245 # There are four variables, which you can use. Substitution will be made
246 # for them, so you can put entered username (local part) and domain name
247 # in the right place of your query. There variables are:
248 # $(local_part) , $(domain) , $(newpass) , $(newpass_crypt)
250 # If a $(domain) is empty (not given by the remote user) the default domain
251 # name is used in its place.
252 # $(newpass) contains plain password
253 # $(newpass_crypt) contains its crypted form
255 # PGSQL_CHPASS_CLAUSE UPDATE popbox \
256 # SET clearpw='$(newpass)', \
257 # password_hash='$(newpass_crypt)' \
258 # WHERE local_part='$(local_part)' \
259 # AND domain_name='$(domain)'