Installing Oxygen JSON Editor on Linux

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:

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.
Otherwise, if the Linux environment variable JAVA_HOME is set, Oxygen JSON Editor uses the Java version pointed to by this variable.
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.

X.org

The version of Java bundled with Oxygen JSON Editor requires X.org (Wayland is not supported).

Linux Installer

To install Oxygen JSON Editor using the Linux installer, follow these steps:

Make sure that your system meets the system requirements.
Download the Linux installer.
[Optional] Validate the integrity of the downloaded file by checking it against the MD5 sum published on the download page.
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.
Warning: If you are running the installer as root and your Linux distribution uses Wayland (such as Ubuntu 17.10 or Fedora 25), before running the installer, the local user must first allow the root user to access the X server by running the following command (as the local user):
```
xhost +SI:localuser:root
```
Start Oxygen JSON Editor using one of the following methods:
- Use the jsoneditor shortcut created by the installer.
  Note: For Ubuntu 17.10 (or later), a security dialog box will appear the first time you start the application where you need to select Trust and Launch to continue. This dialog box will not appear on subsequent launches.
- From a command line, type sh oxygenJSONEditor.sh. This file is located in the installation folder.
To license your copy of Oxygen JSON Editor go to Help > Register and enter your license information.

Linux Unattended Installation

You can run the installation in unattended mode by running the installer from the command line with the -q parameter. By default, running the installer in unattended mode installs Oxygen JSON Editor with the default options and does not overwrite existing files. You can change various options for the unattended installer using the installer command-line parameters.

Linux Installer Command-Line Reference

The Oxygen JSON Editor installer for Linux supports a variety of command-line parameters:

-q: Instructs the installer to run in unattended mode. The installer will not prompt the user for input during the install. Default settings will be used for all options unless a response.varfile is specified using the -varfile option.
-overwrite: In unattended mode, the installer does not overwrite files with the same name if a previous version of the Oxygen JSON Editor is installed in the same folder. The -overwrite parameter added after the -q parameter forces the overwriting of these files.
-console: Displays a console during the installation.
-varfile: Specifies the location of a response.varfile, normally to be used during an unattended installation.
-V: Used to define a variable parameter to be used by an installation.

EXAMPLE:

oxygen.sh -q -overwrite -console -VautoVersionChecking=false

Command-Line Variables for Preconfiguring License Server Details

For organizations that use a license server to manage user licenses, the Oxygen JSON Editor installer also supports the following command-line variables used for preconfiguring license server details:

autoVersionChecking: Used for automatic version checking. Possible values are true (default) or false.
backup.license.servlet.url: Specifies the URL of the backup HTTP license server.
backup.license.servlet.user.name: Specifies the user name for the backup HTTP license server.
backup.license.servlet.password: Specifies the password for the backup HTTP license server, in clear form (will be stored encrypted).
backup.license.servlet.password.encrypted: Specifies the password for the HTTP license server, in encrypted form. Can be obtained from an entry with the same name in an existing license.xml file (found in: [user_home_directory]\AppData\Roaming\com.oxygenxml.jsoneditor).
downloadResources: Used to download resources (links to video demonstrations, webinars, and upcoming events) from https://www.oxygenxml.com to populate the application welcome screen. Possible values are true (default) or false.
license.servlet.url: Specifies the URL of the HTTP license server.
license.servlet.user.name: Specifies the user name for the HTTP license server.
license.servlet.password: Specifies the password for the HTTP license server, in clear form (will be stored encrypted).
license.servlet.password.encrypted: Specifies the password for the HTTP license server, in encrypted form. Can be obtained from an entry with the same name in an existing license.xml file (found in: [user_home_directory]\AppData\Roaming\com.oxygenxml.jsoneeditor).
reportProblem: Used to report a problem encountered while using Oxygen JSON Editor. Possible values are true (default) or false.

EXAMPLE:

oxygen.sh "-Vlicense.servlet.url=http://main.licenseserver:8080/oXygenLicenseServlet/license-servlet"
 "-Vlicense.servlet.user.name=user" "-Vlicense.servlet.password=mypass" 
 "-Vbackup.license.servlet.url=http://backup.licenseserver:8080/oXygenLicenseServlet/license-servlet"
 "-Vbackup.license.servlet.user.name=user" "-Vbackup.license.servlet.password=mypass"

Linux Installer response.varfile

The Oxygen JSON Editor installer for Linux also creates a file called response.varfile, which records the choices that the user made when running the installer interactively. The generated response file is found in the [OXYGEN_INSTALL_DIR]/.install4j folder. You can use the response.varfile to set the options for an unintended install. For more information about the response.varfile format, see install4j site.

Variable Parameters (can be used in the response.varfile or from the command line)

The following variable parameters are supported in the response.varfile (or from the command line):

autoVersionChecking: Used for automatic version checking. Possible values are true (default) or false.
reportProblem: Used to report a problem encountered while using Oxygen JSON Editor. Possible values are true (default) or false.
downloadResources: Used to download resources (links to video demonstrations, webinars, and upcoming events) from https://www.oxygenxml.com to populate the application welcome screen. Possible values are true (default) or false.