Using Remote Liferay Servers

  1. Using Remote Liferay Servers
    1. Requirements
    2. Introduction
    3. Server Manager Plugin Setup
    4. Remote Liferay Server Adapter Setup
    5. Deploy project to Remote Server
    6. Modify Remote Server Settings

Requirements

Introduction

A Remote Liferay server is a special server adapter that works with a remote Liferay server instead of a local Liferay server bundle. To use the Remote Server adapter, the Server Manager plugin must be installed into the remote server instance. The remote Liferay server must be running the Tomcat, JBoss or Glassfish server bundles. The Omni username/password will be used for connecting to the remote server from withing the Liferay IDE/Eclipse environment.

Server Manager Plugin Setup

In order to use the Remote Liferay server feature in Liferay IDE, the Server Manager plugin needs to be installed into the remote Liferay server instance. Below are the steps for installing the server manager plugin.

  1. Start the Liferay Server v6.1 Tomcat, JBoss or Glassfish bundle on the remote server
  2. Download the latest version of the server-manager-web plugin from here.
  3. Copy the server-manager-web-plugin war file into the auto-deploy folder on the remote server instance. (LIFERAY_HOME/deploy)
  4. You should see a message about server-manager plugin war being deployed

Remote Liferay Server Adapter Setup

  1. Open New Server Wizard.. choose File > New > Server > Server
  2. Choose Liferay > Remote Liferay Server
  3. Or from toolbar dropdown
  4. Specify a Liferay v6.x Runtime stub that will be used for runtime definition for projects that are deployed to remote server. This requires a local tomcat bundle of either 6.0 or 6.1 version of Liferay Portal Tomcat bundle. Specify the location of an unzipped tomcat bundle.
  5. On next page type in the correct IP address
  6. Specify http port that Liferay server is listening
  7. For username/password use the Omni admin username and password.
  8. Liferay context path is the context URI that Liferay portal is registered on, most likely the default can be used.
  9. Server manager context path is the context path for the deployed server-manager plugin, by default /server-manager-web
  10. Click Finish
  11. You should see remote server log mssages printed to the console.

Deploy project to Remote Server

  1. Right click the Remote server and choose “Add / Remove” action to configure new projects to be published (deployed) to remote server.
  2. Once the project is deployed, you will see a message for deployment being successful in console.
  3. Once any files or resources are changed, you will need to publish these changes by clicking the “publish” action in the Servers view, and a delta update will be sent to remote server.
  4. Remove a project from the server in the same way as with a local server, just right click the module and click “Remove”.

Modify Remote Server Settings

  1. To edit existing Remote Server settings, double-click the remote server in the Servers view which will open the configuration editor.
  2. Make any modifications and then save the server configuration.