YouTrack Server 2022.2 Help

Migrate from Cloud to Server

This page provides instructions for migrating from a YouTrack Cloud instance that is hosted by JetBrains to a self-hosted YouTrack Server installation. When you perform this type of migration, we assume that:

  • Your YouTrack Server installation is either empty or can be overwritten.

  • You plan to retire your YouTrack Cloud instance and work exclusively with the Server installation or use the YouTrack Cloud instance for another purpose.

  • You have already purchased a licence for YouTrack Server that meets or exceeds the number of active users in your hosted instance. You need to enter the License User Name and License Key during the migration, so keep these values handy.

    If you currently use the free plan and are not migrating to a commercial Server license, you can use the value for the free version of YouTrack Server as shown here:

    Field

    Value

    License User Name

    YouTrack Default

    License Key

    42bd2ce4dbaf8554bf082946a1c039d4384e81a99ed53fb75215c1b6ace8d34cf66889fdeee418cbe93d54f38f6e94a8a05a0108234b1955582d566283e3d084b23a0b8b52b016b0e610abcbbe7573fa3ff8fb3cdc9346dc94ef5f596f5b12719abcb02e6fae23d98f53f22a01788066aac7298b7fe79cc3dcd6f8df2fb41ab4

If you simply want to import issues from a YouTrack Cloud instance to an existing YouTrack Server installation, see Import from YouTrack.

Many administrators install and test YouTrack Server before they migrate data from an YouTrack Cloud instance and make it available to other users. In this case, the installation only contains test data that can be deleted. If you set up a YouTrack Server installation for testing purposes, we recommend that you uninstall the test installation and migrate the data from your YouTrack Cloud instance to a clean installation of YouTrack Server.

Export Your YouTrack Cloud Database

The first step is to export a backup copy of your YouTrack Cloud database.

To export your YouTrack Cloud database:

  1. In YouTrack Cloud, open the Administration > Server Settings > Database Export page.

  2. Click the Update export file button.

  3. When the export file has finished updating, click the Download link.

    • The backup file is saved to your local directory.

Install YouTrack Server

The next step is to install YouTrack Server with the data from your YouTrack Cloud instance.

Note that the backup of your YouTrack Cloud database contains the base URL and license for your YouTrack Cloud instance. Follow the instructions in this guide to update these properties and properly configure your YouTrack Server installation.

To migrate to YouTrack Server with an MSI or ZIP distribution:

  1. Download and install the MSI or ZIP distribution. Follow the standard installation guide up to the step where the web-based Configuration Wizard opens in your default browser.

  2. In the Configuration Wizard, click Upgrade.

  3. On the Select Upgrade Source page, select the database backup that you exported from your YouTrack Cloud instance in the previous procedure.

  4. Click the Next button.

    • The Confirm Settings page opens.

    • The Base URL displays the URL of your YouTrack Cloud instance.

  5. Change the Base URL setting to the URL of your YouTrack Server installation.

  6. Click the Upgrade button.

    • The configuration is applied to your YouTrack Server installation.

    • The YouTrack service starts using the license that is associated with your YouTrack Cloud instance. You are notified that the license can only be used for YouTrack Cloud.

  7. Click the link to access the Global Settings page.

  8. Enter the License User Name and License Key for YouTrack Server.

  9. Click the Save button.

    • Your YouTrack server runs using the updated license.

    • The data from your YouTrack Cloud instance is available for use on your YouTrack Server installation.

To migrate to YouTrack Server with a JAR distribution:

  1. Download the JAR distribution and upload it to your server.

  2. Before you run the YouTrack service, extract the data from your YouTrack Cloud instance to the data directory of your self-hosted installation.

    • Check the data directory of your self-hosted installation and verify that it is empty. The default location of the database is in the teamsysdata folder in the home directory of the user account that runs YouTrack. If there are any files or folders in this directory, delete them.

    • Extract the contents of the database backup file to your data directory. After extraction, the data directory contains two folders: hub and youtrack.

  3. Run YouTrack Server from the command line. Use the following Java start parameters to configure the server:

    Parameter

    Description

    jetbrains.youtrack.baseUrl

    Set the Base URL property to the base URL of your YouTrack Server installation.

    jetbrains.youtrack.licenseName

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

    jetbrains.youtrack.licenseKey

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

    For example:

    java -Xmx1g -XX:MaxMetaspaceSize=250m -Djava.awt.headless=true -Djetbrains.youtrack.baseUrl="http://www.mystandaloneserver.com:[port] -Djetbrains.youtrack.licenseName="YouTrack Free Pack User" -Djetbrains.youtrack.licenseKey="fa210d1d87408e18c6cfb9e09991aa5f9781410fcf660e47a366fcf83d5d25085e4b41e7ffd54256424e32a3aac1d5ec7464d98421b1a3068c8642279d0e0d85cb2e569b0f20fc5174331e40fe2e09f4291d14d8058015a71ef2ab64c2847fc82f71e0038b4ebd53b7e0e4d6ec7348fe0a0598d8b78f253914aa4959a59eb997" -jar youtrack-<version>.jar [host:]<port>[/contextPath] [config file path]
    • Your YouTrack server runs using the updated base URL and license.

    • The data from your YouTrack Cloud instance is available for use on your YouTrack Server installation.

  4. Once you have verified that everything works as expected, remove the custom start parameters from the command that you use to start the server.

Migrate Notification Services

By default, YouTrack Cloud instances use email and Jabber services that are hosted by JetBrains to deliver notifications. After you migrate to a YouTrack Server installation, these services are no longer available. If you're not already using your own notification services, you need to set them up and connect them to your YouTrack Server installation.

Migrate Mailbox Integration

If you used mailbox integration with a default mailbox configuration in your YouTrack Cloud instance, it would stop functioning after the migration. The default mailbox configuration is only available for the cloud YouTrack instances.

To migrate the mailbox integration from YouTrack Cloud to YouTrack Server, choose one of the two options:

Option

Result

Delete the mailbox configuration

The default mailbox configuration migrated from the YouTrack Cloud is removed along with the mailbox rules.

The issues, comments, attachments, and users created from emails remain in YouTrack. However, the references to the original emails are lost. This means that if you add a new mailbox integration, connect it to the same mailbox and try to process the same emails again, it will create duplicate entities in YouTrack.

Reconfigure the mailbox connection settings to match the new environment

The mailbox rules do not require any updates, so you can simply use the same rules with the new mailbox.

Even though the default cloud mailbox is no longer accessible, you can use the same setup with a changed support email. In this case, the threads in the mailbox and in comments will not be interrupted and just continue with the new support address.

Last modified: 14 July 2022