Docker+php-fpm+xdebug (on Linux) + PHPStorm (on Windows) 6th April 2021 docker, php, phpstorm, xdebug. I have docker installed on my Linux host and raised a container with php-fpm and xdebug. Phpstorm is installed on Windows server. The project is hoisted through gitlab. Xdebug is an extension for debugging your PHP code. Magento Cloud Docker provides a separate container to handle Xdebug requests in the Docker environment. Use this container to enable Xdebug and debug PHP code in your Docker environment without affecting your. Instruct XDebug to connect back to the IP where web request came from. Instruct XDebug to connect to host.docker.internal for command line execution or whenever “connect back” is not possible. Set PHPIDECONFIG env variable to serverName=localhost. This will tell your PhpStorm which server configuration to use. See next step for details. Pick the PHP Remote Debug template and click the +on the top left to add a new configuration (don't make the mistake of editing the template). Check 'Filter debug connection by IDE key' and set the IDE key to match the one in your XDebug config (for the above we'd use PHPSTORM).

A quick guide to how to do this, since I always forget and have to look it up. This is done with docker4drupal, but should work equally well with any Docker Compose setup.

Enable xdebug on the relevant Docker container. For docker4drupal this means uncommenting these lines in the docker-compose.yml file:

If you enable these after you've created the PHP container, remember to restart the container so that xdebug is enabled and configured.

Now go to Settings > Languages & Frameworks > PHP and set your language level as required. Add a new CLI interpreter by clicking .... Click the + on the top left and add a new Docker configuration. Select Docker Compose and the php service, then use the default options for everything else. Save this and apply.

