Toolbox Enterprise installation
For production use, start the Docker image: registry.jetbrains.team/p/toolbox-enterprise/public/tbe-server:2024.1.569.
For evaluation, try the Toolbox Enterprise Demo.
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.
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.569You 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)
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.sslgroup or ensure that your server is capable of upgrading the network traffic to HTTPS.Run the following command to start the Docker container:
LinuxmacOSWindowsdocker 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.569docker 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.569docker 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.569The Toolbox Enterprise Server starts in a Docker container. Open the
https://<server_domain>or, in case of local deployment,https://localhost:8080in your browser to log in to the Toolbox Enterprise Web UI.
note
Please note that the Docker image may include additional software subject to separate licenses. Dockerfiles to build Toolbox Enterprise images are available in the official GitHub repository.
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.
tip
Limitations
Toolbox Enterprise Server does not support running multiple versions of the same component concurrently.
A newer Toolbox Enterprise Server version may introduce changes to the database schema, rendering rollback impossible.
You need to terminate all running server instances before starting new versions.
It is not possible to start earlier Toolbox Enterprise Server versions together with a database that was used with a later version. Always keep a backup copy of the database to expedite the recovery process if necessary.
Currently, the side-by-side upgrade is not supported. Please contact us if you encounter such a need.
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.
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.