Rename docker-compose.yml in compose.yaml

Author: dunglas

core/mongodb.md

@@ -43,8 +43,10 @@ docker compose build php
 Add a MongoDB image to the docker-compose file:
 
 ```yaml
-# docker-compose.yml
-# ...
+# compose.yaml
+
+services:
+  # ...
   db-mongodb:
       # In production, you may want to use a managed database service
       image: mongo

core/performance.md

@@ -355,9 +355,11 @@ Blackfire.io allows you to monitor the performance of your applications. For mor
 
 To configure Blackfire.io follow these simple steps:
 
-1. Add the following to your `docker-compose.override.yml` file:
+1. Add the following to your `compose.override.yaml` file:
 
 ```yaml
+services:
+    # ...
     blackfire:
         image: blackfire/blackfire:2
         environment:

deployment/docker-compose.md

@@ -68,7 +68,7 @@ SERVER_NAME=your-domain-name.example.com \
 APP_SECRET=ChangeMe \
 POSTGRES_PASSWORD=ChangeMe \
 CADDY_MERCURE_JWT_SECRET=ChangeThisMercureHubJWTSecretKey \
-docker compose -f docker-compose.yml -f docker-compose.prod.yml up --wait
+docker compose -f compose.yaml -f compose.prod.yaml up --wait
 ```
 
 Be sure to replace `your-domain-name.example.com` by your actual domain name and to set the values of `APP_SECRET`, `CADDY_MERCURE_JWT_SECRET` to cryptographically secure random values.
@@ -84,7 +84,7 @@ Alternatively, if you don't want to expose an HTTPS server but only an HTTP one,
 SERVER_NAME=:80 \
 APP_SECRET=ChangeMe \
 CADDY_MERCURE_JWT_SECRET=ChangeThisMercureHubJWTSecretKey \
-docker compose -f docker-compose.yml -f docker-compose.prod.yml up --wait
+docker compose -f -compose.yaml -f compose.prod.yaml up --wait
 ```
 
 ## Deploying on Multiple Nodes

deployment/traefik.md

@@ -8,7 +8,7 @@
 
 This tutorial will help you to define your own routes for your client, API and more generally for your containers.
 
-Use this custom API Platform `docker-compose.yml` file which implements ready-to-use Træfik container configuration. Override
+Use this custom API Platform `compose.yaml` file which implements ready-to-use Træfik container configuration. Override
 ports and add labels to tell Træfik to listen on the routes mentioned and redirect routes to a specified container.
 
 A few points to note:
@@ -39,7 +39,7 @@ Then you edited your `admin/Dockerfile` and `client/Dockerfile` like this:
 After that, don't forget to re-build your containers
 
 ```yaml
-# docker-compose.yml
+# compose.yaml
 version: '3.4'
 
 x-cache-from:
@@ -190,12 +190,12 @@ If your network is of type B, it may conflict with the Træfik sub-network.
 
 ## Going Further
 
-As this Træfik configuration listens on 80 and 443 ports, you can run only 1 Træfik instance per server. However, you may want to run multiple API Platform projects on the same server. To deal with it, you'll have to externalize the Træfik configuration to another `docker-compose.yml` file, anywhere on your server.
+As this Træfik configuration listens on 80 and 443 ports, you can run only 1 Træfik instance per server. However, you may want to run multiple API Platform projects on the same server. To deal with it, you'll have to externalize the Træfik configuration to another `compose.yaml` file, anywhere on your server.
 
 Here is a working example:
 
 ```yaml
-# /somewhere/docker-compose.yml
+# /somewhere/compose.yaml
 version: '3.4'
 
 services:
@@ -224,10 +224,10 @@ networks:
   # Add other networks here
 ```
 
-Then update the `docker-compose.yml` file belonging to your API Platform projects:
+Then update the `compose.yaml` file belonging to your API Platform projects:
 
 ```diff
-# /anywhere/api-platform/docker-compose.yml
+# /anywhere/api-platform/compose.yaml
 version: '3.4'
 
 x-cache:
