release 9.4-1

Fix installation unaccent extension - specify databases

.dockerignore

@@ -1,4 +1,7 @@
 .git
+circle.yml
+LICENSE
 VERSION
 README.md
 Changelog.md
+Makefile

Changelog.md

@@ -1,5 +1,17 @@
 # Changelog
 
+**9.4-1**
+- start: removed `pwfile` logic
+- init: added `USERMAP_*` configuration options
+- base image update to fix SSL vulnerability
+
+**9.4**
+- postgresql: upgrade to 9.4
+
+**9.1-2**
+- use the official postgresql apt repo
+- feature: automatic data migration on upgrade
+
 **9.1-1**
 - upgrade to sameersbn/ubuntu:20141001, fixes shellshock
 - support creation of users and databases at launch (`docker run`)

Dockerfile

@@ -1,10 +1,13 @@
-FROM sameersbn/ubuntu:12.04.20141001
+FROM sameersbn/ubuntu:14.04.20150613
 MAINTAINER sameer@damagehead.com
 
-RUN apt-get update \
- && apt-get install -y postgresql postgresql-client pwgen \
+ENV PG_VERSION 9.4
+RUN wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - \
+ && echo 'deb http://apt.postgresql.org/pub/repos/apt/ trusty-pgdg main' > /etc/apt/sources.list.d/pgdg.list \
+ && apt-get update \
+ && apt-get install -y postgresql-${PG_VERSION} postgresql-client-${PG_VERSION} postgresql-contrib-${PG_VERSION} \
  && rm -rf /var/lib/postgresql \
