## Chapter 16. Binary Installation

## 16.1. Installing Postgres Pro Standard on Linux

For Linux-based operating systems, Postgres Pro Standard is shipped as binary packages. Each Postgres Pro binary distribution consists of several packages. The package structure differs from vanilla PostgreSQL and offers the following installation modes:

- Quick installation and setup. The `postgrespro-std-11` package installs and configures all the components required for a viable ready-to-use configuration of both server and client components. Choose this option if you are going to install a single Postgres Pro instance only, and you are not worried about possible conflicts with other PostgreSQL-based products.

  ### Important

  Installing the `postgrespro-std-11` package can delete existing installations of Postgres Pro and PostgreSQL-based products. Similarly, this Postgres Pro installation may be automatically removed if you later install another PostgreSQL-based product. Do not use this package for upgrades or migrations, or if you are going to maintain several installations on the same system.

- Custom installation. You can select any packages required for your purposes, including development packages. This option needs manual configuration, so a good grasp of Linux and understanding of PostgreSQL architecture are required. This is the only option to choose if you are going to use Postgres Pro in one of the following scenarios:

  - Install several Postgres Pro versions side by side, or together with other PostgreSQL-based products.

  - Perform an upgrade from a previous version, or migrate from a different PostgreSQL-based product.

  - Control Postgres Pro server execution using high availability software, such as pacemaker, instead of the standard system service management facility.

### 16.1.1. Supported Linux Distributions

Postgres Pro binary packages are available for the following Linux-based systems:

- Red Hat Enterprise Linux (RHEL) systems and its derivatives: CentOS 6/7/8, Red Hat Enterprise Linux 6/7/8, Oracle Linux 6/7, Rosa Enterprise Linux Server 7, ROSA COBALT (server edition) based on Rosa platform 7, Red OS Murom 7, GosLinux 7, MSVSphere 6.3, AlterOS 7.5

- Debian-based systems: Debian 8/9/10, Ubuntu 16.04/18.04/19.04/19.10, Astra Linux Smolensk 1.5/1.6, Astra Linux Orel 2.12

- ALT Linux 7.0/8/9, ALT Linux SPT 7.0

- SUSE Linux Enterprise Server (SLES) 11/12/15

### Note

Postgres Pro binary packages rely on the tzdata library provided by the operating system, so you must ensure that the latest available version is installed. If tzdata is outdated, the time in your database may be incorrect.

### 16.1.2. Quick Installation and Setup

If you only need to install a single Postgres Pro instance and are not going to use any other PostgreSQL-based products on your system, you can use the quick installation mode. The typical process is as follows:

1. Add the package repository required for your operating system. You can find the exact repositories and commands for each supported Linux distribution on the Download page for the selected Postgres Pro version.

2. Install the `postgrespro-std-11` package. It will bring all the required components via dependencies, create the default database, start the database server, as well as enable server autostart at system boot and make all the provided programs available in `PATH`. In the quick installation mode, the database cluster is initialized with checksums enabled.

Once the installation completes, you can launch psql on behalf of the `postgres` user and connect to the newly created database, which is located in the `/var/lib/pgpro/std-11/data` directory.

Since the default database is created using the pg-setup script, the path to its data directory is stored in the `/etc/default/postgrespro-std-11` file. All the subsequent pg-setup commands, as well as any commands that manage Postgres Pro service, affect this database only.

### 16.1.3. Custom Installation

Splitting the distribution into multiple packages enables customizing the installation for different purposes: database servers, client systems, or development workstations. Custom installations need to be configured manually, but give you more flexibility in using the product. You can install several Postgres Pro versions side by side, as well as together with other PostgreSQL-based products. In particular, this may be required when performing upgrades, or migrating from a different PostgreSQL-based product.

To perform a custom installation, complete the following steps:

1. Add the package repository required for your operating system. You can find the exact repositories and commands for each supported Linux distribution on the Download page for the selected Postgres Pro version.

2. Choose Postgres Pro packages required for your purposes and install them using the standard installation commands for your Linux distribution. The available packages are listed in Table 16.1.

   As a result, all files get installed into the `/opt/pgpro/std-11` directory.

3. Run pg-wrapper as root to make the installed client and server programs available via `PATH` and add SQL man pages to the man page configuration file. This utility is provided in the `postgrespro-std-11-client` package.

       /opt/pgpro/std-11/bin/pg-wrapper links update

   For details on how to handle possible conflicts, see pg-wrapper description.

