Edit online

Installing Oxygen JSON Editor on a Linux / UNIX Server

System Requirements

Operating system

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

CPU
  • Minimum - Intel/AMD Dual-core class CPU, 2 GHz
  • Recommended - Quad-core class processor
Memory
  • Minimum - 3 GB of RAM
  • Recommended - 8 GB of RAM
Storage
  • Minimum - 1 GB free disk space
  • Recommended - 2 GB free disk space
Java
Oxygen JSON Editor only officially supports Java Virtual Machines with version 17 from Oracle or Eclipse Adoptium. If you use the Linux installer, Oxygen JSON Editor 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 17 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 JSON Editor may work with other versions of Java, but since Oxygen JSON Editor has only been thoroughly tested with specific versions, there is no guarantee that it will be stable with any other Java version.
Attention: Oxygen JSON Editor does not work with the GNU libgcj Java Virtual Machine.
Oxygen JSON Editor 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 JSON Editor 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 JSON Editor 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 JSON Editor by editing the script file, oxygenJSONEditor.sh.

Linux Installer

To install Oxygen JSON Editor 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 JSON Editor using one of the following methods:
    • Use the jsoneditor shortcut created by the installer.
    • From a command line, type sh oxygenJSONEditor.sh. This file is located in the installation folder.
  6. To license your copy of Oxygen JSON Editor go to Help > Register and enter your license information.

Unix/Linux Server Configuration

  1. Install Oxygen JSON Editor on the server and make sure the oxygenJSONEditor.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 JSON Editor by setting an appropriate value for the -Xmx parameter in the .sh startup script.
    Note: The default value of the -Xmx parameter is about a quarter of the maximum internal memory available on the machine. 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 JSON Editor by typing sh oxygenJSONEditor.sh from the command line. This file is located in the installation folder.