Merge branch 'main' into feat/super-linter

Author: dunglas

README.md

@@ -37,8 +37,9 @@ with [FrankenPHP](https://frankenphp.dev) and [Caddy](https://caddyserver.com/)
 5. [Debugging with Xdebug](docs/xdebug.md)
 6. [TLS Certificates](docs/tls.md)
 7. [Using a Makefile](docs/makefile.md)
-8. [Troubleshooting](docs/troubleshooting.md)
-9. [Updating the template](docs/updating.md)
+8. [Using MySQL instead of PostgreSQL](docs/mysql.md)
+9. [Troubleshooting](docs/troubleshooting.md)
+10. [Updating the template](docs/updating.md)
 
 ## License
 

docs/extra-services.md

@@ -8,5 +8,11 @@ The currently supported packages are:
 * `symfony/orm-pack`: install a PostgreSQL service
 * `symfony/mercure-bundle`: use the Mercure.rocks module shipped with Caddy
 * `symfony/panther`: install chromium and these drivers
-* `symfony/mailer`: install a MailCatcher service
+* `symfony/mailer`: install a Mailpit service
 * `blackfireio/blackfire-symfony-meta`: install a Blackfire service
+
+> [!NOTE]
+> If a recipe modifies the Dockerfile, the container needs to be rebuilt.
+
+> [!WARNING]
+> We recommend that you use the `composer require` command inside the container in development mode so that recipes can be applied correctly

docs/mysql.md

@@ -0,0 +1,72 @@
+# Using MySQL
+
+The Docker configuration of this repository is extensible thanks to Flex recipes. By default, the recipe installs PostgreSQL.
+If you prefer to work with MySQL, follow these steps:
+
+First, install the `symfony/orm-pack` package as described: `docker compose exec php composer req symfony/orm-pack`
+
+## Docker Configuration
+Change the database image to use MySQL instead of PostgreSQL in `compose.yaml`:
+
+```diff
+###> doctrine/doctrine-bundle ###
+-   image: postgres:${POSTGRES_VERSION:-15}-alpine
++   image: mysql:${MYSQL_VERSION:-8}
+    environment:
+-     POSTGRES_DB: ${POSTGRES_DB:-app}
++     MYSQL_DATABASE: ${MYSQL_DATABASE:-app}
+      # You should definitely change the password in production
++     MYSQL_RANDOM_ROOT_PASSWORD: "true"
+-     POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-!ChangeMe!}
++     MYSQL_PASSWORD: ${MYSQL_PASSWORD:-!ChangeMe!}
+-     POSTGRES_USER: ${POSTGRES_USER:-app}
++     MYSQL_USER: ${MYSQL_USER:-app}
+    volumes:
+-     - database_data:/var/lib/postgresql/data:rw
++     - database_data:/var/lib/mysql:rw
+      # You may use a bind-mounted host directory instead, so that it is harder to accidentally remove the volume and lose all your data!
+-     # - ./docker/db/data:/var/lib/postgresql/data:rw
++     # - ./docker/db/data:/var/lib/mysql:rw
+###< doctrine/doctrine-bundle ###
+```
+
+Depending on the database configuration, modify the environment in the same file at `services.php.environment.DATABASE_URL`
+```
+DATABASE_URL: mysql://${MYSQL_USER:-app}:${MYSQL_PASSWORD:-!ChangeMe!}@database:3306/${MYSQL_DATABASE:-app}?serverVersion=${MYSQL_VERSION:-8}&charset=${MYSQL_CHARSET:-utf8mb4}
+```
+
+Since we changed the port, we also have to define this in the `compose.override.yaml`:
+```diff
+###> doctrine/doctrine-bundle ###
+  database:
+    ports:
+-     - "5432"
++     - "3306"
+###< doctrine/doctrine-bundle ###
+```
+
+Last but not least, we need to install the MySQL driver in `Dockerfile`:
+```diff
+###> doctrine/doctrine-bundle ###
+-RUN install-php-extensions pdo_pgsql
++RUN install-php-extensions pdo_mysql
+###< doctrine/doctrine-bundle ###
+```
+
+## Change Environment
+Change the database configuration in `.env`:
+
+```dotenv 
+DATABASE_URL=mysql://${MYSQL_USER:-app}:${MYSQL_PASSWORD:-!ChangeMe!}@database:3306/${MYSQL_DATABASE:-app}?serverVersion=${MYSQL_VERSION:-8}&charset=${MYSQL_CHARSET:-utf8mb4}
+```
+
+## Final steps
+Rebuild the docker environment:
+```shell
+docker compose down --remove-orphans && docker compose build --pull --no-cache
+```
+
+Test your setup:
+```shell
+docker compose exec php bin/console dbal:run-sql -q "SELECT 1" && echo "OK" || echo "Connection is not working"
+```

docs/troubleshooting.md

@@ -6,7 +6,13 @@ If you work on linux and cannot edit some of the project files right after the f
 
 ## HTTPS and Redirects
 
-If Symfony is generating an internal redirect for an `https://` URL, but the resulting URL is `http://`, you have to uncomment the `TRUSTED_PROXIES` setting in your `.env` file.
+If Symfony is generating an internal redirect for an `https://` URL, but the resulting URL is `http://`, you have to uncomment the `TRUSTED_PROXIES` setting in your `.env` file and add this line in `config/packages/framework.yaml`:
+```
+# config/packages/framework.yaml
+framework:
+    trusted_proxies: '%env(TRUSTED_PROXIES)%'
+```
+
 For more details see the [Symfony internal redirect documentation](https://symfony.com/doc/current/routing.html#redirecting-to-urls-and-routes-directly-from-a-route).
 
 ## TLS/HTTPS Issues

docs/updating.md

@@ -6,7 +6,7 @@ To import the changes made to the *Symfony Docker* template into your project, w
 1. Run the script to synchronize your project with the latest version of the skeleton:
 
     ```console
-    curl -sSL https://raw.githubusercontent.com/mano-lis/template-sync/main/template-sync.sh | sh -s -- https://github.com/dunglas/symfony-docker
+    curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- https://github.com/dunglas/symfony-docker
     ```
 
 2. Resolve conflicts, if any

frankenphp/Caddyfile

@@ -27,7 +27,7 @@
 	}
 
 	root * /app/public
-	encode zstd gzip
+	encode zstd br gzip
 
 	mercure {
 		# Transport to use (default to Bolt)