Edit online

Deploying Oxygen XML Web Author

Intended Audience

This section is meant to help system admins or others who are responsible for deploying Oxygen XML Web Author.

For integrators or system admins looking for information about integrating and customizing Web Author, see the Oxygen XML Web Author Customization Guide.

What is Oxygen XML Web Author?

Oxygen XML Web Author is a web-based editing platform that utilizes the advanced authoring technology of Oxygen XML Editor/Author to bring XML editing and reviewing to your mobile devices, as well as your desktop systems. It is supported on Windows, Linux, and macOS platforms and the most popular browsers.

Server Requirements

Even though the requirements are not strict, you should consider the following metrics when provisioning the server for running the Oxygen XML Web Author:
  • A processor core can handle 50 to 100 active users.
  • Editing an average DITA file consumes about 10MB of RAM. However, the Oxygen XML Web Author includes a configurable caching mechanism that stores the oldest files to disk when memory resources become low. For details, see the com.oxygenxml.webapp.datastore.docs.memory.expire option in the Oxygen XML Editor/Author Options Supported in Oxygen XML Web Author table.

Software Requirements

On the server side, the following applications are supported:

Operating System
  • Windows 10 (64-bit)
  • Windows Server 2016, 2019, 2022
  • Linux 64-bit
  • macOS 64-bit
  • Dual-core CPU (recommended)
  • Minimum 4 GB RAM (6 GB recommended)
  • 1 GB free disk space
Servlet Container
JVM Vendors
  • Oracle
  • Open JDK
  • Java 17 (recommended)
    Note: When using the Web Application Archive (WAR) distribution, you need to pass the following command-line flags to the java application:
    --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED -Djava.security.manager=allow
    Custom plugins may cause exceptions of the type java.lang.reflect.InaccessibleObjectException to appear in the server logs. This happens when the plugin uses reflection in a way that is not allowed in Java 17. To workaround these errors, you need to add more --add-opens flags. To determine the exact set of flags, contact the plugin developer.
  • Java 8 (deprecated - to be removed in a future version)

Other Important Deployment Notes