Install Red Hat JBoss Developer Studio

Red Hat JBoss Developer Studio 9.1

Information for users installing JBoss Developer Studio

Red Hat Customer Content Services

Abstract

This document details how to install JBoss Developer Studio.

1. Red Hat Central Content Support Information

Red Hat JBoss Developer Studio offers third-party extensions and tools with varying levels of support from Red Hat. To access a list of all available extensions and tools, click Software/Update at the bottom of the Red Hat Central view. Each extension or tool also lists the level of support at the end, as seen in the figure:
Red Hat Central Software/Update View

Figure 1. Red Hat Central Software/Update View

Content available from Red Hat Central has been tested by Red Hat but support of the content varies depending on content type:

Support Levels for Red Hat Central Content

Supported
These plug-ins are hosted by Red Hat, tested by Red Hat to ensure compatibility with JBoss Developer Studio, and supported by Red Hat.
Tested
These plug-ins are hosted by Red Hat and tested by Red Hat, but support is most likely provided by another vendor. Red Hat attempts to report issues to providers as required.
Technology Preview
These plug-ins are tested by Red Hat, often with documentation describing known issues. The expectation is that these technology preview plug-ins may one day evolve sufficiently to be considered Tested or Supported, but this is not guaranteed.
Experimental , Early Access
These are experimental plug-ins. It is possible that their content may change at any time and without prior notice. Red Hat provides early access to this content so that it can be evaluated and monitored, in order to execute appropriate tests and report issues to plug-in providers as required. May evolve into Technology Preview content, but this is not guaranteed.
External
These plug-ins are tested by Red Hat but, as the plug-ins are hosted by external third-party providers, it is possible that content may change at any time and without prior notice. Red Hat attempts to monitor the associated third-party sites and execute appropriate tests on plug-ins, reporting issues to plug-in providers as required.
Report a bug

2. Install Options

Red Hat JBoss Developer Studio is provided in two variants depending on your circumstance: stand-alone and Bring-Your-Own-Eclipse (BYOE). JBoss Developer Studio stand-alone packages the JBoss Developer Studio plug-ins with Eclipse and dependent third-party plug-ins in an installer for all operating systems. JBoss Developer Studio BYOE packages the JBoss Developer Studio plug-ins for installing in your existing Eclipse instance.
There are a variety of ways of installing each JBoss Developer Studio variant and instructions are given here for completing the following tasks:
Report a bug

3. System Requirements

This release of JBoss Developer Studio is supported for use with a range of operating system, architecture and Java developer kit combinations; for a complete list, see https://access.redhat.com/articles/427493 on the Red Hat Customer Portal.
To install and run this release of JBoss Developer Studio, the following memory requirements are recommended:
  • 4 GB RAM
  • 1.5 GB of hard disk space

Note

The minimum memory requirements are 2 GB RAM and 750 MB of hard disk space.
Report a bug

4. Install JBoss Developer Studio BYOE when Online

JBoss Developer Studio BYOE is available to install from Eclipse Marketplace when you are online.
Prerequisites

JBoss Developer Studio 9.1.0 can be installed using an older version of Java, but it requires Java 8 to run. Ensure that Java 8 is installed to use JBoss Developer Studio 9.1.0.

Install JBoss Developer Studio BYOE when Online

To install JBoss Developer Studio BYOE from Eclipse Marketplace, complete the following steps:

  1. Start Eclipse Mars.
  2. Click Help→Eclipse Marketplace, locate Red Hat JBoss Developer Studio 9.1 GA and click Install.
  3. Follow the on-screen instructions to complete the installation process.
During the installation process, if you receive warnings about installing unsigned content, review the details of the content and if satisfied click OK to continue with the installation.
Once installation is complete, you are prompted to restart Eclipse. Click Yes to restart immediately and No if you need to save any unsaved changes to open projects. Note that IDE changes do not take effect until Eclipse is restarted.
Report a bug

5. Install JBoss Developer Studio BYOE when Offline

