PhpStorm 10.0 Help

Docker

You can add Docker support to PhpStorm by installing the Docker integration plugin.

Prerequisites

Make sure that the following prerequisites are met:

PhpStorm and Docker integration configuration

At this point you have Docker and Docker plugin for PhpStorm installed, so we can start with integration configuration.

Launching default Docker machine and getting necessary parameters

  1. Open the Docker Quickstart Terminal application. Docker will launch a default VM providing output in the console:
    docker_vm_console
  2. In the Docker console, run the console command docker-machine env default. Thus you will get all the necessary parameters - you'll need them later for PhpStorm configuration (such as DOCKER_HOST and DOCKER_CERT_PATH):
    docker_vm_console_params

Configuring PhpStorm to work with Docker

  1. In the Settings / Preferences dialog, open the Clouds page under Build, Execution, Deployment, and click add to create a Docker configuration:
    docker_settings
  2. In the Clouds - Docker page, provide the following information:
    docker_settings1
  3. Apply the changes and close the Settings / Preferences dialog.

Creating a Docker Deployment run/debug configuration

Having set up Docker, create the run/debug configuration.

First, in the Deployment tab, specify the following:

  • Name. Here it is Start Docker.
  • Server. Here Docker server is selected from the drop-down list.
  • Deployment method. Here Dockerfile is selected.
  • Image tag. Here it is mysite.
  • Container name. Here it is Docker_Xdebug.
docker_run_config

Next, in the Container tab, specify the necessary parameters.
At this point we are interested in exposing 80 port of the container to be available from our local machine, so we should configure a port binding for that:

Container port: 80, Protocol: tcp, Host IP: empty, Host port: 8080

docker_run_config1

Apply changes and close the Docker Deployment run/debug configuration dialog.

Working Docker in PhpStorm

Running Docker from PhpStorm

As all the tools are installed, and the integration is configured, the recently created Start Docker Run/Debug Configuration can be launched:

docker_run_config2

The Application Servers Tool Window opens, updating you on the provisioning status and the current state of all your Docker containers:

docker_app_servers_tw

As soon as the process is completed and our Docker_Xdebug container status turns green, one can check how it works in the browser. You should be able to open it by the URL similar to http://192.168.99.100:8080/ (192.168.99.100 is an IP address of the default Docker machine, we've looked into where to get this parameter before). If you can't see the index.php execution results in the browser (that contains phpinfo(); in our case), make sure that you have specified the correct IP address and port bindings on the previous steps. In our example, everything is running fine on the port we've expected the app to be:

docker_php

Managing Docker containers and other Docker-related actions in PhpStorm

From the Application Servers Tool Window, it’s easy to inspect containers and view running processes. PhpStorm also enables you to search through the logs, start and stop containers, and perform basic container management like creating and deleting containers. Each deployment in Docker is assigned a unique container ID - these are initially temporary containers, although they can be committed and saved for further distribution. On the Docker Hub registry, there are many such images available for you to try.

docker_app_servers_tw1

Images in Docker are read-only - once committed, any changes to a container’s state will become part of a new image. When you have a stable build on one instance of Docker (on your development machine, staging server, or a cloud), reproducing the exact same build is as simple as (1) committing the Docker container, (2) pushing it to a registry (public or private), then (3) pulling the same image to another instance of Docker, running - wherever.

docker_app_servers_tw2

Debugging PHP web application running in the Docker container

Assuming that you already run the Docker container now (and everything worked well on the previous steps), you should now able to open your PHP web application in the browser by http://host:port URL (http://192.168.99.100:8080/ in our case). The major difficulty in getting Xdebug (or Zend Debugger) working with PhpStorm and Docker integration is the correct configuration of the Docker container.

In our case we're using a Dockerfile (we've already shown this config earlier and provided links to download it) to configure the container, including Xdebug-specific parameters, such as:

#Set up debugger RUN echo "zend_extension=/usr/lib/php5/20131226/xdebug.so" >> /etc/php5/apache2/php.ini RUN echo "xdebug.remote_enable=1" >> /etc/php5/apache2/php.ini #Please provide your host (local machine IP) instead of 192.168.2.117 RUN echo "xdebug.remote_host=192.168.2.117" >> /etc/php5/apache2/php.ini

In the example above we're modifying /etc/php5/apache2/php.ini providing a path to Xdebug extension, and some other Xdebug parameters (remote_enable and remote_host). Please note that xdebug.remote_host value should be replaced with your local machine IP address (where PhpStorm is running, in our case it is 192.168.2.117).

Configuration for Zend Debugger is similar, please see a full tutorial on installing Xdebug and installing Zend Debugger (there's more information on required parameters and options).

Don't forget to re-run Start Docker Run/Debug Configuration so that all the changes are applied.

As soon as all the configs are in place, the debugging process can be triggered following this tutorial from step 2 (start Listening for PHP Debug Connections, set a breakpoint in the source code, start a debug session in the browser, reload the current page, debug).

docker_php_debug

See Also

Last modified: 23 December 2015