pgmoneta configuration ​

The configuration is loaded from either the path specified by the -c flag or /etc/pgmoneta/pgmoneta.conf.

The configuration of pgmoneta is split into sections using the [ and ] characters.

The main section, called [pgmoneta], is where you configure the overall properties of pgmoneta.

Other sections doesn't have any requirements to their naming so you can give them meaningful names like [primary] for the primary PostgreSQL instance.

All properties are in the format key = value.

The characters # and ; can be used for comments; must be the first character on the line. The Bool data type supports the following values: on, yes, 1, true, off, no, 0 and false.

See a sample configuration for running pgmoneta on localhost.

[pgmoneta] ​

Server section ​

The user specified must have the REPLICATION option in order to stream the Write-Ahead Log (WAL), and must have access to the postgres database in order to get the necessary configuration parameters.

Note, that PostgreSQL 13+ is required, as well as having wal_level at replica or logical level.

Note, that if host starts with a / it represents a path and pgmoneta will connect using a Unix Domain Socket.

extra parameter ​

The extra configuration is set in the server section. It is not required, but if you configure this parameter, when you perform a backup using the CLI pgmoneta-cli -c pgmoneta.conf backup primary, it will also copy all specified files on the server side and send them back to the client side.

This extra feature requires the server side to install the pgmoneta_ext extension and also make the user repl a SUPERUSER (this will be improved in the future). Currently, this feature is only available to the SUPERUSER role.

You can set up pgmoneta_ext by following the README to easily install the extension. There are also more detailed instructions available in the DEVELOPERS documentation.

The format for the extra parameter is a path to a file or directory. You can list more than one file or directory separated by commas. The format is as follows:

extra = /tmp/myfile1, /tmp/myfile2, /tmp/mydir1, /tmp/mydir2

extra = /tmp/myfile1, /tmp/myfile2, /tmp/mydir1, /tmp/mydir2

pgmoneta_users configuration ​

The pgmoneta_users configuration defines the users known to the system. This file is created and managed through the pgmoneta-admin tool.

The configuration is loaded from either the path specified by the -u flag or /etc/pgmoneta/pgmoneta_users.conf.

pgmoneta_admins configuration ​

The pgmoneta_admins configuration defines the administrators known to the system. This file is created and managed through the pgmoneta-admin tool.

The configuration is loaded from either the path specified by the -A flag or /etc/pgmoneta/pgmoneta_admins.conf.

If pgmoneta has both Transport Layer Security (TLS) and management enabled then pgmoneta-cli can connect with TLS using the files ~/.pgmoneta/pgmoneta.key (must be 0600 permission), ~/.pgmoneta/pgmoneta.crt and ~/.pgmoneta/root.crt.

pgmoneta_cli configuration ​

The pgmoneta_cli configuration defines defaults for the pgmoneta-cli client. It is loaded from the path passed with -c or from /etc/pgmoneta/pgmoneta_cli.conf if -c is not supplied. Command-line flags override values in this file.

Configuration Directory ​

You can specify a directory for all configuration files using the -D flag (or --directory). Alternatively, you can set the PGMONETA_CONFIG_DIR environment variable to define the configuration directory.

Behavior:

• When the directory flag (-D) is set, pgmoneta will look for all configuration files in the specified directory.
• If a required file is not found in the specified directory, pgmoneta will look for it in its default location (e.g., /etc/pgmoneta/pgmoneta.conf).
• If the file is not found in either location:
  • If the file is mandatory, pgmoneta will log an error and fail to start.
  • If the file is optional, pgmoneta will log a warning and continue without it.
• All file lookup attempts and missing files are logged for troubleshooting.

Precedence Rules:

• Individual file flags (such as -c, -u, -A, etc.) always take precedence over the directory flag and environment variable for their respective files.
• The directory flag (-D) takes precedence over the environment variable (PGMONETA_CONFIG_DIR).
• If neither the directory flag nor individual file flags are set, pgmoneta uses the default locations for all configuration files.

Using the Environment Variable:

1. Set the environment variable before starting pgmoneta:

export PGMONETA_CONFIG_DIR=/path/to/config_dir
pgmoneta -d

export PGMONETA_CONFIG_DIR=/path/to/config_dir
pgmoneta -d

2. If both the environment variable and the -D flag are set, the flag takes precedence.

Example:

pgmoneta -D /custom/config/dir -d

pgmoneta -D /custom/config/dir -d

or

export PGMONETA_CONFIG_DIR=/custom/config/dir
pgmoneta -d

export PGMONETA_CONFIG_DIR=/custom/config/dir
pgmoneta -d

Refer to logs for details about which configuration files were loaded and from which locations.

pgmoneta_walinfo configuration ​

The pgmoneta_walinfo configuration defines the info needed for walinfo to work.

The configuration is loaded from either the path specified by the -c flag or /etc/pgmoneta/pgmoneta_walinfo.conf if -c wasn't provided.

pgmoneta_walfilter configuration ​

The pgmoneta_walfilter configuration defines the info needed for walfilter to work.

The tool uses two configuration files:

1. A YAML configuration file (required) that specifies source/target directories, filtering rules, and other settings
2. A pgmoneta_walfilter.conf file (optional) for logging configuration

YAML Configuration Format ​

The YAML configuration file defines the paths, filtering rules, and other settings for walfilter. Below is an example configuration:

source_dir: /path/to/source/backup/directory
target_dir: /path/to/target/directory
configuration_file: /etc/pgmoneta/pgmoneta_walfilter.conf
rules:                             # Optional: filtering rules
  - xids:                          # Filter by transaction IDs
    - 752
    - 753

source_dir: /path/to/source/backup/directory
target_dir: /path/to/target/directory
configuration_file: /etc/pgmoneta/pgmoneta_walfilter.conf
rules:                             # Optional: filtering rules
  - xids:                          # Filter by transaction IDs
    - 752
    - 753

Filtering Rules ​

The tool supports two types of filtering:

1. Transaction ID (XID) filtering: Filter out specific transaction IDs
   • Specify a list of XIDs to remove from the WAL stream
2. Operation-based filtering: Filter out specific database operations
   • DELETE: Removes all DELETE operations and their associated transactions

[pgmoneta_walinfo] ​

Server section ​

[pgmoneta_walfilter] ​

Server section ​