The Update Site Zip that can be downloaded from https://devstudio.redhat.com/9.0/development/updates under Offline Install is needed to install JBoss Developer Studio BYOE in offline mode. Alternatively, you can also use an installer downloaded on your system instead of the Update Site Zip to install JBoss Developer Studio BYOE when Offline.

Important

You must first be online to download the .zip file before proceeding to install JBoss Developer Studio BYOE in offline mode.
Prerequisites

JBoss Developer Studio 9.1.0 can be installed using an older version of Java, but it requires Java 8 to run. Ensure that Java 8 is installed to use JBoss Developer Studio 9.1.0.

Install JBoss Developer Studio BYOE when Offline

To install JBoss Developer Studio BYOE in offline mode, complete the following steps:

  1. Locate and download Red Hat JBoss Developer Studio <version> Update Site Zip.
  2. Start Eclipse Mars.
  3. Click Help→Install New Software.
  4. In the Work with field, enter the path of the Update Site Zip file. Alternatively, click Add and click Archive to locate the file.
  5. From the table of components, select JBoss Developer Studio <version> - Bring Your Own Eclipse and click Next.
    JBoss Developer Studio version - Bring Your Own Eclipse Selected for Installation

    Figure 2. JBoss Developer Studio version - Bring Your Own Eclipse Selected for Installation

  6. Follow the on-screen instructions to complete the installation process.
During the installation process you may receive warnings about installing unsigned content. If this is the case, review the details of the content and if satisfied click OK to continue with the installation.
Once installation is complete, you are prompted to restart Eclipse. Click Yes to restart immediately and No to save any unsaved changes to open projects. Note that the IDE changes do not take effect until Eclipse is restarted.
Report a bug

6. Install JBoss Developer Studio Stand-alone

An installer is provided for JBoss Developer Studio stand-alone. This installer is available from a variety of sources, including the Red Hat Customer Portal.
Prerequisites

JBoss Developer Studio 9.1.0 can be installed using an older version of Java, but it requires Java 8 to run. Ensure that Java 8 is installed to use JBoss Developer Studio 9.1.0.

Install JBoss Developer Studio Stand-alone

To install JBoss Developer Studio stand-alone, complete the following steps:

  1. Locate and download Red Hat JBoss Developer Studio <version> Stand-alone Installer.
  2. Start the installer 
    $ cd /path/to/.jar
$ java -jar jboss-devstudio-version-installer-standalone.jar
    Alternatively, you may be able to start the installer by double-clicking the .jar file. On OS X systems, hold control and click the .jar file, click Open, review the .jar file details and if satisfied click Open.
  3. Follow the on-screen instructions to complete the installation process.
Report a bug

7. Install JBoss Developer Studio Stand-alone and JBoss EAP

A single installer is provided for both JBoss Developer Studio stand-alone and Red Hat JBoss Enterprise Application Platform. A specific JBoss EAP version is packaged in the installer; for details of the JBoss EAP version see https://access.redhat.com/articles/427493. This installer is available from a variety of sources, including the Red Hat Customer Portal.
Prerequisites

JBoss Developer Studio 9.1.0 can be installed using an older version of Java, but it requires Java 8 to run. Ensure that Java 8 is installed to use JBoss Developer Studio 9.1.0.

Install JBoss Developer Studio Stand-alone and JBoss EAP

To install JBoss Developer Studio stand-alone and JBoss EAP, complete the following steps:

  1. Locate and download Red Hat JBoss Developer Studio <version> Installer with EAP.
  2. Start the installer 
    $ cd /path/to/.jar
$ java -jar jboss-devstudio-version-installer-eap.jar
    Alternatively, you may be able to start the installer by double-clicking the .jar file. On OS X systems, hold control and click the .jar file, click Open, review the .jar file details and if satisfied click Open.
  3. Follow the on-screen instructions to continue the installation process.
  4. At installer step 5, when asked if you want to install JBoss EAP, click Yes.
  5. Continue to follow the on-screen instructions to complete the installation process.
This additional installer option installs JBoss EAP in a subdirectory of the JBoss Developer Studio installation and generates a complete default server definition within the IDE with which to manage the JBoss EAP instance and deployed applications.
Report a bug

8. Advanced Install Tasks

