Skip to content

Commit 3402d07

Browse files
authored
doc: update docs and fixed typos (#5821)
1 parent c56baf6 commit 3402d07

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

docs/development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ $ TAG=<tag> REGISTRY=$USER/ingress-controller make image
101101
## Deploying
102102

103103
There are several ways to deploy the ingress controller onto a cluster.
104-
Please check the [deployment guide](./deploy/)
104+
Please check the [deployment guide](./deploy/index.md)
105105

106106
## Testing
107107

docs/user-guide/nginx-configuration/configmap.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ data:
1919
This means that we want a value with boolean values we need to quote the values, like "true" or "false".
2020
Same for numbers, like "100".
2121
22-
"Slice" types (defined below as `[]string` or `[]int` can be provided as a comma-delimited string.
22+
"Slice" types (defined below as `[]string` or `[]int`) can be provided as a comma-delimited string.
2323

2424
## Configuration options
2525

@@ -444,7 +444,7 @@ Sets the bucket size for the [map variables hash tables](http://nginx.org/en/doc
444444

445445
## proxy-real-ip-cidr
446446

447-
If use-proxy-protocol is enabled, proxy-real-ip-cidr defines the default the IP/network address of your external load balancer.
447+
If use-forwarded-headers or use-proxy-protocol is enabled, proxy-real-ip-cidr defines the default the IP/network address of your external load balancer.
448448

449449
## proxy-set-headers
450450

@@ -508,6 +508,8 @@ The ordering of a ciphersuite is very important because it decides which algorit
508508

509509
Please check the [Mozilla SSL Configuration Generator](https://mozilla.github.io/server-side-tls/ssl-config-generator/).
510510

511+
__Note:__ ssl_prefer_server_ciphers directive will be enabled by default for http context.
512+
511513
## ssl-ecdh-curve
512514

513515
Specifies a curve for ECDHE ciphers.

rootfs/etc/nginx/lua/certificate.lua

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,14 @@ local function get_pem_cert_uid(raw_hostname)
5757
return uid
5858
end
5959

60-
local wildcard_hosatname, _, err = re_sub(hostname, "^[^\\.]+\\.", "*.", "jo")
60+
local wildcard_hostname, _, err = re_sub(hostname, "^[^\\.]+\\.", "*.", "jo")
6161
if err then
6262
ngx.log(ngx.ERR, "error: ", err)
6363
return uid
6464
end
6565

66-
if wildcard_hosatname then
67-
uid = ngx.shared.certificate_servers:get(wildcard_hosatname)
66+
if wildcard_hostname then
67+
uid = certificate_servers:get(wildcard_hostname)
6868
end
6969

7070
return uid

rootfs/etc/nginx/lua/plugins/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ By defining functions with the following names, you can run your custom Lua code
1414

1515
- `init_worker`: useful for initializing some data per Nginx worker process
1616
- `rewrite`: useful for modifying request, changing headers, redirection, dropping request, doing authentication etc
17-
- `header`: this is called when backend response header is received, it is useful for modifying response headers
17+
- `header_filter`: this is called when backend response header is received, it is useful for modifying response headers
1818
- `log`: this is called when request processing is commpleted and response is delivered to the client
1919

2020
Check this [`hello_world`](https://github.com/kubernetes/ingress-nginx/tree/master/rootfs/etc/nginx/lua/plugins/hello_world) plugin as a simple example or refer to [OpenID Connect integration](https://github.com/ElvinEfendi/ingress-nginx-openidc/tree/master/rootfs/etc/nginx/lua/plugins/openidc) for more advanced usage.

0 commit comments

Comments
 (0)