...
clear | both |
---|
width | 275px |
---|
align | right |
---|
class | menu |
---|
...
This page contains the information you should be aware of when you are upgrading to Magnolia 5.7.x from any previous and currently supported version.
...
What to update
Anchor |
---|
| adding-privacy-modules |
---|
| adding-privacy-modules |
---|
|
Add privacy modules
...
Expand |
---|
title | Click to see how to install the Privacy modules |
---|
|
Multiexcerpt include |
---|
MultiExcerptName | installation |
---|
PageWithExcerpt | Privacy module |
---|
|
|
...
Changes on add-on modules
Include Page |
---|
| _what is an add-on module |
---|
| _what is an add-on module |
---|
|
Updated add on modules
With Magnolia 5.7 we also have updated the Backup module to version 2.3. If you want to use the backup module, you must upgrade it to 2.3.
Anchor |
---|
| anc-outdated-addons |
---|
| anc-outdated-addons |
---|
|
Outdated add-on modulesIn Magnolia 5.7 we In Magnolia 5.7 we removed several add-on modules (not bundled). We recommend you remove them too.
...
See also
Jira |
---|
server | Magnolia - Issue tracker |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
serverId | 500b06a6-e204-3125-b989-2d75b973d05f |
---|
key | MGNLEE-533 |
---|
|
.
Anchor |
---|
| anc-webdav-deprecation |
---|
| anc-webdav-deprecation |
---|
|
WebDAVYou must remove the magnolia-module-webdav
module because Apache .
Jackrabbit 2.16 no longer supports WebDAV.16 removed the HttpClient3 based WebDAV API and introduced a completely new WebDAV API.
You can do many common WebDAV tasks with light development. You can store web resources such as CSS and JS files, template scripts and many more items in a light module and edit them comfortably as local files with your favorite editor. When you are done with the changes, push and commit the files to Git and configure Magnolia to watch for changes in the remote Git directory. Magnolia will register changes in light modules instantly.
Anchor |
---|
| anc-check-custom-fields-based-on-magnolia- |
---|
|
Anchor |
---|
anc-check-custom-fields-based-on-magnolia-fields | | anc-check-custom-fields-based-on-magnolia-fields |
---|
|
Check custom fields extending or decorating Magnolia fields
We have changed a few some names for field definitions. This was part of the initiative to reference fields by its "short" name with the property fieldType
(see Referencing fields). The name which may have changed The name of a field definition is the node name if the field is defined via JCR in the folder modules/some-module/fieldTypes
or the file name of a YAML based definition. Field definitions which have been defined via JCR and which we have renamed now are defined with YAML files. This was part of the initiative to reference fields by its "short" name with the property fieldType
(see Referencing fields).
If you have custom fields which reuse an existing Magnolia configuration via YAML include, YAML inherit, JCR extends or by decoration, your custom definition may be broken now if you reference to a field which has changed its name.
Here's a list of the field names which have been changed:
...
Expand |
---|
title | Click here to expand to see the complete list of changed field names |
---|
|
Include Page |
---|
| _field names shortening |
---|
| _field names shortening |
---|
|
|
...
Use the Definitions app to check for problems.
...
Tip |
---|
When upgrading Magnolia, it is always worth comparing your magnolia.properties file with the one from the newly released Magnolia bundles. |
todo |
- Remove the SNAPSHOT version on the artifact macro displaying the latest 5.7.x version
- fetch the proper version of the properties files based on the latest tagged version after the release.
|
Below are the latest versions of the of the magnolia.properties
files for the Magnolia 5.7.x series:
Artifact resource link |
---|
rangeHigherVersion | 6.0 |
---|
groupId | info.magnolia.bundle |
---|
artifactId | magnolia-bundle-parent |
---|
label | $version |
---|
renderType | display_only | version | SNAPSHOT |
---|
resourceType | POM |
---|
|
Magnolia CE / Magnolia EE Standard *
Code Pro |
---|
profile | bitbucket-ee |
---|
language | text |
---|
title | ce/magnolia-empty-webapp/src/main/webapp/WEB-INF/config/default/magnolia.properties |
---|
collapse | true |
---|
url | https://git.magnolia-cms.com/projects/PLATFORM/repos/ce/raw/magnolia-empty-webapp/src/main/webapp/WEB-INF/config/default/magnolia.properties?at=masterrefs%2Ftags%2Fmagnolia-bundle-5.7.3 |
---|
|
|
*) Magnolia CE and Magnolia EE Standard use the same magnolia.properties
file.
...
Code Pro |
---|
profile | bitbucket-ee |
---|
language | text |
---|
title | ee/magnolia-enterprise-pro-webapp/src/main/webapp/WEB-INF/config/default/magnolia.properties |
---|
collapse | true |
---|
url | https://git.magnolia-cms.com/projects/PLATFORM/repos/ee/raw/magnolia-enterprise-pro-webapp/src/main/webapp/WEB-INF/config/default/magnolia.properties?at=masterrefs%2Ftags%2Fmagnolia-enterprise-bundle-5.7.3 |
---|
|
|
Apache Tomcat 9.0.8
If you use Apache Tomcat: we have upgraded to Apache Tomcat 9.0.8.
...
- commons-lang3-3.7
- freemarker-2.3.38
- gson-2.2.2
- guice-4.2.0
- guice-multibindings-4.2.0
- jackson-databind-2.9.5
- jsoup-1.8.3
- mycila-guice-closeable-4.0
- mycila-guice-injection-4.0
- mycila-guice-jsr-4.0
- snakeyaml-1.21
- xercesImpl-2.12
- .21
We removed Apache Xerces (xercesImpl
) due to the fact that Java (since Java SE 7) already contains Java API for XML Processing (JAXP).
How to update
Recommendations
...
- Stop the application server.
- Extract the new Magnolia bundle.
- Replace JAR files in the
WEB-INF/lib
folder of your old Magnolia instances with new JARs from the bundle. Also replace modules coming from the add-ons bundle (magnolia-enterprise-addons-bundle), in case you are using any of these.
Magnolia 5.7 updates numerous 3rd-party libraries, see Java 8, 9 and 10 runtime compatibility and library updates. - Remove any module JARs you had previously removed from your instances. Add any modules you may have previously added.
We have removed several add-on modules. You must also remove some. See Remove outdated add-on modules. - Add new Magnolia modules. See Add the privacy modules.
- Optional: Delete all indexes to give them a boost. Delete the
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. - If you customized your
magnolia.properties
files, compare the changes to the file in the new bundle. Properties may have been added or removed. - Read the release notes for all intermediate versions for any additional update tasks.
- Restart the application server.
- In your browser, go to the Magnolia instances and run the web update.
...
Expand |
---|
title | Click to see an example |
---|
|
Code Pro |
---|
language | xml |
---|
title | custom-ee/custom-ee-webapp/pom.xml |
---|
linenumbers | true |
---|
| <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.example</groupId>
<artifactId>custom-ee</artifactId>
<version>1.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>custom-ee-webapp</artifactId>
<name>custom-ee: webapp</name>
<packaging>war</packaging>
<dependencies>
<dependency>
<groupId>info.magnolia.eebundle</groupId>
<artifactId>magnolia-enterprise-pro-webapp</artifactId>
<type>war</type>
</dependency>
<dependency>
<groupId>info.magnolia.eebundle</groupId>
<artifactId>magnolia-enterprise-pro-webapp</artifactId>
<type>pom</type>
</dependency>
<!-- More custom modules here -->
<dependency>
<groupId>com.example</groupId>
<artifactId>foobar-module</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<artifactId>maven-war-plugin</artifactId>
<configuration>
<!-- exclude jars copied "physically" from the webapp overlay - so we only get those resolved by Maven's dependency management -->
<dependentWarExcludes>WEB-INF/lib/*.jar</dependentWarExcludes>
</configuration>
</plugin>
</plugins>
</build>
</project> |
|
...
Expand |
---|
title | Click to see an example |
---|
|
Code Pro |
---|
language | xml |
---|
title | custom-ee/pom.xml |
---|
linenumbers | true |
---|
| <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>custom-ee</artifactId>
<name>custom-ee (parent pom)</name>
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>
<properties>
<magnoliaBundleVersion>5.6.6</magnoliaBundleVersion>
<foobarModuleVersion>1.2</foobarModuleVersion>
<javaVersion>1.8</javaVersion>
</properties>
<!-- Fill the following in, so you can use the release plugin -->
<scm>
<connection/>
<developerConnection/>
<url/>
</scm>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>info.magnolia.eebundle</groupId>
<artifactId>magnolia-enterprise-bundle-parent</artifactId>
<version>${magnoliaBundleVersion}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!-- More dependencies for your custom modules here -->
<dependency>
<groupId>com.example</groupId>
<artifactId>foobar-module</artifactId>
<version>${foobarModuleVersion}</version>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.7.0</version>
<configuration>
<source>${javaVersion}</source>
<target>${javaVersion}</target>
</configuration>
</plugin>
</plugins>
<!-- default resources configuration which will filter your module descriptors -->
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*</include>
</includes>
</resource>
<resource>
<filtering>true</filtering>
<directory>src/main/resources</directory>
<includes>
<include>META-INF/magnolia/*</include>
</includes>
</resource>
</resources>
</build>
<repositories>
<repository>
<id>magnolia.public</id>
<url>https://nexus.magnolia-cms.com/content/groups/public</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
<repository>
<id>magnolia.enterprise.releases</id>
<url>https://nexus.magnolia-cms.com/content/repositories/magnolia.enterprise.releases</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>vaadin-addons</id>
<url>https://maven.vaadin.com/vaadin-addons</url>
</repository>
</repositories>
<modules>
<module>custom-ee-webapp</module>
</modules>
</project> |
|
...
Code Pro |
---|
language | xml |
---|
linenumbers | true |
---|
|
<properties>
<magnoliaBundleVersion>5.7.7<1</magnoliaBundleVersion>
<foobarModuleVersion>1.2</foobarModuleVersion>
<javaVersion>1.8</javaVersion>
</properties> |
...
Anchor |
---|
| anc-known-issues |
---|
| anc-known-issues |
---|
|
Known issuesTomcat 8 using BCEL may throw class format exception
Multiexcerpt include |
---|
MultiExcerptName | issue |
---|
PageWithExcerpt | _known issue with tomcat 8.5x JAVA EE and BCEL |
---|
|
Known issuesTomcat 8 using BCEL may throw class format exception
Multiexcerpt include |
---|
MultiExcerptName | issue |
---|
PageWithExcerpt | _known issue with tomcat 8.5x JAVA EE and BCEL |
---|
|
If you encounter other problems, check the Known issues page.
Virtual URI mappings not working if too many are configured
To mitigate an issue caused by having more than 500 configured virtual URI mappings in light modules, a WARN-level message is now logged when a DirectoryWatcher
overflow occurs (MAGNOLIA-7762). We recommend to keep the number of files in a single folder below 100 and to use folder hierarchies whenever possible. For the upcoming fix, see MAGNOLIA-7798If you encounter other problems, check the Known issues page.