« Back to Liferay IDE

Liferay IDE Remote Server Adapter

Requirements For Tutorial #

Introduction #

The Remote Server Adapter is a feature of Liferay IDE where you can deploy your Liferay projects to a remote Liferay Portal instead of using a locally launched and managed Portal server. The remote instance of Liferay Portal must have the Remote IDE Connector application installed from Liferay marketplace. This application installs the server-manager-web plugin for Liferay that provides an API for Liferay IDE's Remote Server Adapter to use for all its remote operations.

Configure the Remote Server Adapter #

You can configure both the remote server adapter and optionally installing the Remote IDE Connector into the remote Liferay Portal instance all through the Remote Server Wizard in Liferay IDE. Below are the steps to follow:

  1. Ensure that the remote Liferay Portal instance is running and you can login using OmniAdmin username/password
  2. In Eclipse with Liferay IDE plugins installed, go to new Server wizard File > New > Other > Server > Liferay > Remote Liferay Server
  3. Select Next
  4. The next page of remote server configuration remote server is to define the Liferay Portal Runtime Stub. This will allow projects created for this server to use this runtime stub for statisfying jar dependencies needed to compile various Liferay projects. Select bundle type based on your local Liferay Portal Tomcat bundle, then browse to the bundle installation directory.
  5. Select Next
  6. The next page is for configuring the connection to the remote Liferay Portal instance. Enter in the host, port and OmniAdmin username/password. The next two fields can be left as the defaults unless you have made changes to your remote Portal environment.
  7. In order for this connection to the remote Liferay Portal to work, the Remote IDE Connector application must be installed in the remote Portal. If you have not installed that application, you can click the link at the bottom of the page to jump to the marketplace control panel to install the Remote IDE connector.
  8. Click the Free button to purchase the Remote IDE Connector application and follow the onscreen prompts.
  9. Once it is purchase select the Purchased page in the control panel.
  10. Download and install the Remote IDE Connector, once it is installed return to Eclipse and the Remote Server config wizard
  11. Select Validate connection and no warnings or errors should be displayed if you have supplied the correct OmniAdmin username/password. 
  12. Select Finish
  13. Once you select Finish, the new Remote Server will be available in the Servers view and if the connection settings were correct, Eclipse will connect to the remote server. Then the remote liferay logs will be displayed in Eclipse's console. If your remote server is in debug mode, the Eclipse java debugger will be attached to the remote process automatically.
  14. If the settings are invalid and the connection can't be established, you can modify the Remote Server settings at any time by double-clicking the server instance in the Servers view and modify the settings in the configuration editor.

Using the Remote Server Adapter #

Once you have the Remote Server correctly configured and connected in Eclipse, you can begin using it as you would a local Liferay Portal Tomcat server, publishing projects to the server.

  1. Right-click the server and choose Add and Remove modules...
  2. Select Liferay projects you wish to publish to the remote server, select Finish
  3. The deployment process should start and after it is published to remote server you should see a message saying plugin is deployed
  4. After you have made the initial remote deployment, if you make any changes to your project, you will need to publish these changes (or have them published automatically in the settings). To invoke a publish operation (after having modified some project files) right click on the server in the Servers view and select Publish
  5. If you want to modify the publish operation behavior, you can do that in the server configuration editor (double-click server in Servers view)
    #If you receive errors, visit the Liferay IDE forums and post the warning/error to try to get help.
13 Attachments
Average (0 Votes)
The average rating is 0.0 stars out of 5.
Threaded Replies Author Date
I've been unable to connect over SSL. Is this... Kirk Stork April 5, 2013 4:28 PM
At the moment, we don't have SSL support. We... Gregory Amerson April 7, 2013 8:58 PM
Hi Gregory, I just want to clarify... the... Qiqo J May 11, 2013 11:24 AM
You are correct. The runtime stub is just to... Gregory Amerson May 14, 2013 12:14 AM
I set this up on my local workstation to... Nathan Harrell August 8, 2013 12:45 PM
Hey Nathan, Can you go ahead and post this... Gregory Amerson August 19, 2013 12:59 AM
After switching workstation from Windows XP to... Nathan Harrell August 28, 2013 8:02 AM
Hey Lee, Can you open a ticket with the steps... Gregory Amerson October 25, 2013 1:59 AM
Hi, I am new to Liferay and tried you're... Martin Dames October 21, 2013 4:50 AM
Hey Martin, Can you post the steps to... Gregory Amerson October 25, 2013 2:00 AM