Next click the 'Add configuration' button on the taskbar in the top right. Pick the PHP Remote Debug template and click the + on the top left to add a new configuration (don't make the mistake of editing the template). Check 'Filter debug connection by IDE key' and set the IDE key to match the one in your XDebug config (for the above we'd use PHPSTORM). Add a server (the name doesn't matter). Give it the appropriate host and port—for docker4drupal the host will be something like http://myproject.docker.drupal.localhost, and the port will be 8000 unless you've changed it. Check 'Use path mappings', and set a path mapping for the root directory to /var/www/html (or wherever it's mounted to on the container).

It's important to note that for this to work with Drush, or anything that exists both in Composer and globally, you need to invoke Drush from the binary in the vendor directory vendor/bin/drush rather than using the system Drush, so that PHPStorm can use the path mappings. You could do this with a make command or Composer script. A make command I've used in the past:

This is a modified version of the default docker4drupal command.

ddev

The process for ddev is largely the same. You can skip the step for setting up the CLI interpreter as this will work fine without it. An important point is that the name of your debug configuration must match your ddev site domain for this to work. See the ddev documentation for more details.

Docker enables developers to deploy applications inside containers for testing code in an environment identical to production. PhpStorm provides Docker support using the Docker plugin. The plugin is bundled and enabled by default. The Docker plugin is bundled with PhpStorm and activated by default. If the plugin is disabled, enable it on the Settings/Preferences | Plugins page as described in Managing plugins.

Enable Docker support

1. Install and run Docker.

   For more information, see the Docker documentation.

2. Configure the Docker daemon connection settings:

   • In the Settings/Preferences dialog Ctrl+Alt+S, select Build, Execution, Deployment | Docker.

   • Click to add a Docker configuration and specify how to connect to the Docker daemon.

     The connection settings depend on your Docker version and operating system. For more information, see Docker configuration.

     The Connection successful message should appear at the bottom of the dialog.

     The default docker-machine value is fine if:

     • The actual name of the executable file is docker-machine.

     • The path to the directory where the file is located is included in the Path environment variable.

     To specify an actual path to the executable file, click and select the file in the dialog that opens.

     If no message appears, check the Docker Machine executable setting on the Docker | Tools page.

     The Path mappings table is used to map local folders to corresponding directories in the Docker virtual machine's file system. Only specified folders will be available for volume binding.

     This table is not available on Linux, because when running Docker on Linux, any folder is available for volume binding.

3. Connect to the Docker daemon.

   The configured Docker connection should appear in the Services tool window (View | Tool Windows | Services or Alt+8 ). Select the Docker node , and click , or select Connect from the context menu.

   To edit the Docker connection settings, select the Docker node and click on the toolbar, or select Edit Configuration from the context menu.

The Services tool window (View | Tool Windows | Services or Alt+8) enables you to pull and push images, create and run containers, manage Docker Compose, and so on. As with other tool windows, you can start typing the name of an image or container to highlight the matching items.

Managing images

Docker images are executable packages for running containers. Depending on your development needs, you can use Docker for the following:

• Pull pre-built images from a Docker registry

  For example, you can pull an image that runs a Postgres server container to test how your application will interact with your production database.

• Build images locally from a Dockerfile

  For example, you can build an image that runs a container with some specific version of PHP to execute your application inside it.

• Push your images to a Docker registry

  For example, if you want to demonstrate to someone how your application runs in some specific version of language instead of setting up the proper environment, they can run a container from your image.

Images are distributed via the Docker registry. Docker Hub is the default public registry with all of the most common images: various Linux flavors, database management systems, web servers, runtimes, and so on. There are other public and private Docker registries, and you can also deploy your own registry server.

PhpStorm Docker registry provides a selection of preconfigured Docker images serving common PHP development needs.

You do not need to configure a registry if you are going to use only Docker Hub.

1. In the Settings/Preferences dialog Ctrl+Alt+S, select Build, Execution, Deployment | Docker | Registry.

2. Click to add a Docker registry configuration and specify how to connect to the registry. If you specify the credentials, PhpStorm will automatically check the connection to the registry. The Connection successful message should appear at the bottom of the dialog.

1. In the Services tool window, select the Images node.

2. Select the Docker registry and specify the repository and tag (name and version of the image, for example, php-71-apache-xdebug-26:latest ).

3. Press Ctrl+Enter to run docker pull.

When you are editing a Dockerfile, PhpStorm provides completion for images from the configured registries. You can also hold down Ctrl and click an image name to open its page in a web browser.

1. Open the Dockerfile from which you want to build the image.

2. Click in the gutter and select to build the image.

PhpStorm runs the docker build command.

1. In the Services tool window, select the image that you want to upload and click or select Push Image from the context menu.

2. Select the Docker registry and specify the repository and tag (name and version of the image, for example, my-app:v2 ).

3. Click OK to run the docker push command.

Images that you pull or build are stored locally and are listed in the Services tool window under Images. When you select an image, you can view its ID or copy it to the clipboard by clicking the button on the Properties tab.

To display detailed information about an image, right-click it and select Inspect from the context menu. PhpStorm runs the docker image inspect command and prints the output to the Inspection tab.

Images with no tags <none>:<none> can be one of the following:

• Intermediate images that serve as layers for other images and do not take up any space

• Dangling images that remain when you rebuild an image based on a newer version of another image. You should regularly prune dangling images to preserve disk space.

To hide untagged images from the list, click on the Docker toolbar, and then click Untagged Images to remove the check mark.

To delete one or several images, select them in the list and click .

Running containers

Containers are runtime instances of corresponding images. For more information, see the docker run command reference.

PhpStorm uses run configurations (Run | Edit Configurations) to run Docker containers. There are three types of Docker run configurations:

• Docker Image: Created automatically when you run a container from an existing image. You can run it from a locally existing Docker image that you either pulled or built previously.

• Dockerfile: Created automatically when you run a container from a Dockerfile. This configuration builds an image from the Dockerfile, and then derives a container from this image.

• Docker-compose: Created automatically when you run a multi-container Docker application from a Docker Compose file.

Any Docker run configuration can also be created manually. From the main menu, select Run | Edit Configurations. Then click , point to Docker, and select the desired type of run configuration.

1. In the Services tool window, select an image and click or select Create Container from the context menu.

2. In the Create container popup, click Create.

   If you already have a Docker run configuration for this image, the Create container popup will also contain the name of that run configuration as an option.

3. In the Create Docker Configuration dialog that opens, you can provide a unique name for the configuration and specify a name for the container. If you leave the Container name field empty, Docker will give it a random unique name.

4. When you are done, click Run to launch the new configuration.

1. Open the Dockerfile from which you want to run the container.

2. Click in the gutter and select to run the container on a specific Docker node.

This creates and starts a run configuration with default settings, which builds an image based on the Dockerfile and then runs a container based on this image.

To create a run configuration with custom settings, click in the gutter and select New Run Configuration. You can specify a custom tag for the built image, as well as a name for the container, and a context folder from which to read the Dockerfile. The context folder can be useful, for example, if you have some artifacts outside of the scope of your Dockerfile, which you would like to add to the file system of the image.

You can right-click the Dockerfile in the Project tool window for the following useful actions:

• Run the container from the Dockerfile

• Save the run configuration for the Dockerfile

• Select the run configuration for this Dockerfile to make it active

Command-line options

When running a container on the command line, the following syntax is used:

All optional parameters can be specified in the corresponding Docker run configuration fields.

To open a run configuration, right-click a container and select Edit Configuration, or use the gutter icon menu in the Dockerfile, or select Run | Edit Configurations from the main menu.

Options are specified in the Command line options field. In the previous screenshot, the container is connected to the my-net network and is assigned an alias my-app.

Commands and arguments to be executed when starting the container are specified in the Entrypoint and Command fields. These fields override the corresponding ENTRYPOINT and CMD instructions in the Dockerfile.

Not all docker run options are supported. If you would like to request support for some option, leave a comment in IDEA-181088.

The Command preview field shows the actual Docker command used for this run configuration.

You can also configure the following container settings in the run configuration:

Bind mounts

Docker can mount a file or directory from the host machine to the container using the -v or --volume option. You can configure this in the Docker run configuration using the Bind mounts field.

If you are using Docker for Windows, you need to enable drive sharing. Open Docker settings, select Shared Drives, select the drive (for example, C:) that you want to make available to your containers, and restart Docker.

Make sure that the corresponding path mappings are configured in the Docker connection settings (the Path mappings table).

Click in the Bind mounts field and add bindings by specifying the host directory and the corresponding path in the container where it should be mounted. Select Read only if you want to disable writing to the container volume. For example, if you want to mount some local MySQL data directory (/Users/Shared/mysql) to the MySQL data directory inside the container (/var/lib/mysql ), this can be configured as illustrated on the previous screenshot.

If you expand the Command preview field, you will see that the following line was added:

This can be used in the Command line options field instead of creating the list of volume bindings using the Bind Mounts dialog.

1. In the Services tool window, select the container and then select the Volume Bindings tab.

2. To create a new binding, click . To edit an existing one, select the binding and click .

3. Specify the settings as necessary and click Save to apply the changes.

The container is stopped and removed, and a new container is created with the specified changes. However, changes are not saved in the corresponding run configuration.

Bind ports

Docker can map specific ports on the host machine to ports in the container using the -p or --publish option. This can be used to make the container externally accessible. In the Docker run configuration, you can choose to expose all container ports to the host or use the Bind ports field to specify port mapping.

Click in the Bind ports field and bindings by specifying which ports on the host should be mapped to which ports in the container. You can also provide a specific host IP from which the port should be accessible (for example, you can set it to 127.0.0.1 to make it accessible only locally, or set it to 0.0.0.0 to open it for all computers in your network).

If you already have MySQL running on the Docker host port %5432%, you can map port %5433% on the host to %5432% inside the container as illustrated on the previous screenshot. This will make MySQL running inside the container accessible via port %5433% on the host.

If you expand the Command preview field, you will see that the following line was added:

This can be used in the Command line options field instead of creating the list of port bindings using the Port Bindings dialog.

1. In the Services tool window, select the container and then select the Port Bindings tab.

2. To create a new binding, click . To edit an existing one, select the binding and click . If the Publish all ports checkbox is selected, clear it to be able to specify individual port mappings.

3. Specify the settings as necessary and click Save to apply changes.

The container is stopped and removed, and a new container is created with the specified changes. However, changes are not saved in the corresponding run configuration.

Environment variables

Environment variables are usually set in the Dockerfile associated with the base image that you are using. There are also environment variables that Docker sets automatically for each new container. You can specify additional variables and redefine the ones that Docker sets using the -e or --env option. In a Docker run configuration, you can use the Environment variables field to configure environment variables.

Click in the Environment variables field to add names and values for variables. For example, if you want to connect to MySQL with a specific username by default (instead of the operating system name of the user running the application), you can define the MYSQL_USER variable as illustrated on the previous screenshot.

If you expand the Command preview field, you will see that the following line was added:

This can be used in the Command line options field instead of creating the list of names and values using the Environment Variables dialog. If you need to pass sensitive information (passwords, secrets, and so on) as environment variables, you can use the --env-file option to specify a file with this information.

1. In the Services tool window, select the container and then select the Environment variables tab.

2. To add a new variable, click . To edit an existing one, select the variable and click .

3. Specify the settings as necessary and click Save to apply changes.

The container is stopped and removed, and a new container is created with the specified changes. However, changes are not saved in the corresponding run configuration.

Build-time arguments

Docker can define build-time values for certain environment variables that do not persist in the intermediate or final images using the --build-arg option for docker build. These must be specified in the ARG instruction of the Dockerfile with a default value. You can configure build-time arguments in the Docker run configuration using the Build args field.

For example, you can use build-time arguments to build the image with a specific version of MySQL. To do this, add the ARG instruction to the beginning of your Dockerfile:

The MSTAG variable in this case will default to latest if you do not redefine it as a build-time argument. So by default, this Dockerfile will produce an image with the latest available MySQL version. However, you can use the Build Args field to redefine the MSTAG variable.

In the previous screenshot, MSTAG is set to 5.5, which will instruct Docker to pull mysql:5.5. When you deploy this run configuration, it will build an image and run the container with MySQL version 5.5.

To check this, execute mysql -V inside the container and see the output: it should be mysql Ver 14.14 Distrib 5.5.60 or some later version.

If you expand the Command preview field, you will see that the following option was added to the docker build command:

Interacting with containers

Created containers are listed in the Services tool window. When you select a container, you can view its ID (and the ID of the corresponding image) and copy it to the clipboard using on the Properties tab. You can also specify a new name for the container and click Save to start another container with this new name from the same image.

By default, the Services tool window displays all containers, including those that are not running. To hide stopped containers from the list, click , and then click Show Stopped Containers to remove the checkbox.

If a container was created using a Docker run configuration, to view its deployment log, select it and open the Deploy log tab. To view the log messages from the container's STDOUT and STDERR, select it and open the Log tab. For more information, see the docker logs command reference.

You can browse the files inside a running container using the Files tab. Select any file and click to open it remotely in the editor or click to create a copy of the file as a scratch.

The file browser may not work by default for containers that don't have the full ls package, for example, images that are based on Alpine, Photon, and BusyBox. To use it, you can add the following command in the Dockerfile:

1. In the Services tool window, right-click the container name and then click Exec.

2. In the Run command in container popup, click Create.

3. In the Exec dialog, type the command and click OK. For example:

   ls /tmp	List the contents of the /tmp directory
   mkdir /tmp/my-new-dir	Create the my-new-dir directory inside the /tmp directory
   /bin/bash	Start a bash session

For more information, see the docker exec command reference.

• In the Services tool window, right-click the container name and then click Inspect.

  The output is rendered as a JSON array on the Inspection tab.

For more information, see the docker inspect command reference.

• In the Services tool window, right-click the container name and then click Show processes.

  The output is rendered as a JSON array on the Processes tab.

For more information, see the docker top command reference.

• In the Services tool window, right-click the container and then click Attach.

  The console is attached to the output of the ENTRYPOINT process running inside a container, and is rendered on the Attached console tab.

For more information, see the docker attach command reference.

Docker Compose

Docker Compose is used to run multi-container applications. For example, you can run a web server, backend database, and your application code as separate services. Each service can be scaled by adding more containers if necessary. This enables you to perform efficient development and testing in a dynamic environment, similar to production.

Run a multi-container Docker application

1. Define necessary services in one or several Docker Compose files.

2. From the main menu, select Run | Edit Configurations.

3. Click , point to Docker and then click Docker-compose.

4. Specify the Docker Compose files that define services which you want to run in containers. If necessary, you can restrict the services that this configuration will start, specify environment variables, and force building of images before starting corresponding containers (that is, add the --build option for the docker-compose up command).

5. When the run configuration is ready, execute it.

To quickly create a Docker-compose run configuration and run it with default settings, right-click a Docker Compose file in the Project tool window and click Run in the context menu. You can also use gutter icons and the context menu in the Docker Compose file to control services.

When Docker Compose runs your multi-container application, you can use the Services tool window to control specific services and interact with containers. The containers are listed under the dedicated Compose nodes, not under the Containers node (which is only for standalone containers).

1. In the Services tool window, select the service you want to scale and click or select Scale from the context menu.

2. Specify how many containers you want for this service and click OK.

• In the Services tool window, select the service and click or select Stop from the context menu.

• In the Services tool window, select the Compose node and click .

• In the Services tool window, select the Compose node and click .

This stops and removes containers along with all related networks, volumes, and images.

• In the Services tool window, right-click the Compose node or a nested service node and then click Jump to Source in the context menu F4.

The Docker-compose run configuration will identify environment files with the .env suffix if they are located in the same directory as the Docker Compose file.

Troubleshooting

If you encounter one of the following problems, try the corresponding suggested solution.

Make sure that:

• Docker is running.

• Your Docker connection settings are correct.

Php Docker Xdebug Phpstorm

If you are using Docker for Windows, enable the Expose daemon on tcp://localhost:2375 without TLS option in the General section of your Docker settings.

If you are using Docker Toolbox, make sure that Docker Machine is running and its executable is specified correctly in the Settings/Preferences dialog Ctrl+Alt+S under Build, Execution, Deployment | Docker | Tools.

When you try to pull an image, the following message is displayed:

Xdebug Docker Phpstorm Windows

In this case, go to <your_home_dir>/.docker directory and delete the config.json file.

Make sure that the Docker Compose executable is specified correctly in the Settings/Preferences dialog Ctrl+Alt+S under Build, Execution, Deployment | Docker | Tools.

Make sure that the corresponding container ports are exposed. Use the EXPOSE command in your Dockerfile.

When you create new Dockerfiles or Docker compose files, PhpStorm automatically identifies their type. If a file type is not evident from its name, you will be prompted to select the file type manually. To associate an existing file with the correct type, right-click it in the Project view and select Associate with File Type from the context menu.

If the Associate with File Type actions is disabled, this probably means that the filename is registered as a pattern for current file type. For example, if you have a Dockerfile with a custom name that is recognized as a text file, you cannot associate it with the Dockerfile type. To remove the file type pattern, do the following:

1. In the Settings/Preferences dialog Ctrl+Alt+S, select Editor | File types.

2. Select the relevant file type (in this case: Text) and remove the pattern with the name of the file.

3. Click OK to apply the changes.

Now you should be able to set the correct file type using Associate with File Type in the context menu.

Limitations

Xdebug Docker Phpstorm

The Docker integration plugin has certain limitations and bugs, however JetBrains is constantly working on fixes and improvements for it. You can find the list of Docker issues in our bug tracking system and vote for the ones that affect you the most. You can also file your own bugs and feature requests.