Skip to content

Commit 969b95d

Browse files
authored
Improve the Docker-related parts of the Getting Started guide (#699)
* Improve the Docker-related parts of the Getting Started guide * Update index.md
1 parent 1fb40ed commit 969b95d

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

distribution/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,13 @@ it.
6666
API Platform is shipped with a [Docker](https://docker.com) setup that makes it easy to get a containerized development
6767
environment up and running. If you do not already have Docker on your computer, [it's the right time to install it](https://docs.docker.com/install/).
6868

69+
On Mac, only [Docker for Mac](https://docs.docker.com/docker-for-mac/) is supported.
70+
Similarly, on Windows, only [Docker for Windows](https://docs.docker.com/docker-for-windows/) is supported. Docker Machine **is not** supported out of the box.
71+
6972
Open a terminal, and navigate to the directory containing your project skeleton. Run the following command to start all
7073
services using [Docker Compose](https://docs.docker.com/compose/):
7174

75+
$ docker-compose pull # Download the latest versions of the pre-built images
7276
$ docker-compose up -d # Running in detached mode
7377

7478
This starts the following services:
@@ -83,11 +87,6 @@ This starts the following services:
8387
| cache-proxy | A HTTP cache proxy for the API provided by Varnish | 8081 | all (prefer using a managed service in prod)
8488
| h2-proxy | A HTTP/2 and HTTPS development proxy for all apps | 443 (client)<br>444 (admin)<br>8443 (api)<br>8444 (cache-proxy) | dev (configure properly your web server in prod)
8589

86-
If you encounter problems running Docker on Windows (especially with Docker Toolbox), see [our Troubleshooting guide](../extra/troubleshooting.md#using-docker).
87-
88-
The first time you start the containers, Docker downloads and builds images for you. It will take some time, but don't worry,
89-
this is done only once. Starting servers will then be lightning fast.
90-
9190
To see the container's logs, run:
9291

9392
$ docker-compose logs -f # follow the logs

0 commit comments

Comments
 (0)