- && rm -rf /var/lib/apt/lists/* # 20141001
+ && rm -rf /var/lib/apt/lists/* # 20150613
 
 ADD start /start
 RUN chmod 755 /start

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Sameer Naik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,21 +1,32 @@
+[![Circle CI](https://circleci.com/gh/sameersbn/docker-postgresql.svg?style=svg)](https://circleci.com/gh/sameersbn/docker-postgresql)
+
 # Table of Contents
 
 - [Introduction](#introduction)
 - [Changelog](Changelog.md)
+- [Contributing](#contributing)
 - [Reporting Issues](#reporting-issues)
 - [Installation](#installation)
 - [Quick Start](#quick-start)
-- [Creating User and Database at Launch](creating-user-and-database-at-launch)
+- [Creating User and Database at Launch](#creating-user-and-database-at-launch)
 - [Configuration](#configuration)
     - [Data Store](#data-store)
-    - [Securing the server](#securing-the-server)
 - [Shell Access](#shell-access)
 - [Upgrading](#upgrading)
+- [Host UID / GID Mapping](#host-uid--gid-mapping)
 
 # Introduction
 
 Dockerfile to build a PostgreSQL container image which can be linked to other containers.
 
+# Contributing
+
+If you find this image useful here's how you can help:
+
+- Send a Pull Request with your awesome new features and bug fixes
+- Help new users with [Issues](https://github.com/sameersbn/docker-postgresql/issues) they may encounter
+- Send me a tip via [Bitcoin](https://www.coinbase.com/sameersbn) or using [Gratipay](https://gratipay.com/sameersbn/)
+
 # Reporting Issues
 
 Docker is a relatively new project and is active being developed and tested by a thriving community of developers and testers and every release of docker features many enhancements and bugfixes.
@@ -49,7 +60,7 @@ In your issue report please make sure you provide the following information:
 Pull the latest version of the image from the docker index. This is the recommended method of installation as it is easier to update image in the future. These builds are performed by the **Docker Trusted Build** service.
 
 ```bash
-docker pull sameersbn/postgresql:latest
+docker pull sameersbn/postgresql:9.4-1
 ```
 
 Alternately you can build the image yourself.
@@ -65,38 +76,13 @@ docker build -t="$USER/postgresql" .
 Run the postgresql image
 
 ```bash
-docker run --name postgresql -d sameersbn/postgresql:latest
+docker run --name postgresql -d sameersbn/postgresql:9.4-1
 ```
 
-The simplest way to login to the postgresql container as the administrative `postgres` user is to use the `--volumes-from` docker option to connect to the postgresql server over the unix socket.
+The simplest way to login to the postgresql container as the administrative `postgres` user is to use the `docker exec` command to attach a new process to the running container and connect to the postgresql server over the unix socket.
 
 ```bash
-docker run -it --rm --volumes-from=postgresql \
-  sameersbn/postgresql sudo -u postgres -H psql
-```
-
-Alternately you can fetch the password set for the `postgres` user from the container logs.
-
-```bash
-docker logs postgresql
-```
-
-In the output you will notice the following lines with the password:
-
-```bash
-|------------------------------------------------------------------|
-| PostgreSQL User: postgres, Password: xxxxxxxxxxxxxx              |
-|                                                                  |
-| To remove the PostgreSQL login credentials from the logs, please |
-| make a note of password and then delete the file pwfile          |
-| from the data store.                                             |
-|------------------------------------------------------------------|
-```
-
-To test if the postgresql server is working properly, try connecting to the server.
-
-```bash
-psql -U postgres -h $(docker inspect --format {{.NetworkSettings.IPAddress}} postgresql)
+docker exec -it postgresql sudo -u postgres psql
 ```
 
 # Creating User and Database at Launch
@@ -108,7 +94,7 @@ To create a new user you should specify the `DB_USER` and `DB_PASS` variables. T
 ```bash
 docker run --name postgresql -d \
   -e 'DB_USER=dbuser' -e 'DB_PASS=dbpass' \
-  sameersbn/postgresql:latest
+  sameersbn/postgresql:9.4-1
 ```
 
 **NOTE**
@@ -119,21 +105,44 @@ Similarly, you can also create a new database by specifying the database name in
 
 ```bash
 docker run --name postgresql -d \
-  -e 'DB_NAME=dbname' sameersbn/postgresql:latest
+  -e 'DB_NAME=dbname' sameersbn/postgresql:9.4-1
 ```
 
-If the `DB_USER` and `DB_PASS` variables are also specified while creating the database, then the user is granted access to the database.
+You may also specify a comma separated list of database names in the `DB_NAME` variable. The following command creates two new databases named *dbname1* and *dbname2 (p.s. this feature is only available in releases greater than 9.4-1)*
+
+```bash
+docker run --name postgresql -d \
+-e 'DB_NAME=dbname1,dbname2' sameersbn/postgresql:latest
+```
+
+If the `DB_USER` and `DB_PASS` variables are also specified while creating the database, then the user is granted access to the database(s).
 
 For example,
 
 ```bash
 docker run --name postgresql -d \
   -e 'DB_USER=dbuser' -e 'DB_PASS=dbpass' -e 'DB_NAME=dbname' \
-  sameersbn/postgresql:latest
+  sameersbn/postgresql:9.4-1
 ```
 
 , will create a user *dbuser* with the password *dbpass*. It will also create a database named *dbname* and the *dbuser* user will have full access to the *dbname* database.
 
+The `PSQL_TRUST_LOCALNET` environment variable can be used to configure postgres to trust connections on the same network.  This is handy for other containers to connect without authentication. To enable this behavior, set `PSQL_TRUST_LOCALNET` to `true`.
+
+For example,
+
+```bash
+docker run --name postgresql -d \
+  -e 'PSQL_TRUST_LOCALNET=true' \
+  sameersbn/postgresql:9.4-1
+```
+
+This has the effect of adding the following to the `pg_hba.conf` file:
+
+```
+host    all             all             samenet                 trust
+```
+
 # Configuration
 
 ## Data Store
@@ -151,36 +160,36 @@ The updated run command looks like this.
 
 ```bash
 docker run --name postgresql -d \
-  -v /opt/postgresql/data:/var/lib/postgresql sameersbn/postgresql:latest
+  -v /opt/postgresql/data:/var/lib/postgresql sameersbn/postgresql:9.4-1
 ```
 
 This will make sure that the data stored in the database is not lost when the image is stopped and started again.
 
-## Securing the server
+## Enable Unaccent (Search plain text with accent)
 
-By default a randomly generated password is assigned for the postgres user. The password is stored in a file named `pwpass` in the data store and is printed in the logs.
+Unaccent is a text search dictionary that removes accents (diacritic signs) from lexemes. It's a filtering dictionary, which means its output is always passed to the next dictionary (if any), unlike the normal behavior of dictionaries. This allows accent-insensitive processing for full text search.
 
-If you dont want this password to be displayed in the logs, then please note down the password listed in `/opt/postgresql/data/pwpass` and then delete the file.
+By default unaccent is configure to `false`
 
 ```bash
-cat /opt/postgresql/data/pwfile
-rm /opt/postgresql/data/pwfile
-```
-
-Alternately, you can change the password of the postgres user
-
-```bash
-psql -U postgres -h $(docker inspect --format {{.NetworkSettings.IPAddress}} postgresql)
-\password postgres
+docker run --name postgresql -d \
+  -e 'DB_UNACCENT=true' \
+  sameersbn/postgresql:9.4-1
 ```
 
 # Shell Access
 
-For debugging and maintenance purposes you may want access the container shell. Since the container does not allow interactive login over the SSH protocol, you can use the [nsenter](http://man7.org/linux/man-pages/man1/nsenter.1.html) linux tool (part of the util-linux package) to access the container shell.
+For debugging and maintenance purposes you may want access the containers shell. If you are using docker version `1.3.0` or higher you can access a running containers shell using `docker exec` command.
+
+```bash
+docker exec -it postgresql bash
+```
+
+If you are using an older version of docker, you can use the [nsenter](http://man7.org/linux/man-pages/man1/nsenter.1.html) linux tool (part of the util-linux package) to access the container shell.
 
 Some linux distros (e.g. ubuntu) use older versions of the util-linux which do not include the `nsenter` tool. To get around this @jpetazzo has created a nice docker image that allows you to install the `nsenter` utility and a helper script named `docker-enter` on these distros.
 
-To install the nsenter tool on your host execute the following command.
+To install `nsenter` execute the following command on your host,
 
 ```bash
 docker run --rm -v /usr/local/bin:/target jpetazzo/nsenter
@@ -194,8 +203,6 @@ sudo docker-enter postgresql
 
 For more information refer https://github.com/jpetazzo/nsenter
 
-Another tool named `nsinit` can also be used for the same purpose. Please refer https://jpetazzo.github.io/2014/03/23/lxc-attach-nsinit-nsenter-docker-0-9/ for more information.
-
 # Upgrading
 
 To upgrade to newer releases, simply follow this 3 step upgrade procedure.
@@ -209,11 +216,23 @@ docker stop postgresql
 - **Step 2**: Update the docker image.
 
 ```bash
-docker pull sameersbn/postgresql:latest
+docker pull sameersbn/postgresql:9.4-1
 ```
 
 - **Step 3**: Start the image
 
 ```bash
-docker run --name postgresql -d [OPTIONS] sameersbn/postgresql:latest
+docker run --name postgresql -d [OPTIONS] sameersbn/postgresql:9.4-1
+```
+
+# Host UID / GID Mapping
+
+Per default the container is configured to run postgres as user and group `postgres` with some unknown `uid` and `gid`. The host possibly uses these ids for different purposes leading to unfavorable effects. From the host it appears as if the mounted data volumes are owned by the host's user/group `[whatever id postgres has in the image]`.
+
+Also the container processes seem to be executed as the host's user/group `[whatever id postgres has in the image]`. The container can be configured to map the `uid` and `gid` of `postgres` to different ids on host by passing the environment variables `USERMAP_UID` and `USERMAP_GID`. The following command maps the ids to user and group `postgres` on the host.
+
+```bash
+docker run --name=postgresql -it --rm [options] \
+  --env="USERMAP_UID=$(id -u postgres)" --env="USERMAP_GID=$(id -g postgres)" \
+  sameersbn/postgresql:9.4-1
 ```

VERSION

@@ -1 +1 @@
-9.1
+9.4

circle.yml

@@ -0,0 +1,15 @@
+machine:
+  services:
+    - docker
+dependencies:
+  cache_directories:
+    - "~/docker-postgresql"
+  override:
+    - docker info
+    - if [[ -e ~/docker-postgresql/image.tar ]]; then docker load --input ~/docker-postgresql/image.tar; fi
+    - docker build -t sameersbn/postgresql .
+    - mkdir -p ~/docker-postgresql; docker save --output ~/docker-postgresql/image.tar sameersbn/postgresql
+test:
+  override:
+    - docker run -d --name=postgresql sameersbn/postgresql; sleep 10
+    - docker run -it --volumes-from=postgresql sameersbn/postgresql sudo -u postgres -H psql -c "\conninfo"

start

@@ -1,21 +1,42 @@
 #!/bin/bash
 set -e
 
-PG_VERSION="9.1"
+PG_HOME="/var/lib/postgresql"
 PG_CONFDIR="/etc/postgresql/${PG_VERSION}/main"
 PG_BINDIR="/usr/lib/postgresql/${PG_VERSION}/bin"
-PG_DATADIR="/var/lib/postgresql/${PG_VERSION}/main"
+PG_DATADIR="${PG_HOME}/${PG_VERSION}/main"
+
+if [ -n "${USERMAP_UID}" ] || [ -n "${USERMAP_GID}" ]; then
+  if [ -n "${USERMAP_UID}" ] && [ -n "${USERMAP_GID}" ]; then
+    groupmod -g ${USERMAP_GID} postgres
+    usermod -u ${USERMAP_UID} -g ${USERMAP_GID} postgres
+  else
+    echo ""
+    echo "WARNING: "
+    echo "  Please specify USERMAP_UID AND USERMAP_GID or neither. Not changing user id..."
+    echo ""
+  fi
+fi
+
+# set this env variable to true to enable a line in the
+# pg_hba.conf file to trust samenet.  this can be used to connect
+# from other containers on the same host without authentication
+PSQL_TRUST_LOCALNET=${PSQL_TRUST_LOCALNET:false}
 
 DB_NAME=${DB_NAME:-}
 DB_USER=${DB_USER:-}
 DB_PASS=${DB_PASS:-}
+DB_UNACCENT=${DB_UNACCENT:false}
 
-# fix permissions and ownership of /var/lib/postgresql
-mkdir -p -m 0700 /var/lib/postgresql
-chown -R postgres:postgres /var/lib/postgresql
+# fix ownership of ${PG_CONFDIR} (may be necessary if USERMAP_* was set)
+chown -R postgres:postgres ${PG_CONFDIR}
+
+# fix permissions and ownership of ${PG_HOME}
+mkdir -p -m 0700 ${PG_HOME}
+chown -R postgres:postgres ${PG_HOME}
 
 # fix permissions and ownership of /run/postgresql
-mkdir -p -m 0755 /run/postgresql
+mkdir -p -m 0755 /run/postgresql /run/postgresql/${PG_VERSION}-main.pg_stat_tmp
 chown -R postgres:postgres /run/postgresql
 chmod g+s /run/postgresql
 
@@ -27,30 +48,53 @@ cat >> ${PG_CONFDIR}/postgresql.conf <<EOF
 listen_addresses = '*'
 EOF
 
+if [ "${PSQL_TRUST_LOCALNET}" == "true" ]; then
+  echo "Enabling trust samenet in pg_hba.conf..."
+  cat >> ${PG_CONFDIR}/pg_hba.conf <<EOF
+host    all             all             samenet                 trust
+EOF
+fi
+
 # allow remote connections to postgresql database
 cat >> ${PG_CONFDIR}/pg_hba.conf <<EOF
 host    all             all             0.0.0.0/0               md5
 EOF
 
+cd ${PG_HOME}
+
 # initialize PostgreSQL data directory
 if [ ! -d ${PG_DATADIR} ]; then
+  # check if we need to perform data migration
+  PG_OLD_VERSION=$(find ${PG_HOME}/[0-9].[0-9]/main -maxdepth 1 -name PG_VERSION 2>/dev/null | sort -r | head -n1 | cut -d'/' -f5)
+
   echo "Initializing database..."
-  PG_PASSWORD=$(pwgen -c -n -1 14)
-  echo "${PG_PASSWORD}" > /var/lib/postgresql/pwfile
-  sudo -u postgres -H "${PG_BINDIR}/initdb" \
-    --pgdata="${PG_DATADIR}" --pwfile=/var/lib/postgresql/pwfile \
+  sudo -u postgres -H "${PG_BINDIR}/initdb" --pgdata="${PG_DATADIR}" \
     --username=postgres --encoding=unicode --auth=trust >/dev/null
 fi
 
-if [ -f /var/lib/postgresql/pwfile ]; then
-  PG_PASSWORD=$(cat /var/lib/postgresql/pwfile)
-  echo "|------------------------------------------------------------------|"
-  echo "| PostgreSQL User: postgres, Password: ${PG_PASSWORD}              |"
-  echo "|                                                                  |"
-  echo "| To remove the PostgreSQL login credentials from the logs, please |"
-  echo "| make a note of password and then delete the file pwfile          |"
-  echo "| from the data store.                                             |"
-  echo "|------------------------------------------------------------------|"
+if [ -n "${PG_OLD_VERSION}" ]; then
+  echo "Migrating postgresql ${PG_OLD_VERSION} data..."
+  PG_OLD_CONFDIR="/etc/postgresql/${PG_OLD_VERSION}/main"
+  PG_OLD_BINDIR="/usr/lib/postgresql/${PG_OLD_VERSION}/bin"
+  PG_OLD_DATADIR="${PG_HOME}/${PG_OLD_VERSION}/main"
+
+  # backup ${PG_OLD_DATADIR} to avoid data loss
+  PG_BKP_SUFFIX=$(date +%Y%m%d%H%M%S)
+  echo "Backing up ${PG_OLD_DATADIR} to ${PG_OLD_DATADIR}.${PG_BKP_SUFFIX}..."
+  cp -a ${PG_OLD_DATADIR} ${PG_OLD_DATADIR}.${PG_BKP_SUFFIX}
+
+  echo "Installing postgresql-${PG_OLD_VERSION}..."
+  apt-get update
+  apt-get install postgresql-${PG_OLD_VERSION} postgresql-client-${PG_OLD_VERSION}
+  rm -rf /var/lib/apt/lists/*
+
+  # migrate ${PG_OLD_VERSION} data
+  echo "Migration in progress. This could take a while, please be patient..."
+  sudo -u postgres -H ${PG_BINDIR}/pg_upgrade \
+    -b ${PG_OLD_BINDIR} -B ${PG_BINDIR} \
+    -d ${PG_OLD_DATADIR} -D ${PG_DATADIR} \
+    -o "-c config_file=${PG_OLD_CONFDIR}/postgresql.conf" \
+    -O "-c config_file=${PG_CONFDIR}/postgresql.conf" >/dev/null
 fi
 
 if [ -n "${DB_USER}" ]; then
@@ -64,24 +108,33 @@ if [ -n "${DB_USER}" ]; then
     echo "Creating user \"${DB_USER}\"..."
     echo "CREATE ROLE ${DB_USER} with LOGIN CREATEDB PASSWORD '${DB_PASS}';" |
       sudo -u postgres -H ${PG_BINDIR}/postgres --single \
-        -D ${PG_DATADIR} -c config_file=${PG_CONFDIR}/postgresql.conf >/dev/null 2>&1
+        -D ${PG_DATADIR} -c config_file=${PG_CONFDIR}/postgresql.conf >/dev/null
   fi
 fi
 
 if [ -n "${DB_NAME}" ]; then
-  echo "Creating database \"${DB_NAME}\"..."
-  echo "CREATE DATABASE ${DB_NAME};" | \
-    sudo -u postgres -H ${PG_BINDIR}/postgres --single \
-      -D ${PG_DATADIR} -c config_file=${PG_CONFDIR}/postgresql.conf >/dev/null 2>&1
-
-  if [ -n "${DB_USER}" ]; then
-    echo "Granting access to database \"${DB_NAME}\" for user \"${DB_USER}\"..."
-    echo "GRANT ALL PRIVILEGES ON DATABASE ${DB_NAME} to ${DB_USER};" |
+  for db in $(awk -F',' '{for (i = 1 ; i <= NF ; i++) print $i}' <<< "${DB_NAME}"); do
+    echo "Creating database \"${db}\"..."
+    echo "CREATE DATABASE ${db};" | \
       sudo -u postgres -H ${PG_BINDIR}/postgres --single \
-        -D ${PG_DATADIR} -c config_file=${PG_CONFDIR}/postgresql.conf >/dev/null 2>&1
-  fi
+        -D ${PG_DATADIR} -c config_file=${PG_CONFDIR}/postgresql.conf >/dev/null
+
+    if [ "${DB_UNACCENT}" == "true" ]; then
+      echo "Installing unaccent extension..."
+      echo "CREATE EXTENSION IF NOT EXISTS unaccent;" | \
+        sudo -u postgres -H ${PG_BINDIR}/postgres --single ${db} \
+          -D ${PG_DATADIR} -c config_file=${PG_CONFDIR}/postgresql.conf >/dev/null
+    fi
+
+    if [ -n "${DB_USER}" ]; then
+      echo "Granting access to database \"${db}\" for user \"${DB_USER}\"..."
+      echo "GRANT ALL PRIVILEGES ON DATABASE ${db} to ${DB_USER};" |
+        sudo -u postgres -H ${PG_BINDIR}/postgres --single \
+          -D ${PG_DATADIR} -c config_file=${PG_CONFDIR}/postgresql.conf >/dev/null
+    fi
+  done
 fi
 
 echo "Starting PostgreSQL server..."
-exec sudo -u postgres -H ${PG_BINDIR}/postgres \
+exec gosu postgres ${PG_BINDIR}/postgres \
   -D ${PG_DATADIR} -c config_file=${PG_CONFDIR}/postgresql.conf