YouTrack Server 2022.2 Help

Configuration Parameters

This page lists common parameters that are specific to YouTrack.

To learn how to apply these parameters when you start YouTrack, see Configure JVM Options.

General Parameters

You can set the following parameters for any YouTrack installation.

Parameter

Description

jetbrains.youtrack.admin.restore

Restores the password for the root user account to the default value root.

  • Data type: Boolean

  • Default value: false

jetbrains.youtrack.support.email

Specifies the email address that is used as the mailto address for the Contact support link on the error screen.

  • Data type: email address

  • Default value: youtrack-feedback@jetbrains.com

jetbrains.youtrack.disableCheckForUpdate

Enables and disables checking for software updates on startup. When set to true, checking for software updates is disabled.

  • Data type: Boolean

  • Default value: false

jetbrains.dnq.textIndex.minPrefixQueryLength

Sets the minimum length of a prefix query string to a set number of characters. If prefix queries and wildcard strings do not return all matching word forms in a search query, set this value to 2.

Setting this system property affects the performance of your YouTrack server. The lower the value, the slower the performance of your server.

  • Data type: integer

  • Default value: 3

jetbrains.youtrack.mailLimit

Sets a daily limit for the number of email messages that are sent with the issue.sendMail() method in workflows. When set to 0, there is no limit. The default value for YouTrack Cloud instances is 100.

  • Data type: integer

  • Default value: 0

jetbrains.youtrack.event.merge.timeout

Sets the amount of time YouTrack waits to compile changes that are applied to an issue as a digest before sending an email notification, in milliseconds.

Reducing this value increases the rate at which YouTrack analyzes notifications and can have a negative impact on general server performance. Increasing this value from the default (one minute) can reduce the overall number of notification emails that are sent by YouTrack.

  • Data type: long

  • Default value: 60000

jetbrains.youtrack.default.page

Sets the default start page for your YouTrack server. Enter a relative path to your base URL with a leading slash.

  • Data type: string

  • Default value: /dashboard

jetbrains.youtrack.webHooksBaseUrl

Sets an alternative base URL for your YouTrack server when sending requests to create webhooks in external services.

  • Data type: string

  • Default value: empty

jetbrains.http.request.header.buffer.size

Maximum request buffer size. If you see the URI is too large >102400 or Request header too large warnings/errors in YouTrack logs, increase the value for this parameter.

  • Data type: long

  • Default value: 102400

jetbrains.http.response.header.buffer.size

Maximum response buffer size. If you see the Response header too large warning/error in the YouTrack logs, increase the value for this parameter.

  • Data type: long

  • Default value: 102400

jetbrains.youtrack.licenseName

Sets the name of your YouTrack license to the name of your YouTrack Server license.

  • Data type: string

  • Default value: empty

jetbrains.youtrack.licenseKey

Set the license key of the YouTrack license to your license key for YouTrack Server.

  • Data type: string

  • Default value: empty

Environmental Parameters

The following parameters are used to manage how YouTrack runs in your server environment.

Property

Description

base-url

The URL that end users request to access your YouTrack installation. For example, https://youtrack.mydomain.com.

  • When the value for the secure-mode property is tls or your YouTrack installation is secured behind an SSL-terminating reverse proxy server, the URL should begin with https.

  • Otherwise (when running YouTrack using plain HTTP), the URL begins with http.

The default value is either of the following (where hostname is the name of the server where YouTrack is installed):

  • "http://" + hostname + ":" + listen-port + "/"

  • "http://" + hostname + "/" (in case when listen-port is equal to 80)

This value is stored as a string data type.

secure-mode

The connection mode that is applied to the YouTrack server. This property supports the following values:

  • disable — TLS is disabled. This is the default value for this property.

  • tls — TLS is enabled.

listen-address

Sets the net interface address for your YouTrack installation. It might be changed if YouTrack should be configured to listen on some particular net interface.

  • Data type: string

  • Default value: 0.0.0.0

listen-port

Designates the port on which YouTrack listens for HTTP traffic. This port might be changed from one configuration phase to another. By default, port 80 is tried to be used on Windows and 8080 on other platforms.

If port 80 is occupied by another process or is not allowed on your server, YouTrack will automatically start listening on port 8080 and any subsequent available port.

This value is stored as an int data type.

tls-redirect-from-http

When true lets you use an additional port (defined by the tls-redirect-from-http-listen-port property) to accept unencrypted HTTP traffic and redirect it to a secure port defined by the property listen-port.

The default value is false.

tls-redirect-from-http-listen-port

Specifies an additional port to accept unencrypted HTTP traffic and redirect it to a secure port defined by the listen-port property. To enable this port, set the value for the tls-redirect-from-http property to true).

tls-server-cert-folder

An (optional) absolute path to resolve relative paths defined by other command line parameters, when present. Relative paths to server certificate files that are specified in other properties are resolved against this directory. The properties that can reference relative paths are:

  • tls-server-cert-key-file

  • tls-server-cert-file

  • tls-server-cert-chain-file

  • tls-server-cert-keystore-file

tls-server-cert-keystore-file

The location of a keystore file in either JKS or PKCS #12 format.

tls-server-cert-keystore-password

Keystore integrity password

tls-server-cert-keystore-key-alias

The alias of the entry in the keystore that contains the server certificate and the private key. If your keystore uses the PKCS #12 format, follow these guidelines:

  • Use the value that is stored as the friendlyName in the keystore.

  • If the private key and certificate pair was not marked with a friendlyName during generation, use this parameter to provide the sequential number of this pair in the keystore. For a keystore that only contains one certificate and private key pair, set the value to 1.

tls-server-cert-keystore-key-password

Password that protects your server's private key entry in the keystore.

tls-server-cert-key-file

The location of a private key (PKCS #1 or PKCS #8) file, stored in PEM format.

tls-server-cert-file

The location of a certificate file, stored in PEM format.

tls-server-cert-chain-file

The (optional) location of a file that contains the certificate chain, stored in PEM format.

tls-server-cert-private-key-passphrase

If you use an encrypted private key, then use this property to provide the passphrase that was used for encryption. Supported for both PKCS #1 and PKCS #8 formats.

data-dir

Sets the directory where YouTrack stores application data.

temp-dir

Sets the directory where YouTrack stores temporary files.

logs-dir

Sets the directory where YouTrack stores application logs.

backups-dir

Sets the directory where YouTrack stores time-specific copies of the database in backup folders.

  • Data type: string

  • Default value: <youtrack_home>\backups

hub-url

Stores the web address of an external Hub service, when used.

statistics-upload

Determines whether YouTrack is allowed to collect and share anonymous usage statistics with JetBrains.

This property is normally set by the administrator in the web-based Configuration Wizard during installation.

  • Data type: Boolean

  • Default value: false

Authentication Throttling Parameters

The following parameters let you enable or disable throttling in YouTrack.

Parameter

Description

jetbrains.hub.auth.login.throttling.enabled

Sets the status of the throttling feature for the Hub authentication module. When true, authentication throttling is enabled.

  • Data type: Boolean

  • Default value: false

Last modified: 10 August 2022