Hub 1.0 Help

Providing Hub Configuration Parameters

Using configure Command

This section describes the recommended method of changing the Java Start Parameters of your Hub server. Described method can be applied to both MSI and ZIP installations.

NOTE: Make sure to execute configure command on behalf of the same OS user that runs Hub service itself. This command creates configuration files and folders; Hub service user should have enough file system permissions to access them afterwards.

See Configuration Parameters page for the complete list of Hub specific Java start parameters.

To provide Java Start Parameters of your Hub service, use the configure command with -J prefix.

The -J prefix signifies that a JVM option is declared after it. Please note that you have to use -J prefix for each JVM option you need to define.

Use "-" to define a JVM option that should be passed to Hub JVM on startup:

bin/hub configure -J-<jvm.property>[=<value>]

For example:

bin/hub configure -J-Dorg.eclipse.jetty.server.Request.maxFormKeys=10000 bin/hub configure -J-Xmx1024m -J-XX:+HeapDumpOnOutOfMemoryError

To remove a JVM option, use "+":

bin/hub configure -J+<jvm.property>[=<value>]

Constructions +option=<value>, +XX:<option>=<value> and +D<property>=<value> remove the corresponding option only if it has exactly the same value, while +option, +XX:<option> and +D<property> remove it regardless of the value.

For example:

bin/hub configure -J+Dorg.eclipse.jetty.server.Request.maxFormKeys=10000 bin/hub configure -J+ea

Customizing Java Start Parameters Manually

Command configure described above allows to automate providing JVM options. However you can customize JVM start parameters manually as well by editing configuration files. To do so, please proceed as follows:

  1. Stop the currently running server.
  2. Navigate to Hub's conf directory:

    • For ZIP distribution it is located in <Hub Installation Directory>/conf
    • For MSI distribution it is located in%programdata%\JetBrains\Hub\conf.

  3. In the 'conf' directory, two sample configuration files are located:

    • hub.jvmoptions.dist — Java Start parameters for Hub server. This is the file to provide your custom Java Start Parameters.

    • hub.launch.jvmoptions.dist — a file to customize properties for the Hub launcher process. Copy the hub.launch.jvmoptions.dist file to hub.launch.jvmoptions and edit it. The format is described in the file itself.
  4. When done, start Hub server.

Changing the Database Location for MSI and ZIP Distributions

To change the database location, please proceed as follows:

  1. Stop currently running Hub server.
  2. Run the configure command:

    <Hub Installation Directory>bin/hub configure --data-dir=<Hub Database Directory Location>

    The directory where Hub DB is located normally includes two sub-folders hub and dashboard containing databases of Hub and Dashboard services, respectively. Also, it may include internal sub-folder containing other internal product data.

    Structure of the Hub database directory
  3. Start Hub server.
Last modified: 19 April 2016