YouTrack Standalone 2021.1 Help

Migrate from InCloud to Standalone

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

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

  • You plan to retire your InCloud instance and work exclusively with the Standalone server or use the InCloud instance for another purpose.

  • You have already purchased a licence for YouTrack Standalone 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 Standalone license, you can use the value for the free version of YouTrack Standalone as shown here:

    FieldValue
    License User NameYouTrack Default
    License Key42bd2ce4dbaf8554bf082946a1c039d4384e81a99ed53fb75215c1b6ace8d34cf66889fdeee418cbe93d54f38f6e94a8a05a0108234b1955582d566283e3d084b23a0b8b52b016b0e610abcbbe7573fa3ff8fb3cdc9346dc94ef5f596f5b12719abcb02e6fae23d98f53f22a01788066aac7298b7fe79cc3dcd6f8df2fb41ab4

If you simply want to import issues from a YouTrack InCloud instance to an existing YouTrack Standalone server, see Import from YouTrack.

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

Export Your YouTrack InCloud Database

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

To export your YouTrack InCloud database:

  1. In YouTrack InCloud, open the Administration > 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 Standalone

The next step is to install YouTrack Standalone with the data from your YouTrack InCloud instance.

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

To migrate to YouTrack Standalone 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 InCloud instance in the previous procedure.

  4. Click the Next button.

    • The Confirm Settings page opens.

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

  5. Change the Base URL setting to the URL of your YouTrack Standalone server.

  6. Click the Upgrade button.

    • The configuration is applied to your YouTrack Standalone server.

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

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

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

  9. Click the Save button.

    • Your YouTrack server runs using the updated license.

    • The data from your YouTrack InCloud instance is available for use on your YouTrack Standalone server.

To migrate to YouTrack Standalone 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 InCloud instance to the data directory of your standalone installation.

    • Check the data directory of your standalone 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 Standalone from the command line. Use the following Java start parameters to configure the server:

    ParameterDescription
    jetbrains.youtrack.baseUrlSet the Base URL property to the base URL of your YouTrack Standalone server.
    jetbrains.youtrack.licenseNameSet the name of your YouTrack license to the name of your YouTrack Standalone license.
    jetbrains.youtrack.licenseKeySet the license key of the YouTrack license to your license key for YouTrack Standalone.

    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 InCloud instance is available for use on your YouTrack Standalone server.

  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 InCloud instances use email and Jabber services that are hosted by JetBrains to deliver notifications. After you migrate to a YouTrack Standalone 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 Standalone installation.

Last modified: 08 March 2021