Toolbox Enterprise installation

Toolbox Enterprise is a comprehensive solution available under a proprietary agreement (EULA). It consists of three main components: the Toolbox Enterprise Server, the Toolbox App, and the Toolbox Enterprise Plugin for IntelliJ-based IDEs.

Each of these components has its separate installation method and requirements.

Toolbox Enterprise Server

The Toolbox Enterprise Server is the core component of Toolbox Enterprise that is installed within your company's infrastructure. It is distributed as a Docker image from the registry:

registry.jetbrains.team/p/toolbox-enterprise/public/tbe-server:2024.1.569

You can use the means of Docker, Docker Compose, or Kubernetes to start the Toolbox Enterprise Server.

For production use, it is recommended to deploy the server in a highly-available and fault-tolerant setup. For proper functioning, the Toolbox Enterprise Server requires the following infrastructure:

Postgres SQL database 13+
Object Storage (an S3-compatible bucket or Azure Blob Storage)
External OAuth2 authentication service (Google, Okta, or similar)

Start Toolbox Enterprise Server in a Docker container

Make sure that you have all parts of the required infrastructure up and running.
Configure the application.yaml file. Provide values for the parameters of the server.ssl group or ensure that your server is capable of upgrading the network traffic to HTTPS.
Run the following command to start the Docker container:
docker run -it \ -v `pwd`/application.yaml:/config/application.yaml \ -e SPRING_CONFIG_ADDITIONAL-LOCATION=/config/application.yaml \ -p 80:8080 \ registry.jetbrains.team/p/toolbox-enterprise/public/tbe-server:2024.1.569
docker run -it \ -v `pwd`/application.yaml:/config/application.yaml \ -e SPRING_CONFIG_ADDITIONAL-LOCATION=/config/application.yaml \ -p 80:8080 \ registry.jetbrains.team/p/toolbox-enterprise/public/tbe-server:2024.1.569
docker run -it ^ -v `pwd`/application.yaml:/config/application.yaml ^ -e SPRING_CONFIG_ADDITIONAL-LOCATION=/config/application.yaml ^ -p 80:8080 ^ registry.jetbrains.team/p/toolbox-enterprise/public/tbe-server:2024.1.569
The Toolbox Enterprise Server starts in a Docker container. Open the https://<server_domain> or, in case of local deployment, https://localhost:8080 in your browser to log in to the Toolbox Enterprise Web UI.

Upgrade Toolbox Enterprise Server

In order to upgrade the Toolbox Enterprise Server, you need to pull and start the newer version of the Toolbox Enterprise Docker image.

Since the Toolbox Enterprise Server uses the object storage and PostgreSQL database, it is recommended to back them up before proceeding with the upgrade. This precautionary measure ensures that your data remains safe in case of any unforeseen issues during the upgrade process.

Toolbox App

The Toolbox App is an application that is installed on developer machines and used for downloading, updating, and configuring IntelliJ-based IDEs. The Toolbox App serves as an agent to deliver IDEs and configurations to developer machines and is vital for proper Toolbox Enterprise functioning.

The application is provided as an installer for Windows, macOS, Linux. It’s required to use version 2.2.1 or newer. For more information, see the Toolbox App and EULA agreement.

Toolbox Enterprise Plugin for IntelliJ-based IDEs

The Toolbox Enterprise Plugin for IntelliJ-based IDEs facilitates the implementation of Toolbox Enterprise features, such as collecting usage statistics and reporting UI freezes and exceptions to the Toolbox Enterprise Server.

Available on JetBrains Marketplace, the Toolbox Enterprise Plugin seamlessly integrates with IntelliJ-based IDEs and is installed automatically.

Last modified: 16 April 2024