Installation Guide

Procedure 2.1. Download the ZIP file

1. Open a browser and log into the Customer Portal at https://access.redhat.com.
2. Click Downloads.
3. Click Red Hat JBoss Enterprise Application Platform in the Product Downloads list.
4. Select the correct JBoss EAP version from the Version drop-down menu.
5. Find Red Hat JBoss Enterprise Application Platform 6.x.x in the list and click the Download option.

Procedure 2.2. ZIP File Installation

1. Move the ZIP archive to the desired location.

   Move the ZIP file to the server and directory where you plan to install JBoss EAP 6. The user who will start and stop the server must have read and write access to this directory.

2. Use an appropriate application to extract the ZIP archive to the desired location.

   In a Red Hat Enterprise Linux environment, use the unzip utility to extract the contents of the ZIP archive.
   In a Microsoft Windows environment, right-click the file and select Extract All.
   In a Hewlett-Packard HP-UX environment, use the unzip utility to extract the contents of the ZIP archive.

Procedure 2.4. Download the Installer

1. Open a browser and log into the Customer Portal at https://access.redhat.com.
2. Click Downloads.
3. Click Red Hat JBoss Enterprise Application Platform in the Product Downloads list.
4. Select the correct JBoss EAP version from the Version drop-down menu.
5. Find Red Hat JBoss Enterprise Application Platform 6.x.x Installer in the list and click the Download option.

Procedure 2.5. Run the JBoss EAP Installation Program

1. Open a terminal and navigate to the directory containing the downloaded installation program JAR.
2. Type the following command:

   java -jar jboss-eap-6.x.x-installer.jar

   Note

   In the Hewlett-Packard HP-UX or Solaris environment, you can specify the required architecture by using the -d32/-d64 switch. Launch the installer by executing either of these commands:

   java -jar -d64 jboss-eap-6.x.x-installer.jar

   or

   java -jar -d32 jboss-eap-6.x.x-installer.jar

3. Follow the instructions in the table below.

Procedure 2.6. Text-based Install Process

1. Open a terminal and navigate to the directory containing the downloaded installation program JAR.
2. Launch the Text-based installer by executing the following command:

   java -jar jboss-eap-6.x.x-installer.jar -console

3. Follow the steps to install JBoss EAP 6.

Procedure 2.7. Uninstall JBoss EAP 6 (Graphical Installation)

1. During the installation of JBoss EAP 6 on the target machine, a directory called Uninstaller was created in the directory where you had installed JBoss EAP 6. This directory contains a file called uninstaller.jar. Navigate to this directory in a terminal window.
2. Launch the GUI uninstaller by executing the following command:

   java -jar uninstaller.jar

   The execution of the command will launch the graphical uninstaller as shown in the following figure. Select the check box if you want to delete the JBoss EAP 6 installation directory.
   

   Figure 2.1. Uninstall JBoss EAP 6 using the graphical installer

3. Press the Uninstall button to start the uninstall process.
4. When the uninstall process is finished, press the Quit button to exit the uninstaller. After a successful uninstall, you may want to manually remove the Uninstaller directory from where you launched the uninstaller.

Procedure 2.8. Text-based Uninstall Process

1. In a console, navigate to the Uninstaller directory created during the installation process. This can be found one level above EAP_HOME.
2. Launch the Text-based uninstaller by executing the following command:

   java -jar uninstaller.jar -console

3. Follow the steps to uninstall JBoss EAP 6.

Procedure 2.9. Install JBoss EAP 6 (Graphical RPM Installation)

1. Launch PackageKit

   PackageKit is an open source package management software installed as part of Red Hat Enterprise Linux. On the target machine launch PackageKit by selecting System → Administration → Add/Remove Software.
2. Type jboss-eap6 in the search box and then press the Find button. You will be presented with the JBoss EAP 6 package in the result box.
3. Select the JBoss EAP 6 package and press the Apply button. See figure below.
   

   Figure 2.2. JBoss EAP 6 PackageKit Install

