1<sect1 id="configuration-file-settings" xreflabel="required configuration file settings">
2
3 <title>Required configuration file settings</title>
4
5  <indexterm>
6    <primary>repmgr.conf</primary>
7    <secondary>required settings</secondary>
8  </indexterm>
9
10 <para>
11   Each <filename>repmgr.conf</filename> file must contain the following parameters:
12 </para>
13 <para>
14  <variablelist>
15   <varlistentry id="repmgr-conf-node-id" xreflabel="node_id">
16    <term><varname>node_id</varname> (<type>int</type>)
17     <indexterm>
18      <primary><varname>node_id</varname> configuration file parameter</primary>
19     </indexterm>
20    </term>
21    <listitem>
22     <para>
23      A unique integer greater than zero which identifies the node.
24     </para>
25    </listitem>
26   </varlistentry>
27
28   <varlistentry id="repmgr-conf-node-name" xreflabel="node_name">
29    <term><varname>node_name</varname> (<type>string</type>)
30     <indexterm>
31      <primary><varname>node_name</varname> configuration file parameter</primary>
32     </indexterm>
33    </term>
34    <listitem>
35     <para>
36       An arbitrary (but unique) string; we recommend using the server's hostname
37       or another identifier unambiguously associated with the server to avoid
38       confusion. Avoid choosing names which reflect the node's current role,
39       e.g. <varname>primary</varname> or <varname>standby1</varname>
40       as roles can change and if you end up in a solution where the current primary is
41       called <varname>standby1</varname> (for example), things will be confusing
42       to say the least.
43     </para>
44     <para>
45       The string's maximum length is 63 characters and it should
46       contain only printable ASCII characters.
47     </para>
48    </listitem>
49   </varlistentry>
50
51   <varlistentry id="repmgr-conf-conninfo" xreflabel="conninfo">
52    <term><varname>conninfo</varname> (<type>string</type>)
53     <indexterm>
54      <primary><varname>conninfo</varname> configuration file parameter</primary>
55     </indexterm>
56    </term>
57    <listitem>
58     <para>
59      Database connection information as a conninfo string.
60      All servers in the cluster must be able to connect to
61      the local node using this string.
62     </para>
63     <para>
64       For details on conninfo strings, see section <ulink
65       url="https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING">Connection Strings</ulink>
66        in the PosgreSQL documentation.
67     </para>
68     <para>
69        If repmgrd is in use, consider explicitly setting
70        <varname>connect_timeout</varname> in the <varname>conninfo</varname>
71        string to determine the length of time which elapses before a network
72        connection attempt is abandoned; for details see <ulink
73        url="https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-CONNECT-TIMEOUT">
74        the PostgreSQL documentation</ulink>.
75     </para>
76    </listitem>
77   </varlistentry>
78
79   <varlistentry id="repmgr-conf-data-directory" xreflabel="data_directory">
80    <term><varname>data_directory</varname> (<type>string</type>)</term>
81    <listitem>
82      <indexterm>
83        <primary><varname>data_directory</varname> configuration file parameter</primary>
84      </indexterm>
85
86     <para>
87       The node's data directory. This is needed by repmgr
88       when performing operations when the PostgreSQL instance
89       is not running and there's no other way of determining
90       the data directory.
91     </para>
92    </listitem>
93   </varlistentry>
94
95
96  </variablelist>
97 </para>
98
99
100
101</sect1>
102