Deploy GitHub Pages

This commit is contained in:
Travis Bot 2019-09-22 20:06:22 +00:00
parent a1da96983c
commit 1d78bdfa08
60 changed files with 1251 additions and 1157 deletions

View file

@ -32,7 +32,7 @@
<meta name="lang:search.tokenizer" content="[\s\-]+">
<link rel="shortcut icon" href="../../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.1">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2">
@ -217,7 +217,7 @@
<li class="md-tabs__item">
<a href="../../.." title="Welcome" class="md-tabs__link">
<a href="../../.." class="md-tabs__link">
Welcome
</a>
@ -230,7 +230,7 @@
<li class="md-tabs__item">
<a href="../../../deploy/" title="Deployment" class="md-tabs__link">
<a href="../../../deploy/" class="md-tabs__link">
Deployment
</a>
@ -247,7 +247,7 @@
<li class="md-tabs__item">
<a href="../" title="User guide" class="md-tabs__link md-tabs__link--active">
<a href="../" class="md-tabs__link md-tabs__link--active">
User guide
</a>
@ -262,7 +262,7 @@
<li class="md-tabs__item">
<a href="../../../examples/" title="Examples" class="md-tabs__link">
<a href="../../../examples/" class="md-tabs__link">
Examples
</a>
@ -274,7 +274,7 @@
</div>
</nav>
<main class="md-main">
<main class="md-main" role="main">
<div class="md-main__inner md-grid" data-md-component="container">
@ -580,21 +580,21 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#canary" title="Canary" class="md-nav__link">
<a href="#canary" class="md-nav__link">
Canary
</a>
</li>
<li class="md-nav__item">
<a href="#rewrite" title="Rewrite" class="md-nav__link">
<a href="#rewrite" class="md-nav__link">
Rewrite
</a>
</li>
<li class="md-nav__item">
<a href="#session-affinity" title="Session Affinity" class="md-nav__link">
<a href="#session-affinity" class="md-nav__link">
Session Affinity
</a>
@ -602,7 +602,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#cookie-affinity" title="Cookie affinity" class="md-nav__link">
<a href="#cookie-affinity" class="md-nav__link">
Cookie affinity
</a>
@ -614,105 +614,105 @@
</li>
<li class="md-nav__item">
<a href="#authentication" title="Authentication" class="md-nav__link">
<a href="#authentication" class="md-nav__link">
Authentication
</a>
</li>
<li class="md-nav__item">
<a href="#custom-nginx-upstream-hashing" title="Custom NGINX upstream hashing" class="md-nav__link">
<a href="#custom-nginx-upstream-hashing" class="md-nav__link">
Custom NGINX upstream hashing
</a>
</li>
<li class="md-nav__item">
<a href="#custom-nginx-load-balancing" title="Custom NGINX load balancing" class="md-nav__link">
<a href="#custom-nginx-load-balancing" class="md-nav__link">
Custom NGINX load balancing
</a>
</li>
<li class="md-nav__item">
<a href="#custom-nginx-upstream-vhost" title="Custom NGINX upstream vhost" class="md-nav__link">
<a href="#custom-nginx-upstream-vhost" class="md-nav__link">
Custom NGINX upstream vhost
</a>
</li>
<li class="md-nav__item">
<a href="#client-certificate-authentication" title="Client Certificate Authentication" class="md-nav__link">
<a href="#client-certificate-authentication" class="md-nav__link">
Client Certificate Authentication
</a>
</li>
<li class="md-nav__item">
<a href="#backend-certificate-authentication" title="Backend Certificate Authentication" class="md-nav__link">
<a href="#backend-certificate-authentication" class="md-nav__link">
Backend Certificate Authentication
</a>
</li>
<li class="md-nav__item">
<a href="#configuration-snippet" title="Configuration snippet" class="md-nav__link">
<a href="#configuration-snippet" class="md-nav__link">
Configuration snippet
</a>
</li>
<li class="md-nav__item">
<a href="#custom-http-errors" title="Custom HTTP Errors" class="md-nav__link">
<a href="#custom-http-errors" class="md-nav__link">
Custom HTTP Errors
</a>
</li>
<li class="md-nav__item">
<a href="#default-backend" title="Default Backend" class="md-nav__link">
<a href="#default-backend" class="md-nav__link">
Default Backend
</a>
</li>
<li class="md-nav__item">
<a href="#enable-cors" title="Enable CORS" class="md-nav__link">
<a href="#enable-cors" class="md-nav__link">
Enable CORS
</a>
</li>
<li class="md-nav__item">
<a href="#http2-push-preload" title="HTTP2 Push Preload." class="md-nav__link">
<a href="#http2-push-preload" class="md-nav__link">
HTTP2 Push Preload.
</a>
</li>
<li class="md-nav__item">
<a href="#server-alias" title="Server Alias" class="md-nav__link">
<a href="#server-alias" class="md-nav__link">
Server Alias
</a>
</li>
<li class="md-nav__item">
<a href="#server-snippet" title="Server snippet" class="md-nav__link">
<a href="#server-snippet" class="md-nav__link">
Server snippet
</a>
</li>
<li class="md-nav__item">
<a href="#client-body-buffer-size" title="Client Body Buffer Size" class="md-nav__link">
<a href="#client-body-buffer-size" class="md-nav__link">
Client Body Buffer Size
</a>
</li>
<li class="md-nav__item">
<a href="#external-authentication" title="External Authentication" class="md-nav__link">
<a href="#external-authentication" class="md-nav__link">
External Authentication
</a>
@ -720,7 +720,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#global-external-authentication" title="Global External Authentication" class="md-nav__link">
<a href="#global-external-authentication" class="md-nav__link">
Global External Authentication
</a>
@ -732,42 +732,42 @@
</li>
<li class="md-nav__item">
<a href="#rate-limiting" title="Rate limiting" class="md-nav__link">
<a href="#rate-limiting" class="md-nav__link">
Rate limiting
</a>
</li>
<li class="md-nav__item">
<a href="#permanent-redirect" title="Permanent Redirect" class="md-nav__link">
<a href="#permanent-redirect" class="md-nav__link">
Permanent Redirect
</a>
</li>
<li class="md-nav__item">
<a href="#permanent-redirect-code" title="Permanent Redirect Code" class="md-nav__link">
<a href="#permanent-redirect-code" class="md-nav__link">
Permanent Redirect Code
</a>
</li>
<li class="md-nav__item">
<a href="#temporal-redirect" title="Temporal Redirect" class="md-nav__link">
<a href="#temporal-redirect" class="md-nav__link">
Temporal Redirect
</a>
</li>
<li class="md-nav__item">
<a href="#ssl-passthrough" title="SSL Passthrough" class="md-nav__link">
<a href="#ssl-passthrough" class="md-nav__link">
SSL Passthrough
</a>
</li>
<li class="md-nav__item">
<a href="#service-upstream" title="Service Upstream" class="md-nav__link">
<a href="#service-upstream" class="md-nav__link">
Service Upstream
</a>
@ -775,7 +775,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#known-issues" title="Known Issues" class="md-nav__link">
<a href="#known-issues" class="md-nav__link">
Known Issues
</a>
@ -787,168 +787,168 @@
</li>
<li class="md-nav__item">
<a href="#server-side-https-enforcement-through-redirect" title="Server-side HTTPS enforcement through redirect" class="md-nav__link">
<a href="#server-side-https-enforcement-through-redirect" class="md-nav__link">
Server-side HTTPS enforcement through redirect
</a>
</li>
<li class="md-nav__item">
<a href="#redirect-fromto-www" title="Redirect from/to www" class="md-nav__link">
<a href="#redirect-fromto-www" class="md-nav__link">
Redirect from/to www
</a>
</li>
<li class="md-nav__item">
<a href="#whitelist-source-range" title="Whitelist source range" class="md-nav__link">
<a href="#whitelist-source-range" class="md-nav__link">
Whitelist source range
</a>
</li>
<li class="md-nav__item">
<a href="#custom-timeouts" title="Custom timeouts" class="md-nav__link">
<a href="#custom-timeouts" class="md-nav__link">
Custom timeouts
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-redirect" title="Proxy redirect" class="md-nav__link">
<a href="#proxy-redirect" class="md-nav__link">
Proxy redirect
</a>
</li>
<li class="md-nav__item">
<a href="#custom-max-body-size" title="Custom max body size" class="md-nav__link">
<a href="#custom-max-body-size" class="md-nav__link">
Custom max body size
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-cookie-domain" title="Proxy cookie domain" class="md-nav__link">
<a href="#proxy-cookie-domain" class="md-nav__link">
Proxy cookie domain
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-cookie-path" title="Proxy cookie path" class="md-nav__link">
<a href="#proxy-cookie-path" class="md-nav__link">
Proxy cookie path
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-buffering" title="Proxy buffering" class="md-nav__link">
<a href="#proxy-buffering" class="md-nav__link">
Proxy buffering
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-buffers-number" title="Proxy buffers Number" class="md-nav__link">
<a href="#proxy-buffers-number" class="md-nav__link">
Proxy buffers Number
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-buffer-size" title="Proxy buffer size" class="md-nav__link">
<a href="#proxy-buffer-size" class="md-nav__link">
Proxy buffer size
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-http-version" title="Proxy HTTP version" class="md-nav__link">
<a href="#proxy-http-version" class="md-nav__link">
Proxy HTTP version
</a>
</li>
<li class="md-nav__item">
<a href="#ssl-ciphers" title="SSL ciphers" class="md-nav__link">
<a href="#ssl-ciphers" class="md-nav__link">
SSL ciphers
</a>
</li>
<li class="md-nav__item">
<a href="#connection-proxy-header" title="Connection proxy header" class="md-nav__link">
<a href="#connection-proxy-header" class="md-nav__link">
Connection proxy header
</a>
</li>
<li class="md-nav__item">
<a href="#enable-access-log" title="Enable Access Log" class="md-nav__link">
<a href="#enable-access-log" class="md-nav__link">
Enable Access Log
</a>
</li>
<li class="md-nav__item">
<a href="#enable-rewrite-log" title="Enable Rewrite Log" class="md-nav__link">
<a href="#enable-rewrite-log" class="md-nav__link">
Enable Rewrite Log
</a>
</li>
<li class="md-nav__item">
<a href="#x-forwarded-prefix-header" title="X-Forwarded-Prefix Header" class="md-nav__link">
<a href="#x-forwarded-prefix-header" class="md-nav__link">
X-Forwarded-Prefix Header
</a>
</li>
<li class="md-nav__item">
<a href="#lua-resty-waf" title="Lua Resty WAF" class="md-nav__link">
<a href="#lua-resty-waf" class="md-nav__link">
Lua Resty WAF
</a>
</li>
<li class="md-nav__item">
<a href="#modsecurity" title="ModSecurity" class="md-nav__link">
<a href="#modsecurity" class="md-nav__link">
ModSecurity
</a>
</li>
<li class="md-nav__item">
<a href="#influxdb" title="InfluxDB" class="md-nav__link">
<a href="#influxdb" class="md-nav__link">
InfluxDB
</a>
</li>
<li class="md-nav__item">
<a href="#backend-protocol" title="Backend Protocol" class="md-nav__link">
<a href="#backend-protocol" class="md-nav__link">
Backend Protocol
</a>
</li>
<li class="md-nav__item">
<a href="#use-regex" title="Use Regex" class="md-nav__link">
<a href="#use-regex" class="md-nav__link">
Use Regex
</a>
</li>
<li class="md-nav__item">
<a href="#satisfy" title="Satisfy" class="md-nav__link">
<a href="#satisfy" class="md-nav__link">
Satisfy
</a>
</li>
<li class="md-nav__item">
<a href="#mirror" title="Mirror" class="md-nav__link">
<a href="#mirror" class="md-nav__link">
Mirror
</a>
@ -1536,21 +1536,21 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#canary" title="Canary" class="md-nav__link">
<a href="#canary" class="md-nav__link">
Canary
</a>
</li>
<li class="md-nav__item">
<a href="#rewrite" title="Rewrite" class="md-nav__link">
<a href="#rewrite" class="md-nav__link">
Rewrite
</a>
</li>
<li class="md-nav__item">
<a href="#session-affinity" title="Session Affinity" class="md-nav__link">
<a href="#session-affinity" class="md-nav__link">
Session Affinity
</a>
@ -1558,7 +1558,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#cookie-affinity" title="Cookie affinity" class="md-nav__link">
<a href="#cookie-affinity" class="md-nav__link">
Cookie affinity
</a>
@ -1570,105 +1570,105 @@
</li>
<li class="md-nav__item">
<a href="#authentication" title="Authentication" class="md-nav__link">
<a href="#authentication" class="md-nav__link">
Authentication
</a>
</li>
<li class="md-nav__item">
<a href="#custom-nginx-upstream-hashing" title="Custom NGINX upstream hashing" class="md-nav__link">
<a href="#custom-nginx-upstream-hashing" class="md-nav__link">
Custom NGINX upstream hashing
</a>
</li>
<li class="md-nav__item">
<a href="#custom-nginx-load-balancing" title="Custom NGINX load balancing" class="md-nav__link">
<a href="#custom-nginx-load-balancing" class="md-nav__link">
Custom NGINX load balancing
</a>
</li>
<li class="md-nav__item">
<a href="#custom-nginx-upstream-vhost" title="Custom NGINX upstream vhost" class="md-nav__link">
<a href="#custom-nginx-upstream-vhost" class="md-nav__link">
Custom NGINX upstream vhost
</a>
</li>
<li class="md-nav__item">
<a href="#client-certificate-authentication" title="Client Certificate Authentication" class="md-nav__link">
<a href="#client-certificate-authentication" class="md-nav__link">
Client Certificate Authentication
</a>
</li>
<li class="md-nav__item">
<a href="#backend-certificate-authentication" title="Backend Certificate Authentication" class="md-nav__link">
<a href="#backend-certificate-authentication" class="md-nav__link">
Backend Certificate Authentication
</a>
</li>
<li class="md-nav__item">
<a href="#configuration-snippet" title="Configuration snippet" class="md-nav__link">
<a href="#configuration-snippet" class="md-nav__link">
Configuration snippet
</a>
</li>
<li class="md-nav__item">
<a href="#custom-http-errors" title="Custom HTTP Errors" class="md-nav__link">
<a href="#custom-http-errors" class="md-nav__link">
Custom HTTP Errors
</a>
</li>
<li class="md-nav__item">
<a href="#default-backend" title="Default Backend" class="md-nav__link">
<a href="#default-backend" class="md-nav__link">
Default Backend
</a>
</li>
<li class="md-nav__item">
<a href="#enable-cors" title="Enable CORS" class="md-nav__link">
<a href="#enable-cors" class="md-nav__link">
Enable CORS
</a>
</li>
<li class="md-nav__item">
<a href="#http2-push-preload" title="HTTP2 Push Preload." class="md-nav__link">
<a href="#http2-push-preload" class="md-nav__link">
HTTP2 Push Preload.
</a>
</li>
<li class="md-nav__item">
<a href="#server-alias" title="Server Alias" class="md-nav__link">
<a href="#server-alias" class="md-nav__link">
Server Alias
</a>
</li>
<li class="md-nav__item">
<a href="#server-snippet" title="Server snippet" class="md-nav__link">
<a href="#server-snippet" class="md-nav__link">
Server snippet
</a>
</li>
<li class="md-nav__item">
<a href="#client-body-buffer-size" title="Client Body Buffer Size" class="md-nav__link">
<a href="#client-body-buffer-size" class="md-nav__link">
Client Body Buffer Size
</a>
</li>
<li class="md-nav__item">
<a href="#external-authentication" title="External Authentication" class="md-nav__link">
<a href="#external-authentication" class="md-nav__link">
External Authentication
</a>
@ -1676,7 +1676,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#global-external-authentication" title="Global External Authentication" class="md-nav__link">
<a href="#global-external-authentication" class="md-nav__link">
Global External Authentication
</a>
@ -1688,42 +1688,42 @@
</li>
<li class="md-nav__item">
<a href="#rate-limiting" title="Rate limiting" class="md-nav__link">
<a href="#rate-limiting" class="md-nav__link">
Rate limiting
</a>
</li>
<li class="md-nav__item">
<a href="#permanent-redirect" title="Permanent Redirect" class="md-nav__link">
<a href="#permanent-redirect" class="md-nav__link">
Permanent Redirect
</a>
</li>
<li class="md-nav__item">
<a href="#permanent-redirect-code" title="Permanent Redirect Code" class="md-nav__link">
<a href="#permanent-redirect-code" class="md-nav__link">
Permanent Redirect Code
</a>
</li>
<li class="md-nav__item">
<a href="#temporal-redirect" title="Temporal Redirect" class="md-nav__link">
<a href="#temporal-redirect" class="md-nav__link">
Temporal Redirect
</a>
</li>
<li class="md-nav__item">
<a href="#ssl-passthrough" title="SSL Passthrough" class="md-nav__link">
<a href="#ssl-passthrough" class="md-nav__link">
SSL Passthrough
</a>
</li>
<li class="md-nav__item">
<a href="#service-upstream" title="Service Upstream" class="md-nav__link">
<a href="#service-upstream" class="md-nav__link">
Service Upstream
</a>
@ -1731,7 +1731,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#known-issues" title="Known Issues" class="md-nav__link">
<a href="#known-issues" class="md-nav__link">
Known Issues
</a>
@ -1743,168 +1743,168 @@
</li>
<li class="md-nav__item">
<a href="#server-side-https-enforcement-through-redirect" title="Server-side HTTPS enforcement through redirect" class="md-nav__link">
<a href="#server-side-https-enforcement-through-redirect" class="md-nav__link">
Server-side HTTPS enforcement through redirect
</a>
</li>
<li class="md-nav__item">
<a href="#redirect-fromto-www" title="Redirect from/to www" class="md-nav__link">
<a href="#redirect-fromto-www" class="md-nav__link">
Redirect from/to www
</a>
</li>
<li class="md-nav__item">
<a href="#whitelist-source-range" title="Whitelist source range" class="md-nav__link">
<a href="#whitelist-source-range" class="md-nav__link">
Whitelist source range
</a>
</li>
<li class="md-nav__item">
<a href="#custom-timeouts" title="Custom timeouts" class="md-nav__link">
<a href="#custom-timeouts" class="md-nav__link">
Custom timeouts
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-redirect" title="Proxy redirect" class="md-nav__link">
<a href="#proxy-redirect" class="md-nav__link">
Proxy redirect
</a>
</li>
<li class="md-nav__item">
<a href="#custom-max-body-size" title="Custom max body size" class="md-nav__link">
<a href="#custom-max-body-size" class="md-nav__link">
Custom max body size
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-cookie-domain" title="Proxy cookie domain" class="md-nav__link">
<a href="#proxy-cookie-domain" class="md-nav__link">
Proxy cookie domain
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-cookie-path" title="Proxy cookie path" class="md-nav__link">
<a href="#proxy-cookie-path" class="md-nav__link">
Proxy cookie path
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-buffering" title="Proxy buffering" class="md-nav__link">
<a href="#proxy-buffering" class="md-nav__link">
Proxy buffering
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-buffers-number" title="Proxy buffers Number" class="md-nav__link">
<a href="#proxy-buffers-number" class="md-nav__link">
Proxy buffers Number
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-buffer-size" title="Proxy buffer size" class="md-nav__link">
<a href="#proxy-buffer-size" class="md-nav__link">
Proxy buffer size
</a>
</li>
<li class="md-nav__item">
<a href="#proxy-http-version" title="Proxy HTTP version" class="md-nav__link">
<a href="#proxy-http-version" class="md-nav__link">
Proxy HTTP version
</a>
</li>
<li class="md-nav__item">
<a href="#ssl-ciphers" title="SSL ciphers" class="md-nav__link">
<a href="#ssl-ciphers" class="md-nav__link">
SSL ciphers
</a>
</li>
<li class="md-nav__item">
<a href="#connection-proxy-header" title="Connection proxy header" class="md-nav__link">
<a href="#connection-proxy-header" class="md-nav__link">
Connection proxy header
</a>
</li>
<li class="md-nav__item">
<a href="#enable-access-log" title="Enable Access Log" class="md-nav__link">
<a href="#enable-access-log" class="md-nav__link">
Enable Access Log
</a>
</li>
<li class="md-nav__item">
<a href="#enable-rewrite-log" title="Enable Rewrite Log" class="md-nav__link">
<a href="#enable-rewrite-log" class="md-nav__link">
Enable Rewrite Log
</a>
</li>
<li class="md-nav__item">
<a href="#x-forwarded-prefix-header" title="X-Forwarded-Prefix Header" class="md-nav__link">
<a href="#x-forwarded-prefix-header" class="md-nav__link">
X-Forwarded-Prefix Header
</a>
</li>
<li class="md-nav__item">
<a href="#lua-resty-waf" title="Lua Resty WAF" class="md-nav__link">
<a href="#lua-resty-waf" class="md-nav__link">
Lua Resty WAF
</a>
</li>
<li class="md-nav__item">
<a href="#modsecurity" title="ModSecurity" class="md-nav__link">
<a href="#modsecurity" class="md-nav__link">
ModSecurity
</a>
</li>
<li class="md-nav__item">
<a href="#influxdb" title="InfluxDB" class="md-nav__link">
<a href="#influxdb" class="md-nav__link">
InfluxDB
</a>
</li>
<li class="md-nav__item">
<a href="#backend-protocol" title="Backend Protocol" class="md-nav__link">
<a href="#backend-protocol" class="md-nav__link">
Backend Protocol
</a>
</li>
<li class="md-nav__item">
<a href="#use-regex" title="Use Regex" class="md-nav__link">
<a href="#use-regex" class="md-nav__link">
Use Regex
</a>
</li>
<li class="md-nav__item">
<a href="#satisfy" title="Satisfy" class="md-nav__link">
<a href="#satisfy" class="md-nav__link">
Satisfy
</a>
</li>
<li class="md-nav__item">
<a href="#mirror" title="Mirror" class="md-nav__link">
<a href="#mirror" class="md-nav__link">
Mirror
</a>
@ -1969,6 +1969,10 @@ table below.</p>
<td>string</td>
</tr>
<tr>
<td><a href="#authentication">nginx.ingress.kubernetes.io/auth-secret-type</a></td>
<td>string</td>
</tr>
<tr>
<td><a href="#authentication">nginx.ingress.kubernetes.io/auth-type</a></td>
<td>basic or digest</td>
</tr>
@ -2394,7 +2398,7 @@ The only affinity type available for NGINX is <code class="codehilite">cookie</c
<p>If you use the <code class="codehilite">cookie</code> affinity type you can also specify the name of the cookie that will be used to route the requests with the annotation <code class="codehilite">nginx.ingress.kubernetes.io/session-cookie-name</code>. The default is to create a cookie named 'INGRESSCOOKIE'.</p>
<p>The NGINX annotation <code class="codehilite">nginx.ingress.kubernetes.io/session-cookie-path</code> defines the path that will be set on the cookie. This is optional unless the annotation <code class="codehilite">nginx.ingress.kubernetes.io/use-regex</code> is set to true; Session cookie paths do not support regex.</p>
<h3 id="authentication">Authentication<a class="headerlink" href="#authentication" title="Permanent link">&para;</a></h3>
<p>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 key <code class="codehilite">auth</code>.</p>
<p>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.</p>
<p>The annotations are:
<div class="codehilite"><pre><span></span>nginx.ingress.kubernetes.io/auth-type: [basic|digest]
</pre></div></p>
@ -2404,6 +2408,14 @@ The only affinity type available for NGINX is <code class="codehilite">cookie</c
<p>The name of the Secret that contains the usernames and passwords which are granted access to the <code class="codehilite">path</code>s defined in the Ingress rules.
This annotation also accepts the alternative form "namespace/secretName", in which case the Secret lookup is performed in the referenced namespace instead of the Ingress namespace.</p>
<div class="codehilite"><pre><span></span>nginx.ingress.kubernetes.io/auth-secret-type: [auth-file|auth-map]
</pre></div>
<p>The <code class="codehilite">auth-secret</code> can have two forms:</p>
<ul>
<li><code class="codehilite">auth-file</code> - default, an htpasswd file in the key <code class="codehilite">auth</code> within the secret</li>
<li><code class="codehilite">auth-map</code> - the keys of the secret are the usernames, and the values are the hashed passwords</li>
</ul>
<div class="codehilite"><pre><span></span>nginx.ingress.kubernetes.io/auth-realm: &quot;realm string&quot;
</pre></div>
@ -2541,13 +2553,13 @@ location enabling this functionality.</p>
</ul>
</div>
<h3 id="server-alias">Server Alias<a class="headerlink" href="#server-alias" title="Permanent link">&para;</a></h3>
<p>To add Server Aliases to an Ingress rule add the annotation <code class="codehilite">nginx.ingress.kubernetes.io/server-alias: &quot;&lt;alias&gt;&quot;</code>.
This will create a server with the same configuration, but a different <code class="codehilite">server_name</code> as the provided host.</p>
<p>Allows the definition of one or more aliases in the server definition of the NGINX configuration using the annotation <code class="codehilite">nginx.ingress.kubernetes.io/server-alias: &quot;&lt;alias 1&gt;,&lt;alias 2&gt;&quot;</code>.
This will create a server with the same configuration, but adding new values to the <code class="codehilite">server_name</code> directive.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>A server-alias name cannot conflict with the hostname of an existing server. If it does the server-alias annotation will be ignored.
If a server-alias is created and later a new server with the same hostname is created,
the new server configuration will take place over the alias configuration.</p>
<p>A server-alias name cannot conflict with the hostname of an existing server. If it does, the server-alias annotation will be ignored.
If a server-alias is created and later a new server with the same hostname is created, the new server configuration will take
place over the alias configuration.</p>
</div>
<p>For more information please see <a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#server_name">the <code class="codehilite">server_name</code> documentation</a>.</p>
<h3 id="server-snippet">Server snippet<a class="headerlink" href="#server-snippet" title="Permanent link">&para;</a></h3>
@ -2643,7 +2655,7 @@ applied to each location provided in the ingress rule.</p>
</ul>
<p>If you specify multiple annotations in a single Ingress rule, limits are applied in the order <code class="codehilite">limit-connections</code>, <code class="codehilite">limit-rpm</code>, <code class="codehilite">limit-rps</code>.</p>
<p>To configure settings globally for all Ingress rules, the <code class="codehilite">limit-rate-after</code> and <code class="codehilite">limit-rate</code> values may be set in the <a href="../configmap/#limit-rate">NGINX ConfigMap</a>. The value set in an Ingress annotation will override the global setting.</p>
<p>The client IP address will be set based on the use of <a href="./configmap/#use-proxy-protocol">PROXY protocol</a> or from the <code class="codehilite">X-Forwarded-For</code> header value when <a href="configmap/#use-forwarded-headers">use-forwarded-headers</a> is enabled.</p>
<p>The client IP address will be set based on the use of <a href="../configmap/#use-proxy-protocol">PROXY protocol</a> or from the <code class="codehilite">X-Forwarded-For</code> header value when <a href="../configmap/#use-forwarded-headers">use-forwarded-headers</a> is enabled.</p>
<h3 id="permanent-redirect">Permanent Redirect<a class="headerlink" href="#permanent-redirect" title="Permanent link">&para;</a></h3>
<p>This annotation allows to return a permanent redirect instead of sending data to the upstream. For example <code class="codehilite">nginx.ingress.kubernetes.io/permanent-redirect: https://www.google.com</code> would redirect everything to Google.</p>
<h3 id="permanent-redirect-code">Permanent Redirect Code<a class="headerlink" href="#permanent-redirect-code" title="Permanent link">&para;</a></h3>