From: Robert Haas <rhaas@postgresql.org>
Date: Tue, 29 Mar 2022 14:06:07 +0000 (-0400)
Subject: Document basebackup_to_shell.required_role.
X-Git-Tag: REL_15_BETA1~368
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=26a0c025e233c3d4333f071bde4ac970ba1ec643;p=thirdparty%2Fpostgresql.git

Document basebackup_to_shell.required_role.

Omission noted by Joe Conway.

Discussion: https://postgr.es/m/CA+Tgmoat+zbzzZQJ7poXyUwiqxQxTaUid=auB4FejZ15VvDh4Q@mail.gmail.com
Discussion: https://postgr.es/m/744cf762-47d3-050f-5fa1-d4f9e8dbae2e@joeconway.com
---

diff --git a/doc/src/sgml/basebackup-to-shell.sgml b/doc/src/sgml/basebackup-to-shell.sgml
index f36f37e5104..9f44071d502 100644
--- a/doc/src/sgml/basebackup-to-shell.sgml
+++ b/doc/src/sgml/basebackup-to-shell.sgml
@@ -55,6 +55,23 @@
      </para>
     </listitem>
    </varlistentry>
+
+   <varlistentry>
+    <term>
+     <varname>basebackup_to_shell.required_role</varname> (<type>string</type>)
+     <indexterm>
+      <primary><varname>basebackup_to_shell.required_role</varname> configuration parameter</primary>
+     </indexterm>
+    </term>
+    <listitem>
+     <para>
+      A role which replication whose privileges users are required to possess
+      in order to make use of the <literal>shell</literal> backup target.
+      If this is not set, any replication user may make use of the
+      <literal>shell</literal> backup target.
+     </para>
+    </listitem>
+   </varlistentry>
   </variablelist>
  </sect2>