4. Follow the rest of the steps to install JBoss EAP 6 on your target machine.

Procedure 2.10. Install JBoss EAP 6 (Text-based RPM Installation)

1. Install the RPM packages

   Use YUM to install the default JBoss EAP 6 group package by using the groupinstall command.

   yum groupinstall jboss-eap6

2. Configure initialization options.

   The RPM install contains initialization scripts for launching the server. The configuration for the initialization scripts are contained in several additional files. Refer to Section A.4, “RPM Installation Configuration Files for JBoss EAP 6” for details about these files and the options contained within.

Procedure 2.11. Automated Installation

• In a terminal, run the following command to install JBoss EAP 6 using the automatic installation script:

  java -jar jboss-eap-6.x.x-installer.jar auto.xml

  Note

  When you use the automatic installation script (auto.xml) for automated installation the installer by default will generate a prompt for entering all passwords.

• In a terminal type either of the following commands to specify the automatic installation script (present at a different network location) to your current network location.
  To access the installation script via HTTP, enter the following command, replacing network-host with the hostname of the FTP or HTTP server and auto.xml with the filename of the installation script.

  java -jar jboss-eap-6.x.x-installer.jar http://network-host/auto.xml

  To access the installation script via FTP, enter the following command:

  java -jar jboss-eap-6.x.x-installer.jar ftp://network-host/auto.xml

Procedure 2.12. 

1. Enter key values in variable file

   JBoss EAP 6 installer creates an automatic installation script and an automatic installation variable file. The automatic installation variable file contains a list of keys and password parameters needed for automatic installation. To enter key values open the automatic installation variable file. Fill in a valid key/password value against each key parameter. For example:

   adminPassword = password#2
   vault.keystorepwd = vaultkeystorepw
   ssl.password = user12345

2. Run the installer with the variablefile filename argument to begin automated installation

   You can begin a fully automated JBoss EAP installation by running the installer with the variablefile argument. This argument supplies the variable file key/password values (step 1) to the installer.To begin a fully automated installation, open a terminal and enter the following command, replacing auto.xml and auto.xml.variables with the names of your files:

   java -jar jboss-eap-6.x.x-installer.jar auto.xml -variablefile auto.xml.variables

Procedure 2.13. 

• Run the Installer with the Variables Argument

  Start the automated installation by running the installer with the variables argument and then specifying a variable list. The variables specifies the variables and their key or password values during installation. To initiate the installation process open a terminal and enter the following command, replacing the filename auto.xml and the variables' values with your own:

  java -jar jboss-eap-6.x.x-installer.jar auto.xml -variables adminPassword=password#2,vault.keystorepwd=vaultkeystorepw,ssl.password=user12345

  Note

  It is important to specify the variable names (adminPassword, keystorepwd and ssl.password) without any empty space for successful installation.

Procedure 2.14. Download and Install Native Components

1. Download the Native Components package for your operating system and architecture from the Red Hat Customer Portal. You can download the packages from the same location specified in Section 2.3.1, “Download JBoss EAP 6 (Zip Installation)”.
2. Extract the downloaded Native Components zip archive over your JBoss EAP 6 installation.
   You can verify a successful extraction by checking if there is a new folder for your operating system and architecture in EAP_HOME/modules/system/layers/base/org/jboss/as/web/main/lib/.
3. Using the Management CLI, activate the native components for the web subsystem with the following command:

   /subsystem=web:write-attribute(name=native,value=true)

4. Restart the JBoss EAP 6 server to apply the changes.

Procedure 2.15. Download and Install Native Utilities

1. Download the Native Utilities package for your operating system and architecture from the Red Hat Customer Portal. You can download the packages from the same location specified in Section 2.3.1, “Download JBoss EAP 6 (Zip Installation)”.
2. Extract the downloaded Native Components zip archive over your JBoss EAP 6 installation.
   You can verify a successful extraction by checking if there is native directory in EAP_HOME/modules/system/layers/base/.
