diff --git a/doc/configuration-file.sgml b/doc/configuration-file.sgml index 533ccfc3..bae89653 100644 --- a/doc/configuration-file.sgml +++ b/doc/configuration-file.sgml @@ -1,15 +1,15 @@ - + repmgr.conf - location configuration - repmgr.conf location + repmgr.conf - Configuration file location + Configuration file + repmgr and repmgrd use a common configuration file, by default called @@ -21,6 +21,55 @@ for more details. + + + + repmgr.conf + format + + + Configuration file format + + + repmgr.conf is a plain text file with one parameter/value + combination per line. + + + Whitespace is insignificant (except within a quoted parameter value) and blank lines are ignored. + Hash marks (#) designate the remainder of the line as a comment. Parameter values that are not simple + identifiers or numbers should be single-quoted. Note that single quote can not be embedded + in a parameter value. + + + + &repmgr; will interpret double-quotes as being part of a string value; only use single quotes + to quote parameter values. + + + + + Example of a valid repmgr.conf file: + +# repmgr.conf + +node_id=1 +node_name= node1 +conninfo ='host=node1 dbname=repmgr user=repmgr connect_timeout=2' +data_directory = /var/lib/pgsql/11/data + + + + + + + + + repmgr.conf + location + + + Configuration file location + The configuration file will be searched for in the following locations: @@ -50,7 +99,7 @@ Note that if a file is explicitly specified with -f/--config-file, an error will be raised if it is not found or not readable, and no attempt will be made to check default locations; this is to prevent repmgr unexpectedly - reading the wrong configuraton file. + reading the wrong configuration file. @@ -65,5 +114,7 @@ to /path/to/./repmgr.conf, whereas you'd normally write /path/to/repmgr.conf). - - + + + + diff --git a/repmgr.conf.sample b/repmgr.conf.sample index a8441088..8bbb3fbf 100644 --- a/repmgr.conf.sample +++ b/repmgr.conf.sample @@ -5,7 +5,13 @@ # Some configuration items will be set with a default value; this # is noted for each item. Where no default value is shown, the # parameter will be treated as empty or false. - +# +# IMPORTANT: string values can be provided as-is, or enclosed in single quotes +# (but not double-quotes, which will be interpreted as part of the string), e.g.: +# +# node_name=foo +# node_name = 'foo' +# # ============================================================================= # Required configuration items # =============================================================================