Installation and activation

Tip

Using Eclipse? Get the XRebel for Eclipse plugin instead.


Download and setup

  1. Download the XRebel archive from http://zeroturnaround.com/software/xrebel/download/. If you downloaded the evaluation version of XRebel after signing up on the web site, your license information is automatically bundled with the archive.
  2. Extract the archive to a location of your choice. You will end up with these files:
3rd-party-licenses.txt
Changelog.txt
License.txt
readme.txt
xrebel.jar
xrebel.lic
  1. Add the following parameter to JVM arguments for the application server. Make sure the path that you refer to contains the xrebel.jar file:
-javaagent:[path/to/]xrebel.jar

Using multiple agents in the same JVM process? You need to specify the -javaagent parameter for every agent:

-javaagent:[path/to/]xrebel.jar -javaagent:[path/to/]jrebel.jar

Consider increasing memory available to the JVM when using multiple agents.

  1. And you are done! Launch your server and application. The XRebel toolbar should now appear within your browser window.

Note

Need more help with configuring the XRebel launch? Adding XRebel via IDE and on application servers.

Your application does not have a front-end? Maybe you cannot inject the toolbar into the application? Use the XRebel Standalone UI feature.


License activation

When launching an application with XRebel, you will see this banner in the console:

XRebel: ################################################################
XRebel:
XRebel:  XRebel 3.3.1 (201704210729)
XRebel:  (c) Copyright ZeroTurnaround AS, Estonia, Tallinn.
XRebel:
XRebel:  For questions and support, contact xrebel@zeroturnaround.com
XRebel:
XRebel: ################################################################

You will be able to activate the license once the application UI is displayed in the browser window. This popup will be shown:

../_images/signup-form.png

XRebel Trial

Note

When downloading the evaluation version of XRebel, your license information is automatically bundled with the archive. You can skip this chapter.

If you downloaded the XRebel ZIP without signing up for a trial license, you can sign up for a trial license from within the application. Complete the form and press Activate XRebel Trial to activate your license. You will be granted a 14-day evaluation license.


I have a license

If you already have a license, press the I have a license link at the bottom. The activation view will switch:

../_images/activation-form.png

This view permits activating XRebel using the following methods:

  • Activation key – Use this option when you were given an activation key. Paste your license key in the text field and press Activate license.
  • License file (xrebel.lic) – Use this option when you were emailed a license file (xrebel.lic). Browse to the license file and press Activate license.
  • License server – Use this option when you activate using a ZeroTurnaround License Server. Paste the Group URL (provided by your license server administrator) into the first field and specify your email in the second field. Press Activate license.

If you do not have a license code, press Try XRebel for Free. This will return you to the evaluation signup form (provided you have not evaluated XRebel before).

Tip

You can always review your current license status in Settings > About.

Refer to the Troubleshooting section if you have trouble with your license file.


Adding XRebel to your server

Having trouble getting XRebel to work with your application server? This chapter details the correct examples for how to add the JVM parameter to your server startup, using either an IDE or running your server without it.


Adding the XRebel parameter using an IDE

You can make your life a lot easier when you use an IDE. This section helps you add XRebel to your servers in Eclipse, IntelliJ IDEA, NetBeans and JDeveloper.


Eclipse

Tip

XRebel for Eclipse is available for download. Learn more.


This set of instructions assumes that you have already configured a server to be used in your IDE. In this example we have a Tomcat 8.0 server present in Eclipse.

  1. Open Run > Run Configurations...
  2. Select the desired server from the left hand menu.
  3. Open the Arguments tab on the right. You will be presented with this view:
../_images/addparameter-eclipse.png
  1. Add the following line under VM arguments:
-javaagent:[path/to/]xrebel.jar
  1. Press Apply to store the configuration.

From here, you can either press Run to immediately run the new server configuration. If you defined the XRebel location successfully, you should see the XRebel banner in the server console immediately on startup.


IntelliJ IDEA

This set of instructions assumes that you have already configured a server to be used in your IDE. In this example we have a Tomcat 7.0 server present in IntelliJ IDEA.

  1. Open Run > Edit Configurations...
  2. Select the desired server from the left hand menu. You will be presented with this view:
../_images/addparameter-intellij.png
  1. Add the following line in the VM options field:
-javaagent:[path/to/]xrebel.jar
  1. Press Apply to save the changes. Press OK to save the changes and close the configuration window.

The next time you run the server with this configuration, XRebel is run with it. If you defined the XRebel location successfully, you should see the XRebel banner in the server console immediately on startup.


NetBeans

