This documentation is currently being worked on. Until the stable version of PrestaShop 1.5 is released, it should not be seen as definitive.
Table of content
Automatic upgrade (recommended)
PrestaShop introduced automatic upgrade in version 1.4.4 and 184.108.40.206, which was then turned into a free module for earlier versions (starting with PS 1.3) and later versions (including 1.5.x).
It enables shop owners to backup and update their site in a few clicks and no technical knowledge.
Downloading and installing the 1-Click Upgrade module
Simply follow the normal path to installing a module on PrestaShop:
- Download the 1-Click Upgrade module from PrestaShop Addons: http://addons.prestashop.com/en/administration-tools/5496-autoupgrade.html. Save the Zip file to your desktop.
- In your PrestaShop administration panel, go to the main "Modules" tab.
- Click on the "Add a module" button, located at the top right of the list of available modules.
If updating from version 1.4, click on the "Add a module from my computer" link, located at the top left.
- In the form that opens, click on the "Browse..." button, then find and select the module's Zip file that you just downloaded.
- Click the "Upload this Module" button. PrestaShop will put the module on your server, unzip it, and place the files in the
The module is now available in your list of modules, but you still have to install it:
- In the "Modules" tab, find the 1-Click Upgrade module: type "1-click upgrade" or "autoupgrade" in the module search box (not the global search at the top). A direct link to the module should appear as you type. Click it.
- PrestaShop then displays the module you just installed in the main list.
- Click the module's "Install" button.
The module is now ready to configure and use.
The Configuration Screen
The module's configuration screen is available from the "Modules" list, by clicking on the module's "Configure" link.
The configuration screen is also available from:
- PrestaShop 1.4: under the "Tools" tab, in the "1-Click Upgrade" sub-tab.
- PrestaShop 1.5: under the "Advanced parameters", in the "1-Click Upgrade" page.
The configuration screen presents you with a series of sections, providing information, tools and settings.
This section compares your version of PrestaShop with the latest stable one. You can quickly see whether you need to update or not. If you know that there is a newer version available than the one presented, you can trigger a version check by clicking the "Check if new version available" button.
If you want to check for a version other than a stable one (for instance, beta, RC or any other unstable version), click on the "More options (Expert mode)" button. This will open a new section, named "Advanced mode", where you can choose the distribution channel to which you want to update.
This section enables you to pinpoint exactly which version you want to upgrade your current PrestaShop installation to.
The options are:
- Channel. Choose the distribution channel that you want to use. The recommended selection is "Minor releases", which means "any stable release above the current one". The other options are:
- Major releases. Only major stable releases above your own: 1.3, 1.4, 1.5, etc.
- Release candidates. RC versions are deemed stable enough to be tested by the majority, but not stable enough to be the real release. Use at your own risks.
- Beta releases, alpha releases. These are development versions. Use at your own risks.
- Private release. Sometimes, the PrestaShop developers upload a private test version. If you have the right URL and hash key, you can update to this version easily using this channel. If you check the "Allow major upgrade" box, you indicate that are only interested in major releases.
- Local archive. To be used if you have downloaded the version you want to upgrade to in the correct local folder,
/admin/autoupgrade/download. Once you have selected archive in the drop-down selector, indicate the version number in the text field (be very exact!).
- Local directory. To be used if you have downloaded and uncompressed the version you want to upgrade to in the
/prestashopfolder must come directly from the archive that you downloaded.
- branch. Indicates if anything is available in the chosen channel.
- name. The name of the latest version in the chosen channel.
- url. The URL to the latest version in the chosen channel.
- md5. The hash check for the latest version in the chosen channel.
The "Checks" section gives you useful information on your current PrestaShop installation, and how it might interact with the automatic upgrade. You must make sure that all the checks are validated before you can launch the upgrade.
- Module version up-to-date (version). Indicates whether you need to update the update module itself. If you have just installed it, there is little chance you will need to update it.
If you do not have the latest version of the module, a button appears below this field, marked "Install the latest by clicking 'Add from my computer'". Clicking it takes you to the "Modules" page. From there, click on the "Add a module from my computer" link to reveal the pre-filled form. Click the "Download this module" button to start updating the module. Finally, go back to the 1-Click Upgrade configuration page to continue performing pre-upgrade checks.
- Root directory is fully writable. Indicates if the read/write permissions are correctly set. If not, you will have to change them, using your FTP client, such as FileZilla.
See the Getting Started guide's "System compatibility & system configuration" section for a quick explanation of how to perform a CHMOD.
- Shop deactivated. Indicates if your shop is active or in maintenance mode. You must put your shop in maintenance mode during the whole process (file backup, database backup, automatic upgrade, verification), so as to prevent customers from losing orders... and you from losing clients. The module will not disable your shop for you, but does provide a button leading to the shop preference page:
- PrestaShop 1.4: enable/disable the shop in the main "Preferences" tab.
- PrestaShop 1.5: enable/disable the shop in the "Maintenance" page, under the "Preferences" menu.
- Cache deactivated. Indicates whether your shop's cache is enabled or disabled. You must disable it during the whole process. The module will not do it for you.
- PrestaShop 1.4: enable/disable the cache in the "Performances" page, under the "Preferences" tab.
- PrestaShop 1.5: enable/disable the cache in the "Performance" page, under the "Advanced parameters" menu.
- PHP time limit: disabled. The automatic upgrade can be a lengthy process, as it needs to download the archive from prestashop.com, unzip it on the server, replace the currently installed files, then trigger the update itself. Hence, the PHP settings might be too low, and break the upgrade altogether, mid-process at worse. In this field, PrestaShop gives you an indication of the current PHP settings. Ideally, it should indicate "disabled".
- Options chosen. Before launching the upgrade, you must make sure that you understand the settings. The "Backup options" and "Upgrade options" sections are available at the bottom of the page, and if the settings have not yet been saved, a button takes you to them.
All these indicators must be green for the upgrade to work. Otherwise, the upgrade button will not appear.
For the curious, the numbered differences between your current version and the latest version in the chosen channel.
In case you have make changes directly to the core files instead of using the overriding possibilities of PrestaShop, these lists can help you know if your changes are safe or not.
Nevertheless, you can improve the lifespan of your custom code by turning it into overriding files. See the developer documentation for more information.
These options enable you to have some control on the backup process:
- Backup my files and database (required). It is not even an option: you must have your files backed-up, and the module will take care of this for you.
- Back up my images. You should let the module take care of your images too, in order to be able to do a clean re-install again by re-uploading your files.
These options enable you to have some control on the upgrade process:
- Preserve the original theme. The upgrade process overwrites the default theme with its latest incarnation. If you have made changes to the theme directly, you can protect these changes by choosing "Yes". As a reminder, it is NOT recommended to edit the default theme! You should make a copy of the theme, and make changes to that copy.
- Keep default mails. An update might bring new default e-mail templates. By default, the upgrade will replace the existing ones with the ones from the newer archive, and add the new templates. If you have customized your templates, it is recommended you keep them. You would then have to customize the new templates in order to fit the general style of your shop.
- Deactivate custom modules. It is recommended to choose "Yes" for this option, as some module might prove a hindrance when upgrading PrestaShop.
- Manual mode. If enabled, the module will stop at each step to ask you for confirmation.
- Server performance. Some shared hosted offer poor performance, which might hinder the performance of the upgrade process, or even make it fail. "Low" is thus selected by default, but if you know you have a powerful server, you can choose "Medium" or even "High".
The Upgrade process
Once all the indicators are green, the update button appears in the "Upgrade" section, along with an indication of which Smarty version you are currently using, and the URL from which the new version will be downloaded.
Clicking the "Upgrade PrestaShop now !" triggers the whole process.
Once the upgrade process is launched, the whole configuration page is replaced by two sections: "Activity Log" and "Rollback".
The activity log gives you a detailed journal of what the updater is doing, in a screen you can scroll through:
- Removed files: only the sample files are removed, such as empty override classes and controllers.
- Name of the backup archive: the name follows the
- Files added to the backup archive: all the remaining files of your current installation are put into the Zip archive.
- Database tables added to the backup archive: your files are important, but your whole catalog is stored in your database, and is therefore saved in the same archive.
- Files copied from the new archive: all the existing files are replaced by their new version.
- Merged translation files.
- Created, deleted, altered and updated database tables.
- Emptied temporary folders: if possible, the upgrader will try and delete the content of the cache folders.
A lot of files are mentioned during the whole process. You do not need to read all the notifications, it's only there for you to peruse in case of error.
You'll know the upgrade is over when the message "upgrade complete. Please check your front-office theme is functional (try to make an order, check theme)" appears in green, along with the following final log entry: "End of process".
The upgrader also indicates that you should re-enable your shop, but before you do that, you should first check that everything is working in your back-office: no errors, all products and categories are in place with their images and attached files, etc. Until you have checked that everything is okay in your shop, it is better to keep it from the public eye.
On first load, pages might look wonky: because your web browser caches files, it is probably using the old CSS files instead of the new ones. Do not hesitate to reload the page several times, or even empty your browser's cache, in order to get the correct interface.
Once you have made sure your PrestaShop installation is up and running, you can re-enable your shop using the option in the "Maintenance" page of the "Preferences" menu, then make tests on your front-office: browse products, sort them, try to order one, etc. In short, go through the entire buying process in order to make sure that you won't miss a sale.
Is everything working fine? Congratulations, you know have successfully upgraded your PrestaShop install!
Sadly, not all upgrades are successful – which is the very reason why you should always back-up all your files and data, and why PrestaShop performs an additional backup of said files and data by itself (which you should not always count on, obviously. Make your own backup first).
PrestaShop's own backup files are saved on your server, and if it turns out your update has gone badly, you can find them in the "Rollback" section of the configuration page for the 1-Click Upgrade module.
Backup files are created as soon as the upgrade process is started, and are available immediately in the "Choose your backup" drop-down list.
Choose the most recent one. The date and hour of the creation of the backup file is right within the name:
Vversion-date-hour-random, for instance "V220.127.116.11_20120907-114024-f85f41a" for a backup of a previous PrestaShop 1.4.9 installation, made September 7th 2012, at 11:40:24 AM.
The "Rollback" button triggers two actions:
- Takes the files from the latest backup, and re-installs them in place of those from the current installed version.
- Takes the data from the latest backup, and re-installs it in place of that from the current database.
Select the backup archive to which you want to roll back to, and click the "Rollback" button. As with the upgrade process, the whole interface disappears to only leave the "Activity Log" section and the "Rollback" section. You can follow the rollback process in the scrolling journal, and once it is finished, reload the page in order to check that everything is indeed back in place.