Rebase from dunglas main repo (#4)

* Typo fix

* Remove iconv workaround

* Replace unsupported wip tld by localhost (dunglas#254)

* ICU 71.1 support

* feat: remove deprecated flags

* feat: improve PHP config (dunglas#266)

* feat: improve PHP config

Tweak PHP config according to Blackfire's recommendation.

* Update docker/php/conf.d/symfony.prod.ini

Co-authored-by: Jacob Dreesen <jacob@hdreesen.de>

* fix

* fix

Co-authored-by: Jacob Dreesen <jacob@hdreesen.de>

* feat: Promote Compose v2

* Windows performance hint (dunglas#270)

* docs: trust certificate on Windows (dunglas#272)

Added information about how to add the caddy cert to the trusted certificates on Windows as this info was only provided for Linux & Mac.

* feat: add native Xdebug support (dunglas#271)

* feat: add native Xdebug support

* cleanup

* fix review

* fix review

* Improve docs

* some more improvements

* remove useless env var

* Update README.md

* Update README.md

* refactor: improve image, uniformize with API Platform  (dunglas#275)

* refactor: improve image, uniformize with API Platform

* feat: remove the SKELETON arg

* chore: minor improvements and sync with API Platform (dunglas#277)

* chore: compatibility with the new ORM recipe (dunglas#278)

* chore: add a default value for XDEBUG_MODE

* fix: stop use obsolete experimental_http3 option

* Feat/supercharged symfony docker (#1)

* 📦 NEW: Makefile + modified ci / dockerfile /README

* 🐛 FIX: added a way to restore permission for the files

* 🐛 FIX: Removed --no-deps option for php command in Docker through Makefile

* 👌 IMPROVE: Added user permissions to manage file permissions

* 🐛 FIX: remove an instruction in Dockerfile

* 🐛 FIX: fixing permissions on small part of the Dockerfile

Co-authored-by: Dezső BICZÓ <mxr576@users.noreply.github.com>
Co-authored-by: Douglas Silva <doug.hs@protonmail.ch>
Co-authored-by: Steven DUBOIS <git@duboiss.fr>
Co-authored-by: Jérôme Zecca <jerome.zecca@cpiglobal.com>
Co-authored-by: Stéphane P <n3wborn@protonmail.com>
Co-authored-by: Kévin Dunglas <kevin@dunglas.fr>
Co-authored-by: Jacob Dreesen <jacob@hdreesen.de>
Co-authored-by: Maxime Hélias <maximehelias16@gmail.com>
Co-authored-by: Robin Brisa <robin.brisa@gmail.com>
Co-authored-by: Borislav Kosun <kosun.b@yandex.ua>

Author: 11 people

.dockerignore

@@ -1,6 +1,9 @@
 **/*.log
 **/*.md
 **/*.php~
+**/*.dist.php
+**/*.dist
+**/*.cache
 **/._*
 **/.dockerignore
 **/.DS_Store
@@ -14,15 +17,14 @@
 **/docker-compose.yml
 **/Dockerfile
 **/Thumbs.db
+.github/
+docs/
+public/bundles/
+tests/
+var/
+vendor/
 .editorconfig
 .env.*.local
 .env.local
 .env.local.php
-.php_cs.cache
-bin/*
-!bin/console
-docker/db/data/
-helm/
-public/bundles/
-var/
-vendor/
+.env.test

.editorconfig

@@ -15,7 +15,7 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.{js,html}]
+[*.{js,html,ts,tsx}]
 indent_style = space
 indent_size = 2
 
@@ -43,10 +43,6 @@ indent_style = space
 indent_size = 4
 trim_trailing_whitespace = false
 
-[api/helm/api/**.yaml]
-indent_style = space
-indent_size = 2
-
 [.github/workflows/*.yml]
 indent_style = space
 indent_size = 2

Dockerfile

@@ -7,8 +7,23 @@
 ARG PHP_VERSION=8.1
 ARG CADDY_VERSION=2
 
-# "php" stage
-FROM php:${PHP_VERSION}-fpm-alpine AS symfony_php
+# Prod image
+FROM php:${PHP_VERSION}-fpm-alpine AS app_php
+
+# Allow to use development versions of Symfony
+ARG STABILITY="stable"
+ENV STABILITY ${STABILITY}
+
+# Allow to select Symfony version
+ARG SYMFONY_VERSION=""
+ENV SYMFONY_VERSION ${SYMFONY_VERSION}
+
+ENV UID=${USER_ID:-1000}
+ENV GID=${GROUP_ID:-1000}
+
+ENV APP_ENV=prod
+
+WORKDIR /srv/app
 
 # persistent / runtime deps
 RUN apk add --no-cache \
@@ -21,18 +36,14 @@ RUN apk add --no-cache \
 		bash \
 	;
 
-# install gnu-libiconv and set LD_PRELOAD env to make iconv work fully on Alpine image.
-# see https://github.com/docker-library/php/issues/240#issuecomment-763112749
-ENV LD_PRELOAD /usr/lib/preloadable_libiconv.so
-
 RUN set -xe \
 	&& apk add --no-cache --virtual .php-deps \
     make
 
-ARG APCU_VERSION=5.1.21
 RUN set -eux; \
 	apk add --no-cache --virtual .build-deps \
 		$PHPIZE_DEPS \
+		icu-data-full \
 		icu-dev \
 		libzip-dev \
 		zlib-dev \
@@ -44,7 +55,7 @@ RUN set -eux; \
 		zip \
 	; \
 	pecl install \
-		apcu-${APCU_VERSION} \
+		apcu \
 	; \
 	pecl clear-cache; \
 	docker-php-ext-enable \
@@ -58,85 +69,117 @@ RUN set -eux; \
 			| sort -u \
 			| awk 'system("[ -e /usr/local/lib/" $1 " ]") == 0 { next } { print "so:" $1 }' \
 	)"; \
-	apk add --no-cache --virtual .phpexts-rundeps $runDeps; \
+	apk add --no-cache --virtual .app-phpexts-rundeps $runDeps; \
 	\
 	apk del .build-deps
 
+###> recipes ###
+###< recipes ###
+
+RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
+COPY docker/php/conf.d/app.ini $PHP_INI_DIR/conf.d/
+COPY docker/php/conf.d/app.prod.ini $PHP_INI_DIR/conf.d/
+
+COPY docker/php/php-fpm.d/zz-docker.conf /usr/local/etc/php-fpm.d/zz-docker.conf
+RUN mkdir -p /var/run/php
+
 COPY docker/php/docker-healthcheck.sh /usr/local/bin/docker-healthcheck
 RUN chmod +x /usr/local/bin/docker-healthcheck
 
 HEALTHCHECK --interval=10s --timeout=3s --retries=3 CMD ["docker-healthcheck"]
 
-RUN ln -s $PHP_INI_DIR/php.ini-production $PHP_INI_DIR/php.ini
-COPY docker/php/conf.d/symfony.prod.ini $PHP_INI_DIR/conf.d/symfony.ini
-
-COPY docker/php/php-fpm.d/zz-docker.conf /usr/local/etc/php-fpm.d/zz-docker.conf
-
 COPY docker/php/docker-entrypoint.sh /usr/local/bin/docker-entrypoint
 RUN chmod +x /usr/local/bin/docker-entrypoint
 
-VOLUME /var/run/php
+RUN addgroup -S app_group --gid ${GID}
 
-COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
+RUN adduser \
+    --disabled-password \
+    --gecos "" \
+    --home "$(pwd)" \
+    --ingroup app_group \
+    --no-create-home \
+    --uid "$UID" \
+    app_user
+
+RUN rm -rf /srv/app/* && chown app_user:app_group -R /srv/app
+
+USER app_user
+
+RUN echo 'alias sf="php bin/console"' >> ~/.bashrc
+RUN echo 'alias phpunit="php vendor/bin/simple-phpunit"' >> ~/.bashrc
+RUN echo 'alias stan="php vendor/bin/phpstan"' >> ~/.bashrc
+
+ENTRYPOINT ["docker-entrypoint"]
+CMD ["php-fpm"]
+RUN bash
 
 # https://getcomposer.org/doc/03-cli.md#composer-allow-superuser
 ENV COMPOSER_ALLOW_SUPERUSER=1
-
 ENV PATH="${PATH}:/root/.composer/vendor/bin"
 
-WORKDIR /srv/app
+COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
 
-# Allow to choose skeleton
-ARG SKELETON="symfony/skeleton"
-ENV SKELETON ${SKELETON}
+# prevent the reinstallation of vendors at every changes in the source code
+COPY composer.* symfony.* ./
+RUN set -eux; \
+    if [ -f composer.json ]; then \
+		composer install --prefer-dist --no-dev --no-autoloader --no-scripts --no-progress; \
+		composer clear-cache; \
+    fi
 
-# Allow to use development versions of Symfony
-ARG STABILITY="stable"
-ENV STABILITY ${STABILITY}
+# copy sources
+COPY . .
 
-# Allow to select skeleton version
-ARG SYMFONY_VERSION=""
-ENV SYMFONY_VERSION ${SYMFONY_VERSION}
+RUN set -eux; \
+	mkdir -p var/cache var/log; \
+    if [ -f composer.json ]; then \
+		composer dump-autoload --classmap-authoritative --no-dev; \
+		composer dump-env prod; \
+		composer run-script --no-dev post-install-cmd; \
+		chmod +x bin/console; sync; \
+    fi
 
-# Download the Symfony skeleton and leverage Docker cache layers
-RUN composer create-project "${SKELETON} ${SYMFONY_VERSION}" . --stability=$STABILITY --prefer-dist --no-dev --no-progress --no-interaction; \
-	composer clear-cache
+# Dev image
+FROM app_php AS app_php_dev
 
-###> recipes ###
-###< recipes ###
+ENV APP_ENV=dev XDEBUG_MODE=off
+VOLUME /srv/app/var/
 
-COPY . .
+USER root
+
+RUN rm $PHP_INI_DIR/conf.d/app.prod.ini; \
+	mv "$PHP_INI_DIR/php.ini" "$PHP_INI_DIR/php.ini-production"; \
+	mv "$PHP_INI_DIR/php.ini-development" "$PHP_INI_DIR/php.ini"
+
+COPY docker/php/conf.d/app.dev.ini $PHP_INI_DIR/conf.d/
 
 RUN set -eux; \
-	mkdir -p var/cache var/log; \
-	composer install --prefer-dist --no-dev --no-progress --no-scripts --no-interaction; \
-	composer dump-autoload --classmap-authoritative --no-dev; \
-	composer symfony:dump-env prod; \
-	composer run-script --no-dev post-install-cmd; \
-	chmod +x bin/console; sync
-VOLUME /srv/app/var
+	apk add --no-cache --virtual .build-deps $PHPIZE_DEPS; \
+	pecl install xdebug; \
+	docker-php-ext-enable xdebug; \
+	apk del .build-deps
 
-RUN echo 'alias sf="php bin/console"' >> ~/.bashrc
-RUN echo 'alias phpunit="php vendor/bin/simple-phpunit"' >> ~/.bashrc
-RUN echo 'alias stan="php vendor/bin/phpstan"' >> ~/.bashrc
+RUN rm -f .env.local.php
 
-ENTRYPOINT ["docker-entrypoint"]
-CMD ["php-fpm"]
-RUN bash
+RUN chown app_user:app_group -R /srv/app
+
+USER app_user
 
-FROM caddy:${CADDY_VERSION}-builder-alpine AS symfony_caddy_builder
+# Build Caddy with the Mercure and Vulcain modules
+FROM caddy:${CADDY_VERSION}-builder-alpine AS app_caddy_builder
 
 RUN xcaddy build \
 	--with github.com/dunglas/mercure \
 	--with github.com/dunglas/mercure/caddy \
 	--with github.com/dunglas/vulcain \
 	--with github.com/dunglas/vulcain/caddy
 
-FROM caddy:${CADDY_VERSION} AS symfony_caddy
+# Caddy image
+FROM caddy:${CADDY_VERSION} AS app_caddy
 
 WORKDIR /srv/app
 
-COPY --from=dunglas/mercure:v0.11 /srv/public /srv/mercure-assets/
-COPY --from=symfony_caddy_builder /usr/bin/caddy /usr/bin/caddy
-COPY --from=symfony_php /srv/app/public public/
+COPY --from=app_caddy_builder /usr/bin/caddy /usr/bin/caddy
+COPY --from=app_php /srv/app/public public/
 COPY docker/caddy/Caddyfile /etc/caddy/Caddyfile

README.md

@@ -19,18 +19,20 @@ A [Docker](https://www.docker.com/)-based installer and runtime for the [Symfony
 ## Getting Started
 
 1. If not already done, [install Docker Compose](https://docs.docker.com/compose/install/)
-2. Run `docker-compose build --pull --no-cache` to build fresh images
-3. Run `docker-compose up` (the logs will be displayed in the current shell)
+2. Run `docker compose build --pull --no-cache` to build fresh images
+3. Run `docker compose up` (the logs will be displayed in the current shell)
 4. Open `https://localhost` in your favorite web browser and [accept the auto-generated TLS certificate](https://stackoverflow.com/a/15076602/1352334)
-5. Run `docker-compose down --remove-orphans` to stop the Docker containers.
+5. Run `docker compose down --remove-orphans` to stop the Docker containers.
 
 ## Features
 
 * Production, development and CI ready
+* [Installation of extra Docker Compose services](docs/extra-services.md) with Symfony Flex
 * Automatic HTTPS (in dev and in prod!)
 * HTTP/2, HTTP/3 and [Preload](https://symfony.com/doc/current/web_link.html) support
 * Built-in [Mercure](https://symfony.com/doc/current/mercure.html) hub
 * [Vulcain](https://vulcain.rocks) support
+* Native [XDebug](docs/xdebug.md) integration
 * Just 2 services (PHP FPM and Caddy server)
 * Super-readable configuration
 
@@ -42,7 +44,7 @@ A [Docker](https://www.docker.com/)-based installer and runtime for the [Symfony
 2. [Using Symfony Docker with an existing project](docs/existing-project.md)
 3. [Support for extra services](docs/extra-services.md)
 4. [Deploying in production](docs/production.md)
-5. [Installing Xdebug](docs/xdebug.md)
+5. [Debugging with Xdebug](docs/xdebug.md)
 6. [Using a Makefile](docs/makefile.md)
 7. [Troubleshooting](docs/troubleshooting.md)
 

docker-compose.override.yml

@@ -3,20 +3,25 @@ version: "3.4"
 # Development environment override
 services:
   php:
+    build:
+      target: app_php_dev
     volumes:
-      # The "cached" option has no effect on Linux but improves performance on Mac
-      - ./:/srv/app:rw,cached
-      - ./docker/php/conf.d/symfony.dev.ini:/usr/local/etc/php/conf.d/symfony.ini
-      # If you develop on Mac you can remove the var/ directory from the bind-mount
-      # for better performance by enabling the next line 
-      # - /srv/app/var
+      - ./:/srv/app
+      - ./docker/php/conf.d/app.dev.ini:/usr/local/etc/php/conf.d/app.dev.ini:ro
+      # If you develop on Mac or Windows you can remove the vendor/ directory
+      #  from the bind-mount for better performance by enabling the next line:
+      #- /srv/app/vendor
     environment:
-      APP_ENV: dev
+      # See https://xdebug.org/docs/all_settings#mode 
+      XDEBUG_MODE: "${XDEBUG_MODE:-off}"
+    extra_hosts:
+      # Ensure that host.docker.internal is correctly defined on Linux
+      - host.docker.internal:host-gateway
 
   caddy:
     volumes:
-      - ./docker/caddy/Caddyfile:/etc/caddy/Caddyfile:ro
       - ./public:/srv/app/public:ro
+      - ./docker/caddy/Caddyfile:/etc/caddy/Caddyfile:ro
 
 ###> symfony/mercure-bundle ###
 ###< symfony/mercure-bundle ###

docker-compose.prod.yml

@@ -4,7 +4,6 @@ version: "3.4"
 services:
   php:
     environment:
-      APP_ENV: prod
       APP_SECRET: ${APP_SECRET}
       MERCURE_JWT_SECRET: ${CADDY_MERCURE_JWT_SECRET}
 

docker-compose.yml

@@ -5,10 +5,9 @@ services:
     container_name: symfony-php
     build:
       context: .
-      target: symfony_php
+      target: app_php
       args:
         SYMFONY_VERSION: ${SYMFONY_VERSION:-}
-        SKELETON: ${SKELETON:-symfony/skeleton}
         STABILITY: ${STABILITY:-stable}
         USER_ID: ${USER_ID:-1000}
         GROUP_ID: ${GROUP_ID:-1000}
@@ -22,7 +21,7 @@ services:
       start_period: 30s
     environment:
       # Run "composer require symfony/orm-pack" to install and configure Doctrine ORM
-      DATABASE_URL: postgresql://${POSTGRES_USER:-symfony}:${POSTGRES_PASSWORD:-ChangeMe}@database:5432/${POSTGRES_DB:-app}?serverVersion=${POSTGRES_VERSION:-13}
+      DATABASE_URL: postgresql://${POSTGRES_USER:-app}:${POSTGRES_PASSWORD:-!ChangeMe!}@database:5432/${POSTGRES_DB:-app}?serverVersion=${POSTGRES_VERSION:-14}
       # Run "composer require symfony/mercure-bundle" to install and configure the Mercure integration
       MERCURE_URL: ${CADDY_MERCURE_URL:-http://caddy/.well-known/mercure}
       MERCURE_PUBLIC_URL: https://${SERVER_NAME:-localhost}/.well-known/mercure
@@ -31,7 +30,7 @@ services:
   caddy:
     build:
       context: .
-      target: symfony_caddy
+      target: app_caddy
     depends_on:
       - php
     environment:

docker/caddy/Caddyfile

@@ -1,12 +1,6 @@
 {
     # Debug
     {$DEBUG}
-    # HTTP/3 support
-    servers {
-        protocol {
-            experimental_http3
-        }
-    }
 }
 
 {$SERVER_NAME}

docker/php/conf.d/app.dev.ini

@@ -0,0 +1,5 @@
+; See https://docs.docker.com/desktop/networking/#i-want-to-connect-from-a-container-to-a-service-on-the-host
+; See https://github.com/docker/for-linux/issues/264
+; The `client_host` below may optionally be replaced with `discover_client_host=yes`
+; Add `start_with_request=yes` to start debug session on each request
+xdebug.client_host = 'host.docker.internal'