Skip to main content
Deutsch
Submit a request
 

How can we help?

Search

Articles in this section

Install, Update, or Uninstall

  • Updated

What you should know about installing, uninstalling, and updating.

Before You Install

Check our Compatibility Guide if you want to know whether Acrolinx for Oxygen XML Web Author works with your local platforms.

Before you install, make sure that you've installed the following:

Compatibility Matrix
Supported Oxygen XML Web Author Versions Supported Maintained Deprecated Support for Acrolinx AI Assistant and Suggestions Notes
28.x 1.8.0 1.7.0 1.6.0 and earlier 1.6.0 and later Acrolinx requires Java 17.
27.x -- 1.8.0

Install

There are two ways to install Acrolinx for Oxygen XML Web Author. You can upload and install the Acrolinx installation package from the Oxygen XML Web Author administration page. You can also install Acrolinx for Oxygen XML Web Author using a hosted instance with the Oxygen SDK.

Install from Oxygen XML Web Author Administration Page

To upload and install the Acrolinx package from the Oxygen XML Web Author Administration Page, follow these steps:

  1. Open the Administration Page in Oxygen XML Web Author.
  2. Navigate to Settings > Plugins, then click Upload plugin.
  3. In the dialog box that appears, select the Acrolinx for Oxygen XML Web Author installation package and click OK. Acrolinx for Oxygen XML Web Author should appear in the list on the Plugins page.
  4. Restart your Oxygen Web Application server, or restart your CMS.

Install Using a Hosted Instance with the Oxygen SDK

To install Acrolinx for Oxygen XML Web Author using a hosted instance with the Oxygen SDK, follow these steps:

NOTICE

If you've already set up the Oxygen SDK and Oxygen XML Web Author component, ignore steps 1, 2 and 3.

  1. Set up the Oxygen SDK.
  2. Set up Oxygen XML Web Author.
  3. Add connectors like WebDAV or Git if you need them.
  4. Navigate to bundle-plugins in the dropins directory and extract the Acrolinx installation package.
  5. Build your application as a Maven build. Go to Run As > Maven build... and in Goals enter the following: install -pl oxygen-sample-webapp –am
  6. Click Run. Acrolinx for Oxygen XML Web Author will be part of the generated Web Author archive.
NOTICE

For more information on customizing the Oxygen XML Web Author and installing Oxygen plugins, take a look at the Oxygen documentation on Customizing the Oxygen XML Web Author.

Update

IMPORTANT

Planning to update Oxygen XML Web Author? You’ll need to uninstall Acrolinx first. Check out our Compatibility Guide before you reinstall Acrolinx to make sure it works with your new editor version. We usually adapt Acrolinx to the latest version of Oxygen XML Web Author.

Make sure you're using the most up-to-date version of Acrolinx for Oxygen XML Web Author.

To update to a newer version of Acrolinx for Oxygen XML Web Author, you first need to uninstall the previous version. You can follow the standard Oxygen XML Web Author uninstall procedure.

After you've uninstalled the old version, you can install the newer version as described above.

Uninstall

To uninstall Acrolinx for Oxygen XML Web Author, you can followthe standard Oxygen XML Web Author uninstall procedure.

IMPORTANT

Make sure that the uninstall instructions are for your version of Oxygen XML Web Author.