User Guide: Connect to Toolbox Enterprise

Last modified: 16 April 2024

Developers can follow these instructions to establish a connection to the Toolbox Enterprise Server and effectively utilize the Toolbox Enterprise Plugin.

Install the Toolbox App

Before connecting to the company's Toolbox Enterprise Server, it is necessary to download and install the Toolbox App from the JetBrains website.

note

The minimum required Toolbox App version is 2.1.

  1. Download the installer .exe from the Toolbox App web page.

  2. Run the installer and follow the wizard steps.

Join your organization

  1. Follow the link shared by your administrator to connect to the company's Toolbox Enterprise Server.

    Clicking the link redirects you to the Toolbox App. You will see the confirmation dialog explicitly suggesting joining the organization.

    Join the organization

  2. Click Log in and provide the credentials of the OAuth2 provider used within your organization to connect to the Toolbox Enterprise Server.

Join using the configuration file

  1. Ensure that the configuration file provided by your administrator is placed in a dedicated system location on your machine:

    • %PROGRAMDATA%\JetBrains\Toolbox\enterprise-config.json (Windows)

    • /Library/Application Support/JetBrains/Toolbox/enterprise-config.json (macOS)

    • /usr/share/jetbrains-toolbox/enterprise-config.json (Linux)

  2. Launch the Toolbox App and log in with the credentials of the OAuth2 provider used within your organization.

After joining, you will see a label stating that your Toolbox App is managed by your organization.

Toolbox App managed by your organization

While using the IDE, you will see an indicator with a logo and message stating that the current IDE is managed by your organization. This feature helps you distinguish between corporate tools and your personal ones more easily.

The IDE managed by Toolbox Enterprise

tip

Clicking the organization logo opens the Toolbox Enterprise page in the IDE settings.

Explore propagated configurations

Toolbox Enterprise delivers pre-configured settings, plugins, and VM options directly to your workspace. You can explore the list of propagated configurations in your IDE's settings: Settings | Tools | YOUR_ORGANIZATION Settings.

Here you can find the information about the Toolbox Enterprise Server instance, to which your Toolbox App is connected, and the list of configurations propagated by Toolbox Enterprise.

The Configuration tab

On the Internal Plugins page, you will find plugins distributed by Toolbox Enterprise from the local plugin repository of your organization. This functionality is designed for testing specific plugin versions.

You can choose the appropriate channels and upgrade or downgrade the desired plugin according to its available versions on the Toolbox Enterprise Server.

the Plugins tab