From dfa3d3a105c28e58779a073cc04808f3d07b0ed2 Mon Sep 17 00:00:00 2001
From: Sameer Naik <sameer@damagehead.com>
Date: Sun, 13 Apr 2014 15:22:58 +0530
Subject: [PATCH] added README

---
 README.md | 123 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 123 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bc8a585
--- /dev/null
+++ b/README.md
@@ -0,0 +1,123 @@
+# Table of Contents
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Configuration](#configuration)
+    - [Data Store](#data-store)
+    - [Securing the server](#securing-the-server)
+- [Maintenance](#maintenance)
+    - [SSH Login](#ssh-login)
+
+# Introduction
+Dockerfile to build a PostgreSQL container image which can be linked to other containers.
+
+# Installation
+
+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.
+
+```
+docker pull sameersbn/postgresql:latest
+```
+
+Alternately you can build the image yourself.
+
+```
+git clone https://github.com/sameersbn/docker-postgresql.git
+cd docker-postgresql
+docker build -t="$USER/postgresql" .
+```
+
+# Quick Start
+Run the postgresql image
+
+```
+docker run -name postgresql -d sameersbn/postgresql:latest
+POSTGRESQL_IP=$(docker inspect postgresql | grep IPAddres | awk -F'"' '{print $4}')
+```
+
+By default remote logins are permitted to the postgresql server and a random password is assigned for the postgres user. The password set for the postgres user can be retrieved from the container logs.
+
+```bash
+docker logs postgresql
+```
+
+In the output you will notice the following lines with the password:
+```
+|------------------------------------------------------------------|
+| 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.
+
+```
+psql -U postgres -h ${POSTGRESQL_IP}
+```
+
+# Configuration
+
+## Data Store
+For data persistence a volume should be mounted at /var/lib/postgresql.
+
+```
+mkdir /opt/postgresql/data
+docker run -name postgresql -d \
+  -v /opt/postgresql/data:/var/lib/postgresql sameersbn/postgresql:latest
+```
+
+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
+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.
+
+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.
+
+```
+cat /opt/postgresql/data/pwfile
+rm /opt/postgresql/data/pwfile
+```
+
+Alternately, you can change the password of the postgres user
+
+```
+psql -U postgres -h ${POSTGRESQL_IP}
+\password postgres
+```
+
+# Maintenance
+
+## SSH Login
+There are two methods to gain root login to the container, the first method is to add your public rsa key to the authorized_keys file and build the image.
+
+The second method is use the dynamically generated password. Every time the container is started a random password is generated using the pwgen tool and assigned to the root user. This password can be fetched from the docker logs.
+
+```
+docker logs postgresql 2>&1 | grep '^User: ' | tail -n1
+```
+This password is not persistent and changes every time the image is executed.
+
+# Upgrading
+
+To upgrade to newer releases, simply follow this 3 step upgrade procedure.
+
+- **Step 1**: Stop the currently running image
+
+```
+docker stop postgresql
+```
+
+- **Step 2**: Update the docker image.
+
+```
+docker pull sameersbn/postgresql:latest
+```
+
+- **Step 3**: Start the image
+
+```
+docker run -name postgresql -d [OPTIONS] sameersbn/postgresql:latest
+```