Skip to content

Commit d1e6ca1

Browse files
vmassolvmassol
committed
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
1 parent c5d3889 commit d1e6ca1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+204
-384
lines changed

‎14/mariadb-tomcat/Dockerfile

+1
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ VOLUME /usr/local/xwiki
103103
# configure xwiki's hibernate.cfg.xml file.
104104
# - CONTEXT_PATH: The name of the context path under which XWiki will be deployed in Tomcat. If not specified then it'll
105105
# be deployed as ROOT.
106+
# - JDBC_PARAMS: Replaces the default JDBC parameters with the passed ones.
106107

107108
# Example:
108109
# docker run -it -e "DB_USER=xwiki" -e "DB_PASSWORD=xwiki" <imagename>

‎14/mariadb-tomcat/docker-compose.yml

+10-7
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ networks:
2222
bridge:
2323
driver: bridge
2424
services:
25-
# The container that runs XWiki + Tomcat
25+
# The container that runs XWiki in Tomcat, with the appropriate JDBC driver (for mariadb).
2626
web:
27-
build: .
27+
image: "xwiki:${XWIKI_VERSION}-mariadb-tomcat"
2828
container_name: xwiki-mariadb-tomcat-web
2929
depends_on:
3030
- db
@@ -48,15 +48,12 @@ services:
4848
db:
4949
image: "mariadb:11.1"
5050
container_name: xwiki-mariadb-db
51-
# - We provide a xwiki.cnf file in order to configure the mysql db to support UTF8 and be case-insensitive
52-
# We have to do it here since we use an existing image and that's how this image allows customizations.
53-
# See https://hub.docker.com/_/mariadb/ for more details.
5451
# - Provide a name instead of an auto-generated id for the mariadb data, to make it simpler to identify in
5552
# 'docker volume ls'
53+
# - Provide a SQL script to be executed when the db image starts (to set permissions to create subwikis)
5654
volumes:
57-
- ./mariadb/xwiki.cnf:/etc/mysql/conf.d/xwiki.cnf
5855
- mariadb-data:/var/lib/mysql
59-
- ./mariadb/init.sql:/docker-entrypoint-initdb.d/init.sql
56+
- ./init.sql:/docker-entrypoint-initdb.d/init.sql
6057

6158
# Configure the MariaDB database and create a user with provided name/password.
6259
# See https://hub.docker.com/_/mariadb/ for more details.
@@ -66,6 +63,12 @@ services:
6663
- MYSQL_USER=${DB_USER}
6764
- MYSQL_PASSWORD=${DB_PASSWORD}
6865
- MYSQL_DATABASE=${DB_DATABASE}
66+
67+
# Pass arguments to configure the database
68+
command:
69+
- "--character-set-server=utf8mb4"
70+
- "--collation-server=utf8mb4_bin"
71+
- "--explicit-defaults-for-timestamp=1"
6972
networks:
7073
- bridge
7174
volumes:

‎14/mariadb-tomcat/mariadb/xwiki.cnf

-31
This file was deleted.

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

