Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 3b5152c

Browse files
committed
Improve comments in sample config files.
1 parent ffce35f commit 3b5152c

File tree

2 files changed

+31
-24
lines changed

2 files changed

+31
-24
lines changed

src/backend/libpq/pg_hba.conf.sample

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,50 +7,56 @@
77
#
88
# This file controls: which hosts are allowed to connect, how clients
99
# are authenticated, which PostgreSQL user names they can use, which
10-
# databases they can access. Records take one of seven forms:
10+
# databases they can access. Records take one of these forms:
1111
#
1212
# local DATABASE USER METHOD [OPTION]
1313
# host DATABASE USER CIDR-ADDRESS METHOD [OPTION]
1414
# hostssl DATABASE USER CIDR-ADDRESS METHOD [OPTION]
1515
# hostnossl DATABASE USER CIDR-ADDRESS METHOD [OPTION]
1616
#
17-
# (The uppercase quantities should be replaced by actual values.)
17+
# (The uppercase items must be replaced by actual values.)
18+
#
1819
# The first field is the connection type: "local" is a Unix-domain socket,
1920
# "host" is either a plain or SSL-encrypted TCP/IP socket, "hostssl" is an
2021
# SSL-encrypted TCP/IP socket, and "hostnossl" is a plain TCP/IP socket.
21-
# DATABASE can be "all", "sameuser", "samegroup", a database name (or
22-
# a comma-separated list thereof), or a file name prefixed with "@".
23-
# USER can be "all", an actual user name or a group name prefixed with
24-
# "+" or a list containing either.
22+
#
23+
# DATABASE can be "all", "sameuser", "samegroup", a database name, or
24+
# a comma-separated list thereof.
25+
#
26+
# USER can be "all", a user name, a group name prefixed with "+", or
27+
# a comma-separated list thereof. In both the DATABASE and USER fields
28+
# you can also write a file name prefixed with "@" to include names from
29+
# a separate file.
2530
#
2631
# CIDR-ADDRESS specifies the set of hosts the record matches.
27-
# It is made up of an IP address and a CIDR mask that is an integer
28-
# (between 0 and 32 (IPv6) or 128(IPv6) inclusive) that specifies
29-
# the number of significant bits in the mask Also, you can use a
30-
# separate IP address and netmask to specify the set of hosts.
32+
# It is made up of an IP address and a CIDR mask that is an integer
33+
# (between 0 and 32 (IPv6) or 128(IPv6) inclusive) that specifies
34+
# the number of significant bits in the mask. Alternatively, you can write
35+
# an IP address and netmask in separate columns to specify the set of hosts.
36+
#
37+
# METHOD can be "trust", "reject", "md5", "crypt", "password",
38+
# "krb4", "krb5", "ident", or "pam". Note that "password" sends passwords
39+
# in clear text; "md5" is preferred since it sends encrypted passwords.
3140
#
32-
# METHOD can be "trust", "reject", "md5", "crypt", "password",
33-
# "krb4", "krb5", "ident", or "pam". Note that "password" uses
34-
# clear-text passwords; "md5" is preferred for encrypted passwords.
35-
# OPTION is the ident map or the name of the PAM service.
41+
# OPTION is the ident map or the name of the PAM service, depending on METHOD.
3642
#
3743
# Database and user names containing spaces, commas, quotes and other special
38-
# characters can be quoted. Quoting one of the keywords "all", "sameuser" or
39-
# "samegroup" makes the name lose its special character, and just match a
44+
# characters must be quoted. Quoting one of the keywords "all", "sameuser" or
45+
# "samegroup" makes the name lose its special character, and just match a
4046
# database or username with that name.
4147
#
4248
# This file is read on server startup and when the postmaster receives
4349
# a SIGHUP signal. If you edit the file on a running system, you have
44-
# to SIGHUP the postmaster for the changes to take effect, or use
45-
# "pg_ctl reload".
50+
# to SIGHUP the postmaster for the changes to take effect. You can use
51+
# "pg_ctl reload" to do that.
4652

4753
# Put your actual configuration here
4854
# ----------------------------------
4955
#
5056
# If you want to allow non-local connections, you need to add more
5157
# "host" records. In that case you will also need to make PostgreSQL listen
52-
# on a non-local interface via the listen_addresses configuration parameter, or
53-
# the -i or -h command line switches.
58+
# on a non-local interface via the listen_addresses configuration parameter,
59+
# or via the -i or -h command line switches.
5460
#
5561

5662
@authcomment@

src/backend/libpq/pg_ident.conf.sample

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,19 @@
1111
#
1212
# MAPNAME IDENT-USERNAME PG-USERNAME
1313
#
14-
# (The uppercase quantities should be replaced by actual values.)
14+
# (The uppercase quantities must be replaced by actual values.)
15+
#
1516
# MAPNAME is the (otherwise freely chosen) map name that was used in
1617
# pg_hba.conf. IDENT-USERNAME is the detected user name of the
17-
# client. PG-USERNAME is the request PostgreSQL user name. The
18+
# client. PG-USERNAME is the requested PostgreSQL user name. The
1819
# existence of a record specifies that IDENT-USERNAME may connect as
1920
# PG-USERNAME. Multiple maps may be specified in this file and used
2021
# by pg_hba.conf.
2122
#
2223
# This file is read on server startup and when the postmaster receives
2324
# a SIGHUP signal. If you edit the file on a running system, you have
24-
# to SIGHUP the postmaster for the changes to take effect, or use
25-
# "pg_ctl reload".
25+
# to SIGHUP the postmaster for the changes to take effect. You can use
26+
# "pg_ctl reload" to do that.
2627

2728
# Put your actual configuration here
2829
# ----------------------------------

0 commit comments

Comments
 (0)