Skip to content

Commit 36b9761

Browse files
committed
PBCKP-817 Update documentation examples to 2.7.0
1 parent 46c8a33 commit 36b9761

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

‎doc/pgprobackup.xml

+21-20
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ doc/src/sgml/pgprobackup.sgml
483483
</listitem>
484484
<listitem>
485485
<para>
486-
<literal>backup</literal> — user on
486+
<literal>backup_user</literal> — user on
487487
<literal>backup_host</literal> running all <application>pg_probackup</application>
488488
operations.
489489
</para>
@@ -1472,12 +1472,12 @@ GRANT SELECT ON TABLE pg_catalog.pg_database TO backup;
14721472
<refsect2 id="pbk-configuring-the-remote-mode">
14731473
<title>Configuring the Remote Mode</title>
14741474
<para>
1475-
<application>pg_probackup</application> supports the remote mode that allows to perform
1476-
backup, restore and WAL archiving operations remotely. In this
1477-
mode, the backup catalog is stored on a local system, while
1478-
<productname>PostgreSQL</productname> instance to backup and/or to restore is located on a
1479-
remote system. Currently the only supported remote protocol is
1480-
SSH.
1475+
<application>pg_probackup</application> supports the remote mode that
1476+
allows to perform backup, restore and WAL archiving operations remotely.
1477+
In this mode, the backup catalog is stored on a local system, while
1478+
<productname>PostgreSQL</productname> instance to backup and/or to restore
1479+
is located on a remote system. Currently the only supported remote
1480+
protocol is SSH.
14811481
</para>
14821482
<refsect3 id="pbk-setup-ssh">
14831483
<title>Set up SSH</title>
@@ -1490,19 +1490,19 @@ GRANT SELECT ON TABLE pg_catalog.pg_database TO backup;
14901490
<para>
14911491
Install <application>pg_probackup</application> on both systems:
14921492
<literal>backup_host</literal> and
1493-
<literal>db_host</literal>.
1493+
<literal>postgres_host</literal>.
14941494
</para>
14951495
</listitem>
14961496
<listitem>
14971497
<para>
14981498
For communication between the hosts set up a passwordless
1499-
SSH connection between <literal>backup</literal> user on
1500-
<literal>backup_host</literal> and
1499+
SSH connection between the <literal>backup_user</literal> user on
1500+
<literal>backup_host</literal> and the
15011501
<literal>postgres</literal> user on
1502-
<literal>db_host</literal>:
1502+
<literal>postgres_host</literal>:
15031503
</para>
15041504
<programlisting>
1505-
[backup@backup_host] ssh-copy-id postgres@db_host
1505+
[backup_user@backup_host] ssh-copy-id postgres@postgres_host
15061506
</programlisting>
15071507
<para>
15081508
Where:
@@ -1516,13 +1516,13 @@ GRANT SELECT ON TABLE pg_catalog.pg_database TO backup;
15161516
</listitem>
15171517
<listitem>
15181518
<para>
1519-
<literal>db_host</literal> is the system with <productname>PostgreSQL</productname>
1519+
<literal>postgres_host</literal> is the system with the <productname>PostgreSQL</productname>
15201520
cluster.
15211521
</para>
15221522
</listitem>
15231523
<listitem>
15241524
<para>
1525-
<literal>backup</literal> is the OS user on
1525+
<literal>backup_user</literal> is the OS user on
15261526
<literal>backup_host</literal> used to run <application>pg_probackup</application>.
15271527
</para>
15281528
</listitem>
@@ -1544,18 +1544,19 @@ GRANT SELECT ON TABLE pg_catalog.pg_database TO backup;
15441544
<link linkend="pbk-setting-up-continuous-wal-archiving">continuous
15451545
WAL archiving</link>, set up a passwordless SSH
15461546
connection between the <literal>postgres</literal> user on
1547-
<literal>db_host</literal> and the <literal>backup</literal>
1547+
<literal>postgres_host</literal> and the <literal>backup</literal>
15481548
user on <literal>backup_host</literal>:
15491549
</para>
15501550
<programlisting>
1551-
[postgres@db_host] ssh-copy-id backup@backup_host
1551+
[postgres@postgres_host] ssh-copy-id backup_user@backup_host
15521552
</programlisting>
15531553
</listitem>
15541554
<listitem>
15551555
<para>
15561556
Make sure <application>pg_probackup</application> on <literal>postgres_host</literal>
15571557
can be located when a connection via SSH is made. For example, for <application>Bash</application>, you can
1558-
modify <literal>PATH</literal> in <filename>~/.bashrc</filename> of the <literal>backup</literal> user.
1558+
modify <literal>PATH</literal> in <filename>~/.bashrc</filename> of the <literal>postgres</literal> user
1559+
(above the line in <filename>bashrc</filename> which exits the script for non-interactive shells).
15591560
Alternatively, for <application>pg_probackup</application> commands, specify the path to the directory
15601561
containing the <application>pg_probackup</application> binary on <literal>postgres_host</literal> via
15611562
the <link linkend="pbk-remote-server-opts">--remote-path</link> option.
@@ -1611,10 +1612,10 @@ GRANT SELECT ON TABLE pg_catalog.pg_database TO backup;
16111612
<para>
16121613
The main process is usually started on
16131614
<replaceable>backup_host</replaceable> and connects to
1614-
<replaceable>db_host</replaceable>, but in case of
1615+
<replaceable>postgres_host</replaceable>, but in case of
16151616
<command>archive-push</command> and
16161617
<command>archive-get</command> commands the main process
1617-
is started on <replaceable>db_host</replaceable> and connects to
1618+
is started on <replaceable>postgres_host</replaceable> and connects to
16181619
<replaceable>backup_host</replaceable>.
16191620
</para>
16201621
</listitem>
@@ -1635,7 +1636,7 @@ GRANT SELECT ON TABLE pg_catalog.pg_database TO backup;
16351636
<listitem>
16361637
<para>
16371638
Compression is always done on
1638-
<replaceable>db_host</replaceable>, while decompression is always done on
1639+
<replaceable>postgres_host</replaceable>, while decompression is always done on
16391640
<replaceable>backup_host</replaceable>.
16401641
</para>
16411642
</listitem>

0 commit comments

Comments
 (0)