Xdebug deepens debugging PHP apps and websites to a level you can’t receive from the manual process of using code level
To install Xdebug for PHP7 on Ubuntu you will need to do so manually. Ubuntu 15 and lower will not come with a package for PHP7 or its xDebug counterpart.
First, be sure you are using PHP 7 already by checking your version.
Should give you something like:
PHP 7.0.0-2+deb.sury.org~trusty+1 (cli) ( NTS ) Copyright (c) 1997-2015 The PHP Group ...
In my case, I’m using the Larval Homestead PHP 7 branch with Vagrant and the VirtualBox provider. So, I have PHP 7 already installed and working with Nginx.
Get your php.ini
Next output your
php.ini information into a file or place you can get to the information. I like to save mine to a file called
sudo php -i > ~/php-info.txt
Use the Xdebug Wizard
Send the text file information into the wizard at Xdebug Wizard. Then follow the instructions the wizard supplies.
Also, if you are using macOS (formerly OSX), you may need to run
brew install autoconf and need to install PHP using homebrew.
The instructions should look something like:
xdebug-2.4.0.tgz(I like to use
wget -O ~/downlaods/xdebug-2.4.0.tgz http://xdebug.org/files/xdebug-2.4.0.tgzon Ubuntu)
- Unpack the downloaded file with
tar -xvzf xdebug-2.4.0.tgz
phpize(See the Xdebug FAQ if you don’t have phpize.)
As part of its output it should be like:
Configuring for: ... Zend Module Api No: 20151012 Zend Extension Api No: 320151012
If it does not, you are using the wrong phpize. Please follow this FAQ entry and skip the next step.
cp modules/xdebug.so /usr/lib/php/20151012
fpmand add the line
zend_extension = /usr/lib/php/20151012/xdebug.so
Enable Remote Xdebug
To use Xdebug remote debugging on a host computer, you need to enable remote debugging on the guest server. In my case, the guest is the Vagrant Homestead VM.
In the guest
php.ini file add:
xdebug.remote_enable = 1 xdebug.remote_connect_back=1 xdebug.scream=0 xdebug.show_local_vars=1 xdebug.idekey=PHPSTORM # Do not assume port 9000 is free xdebug.remote_port = 9000 # You might need to define the host # xdebug.remote_host = 126.96.36.199
Since I use PhpStorm for Debugging I set my Xdebug key to
PHPSTORM. In the browser, the Xdebug and PhpStorm will look for a cookie called
XDEBUG_SESSION with the value
PHPSTORM. To set this cookie, I use the Chrome Browser extension Xdebug helper.
To load the new configurations reload your PHP and HTTP server services. In my case, that is
sudo service php7.0-fpm restart sudo service nginx restart
Configure PHP Storm
Now that Xdebug is installed we are ready to configure a “PHP Remote Debug” for PhpStorm.
PhpStorm | Preferences | Languages & Frameworks | PHP | Debugbe sure Xdebug is set to port 9000 (or 9001 if you need to switch the port)
PhpStorm | Preferences > Languages & Frameworks > PHP > Serversadd a server using port 80 and set the Absolute path on the server.
Run > Edit Configurations...add a “PHP Remote Debug”
- Set the server and the Ide key (session_id) to
Using PhpStorm with Xdebug on a Remote Server
To start receiving requests from the remote server enable “Debug” with Xdebug helper in Google Chrome on the page you want to debug. Then, unlike local testing that uses “Start Listening for PHP Debug Connections” use
Run | Debug instead.
Using the “Debug” command will open up the signal manually and open the direct connection to the remote server.
Set breakpoints and you are off.
Out of Network Servers
If you are trying to remote debug a website with Xdebug from outside your local network be sure port 9000 is not blocked on your network. If you need to unblock that port, it is typically done at the router level.
As always consult the Xdebug remote documentation.
Next, ask Google “what is my public ip” and it will tell you.
Then be sure your remote server is not blocking your IP address.