Introducing our new CEO Don Johnson - Read More

bitnami/postgresql

Verified Publisher

By VMware

Updated about 20 hours ago

Bitnami container image for PostgreSQL

Image
Databases & Storage
Integration & Delivery
Security
319

1B+

Bitnami package for PostgreSQL

What is PostgreSQL?

PostgreSQL (Postgres) is an open source object-relational database known for reliability and data integrity. ACID-compliant, it supports foreign keys, joins, views, triggers and stored procedures.

Overview of PostgreSQL Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

docker run --name postgresql bitnami/postgresql:latest

Warning: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the Configuration section for a more secure deployment.

Why use Bitnami Images?

  • Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
  • With Bitnami images the latest bug fixes and features are available as soon as possible.
  • Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
  • All our images are based on minideb -a minimalist Debian based container image that gives you a small base container image and the familiarity of a leading Linux distribution- or scratch -an explicitly empty image-.
  • All Bitnami images available in Docker Hub are signed with Notation. Check this post to know how to verify the integrity of the images.
  • Bitnami container images are released on a regular basis with the latest distribution packages available.

Looking to use PostgreSQL in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.

How to deploy PostgreSQL in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami PostgreSQL Chart GitHub repository.

Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Why use a non-root container?

Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.

Only latest stable branch maintained in the free Bitnami catalog

Starting December 10th 2024, only the latest stable branch of any container will receive updates in the free Bitnami catalog. To access up-to-date releases for all upstream-supported branches, consider upgrading to Bitnami Premium. Previous versions already released will not be deleted. They are still available to pull from DockerHub.

Please check the Bitnami Premium page in our partner Arrow Electronics for more information.

Supported tags and respective Dockerfile links

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

You can see the equivalence between the different tags by taking a look at the tags-info.yaml file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml.

Subscribe to project updates by watching the bitnami/containers GitHub repo.

Get this image

The recommended way to get the Bitnami PostgreSQL Docker Image is to pull the prebuilt image from the Docker Hub Registry.

docker pull bitnami/postgresql:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

docker pull bitnami/postgresql:[TAG]

If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build command. Remember to replace the APP, VERSION and OPERATING-SYSTEM path placeholders in the example command below with the correct values.

git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .

Persisting your database

If you remove the container all your data and configurations will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a directory at the /bitnami/postgresql path. If the mounted directory is empty, it will be initialized on the first run.

docker run \
    -v /path/to/postgresql-persistence:/bitnami/postgresql \
    bitnami/postgresql:latest

or by modifying the docker-compose.yml file present in this repository:

services:
  postgresql:
  ...
    volumes:
      - /path/to/postgresql-persistence:/bitnami/postgresql
  ...

NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID 1001.

Connecting to other containers

Using Docker container networking, a PostgreSQL server running inside a container can easily be accessed by your application containers.

Containers attached to the same network can communicate with each other using the container name as the hostname.

Using the Command Line

In this example, we will create a PostgreSQL client instance that will connect to the server instance that is running on the same docker network as the client.

Step 1: Create a network

docker network create app-tier --driver bridge

Step 2: Launch the PostgreSQL server instance

Use the --network app-tier argument to the docker run command to attach the PostgreSQL container to the app-tier network.

docker run -d --name postgresql-server \
    --network app-tier \
    bitnami/postgresql:latest

Step 3: Launch your PostgreSQL client instance

Finally we create a new container instance to launch the PostgreSQL client and connect to the server created in the previous step:

docker run -it --rm \
    --network app-tier \
    bitnami/postgresql:latest psql -h postgresql-server -U postgres
Using a Docker Compose file

When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new bridge network named app-tier. In this example we assume that you want to connect to the PostgreSQL server from your own custom application image which is identified in the following snippet by the service name myapp.

version: '2'

networks:
  app-tier:
    driver: bridge

services:
  postgresql:
    image: 'bitnami/postgresql:latest'
    networks:
      - app-tier
  myapp:
    image: 'YOUR_APPLICATION_IMAGE'
    networks:
      - app-tier

IMPORTANT:

  1. Please update the YOUR_APPLICATION_IMAGE_ placeholder in the above snippet with your application image
  2. In your application container, use the hostname postgresql to connect to the PostgreSQL server

Launch the containers using:

docker-compose up -d

Configuration

Environment variables

Customizable environment variables

