Red Hat Training

A Red Hat training course is available for Red Hat JBoss Developer Studio

Installation Guide

Red Hat JBoss Developer Studio 10.1

Installing Red Hat JBoss Developer Studio

Misha Husnain Ali

Supriya Bharadwaj

Red Hat Developer Group Documentation Team

Abstract

Information for users installing Red Hat JBoss Developer Studio. This guide describes all prerequisites for a successful installation of the product followed by a number of installation methods, including how to use your existing installation of Eclipse.

Chapter 1. Introducing JBoss Developer Studio Installation Options

Red Hat JBoss Developer Studio is provided in two variants thaty you can use 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:

Note

You can also install devstudio as part of Red Hat Development Suite. The Development Suite Installer installs the following components:

  • OpenJDK 1.8.0
  • Red Hat JBoss Developer Studio 10.1
  • Cygwin 2.5.1
  • Red Hat Container Development Kit 2.2
  • Vagrant 1.7.4
  • VirtualBox 5.0.8

Note that currently only 64-bit versions of Windows 7, 8, and 10 are supported. For instructions on installing Development Suite, see the Red Hat Development Suite Installation Guide.

Chapter 2. Understanding JBoss Developer Studio Installation Prerequisites

2.1. Hardware and Software Requirements

JBoss Developer Studio 10.1 requires Java 8 to run. Before commencing the installation of devstudio, make sure that Java 8 is installed on your system.

JBoss Developer Studio 10.1 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 JBoss Developer Studio 10.1, the following is recommended:

  • 4 GB RAM (minimum 2 GB RAM)
  • 2 GB of hard disk space

2.2. Installing OpenJDK 8

Unless you already have Java 8 installed on your system, use the OpenJDK distribution provided by Red Hat. This section describes how to install OpenJDK by Red Hat on Microsoft Windows and Red Hat Enterprise Linux.

2.2.1. Installing OpenJDK on Microsoft Windows

Note

Currently, only 64-bit versions of Windows 7, 8, and 10 are supported.

To install OpenJDK 1.8.0 on Windows using the MSI-based installer:

  1. Download the MSI-based installer from: http://developers.redhat.com/products/openjdk/overview/.
  2. Run the installer and follow the on-screen instructions to install.
  3. To configure JBoss Developer Studio to use OpenJDK, follow the instructions at Working with JREs.

2.2.2. Installing OpenJDK on Red Hat Enterprise Linux

To install OpenJDK 1.8.0 on Red Hat Enterprise Linux:

Note

All the commands in the following procedure must be run as the root user.

  1. Register and subscribe the system by running the following command: 

    # subscription-manager register
  2. When prompted, enter your Red Hat Customer Portal user name and password.

  3. To find a suitable subscription, such as Developer Subscription, run the following command: 

    # subscription-manager list --available

    This command lists the available subscriptions and details of the subscriptions. Note down the pool ID of the appropriate subscription.

  4. To attach a subscription to your system, run the following command: 

    # subscription-manager attach --pool=<pool id from previous command>

  5. To install OpenJDK RPMs: 

    # yum install java-1.8.0-openjdk-devel
    Note

    Install the java-1.8.0-openjdk-demo package for examples of Java applications and the java-1.8.0-openjdk-src package to debug your applications. Both packages are available from the Optional repository. Use the following command to enable that repository on your system: 

    # subscription-manager repos --enable=rhel-7-server-optional-rpms

    Substitute the version number in the above command with 6 if you use Red Hat Enterprise Linux 6.

    Use the following command to install the packages: 

    # yum install java-1.8.0-openjdk-src java-1.8.0-openjdk-demo

Chapter 3. Installing JBoss Developer Studio BYOE when Online

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

To install JBoss Developer Studio BYOE from Eclipse Marketplace:

  1. Ensure that Java 8 is installed on your system.
  2. Start Eclipse Neon.
  3. Click Help → Eclipse Marketplace, locate Red Hat JBoss Developer Studio 10.1 GA, and click Install.
  4. 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.

Chapter 4. Installing JBoss Developer Studio BYOE when Offline

You need the Update Site Zip 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.

To install JBoss Developer Studio BYOE in offline mode:

  1. Ensure that Java 8 is installed on your system.
  2. Download the Red Hat JBoss Developer Studio 10.1 Update Site Zip from https://devstudio.redhat.com/10.1/development/updates.
  3. Start Eclipse Neon.
  4. Click Help → Install New Software.
  5. In the Work with field, enter the path of the Update Site Zip file. Alternatively, click Add and click Archive to locate the file.
  6. From the table of components, select JBoss Developer Studio 10.1 - Bring Your Own Eclipse and click Next.
  7. 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 the 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.

Chapter 5. Installing JBoss Developer Studio Stand-alone

The installer provided to install JBoss Developer Studio stand-alone is available from a variety of sources, including the Red Hat Customer Portal.

To install JBoss Developer Studio stand-alone:

  1. Ensure that Java 8 is installed on your system.
  2. Download Red Hat JBoss Developer Studio 10.1 Stand-alone Installer from JBoss Developer Studio Software Downloads.

  3. Start the installer: 

    $ cd /path/to/.jar
