Glebaster/forum
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve README.md

Browse Source
This commit is contained in:
Kévin Dunglas 2018-11-06 10:55:50 +01:00 committed by GitHub
parent 66ff768285
commit ccda890260
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,6 +1,6 @@
# Symfony Docker # Symfony Docker
A [Docker](https://www.docker.com/)-based installer and runtime for the [Symfony](https://symfony.com) web framework. A [Docker](https://www.docker.com/)-based installer and runtime for the [Symfony](https://symfony.com) web framework, with full [HTTP/2](https://symfony.com/doc/current/weblink.html) and HTTPS support.
## Getting Started ## Getting Started
@ -21,13 +21,14 @@ The value must be [a valid Composer stability option](https://getcomposer.org/do
For instance, use the following command to use the `master` branch of Symfony: For instance, use the following command to use the `master` branch of Symfony:
`STABILITY=dev docker-compose up --build` ```bash
STABILITY=dev docker-compose up --build
```
## Debugging ## Debugging
The default Docker stack is shipped without a Xdebug stage. It's easy The default Docker stack is shipped without a Xdebug stage.
though to add [Xdebug](https://xdebug.org/) to your project, for development It's easy though to add [Xdebug](https://xdebug.org/) to your project, for development purposes such as debugging tests or API requests remotely.
purposes such as debugging tests or API requests remotely.
### Add a Development Stage to the Dockerfile ### Add a Development Stage to the Dockerfile
@ -48,8 +49,7 @@ RUN set -eux; \
### Configure Xdebug with Docker Compose Override ### Configure Xdebug with Docker Compose Override
Using an [override](https://docs.docker.com/compose/reference/overview/#specifying-multiple-compose-files) Using an [override](https://docs.docker.com/compose/reference/overview/#specifying-multiple-compose-files) file named `docker-compose.override.yaml` ensures that the production
file named `docker-compose.override.yaml` ensures that the production
configuration remains untouched. configuration remains untouched.
As example, an override could look like this: As example, an override could look like this:
@ -76,15 +76,15 @@ services:
PHP_IDE_CONFIG: serverName=symfony-docker PHP_IDE_CONFIG: serverName=symfony-docker
``` ```
And run : Then run:
````bash ````bash
docker-compose -f docker-compose.yaml -f docker-compose.override.yaml up -d docker-compose -f docker-compose.yaml -f docker-compose.override.yaml up -d
```` ````
### Troubleshooting ### Troubleshooting
Inspect the installation with the following command. The requested Xdebug Inspect the installation with the following command. The requested Xdebug version should be displayed in the output.
version should be displayed in the output.
```bash ```bash
$ docker-compose exec php php --version $ docker-compose exec php php --version