Merge ~valentinviennot/ubuntu-docker-images:update-postgresql-readme into ~ubuntu-docker-images/ubuntu-docker-images/+git/postgresql:edge

[Valentin Viennot]

Fix bug with password & clean/consistency check.

[Sergio Durigan Junior (sergiodj)]

Thanks for the MP, Valentin. I found a very small nit; let me know when you fix it and I can merge the branch for you.

review: Needs Fixing

diff --git a/README.md b/README.md
index 7e5762b..27591ae 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ SQL:2008 data types, including INTEGER, NUMERIC, BOOLEAN, CHAR, VARCHAR, DATE,
 INTERVAL, and TIMESTAMP. It also supports storage of binary large objects,
 including pictures, sounds, or video. It has native programming interfaces for
 C/C++, Java, .Net, Perl, Python, Ruby, Tcl, ODBC, among others, and exceptional
-documentation.
+documentation. Read more on the [PostgreSQL website](https://www.postgresql.org/docs/).
 
 ## Tags
 
@@ -25,25 +25,14 @@ documentation.
 
 ```sh
 $ docker network create postgres-net
-# Run the server
-$ docker run --name postgres-instance --network postgres-net --env POSTGRES_PASSWORD=My$seCret --detach squeakywheel/postgres:edge
-# Run the client
-$ docker run --interactive --tty --rm --network postgres-net squeakywheel/postgres:edge psql -h postgres-instance -U postgres
-```
-
-The password will be asked and you can enter `My$seCret`. Now, you are logged in and can enjoy your new instance.
-
-Since containers are ephemeral you might be interested in persist data and not initialize a new database every time you launch a new container. To do that you can use docker volumes:
-
-```sh
-$ docker run --name postgres --volume /path/to/persisted/data:/var/lib/postgresql/data squeakywheel/postgres:edge
+$ docker run -d --name postgres-instance --network postgres-net -e TZ=Europe/London -e POSTGRES_PASSWORD=My:s3Cr3t/ squeakywheel/postgres:edge
 ```
 
 #### Parameters
 
 | Parameter | Description |
 |---|---|
-| `-e TZ=UTC` | Timezone |
+| `-e TZ=UTC` | Timezone. |
 | `-e POSTGRES_PASSWORD=secret` | Set the password for the superuser which is `postgres` by default. Bear in mind that to connect to the database in the same host the password is not needed but to access it via an external host (for instance another container) the password is needed. This option is **mandatory** and **must not be empty**. |
 | `-e POSTGRES_USER=john` | Create a new user with superuser privileges. This is used in conjunction with `POSTGRES_PASSWORD` |
 | `-e POSTGRES_DB=db_test` | Set the name of the default database. |
@@ -51,6 +40,9 @@ $ docker run --name postgres --volume /path/to/persisted/data:/var/lib/postgresq
 | `-e POSTGRES_INITDB_WALDIR=/path/to/location` | Set the location of the Postgres transaction log. By default it is stored in a subdirectory of the main Postgres data folder (`PGDATA`). |
 | `-e POSTGRES_HOST_AUTH_METHOD=trust` | Set the `auth-method` for `host` connections for `all` databases, `all` users, and `all` addresses. The following will be added to the `pg_hba.conf` if this option is passed: `host all all all $POSTGRES_HOST_AUTH_METHOD`. |
 | `-e PGDATA=/path/to/location` | set the location of the database files. The default is `/var/lib/postgresql/data`. |
+| `-p 30432:5432` | Expose Postgresql server on `localhost:6032`. |
+| `-v /path/to/postgresql.conf:/etc/postgresql/postgresql.conf` | Pass your own `postgresql.conf` configuration file (download this [example file](https://git.launchpad.net/~canonical-server/ubuntu-server-oci/+git/postgresql/plain/examples/config/postgresql.conf)). |
+| `-v /path/to/persisted/data:/var/lib/postgresql/data` | Persist data instead of initializing a new database every time you launch a new container. |
 
 #### Initialization Scripts
 
@@ -62,23 +54,20 @@ One can also add initialization scripts to their containers. This includes `*.sq
 
 All of this is done before the Postgres service is started. Keep in mind if your `PGDATA` directory is not empty (contains pre-existing database) they will be left untouched.
 
-#### Database Configuration
+#### Testing/Debugging
 
-You can pass your own configuration file to the container doing the following:
+In case you need to debug what it is happening with the container you can run `docker logs <name_of_the_container>`. To get access to an interactive shell run:
 
 ```sh
-$ docker run --name postgres --volume /path/to/postgres/config/file/postgresql.conf:/etc/postgresql/postgresql.conf --env POSTGRES_PASSWORD=P@sSwd squeakywheel/postgres:edge
+$ docker exec -it <name_of_the_container> /bin/bash
 ```
 
-#### Debugging
-
-In case you need to debug what it is happening with the container you can run `docker logs <name_of_the_container>`. But if you want to get access to an interactive shell run:
+With this same image, you can launch an interactive container as a client to connect to your `postgresql` server running in the first container.
 
 ```sh
-$ docker exec -it <name_of_the_container> /bin/bash
+$ docker run -it --rm --network postgres-net squeakywheel/postgres:edge psql -h postgres-instance -U postgres
 ```
-
-To see how to use the Postgres OCI image with `docker-compose` and `kubernetes` check the `examples/README.md` file.
+The password will be asked and you can enter `My:s3Cr3t/`. Now, you are logged in and can enjoy your new instance.
 
 ## Deploy with Kubernetes
 
@@ -134,7 +123,7 @@ spec:
         image: squeakywheel/postgres:edge
         env:
         - name: POSTGRES_PASSWORD
-          value: "myS&cret"
+          value: "My:s3Cr3t/"
         volumeMounts:
         - name: postgres-config-volume
           mountPath: /etc/postgresql/postgresql.conf