Installing Oxygen XML Author on a Linux / UNIX Server

Choosing an Installer

You can install Oxygen XML Author on Linux using any of the following methods:

  • Install using the Linux installer.
  • Install using the Linux installer in unattended mode.
  • Install using the all platforms installer. Choose the all platforms installer if you have trouble installing using the Linux installer.

System Requirements

System requirements for a Linux install:

Operating system

Any Unix/Linux distribution with an available Java SE Runtime Environment version 1.6.0 or later from Oracle

CPU
  • Minimum - Intel Pentium III™/AMD Athlon™ class processor, 1 GHz
  • Recommended - Dual Core class processor
Memory
  • Minimum - 2 GB of RAM
  • Recommended - 4 GB of RAM
Storage
  • Minimum - 400 MB free disk space
  • Recommended - 1 GB free disk space
Java

Oxygen XML Author requires Java. Oxygen XML Author only supports official and stable Java Virtual Machines with the version number 1.6.0 or later (the recommended version is 1.6.0) from Oracle available at http://www.oracle.com/technetwork/java/javase/downloads/index.html. Oxygen XML Author may work with JVM implementations from other vendors, but there is no guarantee that other implementations will work with future Oxygen XML Author updates and releases. 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.6.0_45/bin/java -Xmx256m ...

Linux Installation

Linux installation procedure.

To install Oxygen XML Author on Linux, follow these steps:
  1. Download the Linux installer.
  2. Optionally, you can validate the integrity of the downloaded file by checking it against the MD5 sum published on the download page.
  3. Run the installer that you downloaded.
    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.
  4. 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.
  5. To license your copy of Oxygen XML Author go to Help > Register and enter your license key.

Install Using the All Platforms Installer

To install using the all platforms installer:
  1. Download the all platforms installation package (oxygenAuthor.tar.gz) to a folder of your choice.
  2. Extract the archive in that folder.
    Oxygen XML Author is now installed in a new sub-folder called oxygenAuthor.
  3. Optionally, you can move the directory where you installed Oxygen XML Author to your applications directory. You can also rename it to contain the product version information. For example, you can rename it as oxygenAuthor18.0.
  4. Start Oxygen XML Author by running oxygenAuthor.sh, which is located in the install folder.
  5. To license your copy of Oxygen XML Author go to Help > Register and enter your license information.

Unix / Linux Server Configuration

To install Oxygen XML Author on a Unix / Linux server:

  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.
    The default value of the -Xmx parameter is 512 MB. 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.