Skip to content

Commit 24a1352

Browse files
authored
Docs for the new Docker setup (#1786)
* Docs for the new Docker setup * fix linter
1 parent 155e5e7 commit 24a1352

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

core/bootstrap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Bootstraping the core library
22

3-
You may want to run a minimal version of API Platform. This one file runs API Platform (without graphql, doctrine and mongodb).
3+
You may want to run a minimal version of API Platform. This one file runs API Platform (without GraphQL, Doctrine and MongoDB).
44
It requires the following composer packages:
55

66
```console

core/performance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ To configure Blackfire.io follow these simple steps:
396396

397397
```console
398398
docker compose build
399-
docker compose up -d
399+
docker compose up --wait
400400
```
401401

402402
For details on how to perform profiling, see [the Blackfire.io documentation](https://blackfire.io/docs/integrations/docker#using-the-client-for-http-profiling).

deployment/docker-compose.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ SERVER_NAME=your-domain-name.example.com \
7373
APP_SECRET=ChangeMe \
7474
POSTGRES_PASSWORD=ChangeMe \
7575
CADDY_MERCURE_JWT_SECRET=ChangeMe \
76-
docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d
76+
docker compose -f docker-compose.yml -f docker-compose.prod.yml up --wait
7777
```
7878

7979
Be sure to replace `your-domain-name.example.com` with your actual domain name and to set the values of `APP_SECRET`, `CADDY_MERCURE_JWT_SECRET` to cryptographically secure random values.

deployment/kubernetes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ If you do not have gcloud yet, install it with these command.
3636
Versioning: The 0.1.0 is the version. This value should be the same as the attribute `appVersion` in `Chart.yaml`.
3737
Infos for [Google Container pulling and pushing](https://cloud.google.com/container-registry/docs/pushing-and-pulling)
3838

39-
docker build -t gcr.io/test-api-platform/php:0.1.0 -t gcr.io/test-api-platform/php:latest api --target app_php
40-
docker build -t gcr.io/test-api-platform/caddy:0.1.0 -t gcr.io/test-api-platform/caddy:latest api --target app_caddy
39+
docker build -t gcr.io/test-api-platform/php:0.1.0 -t gcr.io/test-api-platform/php:latest api --target php_prod
40+
docker build -t gcr.io/test-api-platform/caddy:0.1.0 -t gcr.io/test-api-platform/caddy:latest api --target caddy_prod
4141
docker build -t gcr.io/test-api-platform/pwa:0.1.0 -t gcr.io/test-api-platform/pwa:latest pwa --target prod
4242

4343
#### 2. Push your images to your Docker registry

distribution/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,10 @@ docker compose pull --include-deps
8282
Then build images and Start Docker Compose in detached mode:
8383

8484
```console
85-
docker compose up -d
85+
docker compose up --wait
8686
```
8787

88-
**Tip:** be sure that the ports `80`, `443` and `5432` of the host are not already in use. The usual offenders are Apache, NGINX and Postgres. If they are running, stop them and run `docker compose up -d` again.
88+
**Tip:** be sure that the ports `80`, `443` and `5432` of the host are not already in use. The usual offenders are Apache, NGINX and Postgres. If they are running, stop them and run `docker compose up --wait` again.
8989

9090
This starts the following services:
9191

@@ -101,8 +101,8 @@ The following components are available:
101101
| URL | Path | Language | Description |
102102
|----------------------------|--------------------|------------|-------------------------|
103103
| `https://localhost/docs/` | `api/` | PHP | The API |
104-
| `https://localhost/` | `pwa/` | JavaScript | The Next.js application |
105-
| `https://localhost/admin/` | `pwa/pages/admin/` | JavaScript | The Admin |
104+
| `https://localhost/` | `pwa/` | TypeScript | The Next.js application |
105+
| `https://localhost/admin/` | `pwa/pages/admin/` | TypeScript | The Admin |
106106

107107
To see the container's logs, run:
108108

@@ -186,7 +186,7 @@ And start the built-in PHP server:
186186
symfony serve
187187
```
188188

189-
All JavaScript components are also [available as standalone libraries](https://github.com/api-platform?language=javascript)
189+
All TypeScript components are also [available as standalone libraries](https://github.com/api-platform?language=typescript)
190190
installable with npm (or any other package manager).
191191

192192
**Note:** when installing API Platform this way, the API will be exposed at the `/api/` path. You need to open `http://localhost:8000/api/` to see the API documentation.

0 commit comments

Comments
 (0)