Installation Guide

Procedure

1. Log in to the Red Hat Customer Portal.
2. Click Downloads.
3. Select Red Hat JBoss Enterprise Application Platform in the Product Downloads list.
4. In the Version drop-down list, select 7.4.
5. Find Red Hat JBoss Enterprise Application Platform 7.4.0 in the list and click the Download link.

Procedure

1. Log in to the Red Hat Customer Portal.
2. Click Downloads.
3. Select Red Hat JBoss Enterprise Application Platform in the Product Downloads list.
4. From the Version drop-down list, select 7.4
5. Find Red Hat JBoss Enterprise Application Platform 7.4.0 in the list and select the Download link.

6. Optional: Move the archive file to the server and location where you want to install JBoss EAP.

   Note

   You must have read and write access to this directory.

7. Depending on your operating system, choose one of the following options:

   • For Red Hat Enterprise Linux, extract the archive file by entering the following command in the management CLI:

     $ unzip jboss-eap-7.4.0.zip

   • For Windows Server, right-click the archive file and select Extract All.

Procedure

1. Configure the start-up options in the jboss-eap.conf file by opening the jboss-eap.conf in a text editor and set the options for your JBoss EAP installation.

2. Copy the service initialization and configuration files into the system directories:

   1. Copy the modified service configuration file to the /etc/default directory.

      $ sudo cp EAP_HOME/bin/init.d/jboss-eap.conf /etc/default

   2. Copy the service startup script to the /etc/init.d directory and give it execute permissions:

      $ sudo cp EAP_HOME/bin/init.d/jboss-eap-rhel.sh /etc/init.d
      $ sudo chmod +x /etc/init.d/jboss-eap-rhel.sh
      $ sudo restorecon /etc/init.d/jboss-eap-rhel.sh

3. Add the new jboss-eap-rhel.sh service to the list of automatically started services using the chkconfig service management command:

   $ sudo chkconfig --add jboss-eap-rhel.sh

4. Verify that the service has been installed correctly by using one of the following commands.

   1. For Red Hat Enterprise Linux 6:

      $ sudo service jboss-eap-rhel.sh start

   2. For Red Hat Enterprise Linux 7 and 8:

      $ sudo service jboss-eap-rhel start

      The service starts. If the service does not start and you get an error message, check the error logs and make sure that the options in the configuration file are set correctly.

   3. For Red Hat Enterprise Linux 9:

      Note

      Red Hat Enterprise Linux 9 does not have the initscripts package in the default build. This package includes the /etc/init.d/functions file used by the jboss-eap-rhel.sh service. The /etc/init.d/functions file is required to start JBoss EAP as a service; therefore, install the initscripts package using the following command:

      $ sudo dnf install initscripts

      1. Restart systemctl:

         $ sudo systemctl daemon-reload

      2. Start JBoss EAP:

         $ sudo service jboss-eap-rhel start

5. Optional: To make the service start automatically when the Red Hat Enterprise Linux server starts, run the following command:

   $ sudo chkconfig jboss-eap-rhel.sh on

Procedure

1. If the service is running, open a terminal and stop the service with one of the following commands:

   1. For Red Hat Enterprise Linux 6:

      $ sudo service jboss-eap-rhel.sh stop

   2. For Red Hat Enterprise Linux 7 and later:

      $ sudo service jboss-eap-rhel stop

2. Remove JBoss EAP from the list of services:

   $ sudo chkconfig --del jboss-eap-rhel.sh

3. Delete the configuration file and startup script:

   $ sudo rm /etc/init.d/jboss-eap-rhel.sh
   $ sudo rm /etc/default/jboss-eap.conf

Procedure

1. Install the JBoss EAP Core Services Jsvc package:

   1. Open a browser and log in to the Red Hat Customer Portal’s Software Downloads page.
   2. From the Product drop-down list, select Apache Jsvc.
   3. From the Version drop-down list, select the latest version.
   4. From the Releases list, select Red Hat JBoss Core Services Apache Jsvc. Ensure that you select the correct platform and architecture for your system. Next, select the Download link.

2. Extract the downloaded archive file into the directory containing your JBoss EAP installation directory. This results in a jbcs-jsvc-<VERSION> directory at the same depth as your JBoss EAP installation directory. The following example shows the path to the jbcs-jsvc-<VERSION> directory:

   C:\Program Files
   ├── jboss-eap-7.4
   │   ├── bin
   │   └── ...
   └── jbcs-jsvc-<VERSION>

