PHPDocker.io Documentation

The recommended way to install PHPDocker.io is by using the make init command. This command automates the entire setup process within a Docker environment, including cache cleanup, SSL provisioning, host entry creation, and dependency installation.

Prerequisites:

• Docker and Docker Compose
• mkcert (required for local SSL generation)
• make

Setup Steps:

1. Run make init.
2. Once complete, the application is accessible at https://phpdocker.local:10000.
3. Navigate to the /generator route to use the core functionality.

To run PHPDocker.io on Windows, you must use WSL2 and Docker Desktop with the WSL 2 backend.

When running on Windows via WSL2, the application will be available at https://localhost:10000 instead of the phpdocker.local domain used on Linux/macOS.

To avoid file permission issues (where files are owned by root on your host):

1. Run Composer on your host machine, not inside the PHP container. This prevents the vendor folder from being owned by root.
2. Run application commands (e.g., Symfony console, Laravel Artisan) inside the container using docker-compose exec.

Create a .vscode/launch.json file with the following configuration. Ensure the pathMappings correctly maps the container's application path to your local workspace root.

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Docker",
            "type": "php",
            "request": "launch",
            "port": 9000,
            "pathMappings": {
                "/application/public": "${workspaceRoot}/"
            }
        }
    ]
}

To use Xdebug 3, add the following lines to php-fpm/php.ini-overrides.ini based on your host OS:

Linux:

xdebug.mode=debug
xdebug.discover_client_host=true
xdebug.start_with_request=yes
xdebug.client_port=9000

macOS and Windows:

xdebug.mode = debug
xdebug.client_host = host.docker.internal
xdebug.start_with_request = yes

1. Update docker-compose.yml: Add the PHP_IDE_CONFIG environment variable to the php-fpm service:

environment:
  PHP_IDE_CONFIG: "serverName=Docker"

2. Configure PHPStorm:
   • Go to Preferences | Languages & Frameworks | PHP | Servers.
   • Add a new server where the Name matches the serverName from docker-compose.yml (e.g., Docker).
   • Set the Port to the same port used by your webserver service.
   • Enable Use path mappings and map your local project path to the container path.
3. Use Xdebug helper browser extension to trigger debugging.

To use Xdebug 2, add the following lines to php-fpm/php.ini-overrides.ini based on your host OS:

Linux:

xdebug.remote_enable = 1
xdebug.remote_connect_back = 1
xdebug.remote_autostart = 1

macOS and Windows:

xdebug.remote_enable = 1
xdebug.remote_host = host.docker.internal
xdebug.remote_autostart = 1

To ensure the webserver can write to your application directories (like public), use chown via docker-compose exec. This allows you to set permissions regardless of the user ID on your host machine.

docker-compose exec php-fpm chown -R www-data:www-data /application/public

To add a PHPDocker.io generated environment to your project:

1. Unzip the generated files into your project root. This creates a docker-compose.yml file and a phpdocker/ directory containing Nginx and PHP-FPM configurations.
2. Verify Nginx configuration: Check phpdocker/nginx/nginx.conf to ensure the front controller location (e.g., public/index.php) matches your project structure.
3. Adjust paths if necessary: If you move the files to a different location, you must update the paths for the php-fpm Dockerfile, php.ini overrides, and Nginx configuration within docker-compose.yml.

Prerequisites:

• Docker
• Docker Compose

cd /path/to/your/project
docker-compose up -d

The bin/console script is the primary CLI entrypoint for managing the PHPDocker.io application using Symfony console commands. It requires that project dependencies are installed via Composer and that the Symfony Runtime is present.

php bin/console

When generating a project, you can configure the Elasticsearch service using the following options. The version field is only required and validated if hasElasticsearch is set to true.

{
  "hasElasticsearch": true,
  "version": "7.10.1"
}