Liferay Dev Studio is a plugin for Eclipse that brings many Liferay-specific features to the table. You can install it into your existing Eclipse environment, or Liferay provides a bundled version included in its Project SDK. Here you’ll learn the different methods available for installing Dev Studio:
- install the Dev Studio bundle from scratch
- install Dev Studio into an existing Eclipse instance using an update URL
- install Dev Studio into an existing Eclipse instance using a ZIP file
Important: If you’re installing Dev Studio into an existing Eclipse environment, you must be on Eclipse Photon or newer. For instructions on upgrading to Photon, see Eclipse’s upgrade documentation. With this particular upgrade, you should also deactivate the current available update sites in the Window → Preferences → Install/Update → Available Software Sites menu to ensure a successful upgrade (e.g., Oxygen).
Download and install Java. Liferay runs on Java, so you’ll need it to run everything else. Because you’ll be developing apps for Liferay DXP in Dev Studio, the Java Development Kit (JDK) is required. It is an enhanced version of the Java Environment used for developing new Java technology. You can download the Java SE JDK from the Java Downloads page.
Download Liferay’s latest Project SDK with Dev Studio. Go to the Downloads page in Liferay’s Help Center. Select Developer Tools in the Product drop-down and Developer Studio for the file type. Then select the executable that correlates to your operating system.
Run the Project SDK executable and step through the installer to install everything to your machine. For help with setting up proxy settings (if necessary), see the Dev Studio Proxy Settings and Liferay Workspace Proxy Settings articles for more information.
Congratulations! You’ve installed Liferay Dev Studio! It’s now available in the
Project SDK folder’s
liferay-developer-studio. To run Dev Studio, execute the
DeveloperStudio executable. A Liferay Workspace has also been initialized in
that same folder.
If you already have an Eclipse environment that you’re using for other things, it’s easy to add Dev Studio to your existing Eclipse installation.
In Eclipse, select Help → Install New Software.
In the Work with field, copy in the following URL: https://releases.liferay.com/tools/ide/latest/stable/
You’ll see the Liferay Dev Studio components in the list below. Check them off and click Next.
Accept the terms of the agreements and click Next, and Dev Studio is installed. Like other Eclipse plugins you’ll have to restart Eclipse to enable it.
To install Liferay Dev Studio into Eclipse from a Zip file, follow these steps:
Go to the Dev Studio downloads page. Under Other Downloads, select the Liferay IDE [version] Archived Update-site option to download it.
In Eclipse, go to Help → Install New Software….
In the Add dialog, click the Archive button and browse to the location of the downloaded Dev Studio Zip file.
You’ll see the Dev Studio components in the list below. Check them off and click Next.
Accept the terms of the agreements and click Next, and Liferay Dev Studio is installed. Like other Eclipse plugins you’ll have to restart Eclipse to enable it.
Awesome! You’ve installed Liferay Dev Studio. Now you can begin Liferay development using a popular and supported IDE.