+2
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ function configure() {
114114
file_env 'DB_DATABASE' 'xwiki'
115115
file_env 'INDEX_HOST' 'localhost'
116116
file_env 'INDEX_PORT' '8983'
117+
file_env 'JDBC_PARAMS' '?useSSL=false'
117118

118119
echo " Deploying XWiki in the '$CONTEXT_PATH' context"
119120
if [ "$CONTEXT_PATH" == "ROOT" ]; then
@@ -127,6 +128,7 @@ function configure() {
127128
safesed "replacepassword" $DB_PASSWORD /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
128129
safesed "replacecontainer" $DB_HOST /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
129130
safesed "replacedatabase" $DB_DATABASE /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
131+
safesed "replacejdbcparams" $JDBC_PARAMS /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
130132

131133
# Set any non-default main wiki database name in the xwiki.cfg file.
132134
if [ "$DB_DATABASE" != "xwiki" ]; then

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@
8080

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

‎14/mysql-tomcat/Dockerfile

+1
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ VOLUME /usr/local/xwiki
103103
# configure xwiki's hibernate.cfg.xml file.
104104
# - CONTEXT_PATH: The name of the context path under which XWiki will be deployed in Tomcat. If not specified then it'll
105105
# be deployed as ROOT.
106+
# - JDBC_PARAMS: Replaces the default JDBC parameters with the passed ones.
106107

107108
# Example:
108109
# docker run -it -e "DB_USER=xwiki" -e "DB_PASSWORD=xwiki" <imagename>

‎14/mysql-tomcat/docker-compose.yml

+10-7
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ networks:
2222
bridge:
2323
driver: bridge
2424
services:
25-
# The container that runs XWiki + Tomcat
25+
# The container that runs XWiki in Tomcat, with the appropriate JDBC driver (for mysql).
2626
web:
27-
build: .
27+
image: "xwiki:${XWIKI_VERSION}-mysql-tomcat"
2828
container_name: xwiki-mysql-tomcat-web
2929
depends_on:
3030
- db
@@ -48,15 +48,12 @@ services:
4848
db:
4949
image: "mysql:8.1"
5050
container_name: xwiki-mysql-db
51-
# - We provide a xwiki.cnf file in order to configure the mysql db to support UTF8 and be case-insensitive
52-
# We have to do it here since we use an existing image and that's how this image allows customizations.
53-
# See https://hub.docker.com/_/mysql/ for more details.
5451
# - Provide a name instead of an auto-generated id for the mysql data, to make it simpler to identify in
5552
# 'docker volume ls'
53+
# - Provide a SQL script to be executed when the db image starts (to set permissions to create subwikis)
5654
volumes:
57-
- ./mysql/xwiki.cnf:/etc/mysql/conf.d/xwiki.cnf
5855
- mysql-data:/var/lib/mysql
59-
- ./mysql/init.sql:/docker-entrypoint-initdb.d/init.sql
56+
- ./init.sql:/docker-entrypoint-initdb.d/init.sql
6057

6158
# Configure the MySQL database and create a user with provided name/password.
6259
# See https://hub.docker.com/_/mysql/ for more details.
@@ -66,6 +63,12 @@ services:
6663
- MYSQL_USER=${DB_USER}
6764
- MYSQL_PASSWORD=${DB_PASSWORD}
6865
- MYSQL_DATABASE=${DB_DATABASE}
66+
67+
# Pass arguments to configure the database
68+
command:
69+
- "--character-set-server=utf8mb4"
70+
- "--collation-server=utf8mb4_bin"
71+
- "--explicit-defaults-for-timestamp=1"
6972
networks:
7073
- bridge
7174
volumes:

‎14/mysql-tomcat/mysql/xwiki.cnf

-31
This file was deleted.

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

+2
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ function configure() {
114114
file_env 'DB_DATABASE' 'xwiki'
115115
file_env 'INDEX_HOST' 'localhost'
116116
file_env 'INDEX_PORT' '8983'
117+
file_env 'JDBC_PARAMS' '?useSSL=false&amp;connectionTimeZone=LOCAL&amp;allowPublicKeyRetrieval=true'
117118

118119
echo " Deploying XWiki in the '$CONTEXT_PATH' context"
119120
if [ "$CONTEXT_PATH" == "ROOT" ]; then
@@ -127,6 +128,7 @@ function configure() {
127128
safesed "replacepassword" $DB_PASSWORD /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
128129
safesed "replacecontainer" $DB_HOST /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
129130
safesed "replacedatabase" $DB_DATABASE /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
131+
safesed "replacejdbcparams" $JDBC_PARAMS /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
130132

131133
# Set any non-default main wiki database name in the xwiki.cfg file.
132134
if [ "$DB_DATABASE" != "xwiki" ]; then

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

+4-2
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,12 @@
8080

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

‎14/postgres-tomcat/Dockerfile

+1
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ VOLUME /usr/local/xwiki
9696
# configure xwiki's hibernate.cfg.xml file.
9797
# - CONTEXT_PATH: The name of the context path under which XWiki will be deployed in Tomcat. If not specified then it'll
9898
# be deployed as ROOT.
99+
# - JDBC_PARAMS: Replaces the default JDBC parameters with the passed ones.
99100

100101
# Example:
101102
# docker run -it -e "DB_USER=xwiki" -e "DB_PASSWORD=xwiki" <imagename>

‎14/postgres-tomcat/docker-compose.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ networks:
2222
bridge:
2323
driver: bridge
2424
services:
25-
# The container that runs XWiki + Tomcat
25+
# The container that runs XWiki in Tomcat, with the appropriate JDBC driver (for postgres).
2626
web:
27-
build: .
27+
image: "xwiki:${XWIKI_VERSION}-postgres-tomcat"
2828
container_name: xwiki-postgres-tomcat-web
2929
depends_on:
3030
- db

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

+2
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ function configure() {
114114
file_env 'DB_DATABASE' 'xwiki'
115115
file_env 'INDEX_HOST' 'localhost'
116116
file_env 'INDEX_PORT' '8983'
117+
file_env 'JDBC_PARAMS' '?'
117118

118119
echo " Deploying XWiki in the '$CONTEXT_PATH' context"
119120
if [ "$CONTEXT_PATH" == "ROOT" ]; then
@@ -127,6 +128,7 @@ function configure() {
127128
safesed "replacepassword" $DB_PASSWORD /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
128129
safesed "replacecontainer" $DB_HOST /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
129130
safesed "replacedatabase" $DB_DATABASE /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
131+
safesed "replacejdbcparams" $JDBC_PARAMS /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
130132

131133
# Set any non-default main wiki database name in the xwiki.cfg file.
132134
if [ "$DB_DATABASE" != "xwiki" ]; then

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

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

‎15.5/mariadb-tomcat/Dockerfile

+1
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ VOLUME /usr/local/xwiki
103103
# configure xwiki's hibernate.cfg.xml file.
104104
# - CONTEXT_PATH: The name of the context path under which XWiki will be deployed in Tomcat. If not specified then it'll
105105
# be deployed as ROOT.
106+
# - JDBC_PARAMS: Replaces the default JDBC parameters with the passed ones.
106107

107108
# Example:
108109
# docker run -it -e "DB_USER=xwiki" -e "DB_PASSWORD=xwiki" <imagename>

‎15.5/mariadb-tomcat/docker-compose.yml

+10-7
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ networks:
2222
bridge:
2323
driver: bridge
2424
services:
25-
# The container that runs XWiki + Tomcat
25+
# The container that runs XWiki in Tomcat, with the appropriate JDBC driver (for mariadb).
2626
web:
27-
build: .
27+
image: "xwiki:${XWIKI_VERSION}-mariadb-tomcat"
2828
container_name: xwiki-mariadb-tomcat-web
2929
depends_on:
3030
- db
@@ -48,15 +48,12 @@ services:
4848
db:
4949
image: "mariadb:11.1"
5050
container_name: xwiki-mariadb-db
51-
# - We provide a xwiki.cnf file in order to configure the mysql db to support UTF8 and be case-insensitive
52-
# We have to do it here since we use an existing image and that's how this image allows customizations.
53-
# See https://hub.docker.com/_/mariadb/ for more details.
5451
# - Provide a name instead of an auto-generated id for the mariadb data, to make it simpler to identify in
5552
# 'docker volume ls'
53+
# - Provide a SQL script to be executed when the db image starts (to set permissions to create subwikis)
5654
volumes:
57-
- ./mariadb/xwiki.cnf:/etc/mysql/conf.d/xwiki.cnf
5855
- mariadb-data:/var/lib/mysql
59-
- ./mariadb/init.sql:/docker-entrypoint-initdb.d/init.sql
56+
- ./init.sql:/docker-entrypoint-initdb.d/init.sql
6057

6158
# Configure the MariaDB database and create a user with provided name/password.
6259
# See https://hub.docker.com/_/mariadb/ for more details.
@@ -66,6 +63,12 @@ services:
6663
- MYSQL_USER=${DB_USER}
6764
- MYSQL_PASSWORD=${DB_PASSWORD}
6865
- MYSQL_DATABASE=${DB_DATABASE}
66+
67+
# Pass arguments to configure the database
68+
command:
69+
- "--character-set-server=utf8mb4"
70+
- "--collation-server=utf8mb4_bin"
71+
- "--explicit-defaults-for-timestamp=1"
6972
networks:
7073
- bridge
7174
volumes:

‎15.5/mariadb-tomcat/mariadb/xwiki.cnf

-31
This file was deleted.

‎15.5/mariadb-tomcat/xwiki/docker-entrypoint.sh

+2
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ function configure() {
114114
file_env 'DB_DATABASE' 'xwiki'
115115
file_env 'INDEX_HOST' 'localhost'
116116
file_env 'INDEX_PORT' '8983'
117+
file_env 'JDBC_PARAMS' '?useSSL=false'
117118

118119
echo " Deploying XWiki in the '$CONTEXT_PATH' context"
119120
if [ "$CONTEXT_PATH" == "ROOT" ]; then
@@ -127,6 +128,7 @@ function configure() {
127128
safesed "replacepassword" $DB_PASSWORD /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
128129
safesed "replacecontainer" $DB_HOST /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
129130
safesed "replacedatabase" $DB_DATABASE /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
131+
safesed "replacejdbcparams" $JDBC_PARAMS /usr/local/tomcat/webapps/$CONTEXT_PATH/WEB-INF/hibernate.cfg.xml
130132

131133
# Set any non-default main wiki database name in the xwiki.cfg file.
132134
if [ "$DB_DATABASE" != "xwiki" ]; then

‎15.5/mariadb-tomcat/xwiki/hibernate.cfg.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@
8080

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

‎15.5/mysql-tomcat/Dockerfile

+1
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ VOLUME /usr/local/xwiki
103103
# configure xwiki's hibernate.cfg.xml file.
104104
# - CONTEXT_PATH: The name of the context path under which XWiki will be deployed in Tomcat. If not specified then it'll
105105
# be deployed as ROOT.
106+
# - JDBC_PARAMS: Replaces the default JDBC parameters with the passed ones.
106107

107108
# Example:
108109
# docker run -it -e "DB_USER=xwiki" -e "DB_PASSWORD=xwiki" <imagename>

0 commit comments

Comments
 (0)