Laravel is now up and running with docker

- docker  .env PHP mount points modified. For laravel, serving from /public/ should be done at the NGINX level. PHP still needs access to everything that is in /src/
- Renamed the nginx php.conf file into nginx-webserver.conf
- changed nginx-webserver.conf to match more closely the official Laravel settings. The previous config did not work with the Laravel Routes
- in the php Dockerfile, added error files init for xdebug and php-errors
- made small changes in xdebug.ini (php container) to get rid of unwanted "error" messages such as Client is not listening. NOT TESTED WITH ACTUAL STEp-DEBUG yet.

Next: try devcontainer
Next: try localhost step-debug

Author: hubertnguyen

.devcontainer/.docker/nginx/conf.d/nginx-webserver.conf

@@ -0,0 +1,38 @@
+# this server config works with Laravel too
+server {
+    listen 80;
+    listen [::]:80 default_server;
+    
+    # not needed for now
+    # server_name example.com;
+    
+    root /var/www/htdoc/public;
+ 
+    add_header X-Frame-Options "SAMEORIGIN";
+    add_header X-Content-Type-Options "nosniff";
+ 
+    index index.php;
+ 
+    charset utf-8;
+ 
+    location / {
+        try_files $uri $uri/ /index.php?$query_string;
+    }
+ 
+    location = /favicon.ico { access_log off; log_not_found off; }
+    location = /robots.txt  { access_log off; log_not_found off; }
+ 
+    error_page 404 /index.php;
+     
+    location ~* \.php$ {
+        fastcgi_pass   php:9000;
+      
+        include        fastcgi_params;
+        fastcgi_param  SCRIPT_FILENAME $document_root$fastcgi_script_name;
+        fastcgi_param  SCRIPT_NAME     $fastcgi_script_name;
+    }
+ 
+    location ~ /\.(?!well-known).* {
+        deny all;
+    }
+}

.devcontainer/.docker/nginx/conf.d/php.conf

@@ -4,6 +4,12 @@ ARG RUNTIME_PHP_IMAGE
 # Use the specified image as the base
 FROM ${RUNTIME_PHP_IMAGE}
 
+# create the log file and provide permission to the www-data user
+RUN touch /tmp/xdebug.log && chown www-data:www-data /tmp/xdebug.log
+
+# same thing for the PHP error log
+RUN touch /var/log/php-errors.log && chown www-data:www-data /var/log/php-errors.log
+
 # Update the packages
 # Install system packages required for MongoDB extension
 RUN apt-get update \
@@ -51,4 +57,14 @@ RUN mv composer.phar /usr/local/bin/composer
 
 # NOT REQUIRED
 # Change to non-root privilege
-# USER www-data
+# USER www-data
+
+# Enable Error-logging in the PHP container
+# ----------------------------------------------------------
+
+# RUN echo "error_log = /var/log/php-fpm.log" >> /usr/local/etc/php-fpm.d/docker.conf
+
+#RUN echo "php_admin_value[error_log] = /var/log/php-fpm/www-error.log" >> /usr/local/etc/php-fpm.d/www.conf && \
+#    echo "php_admin_flag[log_errors] = on" >> /usr/local/etc/php-fpm.d/www.conf && \
+#    echo "catch_workers_output = yes" >> /usr/local/etc/php-fpm.d/www.conf
+

.devcontainer/.docker/php/Dockerfile

@@ -1,11 +1,47 @@
 # already loaded in /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
 #zend_extension=xdebug
 
+; FIXME : should be elsewhere, like docker-php.ini
+error_log = /var/log/php-errors.log
+catch_workers_output = yes
+
 [xdebug]
-xdebug.mode=debug
-xdebug.client_host=host.docker.internal
-xdebug.start_with_request=yes
-;xdebug.discover_client_host=1
+
+; enables step by step debugging
+; xdebug.mode=debug,develop
+xdebug.mode=develop
+
+; xdebug.client_host=host.docker.internal
+
+; set this to 'yes' to ALWAYS start a request/
+; it will complain if not debugger is found listening
+; default value is xdebug.start_with_request=trigger, which should be fine
+;
+; xdebug.start_with_request=yes
+xdebug.discover_client_host=1
+
 xdebug.client_port=9003
