1. Configuration

   The first step of the installation procedure is to configure the source tree for your system and choose the options you would like. This is done by running theconfigure script. For a default installation simply enter:

   ./configure

   This script will run a number of tests to determine values for various system dependent variables and detect any quirks of your operating system, and finally will create several files in the build tree to record what it found. You can also runconfigure in a directory outside the source tree, if you want to keep the build directory separate. This procedure is also called aVPATH build. Here's how:

   mkdir build_dircd build_dir/path/to/source/tree/configure [options go here]make

   The default configuration will build the server and utilities, as well as all client applications and interfaces that require only a C compiler. All files will be installed under/usr/local/pgsql by default.

   You can customize the build and installation process by supplying one or more of the following command line options toconfigure:

   --prefix=PREFIX

   Install all files under the directoryPREFIX instead of/usr/local/pgsql. The actual files will be installed into various subdirectories; no files will ever be installed directly into thePREFIX directory.

   If you have special needs, you can also customize the individual subdirectories with the following options. However, if you leave these with their defaults, the installation will be relocatable, meaning you can move the directory after installation. (Theman anddoc locations are not affected by this.)

   For relocatable installs, you might want to useconfigure's--disable-rpath option. Also, you will need to tell the operating system how to find the shared libraries.

   --exec-prefix=EXEC-PREFIX

   You can install architecture-dependent files under a different prefix,EXEC-PREFIX, than whatPREFIX was set to. This can be useful to share architecture-independent files between hosts. If you omit this, thenEXEC-PREFIX is set equal toPREFIX and both architecture-dependent and independent files will be installed under the same tree, which is probably what you want.

   --bindir=DIRECTORY

   Specifies the directory for executable programs. The default isEXEC-PREFIX/bin, which normally means/usr/local/pgsql/bin.

   --sysconfdir=DIRECTORY

   Sets the directory for various configuration files,PREFIX/etc by default.

   --libdir=DIRECTORY

   Sets the location to install libraries and dynamically loadable modules. The default isEXEC-PREFIX/lib.

   --includedir=DIRECTORY

   Sets the directory for installing C and C++ header files. The default isPREFIX/include.

   --datarootdir=DIRECTORY

   Sets the root directory for various types of read-only data files. This only sets the default for some of the following options. The default isPREFIX/share.

   --datadir=DIRECTORY

   Sets the directory for read-only data files used by the installed programs. The default isDATAROOTDIR. Note that this has nothing to do with where your database files will be placed.

   --localedir=DIRECTORY

   Sets the directory for installing locale data, in particular message translation catalog files. The default isDATAROOTDIR/locale.

   --mandir=DIRECTORY

   The man pages that come withPostgreSQL will be installed under this directory, in their respectivemanx subdirectories. The default isDATAROOTDIR/man.

   --docdir=DIRECTORY

   Sets the root directory for installing documentation files, except"man" pages. This only sets the default for the following options. The default value for this option isDATAROOTDIR/doc/postgresql.

   --htmldir=DIRECTORY

   The HTML-formatted documentation forPostgreSQL will be installed under this directory. The default isDATAROOTDIR.

   Note: Care has been taken to make it possible to installPostgreSQL into shared installation locations (such as/usr/local/include) without interfering with the namespace of the rest of the system. First, the string"/postgresql" is automatically appended todatadir,sysconfdir, anddocdir, unless the fully expanded directory name already contains the string"postgres" or"pgsql". For example, if you choose/usr/local as prefix, the documentation will be installed in/usr/local/doc/postgresql, but if the prefix is/opt/postgres, then it will be in/opt/postgres/doc. The public C header files of the client interfaces are installed intoincludedir and are namespace-clean. The internal header files and the server header files are installed into private directories underincludedir. See the documentation of each interface for information about how to access its header files. Finally, a private subdirectory will also be created, if appropriate, underlibdir for dynamically loadable modules.

   --with-extra-version=STRING

   AppendSTRING to the PostgreSQL version number. You can use this, for example, to mark binaries built from unreleased Git snapshots or containing custom patches with an extra version string such as agit describe identifier or a distribution package release number.

   --with-includes=DIRECTORIES

   DIRECTORIES is a colon-separated list of directories that will be added to the list the compiler searches for header files. If you have optional packages (such as GNUReadline) installed in a non-standard location, you have to use this option and probably also the corresponding--with-libraries option.

   Example:--with-includes=/opt/gnu/include:/usr/sup/include.

   --with-libraries=DIRECTORIES

   DIRECTORIES is a colon-separated list of directories to search for libraries. You will probably have to use this option (and the corresponding--with-includes option) if you have packages installed in non-standard locations.

   Example:--with-libraries=/opt/gnu/lib:/usr/sup/lib.

   --enable-nls[=LANGUAGES]

   Enables Native Language Support (NLS), that is, the ability to display a program's messages in a language other than English.LANGUAGES is an optional space-separated list of codes of the languages that you want supported, for example--enable-nls='de fr'. (The intersection between your list and the set of actually provided translations will be computed automatically.) If you do not specify a list, then all available translations are installed.

   To use this option, you will need an implementation of theGettext API; see above.

   --with-pgport=NUMBER

   SetNUMBER as the default port number for server and clients. The default is 5432. The port can always be changed later on, but if you specify it here then both server and clients will have the same default compiled in, which can be very convenient. Usually the only good reason to select a non-default value is if you intend to run multiplePostgreSQL servers on the same machine.

   --with-perl

   Build thePL/Perl server-side language.

   --with-python

   Build thePL/Python server-side language.

   --with-tcl

   Build thePL/Tcl server-side language.

   --with-tclconfig=DIRECTORY

   Tcl installs the filetclConfig.sh, which contains configuration information needed to build modules interfacing to Tcl. This file is normally found automatically at a well-known location, but if you want to use a different version of Tcl you can specify the directory in which to look for it.

   --with-gssapi

   Build with support for GSSAPI authentication. On many systems, the GSSAPI (usually a part of the Kerberos installation) system is not installed in a location that is searched by default (e.g.,/usr/include,/usr/lib), so you must use the options--with-includes and--with-libraries in addition to this option.configure will check for the required header files and libraries to make sure that your GSSAPI installation is sufficient before proceeding.

   --with-krb-srvnam=NAME

   The default name of the Kerberos service principal used by GSSAPI.postgres is the default. There's usually no reason to change this unless you have a Windows environment, in which case it must be set to upper casePOSTGRES.

   --with-openssl

   Build with support forSSL (encrypted) connections. This requires theOpenSSL package to be installed.configure will check for the required header files and libraries to make sure that yourOpenSSL installation is sufficient before proceeding.

   --with-pam

   Build withPAM (Pluggable Authentication Modules) support.

   --with-ldap

   Build withLDAP support for authentication and connection parameter lookup (seeSection 31.17 andSection 19.3.7 for more information). On Unix, this requires theOpenLDAP package to be installed. On Windows, the defaultWinLDAP library is used.configure will check for the required header files and libraries to make sure that yourOpenLDAP installation is sufficient before proceeding.

   --without-readline

   Prevents use of theReadline library (andlibedit as well). This option disables command-line editing and history inpsql, so it is not recommended.

   --with-libedit-preferred

   Favors the use of the BSD-licensedlibedit library rather than GPL-licensedReadline. This option is significant only if you have both libraries installed; the default in that case is to useReadline.

   --with-bonjour

   Build with Bonjour support. This requires Bonjour support in your operating system. Recommended on OS X.

   --with-uuid=LIBRARY

   Build theuuid-ossp module (which provides functions to generate UUIDs), using the specified UUID library.LIBRARY must be one of:

   • bsd to use the UUID functions found in FreeBSD, NetBSD, and some other BSD-derived systems

   • e2fs to use the UUID library created by thee2fsprogs project; this library is present in most Linux systems and in OS X, and can be obtained for other platforms as well

   • ossp to use theOSSP UUID library

   --with-ossp-uuid

   Obsolete equivalent of--with-uuid=ossp.

   --with-libxml

   Build with libxml (enables SQL/XML support). Libxml version 2.6.23 or later is required for this feature.

   Libxml installs a programxml2-config that can be used to detect the required compiler and linker options. PostgreSQL will use it automatically if found. To specify a libxml installation at an unusual location, you can either set the environment variableXML2_CONFIG to point to thexml2-config program belonging to the installation, or use the options--with-includes and--with-libraries.

   --with-libxslt

   Use libxslt when building thexml2 module.xml2 relies on this library to perform XSL transformations of XML.

   --disable-integer-datetimes

   Disable support for 64-bit integer storage for timestamps and intervals, and store datetime values as floating-point numbers instead. Floating-point datetime storage was the default inPostgreSQL releases prior to 8.4, but it is now deprecated, because it does not support microsecond precision for the full range oftimestamp values. However, integer-based datetime storage requires a 64-bit integer type. Therefore, this option can be used when no such type is available, or for compatibility with applications written for prior versions ofPostgreSQL. SeeSection 8.5 for more information.

   --disable-float4-byval

   Disable passing float4 values"by value", causing them to be passed"by reference" instead. This option costs performance, but may be needed for compatibility with old user-defined functions that are written in C and use the"version 0" calling convention. A better long-term solution is to update any such functions to use the"version 1" calling convention.

   --disable-float8-byval

   Disable passing float8 values"by value", causing them to be passed"by reference" instead. This option costs performance, but may be needed for compatibility with old user-defined functions that are written in C and use the"version 0" calling convention. A better long-term solution is to update any such functions to use the"version 1" calling convention. Note that this option affects not only float8, but also int8 and some related types such as timestamp. On 32-bit platforms,--disable-float8-byval is the default and it is not allowed to select--enable-float8-byval.

   --with-segsize=SEGSIZE

   Set thesegment size, in gigabytes. Large tables are divided into multiple operating-system files, each of size equal to the segment size. This avoids problems with file size limits that exist on many platforms. The default segment size, 1 gigabyte, is safe on all supported platforms. If your operating system has"largefile" support (which most do, nowadays), you can use a larger segment size. This can be helpful to reduce the number of file descriptors consumed when working with very large tables. But be careful not to select a value larger than is supported by your platform and the file systems you intend to use. Other tools you might wish to use, such astar, could also set limits on the usable file size. It is recommended, though not absolutely required, that this value be a power of 2. Note that changing this value requires an initdb.

   --with-blocksize=BLOCKSIZE

   Set theblock size, in kilobytes. This is the unit of storage and I/O within tables. The default, 8 kilobytes, is suitable for most situations; but other values may be useful in special cases. The value must be a power of 2 between 1 and 32 (kilobytes). Note that changing this value requires an initdb.

   --with-wal-segsize=SEGSIZE

   Set theWAL segment size, in megabytes. This is the size of each individual file in the WAL log. It may be useful to adjust this size to control the granularity of WAL log shipping. The default size is 16 megabytes. The value must be a power of 2 between 1 and 64 (megabytes). Note that changing this value requires an initdb.

   --with-wal-blocksize=BLOCKSIZE

   Set theWAL block size, in kilobytes. This is the unit of storage and I/O within the WAL log. The default, 8 kilobytes, is suitable for most situations; but other values may be useful in special cases. The value must be a power of 2 between 1 and 64 (kilobytes). Note that changing this value requires an initdb.

   --disable-spinlocks

   Allow the build to succeed even ifPostgreSQL has no CPU spinlock support for the platform. The lack of spinlock support will result in poor performance; therefore, this option should only be used if the build aborts and informs you that the platform lacks spinlock support. If this option is required to buildPostgreSQL on your platform, please report the problem to thePostgreSQL developers.

   --disable-thread-safety

   Disable the thread-safety of client libraries. This prevents concurrent threads inlibpq andECPG programs from safely controlling their private connection handles.

   --with-system-tzdata=DIRECTORY

   PostgreSQL includes its own time zone database, which it requires for date and time operations. This time zone database is in fact compatible with the IANA time zone database provided by many operating systems such as FreeBSD, Linux, and Solaris, so it would be redundant to install it again. When this option is used, the system-supplied time zone database inDIRECTORY is used instead of the one included in the PostgreSQL source distribution.DIRECTORY must be specified as an absolute path./usr/share/zoneinfo is a likely directory on some operating systems. Note that the installation routine will not detect mismatching or erroneous time zone data. If you use this option, you are advised to run the regression tests to verify that the time zone data you have pointed to works correctly withPostgreSQL.

   This option is mainly aimed at binary package distributors who know their target operating system well. The main advantage of using this option is that the PostgreSQL package won't need to be upgraded whenever any of the many local daylight-saving time rules change. Another advantage is that PostgreSQL can be cross-compiled more straightforwardly if the time zone database files do not need to be built during the installation.

   --without-zlib

   Prevents use of theZlib library. This disables support for compressed archives inpg_dump andpg_restore. This option is only intended for those rare systems where this library is not available.

   --enable-debug

   Compiles all programs and libraries with debugging symbols. This means that you can run the programs in a debugger to analyze problems. This enlarges the size of the installed executables considerably, and on non-GCC compilers it usually also disables compiler optimization, causing slowdowns. However, having the symbols available is extremely helpful for dealing with any problems that might arise. Currently, this option is recommended for production installations only if you use GCC. But you should always have it on if you are doing development work or running a beta version.

   --enable-coverage

   If using GCC, all programs and libraries are compiled with code coverage testing instrumentation. When run, they generate files in the build directory with code coverage metrics. SeeSection 30.5 for more information. This option is for use only with GCC and when doing development work.

   --enable-profiling

   If using GCC, all programs and libraries are compiled so they can be profiled. On backend exit, a subdirectory will be created that contains thegmon.out file for use in profiling. This option is for use only with GCC and when doing development work.

   --enable-cassert

   Enablesassertion checks in the server, which test for many"cannot happen" conditions. This is invaluable for code development purposes, but the tests can slow down the server significantly. Also, having the tests turned on won't necessarily enhance the stability of your server! The assertion checks are not categorized for severity, and so what might be a relatively harmless bug will still lead to server restarts if it triggers an assertion failure. This option is not recommended for production use, but you should have it on for development work or when running a beta version.

   --enable-depend

   Enables automatic dependency tracking. With this option, the makefiles are set up so that all affected object files will be rebuilt when any header file is changed. This is useful if you are doing development work, but is just wasted overhead if you intend only to compile once and install. At present, this option only works with GCC.

   --enable-dtrace

   CompilesPostgreSQL with support for the dynamic tracing tool DTrace. SeeSection 27.4 for more information.

   To point to thedtrace program, the environment variableDTRACE can be set. This will often be necessary becausedtrace is typically installed under/usr/sbin, which might not be in the path.

   Extra command-line options for thedtrace program can be specified in the environment variableDTRACEFLAGS. On Solaris, to include DTrace support in a 64-bit binary, you must specifyDTRACEFLAGS="-64" to configure. For example, using the GCC compiler:

   ./configure CC='gcc -m64' --enable-dtrace DTRACEFLAGS='-64' ...

   Using Sun's compiler:

   ./configure CC='/opt/SUNWspro/bin/cc -xtarget=native64' --enable-dtrace DTRACEFLAGS='-64' ...

   --enable-tap-tests

   Enable tests using the Perl TAP tools. This requires a Perl installation and the Perl moduleIPC::Run. SeeSection 30.4 for more information.

   If you prefer a C compiler different from the oneconfigure picks, you can set the environment variableCC to the program of your choice. By default,configure will pickgcc if available, else the platform's default (usuallycc). Similarly, you can override the default compiler flags if needed with theCFLAGS variable.

   You can specify environment variables on theconfigure command line, for example:

   ./configure CC=/opt/bin/gcc CFLAGS='-O2 -pipe'

   Here is a list of the significant variables that can be set in this manner:

   BISON

   Bison program

   CC

   C compiler

   CFLAGS

   options to pass to the C compiler

   CPP

   C preprocessor

   CPPFLAGS

   options to pass to the C preprocessor

   DTRACE

   location of thedtrace program

   DTRACEFLAGS

   options to pass to thedtrace program

   FLEX

   Flex program

   LDFLAGS

   options to use when linking either executables or shared libraries

   LDFLAGS_EX

   additional options for linking executables only

   LDFLAGS_SL

   additional options for linking shared libraries only

   MSGFMT

   msgfmt program for native language support

   PERL

   Full path to the Perl interpreter. This will be used to determine the dependencies for building PL/Perl.

   PYTHON

   Full path to the Python interpreter. This will be used to determine the dependencies for building PL/Python. Also, whether Python 2 or 3 is specified here (or otherwise implicitly chosen) determines which variant of the PL/Python language becomes available. SeeSection 43.1 for more information.

   TCLSH

   Full path to the Tcl interpreter. This will be used to determine the dependencies for building PL/Tcl, and it will be substituted into Tcl scripts.

   XML2_CONFIG

   xml2-config program used to locate the libxml installation.

   Note: When developing code inside the server, it is recommended to use the configure options--enable-cassert (which turns on many run-time error checks) and--enable-debug (which improves the usefulness of debugging tools).

   If using GCC, it is best to build with an optimization level of at least-O1, because using no optimization (-O0) disables some important compiler warnings (such as the use of uninitialized variables). However, non-zero optimization levels can complicate debugging because stepping through compiled code will usually not match up one-to-one with source code lines. If you get confused while trying to debug optimized code, recompile the specific files of interest with-O0. An easy way to do this is by passing an option tomake:make PROFILE=-O0 file.o.