3. Refer to procedures in the JBoss EAP documentation suite and on the Red Hat Customer Portal to configure specific native utilities features.

Procedure 2.16. Install Native Components and Native Utilities

1. Install native components and utilities

   To install native components and utilities in Red Hat Enterprise Linux 5, 6 and 7 (with their dependencies) run the following command using your administration account, replacing package_name with name of the native component which you need to install:

   yum install package_name

   You can install these native components: mod_cluster-native, mod_jk, mod_rt, mod_snmp, apache-commons-daemon-jsvc-eap6, httpd, httpd-devel, jbossas-hornetq-native, jbossas-jbossweb-native.

   Important

   The native components jbossas-hornetq-native and jbossas-jbossweb-native are installed by default when you run the yum groupinstall jboss-eap6 command to install JBoss EAP 6 group package. If you have used Section 2.6.7, “Install JBoss EAP 6 (Graphical RPM Installation)” or Section 2.6.8, “Install JBoss EAP 6 (Text-based RPM Installation)” for JBoss EAP 6 installation you need not install jbossas-hornetq-native and jbossas-jbossweb-native.

   Note

   It is important to give the correct package name in order to install a specific native component. Package names are case sensitive. In Red Hat Enterprise Linux 7 the name of the httpd package is httpd22. Therefore the package httpd must be replaced with httpd22 when you run yum install package_name command for installing Apache HTTP server in Red Hat Enterprise Linux 7.

2. Restart the server

   Restart the JBoss EAP 6 server to apply the changes

Procedure 2.17. Configure JBoss EAP 6 as a Service using the RPM Method in Red Hat Enterprise Linux

1. Install JBoss EAP 6

   Install JBoss EAP 6 via the RPM method using one of the steps listed in the prerequisite sections listed above.

2. Enable the service

   The RPM install method for JBoss EAP 6 installs the requisite service files in their correct locations. All you need to do to set it up as service is issue the following command:

   chkconfig jbossas on

   To set it up as a service in domain mode, issue the following command:

   chkconfig jbossas-domain on

Procedure 2.18. Set Up the Service

1. Locate the start-up script and configuration file

   The start-up script and an associated configuration file are located in the EAP_HOME/bin/init.d/ directory.

2. Customize the start-up options in the jboss-as.conf file

   Open the file jboss-as.conf in a text editor. There are several options within the jboss-as.conf file. At the minimum, specify the correct values for JBOSS_HOME and the JBOSS_USER variables. If these variables are absent, add them.

3. Copy files into system directories

   1. Create the /etc/jboss-as directory if it doesn't already exist.

      sudo mkdir /etc/jboss-as

   2. Copy the modified configuration file to the /etc/jboss-as directory.

      sudo cp EAP_HOME/bin/init.d/jboss-as.conf /etc/jboss-as

   3. Copy the start-up script to the /etc/init.d directory.

      sudo cp EAP_HOME/bin/init.d/jboss-as-standalone.sh /etc/init.d

      To make the start-up script executable.

      sudo chmod +x /etc/init.d/jboss-as-standalone.sh

4. Add the start-up script as a service.

   Add the new jboss-as-standalone.sh service to list of automatically started services, using the chkconfig service management command.

   sudo chkconfig --add jboss-as-standalone.sh

5. Start the service.

   Test that the service has been installed correctly by using one of the following commands for Red Hat Enterprise Linux.
   • For Red Hat Enterprise Linux 5 and 6:

     sudo service jboss-as-standalone.sh start

   • For Red Hat Enterprise Linux 7:

     sudo service jboss-as-standalone start

   If everything has gone correctly, you should get a green [OK]. If you get an error, check the error logs and make sure your paths are correct in the configuration file.

   Note

   The green [OK] does not appear for Red Hat Enterprise Linux 7.

6. Make the service start automatically when you restart your server.

   To add the service to the list of services which start automatically when your server restarts, issue the following command.

   sudo chkconfig jboss-as-standalone.sh on