-xdebug.idekey=PHPSTORM
-xdebug.log=/tmp/xdebug.log
+
+; No need. By default, this is redirected to the general log of 
+; of your PHP container and visible from tools like Docker Desktop
+; 
+;xdebug.log=/var/tmp/xdebug.log
+
+; Color var_dumps when in CLI
+xdebug.cli_color=1
+
+; redirect the xdebug log to the container's STDOUT (/proc/self/fd/1) or STDERR (/proc/self/fd/2)
+xdebug.log=/tmp/xdebug.log
+
+; 2.x way to activate the debugger. 
+; generates this message, if not debugger is listening:
+;   NOTICE: PHP message: Xdebug: [Step Debug] Time-out connecting to debugging client, waited: 200 ms. Tried: host.docker.internal:9003
+;
+; xdebug.idekey=PHPSTORM
+
+; NOTES
+;
+; the log error "Trigger value for 'XDEBUG_TRIGGER' not found, falling back to 'XDEBUG_SESSION'"
+; can be avoided by adding  /?XDEBUG_SESSION=start to the page URL being browsed
+; 
+; NOTICE: PHP message: Xdebug: [Step Debug] Time-out connecting to debugging client, waited: 200 ms. Tried: host.docker.internal:9003

.devcontainer/.docker/php/xdebug.ini

@@ -6,10 +6,10 @@ NGINX_CONTAINER_PORT=80
 NGINX_HOST_CONFD_DIR=./.docker/nginx/conf.d
 NGINX_CONTAINER_CONFD_DIR=/etc/nginx/conf.d
 
-WEBROOT_HOST_PATH=../src/public
-WEBROOT_CONTAINER_PATH=/var/www/htdoc
+PHP_WEBROOT_HOST_PATH=../src/
+PHP_WEBROOT_CONTAINER_PATH=/var/www/htdoc
 
-NGINX_WEBROOT_HOST_PATH=../src/public
+NGINX_WEBROOT_HOST_PATH=../src/
 NGINX_WEBROOT_CONTAINER_PATH=/var/www/htdoc
 
 MYSQL_IMAGE=mysql:5.7

.devcontainer/.env

@@ -36,10 +36,10 @@ services:
         RUNTIME_PHP_IMAGE: ${PHP_IMAGE}
     image: ${PHP_IMAGE}
     # container-path
-    working_dir: ${WEBROOT_CONTAINER_PATH}
+    working_dir: ${PHP_WEBROOT_CONTAINER_PATH}
     # disk local-path
     volumes:
-      - ${WEBROOT_HOST_PATH}:${WEBROOT_CONTAINER_PATH}
+      - ${PHP_WEBROOT_HOST_PATH}:${PHP_WEBROOT_CONTAINER_PATH}
 
 
   # MySQL Service

.devcontainer/docker-compose.yml

@@ -15,14 +15,25 @@ The article mentions several ways to get a Laravel development environment up an
 
 ## .env file 
 
-Not included in this repo is the .env file that contains the MongoDB connection string with the username / password. You'll have to make a cope of the .env.example file and add this variable: 
+#### Application key
+
+Laravel might ask to generate a new application key. You can do it by running this command in the laravel project folder. 
+
+`php artisan key:generate`
+
+#### MongoDB connection string
+
+Not included in this repo is the Laravel .env file that contains the MongoDB connection string with the username / password. You'll have to make a cope of the .env.example file and add this variable: 
 
 `DB_URI=`
 
 The complete URI looks like this:
 
 `DB_URI=mongodb+srv://USERNAME:PASSWORD@clustername.subdomain.mongodb.net/?retryWrites=true&w=majority`
 
+# Troubleshooting
+
+
 # Disclaimer
 
 Use at your own risk; not a supported MongoDB product

README.md

@@ -1,5 +1,9 @@
 <?php
 
+//echo "hello Laravel world";
+
+//phpinfo();
+
 use Illuminate\Contracts\Http\Kernel;
 use Illuminate\Http\Request;
 
@@ -20,6 +24,8 @@
     require $maintenance;
 }
 
+
+
 /*
 |--------------------------------------------------------------------------
 | Register The Auto Loader
@@ -48,8 +54,11 @@
 
 $kernel = $app->make(Kernel::class);
 
+// CRASH at the line below:
+
 $response = $kernel->handle(
     $request = Request::capture()
 )->send();
 
 $kernel->terminate($request, $response);
+