From fdcc3850c8c67352c3e8235e53bcc6e0fe3a7921 Mon Sep 17 00:00:00 2001
From: Ian Barwick <ian@2ndquadrant.com>
Date: Wed, 31 Oct 2018 09:59:38 +0900
Subject: [PATCH] doc: clarify network and software prerequisites

---
 doc/configuration.sgml | 37 +++++++++++++++++++++++++++++++++++++
 doc/quickstart.sgml    |  7 ++++++-
 2 files changed, 43 insertions(+), 1 deletion(-)

diff --git a/doc/configuration.sgml b/doc/configuration.sgml
index a7d99d70..6bfa0f66 100644
--- a/doc/configuration.sgml
+++ b/doc/configuration.sgml
@@ -1,6 +1,43 @@
 <chapter id="configuration" xreflabel="Configuration">
   <title>repmgr configuration</title>
 
+  <sect1 id="configuration-prerequisites" xreflabel="Prerequisites for configuration">
+    <indexterm>
+      <primary>configuration</primary>
+      <secondary>prerequisites</secondary>
+    </indexterm>
+
+    <title>Prerequisites for configuration</title>
+    <para>
+     Following software must be installed on both servers:
+     <itemizedlist spacing="compact" mark="bullet">
+      <listitem>
+       <simpara><application>PostgreSQL</application></simpara>
+      </listitem>
+      <listitem>
+       <simpara>
+        <application>repmgr</application>
+       </simpara>
+      </listitem>
+     </itemizedlist>
+    </para>
+
+    <para>
+      At network level, connections between the PostgreSQL port (default: <literal>5432</literal>)
+      must be possible between all nodes.
+    </para>
+    <para>
+      Optionally, if you want <application>repmgr</application> to copy PostgreSQL configuration
+      files which are located outside the data directory (as is the case with e.g.
+      <link linkend="packages-debian-ubuntu">Debian packages</link>)
+      when <link linkend="repmgr-standby-clone">cloning a standby</link>, or use &repmgr; to perform
+      <link linkend="preparing-for-switchover">switchovers</link>, passwordless SSH connections are required
+      between all nodes. Additionally, for copying files outide the data directory,
+      <application>rsync</application> must be installed.
+    </para>
+  </sect1>
+
+
   &configuration-file;
   &configuration-file-required-settings;
   &configuration-file-log-settings;
diff --git a/doc/quickstart.sgml b/doc/quickstart.sgml
index 5a8b68ef..bd6a3ebd 100644
--- a/doc/quickstart.sgml
+++ b/doc/quickstart.sgml
@@ -1,6 +1,10 @@
 <chapter id="quickstart" xreflabel="Quick-start guide">
  <title>Quick-start guide</title>
 
+ <indexterm>
+   <primary>quickstart</primary>
+ </indexterm>
+
  <para>
   This section gives a quick introduction to &repmgr;, including setting up a
   sample &repmgr; installation and a basic replication cluster.
@@ -50,7 +54,8 @@
     </para>
     <para>
       If you want <application>repmgr</application> to copy configuration files which are
-      located outside the PostgreSQL data directory, and/or to test <command>switchover</command>
+      located outside the PostgreSQL data directory, and/or to test
+      <command><link linkend="repmgr-standby-switchover">switchover</link></command>
       functionality, you will also need passwordless SSH connections between both servers, and
       <application>rsync</application> should be installed.
     </para>