Procedure 2.19. Uninstall the JBoss EAP 6 service from Red Hat Enterprise Linux

1. If the service is running, first open a terminal and stop the service by executing the stop command with the name of the service:

   sudo service jboss-as-standalone.sh stop

2. Remove JBoss EAP from the list of services:

   sudo chkconfig --del jboss-as-standalone.sh

3. Remove the system directory files.
   1. Remove the service start-up script:

      sudo rm /etc/init.d/jboss-as-standalone.sh

   2. Remove the service configuration file:

      sudo rm /etc/jboss-as/jboss-as.conf

      Important

      /etc/jboss-as is not a standard system directory. Only if there are no other files being used there, also remove the directory itself:

      sudo rm -rf /etc/jboss-as/

Procedure 2.20. Configure a Service for JBoss EAP 6 in Microsoft Windows Server

1. Create system environment variables

   Create two system environment variables:
   • JBOSS_HOME pointing to the JBoss EAP 6 installation directory.
   • NOPAUSE=1

2. If not already configured, download and extract the Native Utilities package for your architecture

   If the Native Utilities for Windows Server package has not been installed as part of the JBoss EAP 6 installation, download the relevant 32-bit or 64-bit package from the Red Hat Customer Portal at https://access.redhat.com. Extract the Native Utilities zip archive over the JBoss EAP 6 installation.
   This will result in a native directory in the following location in the JBoss EAP 6 installation: EAP_HOME\modules\system\layers\base\

3. Install the service

   Open a terminal, and change directories to EAP_HOME\modules\system\layers\base\native\sbin
   A new service can be created with the service install command, with the available options shown in the following table.

   Table 2.4. service install options

   Argument or Switch	Description
   /startup	Indicates the services to auto start. If not specified, the service is set to be started manually.
   /controller HOST:PORT	The host and port of the management interface. If omitted, the default is localhost:9999.
   /host [DOMAIN_HOST]	Indicates that domain mode is to be used, with an optional host controller name. If the host controller name is omitted, the default name master is used.
   /loglevel LEVEL	The log level for the service, either: ERROR, INFO, WARN or DEBUG. If omitted, the default is INFO
   /name SERVICE_NAME	The name of the service to be created, must not contain spaces. If omitted, the default is JBossEAP6
   /desc "DESCRIPTION"	The description of the service. If omitted, the default is "JBoss Enterprise Application Platform 6"
   /serviceuser DOMAIN\USERNAME	Specifies the name of the account under which the service will run. Use an account name in the format of DOMAIN\USERNAME. If omitted, the service runs as the Local System account.
   /servicepass PASSWORD	Password for /serviceuser account.
   /jbossuser USERNAME	Optional, the JBoss EAP 6 username to use for the shutdown command.
   /jbosspass PASSWORD	Password for /jbossuser account, required if /jbossuser is specified.
   /config XML_FILE	Specifies the server-config to use. The default is standalone.xml or domain.xml.
   /hostconfig XML_FILE	Specifies the host config to use in Domain mode only. The default is host.xml.
   /base directory	Specifies the base directory for server/domain content as a fully qualified path. The default is %JBOSS_HOME%\standalone or %JBOSS_HOME%\domain.
   /logpath path	Specifies the path of the log files. /base applies when /logpath is not defined. The default depends on the domain mode or standalone mode, %JBOSS_HOME%\domain\log or %JBOSS_HOME%\standalone\log.
   /debug	Runs the service install in debug mode.

   Below are basic examples of an install command to create a new service in either standalone or domain mode. Execute the following command, adjusting the log level for the service as required:
   • Standalone mode:

     service.bat install /loglevel INFO

   • Domain mode:
     If you are not using the default master for your JBoss EAP 6 domain controller, replace master with the correct host name or alias of the JBoss EAP 6 domain controller.

     service.bat install /host master /loglevel INFO

   A new Windows service will be created with name JBossEAP6.