NameDescriptionDefault Value
POSTGRESQL_VOLUME_DIRPersistence base directory/bitnami/postgresql
POSTGRESQL_DATA_DIRPostgreSQL data directory${POSTGRESQL_VOLUME_DIR}/data
POSTGRESQL_EXTRA_FLAGSExtra flags for PostgreSQL initializationnil
POSTGRESQL_INIT_MAX_TIMEOUTMaximum initialization waiting timeout60
POSTGRESQL_PGCTLTIMEOUTMaximum waiting timeout for pg_ctl commands60
POSTGRESQL_SHUTDOWN_MODEDefault mode for pg_ctl stop commandfast
POSTGRESQL_CLUSTER_APP_NAMEReplication cluster default application namewalreceiver
POSTGRESQL_DATABASEDefault PostgreSQL databasepostgres
POSTGRESQL_INITDB_ARGSOptional args for PostreSQL initdb operationnil
ALLOW_EMPTY_PASSWORDAllow password-less accessno
POSTGRESQL_INITDB_WAL_DIROptional init db wal directorynil
POSTGRESQL_MASTER_HOSTPostgreSQL master host (used by slaves)nil
POSTGRESQL_MASTER_PORT_NUMBERPostgreSQL master host port (used by slaves)5432
POSTGRESQL_NUM_SYNCHRONOUS_REPLICASNumber of PostgreSQL replicas that should use synchronous replication0
POSTGRESQL_SYNCHRONOUS_REPLICAS_MODEPostgreSQL synchronous replication mode (values: empty, FIRST, ANY)nil
POSTGRESQL_PORT_NUMBERPostgreSQL port number5432
POSTGRESQL_ALLOW_REMOTE_CONNECTIONSModify pg_hba settings so users can access from the outsideyes
POSTGRESQL_REPLICATION_MODEPostgreSQL replication mode (values: master, slave)master
POSTGRESQL_REPLICATION_USERPostgreSQL replication usernil
POSTGRESQL_REPLICATION_USE_PASSFILEUse PGPASSFILE instead of PGPASSWORDno
POSTGRESQL_REPLICATION_PASSFILE_PATHPath to store passfile${POSTGRESQL_CONF_DIR}/.pgpass
POSTGRESQL_SYNCHRONOUS_COMMIT_MODEEnable synchronous replication in slaves (number defined by POSTGRESQL_NUM_SYNCHRONOUS_REPLICAS)on
POSTGRESQL_FSYNCEnable fsync in write ahead logson
POSTGRESQL_USERNAMEPostgreSQL default usernamepostgres
POSTGRESQL_ENABLE_LDAPEnable LDAP for PostgreSQL authenticationno
POSTGRESQL_LDAP_URLPostgreSQL LDAP server url (requires POSTGRESQL_ENABLE_LDAP=yes)nil
POSTGRESQL_LDAP_PREFIXPostgreSQL LDAP prefix (requires POSTGRESQL_ENABLE_LDAP=yes)nil
POSTGRESQL_LDAP_SUFFIXPostgreSQL LDAP suffix (requires POSTGRESQL_ENABLE_LDAP=yes)nil
POSTGRESQL_LDAP_SERVERPostgreSQL LDAP server (requires POSTGRESQL_ENABLE_LDAP=yes)nil
POSTGRESQL_LDAP_PORTPostgreSQL LDAP port (requires POSTGRESQL_ENABLE_LDAP=yes)nil
POSTGRESQL_LDAP_SCHEMEPostgreSQL LDAP scheme (requires POSTGRESQL_ENABLE_LDAP=yes)nil
POSTGRESQL_LDAP_TLSPostgreSQL LDAP tls setting (requires POSTGRESQL_ENABLE_LDAP=yes)nil
POSTGRESQL_LDAP_BASE_DNPostgreSQL LDAP base DN settings (requires POSTGRESQL_ENABLE_LDAP=yes)nil
POSTGRESQL_LDAP_BIND_DNPostgreSQL LDAP bind DN settings (requires POSTGRESQL_ENABLE_LDAP=yes)nil
POSTGRESQL_LDAP_BIND_PASSWORDPostgreSQL LDAP bind password (requires POSTGRESQL_ENABLE_LDAP=yes)nil
POSTGRESQL_LDAP_SEARCH_ATTRPostgreSQL LDAP search attribute (requires POSTGRESQL_ENABLE_LDAP=yes)nil
POSTGRESQL_LDAP_SEARCH_FILTERPostgreSQL LDAP search filter (requires POSTGRESQL_ENABLE_LDAP=yes)nil
POSTGRESQL_INITSCRIPTS_USERNAMEUsername for the psql scripts included in /docker-entrypoint.initdb$POSTGRESQL_USERNAME
POSTGRESQL_PASSWORDPassword for the PostgreSQL created usernil
POSTGRESQL_POSTGRES_PASSWORDPassword for the PostgreSQL postgres usernil
POSTGRESQL_REPLICATION_PASSWORDPassword for the PostgreSQL replication usernil
POSTGRESQL_INITSCRIPTS_PASSWORDPassword for the PostgreSQL init scripts user$POSTGRESQL_PASSWORD
POSTGRESQL_ENABLE_TLSWhether to enable TLS for traffic or notno
POSTGRESQL_TLS_CERT_FILEFile containing the certificate for the TLS trafficnil
POSTGRESQL_TLS_KEY_FILEFile containing the key for certificatenil
POSTGRESQL_TLS_CA_FILEFile containing the CA of the certificatenil
POSTGRESQL_TLS_CRL_FILEFile containing a Certificate Revocation Listnil
POSTGRESQL_TLS_PREFER_SERVER_CIPHERSWhether to use the server TLS cipher preferences rather than the clientyes
POSTGRESQL_SHARED_PRELOAD_LIBRARIESList of libraries to preload at PostgreSQL initializationpgaudit
POSTGRESQL_PGAUDIT_LOGComma-separated list of actions to log with pgauditnil
POSTGRESQL_PGAUDIT_LOG_CATALOGEnable pgaudit log catalog (pgaudit.log_catalog setting)nil
POSTGRESQL_PGAUDIT_LOG_PARAMETEREnable pgaudit log parameter (pgaudit.log_parameter setting)nil
POSTGRESQL_LOG_CONNECTIONSAdd a log entry per user connectionnil
POSTGRESQL_LOG_DISCONNECTIONSAdd a log entry per user disconnectionnil
POSTGRESQL_LOG_HOSTNAMELog the client host name when accessingnil
POSTGRESQL_CLIENT_MIN_MESSAGESSet log level of errors to send to the clienterror
POSTGRESQL_LOG_LINE_PREFIXSet the format of the log linesnil
POSTGRESQL_LOG_TIMEZONESet the log timezonenil
POSTGRESQL_TIMEZONESet the timezonenil
POSTGRESQL_MAX_CONNECTIONSSet the maximum amount of connectionsnil
POSTGRESQL_TCP_KEEPALIVES_IDLESet the TCP keepalive idle timenil
POSTGRESQL_TCP_KEEPALIVES_INTERVALSet the TCP keepalive interval timenil
POSTGRESQL_TCP_KEEPALIVES_COUNTSet the TCP keepalive countnil
POSTGRESQL_STATEMENT_TIMEOUTSet the SQL statement timeoutnil
POSTGRESQL_PGHBA_REMOVE_FILTERSComma-separated list of strings for removing pg_hba.conf lines (example: md5, local)nil
POSTGRESQL_USERNAME_CONNECTION_LIMITSet the user connection limitnil
POSTGRESQL_POSTGRES_CONNECTION_LIMITSet the postgres user connection limitnil
POSTGRESQL_WAL_LEVELSet the write-ahead log levelreplica
POSTGRESQL_DEFAULT_TOAST_COMPRESSIONSet the postgres default compressionnil
POSTGRESQL_PASSWORD_ENCRYPTIONSet the passwords encryption methodnil
POSTGRESQL_DEFAULT_TRANSACTION_ISOLATIONSet transaction isolationnil
POSTGRESQL_AUTOCTL_CONF_DIRPath to the configuration dir for the pg_autoctl command${POSTGRESQL_AUTOCTL_VOLUME_DIR}/.config
POSTGRESQL_AUTOCTL_MODEpgAutoFailover node type, valid values [monitor, postgres]postgres
POSTGRESQL_AUTOCTL_MONITOR_HOSTHostname for the monitor componentmonitor
POSTGRESQL_AUTOCTL_HOSTNAMEHostname by which postgres is reachable$(hostname --fqdn)

Read-only environment variables

NameDescriptionValue
POSTGRESQL_BASE_DIRPostgreSQL installation directory/opt/bitnami/postgresql
POSTGRESQL_DEFAULT_CONF_DIRPostgreSQL configuration directory$POSTGRESQL_BASE_DIR/conf.default
POSTGRESQL_CONF_DIRPostgreSQL configuration directory$POSTGRESQL_BASE_DIR/conf
POSTGRESQL_MOUNTED_CONF_DIRPostgreSQL mounted configuration directory$POSTGRESQL_VOLUME_DIR/conf
POSTGRESQL_CONF_FILEPostgreSQL configuration file$POSTGRESQL_CONF_DIR/postgresql.conf
POSTGRESQL_PGHBA_FILEPostgreSQL pg_hba file$POSTGRESQL_CONF_DIR/pg_hba.conf
POSTGRESQL_RECOVERY_FILEPostgreSQL recovery file$POSTGRESQL_DATA_DIR/recovery.conf
POSTGRESQL_LOG_DIRPostgreSQL logs directory`$POSTGRESQL_

Note: the README for this container is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/containers/blob/main/bitnami/postgresql/README.md

Docker Pull Command

docker pull bitnami/postgresql
Bitnami