I've been unable to connect over SSL. Is this not supported or is there some special configuration?
Posted on 4/5/13 4:28 PM.
At the moment, we don't have SSL support. We will be adding this in the future. http://issues.liferay.com/browse/IDE-891
Posted on 4/7/13 8:58 PM in reply to Kirk Stork.
Hi Gregory,

I just want to clarify... the window "Liferay lifetime stub" where you can only select Tomcat bundles, is just used to satisfy jar dependencies of projects and has nothing to do with the remote server management am I right?

I'm currently running Liferay in a pre-production Glassfish 3.1 enviroment that was installed by a war file and not from a glassfish bundle.

I hope you can clarify. thanks

I'm currently running Liferat 6.1 on glassfish (installed from war not a bundle)
Posted on 5/11/13 11:24 AM.
You are correct. The runtime stub is just to satisfy jar dependencies of liferay projects and doesn't interact with remote server at all. Its just so classes like "MVCPortlet" will resolve for your projects that are deployed remotely.
Posted on 5/14/13 12:14 AM in reply to Qiqo Javier.
I set this up on my local workstation to connect with our Production server on the network, which runs Tomcat 7 as an automatic Windows service, and I could never get a display of any information in the console of the workstation's LDS. Does this setup only pertain to launching the Tomcat server from LDS? The Production Tomcat server is configured to run on port 80 and the workstation Tomcat server still uses the default port 8080 configuration. Could that be causing a problem? Any further information about this would be very appreciated.


Posted on 8/8/13 12:45 PM.
Hey Nathan,
Can you go ahead and post this issue on the Liferay IDE forums as well? We can try to follow up with you over there to try to solve your issues. Thanks

Posted on 8/19/13 12:59 AM in reply to Nathan Harrell.
After switching workstation from Windows XP to Windows 7 I finally got a good connection and now I have console readout on my workstation. However, a couple of issues remain. 1) In order to connect to the remote server, I had to change the authentication of the Portal from screenname (our preferred authentication) to email address; then I could connect using the omniadmin login (test@liferay.com, test). At least I suppose that is the omniadmin login. Every time I switch back to screenname authentication, the local LDS shows the remote server is stopped. 2) I can only deploy a portlet via remote IDE connector once. After that I get "not updating xxx portlet because version 6.1.20.x is newer than 6.1.20. So I have to dump out a .WAR file on my local workstation, then copy and paste it into the deploy folder of the remote server. These issues could be due to an error in setup on my part or different Portal authentication preferences were not considered when creating the Remote IDE Connector plugin, and a patch needs to be issued to enable remote connection for all authentications available for a Liferay Portal. If anybody knows what I can do, I would certainly appreciate the input!

Posted on 8/28/13 8:02 AM.

I am new to Liferay and tried you're suggestion with Glassfish 3.1.x (from the Liferaybundle). When I create a new project through Liferay IDE the only state in the server view for Remore Liferay Server is "Republish" and not synchronised. When I choose "Publish" from the context menu, as you described above, the ant script runs and it copies the my portlet war to liferay-plugins-sdk-6.1.1\dist folder. Should it instead copy this to the glassfish deploy folder? Glassfish will not generate some logs like "Portlet XY installed". It just sais nothing. Therefore, my portlet is not shown under Categories in my running Liferay instance. When I try this with the Tomcat bundle it will deploy and shows up.

Thank you for help.
Posted on 10/21/13 4:50 AM.
Hey Lee,

Can you open a ticket with the steps to reproduce this error on the IDE project in JIRA? https://issues.liferay.com/browse/IDE

Posted on 10/25/13 1:59 AM in reply to Nathan Harrell.
Hey Martin,

Can you post the steps to reproduce this issue into a new JIRA ticket for the IDE project?

Posted on 10/25/13 2:00 AM in reply to Martin Dames.