Configuration Parameters
This page lists common parameters that are specific to YouTrack. Some system properties are defined when you install or upgrade YouTrack. Others are defined as options in the JVM and can only be updated as command-line parameters during startup or by updating values stored in the JVM options file for your YouTrack installation. To learn how to update these parameters, see Configure JVM Options.
A few parameters listed on this page are available through the user interface, usually from the Global Settings. The best way to update these system properties is to set the desired values in the user interface. Use the links listed for the Location to learn where you can update these settings in the YouTrack UI.
General Parameters
You can set the following parameters for any YouTrack installation.
Parameter | Description |
|---|---|
jetbrains.youtrack.admin.restore | Restores the password for the default admin user account to the default value
|
jetbrains.youtrack.support.email | Specifies the email address that is used as the
|
jetbrains.youtrack.disableCheckForUpdate | Enables and disables checking for software updates on startup. When set to
|
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 Setting this system property affects the performance of your YouTrack server. The lower the value, the slower the performance of your server.
|
jetbrains.youtrack.mailLimit | Sets a daily limit for the number of email messages that are sent with the
|
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.
|
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.
|
jetbrains.youtrack.webHooksBaseUrl | Sets an alternative base URL for your YouTrack server when sending requests to create webhooks in external services.
|
jetbrains.http.request.header.buffer.size | Maximum request buffer size. If you see the
|
jetbrains.http.response.header.buffer.size | Maximum response buffer size. If you see the
|
jetbrains.youtrack.licenseName | Sets the name of your YouTrack license to the name of your YouTrack Server license.
|
jetbrains.youtrack.licenseKey | Sets the license key of the YouTrack license to your license key for YouTrack Server.
|
jetbrains.youtrack.dumbMode | Lets you run the YouTrack service without connecting to other services inside your network. When This can be particularly helpful for staging environments where you want to test new functionality without disrupting users who are working with the live application.
|
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,
The default value is either of the following (where
This value is stored as a
|
secure-mode | The connection mode that is applied to the YouTrack server.
This property supports the following values:
|
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.
|
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
|
tls-redirect-from-http | When The default value is
|
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
|
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-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:
|
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.
|
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.
|
no-browser | Launches the application without opening a browser window on startup. Use this parameter to run the YouTrack service on a machine without launching unneeded applications or where browser software is not installed.
|
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.
|