@@ -438,7 +438,7 @@ RANDOM_UNIQUE_KEY=yourUniqueKeyForYourSecondInstance
 Then update each traefik http routers names and services following this sample for admin
 
 ```yaml
-# /anywhere/first/api-plaform/docker-compose.yml
+# /anywhere/first/api-plaform/compose.yaml
 # ...
     labels:
       - traefik.http.routers.admin-${RANDOM_UNIQUE_KEY}.rule=Host(`admin.${DOMAIN_NAME}`)
@@ -450,7 +450,7 @@ Then update each traefik http routers names and services following this sample f
 Here is a fully working sample for Træfik generic config with a little script using docker-compose override approach.  
 We assume that you've set `EXPOSE 3000` in your client and admin Dockerfile.
 
-Create a new `init-dc.sh` which contains the generation code that will be written in `docker-compose.override.yaml` file.
+Create a new `init-dc.sh` which contains the generation code that will be written in `compose.override.yaml` file.
 
 ```bash
 #!/bin/sh
@@ -475,7 +475,7 @@ for k in "${services[@]}" ; do
 "
 done
 
-echo "$text" > ./docker-compose.override.yml
+echo "$text" > ./compose.override.yaml
 ```
 
 Write this minimal configuration into your `traefik.toml` file:
@@ -502,10 +502,10 @@ Write this minimal configuration into your `traefik.toml` file:
   address = ":443"
 ```
 
-Then after that update respectively your API Platform and Træfik `docker-compose.yml` following these examples below.
+Then after that update respectively your API Platform and Træfik `compose.yaml` following these examples below.
 
 ```yaml
-# /anywhere/api-platform/docker-compose.yml
+# /anywhere/api-platform/compose.yaml
 version: '3.4'
 
 x-cache:
@@ -640,7 +640,7 @@ networks:
 ```
 
 ```yaml
-# /anywhere/traefik/docker-compose.yml
+# /anywhere/traefik/compose.yaml
 version: '3.4'
 
 x-network:

distribution/debugging.md

@@ -27,43 +27,11 @@ RUN set -eux; \
 
 ## Configure Xdebug with Docker Compose Override
 
-Using an [override](https://docs.docker.com/compose/reference/overview/#specifying-multiple-compose-files) file named
-`docker-compose.override.yml` ensures that the production configuration remains untouched.
-
-As an example, an override could look like this:
-
-```yml
-version: "3.4"
-
-services:
-  php:
-    build:
-      target: api_platform_php_dev
-    environment:
-      # See https://docs.docker.com/docker-for-mac/networking/#i-want-to-connect-from-a-container-to-a-service-on-the-host
-      # See https://github.com/docker/for-linux/issues/264
-      # The `remote_host` below may optionally be replaced with `remote_connect_back`
-      # XDEBUG_MODE required for step debugging
-      XDEBUG_MODE: debug
-      # default port for Xdebug 3 is 9003
-      # idekey=VSCODE if you are debugging with VSCode
-      XDEBUG_CONFIG: >-
-        client_host=host.docker.internal
-        idekey=PHPSTORM 
-      # This should correspond to the server declared in PHPStorm `Preferences | Languages & Frameworks | PHP | Servers`
-      # Then PHPStorm will use the corresponding path mappings
-      PHP_IDE_CONFIG: serverName=api-platform
-```
-
-Note for Mac environments use the following:
-
-```yml
-      XDEBUG_CONFIG: >-
-        idekey=PHPSTORM
-        client_host=docker.for.mac.localhost
-```
+XDebug is shipped by default with the API Platform distribution.
+To enable it, run: `XDEBUG_MODE=debug docker compose up --wait`
 
-In VSCode, alongside the default PHP configuration in `launch.json`, you'll need path mappings for the Docker image.
+If you are using VSCode, use the following `launch.json` to debug.
+Note that this configuration includes the path mappings for the Docker image.
 
 ```json
 {
@@ -83,7 +51,8 @@ In VSCode, alongside the default PHP configuration in `launch.json`, you'll need
 }
 ```
 
-Note: For Linux environments, the `client_host` setting of `host.docker.internal` will not work, you will need the actual local IP address of your computer.
+Note: On Linux, the `client_host` setting of `host.docker.internal` may not work.
+In this case you will need the actual local IP address of your computer.
 
 ## Troubleshooting
 

extra/troubleshooting.md

@@ -24,7 +24,9 @@ On Windows, you can use `netstat`. This will give you all TCP/IP network connect
 netstat -a -b
 ```
 
-You can change the port to be used in the `docker-compose.yml` file (default is port 80).
+The same problem may occur for port 443. In this case, follow the same steps but replace 80 by 443.
+
+You can change the port to be used in the `compose.yaml` file (default ports are 443 and 80).
 
 ## Using API Platform and JMS Serializer in the same project