8.1. Install JBoss Developer Studio by Script

Use the scripted method to install JBoss Developer Studio stand-alone using the GUI once and then a generated script for subsequent installations. This installation method enables simplified repeat installation or installations in bulk without stepping through the installer GUI for every installation.
The JBoss Developer Studio stand-alone installer is available from a variety of sources, including the Red Hat Customer Portal.
To install JBoss Developer Studio by script, complete the following steps:
  1. Locate and download Red Hat JBoss Developer Studio <version> Stand-alone Installer from the Red Hat Customer Portal.
  2. Start the installer as follows: 
    $ cd /path/to/.jar
$ java -jar jboss-devstudio-<version>-installer-standalone.jar
  3. Follow the on-screen instructions to complete the installation process.
    After the installation is complete, a InstallConfigRecord.xml file is generated in the /path/to/jboss-devstudio/ directory.
  4. In the terminal window, enter the following command: 
    java -jar jboss-devstudio-version-installer-standalone.jar /path/to/jboss-devstudio/InstallConfigRecord.xml

Note

The generated InstallConfigRecord.xml file is machine-specific and uses the Java developer kit and installation paths of your system. To use the InstallConfigRecord.xml file for systems with different operating systems, Java developer kits, or paths, you must manually modify the file.
Report a bug

8.2. Build the JBoss Developer Studio Stand-alone Installer from Source

A .zip file is provided from which you can build the JBoss Developer Studio stand-alone installer. The source code archive is available from a variety of sources, including the Red Hat Customer Portal.

Important

Maven must be installed to build the installer from the source code. Also, ensure that you are using Maven 3.2 or later, with Java 8 or later. To obtain and configure Maven, see http://maven.apache.org/.
To build the JBoss Developer Studio stand-alone installer from source:
  1. Locate and download Red Hat JBoss Developer Studio <version> Sources Zip from the Red Hat Customer Portal.
  2. Extract the contents of the downloaded file, by running the following commands: 
    $ cd path/to/.zip
$ unzip jboss-devstudio-<version>-installer-src.zip
  3. Build the installer by following the instructions in the README.how-to-build-from-sources-zip.txt file.

    Note

    The README.how-to-build-from-sources-zip.txt file is located in the extracted current folder at the highest level.
Building takes some time to complete, after which the installer .jar file will be located in the /path/to/jboss-devstudio-<version>-src/jbdevstudio-product-{SHA_checksum}/installer/target directory.
Report a bug

9. Reporting Issues from Within the IDE

Red Hat JBoss Developer Studio and JBoss Tools allow users to report issues from within the IDE as they are encountered. It is recommended that users report issues frequently and include as much detail as possible to help the development and testing teams replicate and fix the issue. The Report Problem wizard creates a zip file containing the relevant IDE log files. This zip file can be attached to the JIRAs submitted against each problem to provide context for the issue.

Procedure 1. Report Issues from Within the IDE

  1. Click Help and then Report Problem.
  2. The Log file name field contains the zipped log files as a default. Click Browse... to select a different log file to attach to the JIRA.
  3. In the Problem Description field, outline details about the problem, such as:
    • What you wanted to do with JBoss Developer Studio.
    • What steps you followed to arrive at the problem or error message.
    • Any other noteworthy information about the environment or any unsupported add-ons or plug-ins in use.
  4. Optionally, add your e-mail address to be potentially contacted in the future about the issue in the E-Mail: field.
  5. Click OK to submit the problem report.
Report a bug

A. Revision History

Revision History
Revision 9.1.0-4Tue May 03 2016Misha Husnain Ali
TOOLSDOC-739: Updated references to Red Hat Central
Revision 9.1.0-3Mon Apr 18 2016Supriya Bharadwaj
Updated for 9.1 GA
Revision 9.1.0-1Tue Dec 22 2015Supriya Bharadwaj
TOOLSDOC-698: Made changes as per QE feedback
Revision 9.1.0-0Thur Nov 12 2015Misha Husnain Ali
Generated for 9.1

Legal Notice

Copyright © 2014 Red Hat, Inc.
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.