init

docs/mysql.md

@@ -0,0 +1,107 @@
+# 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:
+
+```console
+docker compose exec php composer req symfony/orm-pack
+```
+
+## Docker Configuration
+
+Change the database image to use MySQL instead of PostgreSQL in `compose.yaml`:
+
+<!-- markdownlint-disable MD013 -->
+
+```diff
+ ###> doctrine/doctrine-bundle ###
+-    image: postgres:${POSTGRES_VERSION:-16}-alpine
++    image: mysql:${MYSQL_VERSION:-8.0.32}
+     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}
+     healthcheck:
+-      test: ["CMD", "pg_isready", "-d", "${POSTGRES_DB:-app}", "-U", "${POSTGRES_USER:-app}"]
++      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
+       timeout: 5s
+       retries: 5
+       start_period: 60s
+     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 ###
+```
+
+<!-- markdownlint-enable MD013 -->
+
+Depending on the database configuration,
+modify the environment in the same file at `services.php.environment.DATABASE_URL`:
+
+```yaml
+DATABASE_URL: mysql://${MYSQL_USER:-app}:${MYSQL_PASSWORD:-!ChangeMe!}@database:3306/${MYSQL_DATABASE:-app}?serverVersion=${MYSQL_VERSION:-8.0.32}&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.0.32}&charset=${MYSQL_CHARSET:-utf8mb4}
+```
+
+## Final steps
+
+Rebuild the Docker environment:
+
+```console
+docker compose down --remove-orphans && docker compose build --pull --no-cache
+```
+
+Start the services:
+
+```console
+docker compose up --wait
+```
+
+Test your setup:
+
+<!-- markdownlint-disable MD013 -->
+
+```console
+docker compose exec php bin/console dbal:run-sql -q "SELECT 1" && echo "OK" || echo "Connection is not working"
+```
+
+<!-- markdownlint-enable MD013 -->