Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Stop the application server.
  2. Extract the new Magnolia bundle.
  3. Replace JAR files in the WEB-INF/lib folder of your old Magnolia instances with new JARs from the bundle.
    (warning) Note that Magnolia 5.7 updates numerous 3rd-party libraries - see Java 8, 9 and 10 runtime compatibility and library updates.
  4. Remove any module JARs you had previously removed from your instances. Add any modules you might have added.
    (warning) Note that we have removed a few modules from the add-ons. Some of them you must remove. See Removing outdated add-on modules.
  5. Add new introduced modules - see Adding the privacy modules.
  6. Optional: Delete all indexes to give them a little 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.
  7. If you customized magnolia.properties files, compare the changes to the file in the new bundle. Properties may have been added and removed.
  8. Read release notes for all intermediary versions for any additional update tasks.
  9. Restart the application server.
  10. Using your browser, go to the Magnolia instances and run the Web update.

Recommendations

  1. Update to your latest minor release version first before upgrade to recent major release. A June 2018 example: a customer is considering an upgrade from 5.5.8 to 5.7. The correct sequence would be: 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

  2. Update all external libraries required by the Magnolia release to which you intend to upgrade.
  3. Carefully look for "change" or "changes for ..." sections in the release notes since.
  4. Because the upgrade process takes time and is vulnerable to incidents, please minimize the risk by cleaning up your system, removing unused data, reindexing everything and doing a full backup first.

...