Merge pull request #63 from meyeringh/postgres-initialize-db

Add PostgreSQL automatic database initialization support

Author: H2CK

06_initialize_db.sh

@@ -1,8 +1,16 @@
 #!/bin/bash
 INIT_DB=${DB_PASSWORD:-FALSE}
+IDB_TYPE=${DB_TYPE:-mysql}
 IDB_HOST=${DB_HOST:-localhost}
 IDB_PORT=${DB_PORT:-3306}
 IDB_USER=${DB_USER:-root}
+
+# Change default port and database user if using postgres
+if [ "$IDB_TYPE" = "postgres" ]; then
+    IDB_PORT=${DB_PORT:-5432}
+    IDB_USER=${DB_USER:-postgres}
+fi
+
 IDB_PASSWORD=${DB_PASSWORD:-password}
 IDB_DB_NAME=${DB_NAME:-webtrees}
 IDB_DB_PREFIX="wt_"
@@ -20,6 +28,7 @@ then
     else
         echo "Creating the initial database settings in configuration file $CONFIG_FILE and creating database."
         cp /config.ini.php "$CONFIG_FILE"
+        sed -i 's/<DB_TYPE>/'"$IDB_TYPE"'/g' "$CONFIG_FILE"
         sed -i 's/<DB_HOST>/'"$IDB_HOST"'/g' "$CONFIG_FILE"
         sed -i 's/<DB_PORT>/'"$IDB_PORT"'/g' "$CONFIG_FILE"
         sed -i 's/<DB_USER>/'"$IDB_USER"'/g' "$CONFIG_FILE"
@@ -29,24 +38,44 @@ then
         chown www-data:docker-data "$CONFIG_FILE"
         chmod 660 "$CONFIG_FILE"
         #Create database structure and add admin user
-        cp /webtrees.sql /mod_webtrees.sql
+        if [ "$IDB_TYPE" = "postgres" ]; then
+            SQL_FILE="/webtrees-postgres.sql"
+        else
+            SQL_FILE="/webtrees.sql"
+        fi
+
+        cp "$SQL_FILE" /mod_webtrees.sql
         sed -i 's/<DB_NAME>/'"$IDB_DB_NAME"'/g' /mod_webtrees.sql
         sed -i 's/<WT_ADMIN_NAME>/'"$IDB_WT_ADMIN"'/g' /mod_webtrees.sql
+
         #Encode password and escape for sed
         RANDOM22=$(php -r "echo substr(base64_encode(openssl_random_pseudo_bytes(17)),0,22);")
         WTSALT=$(php -r "echo '\$2y\$10\$'.str_replace('+','.','$RANDOM22');")
         WTCRYPT=$(php -r "echo crypt('$IDB_WT_ADMINPW', '$WTSALT');")
         sed -i 's/<WT_ADMIN_PW>/'"$(echo $WTCRYPT | sed -e 's/[]\/$*.^[]/\\&/g')"'/g' /mod_webtrees.sql
         sed -i 's/<WT_ADMIN_MAIL>/'"$IDB_WT_ADMINMAIL"'/g' /mod_webtrees.sql
-        #Write to mysql database
-        until mysqladmin ping -h "$IDB_HOST" --silent; do
-            echo "Waiting for database to be ready ..."
-            sleep 1
-        done
-        echo "Database ready. Writing database."
-        mysql -u "$IDB_USER" --password="$IDB_PASSWORD" -h "$IDB_HOST" < /mod_webtrees.sql
-        #Alternative to set Webtrees admin user:
-        #echo "UPDATE wt_user SET user_name='$IDB_WT_ADMIN', email='$IDB_WT_ADMINMAIL', real_name='Admin', password='$WTCRYPT' WHERE user_id=1" | mysql -u "$IDB_USER" --password="$IDB_PASSWORD" -h "$IDB_HOST" "$IDB_DB_NAME"
+
+        # Wait for database and write schema based on type
+        if [ "$IDB_TYPE" = "postgres" ]; then
+            echo "Using PostgreSQL database"
+            until pg_isready -h "$IDB_HOST" -p "$IDB_PORT" -U "$IDB_USER" > /dev/null 2>&1; do
+                echo "Waiting for PostgreSQL database to be ready ..."
+                sleep 1
+            done
+            echo "PostgreSQL database ready. Writing database."
+            export PGPASSWORD="$IDB_PASSWORD"
+            psql -h "$IDB_HOST" -p "$IDB_PORT" -U "$IDB_USER" -d postgres -f /mod_webtrees.sql
+            unset PGPASSWORD
+        else
+            echo "Using MySQL/MariaDB database"
+            until mysqladmin ping -h "$IDB_HOST" --silent; do
+                echo "Waiting for MySQL/MariaDB database to be ready ..."
+                sleep 1
+            done
+            echo "MySQL/MariaDB database ready. Writing database."
+            mysql -u "$IDB_USER" --password="$IDB_PASSWORD" -h "$IDB_HOST" < /mod_webtrees.sql
+        fi
+
         unset RANDOM22
         unset WTSALT
         unset WTCRYPT

