From 131fdf1e01b95ab0ca1058dcd1bcede6495b822c Mon Sep 17 00:00:00 2001 From: Victor Trac Date: Fri, 16 Feb 2018 17:02:41 -0600 Subject: [PATCH] replace '‑' with actual dashes '-' (#2111) --- docs/user-guide/configmap.md | 206 +++++++++++++++++------------------ 1 file changed, 103 insertions(+), 103 deletions(-) diff --git a/docs/user-guide/configmap.md b/docs/user-guide/configmap.md index ef1b45d63..6e8456907 100644 --- a/docs/user-guide/configmap.md +++ b/docs/user-guide/configmap.md @@ -25,110 +25,110 @@ The following table shows a configuration option's name, type, and the default v |name|type|default| |:---|:---|:------| -|[add‑headers](#add-headers)|string|""| -|[allow‑backend‑server‑header](#allow-backend-server-header)|bool|"false"| -|[hide‑headers](#hide-headers)|string array|empty| -|[access‑log‑path](#access-log-path)|string|"/var/log/nginx/access.log"| -|[error‑log‑path](#error-log-path)|string|"/var/log/nginx/error.log"| -|[enable‑dynamic‑tls‑records](#enable-dynamic-tls-records)|bool|"true"| -|[enable‑modsecurity](#enable-modsecurity)|bool|"false"| -|[enable‑owasp‑modsecurity‑crs](#enable-owasp-modsecurity-crs)|bool|"false"| -|[client‑header‑buffer‑size](#client-header-buffer-size)|string|"1k"| -|[client‑header‑timeout](#client-header-timeout)|int|60| -|[client‑body‑buffer‑size](#client-body-buffer-size)|string|"8k"| -|[client‑body‑timeout](#client-body-timeout)|int|60| -|[disable‑access‑log](#disable-access-log)|bool|false| -|[disable‑ipv6](#disable-ipv6)|bool|false| -|[disable‑ipv6‑dns](#disable-ipv6-dns)|bool|false| -|[enable‑underscores‑in‑headers](#enable-underscores-in-headers)|bool|false| -|[ignore‑invalid‑headers](#ignore-invalid-headers)|bool|true| -|[enable‑vts‑status](#enable-vts-status)|bool|false| -|[vts‑status‑zone‑size](#vts-status-zone-size)|string|"10m"| -|[vts‑default‑filter‑key](#vts-default-filter-key)|string|"$geoip_country_code country::*"| -|[retry‑non‑idempotent](#retry-non-idempotent)|bool|"false"| -|[error‑log‑level](#error-log-level)|string|"notice"| -|[http2‑max‑field‑size](#http2-max-field-size)|string|"4k"| -|[http2‑max‑header‑size](#http2-max-header-size)|string|"16k"| +|[add-headers](#add-headers)|string|""| +|[allow-backend-server-header](#allow-backend-server-header)|bool|"false"| +|[hide-headers](#hide-headers)|string array|empty| +|[access-log-path](#access-log-path)|string|"/var/log/nginx/access.log"| +|[error-log-path](#error-log-path)|string|"/var/log/nginx/error.log"| +|[enable-dynamic-tls-records](#enable-dynamic-tls-records)|bool|"true"| +|[enable-modsecurity](#enable-modsecurity)|bool|"false"| +|[enable-owasp-modsecurity-crs](#enable-owasp-modsecurity-crs)|bool|"false"| +|[client-header-buffer-size](#client-header-buffer-size)|string|"1k"| +|[client-header-timeout](#client-header-timeout)|int|60| +|[client-body-buffer-size](#client-body-buffer-size)|string|"8k"| +|[client-body-timeout](#client-body-timeout)|int|60| +|[disable-access-log](#disable-access-log)|bool|false| +|[disable-ipv6](#disable-ipv6)|bool|false| +|[disable-ipv6-dns](#disable-ipv6-dns)|bool|false| +|[enable-underscores-in-headers](#enable-underscores-in-headers)|bool|false| +|[ignore-invalid-headers](#ignore-invalid-headers)|bool|true| +|[enable-vts-status](#enable-vts-status)|bool|false| +|[vts-status-zone-size](#vts-status-zone-size)|string|"10m"| +|[vts-default-filter-key](#vts-default-filter-key)|string|"$geoip_country_code country::*"| +|[retry-non-idempotent](#retry-non-idempotent)|bool|"false"| +|[error-log-level](#error-log-level)|string|"notice"| +|[http2-max-field-size](#http2-max-field-size)|string|"4k"| +|[http2-max-header-size](#http2-max-header-size)|string|"16k"| |[hsts](#hsts)|bool|"true"| -|[hsts‑include‑subdomains](#hsts-include-subdomains)|bool|"true"| -|[hsts‑max‑age](#hsts-max-age)|string|"15724800"| -|[hsts‑preload](#hsts-preload)|bool|"false"| -|[keep‑alive](#keep-alive)|int|75| -|[keep‑alive‑requests](#keep-alive-requests)|int|100| -|[large‑client‑header‑buffers](#large-client-header-buffers)|string|"4 8k"| -|[log‑format‑escape‑json](#log-format-escape-json)|bool|"false"| -|[log‑format‑upstream](#log-format-upstream)|string|`%v - [$the_real_ip] - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" $request_length $request_time [$proxy_upstream_name] $upstream_addr $upstream_response_length $upstream_response_time $upstream_status`| -|[log‑format‑stream](#log-format-stream)|string|`[$time_local] $protocol $status $bytes_sent $bytes_received $session_time`| -|[max‑worker‑connections](#max-worker-connections)|int|16384| -|[map‑hash‑bucket‑size](#max-worker-connections)|int|64| -|[proxy‑real‑ip‑cidr](#proxy-real-ip-cidr)|[]string|"0.0.0.0/0"| -|[proxy‑set‑headers](#proxy-set-headers)|string|""| -|[server‑name‑hash‑max‑size](#server-name-hash-max-size)|int|1024| -|[server‑name‑hash‑bucket‑size](#server-name-hash-bucket-size)|int|`` -|[proxy‑headers‑hash‑max‑size](#proxy-headers-hash-max-size)|int|512| -|[proxy‑headers‑hash‑bucket‑size](#proxy-headers-hash-bucket-size)|int|64| -|[server‑tokens](#server-tokens)|bool|"true"| -|[ssl‑ciphers](#ssl-ciphers)|string|"ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256"| -|[ssl‑ecdh‑curve](#ssl-ecdh-curve)|string|"auto"| -|[ssl‑dh‑param](#ssl-dh-param)|string|""| -|[ssl‑protocols](#ssl-protocols)|string|"TLSv1.2"| -|[ssl‑session‑cache](#ssl-session-cache)|bool|"true"| -|[ssl‑session‑cache‑size](#ssl-session-cache-size)|string|"10m"| -|[ssl‑session‑tickets](#ssl-session-tickets)|bool|"true"| -|[ssl‑session‑ticket‑key](#ssl-session-ticket-key)|string|`` -|[ssl‑session‑timeout](#ssl-session-timeout)|string|"10m"| -|[ssl‑buffer‑size](#ssl-buffer-size)|string|"4k"| -|[use‑proxy‑protocol](#use-proxy-protocol)|bool|"false"| -|[use‑gzip](#use-gzip)|bool|"true"| -|[enable‑brotli](#enable-brotli)|bool|"true"| -|[brotli‑level](#brotli-level)|int|4| -|[brotli‑types](#brotli-types)|string|"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"| -|[use‑http2](#use-http2)|bool|"true"| -|[gzip‑types](#gzip-types)|string|"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"| -|[worker‑processes](#worker-processes)|string|``| -|[worker‑shutdown‑timeout](#worker-shutdown-timeout)|string|"10s"| -|[load‑balance](#load-balance)|string|"least_conn"| -|[variables‑hash‑bucket‑size](#variables-hash-bucket-size)|int|128| -|[variables‑hash‑max‑size](#variables-hash-max-size)|int|2048| -|[upstream‑keepalive‑connections](#upstream-keepalive-connections)|int|32| -|[limit‑conn‑zone‑variable](#limit-conn-zone-variable)|string|"$binary_remote_addr"| -|[proxy‑stream‑timeout](#proxy-stream-timeout)|string|"600s"| -|[proxy‑stream‑responses](#proxy-stream-responses)|int|1| -|[bind‑address‑ipv4](#bind-address-ipv4)|[]string|""| -|[bind‑address‑ipv6](#bind-address-ipv6)|[]string|""| -|[forwarded‑for‑header](#forwarded-for-header)|string|"X-Forwarded-For"| -|[compute‑full‑forwarded‑for](#compute-full-forwarded-for)|bool|"false"| -|[enable‑opentracing](#enable-opentracing)|bool|"false"| -|[zipkin‑collector‑host](#zipkin-collector-host)|string|""| -|[zipkin‑collector‑port](#zipkin-collector-port)|int|9411| -|[zipkin‑service‑name](#zipkin-service-name)|string|"nginx"| -|[jaeger‑collector‑host](#jaeger-collector-host)|string|""| -|[jaeger‑collector‑port](#jaeger-collector-port)|int|6831| -|[jaeger‑service‑name](#jaeger-service-name)|string|"nginx"| -|[jaeger‑sampler‑type](#jaeger-sampler-type)|string|"const"| -|[jaeger‑sampler‑param](#jaeger-sampler-param)|string|"1"| -|[http‑snippet](#http-snippet)|string|""| -|[server‑snippet](#server-snippet)|string|""| -|[location‑snippet](#location-snippet)|string|""| -|[custom‑http‑errors](#custom-http-errors)|[]int]|[]int{}| -|[proxy‑body‑size](#proxy-body-size)|string|"1m"| -|[proxy‑connect‑timeout](#proxy-connect-timeout)|int|5| -|[proxy‑read‑timeout](#proxy-read-timeout)|int|60| -|[proxy‑send‑timeout](#proxy-send-timeout)|int|60| -|[proxy‑buffer‑size](#proxy-buffer-size)|string|"4k"| -|[proxy‑cookie‑path](#proxy-cookie-path)|string|"off"| -|[proxy‑cookie‑domain](#proxy-cookie-domain)|string|"off"| -|[proxy‑next‑upstream](#proxy-next-upstream)|string|"error timeout invalid_header http_502 http_503 http_504"| -|[proxy‑redirect‑from](#proxy-redirect-from)|string|"off"| -|[proxy‑request‑buffering](#proxy-request-buffering)|string|"on"| -|[ssl‑redirect](#ssl-redirect)|bool|"true"| -|[whitelist‑source‑range](#whitelist-source-range)|[]string|[]string{}| -|[skip‑access‑log‑urls](#skip-access-log-urls)|[]string|[]string{}| -|[limit‑rate](#limit-rate)|int|0| -|[limit‑rate‑after](#limit-rate-after)|int|0| -|[http‑redirect‑code](#http-redirect-code)|int|308| -|[proxy‑buffering](#proxy-buffering)|string|"off"| -|[limit‑request‑status‑code](#limit-request-status-code)|int|503| +|[hsts-include-subdomains](#hsts-include-subdomains)|bool|"true"| +|[hsts-max-age](#hsts-max-age)|string|"15724800"| +|[hsts-preload](#hsts-preload)|bool|"false"| +|[keep-alive](#keep-alive)|int|75| +|[keep-alive-requests](#keep-alive-requests)|int|100| +|[large-client-header-buffers](#large-client-header-buffers)|string|"4 8k"| +|[log-format-escape-json](#log-format-escape-json)|bool|"false"| +|[log-format-upstream](#log-format-upstream)|string|`%v - [$the_real_ip] - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" $request_length $request_time [$proxy_upstream_name] $upstream_addr $upstream_response_length $upstream_response_time $upstream_status`| +|[log-format-stream](#log-format-stream)|string|`[$time_local] $protocol $status $bytes_sent $bytes_received $session_time`| +|[max-worker-connections](#max-worker-connections)|int|16384| +|[map-hash-bucket-size](#max-worker-connections)|int|64| +|[proxy-real-ip-cidr](#proxy-real-ip-cidr)|[]string|"0.0.0.0/0"| +|[proxy-set-headers](#proxy-set-headers)|string|""| +|[server-name-hash-max-size](#server-name-hash-max-size)|int|1024| +|[server-name-hash-bucket-size](#server-name-hash-bucket-size)|int|`` +|[proxy-headers-hash-max-size](#proxy-headers-hash-max-size)|int|512| +|[proxy-headers-hash-bucket-size](#proxy-headers-hash-bucket-size)|int|64| +|[server-tokens](#server-tokens)|bool|"true"| +|[ssl-ciphers](#ssl-ciphers)|string|"ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256"| +|[ssl-ecdh-curve](#ssl-ecdh-curve)|string|"auto"| +|[ssl-dh-param](#ssl-dh-param)|string|""| +|[ssl-protocols](#ssl-protocols)|string|"TLSv1.2"| +|[ssl-session-cache](#ssl-session-cache)|bool|"true"| +|[ssl-session-cache-size](#ssl-session-cache-size)|string|"10m"| +|[ssl-session-tickets](#ssl-session-tickets)|bool|"true"| +|[ssl-session-ticket-key](#ssl-session-ticket-key)|string|`` +|[ssl-session-timeout](#ssl-session-timeout)|string|"10m"| +|[ssl-buffer-size](#ssl-buffer-size)|string|"4k"| +|[use-proxy-protocol](#use-proxy-protocol)|bool|"false"| +|[use-gzip](#use-gzip)|bool|"true"| +|[enable-brotli](#enable-brotli)|bool|"true"| +|[brotli-level](#brotli-level)|int|4| +|[brotli-types](#brotli-types)|string|"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"| +|[use-http2](#use-http2)|bool|"true"| +|[gzip-types](#gzip-types)|string|"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"| +|[worker-processes](#worker-processes)|string|``| +|[worker-shutdown-timeout](#worker-shutdown-timeout)|string|"10s"| +|[load-balance](#load-balance)|string|"least_conn"| +|[variables-hash-bucket-size](#variables-hash-bucket-size)|int|128| +|[variables-hash-max-size](#variables-hash-max-size)|int|2048| +|[upstream-keepalive-connections](#upstream-keepalive-connections)|int|32| +|[limit-conn-zone-variable](#limit-conn-zone-variable)|string|"$binary_remote_addr"| +|[proxy-stream-timeout](#proxy-stream-timeout)|string|"600s"| +|[proxy-stream-responses](#proxy-stream-responses)|int|1| +|[bind-address-ipv4](#bind-address-ipv4)|[]string|""| +|[bind-address-ipv6](#bind-address-ipv6)|[]string|""| +|[forwarded-for-header](#forwarded-for-header)|string|"X-Forwarded-For"| +|[compute-full-forwarded-for](#compute-full-forwarded-for)|bool|"false"| +|[enable-opentracing](#enable-opentracing)|bool|"false"| +|[zipkin-collector-host](#zipkin-collector-host)|string|""| +|[zipkin-collector-port](#zipkin-collector-port)|int|9411| +|[zipkin-service-name](#zipkin-service-name)|string|"nginx"| +|[jaeger-collector-host](#jaeger-collector-host)|string|""| +|[jaeger-collector-port](#jaeger-collector-port)|int|6831| +|[jaeger-service-name](#jaeger-service-name)|string|"nginx"| +|[jaeger-sampler-type](#jaeger-sampler-type)|string|"const"| +|[jaeger-sampler-param](#jaeger-sampler-param)|string|"1"| +|[http-snippet](#http-snippet)|string|""| +|[server-snippet](#server-snippet)|string|""| +|[location-snippet](#location-snippet)|string|""| +|[custom-http-errors](#custom-http-errors)|[]int]|[]int{}| +|[proxy-body-size](#proxy-body-size)|string|"1m"| +|[proxy-connect-timeout](#proxy-connect-timeout)|int|5| +|[proxy-read-timeout](#proxy-read-timeout)|int|60| +|[proxy-send-timeout](#proxy-send-timeout)|int|60| +|[proxy-buffer-size](#proxy-buffer-size)|string|"4k"| +|[proxy-cookie-path](#proxy-cookie-path)|string|"off"| +|[proxy-cookie-domain](#proxy-cookie-domain)|string|"off"| +|[proxy-next-upstream](#proxy-next-upstream)|string|"error timeout invalid_header http_502 http_503 http_504"| +|[proxy-redirect-from](#proxy-redirect-from)|string|"off"| +|[proxy-request-buffering](#proxy-request-buffering)|string|"on"| +|[ssl-redirect](#ssl-redirect)|bool|"true"| +|[whitelist-source-range](#whitelist-source-range)|[]string|[]string{}| +|[skip-access-log-urls](#skip-access-log-urls)|[]string|[]string{}| +|[limit-rate](#limit-rate)|int|0| +|[limit-rate-after](#limit-rate-after)|int|0| +|[http-redirect-code](#http-redirect-code)|int|308| +|[proxy-buffering](#proxy-buffering)|string|"off"| +|[limit-request-status-code](#limit-request-status-code)|int|503| ## add-headers