4. If you chose to install the `postgrespro-std-11-server` package, make sure to complete the following server setup:

   1. Create the default database by running the helper script pg-setup as root with the `initdb` option:

          /opt/pgpro/std-11/bin/pg-setup initdb [initdb_options]

      where `initdb_options` are regular initdb options.

      ### Note

      pg-setup initializes the database cluster with checksums enabled. If this is not what you expect, do not use pg-setup for cluster initialization and run initdb directly instead.

      The `pg-setup` script performs database administration operations as user `postgres`. If you do not specify any initdb options, the default database is created in the `/var/lib/pgpro/std-11/data` directory, using localization settings specified in the `LANG` environment variable for the current session. All the `LC_*` environment variables are ignored.

      Since the default database is created using the pg-setup script, the path to its data directory is stored in the `/etc/default/postgrespro-std-11` file. All the subsequent pg-setup commands, as well as any commands that manage Postgres Pro service, affect this database only.

   2. Start the server by running `pg-setup` as root, as follows:

          /opt/pgpro/std-11/bin/pg-setup service start

      Like vanilla PostgreSQL, Postgres Pro server runs on behalf of the `postgres` user.

      ### Note

      By default, automatic server startup is disabled, so you can manually control the database recovery after a system reboot. Optionally, you can configure the Postgres Pro server to start automatically. For details, see Section 16.1.3.2.

#### 16.1.3.1. Choosing the Packages to Install

The table below lists all the available Postgres Pro packages.

Table 16.1. Postgres Pro Packages

Package | Description
--- | ---
`postgrespro-std-11` | Top-level package that installs and configures Postgres Pro for server and client systems. Do not use this package for upgrades or migrations. ### Important Installing the `postgrespro-std-11` package can delete existing installations of Postgres Pro and PostgreSQL-based products. Similarly, this Postgres Pro installation may be automatically removed if you later install another PostgreSQL-based product.
`postgrespro-std-11-client` | Standard client applications, such as psql or pg_dump.
`postgrespro-std-11-libs` | Shared libraries required to deploy client applications, including libpq; runtime libraries for ECPG processor.
`postgrespro-std-11-server` | Postgres Pro server and PL/pgSQL server-side programming language.
`postgrespro-std-11-contrib` | Additional extensions and programs deployable on database servers.
`pg-probackup-std-11` | pg_probackup utility.
`postgrespro-std-11-devel` | Header files and libraries for developing client applications and server extensions. On Debian-based systems, this package is called `postgrespro-std-11-dev`.
`postgrespro-std-11-plperl` | Server-side programming language based on Perl.
`postgrespro-std-11-plpython` | Server-side programming language based on Python.
`postgrespro-std-11-plpython3` | Server-side programming language based on Python 3. This package is available on all Debian-based and ALT Linux systems, CentOS 6/7/8, Oracle Linux 6/7, SLES 12/15, RHEL 6/7/8, Astra Linux Orel 2.12, and Astra Linux Smolensk 1.5/1.6.
`postgrespro-std-11-pltcl` | Server-side programming language based on Tcl.
`postgrespro-std-11-docs` | Documentation (English).
`postgrespro-std-11-docs-ru` | Documentation (Russian).
`postgrespro-std-11-test` | Test scripts for the server. This package is only available on RHEL-based and SUSE systems.
`postgrespro-std-11-jit` | This package provides support for Just-in-Time (JIT) compilation. This package is only available for the supported Debian and Ubuntu systems, Astra Linux Smolensk 1.6, Astra Linux Orel 2.12, ALT Linux 8, CentOS 7/8, SLES 15, and RHEL 7/8. To learn more about enabling and using JIT, see Chapter 31.

Besides, there are separate packages providing several external modules that have been pre-built for compatibility with Postgres Pro:

Package | Description
--- | ---
`libzstd` | A library for fast lossless data compression.
`mamonsu` | A monitoring agent for collecting Postgres Pro and system metrics.
`pg-repack-std-11` | Postgres Pro extension and utility for reorganizing tables.
`pgpro-pgbadger` | Postgres Pro log analyzer that provides detailed reports and graphs.
`pgbouncer` | Connection pooler for Postgres Pro.
`zstd` | Command-line utility for the `libzstd` library.

Additionally, Postgres Pro provides separate packages with debug information for some operating systems:

- On Debian-based systems, see the `postgrespro-std-11-dbg` package.

- On RHEL-based systems, see the `postgrespro-std-11-debuginfo` package.

- On ALT Linux, all packages containing binary files have the corresponding `-debuginfo` packages.

Server installations require at least the following packages:

- `postgrespro-std-11-server`

- `postgrespro-std-11-client`

- `postgrespro-std-11-libs`

To use additional Postgres Pro extensions, you must also install the `postgrespro-std-11-contrib` package. On Debian-based systems, `postgrespro-std-11-server` package depends on `postgrespro-std-11-contrib` package, so the latter must always be installed together with the server.

For client installations, it is usually enough to install the `postgrespro-std-11-client` and `postgrespro-std-11-libs` packages. If you use custom applications and do not need standard client utilities such as psql, you can install the `postgrespro-std-11-libs` package only.

Development workstations require at least the following packages:

- `postgrespro-std-11-libs`

- `postgrespro-std-11-devel`/ `postgrespro-std-11-dev`

You may also want to install and configure the server with a test database on development systems. For details on additional configuration that may be required, Section 16.1.4.

#### 16.1.3.2. Enabling Automatic Server Startup

