Installing JSON Studio

JSON Studio is a Java application running within Apache Tomcat. Java 1.6 and up is a prerequisite; everything else comes with the installer. The installer itself is a zip file with a simple installation script making the install simple.

JSON Studio can run on any system that has Java. It has been tested on Linux, MacOS, Windows and Solaris x86.

Installing on *nix

Follow these steps to install the Studio on Linux, OSX or Solaris x86:

  • Copy the installer file to the machine where you want to install the Studio.
  • Unzip or untar the file.
  • Run the installer:: $ ./install-sonarFinder.sh
  • Read and accept the license.
  • Enter the directory where the Studio should be installed.
  • The installer will show you its current install parameters. You can choose to continue with those parameters (Y), or change them (N).
  • If you choose to change parameters, the installer will step through them:
  • You can choose, again, where the Studio should be installed.
  • The installer tries to find a valid JRE, or its included JRE. If this is correct, press enter. Otherwise, provide the full path to a valid JRE.
  • Enter the HTTTP and HTTPS ports the Studio will listen on (above 1024).
  • If you will be working with Kerberos, answer Y when prompted. You will then be asked to enter the KDC address and Kerberos realm name.
  • Finally, you can choose to run the Studio in read-only mode. The default is N so that the Studio can be used to update collections. You can (and should) also use the database’s access control mechanism to limit writes if you do not want them to occur from users of the Studio.
  • Now, if you continue with the selected parameters, the Studio will install to the directory you entered earlier.
  • To start JSON Studio, cd to the directory where it is installed and run:: $ ./start_sonar_finder.sh.
  • To stop it, run:: $ ./stop_sonar_finder.sh.

Installing on Windows

Follow these steps to install the Studio on Windows:

  • Copy the provided zip file to the machine where you want to install.

  • Unzip the file.

  • Open a Windows Powershell command terminal.

  • Type the following in the Powershell command prompt and hit enter:

    Set-ExecutionPolicy Bypass process
    

This allows the Powershell session make changes to your machine. You will be asked for permission; enter Y.

  • Cd to the directory where you unzipped the installer.

  • Type sf.ps1 and press Enter to run the installer in PowerShell.

  • Read and accept the license.

  • Enter the directory where the Studio should be installed.

  • If you are running Windows 64 bit then the JRE is included in the installer. If you have 32 bit Windows, you will be asked for the location of the JRE. Locate your JRE and copy the path to the installer. If you do not have a JRE, you can download it from Oracle:

    <http://www.oracle.com/technetwork/java/javase/downloads/jre7-downloads-1880261.html>
    

If you already have a JRE installed make sure it is a server edition. Look at the bin folder in the jre folder; if there is only a client folder, copy the client folder to an additional folder named server. If you are installing the server edition it will already have a server folder.

  • The installer will show you its current install parameters. You can choose to continue with those parameters (Y), or change them (N).
  • If you choose to change parameters, the installer will step through them:
  • You can choose, again, where the Studio should be installed.
  • The installer tries to find a valid JRE, or its included JRE. If this is correct, press enter. Otherwise, provide the full path to a valid JRE.
  • Enter the HTTTP and HTTPS ports the Studio will listen on (above 1024).
  • If you will be working with Kerberos, answer Y when prompted. You will then be asked to enter the KDC address and Kerberos realm name.
  • Finally, you can choose to run the Studio in read-only mode. The default is N so that the Studio can be used to update collections. You can (and should) also use the database’s access control mechanism to limit writes if you do not want them to occur from users of the Studio.
  • Now, if you continue with the selected parameters, the Studio will install to the directory you entered earlier.
  • To start JSON Studio, open the directory where it is installed and run:

    .\start_sonar_finder.bat.
    
  • To stop it, run stop_sonar_finder.bat.

Uninstall

Follow the instructions in UNINSTALL.txt in your installation directory.

Table Of Contents

Previous topic

JSON Studio Architecture

Next topic

Working with JSON Studio

Copyright © 2013-2016 jSonar, Inc
MongoDB is a registered trademark of MongoDB Inc. Excel is a trademark of Microsoft Inc. JSON Studio is a registered trademark of jSonar Inc. All trademarks and service marks are the property of their respective owners.