Hub 2017.3 Help

Configure System Properties

System properties in Hub are the basic settings for your Hub server. Many system properties are defined when you install or upgrade Hub. Others are defined in the user interface, for example, on the System Settings page.

The best way to manage the following system properties for your Hub server is to set the desired values in the user interface. Use the links in the Location column to learn where you can update these settings in Hub.

General Properties

jetbrains.hub.locale Sets the language displayed in the Hub user interface. Specify the language in IETF BCP 47 format (en-US, de-DE, es-ES, fr-FR, ru-RU).stringSystem Settings
jetbrains.hub.motto.disabled Disables the Hub Motto on the user interface. Default value: falseBooleanSystem Settings
jetbrains.hub.smtp.enable Enables or disables email notifications. Default value: falseBooleanSystem Settings Sets the SMTP host address.stringSystem Settings
jetbrains.hub.smtp.port Sets the SMTP connection port.integerSystem Settings
jetbrains.hub.smtp.protocol Sets the protocol that is used to send email notifications. Supports the following values: SMTP / SMTP+SSL / SMTP+TLSstringSystem Settings
jetbrains.hub.smtp.from Sets the email address that is used as the "From:" field in email notifications.stringSystem Settings
jetbrains.hub.smtp.login Sets the login for the account that is used for authentication by the SMTP server.stringSystem Settings
jetbrains.hub.smtp.password Sets the password for the account that is used for authentication by the SMTP server.stringSystem Settings
jetbrains.hub.jabber.enable Enables or disables notifications over Jabber. Default value: falseBooleanSystem Settings
jetbrains.hub.jabber.server Sets the address of the Jabber service.stringSystem Settings
jetbrains.hub.jabber.port Sets the connection port for the Jabber service.integerSystem Settings Sets the name of the Jabber service.stringSystem Settings
jetbrains.hub.jabber.sasl.enable Enables or disables SASL authentication for the Jabber service. Default value: falseBooleanSystem Settings
jetbrains.hub.jabber.login Sets the login for the account that is used for authentication by the Jabber service.stringSystem Settings
jetbrains.hub.jabber.password Sets the password for the account that is used for authentication by the Jabber service.stringSystem Settings Sets the name for the Hub service license.stringLicenses
jetbrains.hub.license.key Sets the license key for the Hub service license.stringLicenses
jetbrains.hub.database.backup.location Sets the directory where Hub stores database backup files.stringBackup

Authentication Throttling Parameters

The following JVM options let you configure how rate limits are applied to failed authentication requests. To protect the security of your application, the default values for these settings are undisclosed.

Use JVM options to update the values for these parameters when you start the Hub service. For instructions, see Configure JVM Options.

ParameterData TypeDescription
jetbrains.hub.auth.login.throttling.enabledBooleanSets the status of the throttling feature for the Hub authentication module. When true, authentication throttling is enabled.
jetbrains.hub.auth.login.throttling.sizeintegerSets the maximum number of IP addresses that are tracked for rate limiting.
jetbrains.hub.auth.login.throttling.failuresintegerSets the maximum number of consecutive failed requests that are allowed before rate limitations are applied to incoming requests from the tracked IP address.
jetbrains.hub.auth.login.throttling.cooldown-valueintegerSets the number of entries that are removed from the counter for each IP address at the interval that is specified for the cooldown period.
jetbrains.hub.auth.login.throttling.cooldown-period-secintegerSets the interval at which entries are removed from the counter for each IP address, in seconds.
jetbrains.hub.auth.login.throttling.white-listcomma-delimited stringDefines the list of IP addresses that are not tracked for failed login requests.

Configure System Properties from the Command Line

Hub stores system properties in and JVM options in an internal configuration file. Every time you start the Hub service, Hub reads this file and applies this configuration to the Hub database.

The one-way synchronization from the configuration file to the database can lead to problems if you're not careful. System properties that are set in the Hub user interface are applied directly to the Hub database. If you change a setting in the user interface that has been updated in the configuration file, the setting in the configuration file is applied to the database on restart, overwriting the setting in the UI.

To avoid conflicts, we recommend that you update and manage these settings in the user interface. This ensures that you don't have synchronization issues with the configuration file.

You can update a system parameter in a command-line interface. In this case, you pass the system property to Hub as an ad hoc parameter with the start command. This method updates the settings in the database without applying changes to the configuration file. Your database remains in sync with the settings in the user interface.

These commands are available for both MSI and ZIP installations. To execute these commands in an MSI distribution, open the Command Prompt window as an administrator.

To pass a system property as an ad hoc parameter:

  1. Stop the Hub service.
  2. In a command-line interface, change the directory to <hub_home>/bin.
    • For a ZIP installation, the <hub_home>/bin directory is the location where the ZIP distribution was unpacked during installation.
    • For an MSI installation, the <hub_home>/bin directory is the location where the MSI distribution was installed. The default installation directory is C:\Hub
  3. Enter the startcommand, followed by all of the system properties that you want to pass to the Hub database on start.
    • Use the --J prefix to pass the settings as ad hoc parameters.
    • Set the system properties in the format -Dproperty=value. Do not add any spaces between the prefix and the system property.
    For example: start --J-Djetbrains.hub.smtp.port=110
    • The Hub service starts using the specified settings.
    • The system property is stored in the Hub database.
    • The hub.jvmoptions file is not modified.
Last modified: 20 November 2017