Hub 2017.4 Help

Upgrade with a ZIP Distribution

You can use the ZIP distribution to upgrade an existing Hub installation that was installed with a ZIP or an MSI distribution.

Prerequisites

Before you upgrade, create a backup of your current database. Hub does not provide forward database compatibility. Your database is migrated to the format that is compatible with the latest version during the upgrade procedure. This means that you cannot revert to a previous version and continue to use the database that was processed during the upgrade.

Copy the backup of your current database to a secure location just in case you encounter problems with the upgrade and need to roll back to the previous version.

Upgrade a ZIP or MSI Installation

Whether your Hub service was previously installed using a ZIP or an MSI distribution, you can use the ZIP distribution to upgrade to the latest version of Hub.

To upgrade an existing Hub installation:

  1. Download the ZIP distribution from the JetBrains website.
  2. Stop the Hub service. For specific instructions, see Stop and Start the Hub Service.
  3. Use your operating system tools to verify that all Java processes that are launched by Hub are no longer running. If there are Hub-related Java processes that are still running, kill the outstanding process trees.
  4. Clear out your <hub_home> directory.
    • For a ZIP installation, the <hub_home> directory is the location where the ZIP distribution was unpacked during installation.
    • For an MSI installation, the <hub_home> directory is %\programdata%\\JetBrains\Hub.

    Do not extract the ZIP installation file to a directory that contains old files.

    We recommend that you perform the following steps:

    • Rename the existing <hub_home> directory to Hub_old (you can use another name).
    • Create a new <hub_home> directory in the same location as the previous installation.

    If you are upgrading an MSI installation, confirm that you have access to the <hub_home> directory and the location that you want to use as the upgrade source.

  5. Extract the contents of the ZIP archive to the empty <hub_home> directory.
  6. In a command-line interface, enter the following command to start Hub:
    <hub_home>/bin/hub.sh run

    If you do not have a web browser installed on the host machine, enter ./hub.sh run --no-browser.

  7. Continue with the upgrade installation in the web-based Configuration Wizard.
    • If you have a browser installed on the host machine, the Configuration Wizard opens automatically.
    • If you do not have a web browser installed on the host machine, open the URL of the wizard in a web browser on another workstation. The wizard URL is printed in the console output:
      JetBrains Hub <version> will be available on [<Hub Base URL>/bundle/starting] after start
  8. In the Configuration Wizard, click Upgrade.
    hub config wizard start
  9. On the Select Upgrade Source page, click the Select button and select an upgrade source.
    hub zip upgrade select source

    You can select the location of a backup or the location of an existing Hub installation.

  10. When done, click Next.
  11. On the Confirm Settings page, confirm or change your system settings and the location of system directories.
    hub zip upgrade confirm
  12. When done, click Upgrade.
    • Hub launches its components.

      Do not close the page in the browser until the setup is complete. When the Hub server is ready, you are redirected to the login page.

  13. Enter the credentials for the Hub administrator account and click the Log in button.
    • Hub opens to the Users page.

    Your Hub installation is upgraded and ready to use.

Upgrade from a Docker Image to a ZIP Distribution

You can upgrade an existing installation that was run in a docker container and change the installation type to ZIP at the same time.

To upgrade from a docker image to the ZIP distribution:

  1. Create a backup of the Hub database while your existing Hub installation is running.
  2. Download the ZIP distribution from the JetBrains website.
  3. Stop the Hub docker container.
  4. Extract the contents of the ZIP archive to the empty <hub_home> directory.
  5. In a command-line interface, enter the following command to start Hub:
    <hub_home>/bin/hub.sh run

    If you do not have a web browser installed on the host machine, enter ./hub.sh run --no-browser.

  6. Continue with the upgrade installation in the web-based Configuration Wizard.
    • If you have a browser installed on the host machine, the Configuration Wizard opens automatically.
    • If you do not have a web browser installed on the host machine, open the URL of the wizard in a web browser on another workstation. The wizard URL is printed in the console output:
      JetBrains Hub <version> will be available on [<Hub Base URL>/bundle/starting] after start
  7. In the Configuration Wizard, click Upgrade.
    hub config wizard start
  8. On the Select Upgrade Source page, click the Select button and select the created backup file as the upgrade source.
    hub zip upgrade select source
    When done, click Next.
  9. On the Confirm Settings page, confirm or your system settings and the location of system directories.
    hub zip upgrade confirm
  10. When done, click Upgrade.
    • Hub launches its components.

      Do not close the page in the browser until the setup is complete. When the Hub server is ready, you are redirected to the login page.

  11. Enter the credentials for the Hub administrator account and click the Log in button.
    • Hub opens to the Users page.

    Your Hub installation is upgraded and ready to use.

Last modified: 7 December 2017

See Also