2. Build

   To start the build, type:

   make

   (Remember to useGNUmake.) The build will take a few minutes depending on your hardware. The last line displayed should be:

   All of PostgreSQL is successfully made. Ready to install.

   If you want to build everything that can be built, including the documentation (HTML and man pages), and the additional modules (contrib), type instead:

   make world

   The last line displayed should be:

   PostgreSQL, contrib and HTML documentation successfully made. Ready to install.

3. Regression Tests

   If you want to test the newly built server before you install it, you can run the regression tests at this point. The regression tests are a test suite to verify thatPostgreSQL runs on your machine in the way the developers expected it to. Type:

   make check

   (This won't work as root; do it as an unprivileged user.)Chapter 30 contains detailed information about interpreting the test results. You can repeat this test at any later time by issuing the same command.

4. Installing the Files

   Note: If you are upgrading an existing system be sure to readSection 17.6 which has instructions about upgrading a cluster.

   To installPostgreSQL enter:

   make install

   This will install files into the directories that were specified instep 1. Make sure that you have appropriate permissions to write into that area. Normally you need to do this step as root. Alternatively, you can create the target directories in advance and arrange for appropriate permissions to be granted.

   To install the documentation (HTML and man pages), enter:

   make install-docs

   If you built the world above, type instead:

   make install-world

   This also installs the documentation.

   You can usemake install-strip instead ofmake install to strip the executable files and libraries as they are installed. This will save some space. If you built with debugging support, stripping will effectively remove the debugging support, so it should only be done if debugging is no longer needed.install-strip tries to do a reasonable job saving space, but it does not have perfect knowledge of how to strip every unneeded byte from an executable file, so if you want to save all the disk space you possibly can, you will have to do manual work.

   The standard installation provides all the header files needed for client application development as well as for server-side program development, such as custom functions or data types written in C. (Prior toPostgreSQL 8.0, a separatemake install-all-headers command was needed for the latter, but this step has been folded into the standard install.)

   Client-only installation: If you want to install only the client applications and interface libraries, then you can use these commands:

   make -C src/bin installmake -C src/include installmake -C src/interfaces installmake -C doc install

   src/bin has a few binaries for server-only use, but they are small.

Uninstallation: To undo the installation use the commandmake uninstall. However, this will not remove any created directories.

Cleaning: After the installation you can free disk space by removing the built files from the source tree with the commandmake clean. This will preserve the files made by theconfigure program, so that you can rebuild everything withmake later on. To reset the source tree to the state in which it was distributed, usemake distclean. If you are going to build for several platforms within the same source tree you must do this and re-configure for each platform. (Alternatively, use a separate build tree for each platform, so that the source tree remains unmodified.)