You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: distribution/index.md
+6-7Lines changed: 6 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -66,9 +66,13 @@ it.
66
66
API Platform is shipped with a [Docker](https://docker.com) setup that makes it easy to get a containerized development
67
67
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/).
68
68
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
+
69
72
Open a terminal, and navigate to the directory containing your project skeleton. Run the following command to start all
70
73
services using [Docker Compose](https://docs.docker.com/compose/):
71
74
75
+
$ docker-compose pull # Download the latest versions of the pre-built images
72
76
$ docker-compose up -d # Running in detached mode
73
77
74
78
This starts the following services:
@@ -83,11 +87,6 @@ This starts the following services:
83
87
| cache-proxy | A HTTP cache proxy for the API provided by Varnish | 8081 | all (prefer using a managed service in prod)
84
88
| 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)
85
89
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
-
91
90
To see the container's logs, run:
92
91
93
92
$ docker-compose logs -f # follow the logs
@@ -151,7 +150,7 @@ And start the built-in PHP server or the Symfony WebServerBundle:
151
150
All JavaScript components are also [available as standalone libraries](https://github.com/api-platform?language=javascript)
152
151
installable with NPM or Yarn.
153
152
154
-
**Note:** when installing API Platform this way, the API will be exposed as the `/api/` path. You need to open `http://localhost:8000/api/` to see the API documentation.
153
+
**Note:** when installing API Platform this way, the API will be exposed as the `/api/` path. You need to open `http://localhost:8000/api/` to see the API documentation. If you are deploying API Platform directly on an Apache or Nginx webserver and getting a 404 error on opening this link, you will need to enable the [rewriting rules](https://symfony.com/doc/current/setup/web_server_configuration.html) for your specific webserver software.
155
154
156
155
## It's Ready!
157
156
@@ -647,7 +646,7 @@ Isn't API Platform a REST **and** GraphQL framework? That's true! GraphQL suppor
647
646
need to install the [graphql-php](https://webonyx.github.io/graphql-php/) library. Run the following command (the cache needs to be cleared twice):
0 commit comments