Warning

Not this project is no longer maintained. Use edoburu/docker-pgbouncer instead.

PgBouncer Docker image

A very minimal PgBouncer Docker image based on Alpine Linux.

Features

• Tiny image size (about 10 MB)
• Fully configurable via environment variables
• Support for multiple databases
• Support for standalone user administration database
• Support for custom configuration file

Quickstart

docker run --rm \
    -e DATABASE_URL="postgres://<user>:<password>@<hostname>:<port>/<database_name>" \
    -e USER_<user>="<password>" \
    -p 6432:6432 \
    litehex/pgbouncer

Or add credentials separately:

docker run --rm \
  -e DB_NAME="<database-name>" \
  -e DB_USER="<password>" \
  -e DB_PASSWORD="<user>" \
  -e DB_HOST="<host>" \
  -p 6432:6432 \
  litehex/pgbouncer

Then you should be able to connect to PgBouncer:

psql "postgresql://<user>:<password>@127.0.0.1:6432/<database-name>"

Environment variables

To configure, please refer to official PgBouncer documentation and use them as environment variables with the following format:

  # -e <PGBOUNCER_OPTION>=<value>

Example:

docker run --rm \
  -e MAX_CLIENT_CONN=100 \
  -e DEFAULT_POOL_SIZE=20 \
  -p 6432:6432 \
  litehex/pgbouncer

Examples

Use a custom configuration

Please note that by going this way, you cannot use any option from environment variables. This method is only useful if you just want to run PgBouncer on Docker.

docker run --rm \
  -v /path/to/pgbouncer.ini:/etc/pgbouncer/pgbouncer.ini \
  -p 6432:6432 \
  litehex/pgbouncer

Create a PgBouncer user

To define a user and add them to the users section of the auth file, you need to use the following environment pattern:

USER_<name> = <password>

Example:

docker run --rm \
  -e USER_UNICORN=securepassword \
  -p 6432:6432 \
  litehex/pgbouncer

Assign a user to a database

This method is useful when you want to create a user and assign it to multiple databases.

docker run --rm \
  -e DB_<name>="host=<hostname> port=<port> dbname=<database_name> auth_user=<user>" \
  -e USER_<name>="<password>" \
  -p 6432:6432 \
  litehex/pgbouncer

Create multiple databases with isolated users access

docker run --rm \
  -e DB_FIRST="host=<hostname> port=<port> dbname=<database_name> auth_user=fu" \
  -e USER_FU="<password>" \
  -e DB_SECOND="host=<hostname> port=<port> dbname=<database_name> password=<password> auth_user=su" \
  -e USER_SU="<password>" \
  -p 6432:6432 \
  litehex/pgbouncer

Use docker-compose and the ability to use multiple databases

To define multiple databases, you have to provide environment variables with the following format:

DB_URL_<name> = <connection_string>

Or you can use the following format(Its same as PgBouncer config):

DB_<name> = host=<hostname> port=<port> //...

version: '3'
services:
  storage-bouncer:
    container_name: 'storage-bouncer'
    image: 'litehex/pgbouncer:latest'
    restart: unless-stopped
    ports:
      - '6432:6432'
    environment:
      - DB_URL_READ=postgres://<user>:<password>@<hostname>:<port>/<database_name>
      - DB_URL_WRITE=postgres://<user>:<password>@<hostname>:<port>/<database_name>
      - DB_THIRD="host=<hostname> port=<port> dbname=<database_name>

Create an admin user and connect to PgBouncer

For defining an admin you have to use ADMIN_USERS and ADMIN_PASSWORD environment variables, it will create a user with given credentials and adds it to config file.

1. Create credentials

export ADMIN_USER=superuser
export ADMIN_PASSWORD=$(openssl rand -base64 32)

2. Add credentials to docker command

docker run --rm \
  -e ADMIN_USER=$ADMIN_USER \
  -e ADMIN_PASSWORD=$ADMIN_PASSWORD \
  -p 6432:6432 \
  litehex/pgbouncer

3. Connect to PgBouncer administration database

echo $ADMIN_PASSWORD | psql -h localhost -p 6432 -U $ADMIN_USER pgbouncer
# Or
psql "postgresql://$ADMIN_USER:$ADMIN_PASSWORD@localhost:6432/pgbouncer"

Credits

This project was inspired by edoburu/docker-pgbouncer and thanks to edoburu for their great work.

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details