Deploying Oxygen XML Web Author
Intended Audience
This section of the User Guide 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 8, 8.1, 10 (64-bit)
- Windows Server 2012, 2012 R2, 2016, 2019
- Linux 64-bit
- macOS 64-bit
- Hardware
-
- Dual-core CPU (recommended)
- Minimum 4 GB RAM (6 GB recommended)
- 1 GB free disk space
- Servlet Container
-
- Apache Tomcat 9
- IBM WebSphere (Traditional) 9.0.0.6 (see: Deploying Web Author in WebSphere (Traditional))
- IBM WebSphere Liberty 8.5.5.8 (see: Deploying Web Author in WebSphere Liberty)
- WildFly 16.0.0.Final (see: Deploying Web Author in WildFly)
- JVM Vendors
-
- Oracle
- Open JDK
- Java
-
- Java 8 (recommended)
- Java 11
Other Important Deployment Notes
- It is recommended that you install Oxygen XML Web Author in its own instance of Tomcat, without sharing it with other applications.
- If you want to reload the application, you have to restart the server by following the procedure found in Starting and Stopping Oxygen XML Web Author.