diff --git a/deployment/traefik.md b/deployment/traefik.md index 18d5df85f12..5b736c3393c 100644 --- a/deployment/traefik.md +++ b/deployment/traefik.md @@ -6,7 +6,7 @@ ## Basic Implementation -This tutorial will help you to define your own routes for your client, api and more generally for your containers. +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 ports and add labels to tell Træfik to listen on the routes mentioned and redirect routes to a specified container. @@ -14,7 +14,7 @@ ports and add labels to tell Træfik to listen on the routes mentioned and redir A few points to note: * `--api.insecure=true` Tells Træfik to generate a browser view to watch containers and IP/DNS associated easier -* `--providers.docker` Tells Træfik to listen on Docker Api +* `--providers.docker` Tells Træfik to listen on Docker API * `labels:` Key for Træfik configuration into Docker integration ```yaml diff --git a/extra/security.md b/extra/security.md index 2323224bf6c..df722d517fa 100644 --- a/extra/security.md +++ b/extra/security.md @@ -47,7 +47,7 @@ Scores from the following areas are added together to produce a score. The score * Integrity: Does this vulnerability cause non-public data to be accessible? If so, does the attacker have control over the data disclosed? (0-4) * Disclosure: Can this exploit allow system data (or data handled by the system) to be compromised? If so, does the attacker have control over modification? (0-4) -* Code Execution: Does the vulnerability allow arbitrary code to be executed on an end-users system, or the server that it runs on? (0-4) +* Code Execution: Does the vulnerability allow arbitrary code to be executed on an end users system, or the server that it runs on? (0-4) * Availability: Is the availability of a service or application affected? Is it reduced availability or total loss of availability of a service / application? Availability includes networked services (e.g., databases) or resources such as consumption of network bandwidth, processor cycles, or disk space. (0-4) ### Affected Projects diff --git a/extra/troubleshooting.md b/extra/troubleshooting.md index 60f74a87843..a492cd096d1 100644 --- a/extra/troubleshooting.md +++ b/extra/troubleshooting.md @@ -12,7 +12,7 @@ Docker Toolbox is not supported anymore by API Platform. Please upgrade to [Dock If the `php` container cannot start and display this `Error starting userland proxy: Bind for 0.0.0.0:80`, it means that port 80 is already in use. You can check to see which processes are currently listening on certain ports. -Find out if any service listens on port 80. You can use this command on UNIX-based OSes like MacOS and Linux: +Find out if any service listens on port 80. You can use this command on UNIX-based OSes like macOS and Linux: ```console sudo lsof -n -i :80 | grep LISTEN @@ -46,9 +46,9 @@ The JMS Serializer service is available as `jms_serializer`. ## "upstream sent too big header while reading response header from upstream" NGINX 502 Error -Some of your API calls fail with a 502 error and the logs for the api container shows the following error message `upstream sent too big header while reading response header from upstream`. +Some of your api calls fail with a 502 error and the logs for the api container shows the following error message `upstream sent too big header while reading response header from upstream`. -This can be due to the cache invalidation headers that are too big for NGINX. When you query the API, API Platform adds the ids of all returned entities and their dependencies in the headers like so : `Cache-Tags: /entity/1,/dependent_entity/1,/entity/2`. This can overflow the default header size (4k) when your API gets larger and more complex. +This can be due to the cache invalidation headers that are too big for NGINX. When you query the API, API Platform adds the IDs of all returned entities and their dependencies in the headers like so : `Cache-Tags: /entity/1,/dependent_entity/1,/entity/2`. This can overflow the default header size (4k) when your API gets larger and more complex. You can modify the `api/docker/nginx/conf.d/default.conf` file and set values to `fastcgi_buffer_size` and `fastcgi_buffers` that suit your needs, like so: diff --git a/schema-generator/index.md b/schema-generator/index.md index a228e6b79d9..7b89930668a 100644 --- a/schema-generator/index.md +++ b/schema-generator/index.md @@ -1,6 +1,6 @@ # The Schema Generator -`schema` is a command line tool part of [the API Platform framework](https://api-platform.com) that instantly generates a set +`schema` is a command-line tool part of [the API Platform framework](https://api-platform.com) that instantly generates a set of PHP classes from [RDF](https://en.wikipedia.org/wiki/Resource_Description_Framework) vocabularies such as (but not limited to) [Schema.org](https://schema.org) or [ActivityStreams](https://www.w3.org/TR/activitystreams-core/). Alternatively, it can generate PHP classes from an [OpenAPI](https://www.openapis.org/) documentation.