Upgrade from DigitalFactory 7.0.0 to DigitalFactory 7.1.0

Upgrading to 7.1.0.0 consists of one unique, easy step; please read it carefully before proceeding.

Please:

  • Stop the user requests / traffic to the server (either on the front-end Apache HTTPD server or firewall/router)
  • Stop Jahia before backing up and running the fix applier
  • Backup your Jahia installation before running the fix applier 
  • Run a pre-production test first

 

  • In DX 7.1, the runtime data and main configuration files are by default located outside of the Digital Experience Manager Web application (the feature, known previously as “externalization”). This allows for more clear separation of artifacts, better customization, production deployment and maintainability throughout the project life-cycle, including hot fixes and upgrades. By default the runtime data is saved in a new folder named digital-factory-data and the configuration in another folder named digital-factory-config. The FixApplier takes care of this modification during its execution.
  • Since DX 7.1, "/find" servlet is disabled by default. You can re-enable it by changing the value of jahia.find.disabled, but it is advised for security reasons to keep it disabled. In case you have used it to query content inside the Jahia JCR repository, now you can use new RESTful API and the prepared queries. Here you will find more details about how this API can be used to retrieve contents.
  • Since DX 7.1, users and groups provider service has been changed. For keeping the compatibility with the previous version of this service in DX 7.0, new module "Jahia Users and Groups Bridge Provider" has been developed and is available in our public App Store. In case you have your own customization of this service in DX 7.0, you need to deploy this module to your DX 7.1.
  • String properties containing path to JCR nodes are never updated. As ldap user path have changed in DX 7.1, if you were storing user path in a string property, you'll need to update them manually.
  • Please make sure you don't have ongoing workflow task on your platform before starting your migration, all tasks should be completed before.

 

DF 7.1 is packaged with Tomcat 8 and for this reason we are providing 2 Fix Appliers:


For a standalone installation

Step 1:Jahia Core & Modules Migration

The first step of the migration is to copy the fix applier you would like to use on your production server.

At this stage, a list of all the files you have customized in your installation will help you to go through the upgrade and decide more easily if you want to merge, keep or overwrite the files.

For all the files impacted, the fix applier will create a backup in the following folder:

$USER_HOME/.fixapplier/backup/ and a detailed log is also available in your <Jahia_installation>/tomcat/webapps/ROOT/META-INF/updates/history/fixes/<FiXAPPLIER_NAME>.log or if you didn't use the default ROOT context in your <JAHIA_INSTALLATION>/tomcat/webapps/<your context>/META-INF/updates/history/fixes/<FiXAPPLIER_NAME>.log

If the fix creator detects that a file has been modified it will try to automatically merge it. If the merge fails you will be able to overwrite the files or skip it installing the modification.
If the merge fails or you decide to skip it, a diff file <FILE_NAME>.patch will be available in the destination folder, please make sure that you don't forget to manually apply the changes.

In DX 7.1, jahia.advanced.properties is renamed to jahia.node.properties, all setting except cluster related ones are moved to the jahia.properties and only cluster setting is kept in jahia.node.properties which are now located in the new externalized configuration folder named by default digital-factory-config. Please make sure your settings are well transfered between these two files at the of migration procedure.

1. Stop Jahia

2a. If you are upgrading your complete Digital Experience Manager package :

Open a terminal in the JAHIA_INSTALLATION/ and type the following command:

java -jar <PATH-TO-FIX-APPLIER>/<FIXAPPLIER_PACKAGE_NAME>.jar

If you use Previous Digital Experience Manager's configuration externalization:

---------------------------------------------------------------------------------------

The FixApplier will autmatically move your externalized configuration to its new location.

By default it will try to look for an externalized configuration in the default location (tomcat/lib/jahia-config.jar) and then will automatically rename jahia-config.jar into jahia-config.jar.moved.

If you are not using the default location, you need to specify it on the FixApplier command line as in the following example:

 java -DalternateJahiaConfigPath=tomcat/jahiaConfig/org/jahia/config -jar DigitalFactory-CommunityDistribution-7.1.0.0-package_7.0.0.0_r49489_to_7.1.0.0_r52740.jar

In the above example the externalized configuration is inside an exploded directory tomcat/jahiaConfig. If you are using a JAR to store the externalized configuration (this is the default behavior), you need to specify the configuration location as in the next example:

 java -DalternateJahiaConfigPath=../../lib/jahia-config.jar!org/jahia/config -jar DigitalFactory-CommunityDistribution-7.1.0.0-package_7.0.0.0_r49489_to_7.1.0.0_r52740.jar

The "!" (exclamation point) is used to specify a path inside the JAR file.

The FixApplier will tell you that it cannot detect the location of jahia.properties and you will be prompted for the folder, where it can be found. Expand the jahia-config.jar into a temporary folder, say <temp>/jahia-config, and enter the path <temp>/jahia-config/org/jahia/config into the prompt of the fix applier. After that it will continue and complete successfully.

Here a manual step is required to remove that jahia-config.jar from the application classpath.

If you are using Digital Experience Manager in a web context other than ROOT:

---------------------------------------------------------------------------------------

If you have installed Digital Experience Manager in another context than the default ROOT context, you will need to specify the directory location of the Digital Experience Manager web application on the file system in a command line option, as in the following example:

 java -DwebappDirectory=tomcat/webapps/jahia  -jar DigitalFactory-CommunityDistribution-7.1.0.0-package_7.0.0.0_r49489_to_7.1.0.0_r52740.jar

In the above example the "jahia" context has been used instead of the default ROOT context. Note that the web application could be located anywhere else, simply specify the directory in the command line property and the FixApplier will look for it in the specified directory.

2b. If you are upgrading your webapps :

Open a terminal in the JAHIA_INSTALLATION/tomcat/webapps/ROOT or JAHIA_INSTALLATION/tomcat/webapps/<your context> if you didn't use the default ROOT context  and type the following command:

java -jar <PATH-TO-FIX-APPLIER>/<FIXAPPLIER_NAME>.jar

The fix applier will manage the upgrade of your platform by deleting, updating and merging all the necessary files. It will now handles the migration of Jahia Core and all the additional Jahia modules installed on your platform.

In case you have externalized your configuration (jar file or folder), you will need to apply the modification relative to jahia.properties and jahia.advanced.properties (or jahia.node.properties) manually at the appropriate place.

Please review your log before starting the next step to ensure you haven't missed a file that needs to be manually merged.

3. Clean the following Tomcat folder

The fix applier now handles the cleaning of the tomcat folders automatically but depending on the OS and some permissions you may need to clean it manually.

Remove the content of your folders <JAHIA_INSTALLATION>/tomcat/temp and <JAHIA_INSTALLATION>/tomcat/work

4. Clean the resource folder

The fix applier will also handles the cleaning of the <JAHIA_INSTALLATION>/digital-factory-data/generated-resources folder automatically but depending on the OS and some permissions you may need to clean it manually.

5. Start your JAHIA

Your Digital Experience Manager upgrade is now completed.

 

For a clustered installation

Step 1:Migration of all your nodes STARTING by the processing node

1. Shut all nodes down

2. Apply the step described for a standalone installation 

3. Repeat the previous step for each of your other cluster node

 

Your Digital Experience Manager upgrade is now completed.

icon-upgrades.pngicon-upgrades.png

Download these 2 fix appliers and follow the instructions on the left

Contact
Share

Get in touch

Whether you are a current user or if you are just evaluating Jahia, we are here to help.

Contact us

Share this page