Merge pull request #923 from ptreyes/some_grammar_fixes

Some essential grammar fixes.
This commit is contained in:
Tianon Gravi 2017-06-05 09:17:53 -07:00 committed by GitHub
commit e384363d3b
1 changed files with 13 additions and 13 deletions

View File

@ -1,4 +1,4 @@
# What is Nginx? # What is nginx?
Nginx (pronounced "engine-x") is an open source reverse proxy server for HTTP, HTTPS, SMTP, POP3, and IMAP protocols, as well as a load balancer, HTTP cache, and a web server (origin server). The nginx project started with a strong focus on high concurrency, high performance and low memory usage. It is licensed under the 2-clause BSD-like license and it runs on Linux, BSD variants, Mac OS X, Solaris, AIX, HP-UX, as well as on other *nix flavors. It also has a proof of concept port for Microsoft Windows. Nginx (pronounced "engine-x") is an open source reverse proxy server for HTTP, HTTPS, SMTP, POP3, and IMAP protocols, as well as a load balancer, HTTP cache, and a web server (origin server). The nginx project started with a strong focus on high concurrency, high performance and low memory usage. It is licensed under the 2-clause BSD-like license and it runs on Linux, BSD variants, Mac OS X, Solaris, AIX, HP-UX, as well as on other *nix flavors. It also has a proof of concept port for Microsoft Windows.
@ -8,7 +8,7 @@ Nginx (pronounced "engine-x") is an open source reverse proxy server for HTTP, H
# How to use this image # How to use this image
## hosting some simple static content ## Hosting some simple static content
```console ```console
$ docker run --name some-nginx -v /some/content:/usr/share/nginx/html:ro -d nginx $ docker run --name some-nginx -v /some/content:/usr/share/nginx/html:ro -d nginx
@ -27,7 +27,7 @@ Place this file in the same directory as your directory of content ("static-html
$ docker run --name some-nginx -d some-content-nginx $ docker run --name some-nginx -d some-content-nginx
``` ```
## exposing the port ## Exposing external port
```console ```console
$ docker run --name some-nginx -d -p 8080:80 some-content-nginx $ docker run --name some-nginx -d -p 8080:80 some-content-nginx
@ -35,15 +35,15 @@ $ docker run --name some-nginx -d -p 8080:80 some-content-nginx
Then you can hit `http://localhost:8080` or `http://host-ip:8080` in your browser. Then you can hit `http://localhost:8080` or `http://host-ip:8080` in your browser.
## complex configuration ## Complex configuration
```console ```console
$ docker run --name my-custom-nginx-container -v /host/path/nginx.conf:/etc/nginx/nginx.conf:ro -d nginx $ docker run --name my-custom-nginx-container -v /host/path/nginx.conf:/etc/nginx/nginx.conf:ro -d nginx
``` ```
For information on the syntax of the Nginx configuration files, see [the official documentation](http://nginx.org/en/docs/) (specifically the [Beginner's Guide](http://nginx.org/en/docs/beginners_guide.html#conf_structure)). For information on the syntax of the nginx configuration files, see [the official documentation](http://nginx.org/en/docs/) (specifically the [Beginner's Guide](http://nginx.org/en/docs/beginners_guide.html#conf_structure)).
If you wish to adapt the default configuration, use something like the following to copy it from a running Nginx container: If you wish to adapt the default configuration, use something like the following to copy it from a running nginx container:
```console ```console
$ docker run --name tmp-nginx-container -d nginx $ docker run --name tmp-nginx-container -d nginx
@ -51,24 +51,24 @@ $ docker cp tmp-nginx-container:/etc/nginx/nginx.conf /host/path/nginx.conf
$ docker rm -f tmp-nginx-container $ docker rm -f tmp-nginx-container
``` ```
As above, this can also be accomplished more cleanly using a simple `Dockerfile` (in `/host/path/`): This can also be accomplished more cleanly using a simple `Dockerfile` (in `/host/path/`):
```dockerfile ```dockerfile
FROM nginx FROM nginx
COPY nginx.conf /etc/nginx/nginx.conf COPY nginx.conf /etc/nginx/nginx.conf
``` ```
If you add a custom `CMD` in the Dockerfile, be sure to include `-g daemon off;` to `CMD` that Nginx stays in the foreground so that Docker can track the process properly (otherwise your container will stop immediately after starting)! If you add a custom `CMD` in the Dockerfile, be sure to include `-g daemon off;` in the `CMD` in order for nginx to stay in the foreground, so that Docker can track the process properly (otherwise your container will stop immediately after starting)!
Then, build with `docker build -t custom-nginx .` and run: Then build the image with `docker build -t custom-nginx .` and run it as follows:
```console ```console
$ docker run --name my-custom-nginx-container -d custom-nginx $ docker run --name my-custom-nginx-container -d custom-nginx
``` ```
### using environment variables in nginx configuration ### Using environment variables in nginx configuration
Out-of-the-box, Nginx doesn't support using environment variables inside most configuration blocks. But `envsubst` may be used as a workaround if you need to generate your nginx configuration dynamically before nginx starts. Out-of-the-box, nginx doesn't support environment variables inside most configuration blocks. But `envsubst` may be used as a workaround if you need to generate your nginx configuration dynamically before nginx starts.
Here is an example using docker-compose.yml: Here is an example using docker-compose.yml:
@ -90,9 +90,9 @@ The `mysite.template` file may then contain variable references like this:
`listen ${NGINX_PORT}; `listen ${NGINX_PORT};
` `
## running nginx in debug mode ## Running nginx in debug mode
Images since version 1.9.8 come with `nginx-debug` binary that produces complete output when using higher verbosity log levels. It can be used with simple CMD substitution: Images since version 1.9.8 come with `nginx-debug` binary that produces verbose output when using higher log levels. It can be used with simple CMD substitution:
```console ```console
$ docker run --name my-nginx -v /host/path/nginx.conf:/etc/nginx/nginx.conf:ro -d nginx nginx-debug -g 'daemon off;' $ docker run --name my-nginx -v /host/path/nginx.conf:/etc/nginx/nginx.conf:ro -d nginx nginx-debug -g 'daemon off;'