$ java -jar devstudio-10.1-installer-standalone.jar

    Alternatively, you can 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.

  4. Follow the on-screen instructions to complete the installation process.

Chapter 6. Installing JBoss Developer Studio Stand-alone and Red Hat 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.

To install JBoss Developer Studio stand-alone and JBoss EAP:

  1. Ensure that Java 8 is installed on your system.
  2. Download Red Hat JBoss Developer Studio 10.1 Installer with EAP from JBoss Developer Studio Software Downloads.

  3. Start the installer: 

    $ cd /path/to/.jar $ *java -jar devstudio-10.1-installer-eap.jar

    Alternatively, you can 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.

  4. Follow the on-screen instructions to continue the installation process.
  5. At installer step 5, when asked if you want to install JBoss EAP, click Yes.
  6. 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.

Chapter 7. Upgrading JBoss Developer Studio

This section describes how to upgrade to newer versions of JBoss Developer Studio.

7.1. Upgrading Major Versions of JBoss Developer Studio

Each major version of JBoss Developer Studio is based on a different version of Eclipse. As a result, it is not possible to update an older major version of JBoss Developer Studio to a newer major version. For example, it is not possible to update a devstudio 8.x installation to 9.x, nor is it possible to update a 9.x installation to 10.x. However, it is possible to use the workspaces created using JBoss Developer Studio 9.x with JBoss Developer Studio 10.x.

The following table details the version of Eclipse supported with each major version of JBoss Developer Studio:

Table 7.1. Eclipse Version Support Matrix

JBoss Developer Studio VersionBase Eclipse Version

JBoss Developer Studio 10.x

Eclipse Neon (4.6)

JBoss Developer Studio 9.x

Eclipse Mars (4.5)

JBoss Developer Studio 8.x

Eclipse Luna (4.4)

JBoss Developer Studio 7.x

Eclipse Kepler (4.3)

JBoss Developer Studio 6.x

Eclipse Juno (4.2)

7.2. Updating Minor Versions of JBoss Developer Studio

You can update your JBoss Developer Studio to the latest minor versions within the major release. For example, you can update your JBoss Developer Studio 9.0 installation to 9.1.

Important

Before updating, back up your workspace. In addition to your project files, your workspace contains metadata about customized settings and preferences for the IDE. To back up your workspace, either copy the workspace directory to a backup location, or save it as a compressed file.

You may be automatically notified by the IDE when the JBoss Developer Studio 9.y update is available, depending on your IDE settings for automatic updates.

Alternatively, use the following instructions to manually check for and apply the most recent JBoss Developer Studio update:

  1. In the IDE, click Window → Preferences, expand Install/Update and click Available Software Sites.
  2. In the Available Software Sites table, ensure the URL https://devstudio.redhat.com/10.1/stable/updates/ is listed or, if not listed, add it.
  3. Close the Preferences window.
  4. Click Help → Check for Updates.
  5. For any JBoss Developer Studio updates found, follow the on-screen instructions to apply the update.

During the update 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 update.

Once updating is complete, you are prompted to restart the IDE. Click Yes to restart immediately or No to save any unsaved changes to open projects. Note that IDE changes do not take effect until the IDE is restarted.

Chapter 8. Performing Advanced Installation Tasks

This section describes how to install JBoss Developer Studio using a script and how to build the JBoss Developer Studio installer from source code.

8.1. Installing JBoss Developer Studio via a 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 installations 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. Download Red Hat JBoss Developer Studio 10.1 Stand-alone Installer from JBoss Developer Studio Software Downloads.

  2. Start the installer as follows: 

    $ cd /path/to/.jar
$ java -jar devstudio-10.1-installer-standalone.jar

  3. Follow the on-screen instructions to complete the installation process.

    After the installation is complete, an InstallConfigRecord.xml file is generated in the /path/to/devstudio/ directory.

  4. In the terminal window, enter the following command: 

    $ java -jar devstudio-10.1-installer-standalone.jar \
  /path/to/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.

8.2. Building 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.

Note

It is easier to build the installer from the https://github.com/jbdevstudio/jbdevstudio-product repository instead of the source ZIP file.

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. Download the Red Hat JBoss Developer Studio 10.1 Stand-alone Installer from JBoss Developer Studio Software Downloads.

  2. Extract the contents of the downloaded file by running the following commands: 

    $ cd path/to/.zip
$ unzip devstudio-10.1-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/devstudio-10.1-src/jbdevstudio-product-SHA-checksum}/installer/target directory.

Chapter 9. Reporting Issues from within JBoss Developer Studio

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.

  1. Click Help and then click 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, in the E-Mail field, add your e-mail address to be potentially contacted in the future about the issue.
  5. Click OK to submit the problem report.

You can also enable error reporting from: Preferences → General → Error Reporting. If enabled, when you encounter a plugin related error, a pop-up notification describing the error will appear. The user can either dismiss or send the error directly, or provide more details about the error. You can optionally provide your e-mail ID to be contacted for more details on the error.

Legal Notice

Copyright © 2017 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
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.