This set of instructions assumes that you have already configured a server to be used in your IDE. In this example we have a Tomcat 8.0 server present in NetBeans.

  1. Open Tools > Servers.
  2. Select the desired server from the left hand menu. Open the Platform tab on the right. You will be presented with this view:
../_images/addparameter-netbeans.png
  1. Add the following line in the VM Options field:
-javaagent:[path/to/]xrebel.jar
  1. Press Close to save the changes and close the window.

The next time you run the server, XRebel is run with it.


JDeveloper

This set of instructions assumes that you have already configured a server to be used in your IDE. In this example we have an embedded WebLogic server configured in JDeveloper.

  1. Open Window > Application Servers.
  2. Select the desired server from Application Servers pane. Right-click it and select Properties.
  3. Access the Launch Settings tab.
../_images/addparameter-jdeveloper.png
  1. Add the following line in the Java Options field:
-javaagent:[path/to/]xrebel.jar
  1. Press OK to save the changes and close the window.

The next time you run this server, XRebel is run with it.


Adding the XRebel parameter without an IDE

When running your application server without an IDE, you need to define the XRebel JAR within your server’s startup script. This chapter provides XRebel running examples for servers that are supported.


GlassFish

  1. Access your GlassFish Administration Console.
  2. Open Configuration > JVM Settings > JVM Options.
  3. Press Add JVM Option and insert the following:
-javaagent:[path/to/]xrebel.jar
  1. Press Save and don’t forget to restart your server.

JBoss

JBoss on Windows

  1. Access your JBoss home folder.
  2. Open the bin folder.
  3. Create a new executable, for example run-xrebel.cmd.
  4. Add the following lines to this new executable:
@echo off
set JAVA_OPTS=-javaagent:[path/to/]xrebel.jar %JAVA_OPTS%
call "%~dp0\standalone.bat" %*

Note

Replace the link to the JBoss executable as necessary when using older JBoss versions.

  1. Run this executable instead of your standard JBoss executable.

JBoss on Mac OS and Linux

  1. Access your JBoss home folder.
  2. Open the bin folder.
  3. Create a new script, for example run-xrebel.sh.
  4. Add the following lines to this new executable:
#!/bin/bash
export JAVA_OPTS="-javaagent:[path/to/]xrebel.jar $JAVA_OPTS"
`dirname $0`/standalone.sh $@

Note

Replace the link to the JBoss executable as necessary when using older JBoss versions.

  1. Run this script instead of your standard JBoss executable.

JBoss Domain

  1. Access your JBoss Domain configuration folder JBOSS_HOME/domain/configuration.

  2. Open configuration.xml.

  3. Locate your desired server group.

  4. Add the following option to the configuration:

    <jvm-options>
      <option value="-javaagent:[path/to/]xrebel.jar"/>
    </jvm-options>
    
  5. Save configuration.xml and restart the server.


Jetty

Jetty on Windows

  1. Add the following to the command line:
-javaagent:[path/to/]xrebel.jar
  1. Run Jetty.

Jetty on Mac OS and Linux

  1. Access your Jetty home folder.
  2. Open the bin folder.
  3. Create a new script, for example jetty-xrebel.sh.
  4. Add the following lines to this new executable:
#!/bin/bash
export JAVA_OPTIONS="-javaagent:[path/to/]xrebel.jar $JAVA_OPTIONS"
`dirname $0`/jetty.sh $@
  1. Run this script instead of of your standard Jetty executable.

Resin

  1. Access your Resin home folder.
  2. Open the conf folder.
  3. Edit the resin.properties file. Locate jvm_args.
  4. Add the XRebel parameter:
jvm_args=-javaagent:[path/to]xrebel.jar
  1. Save and restart your application server.

Note

Alternatively, you can include the XRebel parameter in the resin.xml file. To do this, add the following within the <server> tags: <jvm-arg>-javaagent:[path/to]xrebel.jar</jvm-arg>

Warning

You only need to configure the JVM parameter once. Pick either the properties file or the xml file. Do not add the JVM parameter in both places.


Spring Boot

Add the XRebel parameter to Spring Boot startup:

java -javaagent:[path/to/]xrebel.jar -jar myapp-boot.jar

Spring Boot using Gradle

  1. Add the XRebel startup parameter to the build script:

    applicationDefaultJvmArgs = [ "-javaagent:[path/to]xrebel.jar" ]
    
  2. Start the application using gradle bootRun.

Tip

You can also specify the startup parameter using JAVA_OPTS when using Gradle.


Spring Boot using Maven

Add the following to the Maven run command:

