Configuring Tunneling with Studio

This procedure describes how Platform users can configure the Studio side to connect with Platform using a Communication Tunnel. Communication tunnels are used to circumvent Firewalls and other security devices to enable the use of Platform's advanced diagnostics options. These options include editing, debugging and profiling Event source code using Studio.

 

Tunneling is used for editing PHP code with Studio in instances when the code and the IDE are located on different machines separated by a Firewall.

 

The following instructions pertain to the following IDEs:

Studio for Eclipse 6.0

Studio 5.5

Note:

The Debug port for Studio 5.5 is 10000 and in Studio for Eclipse 10137.

Studio for Eclipse 6.0

There are several steps to defining Tunneling in Studio for Eclipse as follows:

  1. Define a server

  2. Configure Server Preferences

  3. Configure Platform Integration

  4. Set Tunneling Settings

 

 

Instructions on how to complete a procedure

To configure Tunneling Settings for Studio for Eclipse:

  1. Open the PHP Server Preferences dialog from the shortcut menu by clicking tunnel_icon.png or from the main menu: Window | Preferences | PHP |PHP Servers.

  2. Click New to define a New Server (or Edit if the server has already been defined).

  3. Give the server a unique name and enter the URL of the server on which Platform is installed.
    Click Next to continue or go to the next Tab.

  4. You can ignore the Path Mapping option. Before running a Debugging or Profiling session you will be automatically prompted to define path mapping. Read more about Path Mapping in the Studio for Eclipse Help.
    Click Next to continue or go to the next Tab.

  5. In the Platform Integration dialog, check the option "Enable Platform Integration".

  6. In the Platform GUI section keep the option Use Default and the "/ZendPlatform" suffix - this information is used to locate Platform

  7. In the Authentication section enter your Platform User Name and Password.
    Click Next to continue or go to the next Tab.

  8. In the Tunneling Settings section, check the option "Enable Tunneling"

  9. Specify your "Return Host" which should be the IP address of the machine on which Studio is installed (if the response should be sent to the same machine you can leave this option empty).

  10. Configure your Authentication Information - Use this option when working with a Web server that requires HTTP authentication. Zend Studio sends the authentication information in the header.
    Note: This assumes the user account is set up on the Web server
    Click Finish or OK.

  11. Activate Tunneling to a server by clicking the Tunneling icon tunnel_icon.png.
    The statuses are; Green - connected and Red - disconnected. To know which server is connected click on the arrow next to the icon to display the mane of the server.

Now when clicking the Event Details options: Reproduce in Debugger and Reproduce in Profiler, a Studio Session will be initiated.

When debugging and profiling make sure you are in the correct perspective or that you confirm the perspective switch in Studio Eclipse otherwise the session will not start.

Note:

To start a Debug Session click the Resume button in Studio Eclipse's Debug perspective.

Useful Information:

  1. Information in Studio's Debug Preferences, must match the information in Studio’s Tunneling Settings for tunneling to work.

  2. Several Tunneling sessions can be configured. Therefore, If the debug session is not working, check to see that the Tunnel to the correct server is connected.
    To do so in Studio Eclipse, click on the drop-down arrow next to the Tunneling Icon tunnel_icon.png and verify that the name of the server is correct.

  3. If running a session times-out, make sure the "Client Host ID" is defined in Preferences | PHP | Debug. This will direct the response to a single address.

Debug Preferences

To view debug preferences to ensure that the information is suits the Tunneling Preferences go in Studio for Eclipse to:  Window | Preferences | PHP | Debug:

php_debug.png

Studio for Eclipse Debug Preferences

In the section called "Connection to debug server", make sure the following settings are configured:

Debug Options:

Studio 5.5

 

 

Instructions on how to complete a procedure

To configure Tunneling Settings for Studio:

  1. Open the Tunneling dialog: Tools | Tunneling Settings:

  2. Define values for the following settings:

  • Tunnel Target Host - Address of the Web server on which the debugger resides.

  • Tunnel Target Port - Port of the Web server on which the debugger resides the default port is 80.

  • Specify Return Host - When enabled, this should contain the address of the server on which Studio resides.

  • Automatically Connect on Startup - Enables the communication tunnel when Zend Studio starts up.

  • HTTP Authentication - Tunneling supports HTTP authentication. This enables users to send HTTP authentication information (user name, password) together with the header sent to the server. Therefore, you can specify that tunneling to a server will require authentication, and improve security by adding information in the following fields:

  • Send Authentication Information - Use this option when working with a Web server that requires HTTP authentication. Zend Studio sends the authentication information in the header.
    Note: This assumes the user account is set up on the Web server.

  • User Name - User name as defined on the Web server.

  • Password - User password as defined on the Web server. Note: Whenever you use the debugger, the server will use the User Name and Password specified here.

  1. Click "Connect" for Studio to connect to the Tunnel Target Host over the specified port.

Note:

Information in Studio's Debug Preferences, must match the information in Studio’s Tunneling Settings for tunneling to work.

Debug Preferences

To view debug preferences to ensure that the information is suits the Tunneling Preferences go in Studio to:  Tools | Preferences | Debug:

studio_debug_preferences.png

Studio Debug Preferences

In the section called "Connection to debug server", make sure the following settings are configured:

 

 

Related Links

Related Links:
Configuring Preferences for Tunneling

Studio Settings

Tunneling