kubernetes
/
ingress-nginx
mirror of https://github.com/kubernetes/ingress-nginx.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ingress-nginx/user-guide/nginx-configuration/configmap/index.html

18 lines
152 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><link href=https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/ rel=canonical><link rel="shortcut icon" href=../../../assets/images/favicon.png><meta name=generator content="mkdocs-1.1.2, mkdocs-material-6.2.4"><title>ConfigMap - NGINX Ingress Controller</title><link rel=stylesheet href=../../../assets/stylesheets/main.15aa0b43.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.75751829.min.css><meta name=theme-color content=#009485><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback"><style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style><link rel=stylesheet href=../../../extra.css><script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-118407822-1","kubernetes.github.io"),ga("set","anonymizeIp",!0),ga("send","pageview"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})}),document.addEventListener("DOMContentSwitch",function(){ga("send","pageview",document.location.pathname)})</script><script async src=https://www.google-analytics.com/analytics.js></script></head> <body dir=ltr data-md-color-scheme data-md-color-primary=teal data-md-color-accent=green> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#configmaps class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class=md-header data-md-component=header> <nav class="md-header-nav md-grid" aria-label=Header> <a href=https://kubernetes.github.io/ingress-nginx title="NGINX Ingress Controller" class="md-header-nav__button md-logo" aria-label="NGINX Ingress Controller"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg> </a> <label class="md-header-nav__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg> </label> <div class=md-header-nav__title data-md-component=header-title> <div class=md-header-nav__ellipsis> <div class=md-header-nav__topic> <span class=md-ellipsis> NGINX Ingress Controller </span> </div> <div class=md-header-nav__topic> <span class=md-ellipsis> ConfigMap </span> </div> </div> </div> <label class="md-header-nav__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query data-md-state=active required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> </label> <button type=reset class="md-search__icon md-icon" aria-label=Clear data-md-component=search-reset tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg> </button> </form> <div class=md-search__output> <div class=md-search__scrollwrap data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list></ol> </div> </div> </div> </div> </div> <div class=md-header-nav__source> <a href=https://github.com/kubernetes/ingress-nginx/ title="Go to repository" class=md-source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg> </div> <div class=md-source__repository> kubernetes/ingress-nginx </div> </a> </div> </nav> </header> <div class=md-container data-md-component=container> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class="md-tabs__inner md-grid"> <ul class=md-tabs__list> <li class=md-tabs__item> <a href=../../.. class=md-tabs__link> Welcome </a> </li> <li class=md-tabs__item> <a href=../../../deploy/ class=md-tabs__link> Deployment </a> </li> <li class=md-tabs__item> <a href=../ class="md-tabs__link md-tabs__link--active"> User guide </a> </li> <li class=md-tabs__item> <a href=../../../examples/ class=md-tabs__link> Examples </a> </li> <li class=md-tabs__item> <a href=../../../developer-guide/getting-started/ class=md-tabs__link> Developer Guide </a> </li> </ul> </div> </nav> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=https://kubernetes.github.io/ingress-nginx title="NGINX Ingress Controller" class="md-nav__button md-logo" aria-label="NGINX Ingress Controller"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg> </a> NGINX Ingress Controller </label> <div class=md-nav__source> <a href=https://github.com/kubernetes/ingress-nginx/ title="Go to repository" class=md-source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg> </div> <div class=md-source__repository> kubernetes/ingress-nginx </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-1 type=checkbox id=nav-1> <label class=md-nav__link for=nav-1> Welcome <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=Welcome data-md-level=1> <label class=md-nav__title for=nav-1> <span class="md-nav__icon md-icon"></span> Welcome </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../.. class=md-nav__link> Welcome </a> </li> <li class=md-nav__item> <a href=../../../how-it-works/ class=md-nav__link> How it works </a> </li> <li class=md-nav__item> <a href=../../../troubleshooting/ class=md-nav__link> Troubleshooting </a> </li> <li class=md-nav__item> <a href=../../../kubectl-plugin/ class=md-nav__link> kubectl plugin </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-2 type=checkbox id=nav-2> <label class=md-nav__link for=nav-2> Deployment <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=Deployment data-md-level=1> <label class=md-nav__title for=nav-2> <span class="md-nav__icon md-icon"></span> Deployment </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../deploy/ class=md-nav__link> Installation Guide </a> </li> <li class=md-nav__item> <a href=../../../deploy/baremetal/ class=md-nav__link> Bare-metal considerations </a> </li> <li class=md-nav__item> <a href=../../../deploy/rbac/ class=md-nav__link> Role Based Access Control (RBAC) </a> </li> <li class=md-nav__item> <a href=../../../deploy/upgrade/ class=md-nav__link> Upgrade </a> </li> <li class=md-nav__item> <a href=../../../deploy/hardening-guide/ class=md-nav__link> Hardening guide </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-3 type=checkbox id=nav-3 checked> <label class=md-nav__link for=nav-3> User guide <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label="User guide" data-md-level=1> <label class=md-nav__title for=nav-3> <span class="md-nav__icon md-icon"></span> User guide </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-3-1 type=checkbox id=nav-3-1 checked> <label class=md-nav__link for=nav-3-1> NGINX Configuration <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label="NGINX Configuration" data-md-level=2> <label class=md-nav__title for=nav-3-1> <span class="md-nav__icon md-icon"></span> NGINX Configuration </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../ class=md-nav__link> Introduction </a> </li> <li class=md-nav__item> <a href=../../basic-usage/ class=md-nav__link> Basic usage </a> </li> <li class=md-nav__item> <a href=../annotations/ class=md-nav__link> Annotations </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" data-md-toggle=toc type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> ConfigMap <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> ConfigMap </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=#configuration-options class=md-nav__link> Configuration options </a> </li> <li class=md-nav__item> <a href=#add-headers class=md-nav__link> add-headers </a> </li> <li class=md-nav__item> <a href=#allow-backend-server-header class=md-nav__link> allow-backend-server-header </a> </li> <li class=md-nav__item> <a href=#hide-headers class=md-nav__link> hide-headers </a> </li> <li class=md-nav__item> <a href=#access-log-params class=md-nav__link> access-log-params </a> </li> <li class=md-nav__item> <a href=#access-log-path class=md-nav__link> access-log-path </a> </li> <li class=md-nav__item> <a href=#http-access-log-path class=md-nav__link> http-access-log-path </a> </li> <li class=md-nav__item> <a href=#stream-access-log-path class=md-nav__link> stream-access-log-path </a> </li> <li class=md-nav__item> <a href=#enable-access-log-for-default-backend class=md-nav__link> enable-access-log-for-default-backend </a> </li> <li class=md-nav__item> <a href=#error-log-path class=md-nav__link> error-log-path </a> </li> <li class=md-nav__item> <a href=#enable-modsecurity class=md-nav__link> enable-modsecurity </a> </li> <li class=md-nav__item> <a href=#enable-owasp-modsecurity-crs class=md-nav__link> enable-owasp-modsecurity-crs </a> </li> <li class=md-nav__item> <a href=#modsecurity-snippet class=md-nav__link> modsecurity-snippet </a> </li> <li class=md-nav__item> <a href=#client-header-buffer-size class=md-nav__link> client-header-buffer-size </a> </li> <li class=md-nav__item> <a href=#client-header-timeout class=md-nav__link> client-header-timeout </a> </li> <li class=md-nav__item> <a href=#client-body-buffer-size class=md-nav__link> client-body-buffer-size </a> </li> <li class=md-nav__item> <a href=#client-body-timeout class=md-nav__link> client-body-timeout </a> </li> <li class=md-nav__item> <a href=#disable-access-log class=md-nav__link> disable-access-log </a> </li> <li class=md-nav__item> <a href=#disable-ipv6 class=md-nav__link> disable-ipv6 </a> </li> <li class=md-nav__item> <a href=#disable-ipv6-dns class=md-nav__link> disable-ipv6-dns </a> </li> <li class=md-nav__item> <a href=#enable-underscores-in-headers class=md-nav__link> enable-underscores-in-headers </a> </li> <li class=md-nav__item> <a href=#enable-ocsp class=md-nav__link> enable-ocsp </a> </li> <li class=md-nav__item> <a href=#ignore-invalid-headers class=md-nav__link> ignore-invalid-headers </a> </li> <li class=md-nav__item> <a href=#retry-non-idempotent class=md-nav__link> retry-non-idempotent </a> </li> <li class=md-nav__item> <a href=#error-log-level class=md-nav__link> error-log-level </a> </li> <li class=md-nav__item> <a href=#http2-max-field-size class=md-nav__link> http2-max-field-size </a> </li> <li class=md-nav__item> <a href=#http2-max-header-size class=md-nav__link> http2-max-header-size </a> </li> <li class=md-nav__item> <a href=#http2-max-requests class=md-nav__link> http2-max-requests </a> </li> <li class=md-nav__item> <a href=#http2-max-concurrent-streams class=md-nav__link> http2-max-concurrent-streams </a> </li> <li class=md-nav__item> <a href=#hsts class=md-nav__link> hsts </a> </li> <li class=md-nav__item> <a href=#hsts-include-subdomains class=md-nav__link> hsts-include-subdomains </a> </li> <li class=md-nav__item> <a href=#hsts-max-age class=md-nav__link> hsts-max-age </a> </li> <li class=md-nav__item> <a href=#hsts-preload class=md-nav__link> hsts-preload </a> </li> <li class=md-nav__item> <a href=#keep-alive class=md-nav__link> keep-alive </a> </li> <li class=md-nav__item> <a href=#keep-alive-requests class=md-nav__link> keep-alive-requests </a> </li> <li class=md-nav__item> <a href=#large-client-header-buffers class=md-nav__link> large-client-header-buffers </a> </li> <li class=md-nav__item> <a href=#log-format-escape-json class=md-nav__link> log-format-escape-json </a> </li> <li class=md-nav__item> <a href=#log-format-upstream class=md-nav__link> log-format-upstream </a> </li> <li class=md-nav__item> <a href=#log-format-stream class=md-nav__link> log-format-stream </a> </li> <li class=md-nav__item> <a href=#enable-multi-accept class=md-nav__link> enable-multi-accept </a> </li> <li class=md-nav__item> <a href=#max-worker-connections class=md-nav__link> max-worker-connections </a> </li> <li class=md-nav__item> <a href=#max-worker-open-files class=md-nav__link> max-worker-open-files </a> </li> <li class=md-nav__item> <a href=#map-hash-bucket-size class=md-nav__link> map-hash-bucket-size </a> </li> <li class=md-nav__item> <a href=#proxy-real-ip-cidr class=md-nav__link> proxy-real-ip-cidr </a> </li> <li class=md-nav__item> <a href=#proxy-set-headers class=md-nav__link> proxy-set-headers </a> </li> <li class=md-nav__item> <a href=#server-name-hash-max-size class=md-nav__link> server-name-hash-max-size </a> </li> <li class=md-nav__item> <a href=#server-name-hash-bucket-size class=md-nav__link> server-name-hash-bucket-size </a> </li> <li class=md-nav__item> <a href=#proxy-headers-hash-max-size class=md-nav__link> proxy-headers-hash-max-size </a> </li> <li class=md-nav__item> <a href=#reuse-port class=md-nav__link> reuse-port </a> </li> <li class=md-nav__item> <a href=#proxy-headers-hash-bucket-size class=md-nav__link> proxy-headers-hash-bucket-size </a> </li> <li class=md-nav__item> <a href=#plugins class=md-nav__link> plugins </a> </li> <li class=md-nav__item> <a href=#server-tokens class=md-nav__link> server-tokens </a> </li> <li class=md-nav__item> <a href=#ssl-ciphers class=md-nav__link> ssl-ciphers </a> </li> <li class=md-nav__item> <a href=#ssl-ecdh-curve class=md-nav__link> ssl-ecdh-curve </a> </li> <li class=md-nav__item> <a href=#ssl-dh-param class=md-nav__link> ssl-dh-param </a> </li> <li class=md-nav__item> <a href=#ssl-protocols class=md-nav__link> ssl-protocols </a> </li> <li class=md-nav__item> <a href=#ssl-early-data class=md-nav__link> ssl-early-data </a> </li> <li class=md-nav__item> <a href=#ssl-session-cache class=md-nav__link> ssl-session-cache </a> </li> <li class=md-nav__item> <a href=#ssl-session-cache-size class=md-nav__link> ssl-session-cache-size </a> </li> <li class=md-nav__item> <a href=#ssl-session-tickets class=md-nav__link> ssl-session-tickets </a> </li> <li class=md-nav__item> <a href=#ssl-session-ticket-key class=md-nav__link> ssl-session-ticket-key </a> </li> <li class=md-nav__item> <a href=#ssl-session-timeout class=md-nav__link> ssl-session-timeout </a> </li> <li class=md-nav__item> <a href=#ssl-buffer-size class=md-nav__link> ssl-buffer-size </a> </li> <li class=md-nav__item> <a href=#use-proxy-protocol class=md-nav__link> use-proxy-protocol </a> </li> <li class=md-nav__item> <a href=#proxy-protocol-header-timeout class=md-nav__link> proxy-protocol-header-timeout </a> </li> <li class=md-nav__item> <a href=#use-gzip class=md-nav__link> use-gzip </a> </li> <li class=md-nav__item> <a href=#use-geoip class=md-nav__link> use-geoip </a> </li> <li class=md-nav__item> <a href=#use-geoip2 class=md-nav__link> use-geoip2 </a> </li> <li class=md-nav__item> <a href=#enable-brotli class=md-nav__link> enable-brotli </a> </li> <li class=md-nav__item> <a href=#brotli-level class=md-nav__link> brotli-level </a> </li> <li class=md-nav__item> <a href=#brotli-types class=md-nav__link> brotli-types </a> </li> <li class=md-nav__item> <a href=#use-http2 class=md-nav__link> use-http2 </a> </li> <li class=md-nav__item> <a href=#gzip-level class=md-nav__link> gzip-level </a> </li> <li class=md-nav__item> <a href=#gzip-min-length class=md-nav__link> gzip-min-length </a> </li> <li class=md-nav__item> <a href=#gzip-types class=md-nav__link> gzip-types </a> </li> <li class=md-nav__item> <a href=#worker-processes class=md-nav__link> worker-processes </a> </li> <li class=md-nav__item> <a href=#worker-cpu-affinity class=md-nav__link> worker-cpu-affinity </a> </li> <li class=md-nav__item> <a href=#worker-shutdown-timeout class=md-nav__link> worker-shutdown-timeout </a> </li> <li class=md-nav__item> <a href=#load-balance class=md-nav__link> load-balance </a> </li> <li class=md-nav__item> <a href=#variables-hash-bucket-size class=md-nav__link> variables-hash-bucket-size </a> </li> <li class=md-nav__item> <a href=#variables-hash-max-size class=md-nav__link> variables-hash-max-size </a> </li> <li class=md-nav__item> <a href=#upstream-keepalive-connections class=md-nav__link> upstream-keepalive-connections </a> </li> <li class=md-nav__item> <a href=#upstream-keepalive-timeout class=md-nav__link> upstream-keepalive-timeout </a> </li> <li class=md-nav__item> <a href=#upstream-keepalive-requests class=md-nav__link> upstream-keepalive-requests </a> </li> <li class=md-nav__item> <a href=#limit-conn-zone-variable class=md-nav__link> limit-conn-zone-variable </a> </li> <li class=md-nav__item> <a href=#proxy-stream-timeout class=md-nav__link> proxy-stream-timeout </a> </li> <li class=md-nav__item> <a href=#proxy-stream-next-upstream class=md-nav__link> proxy-stream-next-upstream </a> </li> <li class=md-nav__item> <a href=#proxy-stream-next-upstream-timeout class=md-nav__link> proxy-stream-next-upstream-timeout </a> </li> <li class=md-nav__item> <a href=#proxy-stream-next-upstream-tries class=md-nav__link> proxy-stream-next-upstream-tries </a> </li> <li class=md-nav__item> <a href=#proxy-stream-responses class=md-nav__link> proxy-stream-responses </a> </li> <li class=md-nav__item> <a href=#bind-address class=md-nav__link> bind-address </a> </li> <li class=md-nav__item> <a href=#use-forwarded-headers class=md-nav__link> use-forwarded-headers </a> </li> <li class=md-nav__item> <a href=#enable-real-ip class=md-nav__link> enable-real-ip </a> </li> <li class=md-nav__item> <a href=#forwarded-for-header class=md-nav__link> forwarded-for-header </a> </li> <li class=md-nav__item> <a href=#compute-full-forwarded-for class=md-nav__link> compute-full-forwarded-for </a> </li> <li class=md-nav__item> <a href=#proxy-add-original-uri-header class=md-nav__link> proxy-add-original-uri-header </a> </li> <li class=md-nav__item> <a href=#generate-request-id class=md-nav__link> generate-request-id </a> </li> <li class=md-nav__item> <a href=#enable-opentracing class=md-nav__link> enable-opentracing </a> </li> <li class=md-nav__item> <a href=#opentracing-operation-name class=md-nav__link> opentracing-operation-name </a> </li> <li class=md-nav__item> <a href=#opentracing-location-operation-name class=md-nav__link> opentracing-location-operation-name </a> </li> <li class=md-nav__item> <a href=#zipkin-collector-host class=md-nav__link> zipkin-collector-host </a> </li> <li class=md-nav__item> <a href=#zipkin-collector-port class=md-nav__link> zipkin-collector-port </a> </li> <li class=md-nav__item> <a href=#zipkin-service-name class=md-nav__link> zipkin-service-name </a> </li> <li class=md-nav__item> <a href=#zipkin-sample-rate class=md-nav__link> zipkin-sample-rate </a> </li> <li class=md-nav__item> <a href=#jaeger-collector-host class=md-nav__link> jaeger-collector-host </a> </li> <li class=md-nav__item> <a href=#jaeger-collector-port class=md-nav__link> jaeger-collector-port </a> </li> <li class=md-nav__item> <a href=#jaeger-endpoint class=md-nav__link> jaeger-endpoint </a> </li> <li class=md-nav__item> <a href=#jaeger-service-name class=md-nav__link> jaeger-service-name </a> </li> <li class=md-nav__item> <a href=#jaeger-propagation-format class=md-nav__link> jaeger-propagation-format </a> </li> <li class=md-nav__item> <a href=#jaeger-sampler-type class=md-nav__link> jaeger-sampler-type </a> </li> <li class=md-nav__item> <a href=#jaeger-sampler-param class=md-nav__link> jaeger-sampler-param </a> </li> <li class=md-nav__item> <a href=#jaeger-sampler-host class=md-nav__link> jaeger-sampler-host </a> </li> <li class=md-nav__item> <a href=#jaeger-sampler-port class=md-nav__link> jaeger-sampler-port </a> </li> <li class=md-nav__item> <a href=#jaeger-trace-context-header-name class=md-nav__link> jaeger-trace-context-header-name </a> </li> <li class=md-nav__item> <a href=#jaeger-debug-header class=md-nav__link> jaeger-debug-header </a> </li> <li class=md-nav__item> <a href=#jaeger-baggage-header class=md-nav__link> jaeger-baggage-header </a> </li> <li class=md-nav__item> <a href=#jaeger-tracer-baggage-header-prefix class=md-nav__link> jaeger-tracer-baggage-header-prefix </a> </li> <li class=md-nav__item> <a href=#datadog-collector-host class=md-nav__link> datadog-collector-host </a> </li> <li class=md-nav__item> <a href=#datadog-collector-port class=md-nav__link> datadog-collector-port </a> </li> <li class=md-nav__item> <a href=#datadog-service-name class=md-nav__link> datadog-service-name </a> </li> <li class=md-nav__item> <a href=#datadog-environment class=md-nav__link> datadog-environment </a> </li> <li class=md-nav__item> <a href=#datadog-operation-name-override class=md-nav__link> datadog-operation-name-override </a> </li> <li class=md-nav__item> <a href=#datadog-priority-sampling class=md-nav__link> datadog-priority-sampling </a> </li> <li class=md-nav__item> <a href=#datadog-sample-rate class=md-nav__link> datadog-sample-rate </a> </li> <li class=md-nav__item> <a href=#main-snippet class=md-nav__link> main-snippet </a> </li> <li class=md-nav__item> <a href=#http-snippet class=md-nav__link> http-snippet </a> </li> <li class=md-nav__item> <a href=#server-snippet class=md-nav__link> server-snippet </a> </li> <li class=md-nav__item> <a href=#location-snippet class=md-nav__link> location-snippet </a> </li> <li class=md-nav__item> <a href=#custom-http-errors class=md-nav__link> custom-http-errors </a> </li> <li class=md-nav__item> <a href=#proxy-body-size class=md-nav__link> proxy-body-size </a> </li> <li class=md-nav__item> <a href=#proxy-connect-timeout class=md-nav__link> proxy-connect-timeout </a> </li> <li class=md-nav__item> <a href=#proxy-read-timeout class=md-nav__link> proxy-read-timeout </a> </li> <li class=md-nav__item> <a href=#proxy-send-timeout class=md-nav__link> proxy-send-timeout </a> </li> <li class=md-nav__item> <a href=#proxy-buffers-number class=md-nav__link> proxy-buffers-number </a> </li> <li class=md-nav__item> <a href=#proxy-buffer-size class=md-nav__link> proxy-buffer-size </a> </li> <li class=md-nav__item> <a href=#proxy-cookie-path class=md-nav__link> proxy-cookie-path </a> </li> <li class=md-nav__item> <a href=#proxy-cookie-domain class=md-nav__link> proxy-cookie-domain </a> </li> <li class=md-nav__item> <a href=#proxy-next-upstream class=md-nav__link> proxy-next-upstream </a> </li> <li class=md-nav__item> <a href=#proxy-next-upstream-timeout class=md-nav__link> proxy-next-upstream-timeout </a> </li> <li class=md-nav__item> <a href=#proxy-next-upstream-tries class=md-nav__link> proxy-next-upstream-tries </a> </li> <li class=md-nav__item> <a href=#proxy-redirect-from class=md-nav__link> proxy-redirect-from </a> </li> <li class=md-nav__item> <a href=#proxy-request-buffering class=md-nav__link> proxy-request-buffering </a> </li> <li class=md-nav__item> <a href=#ssl-redirect class=md-nav__link> ssl-redirect </a> </li> <li class=md-nav__item> <a href=#whitelist-source-range class=md-nav__link> whitelist-source-range </a> </li> <li class=md-nav__item> <a href=#skip-access-log-urls class=md-nav__link> skip-access-log-urls </a> </li> <li class=md-nav__item> <a href=#limit-rate class=md-nav__link> limit-rate </a> </li> <li class=md-nav__item> <a href=#limit-rate-after class=md-nav__link> limit-rate-after </a> </li> <li class=md-nav__item> <a href=#lua-shared-dicts class=md-nav__link> lua-shared-dicts </a> </li> <li class=md-nav__item> <a href=#http-redirect-code class=md-nav__link> http-redirect-code </a> </li> <li class=md-nav__item> <a href=#proxy-buffering class=md-nav__link> proxy-buffering </a> </li> <li class=md-nav__item> <a href=#limit-req-status-code class=md-nav__link> limit-req-status-code </a> </li> <li class=md-nav__item> <a href=#limit-conn-status-code class=md-nav__link> limit-conn-status-code </a> </li> <li class=md-nav__item> <a href=#no-tls-redirect-locations class=md-nav__link> no-tls-redirect-locations </a> </li> <li class=md-nav__item> <a href=#global-auth-url class=md-nav__link> global-auth-url </a> </li> <li class=md-nav__item> <a href=#global-auth-method class=md-nav__link> global-auth-method </a> </li> <li class=md-nav__item> <a href=#global-auth-signin class=md-nav__link> global-auth-signin </a> </li> <li class=md-nav__item> <a href=#global-auth-signin-redirect-param class=md-nav__link> global-auth-signin-redirect-param </a> </li> <li class=md-nav__item> <a href=#global-auth-response-headers class=md-nav__link> global-auth-response-headers </a> </li> <li class=md-nav__item> <a href=#global-auth-request-redirect class=md-nav__link> global-auth-request-redirect </a> </li> <li class=md-nav__item> <a href=#global-auth-snippet class=md-nav__link> global-auth-snippet </a> </li> <li class=md-nav__item> <a href=#global-auth-cache-key class=md-nav__link> global-auth-cache-key </a> </li> <li class=md-nav__item> <a href=#global-auth-cache-duration class=md-nav__link> global-auth-cache-duration </a> </li> <li class=md-nav__item> <a href=#no-auth-locations class=md-nav__link> no-auth-locations </a> </li> <li class=md-nav__item> <a href=#block-cidrs class=md-nav__link> block-cidrs </a> </li> <li class=md-nav__item> <a href=#block-user-agents class=md-nav__link> block-user-agents </a> </li> <li class=md-nav__item> <a href=#block-referers class=md-nav__link> block-referers </a> </li> <li class=md-nav__item> <a href=#proxy-ssl-location-only class=md-nav__link> proxy-ssl-location-only </a> </li> <li class=md-nav__item> <a href=#default-type class=md-nav__link> default-type </a> </li> <li class=md-nav__item> <a href=#global-rate-limit class=md-nav__link> global-rate-limit </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../custom-template/ class=md-nav__link> Custom NGINX template </a> </li> <li class=md-nav__item> <a href=../log-format/ class=md-nav__link> Log format </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../cli-arguments/ class=md-nav__link> Command line arguments </a> </li> <li class=md-nav__item> <a href=../../custom-errors/ class=md-nav__link> Custom errors </a> </li> <li class=md-nav__item> <a href=../../default-backend/ class=md-nav__link> Default backend </a> </li> <li class=md-nav__item> <a href=../../exposing-tcp-udp-services/ class=md-nav__link> Exposing TCP and UDP services </a> </li> <li class=md-nav__item> <a href=../../fcgi-services/ class=md-nav__link> Exposing FCGI services </a> </li> <li class=md-nav__item> <a href=../../ingress-path-matching/ class=md-nav__link> Regular expressions in paths </a> </li> <li class=md-nav__item> <a href=../../external-articles/ class=md-nav__link> External Articles </a> </li> <li class=md-nav__item> <a href=../../miscellaneous/ class=md-nav__link> Miscellaneous </a> </li> <li class=md-nav__item> <a href=../../monitoring/ class=md-nav__link> Prometheus and Grafana installation </a> </li> <li class=md-nav__item> <a href=../../multiple-ingress/ class=md-nav__link> Multiple Ingress controllers </a> </li> <li class=md-nav__item> <a href=../../tls/ class=md-nav__link> TLS/HTTPS </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-3-13 type=checkbox id=nav-3-13> <label class=md-nav__link for=nav-3-13> Third party addons <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label="Third party addons" data-md-level=2> <label class=md-nav__title for=nav-3-13> <span class="md-nav__icon md-icon"></span> Third party addons </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../third-party-addons/modsecurity/ class=md-nav__link> ModSecurity Web Application Firewall </a> </li> <li class=md-nav__item> <a href=../../third-party-addons/opentracing/ class=md-nav__link> OpenTracing </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-4 type=checkbox id=nav-4> <label class=md-nav__link for=nav-4> Examples <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=Examples data-md-level=1> <label class=md-nav__title for=nav-4> <span class="md-nav__icon md-icon"></span> Examples </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../examples/ class=md-nav__link> Introduction </a> </li> <li class=md-nav__item> <a href=../../../examples/PREREQUISITES/ class=md-nav__link> Prerequisites </a> </li> <li class=md-nav__item> <a href=../../../examples/affinity/cookie/ class=md-nav__link> Sticky Sessions </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-4-4 type=checkbox id=nav-4-4> <label class=md-nav__link for=nav-4-4> Auth <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=Auth data-md-level=2> <label class=md-nav__title for=nav-4-4> <span class="md-nav__icon md-icon"></span> Auth </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../examples/auth/basic/ class=md-nav__link> Basic Authentication </a> </li> <li class=md-nav__item> <a href=../../../examples/auth/client-certs/ class=md-nav__link> Client Certificate Authentication </a> </li> <li class=md-nav__item> <a href=../../../examples/auth/external-auth/ class=md-nav__link> External Basic Authentication </a> </li> <li class=md-nav__item> <a href=../../../examples/auth/oauth-external-auth/ class=md-nav__link> External OAUTH Authentication </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-4-5 type=checkbox id=nav-4-5> <label class=md-nav__link for=nav-4-5> Customization <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label=Customization data-md-level=2> <label class=md-nav__title for=nav-4-5> <span class="md-nav__icon md-icon"></span> Customization </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../examples/customization/configuration-snippets/ class=md-nav__link> Configuration Snippets </a> </li> <li class=md-nav__item> <a href=../../../examples/customization/custom-configuration/ class=md-nav__link> Custom Configuration </a> </li> <li class=md-nav__item> <a href=../../../examples/customization/custom-errors/ class=md-nav__link> Custom Errors </a> </li> <li class=md-nav__item> <a href=../../../examples/customization/custom-headers/ class=md-nav__link> Custom Headers </a> </li> <li class=md-nav__item> <a href=../../../examples/customization/external-auth-headers/ class=md-nav__link> External authentication </a> </li> <li class=md-nav__item> <a href=../../../examples/customization/ssl-dh-param/ class=md-nav__link> Custom DH parameters for perfect forward secrecy </a> </li> <li class=md-nav__item> <a href=../../../examples/customization/sysctl/ class=md-nav__link> Sysctl tuning </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../../examples/docker-registry/ class=md-nav__link> Docker registry </a> </li> <li class=md-nav__item> <a href=../../../examples/grpc/ class=md-nav__link> gRPC </a> </li> <li class=md-nav__item> <a href=../../../examples/multi-tls/ class=md-nav__link> Multi TLS certificate termination </a> </li> <li class=md-nav__item> <a href=../../../examples/rewrite/ class=md-nav__link> Rewrite </a> </li> <li class=md-nav__item> <a href=../../../examples/static-ip/ class=md-nav__link> Static IPs </a> </li> <li class=md-nav__item> <a href=../../../examples/tls-termination/ class=md-nav__link> TLS termination </a> </li> <li class=md-nav__item> <a href=../../../examples/psp/ class=md-nav__link> Pod Security Policy (PSP) </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle" data-md-toggle=nav-5 type=checkbox id=nav-5> <label class=md-nav__link for=nav-5> Developer Guide <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav aria-label="Developer Guide" data-md-level=1> <label class=md-nav__title for=nav-5> <span class="md-nav__icon md-icon"></span> Developer Guide </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../developer-guide/getting-started/ class=md-nav__link> Getting Started </a> </li> <li class=md-nav__item> <a href=../../../developer-guide/code-overview/ class=md-nav__link> Code Overview </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=#configuration-options class=md-nav__link> Configuration options </a> </li> <li class=md-nav__item> <a href=#add-headers class=md-nav__link> add-headers </a> </li> <li class=md-nav__item> <a href=#allow-backend-server-header class=md-nav__link> allow-backend-server-header </a> </li> <li class=md-nav__item> <a href=#hide-headers class=md-nav__link> hide-headers </a> </li> <li class=md-nav__item> <a href=#access-log-params class=md-nav__link> access-log-params </a> </li> <li class=md-nav__item> <a href=#access-log-path class=md-nav__link> access-log-path </a> </li> <li class=md-nav__item> <a href=#http-access-log-path class=md-nav__link> http-access-log-path </a> </li> <li class=md-nav__item> <a href=#stream-access-log-path class=md-nav__link> stream-access-log-path </a> </li> <li class=md-nav__item> <a href=#enable-access-log-for-default-backend class=md-nav__link> enable-access-log-for-default-backend </a> </li> <li class=md-nav__item> <a href=#error-log-path class=md-nav__link> error-log-path </a> </li> <li class=md-nav__item> <a href=#enable-modsecurity class=md-nav__link> enable-modsecurity </a> </li> <li class=md-nav__item> <a href=#enable-owasp-modsecurity-crs class=md-nav__link> enable-owasp-modsecurity-crs </a> </li> <li class=md-nav__item> <a href=#modsecurity-snippet class=md-nav__link> modsecurity-snippet </a> </li> <li class=md-nav__item> <a href=#client-header-buffer-size class=md-nav__link> client-header-buffer-size </a> </li> <li class=md-nav__item> <a href=#client-header-timeout class=md-nav__link> client-header-timeout </a> </li> <li class=md-nav__item> <a href=#client-body-buffer-size class=md-nav__link> client-body-buffer-size </a> </li> <li class=md-nav__item> <a href=#client-body-timeout class=md-nav__link> client-body-timeout </a> </li> <li class=md-nav__item> <a href=#disable-access-log class=md-nav__link> disable-access-log </a> </li> <li class=md-nav__item> <a href=#disable-ipv6 class=md-nav__link> disable-ipv6 </a> </li> <li class=md-nav__item> <a href=#disable-ipv6-dns class=md-nav__link> disable-ipv6-dns </a> </li> <li class=md-nav__item> <a href=#enable-underscores-in-headers class=md-nav__link> enable-underscores-in-headers </a> </li> <li class=md-nav__item> <a href=#enable-ocsp class=md-nav__link> enable-ocsp </a> </li> <li class=md-nav__item> <a href=#ignore-invalid-headers class=md-nav__link> ignore-invalid-headers </a> </li> <li class=md-nav__item> <a href=#retry-non-idempotent class=md-nav__link> retry-non-idempotent </a> </li> <li class=md-nav__item> <a href=#error-log-level class=md-nav__link> error-log-level </a> </li> <li class=md-nav__item> <a href=#http2-max-field-size class=md-nav__link> http2-max-field-size </a> </li> <li class=md-nav__item> <a href=#http2-max-header-size class=md-nav__link> http2-max-header-size </a> </li> <li class=md-nav__item> <a href=#http2-max-requests class=md-nav__link> http2-max-requests </a> </li> <li class=md-nav__item> <a href=#http2-max-concurrent-streams class=md-nav__link> http2-max-concurrent-streams </a> </li> <li class=md-nav__item> <a href=#hsts class=md-nav__link> hsts </a> </li> <li class=md-nav__item> <a href=#hsts-include-subdomains class=md-nav__link> hsts-include-subdomains </a> </li> <li class=md-nav__item> <a href=#hsts-max-age class=md-nav__link> hsts-max-age </a> </li> <li class=md-nav__item> <a href=#hsts-preload class=md-nav__link> hsts-preload </a> </li> <li class=md-nav__item> <a href=#keep-alive class=md-nav__link> keep-alive </a> </li> <li class=md-nav__item> <a href=#keep-alive-requests class=md-nav__link> keep-alive-requests </a> </li> <li class=md-nav__item> <a href=#large-client-header-buffers class=md-nav__link> large-client-header-buffers </a> </li> <li class=md-nav__item> <a href=#log-format-escape-json class=md-nav__link> log-format-escape-json </a> </li> <li class=md-nav__item> <a href=#log-format-upstream class=md-nav__link> log-format-upstream </a> </li> <li class=md-nav__item> <a href=#log-format-stream class=md-nav__link> log-format-stream </a> </li> <li class=md-nav__item> <a href=#enable-multi-accept class=md-nav__link> enable-multi-accept </a> </li> <li class=md-nav__item> <a href=#max-worker-connections class=md-nav__link> max-worker-connections </a> </li> <li class=md-nav__item> <a href=#max-worker-open-files class=md-nav__link> max-worker-open-files </a> </li> <li class=md-nav__item> <a href=#map-hash-bucket-size class=md-nav__link> map-hash-bucket-size </a> </li> <li class=md-nav__item> <a href=#proxy-real-ip-cidr class=md-nav__link> proxy-real-ip-cidr </a> </li> <li class=md-nav__item> <a href=#proxy-set-headers class=md-nav__link> proxy-set-headers </a> </li> <li class=md-nav__item> <a href=#server-name-hash-max-size class=md-nav__link> server-name-hash-max-size </a> </li> <li class=md-nav__item> <a href=#server-name-hash-bucket-size class=md-nav__link> server-name-hash-bucket-size </a> </li> <li class=md-nav__item> <a href=#proxy-headers-hash-max-size class=md-nav__link> proxy-headers-hash-max-size </a> </li> <li class=md-nav__item> <a href=#reuse-port class=md-nav__link> reuse-port </a> </li> <li class=md-nav__item> <a href=#proxy-headers-hash-bucket-size class=md-nav__link> proxy-headers-hash-bucket-size </a> </li> <li class=md-nav__item> <a href=#plugins class=md-nav__link> plugins </a> </li> <li class=md-nav__item> <a href=#server-tokens class=md-nav__link> server-tokens </a> </li> <li class=md-nav__item> <a href=#ssl-ciphers class=md-nav__link> ssl-ciphers </a> </li> <li class=md-nav__item> <a href=#ssl-ecdh-curve class=md-nav__link> ssl-ecdh-curve </a> </li> <li class=md-nav__item> <a href=#ssl-dh-param class=md-nav__link> ssl-dh-param </a> </li> <li class=md-nav__item> <a href=#ssl-protocols class=md-nav__link> ssl-protocols </a> </li> <li class=md-nav__item> <a href=#ssl-early-data class=md-nav__link> ssl-early-data </a> </li> <li class=md-nav__item> <a href=#ssl-session-cache class=md-nav__link> ssl-session-cache </a> </li> <li class=md-nav__item> <a href=#ssl-session-cache-size class=md-nav__link> ssl-session-cache-size </a> </li> <li class=md-nav__item> <a href=#ssl-session-tickets class=md-nav__link> ssl-session-tickets </a> </li> <li class=md-nav__item> <a href=#ssl-session-ticket-key class=md-nav__link> ssl-session-ticket-key </a> </li> <li class=md-nav__item> <a href=#ssl-session-timeout class=md-nav__link> ssl-session-timeout </a> </li> <li class=md-nav__item> <a href=#ssl-buffer-size class=md-nav__link> ssl-buffer-size </a> </li> <li class=md-nav__item> <a href=#use-proxy-protocol class=md-nav__link> use-proxy-protocol </a> </li> <li class=md-nav__item> <a href=#proxy-protocol-header-timeout class=md-nav__link> proxy-protocol-header-timeout </a> </li> <li class=md-nav__item> <a href=#use-gzip class=md-nav__link> use-gzip </a> </li> <li class=md-nav__item> <a href=#use-geoip class=md-nav__link> use-geoip </a> </li> <li class=md-nav__item> <a href=#use-geoip2 class=md-nav__link> use-geoip2 </a> </li> <li class=md-nav__item> <a href=#enable-brotli class=md-nav__link> enable-brotli </a> </li> <li class=md-nav__item> <a href=#brotli-level class=md-nav__link> brotli-level </a> </li> <li class=md-nav__item> <a href=#brotli-types class=md-nav__link> brotli-types </a> </li> <li class=md-nav__item> <a href=#use-http2 class=md-nav__link> use-http2 </a> </li> <li class=md-nav__item> <a href=#gzip-level class=md-nav__link> gzip-level </a> </li> <li class=md-nav__item> <a href=#gzip-min-length class=md-nav__link> gzip-min-length </a> </li> <li class=md-nav__item> <a href=#gzip-types class=md-nav__link> gzip-types </a> </li> <li class=md-nav__item> <a href=#worker-processes class=md-nav__link> worker-processes </a> </li> <li class=md-nav__item> <a href=#worker-cpu-affinity class=md-nav__link> worker-cpu-affinity </a> </li> <li class=md-nav__item> <a href=#worker-shutdown-timeout class=md-nav__link> worker-shutdown-timeout </a> </li> <li class=md-nav__item> <a href=#load-balance class=md-nav__link> load-balance </a> </li> <li class=md-nav__item> <a href=#variables-hash-bucket-size class=md-nav__link> variables-hash-bucket-size </a> </li> <li class=md-nav__item> <a href=#variables-hash-max-size class=md-nav__link> variables-hash-max-size </a> </li> <li class=md-nav__item> <a href=#upstream-keepalive-connections class=md-nav__link> upstream-keepalive-connections </a> </li> <li class=md-nav__item> <a href=#upstream-keepalive-timeout class=md-nav__link> upstream-keepalive-timeout </a> </li> <li class=md-nav__item> <a href=#upstream-keepalive-requests class=md-nav__link> upstream-keepalive-requests </a> </li> <li class=md-nav__item> <a href=#limit-conn-zone-variable class=md-nav__link> limit-conn-zone-variable </a> </li> <li class=md-nav__item> <a href=#proxy-stream-timeout class=md-nav__link> proxy-stream-timeout </a> </li> <li class=md-nav__item> <a href=#proxy-stream-next-upstream class=md-nav__link> proxy-stream-next-upstream </a> </li> <li class=md-nav__item> <a href=#proxy-stream-next-upstream-timeout class=md-nav__link> proxy-stream-next-upstream-timeout </a> </li> <li class=md-nav__item> <a href=#proxy-stream-next-upstream-tries class=md-nav__link> proxy-stream-next-upstream-tries </a> </li> <li class=md-nav__item> <a href=#proxy-stream-responses class=md-nav__link> proxy-stream-responses </a> </li> <li class=md-nav__item> <a href=#bind-address class=md-nav__link> bind-address </a> </li> <li class=md-nav__item> <a href=#use-forwarded-headers class=md-nav__link> use-forwarded-headers </a> </li> <li class=md-nav__item> <a href=#enable-real-ip class=md-nav__link> enable-real-ip </a> </li> <li class=md-nav__item> <a href=#forwarded-for-header class=md-nav__link> forwarded-for-header </a> </li> <li class=md-nav__item> <a href=#compute-full-forwarded-for class=md-nav__link> compute-full-forwarded-for </a> </li> <li class=md-nav__item> <a href=#proxy-add-original-uri-header class=md-nav__link> proxy-add-original-uri-header </a> </li> <li class=md-nav__item> <a href=#generate-request-id class=md-nav__link> generate-request-id </a> </li> <li class=md-nav__item> <a href=#enable-opentracing class=md-nav__link> enable-opentracing </a> </li> <li class=md-nav__item> <a href=#opentracing-operation-name class=md-nav__link> opentracing-operation-name </a> </li> <li class=md-nav__item> <a href=#opentracing-location-operation-name class=md-nav__link> opentracing-location-operation-name </a> </li> <li class=md-nav__item> <a href=#zipkin-collector-host class=md-nav__link> zipkin-collector-host </a> </li> <li class=md-nav__item> <a href=#zipkin-collector-port class=md-nav__link> zipkin-collector-port </a> </li> <li class=md-nav__item> <a href=#zipkin-service-name class=md-nav__link> zipkin-service-name </a> </li> <li class=md-nav__item> <a href=#zipkin-sample-rate class=md-nav__link> zipkin-sample-rate </a> </li> <li class=md-nav__item> <a href=#jaeger-collector-host class=md-nav__link> jaeger-collector-host </a> </li> <li class=md-nav__item> <a href=#jaeger-collector-port class=md-nav__link> jaeger-collector-port </a> </li> <li class=md-nav__item> <a href=#jaeger-endpoint class=md-nav__link> jaeger-endpoint </a> </li> <li class=md-nav__item> <a href=#jaeger-service-name class=md-nav__link> jaeger-service-name </a> </li> <li class=md-nav__item> <a href=#jaeger-propagation-format class=md-nav__link> jaeger-propagation-format </a> </li> <li class=md-nav__item> <a href=#jaeger-sampler-type class=md-nav__link> jaeger-sampler-type </a> </li> <li class=md-nav__item> <a href=#jaeger-sampler-param class=md-nav__link> jaeger-sampler-param </a> </li> <li class=md-nav__item> <a href=#jaeger-sampler-host class=md-nav__link> jaeger-sampler-host </a> </li> <li class=md-nav__item> <a href=#jaeger-sampler-port class=md-nav__link> jaeger-sampler-port </a> </li> <li class=md-nav__item> <a href=#jaeger-trace-context-header-name class=md-nav__link> jaeger-trace-context-header-name </a> </li> <li class=md-nav__item> <a href=#jaeger-debug-header class=md-nav__link> jaeger-debug-header </a> </li> <li class=md-nav__item> <a href=#jaeger-baggage-header class=md-nav__link> jaeger-baggage-header </a> </li> <li class=md-nav__item> <a href=#jaeger-tracer-baggage-header-prefix class=md-nav__link> jaeger-tracer-baggage-header-prefix </a> </li> <li class=md-nav__item> <a href=#datadog-collector-host class=md-nav__link> datadog-collector-host </a> </li> <li class=md-nav__item> <a href=#datadog-collector-port class=md-nav__link> datadog-collector-port </a> </li> <li class=md-nav__item> <a href=#datadog-service-name class=md-nav__link> datadog-service-name </a> </li> <li class=md-nav__item> <a href=#datadog-environment class=md-nav__link> datadog-environment </a> </li> <li class=md-nav__item> <a href=#datadog-operation-name-override class=md-nav__link> datadog-operation-name-override </a> </li> <li class=md-nav__item> <a href=#datadog-priority-sampling class=md-nav__link> datadog-priority-sampling </a> </li> <li class=md-nav__item> <a href=#datadog-sample-rate class=md-nav__link> datadog-sample-rate </a> </li> <li class=md-nav__item> <a href=#main-snippet class=md-nav__link> main-snippet </a> </li> <li class=md-nav__item> <a href=#http-snippet class=md-nav__link> http-snippet </a> </li> <li class=md-nav__item> <a href=#server-snippet class=md-nav__link> server-snippet </a> </li> <li class=md-nav__item> <a href=#location-snippet class=md-nav__link> location-snippet </a> </li> <li class=md-nav__item> <a href=#custom-http-errors class=md-nav__link> custom-http-errors </a> </li> <li class=md-nav__item> <a href=#proxy-body-size class=md-nav__link> proxy-body-size </a> </li> <li class=md-nav__item> <a href=#proxy-connect-timeout class=md-nav__link> proxy-connect-timeout </a> </li> <li class=md-nav__item> <a href=#proxy-read-timeout class=md-nav__link> proxy-read-timeout </a> </li> <li class=md-nav__item> <a href=#proxy-send-timeout class=md-nav__link> proxy-send-timeout </a> </li> <li class=md-nav__item> <a href=#proxy-buffers-number class=md-nav__link> proxy-buffers-number </a> </li> <li class=md-nav__item> <a href=#proxy-buffer-size class=md-nav__link> proxy-buffer-size </a> </li> <li class=md-nav__item> <a href=#proxy-cookie-path class=md-nav__link> proxy-cookie-path </a> </li> <li class=md-nav__item> <a href=#proxy-cookie-domain class=md-nav__link> proxy-cookie-domain </a> </li> <li class=md-nav__item> <a href=#proxy-next-upstream class=md-nav__link> proxy-next-upstream </a> </li> <li class=md-nav__item> <a href=#proxy-next-upstream-timeout class=md-nav__link> proxy-next-upstream-timeout </a> </li> <li class=md-nav__item> <a href=#proxy-next-upstream-tries class=md-nav__link> proxy-next-upstream-tries </a> </li> <li class=md-nav__item> <a href=#proxy-redirect-from class=md-nav__link> proxy-redirect-from </a> </li> <li class=md-nav__item> <a href=#proxy-request-buffering class=md-nav__link> proxy-request-buffering </a> </li> <li class=md-nav__item> <a href=#ssl-redirect class=md-nav__link> ssl-redirect </a> </li> <li class=md-nav__item> <a href=#whitelist-source-range class=md-nav__link> whitelist-source-range </a> </li> <li class=md-nav__item> <a href=#skip-access-log-urls class=md-nav__link> skip-access-log-urls </a> </li> <li class=md-nav__item> <a href=#limit-rate class=md-nav__link> limit-rate </a> </li> <li class=md-nav__item> <a href=#limit-rate-after class=md-nav__link> limit-rate-after </a> </li> <li class=md-nav__item> <a href=#lua-shared-dicts class=md-nav__link> lua-shared-dicts </a> </li> <li class=md-nav__item> <a href=#http-redirect-code class=md-nav__link> http-redirect-code </a> </li> <li class=md-nav__item> <a href=#proxy-buffering class=md-nav__link> proxy-buffering </a> </li> <li class=md-nav__item> <a href=#limit-req-status-code class=md-nav__link> limit-req-status-code </a> </li> <li class=md-nav__item> <a href=#limit-conn-status-code class=md-nav__link> limit-conn-status-code </a> </li> <li class=md-nav__item> <a href=#no-tls-redirect-locations class=md-nav__link> no-tls-redirect-locations </a> </li> <li class=md-nav__item> <a href=#global-auth-url class=md-nav__link> global-auth-url </a> </li> <li class=md-nav__item> <a href=#global-auth-method class=md-nav__link> global-auth-method </a> </li> <li class=md-nav__item> <a href=#global-auth-signin class=md-nav__link> global-auth-signin </a> </li> <li class=md-nav__item> <a href=#global-auth-signin-redirect-param class=md-nav__link> global-auth-signin-redirect-param </a> </li> <li class=md-nav__item> <a href=#global-auth-response-headers class=md-nav__link> global-auth-response-headers </a> </li> <li class=md-nav__item> <a href=#global-auth-request-redirect class=md-nav__link> global-auth-request-redirect </a> </li> <li class=md-nav__item> <a href=#global-auth-snippet class=md-nav__link> global-auth-snippet </a> </li> <li class=md-nav__item> <a href=#global-auth-cache-key class=md-nav__link> global-auth-cache-key </a> </li> <li class=md-nav__item> <a href=#global-auth-cache-duration class=md-nav__link> global-auth-cache-duration </a> </li> <li class=md-nav__item> <a href=#no-auth-locations class=md-nav__link> no-auth-locations </a> </li> <li class=md-nav__item> <a href=#block-cidrs class=md-nav__link> block-cidrs </a> </li> <li class=md-nav__item> <a href=#block-user-agents class=md-nav__link> block-user-agents </a> </li> <li class=md-nav__item> <a href=#block-referers class=md-nav__link> block-referers </a> </li> <li class=md-nav__item> <a href=#proxy-ssl-location-only class=md-nav__link> proxy-ssl-location-only </a> </li> <li class=md-nav__item> <a href=#default-type class=md-nav__link> default-type </a> </li> <li class=md-nav__item> <a href=#global-rate-limit class=md-nav__link> global-rate-limit </a> </li> </ul> </nav> </div> </div> </div> <div class=md-content> <article class="md-content__inner md-typeset"> <a href=https://github.com/kubernetes/ingress-nginx/edit/master/docs/user-guide/nginx-configuration/configmap.md title="Edit this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg> </a> <h1 id=configmaps>ConfigMaps<a class=headerlink href=#configmaps title="Permanent link"></a></h1> <p>ConfigMaps allow you to decouple configuration artifacts from image content to keep containerized applications portable.</p> <p>The ConfigMap API resource stores configuration data as key-value pairs. The data provides the configurations for system components for the nginx-controller.</p> <p>In order to overwrite nginx-controller configuration values as seen in <a href=https://github.com/kubernetes/ingress-nginx/blob/master/internal/ingress/controller/config/config.go>config.go</a>, you can add key-value pairs to the data section of the config-map. For Example:</p> <div class=highlight><pre><span></span><code><span class=nt>data</span><span class=p>:</span>
<span class=nt>map-hash-bucket-size</span><span class=p>:</span> <span class=s>&quot;128&quot;</span>
<span class=nt>ssl-protocols</span><span class=p>:</span> <span class="l l-Scalar l-Scalar-Plain">SSLv2</span>
</code></pre></div> <div class="admonition important"> <p class=admonition-title>Important</p> <p>The key and values in a ConfigMap can only be strings. 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".</p> <p>"Slice" types (defined below as <code>[]string</code> or <code>[]int</code>) can be provided as a comma-delimited string.</p> </div> <h2 id=configuration-options>Configuration options<a class=headerlink href=#configuration-options title="Permanent link"></a></h2> <p>The following table shows a configuration option's name, type, and the default value:</p> <table> <thead> <tr> <th align=left>name</th> <th align=left>type</th> <th align=left>default</th> </tr> </thead> <tbody> <tr> <td align=left><a href=#add-headers>add-headers</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#allow-backend-server-header>allow-backend-server-header</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#hide-headers>hide-headers</a></td> <td align=left>string array</td> <td align=left>empty</td> </tr> <tr> <td align=left><a href=#access-log-params>access-log-params</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#access-log-path>access-log-path</a></td> <td align=left>string</td> <td align=left>"/var/log/nginx/access.log"</td> </tr> <tr> <td align=left><a href=#http-access-log-path>http-access-log-path</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#stream-access-log-path>stream-access-log-path</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#enable-access-log-for-default-backend>enable-access-log-for-default-backend</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#error-log-path>error-log-path</a></td> <td align=left>string</td> <td align=left>"/var/log/nginx/error.log"</td> </tr> <tr> <td align=left><a href=#enable-modsecurity>enable-modsecurity</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#modsecurity-snippet>modsecurity-snippet</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#enable-owasp-modsecurity-crs>enable-owasp-modsecurity-crs</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#client-header-buffer-size>client-header-buffer-size</a></td> <td align=left>string</td> <td align=left>"1k"</td> </tr> <tr> <td align=left><a href=#client-header-timeout>client-header-timeout</a></td> <td align=left>int</td> <td align=left>60</td> </tr> <tr> <td align=left><a href=#client-body-buffer-size>client-body-buffer-size</a></td> <td align=left>string</td> <td align=left>"8k"</td> </tr> <tr> <td align=left><a href=#client-body-timeout>client-body-timeout</a></td> <td align=left>int</td> <td align=left>60</td> </tr> <tr> <td align=left><a href=#disable-access-log>disable-access-log</a></td> <td align=left>bool</td> <td align=left>false</td> </tr> <tr> <td align=left><a href=#disable-ipv6>disable-ipv6</a></td> <td align=left>bool</td> <td align=left>false</td> </tr> <tr> <td align=left><a href=#disable-ipv6-dns>disable-ipv6-dns</a></td> <td align=left>bool</td> <td align=left>false</td> </tr> <tr> <td align=left><a href=#enable-underscores-in-headers>enable-underscores-in-headers</a></td> <td align=left>bool</td> <td align=left>false</td> </tr> <tr> <td align=left><a href=#enable-ocsp>enable-ocsp</a></td> <td align=left>bool</td> <td align=left>false</td> </tr> <tr> <td align=left><a href=#ignore-invalid-headers>ignore-invalid-headers</a></td> <td align=left>bool</td> <td align=left>true</td> </tr> <tr> <td align=left><a href=#retry-non-idempotent>retry-non-idempotent</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#error-log-level>error-log-level</a></td> <td align=left>string</td> <td align=left>"notice"</td> </tr> <tr> <td align=left><a href=#http2-max-field-size>http2-max-field-size</a></td> <td align=left>string</td> <td align=left>"4k"</td> </tr> <tr> <td align=left><a href=#http2-max-header-size>http2-max-header-size</a></td> <td align=left>string</td> <td align=left>"16k"</td> </tr> <tr> <td align=left><a href=#http2-max-requests>http2-max-requests</a></td> <td align=left>int</td> <td align=left>1000</td> </tr> <tr> <td align=left><a href=#http2-max-concurrent-streams>http2-max-concurrent-streams</a></td> <td align=left>int</td> <td align=left>1000</td> </tr> <tr> <td align=left><a href=#hsts>hsts</a></td> <td align=left>bool</td> <td align=left>"true"</td> </tr> <tr> <td align=left><a href=#hsts-include-subdomains>hsts-include-subdomains</a></td> <td align=left>bool</td> <td align=left>"true"</td> </tr> <tr> <td align=left><a href=#hsts-max-age>hsts-max-age</a></td> <td align=left>string</td> <td align=left>"15724800"</td> </tr> <tr> <td align=left><a href=#hsts-preload>hsts-preload</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#keep-alive>keep-alive</a></td> <td align=left>int</td> <td align=left>75</td> </tr> <tr> <td align=left><a href=#keep-alive-requests>keep-alive-requests</a></td> <td align=left>int</td> <td align=left>100</td> </tr> <tr> <td align=left><a href=#large-client-header-buffers>large-client-header-buffers</a></td> <td align=left>string</td> <td align=left>"4 8k"</td> </tr> <tr> <td align=left><a href=#log-format-escape-json>log-format-escape-json</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#log-format-upstream>log-format-upstream</a></td> <td align=left>string</td> <td align=left><code>$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" $request_length $request_time [$proxy_upstream_name] [$proxy_alternative_upstream_name] $upstream_addr $upstream_response_length $upstream_response_time $upstream_status $req_id</code></td> </tr> <tr> <td align=left><a href=#log-format-stream>log-format-stream</a></td> <td align=left>string</td> <td align=left><code>[$remote_addr] [$time_local] $protocol $status $bytes_sent $bytes_received $session_time</code></td> </tr> <tr> <td align=left><a href=#enable-multi-accept>enable-multi-accept</a></td> <td align=left>bool</td> <td align=left>"true"</td> </tr> <tr> <td align=left><a href=#max-worker-connections>max-worker-connections</a></td> <td align=left>int</td> <td align=left>16384</td> </tr> <tr> <td align=left><a href=#max-worker-open-files>max-worker-open-files</a></td> <td align=left>int</td> <td align=left>0</td> </tr> <tr> <td align=left><a href=#max-hash-bucket-size>map-hash-bucket-size</a></td> <td align=left>int</td> <td align=left>64</td> </tr> <tr> <td align=left><a href=#nginx-status-ipv4-whitelist>nginx-status-ipv4-whitelist</a></td> <td align=left>[]string</td> <td align=left>"127.0.0.1"</td> </tr> <tr> <td align=left><a href=#nginx-status-ipv6-whitelist>nginx-status-ipv6-whitelist</a></td> <td align=left>[]string</td> <td align=left>"::1"</td> </tr> <tr> <td align=left><a href=#proxy-real-ip-cidr>proxy-real-ip-cidr</a></td> <td align=left>[]string</td> <td align=left>"0.0.0.0/0"</td> </tr> <tr> <td align=left><a href=#proxy-set-headers>proxy-set-headers</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#server-name-hash-max-size>server-name-hash-max-size</a></td> <td align=left>int</td> <td align=left>1024</td> </tr> <tr> <td align=left><a href=#server-name-hash-bucket-size>server-name-hash-bucket-size</a></td> <td align=left>int</td> <td align=left><code>&lt;size of the processor’s cache line&gt;</code></td> </tr> <tr> <td align=left><a href=#proxy-headers-hash-max-size>proxy-headers-hash-max-size</a></td> <td align=left>int</td> <td align=left>512</td> </tr> <tr> <td align=left><a href=#proxy-headers-hash-bucket-size>proxy-headers-hash-bucket-size</a></td> <td align=left>int</td> <td align=left>64</td> </tr> <tr> <td align=left><a href=#plugins>plugins</a></td> <td align=left>[]string</td> <td align=left></td> </tr> <tr> <td align=left><a href=#reuse-port>reuse-port</a></td> <td align=left>bool</td> <td align=left>"true"</td> </tr> <tr> <td align=left><a href=#server-tokens>server-tokens</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#ssl-ciphers>ssl-ciphers</a></td> <td align=left>string</td> <td align=left>"ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384"</td> </tr> <tr> <td align=left><a href=#ssl-ecdh-curve>ssl-ecdh-curve</a></td> <td align=left>string</td> <td align=left>"auto"</td> </tr> <tr> <td align=left><a href=#ssl-dh-param>ssl-dh-param</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#ssl-protocols>ssl-protocols</a></td> <td align=left>string</td> <td align=left>"TLSv1.2 TLSv1.3"</td> </tr> <tr> <td align=left><a href=#ssl-session-cache>ssl-session-cache</a></td> <td align=left>bool</td> <td align=left>"true"</td> </tr> <tr> <td align=left><a href=#ssl-session-cache-size>ssl-session-cache-size</a></td> <td align=left>string</td> <td align=left>"10m"</td> </tr> <tr> <td align=left><a href=#ssl-session-tickets>ssl-session-tickets</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#ssl-session-ticket-key>ssl-session-ticket-key</a></td> <td align=left>string</td> <td align=left><code>&lt;Randomly Generated&gt;</code></td> </tr> <tr> <td align=left><a href=#ssl-session-timeout>ssl-session-timeout</a></td> <td align=left>string</td> <td align=left>"10m"</td> </tr> <tr> <td align=left><a href=#ssl-buffer-size>ssl-buffer-size</a></td> <td align=left>string</td> <td align=left>"4k"</td> </tr> <tr> <td align=left><a href=#use-proxy-protocol>use-proxy-protocol</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#proxy-protocol-header-timeout>proxy-protocol-header-timeout</a></td> <td align=left>string</td> <td align=left>"5s"</td> </tr> <tr> <td align=left><a href=#use-gzip>use-gzip</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#use-geoip>use-geoip</a></td> <td align=left>bool</td> <td align=left>"true"</td> </tr> <tr> <td align=left><a href=#use-geoip2>use-geoip2</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#enable-brotli>enable-brotli</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#brotli-level>brotli-level</a></td> <td align=left>int</td> <td align=left>4</td> </tr> <tr> <td align=left><a href=#brotli-types>brotli-types</a></td> <td align=left>string</td> <td align=left>"application/xml+rss application/atom+xml application/javascript application/x-javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/svg+xml image/x-icon text/css text/javascript text/plain text/x-component"</td> </tr> <tr> <td align=left><a href=#use-http2>use-http2</a></td> <td align=left>bool</td> <td align=left>"true"</td> </tr> <tr> <td align=left><a href=#gzip-level>gzip-level</a></td> <td align=left>int</td> <td align=left>1</td> </tr> <tr> <td align=left><a href=#gzip-types>gzip-types</a></td> <td align=left>string</td> <td align=left>"application/atom+xml application/javascript application/x-javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/svg+xml image/x-icon text/css text/javascript text/plain text/x-component"</td> </tr> <tr> <td align=left><a href=#worker-processes>worker-processes</a></td> <td align=left>string</td> <td align=left><code>&lt;Number of CPUs&gt;</code></td> </tr> <tr> <td align=left><a href=#worker-cpu-affinity>worker-cpu-affinity</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#worker-shutdown-timeout>worker-shutdown-timeout</a></td> <td align=left>string</td> <td align=left>"240s"</td> </tr> <tr> <td align=left><a href=#load-balance>load-balance</a></td> <td align=left>string</td> <td align=left>"round_robin"</td> </tr> <tr> <td align=left><a href=#variables-hash-bucket-size>variables-hash-bucket-size</a></td> <td align=left>int</td> <td align=left>128</td> </tr> <tr> <td align=left><a href=#variables-hash-max-size>variables-hash-max-size</a></td> <td align=left>int</td> <td align=left>2048</td> </tr> <tr> <td align=left><a href=#upstream-keepalive-connections>upstream-keepalive-connections</a></td> <td align=left>int</td> <td align=left>320</td> </tr> <tr> <td align=left><a href=#upstream-keepalive-timeout>upstream-keepalive-timeout</a></td> <td align=left>int</td> <td align=left>60</td> </tr> <tr> <td align=left><a href=#upstream-keepalive-requests>upstream-keepalive-requests</a></td> <td align=left>int</td> <td align=left>10000</td> </tr> <tr> <td align=left><a href=#limit-conn-zone-variable>limit-conn-zone-variable</a></td> <td align=left>string</td> <td align=left>"$binary_remote_addr"</td> </tr> <tr> <td align=left><a href=#proxy-stream-timeout>proxy-stream-timeout</a></td> <td align=left>string</td> <td align=left>"600s"</td> </tr> <tr> <td align=left><a href=#proxy-stream-next-upstream>proxy-stream-next-upstream</a></td> <td align=left>bool</td> <td align=left>"true"</td> </tr> <tr> <td align=left><a href=#proxy-stream-next-upstream-timeout>proxy-stream-next-upstream-timeout</a></td> <td align=left>string</td> <td align=left>"600s"</td> </tr> <tr> <td align=left><a href=#proxy-stream-next-upstream-tries>proxy-stream-next-upstream-tries</a></td> <td align=left>int</td> <td align=left>3</td> </tr> <tr> <td align=left><a href=#proxy-stream-responses>proxy-stream-responses</a></td> <td align=left>int</td> <td align=left>1</td> </tr> <tr> <td align=left><a href=#bind-address>bind-address</a></td> <td align=left>[]string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#use-forwarded-headers>use-forwarded-headers</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#enable-real-ip>enable-real-ip</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#forwarded-for-header>forwarded-for-header</a></td> <td align=left>string</td> <td align=left>"X-Forwarded-For"</td> </tr> <tr> <td align=left><a href=#compute-full-forwarded-for>compute-full-forwarded-for</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#proxy-add-original-uri-header>proxy-add-original-uri-header</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#generate-request-id>generate-request-id</a></td> <td align=left>bool</td> <td align=left>"true"</td> </tr> <tr> <td align=left><a href=#enable-opentracing>enable-opentracing</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#opentracing-operation-name>opentracing-operation-name</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#opentracing-location-operation-name>opentracing-location-operation-name</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#zipkin-collector-host>zipkin-collector-host</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#zipkin-collector-port>zipkin-collector-port</a></td> <td align=left>int</td> <td align=left>9411</td> </tr> <tr> <td align=left><a href=#zipkin-service-name>zipkin-service-name</a></td> <td align=left>string</td> <td align=left>"nginx"</td> </tr> <tr> <td align=left><a href=#zipkin-sample-rate>zipkin-sample-rate</a></td> <td align=left>float</td> <td align=left>1.0</td> </tr> <tr> <td align=left><a href=#jaeger-collector-host>jaeger-collector-host</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#jaeger-collector-port>jaeger-collector-port</a></td> <td align=left>int</td> <td align=left>6831</td> </tr> <tr> <td align=left><a href=#jaeger-endpoint>jaeger-endpoint</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#jaeger-service-name>jaeger-service-name</a></td> <td align=left>string</td> <td align=left>"nginx"</td> </tr> <tr> <td align=left><a href=#jaeger-propagation-format>jaeger-propagation-format</a></td> <td align=left>string</td> <td align=left>"jaeger"</td> </tr> <tr> <td align=left><a href=#jaeger-sampler-type>jaeger-sampler-type</a></td> <td align=left>string</td> <td align=left>"const"</td> </tr> <tr> <td align=left><a href=#jaeger-sampler-param>jaeger-sampler-param</a></td> <td align=left>string</td> <td align=left>"1"</td> </tr> <tr> <td align=left><a href=#jaeger-sampler-host>jaeger-sampler-host</a></td> <td align=left>string</td> <td align=left>"http://127.0.0.1"</td> </tr> <tr> <td align=left><a href=#jaeger-sampler-port>jaeger-sampler-port</a></td> <td align=left>int</td> <td align=left>5778</td> </tr> <tr> <td align=left><a href=#jaeger-trace-context-header-name>jaeger-trace-context-header-name</a></td> <td align=left>string</td> <td align=left>uber-trace-id</td> </tr> <tr> <td align=left><a href=#jaeger-debug-header>jaeger-debug-header</a></td> <td align=left>string</td> <td align=left>uber-debug-id</td> </tr> <tr> <td align=left><a href=#jaeger-baggage-header>jaeger-baggage-header</a></td> <td align=left>string</td> <td align=left>jaeger-baggage</td> </tr> <tr> <td align=left><a href=#jaeger-trace-baggage-header-prefix>jaeger-trace-baggage-header-prefix</a></td> <td align=left>string</td> <td align=left>uberctx-</td> </tr> <tr> <td align=left><a href=#datadog-collector-host>datadog-collector-host</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#datadog-collector-port>datadog-collector-port</a></td> <td align=left>int</td> <td align=left>8126</td> </tr> <tr> <td align=left><a href=#datadog-service-name>datadog-service-name</a></td> <td align=left>string</td> <td align=left>"nginx"</td> </tr> <tr> <td align=left><a href=#datadog-environment>datadog-environment</a></td> <td align=left>string</td> <td align=left>"prod"</td> </tr> <tr> <td align=left><a href=#datadog-operation-name-override>datadog-operation-name-override</a></td> <td align=left>string</td> <td align=left>"nginx.handle"</td> </tr> <tr> <td align=left><a href=#datadog-priority-sampling>datadog-priority-sampling</a></td> <td align=left>bool</td> <td align=left>"true"</td> </tr> <tr> <td align=left><a href=#datadog-sample-rate>datadog-sample-rate</a></td> <td align=left>float</td> <td align=left>1.0</td> </tr> <tr> <td align=left><a href=#main-snippet>main-snippet</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#http-snippet>http-snippet</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#server-snippet>server-snippet</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#location-snippet>location-snippet</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#custom-http-errors>custom-http-errors</a></td> <td align=left>[]int</td> <td align=left>[]int{}</td> </tr> <tr> <td align=left><a href=#proxy-body-size>proxy-body-size</a></td> <td align=left>string</td> <td align=left>"1m"</td> </tr> <tr> <td align=left><a href=#proxy-connect-timeout>proxy-connect-timeout</a></td> <td align=left>int</td> <td align=left>5</td> </tr> <tr> <td align=left><a href=#proxy-read-timeout>proxy-read-timeout</a></td> <td align=left>int</td> <td align=left>60</td> </tr> <tr> <td align=left><a href=#proxy-send-timeout>proxy-send-timeout</a></td> <td align=left>int</td> <td align=left>60</td> </tr> <tr> <td align=left><a href=#proxy-buffers-number>proxy-buffers-number</a></td> <td align=left>int</td> <td align=left>4</td> </tr> <tr> <td align=left><a href=#proxy-buffer-size>proxy-buffer-size</a></td> <td align=left>string</td> <td align=left>"4k"</td> </tr> <tr> <td align=left><a href=#proxy-cookie-path>proxy-cookie-path</a></td> <td align=left>string</td> <td align=left>"off"</td> </tr> <tr> <td align=left><a href=#proxy-cookie-domain>proxy-cookie-domain</a></td> <td align=left>string</td> <td align=left>"off"</td> </tr> <tr> <td align=left><a href=#proxy-next-upstream>proxy-next-upstream</a></td> <td align=left>string</td> <td align=left>"error timeout"</td> </tr> <tr> <td align=left><a href=#proxy-next-upstream-timeout>proxy-next-upstream-timeout</a></td> <td align=left>int</td> <td align=left>0</td> </tr> <tr> <td align=left><a href=#proxy-next-upstream-tries>proxy-next-upstream-tries</a></td> <td align=left>int</td> <td align=left>3</td> </tr> <tr> <td align=left><a href=#proxy-redirect-from>proxy-redirect-from</a></td> <td align=left>string</td> <td align=left>"off"</td> </tr> <tr> <td align=left><a href=#proxy-request-buffering>proxy-request-buffering</a></td> <td align=left>string</td> <td align=left>"on"</td> </tr> <tr> <td align=left><a href=#ssl-redirect>ssl-redirect</a></td> <td align=left>bool</td> <td align=left>"true"</td> </tr> <tr> <td align=left><a href=#whitelist-source-range>whitelist-source-range</a></td> <td align=left>[]string</td> <td align=left>[]string{}</td> </tr> <tr> <td align=left><a href=#skip-access-log-urls>skip-access-log-urls</a></td> <td align=left>[]string</td> <td align=left>[]string{}</td> </tr> <tr> <td align=left><a href=#limit-rate>limit-rate</a></td> <td align=left>int</td> <td align=left>0</td> </tr> <tr> <td align=left><a href=#limit-rate-after>limit-rate-after</a></td> <td align=left>int</td> <td align=left>0</td> </tr> <tr> <td align=left><a href=#lua-shared-dicts>lua-shared-dicts</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#http-redirect-code>http-redirect-code</a></td> <td align=left>int</td> <td align=left>308</td> </tr> <tr> <td align=left><a href=#proxy-buffering>proxy-buffering</a></td> <td align=left>string</td> <td align=left>"off"</td> </tr> <tr> <td align=left><a href=#limit-req-status-code>limit-req-status-code</a></td> <td align=left>int</td> <td align=left>503</td> </tr> <tr> <td align=left><a href=#limit-conn-status-code>limit-conn-status-code</a></td> <td align=left>int</td> <td align=left>503</td> </tr> <tr> <td align=left><a href=#no-tls-redirect-locations>no-tls-redirect-locations</a></td> <td align=left>string</td> <td align=left>"/.well-known/acme-challenge"</td> </tr> <tr> <td align=left><a href=#global-auth-url>global-auth-url</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#global-auth-method>global-auth-method</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#global-auth-signin>global-auth-signin</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#global-auth-signin-redirect-param>global-auth-signin-redirect-param</a></td> <td align=left>string</td> <td align=left>"rd"</td> </tr> <tr> <td align=left><a href=#global-auth-response-headers>global-auth-response-headers</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#global-auth-request-redirect>global-auth-request-redirect</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#global-auth-snippet>global-auth-snippet</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#global-auth-cache-key>global-auth-cache-key</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#global-auth-cache-duration>global-auth-cache-duration</a></td> <td align=left>string</td> <td align=left>"200 202 401 5m"</td> </tr> <tr> <td align=left><a href=#no-auth-locations>no-auth-locations</a></td> <td align=left>string</td> <td align=left>"/.well-known/acme-challenge"</td> </tr> <tr> <td align=left><a href=#block-cidrs>block-cidrs</a></td> <td align=left>[]string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#block-user-agents>block-user-agents</a></td> <td align=left>[]string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#block-referers>block-referers</a></td> <td align=left>[]string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#proxy-ssl-location-only>proxy-ssl-location-only</a></td> <td align=left>bool</td> <td align=left>"false"</td> </tr> <tr> <td align=left><a href=#default-type>default-type</a></td> <td align=left>string</td> <td align=left>"text/html"</td> </tr> <tr> <td align=left><a href=#global-rate-limit>global-rate-limit-memcached-host</a></td> <td align=left>string</td> <td align=left>""</td> </tr> <tr> <td align=left><a href=#global-rate-limit>global-rate-limit-memcached-port</a></td> <td align=left>int</td> <td align=left>11211</td> </tr> <tr> <td align=left><a href=#global-rate-limit>global-rate-limit-memcached-connect-timeout</a></td> <td align=left>int</td> <td align=left>50</td> </tr> <tr> <td align=left><a href=#global-rate-limit>global-rate-limit-memcached-max-idle-timeout</a></td> <td align=left>int</td> <td align=left>10000</td> </tr> <tr> <td align=left><a href=#global-rate-limit>global-rate-limit-memcached-pool-size</a></td> <td align=left>int</td> <td align=left>50</td> </tr> <tr> <td align=left><a href=#global-rate-limit>global-rate-limit-status-code</a></td> <td align=left>int</td> <td align=left>429</td> </tr> </tbody> </table> <h2 id=add-headers>add-headers<a class=headerlink href=#add-headers title="Permanent link"></a></h2> <p>Sets custom headers from named configmap before sending traffic to the client. See <a href=#proxy-set-headers>proxy-set-headers</a>. <a href=https://github.com/kubernetes/ingress-nginx/tree/master/docs/examples/customization/custom-headers>example</a></p> <h2 id=allow-backend-server-header>allow-backend-server-header<a class=headerlink href=#allow-backend-server-header title="Permanent link"></a></h2> <p>Enables the return of the header Server from the backend instead of the generic nginx string. <em><strong>default:</strong></em> is disabled</p> <h2 id=hide-headers>hide-headers<a class=headerlink href=#hide-headers title="Permanent link"></a></h2> <p>Sets additional header that will not be passed from the upstream server to the client response. <em><strong>default:</strong></em> empty</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_hide_header>http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_hide_header</a></p> <h2 id=access-log-params>access-log-params<a class=headerlink href=#access-log-params title="Permanent link"></a></h2> <p>Additional params for access_log. For example, buffer=16k, gzip, flush=1m</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log>http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log</a></p> <h2 id=access-log-path>access-log-path<a class=headerlink href=#access-log-path title="Permanent link"></a></h2> <p>Access log path for both http and stream context. Goes to <code>/var/log/nginx/access.log</code> by default.</p> <p><strong>Note:</strong> the file <code>/var/log/nginx/access.log</code> is a symlink to <code>/dev/stdout</code></p> <h2 id=http-access-log-path>http-access-log-path<a class=headerlink href=#http-access-log-path title="Permanent link"></a></h2> <p>Access log path for http context globally. <em><strong>default:</strong></em> ""</p> <p><strong>Note:</strong> If not specified, the <code>access-log-path</code> will be used.</p> <h2 id=stream-access-log-path>stream-access-log-path<a class=headerlink href=#stream-access-log-path title="Permanent link"></a></h2> <p>Access log path for stream context globally. <em><strong>default:</strong></em> ""</p> <p><strong>Note:</strong> If not specified, the <code>access-log-path</code> will be used.</p> <h2 id=enable-access-log-for-default-backend>enable-access-log-for-default-backend<a class=headerlink href=#enable-access-log-for-default-backend title="Permanent link"></a></h2> <p>Enables logging access to default backend. <em><strong>default:</strong></em> is disabled.</p> <h2 id=error-log-path>error-log-path<a class=headerlink href=#error-log-path title="Permanent link"></a></h2> <p>Error log path. Goes to <code>/var/log/nginx/error.log</code> by default.</p> <p><strong>Note:</strong> the file <code>/var/log/nginx/error.log</code> is a symlink to <code>/dev/stderr</code></p> <p><em>References:</em> <a href=http://nginx.org/en/docs/ngx_core_module.html#error_log>http://nginx.org/en/docs/ngx_core_module.html#error_log</a></p> <h2 id=enable-modsecurity>enable-modsecurity<a class=headerlink href=#enable-modsecurity title="Permanent link"></a></h2> <p>Enables the modsecurity module for NGINX. <em><strong>default:</strong></em> is disabled</p> <h2 id=enable-owasp-modsecurity-crs>enable-owasp-modsecurity-crs<a class=headerlink href=#enable-owasp-modsecurity-crs title="Permanent link"></a></h2> <p>Enables the OWASP ModSecurity Core Rule Set (CRS). <em><strong>default:</strong></em> is disabled</p> <h2 id=modsecurity-snippet>modsecurity-snippet<a class=headerlink href=#modsecurity-snippet title="Permanent link"></a></h2> <p>Adds custom rules to modsecurity section of nginx configuration</p> <h2 id=client-header-buffer-size>client-header-buffer-size<a class=headerlink href=#client-header-buffer-size title="Permanent link"></a></h2> <p>Allows to configure a custom buffer size for reading client request header.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#client_header_buffer_size>http://nginx.org/en/docs/http/ngx_http_core_module.html#client_header_buffer_size</a></p> <h2 id=client-header-timeout>client-header-timeout<a class=headerlink href=#client-header-timeout title="Permanent link"></a></h2> <p>Defines a timeout for reading client request header, in seconds.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#client_header_timeout>http://nginx.org/en/docs/http/ngx_http_core_module.html#client_header_timeout</a></p> <h2 id=client-body-buffer-size>client-body-buffer-size<a class=headerlink href=#client-body-buffer-size title="Permanent link"></a></h2> <p>Sets buffer size for reading client request body.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_buffer_size>http://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_buffer_size</a></p> <h2 id=client-body-timeout>client-body-timeout<a class=headerlink href=#client-body-timeout title="Permanent link"></a></h2> <p>Defines a timeout for reading client request body, in seconds.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_timeout>http://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_timeout</a></p> <h2 id=disable-access-log>disable-access-log<a class=headerlink href=#disable-access-log title="Permanent link"></a></h2> <p>Disables the Access Log from the entire Ingress Controller. <em><strong>default:</strong></em> '"false"'</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log>http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log</a></p> <h2 id=disable-ipv6>disable-ipv6<a class=headerlink href=#disable-ipv6 title="Permanent link"></a></h2> <p>Disable listening on IPV6. <em><strong>default:</strong></em> <code>false</code>; IPv6 listening is enabled</p> <h2 id=disable-ipv6-dns>disable-ipv6-dns<a class=headerlink href=#disable-ipv6-dns title="Permanent link"></a></h2> <p>Disable IPV6 for nginx DNS resolver. <em><strong>default:</strong></em> <code>false</code>; IPv6 resolving enabled.</p> <h2 id=enable-underscores-in-headers>enable-underscores-in-headers<a class=headerlink href=#enable-underscores-in-headers title="Permanent link"></a></h2> <p>Enables underscores in header names. <em><strong>default:</strong></em> is disabled</p> <h2 id=enable-ocsp>enable-ocsp<a class=headerlink href=#enable-ocsp title="Permanent link"></a></h2> <p>Enables <a href=https://en.wikipedia.org/wiki/OCSP_stapling>Online Certificate Status Protocol stapling</a> (OCSP) support. <em><strong>default:</strong></em> is disabled</p> <h2 id=ignore-invalid-headers>ignore-invalid-headers<a class=headerlink href=#ignore-invalid-headers title="Permanent link"></a></h2> <p>Set if header fields with invalid names should be ignored. <em><strong>default:</strong></em> is enabled</p> <h2 id=retry-non-idempotent>retry-non-idempotent<a class=headerlink href=#retry-non-idempotent title="Permanent link"></a></h2> <p>Since 1.9.13 NGINX will not retry non-idempotent requests (POST, LOCK, PATCH) in case of an error in the upstream server. The previous behavior can be restored using the value "true".</p> <h2 id=error-log-level>error-log-level<a class=headerlink href=#error-log-level title="Permanent link"></a></h2> <p>Configures the logging level of errors. Log levels above are listed in the order of increasing severity.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/ngx_core_module.html#error_log>http://nginx.org/en/docs/ngx_core_module.html#error_log</a></p> <h2 id=http2-max-field-size>http2-max-field-size<a class=headerlink href=#http2-max-field-size title="Permanent link"></a></h2> <p>Limits the maximum size of an HPACK-compressed request header field.</p> <p><em>References:</em> <a href=https://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_field_size>https://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_field_size</a></p> <h2 id=http2-max-header-size>http2-max-header-size<a class=headerlink href=#http2-max-header-size title="Permanent link"></a></h2> <p>Limits the maximum size of the entire request header list after HPACK decompression.</p> <p><em>References:</em> <a href=https://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_header_size>https://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_header_size</a></p> <h2 id=http2-max-requests>http2-max-requests<a class=headerlink href=#http2-max-requests title="Permanent link"></a></h2> <p>Sets the maximum number of requests (including push requests) that can be served through one HTTP/2 connection, after which the next client request will lead to connection closing and the need of establishing a new connection.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_requests>http://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_requests</a></p> <h2 id=http2-max-concurrent-streams>http2-max-concurrent-streams<a class=headerlink href=#http2-max-concurrent-streams title="Permanent link"></a></h2> <p>Sets the maximum number of concurrent HTTP/2 streams in a connection.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_concurrent_streams>http://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_concurrent_streams</a></p> <h2 id=hsts>hsts<a class=headerlink href=#hsts title="Permanent link"></a></h2> <p>Enables or disables the header HSTS in servers running SSL. HTTP Strict Transport Security (often abbreviated as HSTS) is a security feature (HTTP header) that tell browsers that it should only be communicated with using HTTPS, instead of using HTTP. It provides protection against protocol downgrade attacks and cookie theft.</p> <p><em>References:</em></p> <ul> <li><a href=https://developer.mozilla.org/en-US/docs/Web/Security/HTTP_strict_transport_security>https://developer.mozilla.org/en-US/docs/Web/Security/HTTP_strict_transport_security</a></li> <li><a href=https://blog.qualys.com/securitylabs/2016/03/28/the-importance-of-a-proper-http-strict-transport-security-implementation-on-your-web-server>https://blog.qualys.com/securitylabs/2016/03/28/the-importance-of-a-proper-http-strict-transport-security-implementation-on-your-web-server</a></li> </ul> <h2 id=hsts-include-subdomains>hsts-include-subdomains<a class=headerlink href=#hsts-include-subdomains title="Permanent link"></a></h2> <p>Enables or disables the use of HSTS in all the subdomains of the server-name.</p> <h2 id=hsts-max-age>hsts-max-age<a class=headerlink href=#hsts-max-age title="Permanent link"></a></h2> <p>Sets the time, in seconds, that the browser should remember that this site is only to be accessed using HTTPS.</p> <h2 id=hsts-preload>hsts-preload<a class=headerlink href=#hsts-preload title="Permanent link"></a></h2> <p>Enables or disables the preload attribute in the HSTS feature (when it is enabled) dd</p> <h2 id=keep-alive>keep-alive<a class=headerlink href=#keep-alive title="Permanent link"></a></h2> <p>Sets the time during which a keep-alive client connection will stay open on the server side. The zero value disables keep-alive client connections.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout>http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout</a></p> <h2 id=keep-alive-requests>keep-alive-requests<a class=headerlink href=#keep-alive-requests title="Permanent link"></a></h2> <p>Sets the maximum number of requests that can be served through one keep-alive connection.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_requests>http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_requests</a></p> <h2 id=large-client-header-buffers>large-client-header-buffers<a class=headerlink href=#large-client-header-buffers title="Permanent link"></a></h2> <p>Sets the maximum number and size of buffers used for reading large client request header. <em><strong>default:</strong></em> 4 8k</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#large_client_header_buffers>http://nginx.org/en/docs/http/ngx_http_core_module.html#large_client_header_buffers</a></p> <h2 id=log-format-escape-json>log-format-escape-json<a class=headerlink href=#log-format-escape-json title="Permanent link"></a></h2> <p>Sets if the escape parameter allows JSON ("true") or default characters escaping in variables ("false") Sets the nginx <a href=http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format>log format</a>.</p> <h2 id=log-format-upstream>log-format-upstream<a class=headerlink href=#log-format-upstream title="Permanent link"></a></h2> <p>Sets the nginx <a href=http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format>log format</a>. Example for json output:</p> <div class=highlight><pre><span></span><code><span class=err>log</span><span class=mi>-</span><span class=kc>f</span><span class=err>orma</span><span class=kc>t</span><span class=mi>-</span><span class=err>ups</span><span class=kc>trea</span><span class=err>m</span><span class=p>:</span> <span class=err>&#39;</span><span class=p>{</span><span class=nt>&quot;time&quot;</span><span class=p>:</span> <span class=s2>&quot;$time_iso8601&quot;</span><span class=p>,</span> <span class=nt>&quot;remote_addr&quot;</span><span class=p>:</span> <span class=s2>&quot;$proxy_protocol_addr&quot;</span><span class=p>,</span> <span class=nt>&quot;x_forward_for&quot;</span><span class=p>:</span> <span class=s2>&quot;$proxy_add_x_forwarded_for&quot;</span><span class=p>,</span> <span class=nt>&quot;request_id&quot;</span><span class=p>:</span> <span class=s2>&quot;$req_id&quot;</span><span class=p>,</span>
<span class=nt>&quot;remote_user&quot;</span><span class=p>:</span> <span class=s2>&quot;$remote_user&quot;</span><span class=p>,</span> <span class=nt>&quot;bytes_sent&quot;</span><span class=p>:</span> <span class=err>$by</span><span class=kc>tes</span><span class=err>_se</span><span class=kc>nt</span><span class=p>,</span> <span class=nt>&quot;request_time&quot;</span><span class=p>:</span> <span class=err>$reques</span><span class=kc>t</span><span class=err>_</span><span class=kc>t</span><span class=err>ime</span><span class=p>,</span> <span class=nt>&quot;status&quot;</span><span class=p>:</span> <span class=err>$s</span><span class=kc>tatus</span><span class=p>,</span> <span class=nt>&quot;vhost&quot;</span><span class=p>:</span> <span class=s2>&quot;$host&quot;</span><span class=p>,</span> <span class=nt>&quot;request_proto&quot;</span><span class=p>:</span> <span class=s2>&quot;$server_protocol&quot;</span><span class=p>,</span>
<span class=nt>&quot;path&quot;</span><span class=p>:</span> <span class=s2>&quot;$uri&quot;</span><span class=p>,</span> <span class=nt>&quot;request_query&quot;</span><span class=p>:</span> <span class=s2>&quot;$args&quot;</span><span class=p>,</span> <span class=nt>&quot;request_length&quot;</span><span class=p>:</span> <span class=err>$reques</span><span class=kc>t</span><span class=err>_le</span><span class=kc>n</span><span class=err>g</span><span class=kc>t</span><span class=err>h</span><span class=p>,</span> <span class=nt>&quot;duration&quot;</span><span class=p>:</span> <span class=err>$reques</span><span class=kc>t</span><span class=err>_</span><span class=kc>t</span><span class=err>ime</span><span class=p>,</span><span class=nt>&quot;method&quot;</span><span class=p>:</span> <span class=s2>&quot;$request_method&quot;</span><span class=p>,</span> <span class=nt>&quot;http_referrer&quot;</span><span class=p>:</span> <span class=s2>&quot;$http_referer&quot;</span><span class=p>,</span>
<span class=nt>&quot;http_user_agent&quot;</span><span class=p>:</span> <span class=s2>&quot;$http_user_agent&quot;</span> <span class=p>}</span><span class=err>&#39;</span>
</code></pre></div> <p>Please check the <a href=../log-format/ >log-format</a> for definition of each field.</p> <h2 id=log-format-stream>log-format-stream<a class=headerlink href=#log-format-stream title="Permanent link"></a></h2> <p>Sets the nginx <a href=https://nginx.org/en/docs/stream/ngx_stream_log_module.html#log_format>stream format</a>.</p> <h2 id=enable-multi-accept>enable-multi-accept<a class=headerlink href=#enable-multi-accept title="Permanent link"></a></h2> <p>If disabled, a worker process will accept one new connection at a time. Otherwise, a worker process will accept all new connections at a time. <em><strong>default:</strong></em> true</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/ngx_core_module.html#multi_accept>http://nginx.org/en/docs/ngx_core_module.html#multi_accept</a></p> <h2 id=max-worker-connections>max-worker-connections<a class=headerlink href=#max-worker-connections title="Permanent link"></a></h2> <p>Sets the <a href=http://nginx.org/en/docs/ngx_core_module.html#worker_connections>maximum number of simultaneous connections</a> that can be opened by each worker process. 0 will use the value of <a href=#max-worker-open-files>max-worker-open-files</a>. <em><strong>default:</strong></em> 16384</p> <div class="admonition tip"> <p class=admonition-title>Tip</p> <p>Using 0 in scenarios of high load improves performance at the cost of increasing RAM utilization (even on idle).</p> </div> <h2 id=max-worker-open-files>max-worker-open-files<a class=headerlink href=#max-worker-open-files title="Permanent link"></a></h2> <p>Sets the <a href=http://nginx.org/en/docs/ngx_core_module.html#worker_rlimit_nofile>maximum number of files</a> that can be opened by each worker process. The default of 0 means "max open files (system's limit) / <a href=#worker-processes>worker-processes</a> - 1024". <em><strong>default:</strong></em> 0</p> <h2 id=map-hash-bucket-size>map-hash-bucket-size<a class=headerlink href=#map-hash-bucket-size title="Permanent link"></a></h2> <p>Sets the bucket size for the <a href=http://nginx.org/en/docs/http/ngx_http_map_module.html#map_hash_bucket_size>map variables hash tables</a>. The details of setting up hash tables are provided in a separate <a href=http://nginx.org/en/docs/hash.html>document</a>.</p> <h2 id=proxy-real-ip-cidr>proxy-real-ip-cidr<a class=headerlink href=#proxy-real-ip-cidr title="Permanent link"></a></h2> <p>If <code>use-forwarded-headers</code> or <code>use-proxy-protocol</code> is enabled, <code>proxy-real-ip-cidr</code> defines the default IP/network address of your external load balancer. Can be a comma-separated list of CIDR blocks. <em><strong>default:</strong></em> "0.0.0.0/0"</p> <h2 id=proxy-set-headers>proxy-set-headers<a class=headerlink href=#proxy-set-headers title="Permanent link"></a></h2> <p>Sets custom headers from named configmap before sending traffic to backends. The value format is namespace/name. See <a href=https://github.com/kubernetes/ingress-nginx/tree/master/docs/examples/customization/custom-headers>example</a></p> <h2 id=server-name-hash-max-size>server-name-hash-max-size<a class=headerlink href=#server-name-hash-max-size title="Permanent link"></a></h2> <p>Sets the maximum size of the <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#server_names_hash_max_size>server names hash tables</a> used in server names,map directive’s values, MIME types, names of request header strings, etc.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/hash.html>http://nginx.org/en/docs/hash.html</a></p> <h2 id=server-name-hash-bucket-size>server-name-hash-bucket-size<a class=headerlink href=#server-name-hash-bucket-size title="Permanent link"></a></h2> <p>Sets the size of the bucket for the server names hash tables.</p> <p><em>References:</em></p> <ul> <li><a href=http://nginx.org/en/docs/hash.html>http://nginx.org/en/docs/hash.html</a></li> <li><a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#server_names_hash_bucket_size>http://nginx.org/en/docs/http/ngx_http_core_module.html#server_names_hash_bucket_size</a></li> </ul> <h2 id=proxy-headers-hash-max-size>proxy-headers-hash-max-size<a class=headerlink href=#proxy-headers-hash-max-size title="Permanent link"></a></h2> <p>Sets the maximum size of the proxy headers hash tables.</p> <p><em>References:</em></p> <ul> <li><a href=http://nginx.org/en/docs/hash.html>http://nginx.org/en/docs/hash.html</a></li> <li><a href=https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_max_size>https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_max_size</a></li> </ul> <h2 id=reuse-port>reuse-port<a class=headerlink href=#reuse-port title="Permanent link"></a></h2> <p>Instructs NGINX to create an individual listening socket for each worker process (using the SO_REUSEPORT socket option), allowing a kernel to distribute incoming connections between worker processes <em><strong>default:</strong></em> true</p> <h2 id=proxy-headers-hash-bucket-size>proxy-headers-hash-bucket-size<a class=headerlink href=#proxy-headers-hash-bucket-size title="Permanent link"></a></h2> <p>Sets the size of the bucket for the proxy headers hash tables.</p> <p><em>References:</em></p> <ul> <li><a href=http://nginx.org/en/docs/hash.html>http://nginx.org/en/docs/hash.html</a></li> <li><a href=https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_bucket_size>https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_bucket_size</a></li> </ul> <h2 id=plugins>plugins<a class=headerlink href=#plugins title="Permanent link"></a></h2> <p>Activates plugins installed in <code>/etc/nginx/lua/plugins</code>. Refer to <a href=https://github.com/kubernetes/ingress-nginx/blob/master/rootfs/etc/nginx/lua/plugins/README.md>ingress-nginx plugins README</a> for more information on how to write and install a plugin.</p> <h2 id=server-tokens>server-tokens<a class=headerlink href=#server-tokens title="Permanent link"></a></h2> <p>Send NGINX Server header in responses and display NGINX version in error pages. <em><strong>default:</strong></em> is disabled</p> <h2 id=ssl-ciphers>ssl-ciphers<a class=headerlink href=#ssl-ciphers title="Permanent link"></a></h2> <p>Sets the <a href=http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_ciphers>ciphers</a> list to enable. The ciphers are specified in the format understood by the OpenSSL library.</p> <p>The default cipher list is: <code>ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384</code>.</p> <p>The ordering of a ciphersuite is very important because it decides which algorithms are going to be selected in priority. The recommendation above prioritizes algorithms that provide perfect <a href=https://wiki.mozilla.org/Security/Server_Side_TLS#Forward_Secrecy>forward secrecy</a>.</p> <p>DHE-based cyphers will not be available until DH parameter is configured <a href=https://github.com/kubernetes/ingress-nginx/tree/master/docs/examples/customization/ssl-dh-param>Custom DH parameters for perfect forward secrecy</a></p> <p>Please check the <a href=https://mozilla.github.io/server-side-tls/ssl-config-generator/ >Mozilla SSL Configuration Generator</a>.</p> <p><strong>Note:</strong> ssl_prefer_server_ciphers directive will be enabled by default for http context.</p> <h2 id=ssl-ecdh-curve>ssl-ecdh-curve<a class=headerlink href=#ssl-ecdh-curve title="Permanent link"></a></h2> <p>Specifies a curve for ECDHE ciphers.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_ecdh_curve>http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_ecdh_curve</a></p> <h2 id=ssl-dh-param>ssl-dh-param<a class=headerlink href=#ssl-dh-param title="Permanent link"></a></h2> <p>Sets the name of the secret that contains Diffie-Hellman key to help with "Perfect Forward Secrecy".</p> <p><em>References:</em></p> <ul> <li><a href=https://wiki.openssl.org/index.php/Diffie-Hellman_parameters>https://wiki.openssl.org/index.php/Diffie-Hellman_parameters</a></li> <li><a href=https://wiki.mozilla.org/Security/Server_Side_TLS#DHE_handshake_and_dhparam>https://wiki.mozilla.org/Security/Server_Side_TLS#DHE_handshake_and_dhparam</a></li> <li><a href=http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_dhparam>http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_dhparam</a></li> </ul> <h2 id=ssl-protocols>ssl-protocols<a class=headerlink href=#ssl-protocols title="Permanent link"></a></h2> <p>Sets the <a href=http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_protocols>SSL protocols</a> to use. The default is: <code>TLSv1.2 TLSv1.3</code>.</p> <p>Please check the result of the configuration using <code>https://ssllabs.com/ssltest/analyze.html</code> or <code>https://testssl.sh</code>.</p> <h2 id=ssl-early-data>ssl-early-data<a class=headerlink href=#ssl-early-data title="Permanent link"></a></h2> <p>Enables or disables TLS 1.3 <a href=https://tools.ietf.org/html/rfc8446#section-2.3>early data</a>, also known as Zero Round Trip Time Resumption (0-RTT).</p> <p>This requires <code>ssl-protocols</code> to have <code>TLSv1.3</code> enabled. Enable this with caution, because requests sent within early data are subject to <a href=https://tools.ietf.org/html/rfc8470>replay attacks</a>.</p> <p><a href=http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_early_data>ssl_early_data</a>. The default is: <code>false</code>.</p> <h2 id=ssl-session-cache>ssl-session-cache<a class=headerlink href=#ssl-session-cache title="Permanent link"></a></h2> <p>Enables or disables the use of shared <a href=http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_cache>SSL cache</a> among worker processes.</p> <h2 id=ssl-session-cache-size>ssl-session-cache-size<a class=headerlink href=#ssl-session-cache-size title="Permanent link"></a></h2> <p>Sets the size of the <a href=http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_cache>SSL shared session cache</a> between all worker processes.</p> <h2 id=ssl-session-tickets>ssl-session-tickets<a class=headerlink href=#ssl-session-tickets title="Permanent link"></a></h2> <p>Enables or disables session resumption through <a href=http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_tickets>TLS session tickets</a>.</p> <h2 id=ssl-session-ticket-key>ssl-session-ticket-key<a class=headerlink href=#ssl-session-ticket-key title="Permanent link"></a></h2> <p>Sets the secret key used to encrypt and decrypt TLS session tickets. The value must be a valid base64 string. To create a ticket: <code>openssl rand 80 | openssl enc -A -base64</code></p> <p><a href=http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_tickets>TLS session ticket-key</a>, by default, a randomly generated key is used.</p> <h2 id=ssl-session-timeout>ssl-session-timeout<a class=headerlink href=#ssl-session-timeout title="Permanent link"></a></h2> <p>Sets the time during which a client may <a href=http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_timeout>reuse the session</a> parameters stored in a cache.</p> <h2 id=ssl-buffer-size>ssl-buffer-size<a class=headerlink href=#ssl-buffer-size title="Permanent link"></a></h2> <p>Sets the size of the <a href=http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_buffer_size>SSL buffer</a> used for sending data. The default of 4k helps NGINX to improve TLS Time To First Byte (TTTFB).</p> <p><em>References:</em> <a href=https://www.igvita.com/2013/12/16/optimizing-nginx-tls-time-to-first-byte/ >https://www.igvita.com/2013/12/16/optimizing-nginx-tls-time-to-first-byte/</a></p> <h2 id=use-proxy-protocol>use-proxy-protocol<a class=headerlink href=#use-proxy-protocol title="Permanent link"></a></h2> <p>Enables or disables the <a href=https://www.nginx.com/resources/admin-guide/proxy-protocol/ >PROXY protocol</a> to receive client connection (real IP address) information passed through proxy servers and load balancers such as HAProxy and Amazon Elastic Load Balancer (ELB).</p> <h2 id=proxy-protocol-header-timeout>proxy-protocol-header-timeout<a class=headerlink href=#proxy-protocol-header-timeout title="Permanent link"></a></h2> <p>Sets the timeout value for receiving the proxy-protocol headers. The default of 5 seconds prevents the TLS passthrough handler from waiting indefinitely on a dropped connection. <em><strong>default:</strong></em> 5s</p> <h2 id=use-gzip>use-gzip<a class=headerlink href=#use-gzip title="Permanent link"></a></h2> <p>Enables or disables compression of HTTP responses using the <a href=http://nginx.org/en/docs/http/ngx_http_gzip_module.html>"gzip" module</a>. MIME types to compress are controlled by <a href=#gzip-types>gzip-types</a>. <em><strong>default:</strong></em> false</p> <h2 id=use-geoip>use-geoip<a class=headerlink href=#use-geoip title="Permanent link"></a></h2> <p>Enables or disables <a href=http://nginx.org/en/docs/http/ngx_http_geoip_module.html>"geoip" module</a> that creates variables with values depending on the client IP address, using the precompiled MaxMind databases. <em><strong>default:</strong></em> true</p> <blockquote> <p><strong>Note:</strong> MaxMind legacy databases are discontinued and will not receive updates after 2019-01-02, cf. <a href=https://support.maxmind.com/geolite-legacy-discontinuation-notice/ >discontinuation notice</a>. Consider <a href=#use-geoip2>use-geoip2</a> below.</p> </blockquote> <h2 id=use-geoip2>use-geoip2<a class=headerlink href=#use-geoip2 title="Permanent link"></a></h2> <p>Enables the <a href=https://github.com/leev/ngx_http_geoip2_module>geoip2 module</a> for NGINX. Since <code>0.27.0</code> and due to a <a href=https://blog.maxmind.com/2019/12/18/significant-changes-to-accessing-and-using-geolite2-databases>change in the MaxMind databases</a> a license is required to have access to the databases. For this reason, it is required to define a new flag <code>--maxmind-license-key</code> in the ingress controller deployment to download the databases needed during the initialization of the ingress controller. Alternatively, it is possible to use a volume to mount the files <code>/etc/nginx/geoip/GeoLite2-City.mmdb</code> and <code>/etc/nginx/geoip/GeoLite2-ASN.mmdb</code>, avoiding the overhead of the download.</p> <div class="admonition important"> <p class=admonition-title>Important</p> <p>If the feature is enabled but the files are missing, GeoIP2 will not be enabled.</p> </div> <p><em><strong>default:</strong></em> false</p> <h2 id=enable-brotli>enable-brotli<a class=headerlink href=#enable-brotli title="Permanent link"></a></h2> <p>Enables or disables compression of HTTP responses using the <a href=https://github.com/google/ngx_brotli>"brotli" module</a>. The default mime type list to compress is: <code>application/xml+rss application/atom+xml application/javascript application/x-javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/svg+xml image/x-icon text/css text/plain text/x-component</code>. <em><strong>default:</strong></em> is disabled</p> <blockquote> <p><strong>Note:</strong> Brotli does not works in Safari &lt; 11. For more information see <a href="https://caniuse.com/#feat=brotli">https://caniuse.com/#feat=brotli</a></p> </blockquote> <h2 id=brotli-level>brotli-level<a class=headerlink href=#brotli-level title="Permanent link"></a></h2> <p>Sets the Brotli Compression Level that will be used. <em><strong>default:</strong></em> 4</p> <h2 id=brotli-types>brotli-types<a class=headerlink href=#brotli-types title="Permanent link"></a></h2> <p>Sets the MIME Types that will be compressed on-the-fly by brotli. <em><strong>default:</strong></em> <code>application/xml+rss application/atom+xml application/javascript application/x-javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/svg+xml image/x-icon text/css text/plain text/x-component</code></p> <h2 id=use-http2>use-http2<a class=headerlink href=#use-http2 title="Permanent link"></a></h2> <p>Enables or disables <a href=http://nginx.org/en/docs/http/ngx_http_v2_module.html>HTTP/2</a> support in secure connections.</p> <h2 id=gzip-level>gzip-level<a class=headerlink href=#gzip-level title="Permanent link"></a></h2> <p>Sets the gzip Compression Level that will be used. <em><strong>default:</strong></em> 1</p> <h2 id=gzip-min-length>gzip-min-length<a class=headerlink href=#gzip-min-length title="Permanent link"></a></h2> <p>Minimum length of responses to be returned to the client before it is eligible for gzip compression, in bytes. <em><strong>default:</strong></em> 256</p> <h2 id=gzip-types>gzip-types<a class=headerlink href=#gzip-types title="Permanent link"></a></h2> <p>Sets the MIME types in addition to "text/html" to compress. The special value "*" matches any MIME type. Responses with the "text/html" type are always compressed if <a href=#use-gzip><code>use-gzip</code></a> is enabled. <em><strong>default:</strong></em> <code>application/atom+xml application/javascript application/x-javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/svg+xml image/x-icon text/css text/plain text/x-component</code>.</p> <h2 id=worker-processes>worker-processes<a class=headerlink href=#worker-processes title="Permanent link"></a></h2> <p>Sets the number of <a href=http://nginx.org/en/docs/ngx_core_module.html#worker_processes>worker processes</a>. The default of "auto" means number of available CPU cores.</p> <h2 id=worker-cpu-affinity>worker-cpu-affinity<a class=headerlink href=#worker-cpu-affinity title="Permanent link"></a></h2> <p>Binds worker processes to the sets of CPUs. <a href=http://nginx.org/en/docs/ngx_core_module.html#worker_cpu_affinity>worker_cpu_affinity</a>. By default worker processes are not bound to any specific CPUs. The value can be:</p> <ul> <li>"": empty string indicate no affinity is applied.</li> <li>cpumask: e.g. <code>0001 0010 0100 1000</code> to bind processes to specific cpus.</li> <li>auto: binding worker processes automatically to available CPUs.</li> </ul> <h2 id=worker-shutdown-timeout>worker-shutdown-timeout<a class=headerlink href=#worker-shutdown-timeout title="Permanent link"></a></h2> <p>Sets a timeout for Nginx to <a href=http://nginx.org/en/docs/ngx_core_module.html#worker_shutdown_timeout>wait for worker to gracefully shutdown</a>. <em><strong>default:</strong></em> "240s"</p> <h2 id=load-balance>load-balance<a class=headerlink href=#load-balance title="Permanent link"></a></h2> <p>Sets the algorithm to use for load balancing. The value can either be:</p> <ul> <li>round_robin: to use the default round robin loadbalancer</li> <li>ewma: to use the Peak EWMA method for routing (<a href=https://github.com/kubernetes/ingress-nginx/blob/master/rootfs/etc/nginx/lua/balancer/ewma.lua>implementation</a>)</li> </ul> <p>The default is <code>round_robin</code>.</p> <ul> <li>To load balance using consistent hashing of IP or other variables, consider the <code>nginx.ingress.kubernetes.io/upstream-hash-by</code> annotation.</li> <li>To load balance using session cookies, consider the <code>nginx.ingress.kubernetes.io/affinity</code> annotation.</li> </ul> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/load_balancing.html>http://nginx.org/en/docs/http/load_balancing.html</a></p> <h2 id=variables-hash-bucket-size>variables-hash-bucket-size<a class=headerlink href=#variables-hash-bucket-size title="Permanent link"></a></h2> <p>Sets the bucket size for the variables hash table.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_map_module.html#variables_hash_bucket_size>http://nginx.org/en/docs/http/ngx_http_map_module.html#variables_hash_bucket_size</a></p> <h2 id=variables-hash-max-size>variables-hash-max-size<a class=headerlink href=#variables-hash-max-size title="Permanent link"></a></h2> <p>Sets the maximum size of the variables hash table.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_map_module.html#variables_hash_max_size>http://nginx.org/en/docs/http/ngx_http_map_module.html#variables_hash_max_size</a></p> <h2 id=upstream-keepalive-connections>upstream-keepalive-connections<a class=headerlink href=#upstream-keepalive-connections title="Permanent link"></a></h2> <p>Activates the cache for connections to upstream servers. The connections parameter sets the maximum number of idle keepalive connections to upstream servers that are preserved in the cache of each worker process. When this number is exceeded, the least recently used connections are closed. <em><strong>default:</strong></em> 320</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive>http://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive</a></p> <h2 id=upstream-keepalive-timeout>upstream-keepalive-timeout<a class=headerlink href=#upstream-keepalive-timeout title="Permanent link"></a></h2> <p>Sets a timeout during which an idle keepalive connection to an upstream server will stay open. <em><strong>default:</strong></em> 60</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_timeout>http://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_timeout</a></p> <h2 id=upstream-keepalive-requests>upstream-keepalive-requests<a class=headerlink href=#upstream-keepalive-requests title="Permanent link"></a></h2> <p>Sets the maximum number of requests that can be served through one keepalive connection. After the maximum number of requests is made, the connection is closed. <em><strong>default:</strong></em> 10000</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_requests>http://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_requests</a></p> <h2 id=limit-conn-zone-variable>limit-conn-zone-variable<a class=headerlink href=#limit-conn-zone-variable title="Permanent link"></a></h2> <p>Sets parameters for a shared memory zone that will keep states for various keys of <a href=http://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone>limit_conn_zone</a>. The default of "$binary_remote_addr" variable’s size is always 4 bytes for IPv4 addresses or 16 bytes for IPv6 addresses.</p> <h2 id=proxy-stream-timeout>proxy-stream-timeout<a class=headerlink href=#proxy-stream-timeout title="Permanent link"></a></h2> <p>Sets the timeout between two successive read or write operations on client or proxied server connections. If no data is transmitted within this time, the connection is closed.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_timeout>http://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_timeout</a></p> <h2 id=proxy-stream-next-upstream>proxy-stream-next-upstream<a class=headerlink href=#proxy-stream-next-upstream title="Permanent link"></a></h2> <p>When a connection to the proxied server cannot be established, determines whether a client connection will be passed to the next server.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_next_upstream>http://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_next_upstream</a></p> <h2 id=proxy-stream-next-upstream-timeout>proxy-stream-next-upstream-timeout<a class=headerlink href=#proxy-stream-next-upstream-timeout title="Permanent link"></a></h2> <p>Limits the time allowed to pass a connection to the next server. The 0 value turns off this limitation.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_next_upstream_timeout>http://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_next_upstream_timeout</a></p> <h2 id=proxy-stream-next-upstream-tries>proxy-stream-next-upstream-tries<a class=headerlink href=#proxy-stream-next-upstream-tries title="Permanent link"></a></h2> <p>Limits the number of possible tries a request should be passed to the next server. The 0 value turns off this limitation.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_next_upstream_timeout>http://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_next_upstream_tries</a></p> <h2 id=proxy-stream-responses>proxy-stream-responses<a class=headerlink href=#proxy-stream-responses title="Permanent link"></a></h2> <p>Sets the number of datagrams expected from the proxied server in response to the client request if the UDP protocol is used.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_responses>http://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_responses</a></p> <h2 id=bind-address>bind-address<a class=headerlink href=#bind-address title="Permanent link"></a></h2> <p>Sets the addresses on which the server will accept requests instead of *. It should be noted that these addresses must exist in the runtime environment or the controller will crash loop.</p> <h2 id=use-forwarded-headers>use-forwarded-headers<a class=headerlink href=#use-forwarded-headers title="Permanent link"></a></h2> <p>If true, NGINX passes the incoming <code>X-Forwarded-*</code> headers to upstreams. Use this option when NGINX is behind another L7 proxy / load balancer that is setting these headers.</p> <p>If false, NGINX ignores incoming <code>X-Forwarded-*</code> headers, filling them with the request information it sees. Use this option if NGINX is exposed directly to the internet, or it's behind a L3/packet-based load balancer that doesn't alter the source IP in the packets.</p> <h2 id=enable-real-ip>enable-real-ip<a class=headerlink href=#enable-real-ip title="Permanent link"></a></h2> <p><code>enable-real-ip</code> enables the configuration of <a href=http://nginx.org/en/docs/http/ngx_http_realip_module.html>http://nginx.org/en/docs/http/ngx_http_realip_module.html</a>. Specific attributes of the module can be configured further by using <code>forwarded-for-header</code> and <code>proxy-real-ip-cidr</code> settings.</p> <h2 id=forwarded-for-header>forwarded-for-header<a class=headerlink href=#forwarded-for-header title="Permanent link"></a></h2> <p>Sets the header field for identifying the originating IP address of a client. <em><strong>default:</strong></em> X-Forwarded-For</p> <h2 id=compute-full-forwarded-for>compute-full-forwarded-for<a class=headerlink href=#compute-full-forwarded-for title="Permanent link"></a></h2> <p>Append the remote address to the X-Forwarded-For header instead of replacing it. When this option is enabled, the upstream application is responsible for extracting the client IP based on its own list of trusted proxies.</p> <h2 id=proxy-add-original-uri-header>proxy-add-original-uri-header<a class=headerlink href=#proxy-add-original-uri-header title="Permanent link"></a></h2> <p>Adds an X-Original-Uri header with the original request URI to the backend request</p> <h2 id=generate-request-id>generate-request-id<a class=headerlink href=#generate-request-id title="Permanent link"></a></h2> <p>Ensures that X-Request-ID is defaulted to a random value, if no X-Request-ID is present in the request</p> <h2 id=enable-opentracing>enable-opentracing<a class=headerlink href=#enable-opentracing title="Permanent link"></a></h2> <p>Enables the nginx Opentracing extension. <em><strong>default:</strong></em> is disabled</p> <p><em>References:</em> <a href=https://github.com/opentracing-contrib/nginx-opentracing>https://github.com/opentracing-contrib/nginx-opentracing</a></p> <h2 id=opentracing-operation-name>opentracing-operation-name<a class=headerlink href=#opentracing-operation-name title="Permanent link"></a></h2> <p>Specifies a custom name for the server span. <em><strong>default:</strong></em> is empty</p> <p>For example, set to "HTTP $request_method $uri".</p> <h2 id=opentracing-location-operation-name>opentracing-location-operation-name<a class=headerlink href=#opentracing-location-operation-name title="Permanent link"></a></h2> <p>Specifies a custom name for the location span. <em><strong>default:</strong></em> is empty</p> <p>For example, set to "HTTP $request_method $uri".</p> <h2 id=zipkin-collector-host>zipkin-collector-host<a class=headerlink href=#zipkin-collector-host title="Permanent link"></a></h2> <p>Specifies the host to use when uploading traces. It must be a valid URL.</p> <h2 id=zipkin-collector-port>zipkin-collector-port<a class=headerlink href=#zipkin-collector-port title="Permanent link"></a></h2> <p>Specifies the port to use when uploading traces. <em><strong>default:</strong></em> 9411</p> <h2 id=zipkin-service-name>zipkin-service-name<a class=headerlink href=#zipkin-service-name title="Permanent link"></a></h2> <p>Specifies the service name to use for any traces created. <em><strong>default:</strong></em> nginx</p> <h2 id=zipkin-sample-rate>zipkin-sample-rate<a class=headerlink href=#zipkin-sample-rate title="Permanent link"></a></h2> <p>Specifies sample rate for any traces created. <em><strong>default:</strong></em> 1.0</p> <h2 id=jaeger-collector-host>jaeger-collector-host<a class=headerlink href=#jaeger-collector-host title="Permanent link"></a></h2> <p>Specifies the host to use when uploading traces. It must be a valid URL.</p> <h2 id=jaeger-collector-port>jaeger-collector-port<a class=headerlink href=#jaeger-collector-port title="Permanent link"></a></h2> <p>Specifies the port to use when uploading traces. <em><strong>default:</strong></em> 6831</p> <h2 id=jaeger-endpoint>jaeger-endpoint<a class=headerlink href=#jaeger-endpoint title="Permanent link"></a></h2> <p>Specifies the endpoint to use when uploading traces to a collector. This takes priority over <code>jaeger-collector-host</code> if both are specified.</p> <h2 id=jaeger-service-name>jaeger-service-name<a class=headerlink href=#jaeger-service-name title="Permanent link"></a></h2> <p>Specifies the service name to use for any traces created. <em><strong>default:</strong></em> nginx</p> <h2 id=jaeger-propagation-format>jaeger-propagation-format<a class=headerlink href=#jaeger-propagation-format title="Permanent link"></a></h2> <p>Specifies the traceparent/tracestate propagation format. <em><strong>default:</strong></em> jaeger</p> <h2 id=jaeger-sampler-type>jaeger-sampler-type<a class=headerlink href=#jaeger-sampler-type title="Permanent link"></a></h2> <p>Specifies the sampler to be used when sampling traces. The available samplers are: const, probabilistic, ratelimiting, remote. <em><strong>default:</strong></em> const</p> <h2 id=jaeger-sampler-param>jaeger-sampler-param<a class=headerlink href=#jaeger-sampler-param title="Permanent link"></a></h2> <p>Specifies the argument to be passed to the sampler constructor. Must be a number. For const this should be 0 to never sample and 1 to always sample. <em><strong>default:</strong></em> 1</p> <h2 id=jaeger-sampler-host>jaeger-sampler-host<a class=headerlink href=#jaeger-sampler-host title="Permanent link"></a></h2> <p>Specifies the custom remote sampler host to be passed to the sampler constructor. Must be a valid URL. Leave blank to use default value (localhost). <em><strong>default:</strong></em> http://127.0.0.1</p> <h2 id=jaeger-sampler-port>jaeger-sampler-port<a class=headerlink href=#jaeger-sampler-port title="Permanent link"></a></h2> <p>Specifies the custom remote sampler port to be passed to the sampler constructor. Must be a number. <em><strong>default:</strong></em> 5778</p> <h2 id=jaeger-trace-context-header-name>jaeger-trace-context-header-name<a class=headerlink href=#jaeger-trace-context-header-name title="Permanent link"></a></h2> <p>Specifies the header name used for passing trace context. <em><strong>default:</strong></em> uber-trace-id</p> <h2 id=jaeger-debug-header>jaeger-debug-header<a class=headerlink href=#jaeger-debug-header title="Permanent link"></a></h2> <p>Specifies the header name used for force sampling. <em><strong>default:</strong></em> jaeger-debug-id</p> <h2 id=jaeger-baggage-header>jaeger-baggage-header<a class=headerlink href=#jaeger-baggage-header title="Permanent link"></a></h2> <p>Specifies the header name used to submit baggage if there is no root span. <em><strong>default:</strong></em> jaeger-baggage</p> <h2 id=jaeger-tracer-baggage-header-prefix>jaeger-tracer-baggage-header-prefix<a class=headerlink href=#jaeger-tracer-baggage-header-prefix title="Permanent link"></a></h2> <p>Specifies the header prefix used to propagate baggage. <em><strong>default:</strong></em> uberctx-</p> <h2 id=datadog-collector-host>datadog-collector-host<a class=headerlink href=#datadog-collector-host title="Permanent link"></a></h2> <p>Specifies the datadog agent host to use when uploading traces. It must be a valid URL.</p> <h2 id=datadog-collector-port>datadog-collector-port<a class=headerlink href=#datadog-collector-port title="Permanent link"></a></h2> <p>Specifies the port to use when uploading traces. <em><strong>default:</strong></em> 8126</p> <h2 id=datadog-service-name>datadog-service-name<a class=headerlink href=#datadog-service-name title="Permanent link"></a></h2> <p>Specifies the service name to use for any traces created. <em><strong>default:</strong></em> nginx</p> <h2 id=datadog-environment>datadog-environment<a class=headerlink href=#datadog-environment title="Permanent link"></a></h2> <p>Specifies the environment this trace belongs to. <em><strong>default:</strong></em> prod</p> <h2 id=datadog-operation-name-override>datadog-operation-name-override<a class=headerlink href=#datadog-operation-name-override title="Permanent link"></a></h2> <p>Overrides the operation naem to use for any traces crated. <em><strong>default:</strong></em> nginx.handle</p> <h2 id=datadog-priority-sampling>datadog-priority-sampling<a class=headerlink href=#datadog-priority-sampling title="Permanent link"></a></h2> <p>Specifies to use client-side sampling. If true disables client-side sampling (thus ignoring <code>sample_rate</code>) and enables distributed priority sampling, where traces are sampled based on a combination of user-assigned priorities and configuration from the agent. <em><strong>default:</strong></em> true</p> <h2 id=datadog-sample-rate>datadog-sample-rate<a class=headerlink href=#datadog-sample-rate title="Permanent link"></a></h2> <p>Specifies sample rate for any traces created. This is effective only when <code>datadog-priority-sampling</code> is <code>false</code> <em><strong>default:</strong></em> 1.0</p> <h2 id=main-snippet>main-snippet<a class=headerlink href=#main-snippet title="Permanent link"></a></h2> <p>Adds custom configuration to the main section of the nginx configuration.</p> <h2 id=http-snippet>http-snippet<a class=headerlink href=#http-snippet title="Permanent link"></a></h2> <p>Adds custom configuration to the http section of the nginx configuration.</p> <h2 id=server-snippet>server-snippet<a class=headerlink href=#server-snippet title="Permanent link"></a></h2> <p>Adds custom configuration to all the servers in the nginx configuration.</p> <h2 id=location-snippet>location-snippet<a class=headerlink href=#location-snippet title="Permanent link"></a></h2> <p>Adds custom configuration to all the locations in the nginx configuration.</p> <p>You can not use this to add new locations that proxy to the Kubernetes pods, as the snippet does not have access to the Go template functions. If you want to add custom locations you will have to <a href=https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/custom-template/ >provide your own nginx.tmpl</a>.</p> <h2 id=custom-http-errors>custom-http-errors<a class=headerlink href=#custom-http-errors title="Permanent link"></a></h2> <p>Enables which HTTP codes should be passed for processing with the <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#error_page>error_page directive</a></p> <p>Setting at least one code also enables <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_intercept_errors>proxy_intercept_errors</a> which are required to process error_page.</p> <p>Example usage: <code>custom-http-errors: 404,415</code></p> <h2 id=proxy-body-size>proxy-body-size<a class=headerlink href=#proxy-body-size title="Permanent link"></a></h2> <p>Sets the maximum allowed size of the client request body. See NGINX <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size>client_max_body_size</a>.</p> <h2 id=proxy-connect-timeout>proxy-connect-timeout<a class=headerlink href=#proxy-connect-timeout title="Permanent link"></a></h2> <p>Sets the timeout for <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_connect_timeout>establishing a connection with a proxied server</a>. It should be noted that this timeout cannot usually exceed 75 seconds.</p> <h2 id=proxy-read-timeout>proxy-read-timeout<a class=headerlink href=#proxy-read-timeout title="Permanent link"></a></h2> <p>Sets the timeout in seconds for <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_read_timeout>reading a response from the proxied server</a>. The timeout is set only between two successive read operations, not for the transmission of the whole response.</p> <h2 id=proxy-send-timeout>proxy-send-timeout<a class=headerlink href=#proxy-send-timeout title="Permanent link"></a></h2> <p>Sets the timeout in seconds for <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_send_timeout>transmitting a request to the proxied server</a>. The timeout is set only between two successive write operations, not for the transmission of the whole request.</p> <h2 id=proxy-buffers-number>proxy-buffers-number<a class=headerlink href=#proxy-buffers-number title="Permanent link"></a></h2> <p>Sets the number of the buffer used for <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffers>reading the first part of the response</a> received from the proxied server. This part usually contains a small response header.</p> <h2 id=proxy-buffer-size>proxy-buffer-size<a class=headerlink href=#proxy-buffer-size title="Permanent link"></a></h2> <p>Sets the size of the buffer used for <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffer_size>reading the first part of the response</a> received from the proxied server. This part usually contains a small response header.</p> <h2 id=proxy-cookie-path>proxy-cookie-path<a class=headerlink href=#proxy-cookie-path title="Permanent link"></a></h2> <p>Sets a text that <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_path>should be changed in the path attribute</a> of the “Set-Cookie” header fields of a proxied server response.</p> <h2 id=proxy-cookie-domain>proxy-cookie-domain<a class=headerlink href=#proxy-cookie-domain title="Permanent link"></a></h2> <p>Sets a text that <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_domain>should be changed in the domain attribute</a> of the “Set-Cookie” header fields of a proxied server response.</p> <h2 id=proxy-next-upstream>proxy-next-upstream<a class=headerlink href=#proxy-next-upstream title="Permanent link"></a></h2> <p>Specifies in <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_next_upstream>which cases</a> a request should be passed to the next server.</p> <h2 id=proxy-next-upstream-timeout>proxy-next-upstream-timeout<a class=headerlink href=#proxy-next-upstream-timeout title="Permanent link"></a></h2> <p><a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_next_upstream_timeout>Limits the time</a> in seconds during which a request can be passed to the next server.</p> <h2 id=proxy-next-upstream-tries>proxy-next-upstream-tries<a class=headerlink href=#proxy-next-upstream-tries title="Permanent link"></a></h2> <p>Limit the number of <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_next_upstream_tries>possible tries</a> a request should be passed to the next server.</p> <h2 id=proxy-redirect-from>proxy-redirect-from<a class=headerlink href=#proxy-redirect-from title="Permanent link"></a></h2> <p>Sets the original text that should be changed in the "Location" and "Refresh" header fields of a proxied server response. <em><strong>default:</strong></em> off</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_redirect>http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_redirect</a></p> <h2 id=proxy-request-buffering>proxy-request-buffering<a class=headerlink href=#proxy-request-buffering title="Permanent link"></a></h2> <p>Enables or disables <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_request_buffering>buffering of a client request body</a>.</p> <h2 id=ssl-redirect>ssl-redirect<a class=headerlink href=#ssl-redirect title="Permanent link"></a></h2> <p>Sets the global value of redirects (301) to HTTPS if the server has a TLS certificate (defined in an Ingress rule). <em><strong>default:</strong></em> "true"</p> <h2 id=whitelist-source-range>whitelist-source-range<a class=headerlink href=#whitelist-source-range title="Permanent link"></a></h2> <p>Sets the default whitelisted IPs for each <code>server</code> block. This can be overwritten by an annotation on an Ingress rule. See <a href=http://nginx.org/en/docs/http/ngx_http_access_module.html>ngx_http_access_module</a>.</p> <h2 id=skip-access-log-urls>skip-access-log-urls<a class=headerlink href=#skip-access-log-urls title="Permanent link"></a></h2> <p>Sets a list of URLs that should not appear in the NGINX access log. This is useful with urls like <code>/health</code> or <code>health-check</code> that make "complex" reading the logs. <em><strong>default:</strong></em> is empty</p> <h2 id=limit-rate>limit-rate<a class=headerlink href=#limit-rate title="Permanent link"></a></h2> <p>Limits the rate of response transmission to a client. The rate is specified in bytes per second. The zero value disables rate limiting. The limit is set per a request, and so if a client simultaneously opens two connections, the overall rate will be twice as much as the specified limit.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#limit_rate>http://nginx.org/en/docs/http/ngx_http_core_module.html#limit_rate</a></p> <h2 id=limit-rate-after>limit-rate-after<a class=headerlink href=#limit-rate-after title="Permanent link"></a></h2> <p>Sets the initial amount after which the further transmission of a response to a client will be rate limited.</p> <h2 id=lua-shared-dicts>lua-shared-dicts<a class=headerlink href=#lua-shared-dicts title="Permanent link"></a></h2> <p>Customize default Lua shared dictionaries or define more. You can use the following syntax to do so:</p> <div class=highlight><pre><span></span><code>lua-shared-dicts: &quot;&lt;my dict name&gt;: &lt;my dict size&gt;, [&lt;my dict name&gt;: &lt;my dict size&gt;], ...&quot;
</code></pre></div> <p>For example following will set default <code>certificate_data</code> dictionary to <code>100M</code> and will introduce a new dictionary called <code>my_custom_plugin</code>:</p> <div class=highlight><pre><span></span><code>lua-shared-dicts: &quot;certificate_data: 100, my_custom_plugin: 5&quot;
</code></pre></div> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#limit_rate_after>http://nginx.org/en/docs/http/ngx_http_core_module.html#limit_rate_after</a></p> <h2 id=http-redirect-code>http-redirect-code<a class=headerlink href=#http-redirect-code title="Permanent link"></a></h2> <p>Sets the HTTP status code to be used in redirects. Supported codes are <a href=https://developer.mozilla.org/docs/Web/HTTP/Status/301>301</a>,<a href=https://developer.mozilla.org/docs/Web/HTTP/Status/302>302</a>,<a href=https://developer.mozilla.org/docs/Web/HTTP/Status/307>307</a> and <a href=https://developer.mozilla.org/docs/Web/HTTP/Status/308>308</a> <em><strong>default:</strong></em> 308</p> <blockquote> <p><strong>Why the default code is 308?</strong></p> <p><a href=https://tools.ietf.org/html/rfc7238>RFC 7238</a> was created to define the 308 (Permanent Redirect) status code that is similar to 301 (Moved Permanently) but it keeps the payload in the redirect. This is important if we send a redirect in methods like POST.</p> </blockquote> <h2 id=proxy-buffering>proxy-buffering<a class=headerlink href=#proxy-buffering title="Permanent link"></a></h2> <p>Enables or disables <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering>buffering of responses from the proxied server</a>.</p> <h2 id=limit-req-status-code>limit-req-status-code<a class=headerlink href=#limit-req-status-code title="Permanent link"></a></h2> <p>Sets the <a href=http://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_status>status code to return in response to rejected requests</a>. <em><strong>default:</strong></em> 503</p> <h2 id=limit-conn-status-code>limit-conn-status-code<a class=headerlink href=#limit-conn-status-code title="Permanent link"></a></h2> <p>Sets the <a href=http://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_status>status code to return in response to rejected connections</a>. <em><strong>default:</strong></em> 503</p> <h2 id=no-tls-redirect-locations>no-tls-redirect-locations<a class=headerlink href=#no-tls-redirect-locations title="Permanent link"></a></h2> <p>A comma-separated list of locations on which http requests will never get redirected to their https counterpart. <em><strong>default:</strong></em> "/.well-known/acme-challenge"</p> <h2 id=global-auth-url>global-auth-url<a class=headerlink href=#global-auth-url title="Permanent link"></a></h2> <p>A url to an existing service that provides authentication for all the locations. Similar to the Ingress rule annotation <code>nginx.ingress.kubernetes.io/auth-url</code>. Locations that should not get authenticated can be listed using <code>no-auth-locations</code> See <a href=#no-auth-locations>no-auth-locations</a>. In addition, each service can be excluded from authentication via annotation <code>enable-global-auth</code> set to "false". <em><strong>default:</strong></em> ""</p> <p><em>References:</em> <a href=https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/annotations.md#external-authentication>https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/annotations.md#external-authentication</a></p> <h2 id=global-auth-method>global-auth-method<a class=headerlink href=#global-auth-method title="Permanent link"></a></h2> <p>A HTTP method to use for an existing service that provides authentication for all the locations. Similar to the Ingress rule annotation <code>nginx.ingress.kubernetes.io/auth-method</code>. <em><strong>default:</strong></em> ""</p> <h2 id=global-auth-signin>global-auth-signin<a class=headerlink href=#global-auth-signin title="Permanent link"></a></h2> <p>Sets the location of the error page for an existing service that provides authentication for all the locations. Similar to the Ingress rule annotation <code>nginx.ingress.kubernetes.io/auth-signin</code>. <em><strong>default:</strong></em> ""</p> <h2 id=global-auth-signin-redirect-param>global-auth-signin-redirect-param<a class=headerlink href=#global-auth-signin-redirect-param title="Permanent link"></a></h2> <p>Sets the query parameter in the error page signin URL which contains the original URL of the request that failed authentication. Similar to the Ingress rule annotation <code>nginx.ingress.kubernetes.io/auth-signin-redirect-param</code>. <em><strong>default:</strong></em> "rd"</p> <h2 id=global-auth-response-headers>global-auth-response-headers<a class=headerlink href=#global-auth-response-headers title="Permanent link"></a></h2> <p>Sets the headers to pass to backend once authentication request completes. Applied to all the locations. Similar to the Ingress rule annotation <code>nginx.ingress.kubernetes.io/auth-response-headers</code>. <em><strong>default:</strong></em> ""</p> <h2 id=global-auth-request-redirect>global-auth-request-redirect<a class=headerlink href=#global-auth-request-redirect title="Permanent link"></a></h2> <p>Sets the X-Auth-Request-Redirect header value. Applied to all the locations. Similar to the Ingress rule annotation <code>nginx.ingress.kubernetes.io/auth-request-redirect</code>. <em><strong>default:</strong></em> ""</p> <h2 id=global-auth-snippet>global-auth-snippet<a class=headerlink href=#global-auth-snippet title="Permanent link"></a></h2> <p>Sets a custom snippet to use with external authentication. Applied to all the locations. Similar to the Ingress rule annotation <code>nginx.ingress.kubernetes.io/auth-request-redirect</code>. <em><strong>default:</strong></em> ""</p> <h2 id=global-auth-cache-key>global-auth-cache-key<a class=headerlink href=#global-auth-cache-key title="Permanent link"></a></h2> <p>Enables caching for global auth requests. Specify a lookup key for auth responses, e.g. <code>$remote_user$http_authorization</code>.</p> <h2 id=global-auth-cache-duration>global-auth-cache-duration<a class=headerlink href=#global-auth-cache-duration title="Permanent link"></a></h2> <p>Set a caching time for auth responses based on their response codes, e.g. <code>200 202 30m</code>. See <a href=http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_valid>proxy_cache_valid</a> for details. You may specify multiple, comma-separated values: <code>200 202 10m, 401 5m</code>. defaults to <code>200 202 401 5m</code>.</p> <h2 id=no-auth-locations>no-auth-locations<a class=headerlink href=#no-auth-locations title="Permanent link"></a></h2> <p>A comma-separated list of locations that should not get authenticated. <em><strong>default:</strong></em> "/.well-known/acme-challenge"</p> <h2 id=block-cidrs>block-cidrs<a class=headerlink href=#block-cidrs title="Permanent link"></a></h2> <p>A comma-separated list of IP addresses (or subnets), request from which have to be blocked globally.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_access_module.html#deny>http://nginx.org/en/docs/http/ngx_http_access_module.html#deny</a></p> <h2 id=block-user-agents>block-user-agents<a class=headerlink href=#block-user-agents title="Permanent link"></a></h2> <p>A comma-separated list of User-Agent, request from which have to be blocked globally. It's possible to use here full strings and regular expressions. More details about valid patterns can be found at <code>map</code> Nginx directive documentation.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_map_module.html#map>http://nginx.org/en/docs/http/ngx_http_map_module.html#map</a></p> <h2 id=block-referers>block-referers<a class=headerlink href=#block-referers title="Permanent link"></a></h2> <p>A comma-separated list of Referers, request from which have to be blocked globally. It's possible to use here full strings and regular expressions. More details about valid patterns can be found at <code>map</code> Nginx directive documentation.</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_map_module.html#map>http://nginx.org/en/docs/http/ngx_http_map_module.html#map</a></p> <h2 id=proxy-ssl-location-only>proxy-ssl-location-only<a class=headerlink href=#proxy-ssl-location-only title="Permanent link"></a></h2> <p>Set if proxy-ssl parameters should be applied only on locations and not on servers. <em><strong>default:</strong></em> is disabled</p> <h2 id=default-type>default-type<a class=headerlink href=#default-type title="Permanent link"></a></h2> <p>Sets the default MIME type of a response. <em><strong>default:</strong></em> text/html</p> <p><em>References:</em> <a href=http://nginx.org/en/docs/http/ngx_http_core_module.html#default_type>http://nginx.org/en/docs/http/ngx_http_core_module.html#default_type</a></p> <h2 id=global-rate-limit>global-rate-limit<a class=headerlink href=#global-rate-limit title="Permanent link"></a></h2> <ul> <li><code>global-rate-limit-status-code</code>: configure HTTP status code to return when rejecting requests. Defaults to 429.</li> </ul> <p>Configure <code>memcached</code> client for <a href=https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/annotations.md#global-rate-limiting>Global Rate Limiting</a>.</p> <ul> <li><code>global-rate-limit-memcached-host</code>: IP/FQDN of memcached server to use. Required to enable Global Rate Limiting.</li> <li><code>global-rate-limit-memcached-port</code>: port of memcached server to use. Defaults default memcached port of <code>11211</code>.</li> <li><code>global-rate-limit-memcached-connect-timeout</code>: configure timeout for connect, send and receive operations. Unit is millisecond. Defaults to 50ms.</li> <li><code>global-rate-limit-memcached-max-idle-timeout</code>: configure timeout for cleaning idle connections. Unit is millisecond. Defaults to 50ms. </li> <li><code>global-rate-limit-memcached-pool-size</code>: configure number of max connections to keep alive. Make sure your <code>memcached</code> server can handle <code>global-rate-limit-memcached-pool-size * worker-processes * &lt;number of ingress-nginx replicas&gt;</code> simultaneous connections.</li> </ul> <p>These settings get used by <a href=https://github.com/ElvinEfendi/lua-resty-global-throttle>lua-resty-global-throttle</a> that ingress-nginx includes. Refer to the link to learn more about <code>lua-resty-global-throttle</code>.</p> </article> </div> </div> </main> <footer class=md-footer> <div class=md-footer-nav> <nav class="md-footer-nav__inner md-grid" aria-label=Footer> <a href=../annotations/ class="md-footer-nav__link md-footer-nav__link--prev" rel=prev> <div class="md-footer-nav__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> </div> <div class=md-footer-nav__title> <div class=md-ellipsis> <span class=md-footer-nav__direction> Previous </span> Annotations </div> </div> </a> <a href=../custom-template/ class="md-footer-nav__link md-footer-nav__link--next" rel=next> <div class=md-footer-nav__title> <div class=md-ellipsis> <span class=md-footer-nav__direction> Next </span> Custom NGINX template </div> </div> <div class="md-footer-nav__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg> </div> </a> </nav> </div> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-footer-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <script src=../../../assets/javascripts/vendor.93c04032.min.js></script> <script src=../../../assets/javascripts/bundle.83e5331e.min.js></script><script id=__lang type=application/json>{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script> <script>
app = initialize({
base: "../../..",
features: ['navigation.tabs', 'navigation.tabs.sticky', 'navigation.instant', 'navigation.sections'],
search: Object.assign({
worker: "../../../assets/javascripts/worker/search.8c7e0a7e.min.js"
}, typeof search !== "undefined" && search)
})
</script> </body> </html>
Reference in New Issue View Git Blame Copy Permalink