If you want to know more about all the upgrade steps of the Mautic 3 upgrade process, this is the place to be.
The upgrade process consists of multiple steps to make it as robust as possible. If the process fails at a certain step, you can find all details about the specific error code on the Mautic 3 upgrade errors page.
If you use the web interface to do the upgrade, and you're stuck, you can always go to a specific step by adding the step code to the URL, e.g. upgrade_v3.php#buildCache
. Please note that we don't support manually switching between steps, only do so when support asks you to do so!
Code: preUpgradeChecks
Here, we do some checks prior to starting the upgrade, to make sure your system is compatible with the upgrade. The checks are:
api_rate_limiter_cache
set? TODO add docsspool/default
folder? This indicates that there are still emails in the queuemax_execution_time
either 0 (unlimited) or > 240? If not, we try to set it, if that doesn't work, we show an errormysqldump
available for creating database backups?memory_limit
equal to or higher than 256M? If not, we try to set it, if that doesn't work, we show an errorCode: startUpgrade
Starts the upgrade and starts logging things as well. In case something goes wrong, you can send us your log file so that we can assist further.
Code: backupDatabase
If mysqldump
is available, we create a database backup. Especially on shared hosts this function might not be available.
Code: applyV2Migrations
During this stage we are applying any database migration is that remain outstanding for your Mautic 2.16.3 instance. This can sometimes happen if a previous update has not completed successfully. It is important that your database has all of the updates required before we proceed.
Code: fetchUpdates
In this stage we are downloading the Mautic 3 upgrade package from the server.
Code: extractUpdate
In this stage we are extracting the files from the upgrade package and saving them into a folder which we will then use for your migration.
Code: moveMautic2and3Files
This is where a lot of magic happens. A complete backup is taken of your Mautic 2 installation, after which we move Mautic 3 files into place.
Code: updateLocalConfig
A few configuration parameters have changed in Mautic 3; the upgrade script automatically updates them for you if necessary. To get an overview of all changes configuration parameters, see our update doc.
Code: applyMigrations
The database structure has slightly changed in Mautic 3. As part of the standard update process in Mautic, we check for database migrations and execute those.
Code: restoreUserData
If you had any custom plugins/themes/media installed in Mautic 2, this step will restore those in Mautic 3 by copying them over to the "new" Mautic 3 folder.
Code: cleanupFiles
In this step, we clean up some of the installation files.
Code: buildCache
Mautic always prepares cache the first time you start it, so that it runs faster on subsequent requests. In this step, we prepare the cache, so that you'll be able to get started easily and quickly.
Code: finished
Cleans up some last files, and allows the user to open Mautic 3.
A last step that is offered at the end of the upgrade, is to remove backup files. The user is advised to remove the backup files as soon as possible; this step also removes the upgrade script itself.
Found errors? Think you can improve this documentation? edit this page on Github