Xdebug Debugging On A Remote Server

20th January 2013 - 4 minutes read time

I have started to use virtual machines to develop sites rather than installing a local web server. This allows me to replicate the exact setup of the server I will be deploying to with ease. For each virtual machine I set up a shared folder which allows me to store the files locally whilst being able to run the code on the virtual machine. One thing I missed was the ability to use xdebug to debug the sites through Netbeans, so I set about trying to set up the virtual hosts to allow me to use xdebug remotely.

All that is needed was to add a xdebug.remote_connect_back clause to the xdebug.ini file found in the PHP configuration. Set this value to 1 to automatically connect back to any xdebug session that is created on the server.

xdebug.remote_connect_back = 1

Remember that you will also need to setup the correct hosts directive on your system to allow your web browser to open up and accept the xdebug session. Additionally, because I was using virtual machines I could never be sure that the IP address of the host computer was going to be the same. For this reason the xdebug.remote_host clause should be removed so that xdebug was IP address agnostic. I sill needed to tweak my hosts file every now and then, but I wouldn't need to edit the xdebug.ini file and restart Apache.

I should note here that if you are doing this on a server the removal of the xdebug.remote_host clause will mean that anyone will be able to create an xdebug session on the server. Which is a bit of a security problem.

Here is the xdebug configuration on my virtual servers in full. The first clause (for the xdebug binary) might be different on your setup.

zend_extension=/usr/lib/php5/20100525/xdebug.so

xdebug.remote_enable=1
xdebug.remote_port=9000
xdebug.remote_handler="dbgp"
xdebug.remote_connect_back = 1

If you have a development server then you should remember that xdebug will only be able to create one debugging session at a time.

PHP
xdebug

Add new comment

The content of this field is kept private and will not be shown publicly.
CAPTCHA
4 + 4 =
Solve this simple math problem and enter the result. E.g. for 1+3, enter 4.
This question is for testing whether or not you are a human visitor and to prevent automated spam submissions.

Related Content

Generating Colour Palettes From Images In PHP

4th August 2024

A common web design pattern is to incorporate an image into the design of the page. This creates a tighter integration with the image and the rest of the page.

The main issue in designing a page around the image is that the colours of the page must match the image. Otherwise this creates a dissonance between the image and the styles of the site.

Read more

Validating XML Files With XML Schema Definitions In PHP

21st July 2024

XML is a useful format for configuration, data storage, and transmitting data from one system to another. As a human readable format that can be easily read by machines it quickly gained favor in lots of different systems as a mechanism for data storage.

Read more

Approximating Pi Using A Circle And A Square

26th May 2024

Pi day was a few weeks ago, but I came across this simple approximation of pi recently and decided to put together an example in PHP since it seemed pretty simple.

This approximation of pi centers around a real world example, but we can simulate this using some code.

Read more

Drawing A Parabolic Curve With Straight Lines In PHP

12th May 2024

A parabolic curve is a type of curve where every point is an equal distance from a focal point. There a number of different way to generate this sort of curve using math, but one of the simplest is to use straight lines to create the illusion of the curve.

Read more

Recreating Spotify Wrapped In PHP

17th March 2024

I quite like the end of the year report from Spotify that they call "Wrapped". This is a little application in which they tell you what your favorite artist was and what sort of genres you listened to the most during the year.

Read more