jlucki/docker-php-dev-env

A simple web development environment using Docker with NGINX, PHP, MySQL and Xdebug.

v1.5 2023-12-13 08:24 UTC

MIT

• Jan Lucki

• php
• Xdebug
• development
• environment
• nginx
• docker

README

This repository allows you to quickly get a development environment up and running using Docker, including a MySQL database and some debugging tools.

This environment includes the latest versions of the following software:

• nginx:alpine
• php:8.3-fpm
• mysql:latest
• xdebug

Prerequisites

• Docker - https://www.docker.com/products/docker-desktop
• Tested and confirmed working on:
  • macOS 12.3 (Monterey)
  • Windows 10 Version 21H1 build 19043.1165

Project Setup

Run composer create-project jlucki/docker-php-dev-env "project_name"

Alternatively, download the files from this repo and copy them to your project directory.

Running the Container

1. Run docker compose up from the project directory
   • Note: the above command will only work on versions newer than 3.6. If you are using Docker 3.6 or older, use docker-compose up
2. Visit localhost in your browser

Setting up Xdebug in Your IDE

The following instructions are for PHPStorm.

1. Click on Run > Edit Configurations
2. Click the + and add a new PHP Remote Debug configuration
3. Give the configuration a name
4. Tick Filter debug connection by IDE key
5. Add PHPSTORM in the session id
6. Click the ... next to Server
7. Click the + to add a new server
8. Give the server a name, and set the host to localhost
9. Tick Use path mappings
10. Under the Project files file/directory, next to your project folder, for the Absolute path on the server column add /var/www/html
11. Hit Apply and OK until you've returned to the IDE
12. Click the Start Listening for PHP Debug Connections icon
13. Set a breakpoint in your code
14. Refresh the page in your browser
15. Accept Incoming Connection From Xdebug
16. Happy debugging!

See https://xdebug.org/docs/remote for how to enable xdebug sessions.

Additional Notes

For database connections, use mysql as the hostname. If you would like a different hostname, change the service name in the docker-compose.yml file.

Windows 10 Troubleshooting

If you are having problems and can't seem to fix the issue, try one or both of these fixes:

Solution 1

Try switching to Windows containers:

Right-click the Docker icon in the system tray and click Switch to Windows containers as seen below:

Solution 2

If the Use the WSL 2 based engine setting is checked:

Uncheck the setting, then enable file sharing located under the Resources section, then the File Sharing section as seen below:

If the Use the WSL 2 based engine setting is unchecked: Enable/check the setting (file sharing is automatically configured)