XDOCKER-296: Improve ease of use of the docker compose files

XDOCKER-225: Allow customizing the JDBC connexion parameters + add "allowPublicKeyRetrieval=true" by default for MySQL
XDOCKER-285: Change default MySQL/MariaDB charset + collation to utf8mb4

Author: vmassol

14/mariadb-tomcat/Dockerfile

@@ -103,6 +103,7 @@ VOLUME /usr/local/xwiki
 #            configure xwiki's hibernate.cfg.xml file.
 # - CONTEXT_PATH: The name of the context path under which XWiki will be deployed in Tomcat. If not specified then it'll
 #                 be deployed as ROOT.
+# - JDBC_PARAMS: Replaces the default JDBC parameters with the passed ones.
 
 # Example:
 #   docker run -it -e "DB_USER=xwiki" -e "DB_PASSWORD=xwiki" <imagename>

14/mariadb-tomcat/docker-compose.yml

@@ -22,9 +22,9 @@ networks:
   bridge:
     driver: bridge
 services:
-  # The container that runs XWiki + Tomcat
+  # The container that runs XWiki in Tomcat, with the appropriate JDBC driver (for mariadb).
   web:
-    build: .
+    image: "xwiki:${XWIKI_VERSION}-mariadb-tomcat"
     container_name: xwiki-mariadb-tomcat-web
     depends_on:
       - db
@@ -48,15 +48,12 @@ services:
   db:
     image: "mariadb:11.1"
     container_name: xwiki-mariadb-db
-    # - We provide a xwiki.cnf file in order to configure the mysql db to support UTF8 and be case-insensitive
-    # We have to do it here since we use an existing image and that's how this image allows customizations.
-    # See https://hub.docker.com/_/mariadb/ for more details.
     # - Provide a name instead of an auto-generated id for the mariadb data, to make it simpler to identify in
     # 'docker volume ls'
+    # - Provide a SQL script to be executed when the db image starts (to set permissions to create subwikis)
     volumes:
-      - ./mariadb/xwiki.cnf:/etc/mysql/conf.d/xwiki.cnf
       - mariadb-data:/var/lib/mysql
-      - ./mariadb/init.sql:/docker-entrypoint-initdb.d/init.sql
+      - ./init.sql:/docker-entrypoint-initdb.d/init.sql
 
     # Configure the MariaDB database and create a user with provided name/password.
     # See https://hub.docker.com/_/mariadb/ for more details.
@@ -66,6 +63,12 @@ services:
       - MYSQL_USER=${DB_USER}
       - MYSQL_PASSWORD=${DB_PASSWORD}
       - MYSQL_DATABASE=${DB_DATABASE}
+
+    # Pass arguments to configure the database
+    command:
+      - "--character-set-server=utf8mb4"
+      - "--collation-server=utf8mb4_bin"
+      - "--explicit-defaults-for-timestamp=1"
     networks:
       - bridge
 volumes:

14/mariadb-tomcat/mariadb/xwiki.cnf

