Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: DOCU-2673

...

clearboth
width275px
alignright
classmenu

...

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.

...

With Magnolia 5.7 we also have been updated the Backup module to version 2.3. If you want to use the backup module, you must upgrade it to 2.3.

...

See also 

Jira
serverMagnolia - Issue tracker
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId500b06a6-e204-3125-b989-2d75b973d05f
keyMGNLEE-533
.

Anchor
anc-webdav-deprecation
anc-webdav-deprecation
WebDAV

You 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.

Anchoranchor
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 some names for field definitions. The name of a field definition is the node name if defined via JCR  in 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). 

...

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

    the newly released Magnolia bundles.

    Below are the latest versions of  the of the magnolia.properties files for the Magnolia 5.7.x series: 

    Artifact resource link
    rangeHigherVersion6.0
    groupIdinfo.magnolia.bundle
    artifactIdmagnolia-bundle-parent
    label$version
    renderTypedisplay_only
    versionSNAPSHOT
    resourceTypePOM

    Magnolia CE / Magnolia EE Standard *

    Code Pro
    profilebitbucket-ee
    languagetext
    titlece/magnolia-empty-webapp/src/main/webapp/WEB-INF/config/default/magnolia.properties
    collapsetrue
    urlhttps://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
    profilebitbucket-ee
    languagetext
    titleee/magnolia-enterprise-pro-webapp/src/main/webapp/WEB-INF/config/default/magnolia.properties
    collapsetrue
    urlhttps://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.

    ...

    • Update to the latest minor release version first before upgrading to the most recent major release.
      A June 2018 example: a customer is considering an upgrade from 5.5.8 to 5.7. The correct upgrade sequence is: 5.5.8 → 

      Artifact resource link
      rangeHigherVersion5.6
      groupIdinfo.magnolia.bundle
      artifactIdmagnolia-bundle-parent
      label$version
      renderTypedisplay_only
      resourceTypePOM
       → 
      Artifact resource link
      rangeHigherVersion5.7
      groupIdinfo.magnolia.bundle
      artifactIdmagnolia-bundle-parent
      label$version
      renderTypedisplay_only
      resourceTypePOM
       → 5.7.x

    • Update all external libraries required by the Magnolia release to which you intend to upgrade.
    • Because the upgrade process takes time and is vulnerable to incidents, we recommend you minimize the risk by cleaning up your system, removing unused data, reindexing everything and doing a full backup first.

    ...

    Expand
    titleClick to see an example
    Code Pro
    languagexml
    titlecustom-ee/custom-ee-webapp/pom.xml
    linenumberstrue
    <?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
    titleClick to see an example
    Code Pro
    languagexml
    titlecustom-ee/pom.xml
    linenumberstrue
    <?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
    languagexml
    linenumberstrue
    <properties>
      <magnoliaBundleVersion>5.7.7<1</magnoliaBundleVersion>
      <foobarModuleVersion>1.2</foobarModuleVersion>
      <javaVersion>1.8</javaVersion>
    </properties>

    ...

    Anchor
    anc-known-issues
    anc-known-issues
    Known issues

    Tomcat 8 using BCEL may throw class format exception

    Multiexcerpt include
    MultiExcerptNameissue
    PageWithExcerpt_known issue with tomcat 8.5x JAVA EE and BCEL

    -known-issues
    Known issues

    Tomcat 8 using BCEL may throw class format exception

    Multiexcerpt include
    MultiExcerptNameissue
    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.