Skip to content

Installation

Jump to bottom
Alex Boyko edited this page Jul 17, 2023 · 110 revisions

This guides you through the various installation steps for the STS4 components on the different supported platforms (Eclipse, Visual Studio Code and Theia). All the variants require at least a JDK11+ to be installed on your system as a prerequisite.

The language server launcher will look for JVM to launch with. It looks in these places and uses the first java executable found:

  • the location configured via ${language-server-name}.ls.java.homesettings. Where ${language-server-name} is one of spring-boot, concourse, cloudfoundry-manifest or bosh. This setting is specific fora particular language server and only affects how that server launches.
  • the location in JAVA_HOME environment variable
  • a java executable in the PATH

It is possible to use the spring-boot and Java tooling with projects that require older JRE to compile and run since the JRE used for this purpose is independent of the JRE used to launch the language server itself. The best way to configure the JRE for the language server independently is to set ${language-server-name}.ls.java.home in vscode's user or workspace settings.

Spring Tool Suite 4 (the Eclipse-based distribution)

Spring Tools 4 ready-to-use distribution package

To download the full featured Spring Tool Suite 4 distribution that has everything pre-installed, please go to:

Note: For Windows, the download is a self-extracting JAR archive. Double click and it will expand itself on disc.

Install Spring Tools 4 into an existing Eclipse (via the Marketplace)

In order to install the Spring Tools 4 into an existing Eclipse install, you need the latest Eclipse release as a prerequisite (download the Eclipse IDE from here: https://www.eclipse.org/downloads/packages).

You can install Spring Tools 4 into your existing Eclipse installation using the Eclipse Marketplace. Search for "Spring Tools 4" and install:

Install Spring Tools 4 into an existing Eclipse (via a p2 repo)

You can also use a p2 repository to install individual components of Spring Tools 4 into an existing Eclipse installation. Choose Install New Software in Eclipse and use this p2 repository URL:

Select the main features you wish to install and proceed. The standard set of features is this:

For the reference, the feature IDs are:

  • org.springframework.boot.ide.main.feature
  • org.springframework.tooling.boot.ls.feature
  • org.springframework.tooling.cloudfoundry.manifest.ls.feature
  • org.springframework.tooling.bosh.ls.feature
  • org.springframework.tooling.concourse.ls.feature
  • org.springframework.ide.eclipse.boot.dash.feature
  • org.springframework.ide.eclipse.xml.namespaces.feature

In addition to those p2 repositories, we also provide an additional one:

This will provide you the latest Spring Tools 4 together with the latest Eclipse release and can be used to always stay on top of the latest Spring Tools 4 and the latest Eclipse version. Since it combines Spring Tools 4 and Eclipse release train repos, it is not recommended for manually installing Spring Tools 4.

Visual Studio Code

Download and install Visual Studio Code:

Install from the Visual Studio Marketplace:

More detailed instructions on installing extension from Visual Studio Marketplace can be found here

Theia

Download and install Theia for desktop:

Install from the Extensions view:

More detailed instructions on installing extension from Visual Studio Marketplace can be found here

Theia IDE can be deployed in a Cloud environment and served over the web. (See Instructions for Deployment in the Cloud) If Theia IDE is deployed and running somewhere then STS extensions can be installed into Theia with the Extension Manager. You can use the Extension Manager to install the STS 4 vscode extensions which you can get from our VSCode Extensions Downloads page. Note that in order for this to work your Theia instance must have both the:

  • the Extension Manager (package @theia/plugin-ext) and the
  • VSCode extension compatibility support (package @theia/plugin-ext-vscode) included.

Atom (deprecated since Spring Tools 4.3.0 release)

Download and Install latest Atom (any version >= 1.22)

Atom packages can be installed through Atom -> Preferences - on Settings window, select Install. Atom packages may prompt you to install missing prerequisite Atom packages (i.e. ide-ui and/or ide-java). It's recommended that you choose to install them.

Install the following from the Spring Team (spring-projects):

Clone this wiki locally