Edit online

Installing Oxygen XML Author on a Linux / UNIX Server

System Requirements

Operating system

The product has been fully tested on Ubuntu 20.04. The latest version of Oxygen XML Author might work on other flavors/versions of Linux, but they have not been officially tested.

  • Minimum - Intel/AMD CPU, 1 GHz
  • Recommended - Dual-core class processor
  • Minimum - 3 GB of RAM
  • Recommended - 8 GB of RAM
  • Minimum - 1 GB free disk space
  • Recommended - 2 GB free disk space
Oxygen XML Author only supports official and stable Java Virtual Machines with version 1.8 from Oracle. If you use the Linux installer, Oxygen XML Author will be installed with its own copy of Java with the specific update version that has been thoroughly tested.
All Platforms Package
If you use the all platforms package, your system must have a compatible Java 1.8 virtual machine installed. To see the exact Java update version that is supported, go to www.oxygenxml.com, navigate to the Download page for the particular product you are installing, and click on the tab for your particular platform.
Note: Oxygen XML Author may work with other versions of Java, but since Oxygen XML Author has only been thoroughly tested with specific versions, there is no guarantee that it will be stable with any other Java version.
Attention: Oxygen XML Author does not work with the GNU libgcj Java Virtual Machine.
Oxygen XML Author uses the following rules to determine which installed version of Java to use:
  1. If you used the Linux installer, which installs a version of Java as part of the Oxygen XML Author installation, the version in the jre subdirectory of the installation directory is used.
  2. Otherwise, if the Linux environment variable JAVA_HOME is set, Oxygen XML Author uses the Java version pointed to by this variable.
  3. Otherwise, the version of Java pointed to by your PATH environment variable is used.
You can also change the version of the Java Virtual Machine that runs Oxygen XML Author by editing the script file, oxygenAuthor.sh. Go to the Java command at the end of the script file and specify the full path to the Java executable of the desired JVM version. For example:
/usr/bin/jre1.8.0_121/bin/java -Xmx1024m ...

Linux Installer

To install Oxygen XML Author using the Linux installer, follow these steps:
  1. Make sure that your system meets the system requirements.
  2. Download the Linux installer.
  3. [Optional] Validate the integrity of the downloaded file by checking it against the MD5 sum published on the download page.
  4. Run the installer and follow the instructions in the installation program.
    Note: For example, open a shell, cd to the installation directory, and at the prompt type sh ./oxygen-32bit.sh or sh ./oxygen-64bit.sh, depending on which installer you downloaded.
  5. Start Oxygen XML Author using one of the following methods:
    • Use the author shortcut created by the installer.
    • From a command line, type sh oxygenAuthor.sh. This file is located in the installation folder.
  6. To license your copy of Oxygen XML Author go to Help > Register and enter your license information.

Unix/Linux Server Configuration

  1. Install Oxygen XML Author on the server and make sure the oxygenAuthor.sh script is executable and the installation directory is in the PATH of the users that need to use the application.
  2. Make sure you allocate sufficient memory to Oxygen XML Author by setting an appropriate value for the -Xmx parameter in the .sh startup script.
    Note: The default value of the -Xmx parameter is 1 GB. To avoid performance issues with large documents, you may need to adjust it.
  3. Make sure the X server processes located on the workstations allow connections from the server host. For this, use the xhost command.
  4. Start telnet (or ssh) on the server host.
  5. Start an xterm process with the display parameter set on the current workstation. For example: xterm -display workstationip:0.0.
  6. Start Oxygen XML Author by typing sh oxygenAuthor.sh from the command line. This file is located in the installation folder.