Dockerfile

@@ -20,6 +20,7 @@ RUN apt-get update -qq && apt-get upgrade -qy && apt-get install -qy \
     unzip \
     sed \
     mysql-client \
+    postgresql-client \
     php \
     libapache2-mod-php \
     php-mysql \
@@ -87,6 +88,7 @@ ADD Auth.php /Auth.php
 ADD config.ini.php /config.ini.php
 ADD config_blank.ini.php /config_blank.ini.php
 ADD webtrees.sql /webtrees.sql
+ADD webtrees-postgres.sql /webtrees-postgres.sql
 COPY .htaccess /var/www/html/.htaccess
 RUN chown -R www-data:www-data /var/www/html \
     && chmod -R 770 /var/www/html

README.md

@@ -74,7 +74,8 @@ It is also possible to active pretty urls by using environment variables. You co
 
 ## Automatic initialization of database
 
-For MySQL or MariaDB it is possible to use an automatical initalization of the database within the application. User the parameters to DB_* and WT_* to set the corresponding values. To possible error of the initialization start the container in interactve mode using -it.
+For MySQL, MariaDB, or PostgreSQL it is possible to use an automatical initalization of the database within the application. Use the parameters DB_TYPE, DB_* and WT_* to set the corresponding values.
+To debug any errors in the initialization process: Start the container in interactve mode using -it.
 
 ## Support for PostgreSQL or SQLServer
 
@@ -90,6 +91,7 @@ This image contains now the necessary libraries to optionally also select Postgr
 * `-e ENABLE_REMOTE_USER` - if set to TRUE use REMOTE_USER for authentication
 * `-e HEADER_AUTH_VAR` - Sets the name of header variable used for authentication. Default is REMOTE_USER.
 * `-e DISABLE_SSL` - if set to TRUE the image only provides an http entpoint. You should also set the port, because default port 443 is not modifed by this setting.
+* `-e DB_TYPE` - can only be used at first instantiation to set the database type (mysql, postgres, pgsql, postgresql). Password (DB_PASSWORD) must also be set, otherwise no initial setup is performed. If not present the default will be mysql.
 * `-e DB_USER` - can only be used at first instantiation to set the db username. Password (DB_PASSWORD) must also be set (see below), otherwise no initial setup is performed. If not present (only DB_PASSWORD is present) the default will be root.
 * `-e DB_PASSWORD` - can only be used at first instantiation to set the db setting during instantiation and perform initial application setup.
 * `-e DB_HOST` - can only be used at first instantiation to set the db hostname (or ip). Password (DB_PASSWORD) must also be set (see above), otherwise no initial setup is performed. If not present (only DB_PASSWORD is present) the default will be localhost.

config.ini.php

@@ -1,4 +1,5 @@
 ; <?php exit; ?> DO NOT DELETE THIS LINE
+dbtype="<DB_TYPE>"
 dbhost="<DB_HOST>"
 dbport="<DB_PORT>"
 dbuser="<DB_USER>"

docker-compose/webtrees-with-postgres.yml

@@ -0,0 +1,37 @@
+services:
+  postgres:
+    image: postgres:18
+    container_name: webtrees-postgres
+    environment:
+      POSTGRES_DB: webtrees
+      POSTGRES_USER: webtrees
+      POSTGRES_PASSWORD: webtrees1234
+    ports:
+      - "5432:5432"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U webtrees"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+
+  webtrees:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: webtrees-app
+    ports:
+      - "8080:80"
+    environment:
+      - DB_HOST=postgres
+      - DB_USER=webtrees
+      - DB_PASSWORD=webtrees1234
+      - DB_NAME=webtrees
+      - DB_TYPE=postgres
+      - WT_ADMIN=admin
+      - WT_ADMINPW=admin12345
+      - WT_ADMINMAIL=admin@webtrees.local
+      - DISABLE_SSL=TRUE
+      - PORT=80
+    depends_on:
+      postgres:
+        condition: service_healthy