3. Install the service by opening the terminal and changing the directories to EAP_HOME\bin. For a list of all possible options, run service.bat without any arguments

   Note

   If you specify the /jbossuser and /jbosspass parameters, you must ensure that your JBoss EAP user’s password does not contain a hash (#) or a semicolon (;).

   The following examples show a basic service.bat install command that is needed to create a new service for either a standalone server, or a server in a managed domain.

   Enter the following command, adjusting the log level for the service as required:

   1. For a standalone server:

      $ service.bat install /loglevel INFO

   2. For a server in a managed domain:

      Use the /host parameter to specify the name of the JBoss EAP host controller being controlled by the service. You can see valid values for the name by executing ls /host in the management CLI.

      In the following command, replace EAP_HOST_NAME with your JBoss EAP host controller name. If you specify the /host parameter without providing a JBoss EAP host controller name, the name defaults to master.

      $ service.bat install /host EAP_HOST_NAME /loglevel INFO

4. A new Windows service is created with the name JBossEAP7.

Procedure

1. Use the setx command to create two system environment variables: JBOSS_HOME and NOPAUSE.

2. Use the setx command to configure the two environment variables:

   1. Configure the path for the JBOSS_HOME variable to the JBoss EAP installation directory.
   2. The jboss-cli.bat script contains the if "x%NOPAUSE%" == "x" pause line of code. This code creates a status message when you issue the pause command. To disable these messages, you must specify a value for the NOPAUSE variable. For example, setting the NOPAUSE variable to NOPAUSE=true disables status messages from appearing when a script completes.

Procedure

1. If the service is running, open the command prompt and stop the service by entering the net stop command with the name of the service:

   net stop JBossEAP7

2. At a command prompt, change directories to EAP_HOME\bin and execute the following command:

   service.bat uninstall

Procedure

1. Open a browser and log in to the Red Hat Customer Portal’s Software Downloads page.
2. From the Product drop-down list, select Apache Jsvc.
3. From the Version drop-down list, select the latest version.
4. From the Releases list, select Red Hat JBoss Core Services Apache Jsvc. Ensure that you select the correct platform and architecture for your system. Next, select the Download link.

5. Extract the downloaded archive file into the directory containing your JBoss EAP installation directory.

   This results in a jbcs-jsvc-<VERSION> directory at the same depth as your JBoss EAP installation directory. For example:

   /var/opt/
   ├── jboss-eap-7.4
   │   ├── bin
   │   └── ...
   └── jbcs-jsvc-<VERSION>

6. Optional: The command examples for using Jsvc to start JBoss EAP assume that a jboss user has been created. If you have not already created a user for JBoss EAP, run the following commands to create the jboss user and group:

   # groupadd -f -g 185 -r jboss
   # useradd -r -u 185 -g jboss -d EAP_HOME -s /sbin/nologin -c "JBoss" jboss

Procedure

1. Delete the installation directory to uninstall JBoss EAP.
2. Delete any scripts that depend on JBoss EAP being installed on your machine.

Procedure

1. Log in to the Red Hat Customer Portal.
2. From the Product Downloads list, select Red Hat JBoss Enterprise Application Platform.
3. Click Downloads.
4. From the Version drop-down list, select 7.4.
5. Find Red Hat JBoss Enterprise Application Platform 7.4.0 Installer file in the list and click the Download link.

Procedure

1. Open a terminal and navigate to the directory containing the downloaded JBoss EAP installer file.

2. Run the graphical installer using the following command:

   $ java -jar jboss-eap-7.4.0-installer.jar

3. Choose the desired language for the installer and click OK.
4. Agree with the prompt for The EULA for RED HAT JBOSS MIDDLEWARE by selecting "I accept the terms of this license agreement", and then click Next.
5. Select the installation path for JBoss EAP, and click Next.

6. Select the components to install. Required components are disabled for deselection.

   Figure 3.1. JBoss EAP installer - Component selection screen

   
7. Create an administrative user and assign a password. Then click Next.
8. Review your installation options, and then click Yes.
9. When the installation progress completes, click Next.

10. Choose a default configuration for your JBoss EAP installation, or choose to perform an advanced configuration with the installer.

    Note

    Even if you choose a default configuration, you can still alter your configuration using the JBoss EAP management interfaces at a later time.

11. Select Perform default configuration, or select Perform advanced configuration and select the items to configure, and then click Next.

    Figure 3.2. JBoss EAP installer - Configure runtime environment screen

    

12. The following configuration steps are optional:

    Configure password vault

    You can use the Configure Password Vault option to install a password vault in the advanced configuration of the runtime environment.

    • Configure a password vault to store your sensitive passwords in an encrypted keystore, and then click Next.  

    For more information, see the password vault documentation in the How To Configure Server Security guide.

    Figure 3.3. JBoss EAP installer - Configure password vault screen

    

    SSL Security

    You can enable SSL Security in the advanced configuration of the runtime environment by specifying the location of the keystore and the password for securing the JBoss EAP management interfaces.

      a. Specify the location of the keystore and the password for securing the JBoss EAP management interfaces.

      b. When you have specified these values, click Next.

      For more information, see the documentation on securing the management interfaces in the How To Configure Server Security guide.

    Warning

    Red Hat recommends that SSLv2, SSLv3, and TLSv1.0 be explicitly disabled in favor of TLSv1.1 or TLSv1.2 in all affected packages.

    LDAP configuration

    You can enable the LDAP server to be the authentication and authorization authority as follows:

      a. Select Configure Runtime.

      b. Select Enable LDAP authentication.

      c. On the LDAP Configuration screen, complete the required configurations and click Next.

      For more information, see the LDAP documentation in How to Configure Identity Management.

    Figure 3.4. JBoss EAP installer - LDAP configuration screen

    

    LDAP security realm configuration

    You can enable LDAP authentication in the advanced configuration of the runtime environment by using the LDAP connection, which is defined in the previous step. Enabling LDAP authentication creates a new security realm and this realm becomes associated with the management interfaces.  

    • Specify the values for your LDAP Security Realm, and then click Next.

      For more information, see the LDAP documentation in How to Configure Identity Management.

    Figure 3.5. JBoss EAP installer - LDAP security realm configuration screen

    

    Security Domain Configuration

    You can add a security domain in the advanced configuration of the runtime environment by configuring a security domain for the JBoss EAP server instance. Most of the fields are already populated with default values and do not need modification.

      a. Configure the security domain for your JBoss EAP server instance.

      b. Click Next.

      For more information, see Security Domains in the Security Architecture guide.

    Figure 3.6. JBoss EAP installer - Security domain configuration screen

    

    Java Secure Socket Extension configuration

    You can add a security domain in the advanced configuration of the runtime environment by configuring the Jave Secure Socket Extension (JSSE) for the security domain defined in the previous step.

      a. For the JSSE element, set either a keystore or a truststore.

      b. Click Next.

    Figure 3.7. JBoss EAP installer - Java Secure Socket Extension configuration screen

    

    Quickstarts

    You can choose to install quickstarts in the advanced configuration of the runtime environment by selecting the quickstart installation path, and then clicking Next.

    Maven repository setup

    You can install quickstarts in the advanced configuration of the runtime environment by selecting your Maven repository and its settings.xml file.

    Figure 3.8. JBoss EAP installer - Maven repository setup screen

    

    Socket bindings

    Choose one of the following options to configure your socket bindings:

    • Configure server port bindings in the advanced configuration settings of the runtime environment by configuring port offsets for all default bindings, or configuring custom port bindings. You might need to determine whether the installation uses the default port bindings.
    • Configure port offsets by choosing the offset type.
    • Configure custom bindings by selecting whether to configure the ports for standalone mode, domain mode, or both.
    • If the host is configured for IPv6 only, select the Enable pure IPv6 configuration check box and the installer makes the required configuration changes.

    When you have configured your socket binding, click Next.

    Figure 3.9. JBoss EAP Installer - Socket bindings screen

    

    Custom socket bindings for Standalone configurations

    • Configure custom port bindings for standalone mode by setting the ports and system properties for each of the standalone configurations (standalone, standalone ha, standalone full, standalone full-ha), and then click Next.

    Figure 3.10. JBoss EAP installer - Custom socket bindings for standalone configurations screen

    

    Custom socket bindings for domain configurations

    • Configure custom port bindings for domain mode by setting the ports and system properties for the host configuration (domain host) and each of the domain profiles (domain default, domain ha, domain full, domain full-ha), and then click Next.

    Figure 3.11. JBoss EAP installer - Custom socket bindings for domain configurations screen

    

    Logging options

    You can configure logging levels in the advanced configuration settings of the runtime environment as follows:

      a. Select the desired logging levels for the root logger and the console logger.

      b. Click Next.

    Jakarta server faces setup

    You can install a Jakarta Server Faces implementation in the advanced configuration settings of the runtime environment, as follows:

      a. Configure the Jakarta Server Faces options and paths to your Jakarta Server Faces JARs.

      b. Click Next.

      For more information, see Installing a Jakarta Server Faces Implementation in the Configuration Guide.

    Figure 3.12. JBoss EAPinstaller - Jakarta server faces setup screen

    

    JDBC driver setup

    You can install a JDBC driver in the advanced configuration settings of the runtime environment by installing and setting up a JDBC driver.

      a. Choose the appropriate driver vendor from the drop-down list.

      b. Specify the driver’s JAR location(s).

      c. Click Next.

      For more information, see the datasource JDBC driver section in the Configuration Guide.

    Figure 3.13. JBoss EAP installer - JDBC driver setup screen

    

    Datasource setup

    You can install a JDBC driver and install a datasource in the advanced configuration settings of the runtime environment by configuring a datasource.

      a. Provide a datasource name and configure the other options.

      b. Click Next.

      For more information, see the details of datasource management in the Configuration Guide.

    Figure 3.14. JBoss EAP installer - Datasource setup screen

    
13. When the configuration progress completes, click Next.

14. Select the Create shortcuts in the Start-Menu check box to create shortcuts, and then click Next.

    Note

    Only alphanumeric characters, dash (-), and underscore (_) characters are allowed. On Microsoft Windows, the slash (/) and backslash (\) characters are also allowed.

15. Click Generate installation script and properties file if you want to capture the selected installation options for a future automated installer installation, and then click Done.

Procedure

1. Open a terminal and navigate to the directory containing the downloaded JBoss EAP installer.

2. Run the text-based installer using the following command:

   $ java -jar jboss-eap-7.4.0-installer.jar -console

3. Follow the prompts to install JBoss EAP. The directory created by the installer is the top-level directory for the server. This is referred to as EAP_HOME.

Procedure

1. Configure the start-up options in the jboss-eap.conf file by opening the jboss-eap.conf in a text editor and set the options for your JBoss EAP installation.

2. Copy the service initialization and configuration files into the system directories:

   1. Copy the modified service configuration file to the /etc/default directory.

      $ sudo cp EAP_HOME/bin/init.d/jboss-eap.conf /etc/default

   2. Copy the service startup script to the /etc/init.d directory and give it execute permissions:

      $ sudo cp EAP_HOME/bin/init.d/jboss-eap-rhel.sh /etc/init.d
      $ sudo chmod +x /etc/init.d/jboss-eap-rhel.sh

3. Add the new jboss-eap-rhel.sh service to the list of automatically started services using the chkconfig service management command:

   $ sudo chkconfig --add jboss-eap-rhel.sh

4. Verify that the service has been installed correctly by using one of the following commands.

   1. For Red Hat Enterprise Linux 6:

      $ sudo service jboss-eap-rhel.sh start

   2. For Red Hat Enterprise Linux 7 and later:

      $ sudo service jboss-eap-rhel start

      The service starts. If the service does not start and you get an error message, check the error logs and make sure that the options in the configuration file are set correctly.

5. Optional: To make the service start automatically when the Red Hat Enterprise Linux server starts, run the following command:

   $ sudo chkconfig jboss-eap-rhel.sh on

   Verification

   • To check the permissions of a file, enter the ls -l command in the directory containing the file.

   • To check that the automatic service start is enabled, enter the following command:

     $ sudo chkconfig --list jboss-eap-rhel.sh

   • For more information about controlling the state of services, see Management system services in the JBoss EAP Configuring basic system settings guide.
   • For more information about viewing error logs, see Bootup logging in the JBoss EAP Configuration Guide.

Procedure

1. Open a terminal and navigate to the directory containing the downloaded JBoss EAP installer file.

2. Run the following command to install JBoss EAP using the automatic installation script XML file:

   $ java -jar jboss-eap-7.4.0-installer.jar auto.xml

   By default, the installer prompts you to enter any passwords required for the JBoss EAP configuration. You can do an unattended install by pre-setting the passwords for the installation.

   Note

   You can store the automatic installation script XML file on a network host, and use HTTP or FTP to point the installer to use it for an installation. For example:

   $ java -jar jboss-eap-7.4.0-installer.jar http://network-host.local/auto.xml

   $ java -jar jboss-eap-7.4.0-installer.jar ftp://network-host.local/auto.xml

Procedure

1. Open the .variables file in a text editor and provide a password value for each key. The following example demonstrates setting a password value for a key:

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

2. Run the installer using the automatic installation script XML file:

   $ java -jar jboss-eap-7.4.0-installer.jar auto.xml
   
   Checking for corresponding .variables file
   Variables file detected: auto.xml.variables
   [ Starting automated installation ]
   ...

Procedure

1. Specify the path to the variables file using -variablefile:

   $ java -jar jboss-eap-7.4.0-installer.jar auto.xml -variablefile auto.xml.variables

2. Run the installer using the automatic installation script XML file and specify the required passwords as key/value pairs using the -variables argument, as demonstrated in the following example:

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

   Note

   Check that you have not entered any spaces when specifying the -variables key or value pairs.

Procedure

1. Open a terminal and navigate to EAP_HOME/Uninstaller.

2. Run the graphical uninstaller using the following command:

   $ java -jar uninstaller.jar

   The graphical uninstaller is similar to the following figure. Select the check box if you want to delete the JBoss EAP installation directory.

   Figure 3.15. JBoss EAP graphical uninstaller

   
3. Click Uninstall to start the uninstall process.
4. When the uninstall process is finished, click Quit to exit the uninstaller.

Procedure

1. Open a terminal and navigate to EAP_HOME/Uninstaller.

2. Run the text-based uninstaller using the following command:

   $ java -jar uninstaller.jar -console

3. Follow the prompts to uninstall JBoss EAP.

Procedure

1. Enter the Red Hat Subscription Manager.

2. Replace EAP_MINOR_VERSION with your intended JBoss EAP minor version. For example, 7.4.

   1. For Red Hat Enterprise Linux 6 and 7, replace RHEL_VERSION with either 6 or 7 depending on your Red Hat Enterprise Linux version:

      # subscription-manager repos --enable=jb-eap-EAP_MINOR_VERSION-for-rhel-RHEL_VERSION-server-rpms

   2. For Red Hat Enterprise Linux 8, use the following command:

      # subscription-manager repos --enable=jb-eap-EAP_MINOR_VERSION-for-rhel-RHEL_VERSION-ARCH-rpms

Procedure

1. Install JBoss EAP and JDK 8.

   # yum groupinstall jboss-eap7

2. Install JBoss EAP and JDK 11. JDK 11 is available for Red Hat Enterprise Linux 7 and later.

   • Red Hat Enterprise Linux 7:

     # yum groupinstall jboss-eap7-jdk11

   • Red Hat Enterprise Linux 8:

     # dnf groupinstall jboss-eap7-jdk11

     Note

     The groupinstall command installs the specified version of JDK if that version of JDK is not installed on the system. If a different version of JDK already exists, the system contains multiple JDKs installed after the command is executed.

     If there are multiple JDKs installed on your system after groupinstall is complete, check which JDK is used for JBoss EAP execution. By default, the system default JDK is used.

     You can modify the default by either of the following ways:

     • Change system wide configuration using the alternatives command:

       # alternatives --config java

       The command displays a list of installed JDKs and instructions for setting a specific JDK as the default.

     • Change the JDK used by JBoss EAP by using the JAVA_HOME property.

       Your installation is complete. The default EAP_HOME path for the RPM installation is /opt/rh/eap7/root/usr/share/wildfly.

       Important

       When using the RPM installer to install JBoss EAP, configuring multiple domain or host controllers on the same machine is not supported.

Procedure

1. Using Red Hat Subscription Manager, unsubscribe from the existing repository and subscribe to the new repository. In the command below, replace EXISTING_REPOSITORY and NEW_REPOSITORY with the respective repository names.

   # subscription-manager repos --disable=EXISTING_REPOSITORY --enable=NEW_REPOSITORY

Procedure

1. Log in to the Red Hat Customer Portal.
2. Click on Systems in the Subscriber Inventory.

3. Subscribe to the JBoss Core Services CDN repositories for your operating system version and architecture:

   1. For Red Hat Enterprise Linux 6:

      jb-coreservices-1-for-rhel-6-server-rpms

   2. For Red Hat Enterprise Linux 7 and later:

      jb-coreservices-1-for-rhel-7-server-rpms

   3. Run the following command as the root user to install Apache Jsvc:

      # yum groupinstall jbcs-jsvc