To install Fix Packs and hotfixes on Liferay DXP, customers must first download the latest Patching Tool. For more information on how to configure the Patching Tool, see: Using the Patching Tool.
Notes:
If you are updating your instance from Liferay DXP 7.2 GA1 or Fix Pack 1, please follow the installation instructions described here:
If you are using Liferay provided Liferay DXP Docker images, please follow the installation instructions described here:
Environment
Fix Packs
- Liferay DXP 7.3 Fix Pack 2 and below
- Liferay DXP 7.2 GA1 and above
- Liferay DXP 7.1 GA1 and above
- Liferay DXP 7.0 GA1 and above
Hotfixes
- Liferay DXP All Versions
Resolution
Important: Be sure to backup your Liferay DXP installation and database regularly, especially before patching.
- Stop the application server first.
- Download the patch file(s) to the
{PATCHING_TOOL_HOME}/patchesfolder:- If you are installing a Fix Pack, download the Fix Pack to the folder. (Do not unzip the file)
- If you are installing a hotfix, download the hotfix along with its related Fix Pack to the folder. (Do not unzip the files)
- Execute the command:
patching-tool info(Windows) or./patching-tool.sh info(Unix/Linux) in order to confirm the patch is available to be installed.- If the patching tool output indicates that the patch is
Currently not installed; Won't be installedfulfill the required dependencies prior to completing the next steps.
- If the patching tool output indicates that the patch is
- Execute the command:
patching-tool install(Windows) or./patching-tool.sh install(Unix/Linux).- It is not necessary to revert prior to installing a new patch. The patching tool will revert the previously installed Fix Packs before installing any new patches.
- Confirm the patch was installed by executing
patching-tool info(Windows) or./patching-tool.sh info(Unix/Linux). You should see anInext to the installed patch or patches. - Clean up the cache folders within DXP's
{$LIFERAY_HOME}:-
Delete the
$LIFERAY_HOME/osgi/statefolder. -
Empty the
$LIFERAY_HOME/Workfolder -
Empty the
$LIFERAY_HOME/tomcat-version/tempfolder -
Empty the
$LIFERAY_HOME/tomcat-version/workfolder
-
Delete the
- Start the application server again.
If the hotfix is not installed, or if you receive an error that is not covered in the documentation below, please open a Help Center ticket and provide the full patching-tool output.
Note: If there are any issues with the installed fixes, verify that there are no remaining files within the application server cache from the previous patch installation of a Fix Pack or hotfix. Consult the platform vendor's documentation on where to find the cache.
Do not delete these two files!
During the installation, patching-backup-deps.zip and patching-backup.zip files will be created and stored in the /ROOT/WEB-INF folder.
The patching-backup.zip file is necessary for installing future patches because Patching Tool reverts the previously installed Fix Packs before installing a new one. In order to revert the installed Fix Pack, the Patching Tool examines the contents of the patching-backup.zip in order to determine what changes have been made that it needs to revert.
web.xml file inside the /WEB-INF folder will always be overwritten by the one inside the patch. Any custom configurations made by system administrators will be lost. Administrators should remember to add back whatever custom configurations before restarting the application server.
While removing the patching-backup.zip file does not affect the Patching Tool's report of what is installed in the bundle, we do not recommend removing the file from the ROOT/WEB-INF because doing so will cause future installations to fail.
If there are any other hooks and plugins already installed, there is no need to remove them first. The Patching Tool updates the Liferay product's core infrastructure first. If there are any Liferay plugins installed, there is a separate command to update them. See the article: Updating Plugins After Applying a Patch.
Note: Patching a Cluster requires additional considerations
Note: It is sometimes necessary to clear the browser or server caches for CSS or JS changes to be reflected in the updated environment. See article Why are my theme JS and CSS changes showing only if I clear the server's cache?
Additional Information
Updating the Patching Tool: When a patch you’re trying to install requires a Patching Tool update, the Patching Tool will tell you. To update the Patching Tool, download the latest version from the Download page. Overwrite the existing Patching Tool by unzipping the new one to the patching-tool folder’s parent folder.
Database Indexes: If there are new database indexes created by the patch, the Patching Tool tells you to update them. To get the list, run this command:
patching-tool index-info
Since there’s no database connection at patching time, the indexes must be created at portal startup. If the server has permissions to modify the database indexes, instruct Liferay DXP to create the indexes automatically at startup by adding this setting to your portal-ext.properties file:
database.indexes.update.on.startup=true
Otherwise, you must create the indexes manually. Check the patching-tool index-info command output for more details.
Managing Hotfixes and Patches: Hotfixes are on-demand fixes provided directly to specific customers, and Fix Packs are larger bundles of hotfixes provided to all customers at regular intervals. If you already have a hotfix installed and the Fix Pack that contains that hotfix is released, the Patching Tool can manage this for you. Fix packs always supersede hotfixes; so when you install your Fix Pack, the redundant hotfix you already have is uninstalled and the Fix Pack version is installed in its place.
Since Fix Packs are cumulative, the latest Fix Pack contains all of the updates from the previous Fix Packs for the same Liferay version. You only need to install the latest one, and in most cases there is no need to manually uninstall the previous version.
Fix Pack Dependencies: Most hotfixes depend on a certain Fix Pack. If you attempt to install a hotfix that depends on a certain Fix Pack, the Patching Tool notifies you. Go to the Downloads page and obtain the necessary Fix Pack. Once all the necessary patches are available in the patches folder (your hotfix and required Fix Pack), the Patching Tool installs them.
See also: