Skip to content

Commit d594e0d

Browse files
committed
doc: move HBA reload instructions above the syntax details
Reported-by: John <johrss@amazon.com> Discussion: https://postgr.es/m/165947088723.651.7641196693246068619@wrigleys.postgresql.org Backpatch-through: master
1 parent 42d3125 commit d594e0d

File tree

1 file changed

+51
-50
lines changed

1 file changed

+51
-50
lines changed

doc/src/sgml/client-auth.sgml

Lines changed: 51 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,35 @@
7373
however; see the <xref linkend="guc-hba-file"/> configuration parameter.
7474
</para>
7575

76+
<para>
77+
The <filename>pg_hba.conf</filename> file is read on start-up and when
78+
the main server process receives a
79+
<systemitem>SIGHUP</systemitem><indexterm><primary>SIGHUP</primary></indexterm>
80+
signal. If you edit the file on an
81+
active system, you will need to signal the postmaster
82+
(using <literal>pg_ctl reload</literal>, calling the SQL function
83+
<function>pg_reload_conf()</function>, or using <literal>kill
84+
-HUP</literal>) to make it re-read the file.
85+
</para>
86+
87+
<note>
88+
<para>
89+
The preceding statement is not true on Microsoft Windows: there, any
90+
changes in the <filename>pg_hba.conf</filename> file are immediately
91+
applied by subsequent new connections.
92+
</para>
93+
</note>
94+
95+
<para>
96+
The system view
97+
<link linkend="view-pg-hba-file-rules"><structname>pg_hba_file_rules</structname></link>
98+
can be helpful for pre-testing changes to the <filename>pg_hba.conf</filename>
99+
file, or for diagnosing problems if loading of the file did not have the
100+
desired effects. Rows in the view with
101+
non-null <structfield>error</structfield> fields indicate problems in the
102+
corresponding lines of the file.
103+
</para>
104+
76105
<para>
77106
The general format of the <filename>pg_hba.conf</filename> file is
78107
a set of records, one per line. Blank lines are ignored, as is any
@@ -733,35 +762,6 @@ openssl x509 -in myclient.crt -noout --subject -nameopt RFC2253 | sed "s/^subjec
733762
range of allowed client IP addresses.
734763
</para>
735764

736-
<para>
737-
The <filename>pg_hba.conf</filename> file is read on start-up and when
738-
the main server process receives a
739-
<systemitem>SIGHUP</systemitem><indexterm><primary>SIGHUP</primary></indexterm>
740-
signal. If you edit the file on an
741-
active system, you will need to signal the postmaster
742-
(using <literal>pg_ctl reload</literal>, calling the SQL function
743-
<function>pg_reload_conf()</function>, or using <literal>kill
744-
-HUP</literal>) to make it re-read the file.
745-
</para>
746-
747-
<note>
748-
<para>
749-
The preceding statement is not true on Microsoft Windows: there, any
750-
changes in the <filename>pg_hba.conf</filename> file are immediately
751-
applied by subsequent new connections.
752-
</para>
753-
</note>
754-
755-
<para>
756-
The system view
757-
<link linkend="view-pg-hba-file-rules"><structname>pg_hba_file_rules</structname></link>
758-
can be helpful for pre-testing changes to the <filename>pg_hba.conf</filename>
759-
file, or for diagnosing problems if loading of the file did not have the
760-
desired effects. Rows in the view with
761-
non-null <structfield>error</structfield> fields indicate problems in the
762-
corresponding lines of the file.
763-
</para>
764-
765765
<tip>
766766
<para>
767767
To connect to a particular database, a user must not only pass the
@@ -933,6 +933,28 @@ local db1,db2,@demodbs all md5
933933
As for <filename>pg_hba.conf</filename>, the lines in this file can
934934
be include directives, following the same rules.
935935
</para>
936+
937+
<para>
938+
The <filename>pg_ident.conf</filename> file is read on start-up and
939+
when the main server process receives a
940+
<systemitem>SIGHUP</systemitem><indexterm><primary>SIGHUP</primary></indexterm>
941+
signal. If you edit the file on an
942+
active system, you will need to signal the postmaster
943+
(using <literal>pg_ctl reload</literal>, calling the SQL function
944+
<function>pg_reload_conf()</function>, or using <literal>kill
945+
-HUP</literal>) to make it re-read the file.
946+
</para>
947+
948+
<para>
949+
The system view
950+
<link linkend="view-pg-ident-file-mappings"><structname>pg_ident_file_mappings</structname></link>
951+
can be helpful for pre-testing changes to the
952+
<filename>pg_ident.conf</filename> file, or for diagnosing problems if
953+
loading of the file did not have the desired effects. Rows in the view with
954+
non-null <structfield>error</structfield> fields indicate problems in the
955+
corresponding lines of the file.
956+
</para>
957+
936958
<para>
937959
There is no restriction regarding how many database users a given
938960
operating system user can correspond to, nor vice versa. Thus, entries
@@ -999,27 +1021,6 @@ mymap /^(.*)@otherdomain\.com$ guest
9991021
</para>
10001022
</tip>
10011023

1002-
<para>
1003-
The <filename>pg_ident.conf</filename> file is read on start-up and
1004-
when the main server process receives a
1005-
<systemitem>SIGHUP</systemitem><indexterm><primary>SIGHUP</primary></indexterm>
1006-
signal. If you edit the file on an
1007-
active system, you will need to signal the postmaster
1008-
(using <literal>pg_ctl reload</literal>, calling the SQL function
1009-
<function>pg_reload_conf()</function>, or using <literal>kill
1010-
-HUP</literal>) to make it re-read the file.
1011-
</para>
1012-
1013-
<para>
1014-
The system view
1015-
<link linkend="view-pg-ident-file-mappings"><structname>pg_ident_file_mappings</structname></link>
1016-
can be helpful for pre-testing changes to the
1017-
<filename>pg_ident.conf</filename> file, or for diagnosing problems if
1018-
loading of the file did not have the desired effects. Rows in the view with
1019-
non-null <structfield>error</structfield> fields indicate problems in the
1020-
corresponding lines of the file.
1021-
</para>
1022-
10231024
<para>
10241025
A <filename>pg_ident.conf</filename> file that could be used in
10251026
conjunction with the <filename>pg_hba.conf</filename> file in <xref

0 commit comments

Comments
 (0)