@@ -114,6 +114,7 @@ function configure() {
   file_env 'DB_DATABASE' 'xwiki'
   file_env 'INDEX_HOST' 'localhost'
   file_env 'INDEX_PORT' '8983'
+  file_env 'JDBC_PARAMS' '?useSSL=false'
 
   echo "  Deploying XWiki in the '$CONTEXT_PATH' context"
   if [ "$CONTEXT_PATH" == "ROOT" ]; then
@@ -127,6 +128,7 @@ function configure() {
   safesed "replacepassword" $DB_PASSWORD /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
   safesed "replacecontainer" $DB_HOST /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
   safesed "replacedatabase" $DB_DATABASE /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
+  safesed "replacejdbcparams" $JDBC_PARAMS /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
 
   # Set any non-default main wiki database name in the xwiki.cfg file.
   if [ "$DB_DATABASE" != "xwiki" ]; then

14/mariadb-tomcat/xwiki/docker-entrypoint.sh

@@ -80,10 +80,10 @@
 
     <!-- MariaDB configuration.
          Notes:
-           - if you want the main wiki database to be different than "xwiki"
+           - If you want the main wiki database to be different than "xwiki"
              you will also have to set the property xwiki.db in xwiki.cfg file
     -->
-    <property name="connection.url">jdbc:mariadb://replacecontainer/replacedatabase?useSSL=false</property>
+    <property name="connection.url">jdbc:mariadb://replacecontainer/replacedatabasereplacejdbcparams</property>
     <property name="connection.username">replaceuser</property>
     <property name="connection.password">replacepassword</property>
     <property name="connection.driver_class">org.mariadb.jdbc.Driver</property>

14/mariadb-tomcat/xwiki/hibernate.cfg.xml

@@ -103,6 +103,7 @@ VOLUME /usr/local/xwiki
 #            configure xwiki's hibernate.cfg.xml file.
 # - CONTEXT_PATH: The name of the context path under which XWiki will be deployed in Tomcat. If not specified then it'll
 #                 be deployed as ROOT.
+# - JDBC_PARAMS: Replaces the default JDBC parameters with the passed ones.
 
 # Example:
 #   docker run -it -e "DB_USER=xwiki" -e "DB_PASSWORD=xwiki" <imagename>

14/mysql-tomcat/Dockerfile

@@ -22,9 +22,9 @@ networks:
   bridge:
     driver: bridge
 services:
-  # The container that runs XWiki + Tomcat
+  # The container that runs XWiki in Tomcat, with the appropriate JDBC driver (for mysql).
   web:
-    build: .
+    image: "xwiki:${XWIKI_VERSION}-mysql-tomcat"
     container_name: xwiki-mysql-tomcat-web
     depends_on:
       - db
@@ -48,15 +48,12 @@ services:
   db:
     image: "mysql:8.1"
     container_name: xwiki-mysql-db
-    # - We provide a xwiki.cnf file in order to configure the mysql db to support UTF8 and be case-insensitive
-    # We have to do it here since we use an existing image and that's how this image allows customizations.
-    # See https://hub.docker.com/_/mysql/ for more details.
     # - Provide a name instead of an auto-generated id for the mysql data, to make it simpler to identify in
     # 'docker volume ls'
+    # - Provide a SQL script to be executed when the db image starts (to set permissions to create subwikis)
     volumes:
-      - ./mysql/xwiki.cnf:/etc/mysql/conf.d/xwiki.cnf
       - mysql-data:/var/lib/mysql
-      - ./mysql/init.sql:/docker-entrypoint-initdb.d/init.sql
+      - ./init.sql:/docker-entrypoint-initdb.d/init.sql
 
     # Configure the MySQL database and create a user with provided name/password.
     # See https://hub.docker.com/_/mysql/ for more details.
@@ -66,6 +63,12 @@ services:
       - MYSQL_USER=${DB_USER}
       - MYSQL_PASSWORD=${DB_PASSWORD}
       - MYSQL_DATABASE=${DB_DATABASE}
+
+    # Pass arguments to configure the database
+    command:
+      - "--character-set-server=utf8mb4"
+      - "--collation-server=utf8mb4_bin"
+      - "--explicit-defaults-for-timestamp=1"
     networks:
       - bridge
 volumes:

14/mysql-tomcat/docker-compose.yml

@@ -114,6 +114,7 @@ function configure() {
   file_env 'DB_DATABASE' 'xwiki'
   file_env 'INDEX_HOST' 'localhost'
   file_env 'INDEX_PORT' '8983'
+  file_env 'JDBC_PARAMS' '?useSSL=false&connectionTimeZone=LOCAL&allowPublicKeyRetrieval=true'
 
   echo "  Deploying XWiki in the '$CONTEXT_PATH' context"
   if [ "$CONTEXT_PATH" == "ROOT" ]; then
@@ -127,6 +128,7 @@ function configure() {
   safesed "replacepassword" $DB_PASSWORD /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
   safesed "replacecontainer" $DB_HOST /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
   safesed "replacedatabase" $DB_DATABASE /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
+  safesed "replacejdbcparams" $JDBC_PARAMS /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
 
   # Set any non-default main wiki database name in the xwiki.cfg file.
   if [ "$DB_DATABASE" != "xwiki" ]; then

14/mysql-tomcat/mysql/xwiki.cnf

@@ -80,10 +80,12 @@
 
     <!-- MySQL configuration.
          Notes:
-           - if you want the main wiki database to be different than "xwiki"
+           - If you want the main wiki database to be different than "xwiki"
              you will also have to set the property xwiki.db in xwiki.cfg file
+           - Use the local timezone to work around a bug in the MySQL 8.x which often does not understand the server
+              timezone and crash
     -->
-    <property name="connection.url">jdbc:mysql://replacecontainer/replacedatabase?useSSL=false</property>
+    <property name="connection.url">jdbc:mysql://replacecontainer/replacedatabasereplacejdbcparams</property>
     <property name="connection.username">replaceuser</property>
     <property name="connection.password">replacepassword</property>
     <property name="connection.driver_class">com.mysql.cj.jdbc.Driver</property>

14/mysql-tomcat/xwiki/docker-entrypoint.sh

@@ -96,6 +96,7 @@ VOLUME /usr/local/xwiki
 #            configure xwiki's hibernate.cfg.xml file.
 # - CONTEXT_PATH: The name of the context path under which XWiki will be deployed in Tomcat. If not specified then it'll
 #                 be deployed as ROOT.
+# - JDBC_PARAMS: Replaces the default JDBC parameters with the passed ones.
 
 # Example:
 #   docker run -it -e "DB_USER=xwiki" -e "DB_PASSWORD=xwiki" <imagename>

14/mysql-tomcat/xwiki/hibernate.cfg.xml

@@ -22,9 +22,9 @@ networks:
   bridge:
     driver: bridge
 services:
-  # The container that runs XWiki + Tomcat
+  # The container that runs XWiki in Tomcat, with the appropriate JDBC driver (for postgres).
   web:
-    build: .
+    image: "xwiki:${XWIKI_VERSION}-postgres-tomcat"
     container_name: xwiki-postgres-tomcat-web
     depends_on:
       - db

14/postgres-tomcat/Dockerfile

@@ -114,6 +114,7 @@ function configure() {
   file_env 'DB_DATABASE' 'xwiki'
   file_env 'INDEX_HOST' 'localhost'
   file_env 'INDEX_PORT' '8983'
+  file_env 'JDBC_PARAMS' '?'
 
   echo "  Deploying XWiki in the '$CONTEXT_PATH' context"
   if [ "$CONTEXT_PATH" == "ROOT" ]; then
@@ -127,6 +128,7 @@ function configure() {
   safesed "replacepassword" $DB_PASSWORD /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
   safesed "replacecontainer" $DB_HOST /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
   safesed "replacedatabase" $DB_DATABASE /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
+  safesed "replacejdbcparams" $JDBC_PARAMS /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
 
   # Set any non-default main wiki database name in the xwiki.cfg file.
   if [ "$DB_DATABASE" != "xwiki" ]; then

14/postgres-tomcat/docker-compose.yml

@@ -87,7 +87,7 @@
            - if you want the main wiki database to be different than "xwiki" (or "public" in schema mode)
              you will also have to set the property xwiki.db in xwiki.cfg file
     -->
-    <property name="connection.url">jdbc:postgresql://replacecontainer:5432/replacedatabase</property>
+    <property name="connection.url">jdbc:postgresql://replacecontainer:5432/replacedatabasereplacejdbcparams</property>
     <property name="connection.username">replaceuser</property>
     <property name="connection.password">replacepassword</property>
     <property name="connection.driver_class">org.postgresql.Driver</property>

14/postgres-tomcat/xwiki/docker-entrypoint.sh

@@ -103,6 +103,7 @@ VOLUME /usr/local/xwiki
 #            configure xwiki's hibernate.cfg.xml file.
 # - CONTEXT_PATH: The name of the context path under which XWiki will be deployed in Tomcat. If not specified then it'll
 #                 be deployed as ROOT.
+# - JDBC_PARAMS: Replaces the default JDBC parameters with the passed ones.
 
 # Example:
 #   docker run -it -e "DB_USER=xwiki" -e "DB_PASSWORD=xwiki" <imagename>

14/postgres-tomcat/xwiki/hibernate.cfg.xml

@@ -22,9 +22,9 @@ networks:
   bridge:
     driver: bridge
 services:
-  # The container that runs XWiki + Tomcat
+  # The container that runs XWiki in Tomcat, with the appropriate JDBC driver (for mariadb).
   web:
-    build: .
+    image: "xwiki:${XWIKI_VERSION}-mariadb-tomcat"
     container_name: xwiki-mariadb-tomcat-web
     depends_on:
       - db
@@ -48,15 +48,12 @@ services:
   db:
     image: "mariadb:11.1"
     container_name: xwiki-mariadb-db
-    # - We provide a xwiki.cnf file in order to configure the mysql db to support UTF8 and be case-insensitive
-    # We have to do it here since we use an existing image and that's how this image allows customizations.
-    # See https://hub.docker.com/_/mariadb/ for more details.
     # - Provide a name instead of an auto-generated id for the mariadb data, to make it simpler to identify in
     # 'docker volume ls'
+    # - Provide a SQL script to be executed when the db image starts (to set permissions to create subwikis)
     volumes:
-      - ./mariadb/xwiki.cnf:/etc/mysql/conf.d/xwiki.cnf
       - mariadb-data:/var/lib/mysql
-      - ./mariadb/init.sql:/docker-entrypoint-initdb.d/init.sql
+      - ./init.sql:/docker-entrypoint-initdb.d/init.sql
 
     # Configure the MariaDB database and create a user with provided name/password.
     # See https://hub.docker.com/_/mariadb/ for more details.
@@ -66,6 +63,12 @@ services:
       - MYSQL_USER=${DB_USER}
       - MYSQL_PASSWORD=${DB_PASSWORD}
       - MYSQL_DATABASE=${DB_DATABASE}
+
+    # Pass arguments to configure the database
+    command:
+      - "--character-set-server=utf8mb4"
+      - "--collation-server=utf8mb4_bin"
+      - "--explicit-defaults-for-timestamp=1"
     networks:
       - bridge
 volumes:

15.5/mariadb-tomcat/Dockerfile

@@ -114,6 +114,7 @@ function configure() {
   file_env 'DB_DATABASE' 'xwiki'
   file_env 'INDEX_HOST' 'localhost'
   file_env 'INDEX_PORT' '8983'
+  file_env 'JDBC_PARAMS' '?useSSL=false'
 
   echo "  Deploying XWiki in the '$CONTEXT_PATH' context"
   if [ "$CONTEXT_PATH" == "ROOT" ]; then
@@ -127,6 +128,7 @@ function configure() {
   safesed "replacepassword" $DB_PASSWORD /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
   safesed "replacecontainer" $DB_HOST /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
   safesed "replacedatabase" $DB_DATABASE /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
+  safesed "replacejdbcparams" $JDBC_PARAMS /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
 
   # Set any non-default main wiki database name in the xwiki.cfg file.
   if [ "$DB_DATABASE" != "xwiki" ]; then

15.5/mariadb-tomcat/docker-compose.yml

@@ -80,10 +80,10 @@
 
     <!-- MariaDB configuration.
          Notes:
-           - if you want the main wiki database to be different than "xwiki"
+           - If you want the main wiki database to be different than "xwiki"
              you will also have to set the property xwiki.db in xwiki.cfg file
     -->
-    <property name="connection.url">jdbc:mariadb://replacecontainer/replacedatabase?useSSL=false</property>
+    <property name="connection.url">jdbc:mariadb://replacecontainer/replacedatabasereplacejdbcparams</property>
     <property name="connection.username">replaceuser</property>
     <property name="connection.password">replacepassword</property>
     <property name="connection.driver_class">org.mariadb.jdbc.Driver</property>

15.5/mariadb-tomcat/mariadb/xwiki.cnf

@@ -103,6 +103,7 @@ VOLUME /usr/local/xwiki
 #            configure xwiki's hibernate.cfg.xml file.
 # - CONTEXT_PATH: The name of the context path under which XWiki will be deployed in Tomcat. If not specified then it'll
 #                 be deployed as ROOT.
+# - JDBC_PARAMS: Replaces the default JDBC parameters with the passed ones.
 
 # Example:
 #   docker run -it -e "DB_USER=xwiki" -e "DB_PASSWORD=xwiki" <imagename>