9 printf '%s [%s] [Entrypoint]: %s\n' "$(date --rfc-3339=seconds)" "$type" "$*"
15 mysql_log Warn "$@" >&2
18 mysql_log ERROR "$@" >&2
22 # usage: file_env VAR [DEFAULT]
23 # ie: file_env 'XYZ_DB_PASSWORD' 'example'
24 # (will allow for "$XYZ_DB_PASSWORD_FILE" to fill in the value of
25 # "$XYZ_DB_PASSWORD" from a file, especially for Docker's secrets feature)
33 if [ "${!var:-}" ] && [ "${!fileVar:-}" ]; then
34 mysql_error "Both $var and $fileVar are set (but are exclusive)"
39 # val="$(< "${!fileVar}")"
40 # eval replacement of the bashism equivalents above presents no security issue here
41 # since var and fileVar variables contents are derived from the file_env() function arguments.
42 # This method is only called inside this script with a limited number of possible values.
43 if [ "${!var:-}" ]; then
45 elif [ "${!fileVar:-}" ]; then
46 val="$(< "$(eval echo "\$$fileVar")")"
53 # usage: docker_process_init_files [file [file [...]]]
54 # ie: docker_process_init_files /always-initdb.d/*
55 # process initializer files, based on file extensions
56 docker_process_init_files() {
57 # mysql here for backwards compatibility "${mysql[@]}"
58 mysql=( docker_process_sql )
65 # https://github.com/docker-library/postgres/issues/450#issuecomment-393167936
66 # https://github.com/docker-library/postgres/pull/452
68 mysql_note "$0: running $f"
71 mysql_note "$0: sourcing $f"
75 *.sql) mysql_note "$0: running $f"; docker_process_sql < "$f"; echo ;;
76 *.sql.gz) mysql_note "$0: running $f"; gunzip -c "$f" | docker_process_sql; echo ;;
77 *.sql.xz) mysql_note "$0: running $f"; xzcat "$f" | docker_process_sql; echo ;;
78 *) mysql_warn "$0: ignoring $f" ;;
84 mysql_check_config() {
87 toRun=( "$@" --verbose --help --log-bin-index="$(mktemp -u)" )
88 if ! errors="$("${toRun[@]}" 2>&1 >/dev/null)"; then
89 mysql_error "$(printf 'mysqld failed while attempting to check config\n\tcommand was: ')${toRun[*]}$(printf'\n\t')$errors"
93 # Fetch value from server config
94 # We use mysqld --verbose --help instead of my_print_defaults because the
95 # latter only show values present in config files, and not server defaults
99 "$@" --verbose --help --log-bin-index="$(mktemp -u)" 2>/dev/null \
100 | awk -v conf="$conf" '$1 == conf && /^[^ \t]/ { sub(/^[^ \t]+[ \t]+/, ""); print; exit }'
101 # match "datadir /some/path with/spaces in/it here" but not "--xyz=abc\n datadir (xyz)"
104 # Do a temporary startup of the MySQL server, for init purposes
105 docker_temp_server_start() {
106 "$@" --skip-networking --socket="${SOCKET}" &
107 mysql_note "Waiting for server startup"
109 for i in $(seq 30 -1 0); do
110 # only use the root password if the database has already been initializaed
111 # so that it won't try to fill in a password file when it hasn't been set yet
113 if [ -z "$DATABASE_ALREADY_EXISTS" ]; then
114 extraArgs=${extraArgs}" --dont-use-mysql-root-password"
116 if echo 'SELECT 1' |docker_process_sql ${extraArgs} --database=mysql >/dev/null 2>&1; then
121 if [ "$i" = 0 ]; then
122 mysql_error "Unable to start server."
126 # Stop the server. When using a local socket file mysqladmin will block until
127 # the shutdown is complete.
128 docker_temp_server_stop() {
129 if ! mysqladmin --defaults-extra-file=<( _mysql_passfile ) shutdown -uroot --socket="${SOCKET}"; then
130 mysql_error "Unable to shut down server."
134 # Verify that the minimally required password settings are set for new databases.
135 docker_verify_minimum_env() {
136 if [ -z "$MYSQL_ROOT_PASSWORD" -a -z "$MYSQL_ALLOW_EMPTY_PASSWORD" -a -z "$MYSQL_RANDOM_ROOT_PASSWORD" ]; then
137 mysql_error "$(printf'Database is uninitialized and password option is not specified\n\tYou need to specify one of MYSQL_ROOT_PASSWORD, MYSQL_ALLOW_EMPTY_PASSWORD and MYSQL_RANDOM_ROOT_PASSWORD')"
141 # creates folders for the database
142 # also ensures permission for user mysql of run as root
143 docker_create_db_directories() {
147 # TODO other directories that are used by default? like /var/lib/mysql-files
148 # see https://github.com/docker-library/mysql/issues/562
151 if [ "$user" = "0" ]; then
152 # this will cause less disk access than `chown -R`
153 find "$DATADIR" \! -user mysql -exec chown mysql '{}' +
157 # initializes the database directory
158 docker_init_database_dir() {
159 mysql_note "Initializing database files"
160 installArgs=" --datadir=$DATADIR --rpm "
161 if { mysql_install_db --help || :; } | grep -q -- '--auth-root-authentication-method'; then
162 # beginning in 10.4.3, install_db uses "socket" which only allows system user root to connect, switch back to "normal" to allow mysql root without a password
163 # see https://github.com/MariaDB/server/commit/b9f3f06857ac6f9105dc65caae19782f09b47fb3
164 # (this flag doesn't exist in 10.0 and below)
165 installArgs=${installArgs}" --auth-root-authentication-method=normal"
167 # "Other options are passed to mysqld." (so we pass all "mysqld" arguments directly here)
168 mysql_install_db ${installArgs} "$(echo ${@} | sed 's/^ *[^ ]* *//')"
169 mysql_note "Database files initialized"
172 # Loads various settings that are used elsewhere in the script
173 # This should be called after mysql_check_config, but before any other functions
176 declare -g DATADIR SOCKET
177 DATADIR="$(mysql_get_config 'datadir' "$@")"
178 SOCKET="$(mysql_get_config 'socket' "$@")"
180 # Initialize values that might be stored in a file
181 file_env 'MYSQL_ROOT_HOST' '%'
182 file_env 'MYSQL_DATABASE'
183 file_env 'MYSQL_USER'
184 file_env 'MYSQL_PASSWORD'
185 file_env 'MYSQL_ROOT_PASSWORD'
186 file_env 'PORTAL_DB_TABLES'
188 declare -g DATABASE_ALREADY_EXISTS
189 if [ -d "$DATADIR/mysql" ]; then
190 DATABASE_ALREADY_EXISTS='true'
194 # Execute sql script, passed via stdin
195 # usage: docker_process_sql [--dont-use-mysql-root-password] [mysql-cli-args]
196 # ie: docker_process_sql --database=mydb <<<'INSERT ...'
197 # ie: docker_process_sql --dont-use-mysql-root-password --database=mydb <my-file.sql
198 docker_process_sql() {
200 if [ '--dont-use-mysql-root-password' = "$1" ]; then
201 passfileArgs=${passfileArgs}" $1"
204 # args sent in can override this db, since they will be later in the command
205 if [ -n "$MYSQL_DATABASE" ]; then
206 set -- --database="$MYSQL_DATABASE" "$@"
209 mysql --defaults-extra-file=<( _mysql_passfile ${passfileArgs}) --protocol=socket -uroot -hlocalhost --socket="${SOCKET}" "$@"
212 # Initializes database with timezone info and root password, plus optional extra db/user
214 # Load timezone info into database
215 if [ -z "$MYSQL_INITDB_SKIP_TZINFO" ]; then
217 # Aria in 10.4+ is slow due to "transactional" (crash safety)
218 # https://jira.mariadb.org/browse/MDEV-23326
219 # https://github.com/docker-library/mariadb/issues/262
221 tztables=( time_zone time_zone_leap_second time_zone_name time_zone_transition time_zone_transition_type )
222 for table in "${tztables[@]}"; do
223 echo "/*!100400 ALTER TABLE $table TRANSACTIONAL=0 */;"
226 # sed is for https://bugs.mysql.com/bug.php?id=20545
227 mysql_tzinfo_to_sql /usr/share/zoneinfo \
228 | sed 's/Local time zone must be set--see zic manual page/FCTY/'
230 for table in "${tztables[@]}"; do
231 echo "/*!100400 ALTER TABLE $table TRANSACTIONAL=1 */;"
233 } | docker_process_sql --dont-use-mysql-root-password --database=mysql
234 # tell docker_process_sql to not use MYSQL_ROOT_PASSWORD since it is not set yet
236 # Generate random root password
237 if [ -n "$MYSQL_RANDOM_ROOT_PASSWORD" ]; then
238 export MYSQL_ROOT_PASSWORD="$(pwgen -1 32)"
239 mysql_note "GENERATED ROOT PASSWORD: $MYSQL_ROOT_PASSWORD"
241 # Sets root password and creates root users for non-localhost hosts
244 # default root to listen for connections from anywhere
245 if [ -n "$MYSQL_ROOT_HOST" ] && [ "$MYSQL_ROOT_HOST" != 'localhost' ]; then
246 # no, we don't care if read finds a terminating character in this heredoc
247 # https://unix.stackexchange.com/questions/265149/why-is-set-o-errexit-breaking-this-read-heredoc-expression/265151#265151
248 read -r -d '' rootCreate <<-EOSQL || true
249 CREATE USER 'root'@'${MYSQL_ROOT_HOST}' IDENTIFIED BY '${MYSQL_ROOT_PASSWORD}' ;
250 GRANT ALL ON *.* TO 'root'@'${MYSQL_ROOT_HOST}' WITH GRANT OPTION ;
254 # tell docker_process_sql to not use MYSQL_ROOT_PASSWORD since it is just now being set
255 docker_process_sql --dont-use-mysql-root-password --database=mysql <<-EOSQL
256 -- What's done in this file shouldn't be replicated
257 -- or products like mysql-fabric won't work
258 SET @@SESSION.SQL_LOG_BIN=0;
260 DELETE FROM mysql.user WHERE user NOT IN ('mysql.sys', 'mariadb.sys', 'mysqlxsys', 'root') OR host NOT IN ('localhost') ;
261 SET PASSWORD FOR 'root'@'localhost'=PASSWORD('${MYSQL_ROOT_PASSWORD}') ;
262 -- 10.1: https://github.com/MariaDB/server/blob/d925aec1c10cebf6c34825a7de50afe4e630aff4/scripts/mysql_secure_installation.sh#L347-L365
263 -- 10.5: https://github.com/MariaDB/server/blob/00c3a28820c67c37ebbca72691f4897b57f2eed5/scripts/mysql_secure_installation.sh#L351-L369
264 DELETE FROM mysql.db WHERE Db='test' OR Db='test\_%' ;
266 GRANT ALL ON *.* TO 'root'@'localhost' WITH GRANT OPTION ;
269 DROP DATABASE IF EXISTS test ;
272 # Creates a custom database and user if specified
273 if [ -n "$MYSQL_DATABASE" ]; then
274 mysql_note "Creating database ${MYSQL_DATABASE}"
275 echo "CREATE DATABASE IF NOT EXISTS \`$MYSQL_DATABASE\` ;" |docker_process_sql --database=mysql
278 if [ -n "$MYSQL_USER" ] && [ -n "$MYSQL_PASSWORD" ]; then
279 mysql_note "Creating user ${MYSQL_USER}"
280 echo "CREATE USER '$MYSQL_USER'@'%' IDENTIFIED BY '$MYSQL_PASSWORD' ;" |docker_process_sql --database=mysql
282 if [ -n "$MYSQL_DATABASE" ]; then
283 mysql_note "Giving user ${MYSQL_USER} access to schema ${MYSQL_DATABASE}"
284 echo "GRANT ALL ON \`$(echo $MYSQL_DATABASE | sed 's@_@\\_@g')\`.* TO '$MYSQL_USER'@'%' ;" | docker_process_sql --database=mysql
287 echo "FLUSH PRIVILEGES ;" | docker_process_sql --database=mysql
292 # echo the password to the "file" the client uses
293 # the client command will use process substitution to create a file on the fly
294 # ie: --defaults-extra-file=<( _mysql_passfile )
295 if [ '--dont-use-mysql-root-password' != "$1" ] && [ -n "$MYSQL_ROOT_PASSWORD" ]; then
298 password="${MYSQL_ROOT_PASSWORD}"
303 # check arguments for an option that would cause mysqld to stop
304 # return true if there is one
309 -'?'|--help|--print-defaults|-V|--version)
318 # if command starts with an option, prepend mysqld
319 if echo "$1" | grep '^-' >/dev/null; then
323 # skip setup if they aren't running mysqld or want an option that stops mysqld
324 if [ "$1" = 'mysqld' ] && ! _mysql_want_help "$@"; then
325 mysql_note "Entrypoint script for MySQL Server ${MARIADB_VERSION} started."
327 mysql_check_config "$@"
328 # Load various environment variables
329 docker_setup_env "$@"
330 docker_create_db_directories
332 # If container is started as root user, restart as dedicated mysql user
333 if [ "$(id -u)" = "0" ]; then
334 mysql_note "Switching to dedicated user 'mysql'"
335 exec gosu mysql "$0" "$@"
338 # there's no database, so it needs to be initialized
339 if [ -z "$DATABASE_ALREADY_EXISTS" ]; then
340 docker_verify_minimum_env
342 # check dir permissions to reduce likelihood of half-initialized database
343 ls /docker-entrypoint-initdb.d/ > /dev/null
345 docker_init_database_dir "$@"
347 mysql_note "Starting temporary server"
348 docker_temp_server_start "$@"
349 mysql_note "Temporary server started."
352 docker_process_init_files /docker-entrypoint-initdb.d/*
354 for i in $(echo $PORTAL_DB_TABLES | sed "s/,/ /g")
356 echo "Granting portal user ALL PRIVILEGES for table $i"
357 echo "GRANT ALL ON \`$i\`.* TO '$MYSQL_USER'@'%' ;" | "${mysql[@]}"
360 mysql_note "Stopping temporary server"
361 docker_temp_server_stop
362 mysql_note "Temporary server stopped"
365 mysql_note "MySQL init process done. Ready for start up."
372 # If we are sourced from elsewhere, don't perform any further actions
373 # https://stackoverflow.com/questions/2683279/how-to-detect-if-a-script-is-being-sourced/2942183#2942183
374 if [ "$(basename $0)" = "docker-entrypoint.sh" ]; then