mvn spring-boot:run -Drun.jvmArguments="-javaagent:[/path/to/]xrebel.jar"

Tomcat

Tomcat on Windows

  1. Access your Tomcat home folder.
  2. Open the bin folder.
  3. Create a new executable, for example catalina-xrebel.bat.
  4. Add the following lines to this new executable:
@echo off
set JAVA_OPTS=-javaagent:[path/to/]xrebel.jar %JAVA_OPTS%
call "%~dp0\catalina.bat" %*
  1. Run this executable instead of your standard Tomcat executable:
$ catalina-xrebel.bat run

Running Tomcat as a service? Open the tomcatXw.exe wrapper (double-click the Tomcat icon in your system tray). Insert the following line into the Java > Java Options text field:

-javaagent:[path/to/]xrebel.jar

Tomcat on Mac OS and Linux

  1. Access your Tomcat home folder.
  2. Open the bin folder.
  3. Create a new script, for example catalina-xrebel.sh.
  4. Add the following lines to this new executable:
#!/bin/bash
export JAVA_OPTS="-javaagent:[path/to/]xrebel.jar $JAVA_OPTS"
`dirname $0`/catalina.sh $@
  1. Run this script instead of your standard Tomcat executable.
./catalina-xrebel.sh run

WildFly

WildFly on Windows

  1. Access your WildFly home folder.
  2. Open the bin folder.
  3. Create a new executable, for example run-xrebel.cmd.
  4. Add the following lines to this new executable:
@echo off
set JAVA_OPTS=-javaagent:[path/to/]xrebel.jar %JAVA_OPTS%
call "%~dp0\standalone.bat" %*
  1. Run this executable instead of your standard JBoss executable.

WildFly on Mac OS and Linux

  1. Access your WildFly home folder.
  2. Open the bin folder.
  3. Create a new script, for example run-xrebel.sh.
  4. Add the following lines to this new executable:
#!/bin/bash
export JAVA_OPTS="-javaagent:[path/to/]xrebel.jar $JAVA_OPTS"
`dirname $0`/standalone.sh $@
  1. Run this script instead of your standard WildFly executable.

WebLogic

WebLogic on Windows

  1. Access your WebLogic home folder.
  2. Open the bin folder.
  3. Create a new executable, for example startWeblogic-xrebel.cmd.
  4. Add the following lines to this new executable:
@echo off
set JAVA_OPTIONS=-javaagent:[path/to/]xrebel.jar %JAVA_OPTIONS%
call "%~dp0\startWebLogic.cmd" %*
  1. Run this executable instead of your standard WebLogic executable.

WebLogic on Mac OS and Linux

  1. Access your WebLogic home folder.
  2. Open the bin folder.
  3. Create a new executable, for example startWeblogic-xrebel.sh.
  4. Add the following lines to this new executable:
#!/bin/bash
export JAVA_OPTIONS="-javaagent:[path/to/]xrebel.jar $JAVA_OPTIONS"
`dirname $0`/startWebLogic.sh $@
  1. Run this executable instead of your standard WebLogic executable.

WebSphere

Windows

  1. Start the IBM WebSphere server and open the administrative console.
  2. In the Admin Console open Servers > Application servers. Select the server your application is deployed to.
  3. Select Java and Process Management > Process Definition.
  4. Select Java Virtual Machine.
  5. Insert the following line into Generic JVM arguments for WebSphere:
-noverify -Xshareclasses:none -javaagent:[c:\path\to\]xrebel.jar
  1. Press OK. When asked, save the master configuration and restart the server.

Linux and Mac OS

  1. Start the IBM WebSphere server and open the administrative console.
  2. In the Administration Console open Servers > Application Servers. Select the server your application is deployed to.
  3. Select Java and Process Management > Process Definition.
  4. Select Java Virtual Machine.
  5. Insert the following line into Generic JVM arguments for WebSphere:
-noverify -Xshareclasses:none -javaagent:[/path/to/]xrebel.jar
  1. Press OK. When asked, save the master configuration and restart the server.

WebSphere Application Server Liberty Profile

To run XRebel, you need to specify the XRebel JVM argument in the JVM_ARGS environment variable before you launch the startup script:

  1. Run the JVM arguments setting command using the server command line:
  2. When using Mac OS or Linux:
export JVM_ARGS="-javaagent:[path/to]xrebel.jar"
  1. When using Windows:
set JVM_ARGS=-javaagent:[path/to]xrebel.jar
  1. Launch the server.

When you start your application server with this argument configured, XRebel is loaded at startup.