added deprecation warning for DB_UNACCENT parameter

Author: Sameer Naik

README.md

@@ -13,7 +13,6 @@
   - [Setting `postgres` user password](#setting-postgres-user-password)
   - [Creating database user](#creating-database-user)
   - [Creating databases](#creating-databases)
-  - [Enabling unaccent extension](#enabling-unaccent-extension)
   - [Granting user access to a database](#granting-user-access-to-a-database)
   - [Enabling extensions](#enabling-extensions)
   - [Creating replication user](#creating-replication-user)
@@ -172,20 +171,6 @@ docker run --name postgresql -itd --restart always \
   sameersbn/postgresql:9.4-16
 ```
 
-# Enabling unaccent extension
-
-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 [[source](http://www.postgresql.org/docs/9.4/static/unaccent.html)].
-
-You can enable the unaccent extension on database(s) by specifying `DB_UNACCENT=true`. For example, the following command enables the unaccent extension for the `dbname` database.
-
-```bash
-docker run --name postgresql -itd \
-  --env 'DB_NAME=dbname' --env 'DB_UNACCENT=true' \
-  sameersbn/postgresql:9.4-16
-```
-
-*By default the unaccent extension is disabled*
-
 ## Granting user access to a database
 
 If the `DB_USER` and `DB_PASS` variables are specified along with the `DB_NAME` variable, then the user specified in `DB_USER` will be granted access to all the databases listed in `DB_NAME`. Note that if the user and/or databases do not exist, they will be created.
@@ -211,6 +196,10 @@ docker run --name postgresql -itd \
 
 The above command enables the `unaccent` and `pg_trgm` modules on the databases listed in `DB_NAME`, namely `db1` and `db2`.
 
+> **NOTE**:
+>
+> This option deprecates the `DB_UNACCENT` parameter.
+
 ## Creating replication user
 
 Similar to the creation of a database user, a new PostgreSQL replication user can be created by specifying the `REPLICATION_USER` and `REPLICATION_PASS` variables while starting the container.

docker-compose.yml

@@ -11,7 +11,6 @@ PostgreSQL:
     - DB_NAME=
     - DB_TEMPLATE=
 
-    - DB_UNACCENT=
     - DB_EXTENSION=
 
     - REPLICATION_MODE=

runtime/env-defaults

@@ -19,5 +19,3 @@ DB_PASS=${DB_PASS:-}
 DB_TEMPLATE=${DB_TEMPLATE:-template1}
 
 DB_EXTENSION=${DB_EXTENSION:-}
-
-DB_UNACCENT=${DB_UNACCENT:-false}

runtime/functions

@@ -309,6 +309,11 @@ load_extensions() {
   local database=${1?missing argument}
 
   if [[ ${DB_UNACCENT} == true ]]; then
+    echo
+    echo "WARNING: "
+    echo "  The DB_UNACCENT option will be deprecated in favour of DB_EXTENSION soon."
+    echo "  Please migrate to using DB_EXTENSION"
+    echo
     echo "‣ Loading unaccent extension..."
     psql -U ${PG_USER} -d ${database} -c "CREATE EXTENSION IF NOT EXISTS unaccent;" >/dev/null 2>&1
   fi