Magnolia 5.6 reached end of life on June 25, 2020. This branch is no longer supported, see End-of-life policy.
This page provides the most essential information you should be aware of when upgrading to Magnolia 5.6.x from any previous and currently supported version. Before commencing with the upgrade, please read:
If you are running an unsupported version of Magnolia, look at the migration process. You may also contact usfor for migration support and look at the migration process. Read the release notes for the version you are updating to and all intermediate versions.
Table of Contents |
---|
Please note depending on the number of versions in the version
workspace, the upgrade to 5.6.x from any version below may take from 20 to 30 minutes since all of the versions have to migrate to a new structure.
...
WEB-INF/lib
folder of your old Magnolia instances with new JARs from the bundle.index
folder under each workspace directory: repositories/magnolia/workspaces/<workspace>/index
. Indexes are recreated on startup, which might take a while depending on the size of your repository.magnolia.properties
files, compare the changes to the file in the new bundle. Properties may have been added and removed.2DO
2DO
If you had EE Pro 5.4.x or previous and are installing EE Pro 5.6: Due to component personalization bringing in new features to the page editor, you must replace the widgetset in the magnolia.properties
file. Either replace or add (depending on the update path):
Code Pro |
---|
magnolia.ui.vaadin.widgetset=info.magnolia.widgetset.MagnoliaProWidgetSet |
The default JCR persistency layer in Magnolia 5.6 is H2, which is reflected in the following setting of the magnolia.repositories.jackrabbit.config
property in the magnolia.properties
file:
...
Code Pro |
---|
magnolia.repositories.jackrabbit.config=WEB-INF/config/repo-conf/jackrabbit-bundle-derby-search.xml n your magnolia.properties file. |
Standard Templating Kit (STK) was deprecated on September 15, 2017 and will reach end of life on December 31, 2018. The replacement for STK is Magnolia Templating Kit (MTK), first released with Magnolia 5.4 on July 3, 2015. MTK is quicker to learn than STK and requires fewer skills. MTK is aimed at the increasing number of front-end developers who looked for something leaner and less time-consuming. MTE is front-end framework agnostic, which means you can integrate it with any modern framework such as Bootstrap or Foundation.
With the the release of Magnolia 5.6 we will stop producing preconfigured bundles and webapps with the STK based demo. If you still rely on STK, see how to add STK to your bundle.
Check your magnolia.properties
file for the presence of the following lines which configure a directory for loading file system resources and the file types Magnolia should observe in the classpath and reload on-change:
Code Block |
---|
magnolia.resources.dir=${magnolia.home} magnolia.resources.classpath.observation.pattern=.*\\.(ftl|yaml)$ |
In order to enable getting an HTML excerpt in a query result, you should update the configuration files of your Jackrabbit instances. Add the two <param/>
directives within your <SearchIndex>
block.
Code Block | ||
---|---|---|
| ||
<SearchIndex> <!-- more params here --> <!-- needed to highlight the searched term --> <param name="supportHighlighting" value="true"/> <!-- custom provider for getting an HTML excerpt in a query result with rep:excerpt() --> <param name="excerptProviderClass" value="info.magnolia.jackrabbit.lucene.SearchHTMLExcerpt"/> </SearchIndex> |
Add the log configuration for org.reflections
Code Block | ||
---|---|---|
| ||
... <category name="org.apache.jackrabbit"> <priority value="WARN" /> </category> <!-- Reflections library spoils logs with hundreds of harmless warnings; tries to look into native libs but none of its DefaultUrlTypes can handle them. --> <category name="org.reflections"> <priority value="ERROR" /> </category> <category name="com"> <priority value="WARN" /> </category> ... |
Magnolia 5.6 ee-bundle may require you to allocate more memory the Java Virtual Machine (JVM). If you see a java.lang.OutOfMemoryError
in the startup log or the system stops responding during installation, increase the Java heap size. The default maximum heap size is 512M. Try a higher amount such as 1024M. We are working on uncovering the root cause for the increased memory need.
See: Java out of memory
When selecting properties in a definition that are actually extended from another node in the config workspace, opening the definition in the Configuration app will not work correctly, as the underlying node/property doesn't exist. For example,
/.magnolia/admincentral#app:definitions-app:;app~site@subApps/browser/actions/addFolder/icon:treeview
points to config:/modules/site-app/apps/site/subApps/browser/actions/addFolder/icon
.
but all the actions are inherited from /modules/ui-admincentral/apps/configuration/subApps/browser
via extends.
For other known issues please this this the Known issues page.