Skip to content

Commit 22d74df

Browse files
authored
Merge pull request #145 from chentao1596/configuration-correct
fix wrong links and punctuations
2 parents fbcedc0 + 7bcdef0 commit 22d74df

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

controllers/nginx/configuration.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121

2222
There are 3 ways to customize NGINX:
2323

24-
1. [ConfigMap](#allowed-parameters-in-configuration-configmap): create a stand alone ConfigMap, use this if you want a different global configuration
25-
2. [annotations](#annotations): use this if you want a specific configuration for the site defined in the Ingress rule
24+
1. [ConfigMap](#allowed-parameters-in-configuration-configmap): create a stand alone ConfigMap, use this if you want a different global configuration.
25+
2. [annotations](#annotations): use this if you want a specific configuration for the site defined in the Ingress rule.
2626
3. custom template: when more specific settings are required, like [open_file_cache](http://nginx.org/en/docs/http/ngx_http_core_module.html#open_file_cache), custom [log_format](http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format), adjust [listen](http://nginx.org/en/docs/http/ngx_http_core_module.html#listen) options as `rcvbuf` or when is not possible to change an through the ConfigMap.
2727

2828

@@ -97,7 +97,7 @@ Please check the [custom upstream check](examples/custom-upstream-check/README.m
9797

9898
### Authentication
9999

100-
Is possible to add authentication adding additional annotations in the Ingress rule. The source of the authentication is a secret that contains usernames and passwords inside the the key `auth`
100+
Is possible to add authentication adding additional annotations in the Ingress rule. The source of the authentication is a secret that contains usernames and passwords inside the the key `auth`.
101101

102102
The annotations are:
103103

@@ -154,16 +154,16 @@ The annotations `ingress.kubernetes.io/limit-connections` and `ingress.kubernete
154154
If you specify both annotations in a single Ingress rule, `limit-rps` takes precedence.
155155

156156

157-
### Secure upstreams
157+
### Secure backends
158158

159159
By default NGINX uses `http` to reach the services. Adding the annotation `ingress.kubernetes.io/secure-backends: "true"` in the Ingress rule changes the protocol to `https`.
160160

161161

162162
### Server-side HTTPS enforcement through redirect
163163

164-
By default the controller redirects (301) to `HTTPS` if TLS is enabled for that ingress. If you want to disable that behaviour globally, you can use `ssl-redirect: "false"` in the NGINX config map
164+
By default the controller redirects (301) to `HTTPS` if TLS is enabled for that ingress. If you want to disable that behaviour globally, you can use `ssl-redirect: "false"` in the NGINX config map.
165165

166-
To configure this feature for specific ingress resources, you can use the `ingress.kubernetes.io/ssl-redirect: "false"` annotation in the particular resource
166+
To configure this feature for specific ingress resources, you can use the `ingress.kubernetes.io/ssl-redirect: "false"` annotation in the particular resource.
167167

168168

169169
### Whitelist source range
@@ -177,7 +177,7 @@ To configure this setting globally for all Ingress rules, the `whitelist-source-
177177
Please check the [whitelist](examples/whitelist/README.md) example.
178178

179179

180-
### **Allowed parameters in configuration ConfigMap:**
180+
### **Allowed parameters in configuration ConfigMap**
181181

182182
**body-size:** Sets the maximum allowed size of the client request body. See NGINX [client_max_body_size](http://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size).
183183

@@ -222,7 +222,7 @@ http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout
222222
**max-worker-connections:** Sets the maximum number of simultaneous connections that can be opened by each [worker process](http://nginx.org/en/docs/ngx_core_module.html#worker_connections).
223223

224224

225-
**proxy-buffer-size:** Sets the size of the buffer used for [reading the first part of the response](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffer_size) received from the proxied server. This part usually contains a small response header.`
225+
**proxy-buffer-size:** Sets the size of the buffer used for [reading the first part of the response](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffer_size) received from the proxied server. This part usually contains a small response header.
226226

227227

228228
**proxy-connect-timeout:** Sets the timeout for [establishing a connection with a proxied server](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_connect_timeout). It should be noted that this timeout cannot usually exceed 75 seconds.
@@ -249,7 +249,7 @@ http://nginx.org/en/docs/hash.html
249249

250250

251251

252-
**map-hash-bucket-size:** Sets the bucket size for the [map variables hash tables](http://nginx.org/en/docs/http/ngx_http_map_module.html#map_hash_bucket_size). The details of setting up hash tables are provided in a separate [document](http://nginx.org/en/docs/hash.html)
252+
**map-hash-bucket-size:** Sets the bucket size for the [map variables hash tables](http://nginx.org/en/docs/http/ngx_http_map_module.html#map_hash_bucket_size). The details of setting up hash tables are provided in a separate [document](http://nginx.org/en/docs/hash.html).
253253

254254

255255
**ssl-buffer-size:** Sets the size of the [SSL buffer](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_buffer_size) used for sending data.
@@ -268,7 +268,7 @@ The recommendation above prioritizes algorithms that provide perfect [forward se
268268
Please check the [Mozilla SSL Configuration Generator](https://mozilla.github.io/server-side-tls/ssl-config-generator/).
269269

270270

271-
**ssl-dh-param:** sets the Base64 string that contains Diffie-Hellman key to help with "Perfect Forward Secrecy."
271+
**ssl-dh-param:** sets the Base64 string that contains Diffie-Hellman key to help with "Perfect Forward Secrecy".
272272
https://www.openssl.org/docs/manmaster/apps/dhparam.html
273273
https://wiki.mozilla.org/Security/Server_Side_TLS#DHE_handshake_and_dhparam
274274
http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_dhparam

0 commit comments

Comments
 (0)