Skip to content

Commit ee7fbde

Browse files
noxian-byteJTorreGADubhlaoichy82
authored
Improve readability of NGINX reverse proxy doc (#299) (#314)
* Improve readability of NGINX reverse proxy doc (#299) * Update content/nginx/admin-guide/web-server/reverse-proxy.md Co-authored-by: Alan Dooley <[email protected]> * Update content/nginx/admin-guide/web-server/reverse-proxy.md Co-authored-by: Alan Dooley <[email protected]> * Update content/nginx/admin-guide/web-server/reverse-proxy.md Co-authored-by: Alan Dooley <[email protected]> * Update content/nginx/admin-guide/web-server/reverse-proxy.md Co-authored-by: Alan Dooley <[email protected]> * Update content/nginx/admin-guide/web-server/reverse-proxy.md Co-authored-by: Alan Dooley <[email protected]> * Update content/nginx/admin-guide/web-server/reverse-proxy.md Co-authored-by: yar <[email protected]> * Update content/nginx/admin-guide/web-server/reverse-proxy.md Co-authored-by: yar <[email protected]> * Update content/nginx/admin-guide/web-server/reverse-proxy.md Co-authored-by: yar <[email protected]> * Updated documentation based on review suggestions --------- Co-authored-by: Jon Torre <[email protected]> Co-authored-by: Alan Dooley <[email protected]> Co-authored-by: yar <[email protected]> Co-authored-by: Alan Dooley <[email protected]>
1 parent c7234a7 commit ee7fbde

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

content/nginx/admin-guide/web-server/reverse-proxy.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,13 @@ Proxying is typically used to distribute the load among several servers, seamles
1717

1818
## Passing a Request to a Proxied Server
1919

20-
When NGINX proxies a request, it sends the request to a specified proxied server, fetches the response, and sends it back to the client. It is possible to proxy requests to an HTTP server (another NGINX server or any other server) or a non-HTTP server (which can run an application developed with a specific framework, such as PHP or Python) using a specified protocol. Supported protocols include [FastCGI](https://nginx.org/en/docs/http/ngx_http_fastcgi_module.html), [uwsgi](https://nginx.org/en/docs/http/ngx_http_uwsgi_module.html), [SCGI](https://nginx.org/en/docs/http/ngx_http_scgi_module.html), and [memcached](https://nginx.org/en/docs/http/ngx_http_memcached_module.html).
20+
When NGINX proxies a request, it:
21+
22+
1. Sends the request to a specified proxy server
23+
1. Fetches the response
24+
1. Sends the response back to the client.
25+
26+
It is possible to proxy requests to an HTTP server (another NGINX server or any other server) or a non-HTTP server (which can run an application developed with a specific framework, such as PHP or Python) using a specified protocol. Supported protocols include [FastCGI](https://nginx.org/en/docs/http/ngx_http_fastcgi_module.html), [uwsgi](https://nginx.org/en/docs/http/ngx_http_uwsgi_module.html), [SCGI](https://nginx.org/en/docs/http/ngx_http_scgi_module.html), and [memcached](https://nginx.org/en/docs/http/ngx_http_memcached_module.html).
2127

2228
To pass a request to an HTTP proxied server, the [proxy_pass](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass) directive is specified inside a [location](https://nginx.org/en/docs/http/ngx_http_core_module.html#location). For example:
2329

@@ -35,7 +41,9 @@ location ~ \.php {
3541
}
3642
```
3743

38-
Note that in the first example above, the address of the proxied server is followed by a URI, `/link/`. If the URI is specified along with the address, it replaces the part of the request URI that matches the location parameter. For example, here the request with the `/some/path/page.html` URI will be proxied to `http://www.example.com/link/page.html`. If the address is specified without a URI, or it is not possible to determine the part of URI to be replaced, the full request URI is passed (possibly, modified).
44+
Note that in the first example above, the address of the proxied server is followed by a URI, `/link/`. If the URI is specified along with the address, it replaces the part of the request URI that matches the location parameter.
45+
46+
For example, the request with the `/some/path/page.html` URI will be proxied to `http://www.example.com/link/page.html`. However, if the address is specified without a URI, or it is not possible to determine the part of URI to be replaced, the full request URI is passed (possibly, modified).
3947

4048
To pass a request to a non-HTTP proxied server, the appropriate `**_pass` directive should be used:
4149

@@ -46,14 +54,14 @@ To pass a request to a non-HTTP proxied server, the appropriate `**_pass` direct
4654

4755
Note that in these cases, the rules for specifying addresses may be different. You may also need to pass additional parameters to the server (see the [reference documentation](https://nginx.org/en/docs/) for more detail).
4856

49-
The [proxy_pass](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass) directive can also point to a [named group](https://nginx.org/en/docs/http/load_balancing.html#algorithms) of servers. In this case, requests are distributed among the servers in the group according to the [specified method](https://www.nginx.com/resources/admin-guide/load-balancer/).
57+
The [proxy_pass](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass) directive can also be used to pass requests to a [named group](https://nginx.org/en/docs/http/load_balancing.html#algorithms) of servers. In this case, requests are distributed among the servers in the group according to the [specified method](https://www.nginx.com/resources/admin-guide/load-balancer/).
5058

5159
<span id="headers"></span>
5260
## Passing Request Headers
5361

54-
By default, NGINX redefines two header fields in proxied requests, “Host” and “Connection”, and eliminates the header fields whose values are empty strings. “Host” is set to the `$proxy_host` variable, and “Connection” is set to `close`.
62+
By default, NGINX modifies two header fields in proxied requests, “Host” and “Connection”, and eliminates the header fields whose values are empty strings. “Host” is set to the value of the `$proxy_host` variable, and “Connection” is set to `close`.
5563

56-
To change these setting, as well as modify other header fields, use the [proxy_set_header](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_set_header) directive. This directive can be specified in a [location](https://nginx.org/en/docs/http/ngx_http_core_module.html#location) or higher. It can also be specified in a particular [server](https://nginx.org/en/docs/http/ngx_http_core_module.html#server) context or in the [http](https://nginx.org/en/docs/http/ngx_http_core_module.html#http) block. For example:
64+
To change these settings, as well as modify other header fields, use the [proxy_set_header](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_set_header) directive. This directive can be specified in a [location](https://nginx.org/en/docs/http/ngx_http_core_module.html#location) or higher. It can also be specified in a particular [server](https://nginx.org/en/docs/http/ngx_http_core_module.html#server) context or in the [http](https://nginx.org/en/docs/http/ngx_http_core_module.html#http) block. For example:
5765

5866
```nginx
5967
location /some/path/ {
@@ -81,6 +89,8 @@ By default NGINX buffers responses from proxied servers. A response is stored in
8189

8290
The directive that is responsible for enabling and disabling buffering is [proxy_buffering](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering). By default it is set to `on` and buffering is enabled.
8391

92+
The [proxy_buffers](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffers) and [proxy_buffer_size](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffer_size) directives control how NGINX stores and buffers data.
93+
8494
The [proxy_buffers](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffers) directive controls the size and the number of buffers allocated for a request. The first part of the response from a proxied server is stored in a separate buffer, the size of which is set with the [proxy_buffer_size](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffer_size) directive. This part usually contains a comparatively small response header and can be made smaller than the buffers for the rest of the response.
8595

8696
In the following example, the default number of buffers is increased and the size of the buffer for the first portion of the response is made smaller than the default.
@@ -113,7 +123,7 @@ A common use of a reverse proxy is to provide load balancing. Learn how to impro
113123

114124
If your proxy server has several network interfaces, sometimes you might need to choose a particular source IP address for connecting to a proxied server or an upstream. This may be useful if a proxied server behind NGINX is configured to accept connections from particular IP networks or IP address ranges.
115125

116-
Specify the [proxy_bind](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_bind) directive and the IP address of the necessary network interface:
126+
In such cases, you can specify the [proxy_bind](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_bind) directive and the IP address of the necessary network interface:
117127

118128
```nginx
119129
location /app1/ {

0 commit comments

Comments
 (0)