4. Verify the new service in the Services console

   Execute the following command in a terminal to open the Windows Services console:

   services.msc

   If the default service name was used, in the list of Windows services, the new service will have the display name: JBossEAP6. From the Services console you can start and stop the service, as well change its settings on how and when it starts.

5. Starting and stopping the JBoss EAP 6 service from a terminal

   To start the service from a terminal, use the following command, changing the service name if necessary:

   net start JBossEAP6

   To stop the service from a terminal, use the following command, changing the service name if necessary:

   net stop JBossEAP6

Procedure 2.21. Uninstall the JBoss EAP 6 service from Microsoft Windows Server

• If the service is running, first open a terminal and stop the service by executing the net stop command with the name of the service:

  net stop JBossEAP6

  In a terminal, change directories to EAP_HOME\modules\system\layers\base\native\sbin and execute the following command:

  service uninstall

Procedure 3.5. Apply a patch to a JBoss product via the RPM method

1. Get notified about the security patch either via being a subscriber to the JBoss watch mailing list or by browsing the JBoss watch mailing list archives.
2. Read the errata for the security patch and confirm that it applies to a JBoss product in your environment.
3. If the security patch applies to a JBoss product in your environment, then follow the link to download the updated RPM package which is included in the errata.
4. Use

   yum update

   to install the patch.

   Important

   When updating an RPM installation, your JBoss product is updated cumulatively with all RPM-released fixes.

Procedure 3.6. Subscribe to the JBoss Watch List

1. Click the following link to go to the JBoss Watch mailing list page: JBoss Watch Mailing List.
2. Enter your email address in the Subscribing to Jboss-watch-list section.
3. [You can enter your name and select a password for yourself. Doing so is optional but recommended.]
4. Press the Subscribe button to start the subscription process.
5. You can browse the archives of the mailing list by going to: JBoss Watch Mailing List Archives.

Procedure 3.7. Upgrade to the latest JBoss EAP 6 version

1. Move the downloaded ZIP archive to the desired location. It is recommended that this is a different location to the existing JBoss EAP 6 installation.

   Important

   If you wish to install the latest version of JBoss EAP 6 to the same directory location as the existing installation, you will need to move the existing installation to a different location before proceeding. This is to prevent modified configuration files, deployments, and upgrades from being lost.
2. Unzip the archive. This step installs a clean instance of the latest JBoss EAP 6 release.
3. Copy the EAP_HOME/domain/ and EAP_HOME/standalone/ directories from the previous installation over the new installation directories.

   Note

   New features in the new release, such as new subsystems, may not be activated if configuration files are copied from an older JBoss EAP 6 installation. To use these new features, it is necessary to compare and update the old configuration files with the ones from the new version.
4. Review the changes made to the bin directory of the previous installation, and make the equivalent modifications to the new directory.

   Warning

   Files in the bin directory should not be overwritten by the files from previous versions. Changes should be made manually.
5. Review the remaining modified files from the previous installation, and move these changes into the new installation. These files may include:
   • The welcome-content directory.
   • Custom modules in the modules directory.
   • Custom bundles in the bundles directory.
6. Optional: If JBoss EAP 6 was previously configured to run as a service, remove the existing service and configure a new service for the upgraded installation.

Procedure 3.8. Upgrade to the latest JBoss EAP 6 release

1. Run the following command in a terminal to upgrade the installation:

   yum update

2. Manually merge each created *.rpmnew file that contains changes into the production configuration files.

Procedure 3.9. Setup a JBoss EAP Cluster

1. Refer to the HTTP Clustering and Load Balancing chapter of the JBoss EAP 6.4 Administration and Configuration Guide for instructions on how to setup a JBoss EAP cluster in 6.4.
2. Migrate all traffic to this new cluster using the steps outlined in the Migrate Traffic between Clusters chapter of the JBoss EAP 6.4 Administration and Configuration Guide