adjust development example, added xdebug

Author: rw4lll

README.md

@@ -239,4 +239,4 @@ git commit -m "Description of changes"
 
 ## License
 
-This project is licensed under the MIT License. See the [LICENSE]LICENSE file for more details.
+This project is licensed under the MIT License. See the LICENSE file for more details.

development/nginx-fpm/compose.yaml

@@ -1,41 +1,54 @@
 services:
   web:
     image: nginx:latest # We don't need to customize the image. Just pass the configuration to the Dockerfile.
-    networks:
-      - laravel
     volumes:
-      - ${LARAVEL_APP_PATH}/nginx.conf:/etc/nginx/nginx.conf:ro  # Mount the nginx.conf file directly
+      # Mount the application code for live updates
       - ${LARAVEL_APP_PATH}:/var/www
+      # Mount the Nginx configuration file
+      - ${LARAVEL_APP_PATH}/nginx.conf:/etc/nginx/nginx.conf:ro
     ports:
+      # Map port 80 inside the container to the port specified by 'NGINX_PORT' on the host machine
       - "${NGINX_PORT}:80"
     environment:
       - NGINX_HOST=${NGINX_HOST}
+    networks:
+      - laravel
+    depends_on:
+      php-fpm:
+        condition: service_started  # Wait for php-fpm to start
 
   php-fpm:
     # For the php-fpm service, we will create a custom image to install the necessary PHP extensions and setup proper permissions.
     build:
-      context: ./php-fpm
-      dockerfile: Dockerfile
+      context: ../../example-app
+      dockerfile: ../development/nginx-fpm/php-fpm/Dockerfile
       args:
         UID: ${UID}
         GID: ${GID}
     env_file:
+      # Load the environment variables from the Laravel application
       - ${LARAVEL_APP_PATH}/.env
     volumes:
+      # Mount the application code for live updates
       - ${LARAVEL_APP_PATH}:/var/www
+    ports:
+      - "9004:9003"  # Xdebug port
     networks:
       - laravel
+    depends_on:
+      postgres:
+        condition: service_started  # Wait for postgres to start
 
   workspace:
    # For the workspace service, we will also create a custom image to install and setup all the necessary stuff.
     build:
-      context: ./workspace
-      dockerfile: Dockerfile
+      context: ../../example-app
+      dockerfile: ../development/nginx-fpm/workspace/Dockerfile
       args:
         UID: ${UID}
         GID: ${GID}
-    tty: true   # Keep the terminal open
-    stdin_open: true  # Keep stdin open to attach to the container
+    tty: true  # Enables an interactive terminal
+    stdin_open: true  # Keeps standard input open for 'docker exec'
     env_file:
       - ${LARAVEL_APP_PATH}/.env
     volumes:
@@ -46,11 +59,11 @@ services:
   postgres:
     image: postgres:16
     ports:
-      - "5432:5432"
+      - "${POSTGRES_PORT}:5432"
     environment:
-      - POSTGRES_DB=${DB_DATABASE}
-      - POSTGRES_USER=${DB_USERNAME}
-      - POSTGRES_PASSWORD=${DB_PASSWORD}
+      - POSTGRES_DB=${POSTGRES_DATABASE}
+      - POSTGRES_USER=${POSTGRES_USERNAME}
+      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
     volumes:
       - postgres-data:/var/lib/postgresql/data
     networks:

development/nginx-fpm/php-fpm/Dockerfile

@@ -1,24 +1,44 @@
-# Stage 1: Build environment
-FROM php:8.3-fpm AS builder
+# For development environment we can use one-stage build for simplicity.
+FROM php:8.3-fpm
 
-# Install system dependencies and build libraries
+# Install system dependencies and PHP extensions required for Laravel + MySQL/PostgreSQL support
+# Some dependencies are required for PHP extensions only in the build stage
+# We don't need to install Node.js or build assets, as it was done in the Nginx image
 RUN apt-get update && apt-get install -y --no-install-recommends \
     curl \
-    # libpq-dev is required for PostgreSQL
+    unzip \
     libpq-dev \
     libonig-dev \
     libssl-dev \
     libxml2-dev \
     libcurl4-openssl-dev \
+    libicu-dev \
+    libzip-dev \
     && docker-php-ext-install -j$(nproc) \
-    # PHP Extensions required for Laravel. See https://laravel.com/docs/11.x/deployment#server-requirements
-    # Most of these extensions are already included in the base image.
+    pdo_mysql \
     pdo_pgsql \
     pgsql \
-    && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
-
-# Stage 2: Runtime environment
-FROM php:8.3-fpm
+    opcache \
+    intl \
+    zip \
+    bcmath \
+    soap \
+    && pecl install redis xdebug \
+    && docker-php-ext-enable redis xdebug\
+    && apt-get autoremove -y && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+# Configure Xdebug by appending settings to the existing INI file
+RUN echo "xdebug.mode=develop,coverage,debug,profile" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
+    && echo "xdebug.idekey=docker" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
+    && echo "xdebug.start_with_request=yes" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
+    && echo "xdebug.log=/dev/stdout" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
+    && echo "xdebug.log_level=0" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
+    && echo "xdebug.client_port=9003" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
+    && echo "xdebug.client_host=host.docker.internal" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
+
+# Copy the initialization script
+COPY ./entrypoint.sh /usr/local/bin/entrypoint.sh
+RUN chmod +x /usr/local/bin/entrypoint.sh
 
 # Set environment variables for user and group ID
 ARG UID=1000
@@ -28,17 +48,14 @@ ARG GID=1000
 RUN groupadd -g ${GID} www && \
     useradd -u ${UID} -g www -m www
 
-# Copy only the necessary PHP extensions from the build stage
-COPY --from=builder /usr/local/lib/php/extensions/no-debug-non-zts-*/ /usr/local/lib/php/extensions/no-debug-non-zts-*/
-
 # Set working directory
 WORKDIR /var/www
 
 # Change ownership of the working directory to the new user
 RUN chown -R www:www /var/www
 
-# Switch to the non-root user
-USER www
+# Change the default command to run the entrypoint script
+ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
 
 # Expose port 9000 and start php-fpm server
 EXPOSE 9000

development/nginx-fpm/workspace/Dockerfile

@@ -7,10 +7,8 @@ ARG GID=1000
 ARG NODE_VERSION=22.0.0
 
 # Install system dependencies and build libraries
-RUN apt-get update && apt-get install -y \
+RUN apt-get update && apt-get install -y --no-install-recommends \
     curl \
-    git \
-    sudo \
     unzip \
     libpq-dev \
     libonig-dev \
@@ -19,9 +17,19 @@ RUN apt-get update && apt-get install -y \
     libcurl4-openssl-dev \
     libicu-dev \
     libzip-dev \
+    && docker-php-ext-install -j$(nproc) \
+    pdo_mysql \
+    pdo_pgsql \
+    pgsql \
+    opcache \
+    intl \
+    zip \
+    bcmath \
+    soap \
+    && pecl install redis xdebug \
+    && docker-php-ext-enable redis xdebug\
     && curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer \
-    && curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash \
-    && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+    && apt-get autoremove -y && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
 # Create a user with the same UID and GID as the host user
 RUN groupadd -g ${GID} www && \

example-app/routes/web.php

@@ -7,6 +7,11 @@
     return view('welcome');
 });
 
+Route::get('/info', function () {
+    Log::info('Phpinfo page visited');
+    return phpinfo();
+});
+
 Route::get('/health', function () {
     $status = [];