If you are running a custom installation, automatic server startup is disabled by default. Once the default database is created, you can configure the server to start automatically upon system boot using service management solutions available in your operating system or third-party high-availability software. To facilitate this task, `postgrespro-std-11-server` package provides the pg-setup script, which is installed in the `/opt/pgpro/std-11/bin` directory.

To enable server autostart, run the pg-setup script with the following options:

    pg-setup service enable

If required, you can disable server autostart using the same script:

    pg-setup service disable

Alternatively, you can use system service management solutions directly by running the autostart scripts for SysV-style init.d and systemd provided in the `postgrespro-std-11-server` package. Depending on your Linux distribution, Postgres Pro supports different service management solutions:

Linux Distribution | Provided Scripts
--- | ---
RHEL 7, SLES 12.1 | systemd unit file
RHEL 6 and compatible distributions, SLES 11, ALT Linux 6 | SysV-style init.d script
Debian, Ubuntu, ALT Linux 7/8 | Both systemd unit file and SysV-style init.d script

To use systemd for automatic server startup, run the following command:

    systemctl enable postgrespro-std-11.service

To use SysV-style init.d script:

- On RHEL 6, SLES 11, and ALT Linux systems, use `chkconfig` command to add the `postgrespro-std-11` script to the appropriate runlevel. See `chkconfig` man page for the exact syntax.

- On Debian systems, use `update-rc.d`. See the corresponding man page for details.

### 16.1.4. Setting up Development Workstations

While installing `postgrespro-std-11-libs` and `postgrespro-std-11-devel`/ `postgrespro-std-11-dev` packages may be enough, it is usually convenient to have the server set up on the development system. For quick setup, you can install `postgrespro-std-11` package, which automatically configures the provided client and server programs and creates the default database. However, if you are going to use several PostgreSQL-based products simultaneously, follow the custom installation instructions in Section 16.1.3.

To compile programs with Postgres Pro libraries using the pg_config utility shipped with Postgres Pro, make sure it appears before the path to other pg_config versions, if any. Note that on RHEL-based systems pg_config is not added to `PATH` automatically. If you do not have any other pg_config versions on your system, you can use pg-wrapper provided in the `postgrespro-std-11-client` package to create a symbolic link to pg_config in the standard binary directory.

To compile programs using pkg-config command, add the `/opt/pgpro/std-11/lib/pkgconfig/` path to the `PKG_CONFIG_PATH` environment variable.

If you would like to compile Postgres Pro extensions that support JIT inlining, make sure to meet the following additional requirements:

- Install LLVM development package and Clang compiler. You must choose the packages of the same version that was used for the `postgrespro-std-11-jit` to be installed on the server. To determine the required version for the current Postgres Pro release, check the `CLANG` value in the `/opt/pgpro/std-11/lib/pgxs/src/Makefile.global` file.

- When running `make` or `make install` commands, specify the `with-llvm=yes` option to compile and install bitcode files for your extension. By default, bitcode compilation is disabled as it depends on Clang compiler availability.

#### 16.1.4.1. Using Third-Party Programs with Postgres Pro

To use Postgres Pro server with a client program provided with a third-party product, you can install the version of PostgreSQL libraries that was used to compile this program. For example, if this program is provided with vanilla PostgreSQL, you may need to install the `libpq` or `postgresql-libs` packages available for your Linux distribution. In this case, the program may not be able to use some new features of Postgres Pro server, but it is probably not designed to use them anyway.

If you prefer to use Postgres Pro libraries with a third-party program, or would like to enable support for a new feature that does not require client application change, such as SCRAM authentication, you can recompile your program with Postgres Pro libraries.

### Important

If the program is compiled with one version of libpq but used with another, its stable work cannot be guaranteed.

If you are creating `.rpm` or `.deb` packages for your program, it is recommended to do the following:

1. Add `/opt/pgpro/std-11/bin` to `PATH` inside your build scripts (`.spec` files or `debian/rules`).

2. Specify `postgrespro-std-11-dev` in the `BuildDepends` or `BuildRequires` tags for your program.

Thus, you can ensure that your package build process calls the right version of pg_config whenever the source package is rebuilt.

### 16.1.5. Configuring Multiple Postgres Pro Instances

To set up several Postgres Pro server instances with different data directories on Linux, do the following:

1. Install and configure Postgres Pro as explained in Section 16.1.2 or Section 16.1.3.

2. Once the first default database is created, run initdb specifying the path to a different data directory and any other parameters required to initialize another server instance.

3. Specify different ports for your server instances in the corresponding `postgresql.conf` files to avoid conflicts.

4. If required, configure automatic server startup, as follows:

   1. Create a copy of `/etc/init.d/postgrespro-std-11` or `/lib/systemd/system/postgrespro-std-11.service` with a different name, specifying the path to the data directory.

   2. Enable automatic server startup using the provided autostart scripts for your system service management facility instead of `pg-setup`, as described in Section 16.1.3.2. Make sure to use the renamed copies of the scripts you created in step 1.