YouTrack Standalone 7.0 Help

JAR Installation

The YouTrack JAR distribution is available for download on the JetBrains website.

YouTrack JAR is a cross-platform distribution. You can use this distribution to install and run YouTrack on Linux, OS X, and Windows.

The procedure for installing YouTrack with this distribution is similar for all operating systems.

To install YouTrack Standalone with a JAR distribution:

  1. Download the JAR distribution from the JetBrains website.
  2. Upload the JAR distribution to your server.
  3. Run the application from the command line.

Installation Options

A YouTrack JAR distribution can be set up in a variety of server environments. The following topics provide specific instructions for installing and running the JAR distribution different operating systems:

Run YouTrack JAR

Run YouTrack Standalone with the following command:

java -Xmx1g -XX:MaxMetaspaceSize=250m -Djava.awt.headless=true [JVM options] -jar youtrack-<version>.jar [host:]<port>[/contextPath] [config file path]

The command includes all of the options and variables that you want to pass to the application on startup. The following JVM options are mandatory and precede the command to run the JAR file:

JVM OptionDescription
-Xmx=1gSets the maximum Java heap size to 1GB.
-XX:MaxMetaspaceSize=250mSets the maximum Metaspace memory to 250MB. For Java 7, set the maximum Permanent Generation memory with -XX:MaxPermSize=250m.
-Djava.awt.headless=trueRuns Java in Headless Mode.

You can also set the java.awt.headless system property. For more information, refer to the Using Headless Mode in the Java SE Platform article on the official Java website.

Set values for the following variables in the command:

ParameterDescriptionRequirement
JVM optionsThe JVM options that are set when when the YouTrack instance is started.Optional
hostThe listen address of your YouTrack server. The default value is 0.0.0.0.Optional
portThe HTTP port number of your YouTrack server.Mandatory
contextPathThe context path of your YouTrack instance. The default context is root. The context path is a prefix on the path portion of a URL. This path routes requests to the proper webapp when more than one webapp is hosted on the same server. Optional
config file pathThe path to a Jetty configuration file for fine-tuning the deployment. Most installations do not need it.Optional

When you set the contextPath, you can run YouTrack with the context other than the default root path. Here are a few command examples with various URI configurations for different YouTrack servers:

java -Xmx1g -XX:MaxPermSize=250m -Djava.awt.headless=true -jar youtrack-6.0.12124.jar 8080 java -Xmx1g -XX:MaxPermSize=250m -Djava.awt.headless=true -jar youtrack-6.0.12124.jar 8080/youtrack java -Xmx1g -XX:MaxPermSize=250m -Djava.awt.headless=true -jar youtrack-6.0.12124.jar 127.0.0.1:8080 java -Xmx1g -XX:MaxPermSize=250m -Djava.awt.headless=true -jar youtrack-6.0.12124.jar 127.0.0.1:8080/youtrack

When you start YouTrack, the application opens in a browser. If you do not have a web browser installed on the host machine or don't want the browser to pop up, use the following JVM option: -Djetbrains.youtrack.disableBrowser=true

For a complete list of YouTrack-specific JVM options, see Configuration Parameters.

Once your YouTrack service is up and running, you may want to set up projects and access rights, import issues from another tracker, or fine-tune the server environment. For more information, check the topics in the See Also section below.

See Also

Last modified: 3 October 2016