Merge pull request #112 from linuxserver/upgrade

Upgrade

Author: nemchik

readme-vars.yml

@@ -53,7 +53,7 @@ optional_block_1: false
 app_setup_block_enabled: true
 app_setup_block: |
   If you didn't set a password during installation, (see logs for warning) use
-  `mysqladmin -u root password <PASSWORD>`
+  `mariadb-admin -u root -p<PASSWORD>`
   to set one at the docker prompt...
 
   NOTE changing the MYSQL_ROOT_PASSWORD variable after the container has set up the initial databases has no effect, use the mysqladmin tool to change your mariadb password.
@@ -94,8 +94,17 @@ app_setup_block: |
   ```
   This will have the same effect as setting the `REMOTE_SQL` environment variable. The sql will only be run on the containers first boot and setup.
 
+  ### Upgrading
+
+  When this container initializes, if `MYSQL_ROOT_PASSWORD` is set an upgrade check will run. If an upgrade is required the log will indicate the need to run:
+
+  ```
+  mariadb-upgrade -u root -p<PASSWORD>
+  ```
+
 # changelog
 changelogs:
+  - { date: "09.12.22:", desc: "Add upgrade check warning." }
   - { date: "11.10.22:", desc: "Rebase master to Alpine 3.16, migrate to s6v3, remove password escape logic which caused problems for a small subset of users." }
   - { date: "06.07.21:", desc: "Rebase master to alpine." }
   - { date: "03.07.21:", desc: "Rebase to 3.14." }

root/etc/s6-overlay/s6-rc.d/init-mariadb-initdb/run

@@ -1,52 +1,35 @@
 #!/usr/bin/with-contenv bash
 # shellcheck shell=bash
 
-# set start function that creates user and password, used later
-start_mysql() {
-    mysqld --datadir="${DATADIR}" --init-file="${tempSqlFile}" --user=abc &
+# set start function used later
+start_mariadb() {
+    mariadbd --datadir="${DATADIR}" --init-file="${tempSqlFile}" --user=abc &
     pid="$!"
     RET=1
     while [[ RET -ne 0 ]]; do
-        mysql -uroot -e "status" >/dev/null 2>&1
+        mariadb -uroot -e "status" >/dev/null 2>&1
         RET=$?
         sleep 1
     done
 }
 
 # test for existence of mysql folder in datadir and start initialise if not present
-# BEGIN: No indentation due to heredocs
 if [[ ! -d "${DATADIR}/mysql" ]]; then
-
     # load env file if it exists
     if [[ -f "/config/env" ]]; then
+        # shellcheck source=/dev/null
         source /config/env
     fi
 
-    # set basic sql command
+    # make temp sql init file
     tempSqlFile=$(mktemp)
+
+    # set basic sql command
     cat >"${tempSqlFile}" <<-EOSQL
 DELETE FROM mysql.user WHERE user <> 'mariadb.sys';
 EOSQL
 
-    # set what to display if no password set with variable MYSQL_ROOT_PASSWORD
-    NOPASS_SET=$(mktemp)
-    cat >"${NOPASS_SET}" <<-EOFPASS
-#################################################################
-# No root password or too short a password, min of 4 characters #
-#    No root password will be set, this is not a good thing     #
-#    You shoud set one after initialisation with the command    #
-#             mysqladmin -u root password <PASSWORD>            #
-#################################################################
-EOFPASS
-
-    # test for empty password variable, if it's set to 0 or less than 4 characters
-    if [[ -z "${MYSQL_ROOT_PASSWORD}" ]]; then
-        TEST_LEN="0"
-    else
-        TEST_LEN=${#MYSQL_ROOT_PASSWORD}
-    fi
-
-    if [[ "${TEST_LEN}" -lt "4" ]]; then
+    if [[ "${#MYSQL_ROOT_PASSWORD}" -lt "4" ]]; then
         MYSQL_PASS="CREATE USER 'root'@'%' IDENTIFIED BY '' ;"
     else
         MYSQL_PASS="CREATE USER 'root'@'%' IDENTIFIED BY '${MYSQL_ROOT_PASSWORD}' ;"
@@ -58,7 +41,7 @@ EOFPASS
         [[ "${MYSQL_DATABASE+x}" ]] &&
         [[ "${MYSQL_PASSWORD+x}" ]] &&
         [[ "${#MYSQL_PASSWORD}" -gt "3" ]]; then
-        read -r -d '' MYSQL_DB_SETUP <<EOM
+        read -r -d '' MYSQL_DB_SETUP <<-EOM
 CREATE DATABASE \`${MYSQL_DATABASE}\`;
 CREATE USER '${MYSQL_USER}'@'%' IDENTIFIED BY '${MYSQL_PASSWORD}';
 GRANT ALL PRIVILEGES ON \`${MYSQL_DATABASE}\`.* TO '${MYSQL_USER}'@'%';
@@ -81,8 +64,6 @@ EONEWSQL
         cat /config/initdb.d/*.sql >>"${tempSqlFile}"
     fi
 
-    chown -R abc:abc "${tempSqlFile}"
-
     # ingest remote sql if REMOTE_SQL is set
     if [[ -n "${REMOTE_SQL+set}" ]]; then
         IFS=, read -ra URLS <<<"${REMOTE_SQL}"
@@ -92,34 +73,46 @@ EONEWSQL
             fi
         done
     fi
-    # set some permissions needed before we begin initialising
-    chown -R abc:abc /config/log/mysql /var/run/mysqld /var/lib/mysql
+
+    # set some permissions needed before we begin
+    lsiown -R abc:abc "${tempSqlFile}" /config/log/mysql /var/run/mysqld /var/lib/mysql
     chmod -R 777 /config/log/mysql /var/run/mysqld /var/lib/mysql
 
     # initialise database structure
-    mysql_install_db --datadir="${DATADIR}" --user=abc --auth-root-authentication-method=normal
+    mariadb-install-db --datadir="${DATADIR}" --user=abc --auth-root-authentication-method=normal
 
-    # start mysql and apply our sql commands we set above
-    start_mysql
+    # start mariadb and apply our sql commands we set above
+    start_mariadb
 
     # shut down after apply sql commands, waiting for pid to stop
-    mysqladmin -u root shutdown
+    mariadb-admin -u root shutdown
     wait "${pid}"
     echo "Database Setup Completed"
 
     # display a message about password if not set or too short
-    if [[ "${TEST_LEN}" -lt "4" ]]; then
-        printf '\n\n\n%s\n\n\n' "$(<"${NOPASS_SET}")"
+    if [[ "${#MYSQL_ROOT_PASSWORD}" -lt "4" ]]; then
+        cat <<-EOFPASS
+
+
+
+#################################################################
+# No root password or too short a password, min of 4 characters #
+#    No root password will be set, this is not a good thing     #
+#    You shoud set one after initialisation with the command    #
+#              mariadb-admin -u root -p<PASSWORD>               #
+#################################################################
+
+
+
+EOFPASS
+
         sleep 5s
     fi
 
     # clean up any old install files from /tmp
-    rm -f "${NOPASS_SET}"
     rm -f "${tempSqlFile}"
-
-# END: No indentation due to heredocs
 fi
 
 # own the folder the pid for mysql runs in
-chown -R abc:abc /var/run/mysqld
-chown -R abc:abc /config
+lsiown -R abc:abc /var/run/mysqld
+lsiown -R abc:abc /config

root/etc/s6-overlay/s6-rc.d/init-mariadb-upgrade/dependencies.d/svc-mariadb

@@ -0,0 +1,27 @@
+#!/usr/bin/with-contenv bash
+# shellcheck shell=bash
+
+if [[ "${#MYSQL_ROOT_PASSWORD}" -gt "3" ]]; then
+    # display a message about upgrading database if needed
+    if mariadb-upgrade -u root -p"${MYSQL_ROOT_PASSWORD}" --check-if-upgrade-is-needed >/dev/null 2>&1; then
+        cat <<-EOF
+
+
+
+#################################################################
+#                                                               #
+#           An upgrade is required on your databases.           #
+#                                                               #
+#         Stop any services that are accessing databases        #
+#          in this container, and then run the command          #
+#                                                               #
+#             mariadb-upgrade -u root -p<PASSWORD>              #
+#                                                               #
+#################################################################
+
+
+
+EOF
+        sleep 5s
+    fi
+fi

root/etc/s6-overlay/s6-rc.d/init-mariadb-upgrade/run

@@ -0,0 +1 @@
+oneshot

root/etc/s6-overlay/s6-rc.d/init-mariadb-upgrade/type

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-mariadb-upgrade/run