Skip to content

Commit

Permalink
doc: update docs and fixed typos
Browse files Browse the repository at this point in the history
  • Loading branch information
agile6v committed Jun 30, 2020
1 parent 0e19740 commit 4d78d25
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ $ TAG=<tag> REGISTRY=$USER/ingress-controller make image
## Deploying

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

## Testing

Expand Down
6 changes: 4 additions & 2 deletions docs/user-guide/nginx-configuration/configmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ data:
This means that we want a value with boolean values we need to quote the values, like "true" or "false".
Same for numbers, like "100".
"Slice" types (defined below as `[]string` or `[]int` can be provided as a comma-delimited string.
"Slice" types (defined below as `[]string` or `[]int`) can be provided as a comma-delimited string.

## Configuration options

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

## proxy-real-ip-cidr

If use-proxy-protocol is enabled, proxy-real-ip-cidr defines the default the IP/network address of your external load balancer.
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.

## proxy-set-headers

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

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

__Note:__ ssl_prefer_server_ciphers directive will be enabled by default for http context.

## ssl-ecdh-curve

Specifies a curve for ECDHE ciphers.
Expand Down
6 changes: 3 additions & 3 deletions rootfs/etc/nginx/lua/certificate.lua
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,14 @@ local function get_pem_cert_uid(raw_hostname)
return uid
end

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

if wildcard_hosatname then
uid = ngx.shared.certificate_servers:get(wildcard_hosatname)
if wildcard_hostname then
uid = certificate_servers:get(wildcard_hostname)
end

return uid
Expand Down
2 changes: 1 addition & 1 deletion rootfs/etc/nginx/lua/plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ By defining functions with the following names, you can run your custom Lua code

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

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.
Expand Down

0 comments on commit 4d78d25

Please sign in to comment.