nginx.tmpl 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986
  1. # nginx-proxy{{ if $.Env.NGINX_PROXY_VERSION }} version : {{ $.Env.NGINX_PROXY_VERSION }}{{ end }}
  2. {{- /*
  3. * Global values. Values are stored in this map rather than in individual
  4. * global variables so that the values can be easily passed to embedded
  5. * templates. (Go templates cannot access variables outside of their own
  6. * scope.)
  7. */}}
  8. {{- $globals := dict }}
  9. {{- $_ := set $globals "containers" $ }}
  10. {{- $_ := set $globals "Env" $.Env }}
  11. {{- $_ := set $globals "Docker" $.Docker }}
  12. {{- $_ := set $globals "CurrentContainer" (where $globals.containers "ID" $globals.Docker.CurrentContainerID | first) }}
  13. {{- $config := dict }}
  14. {{- $_ := set $config "nginx_proxy_version" $.Env.NGINX_PROXY_VERSION }}
  15. {{- $_ := set $config "default_cert_ok" (and (exists "/etc/nginx/certs/default.crt") (exists "/etc/nginx/certs/default.key")) }}
  16. {{- $_ := set $config "external_http_port" (coalesce $globals.Env.HTTP_PORT "80") }}
  17. {{- $_ := set $config "external_https_port" (coalesce $globals.Env.HTTPS_PORT "443") }}
  18. {{- $_ := set $config "sha1_upstream_name" (parseBool (coalesce $globals.Env.SHA1_UPSTREAM_NAME "false")) }}
  19. {{- $_ := set $config "default_root_response" (coalesce $globals.Env.DEFAULT_ROOT "404") }}
  20. {{- $_ := set $config "trust_downstream_proxy" (parseBool (coalesce $globals.Env.TRUST_DOWNSTREAM_PROXY "true")) }}
  21. {{- $_ := set $config "enable_access_log" ($globals.Env.DISABLE_ACCESS_LOGS | default "false" | parseBool | not) }}
  22. {{- $_ := set $config "enable_ipv6" (parseBool (coalesce $globals.Env.ENABLE_IPV6 "false")) }}
  23. {{- $_ := set $config "ssl_policy" (or ($globals.Env.SSL_POLICY) "Mozilla-Intermediate") }}
  24. {{- $_ := set $config "enable_debug_endpoint" ($globals.Env.DEBUG_ENDPOINT | default "false") }}
  25. {{- $_ := set $config "hsts" ($globals.Env.HSTS | default "max-age=31536000") }}
  26. {{- $_ := set $config "acme_http_challenge" ($globals.Env.ACME_HTTP_CHALLENGE_LOCATION | default "true") }}
  27. {{- $_ := set $config "enable_http2" ($globals.Env.ENABLE_HTTP2 | default "true") }}
  28. {{- $_ := set $config "enable_http3" ($globals.Env.ENABLE_HTTP3 | default "false") }}
  29. {{- $_ := set $config "enable_http_on_missing_cert" ($globals.Env.ENABLE_HTTP_ON_MISSING_CERT | default "true") }}
  30. {{- $_ := set $globals "config" $config }}
  31. {{- $_ := set $globals "vhosts" (dict) }}
  32. {{- $_ := set $globals "networks" (dict) }}
  33. # Networks available to the container running docker-gen (which are assumed to
  34. # match the networks available to the container running nginx):
  35. {{- /*
  36. * Note: $globals.CurrentContainer may be nil in some circumstances due to
  37. * <https://github.com/nginx-proxy/docker-gen/issues/458>. For more context
  38. * see <https://github.com/nginx-proxy/nginx-proxy/issues/2189>.
  39. */}}
  40. {{- if $globals.CurrentContainer }}
  41. {{- range sortObjectsByKeysAsc $globals.CurrentContainer.Networks "Name" }}
  42. {{- $_ := set $globals.networks .Name . }}
  43. # {{ .Name }}
  44. {{- else }}
  45. # (none)
  46. {{- end }}
  47. {{- else }}
  48. # /!\ WARNING: Failed to find the Docker container running docker-gen. All
  49. # upstream (backend) application containers will appear to be
  50. # unreachable. Try removing the -only-exposed and -only-published
  51. # arguments to docker-gen if you pass either of those. See
  52. # <https://github.com/nginx-proxy/docker-gen/issues/458>.
  53. {{- end }}
  54. {{- /*
  55. * Template used as a function to get a container's IP address. This
  56. * template only outputs debug comments; the IP address is "returned" by
  57. * storing the value in the provided dot dict.
  58. *
  59. * The provided dot dict is expected to have the following entries:
  60. * - "globals": Global values.
  61. * - "container": The container's RuntimeContainer struct.
  62. *
  63. * The return value will be added to the dot dict with key "ip".
  64. */}}
  65. {{- define "container_ip" }}
  66. {{- $ip := "" }}
  67. # networks:
  68. {{- range sortObjectsByKeysAsc $.container.Networks "Name" }}
  69. {{- /*
  70. * TODO: Only ignore the "ingress" network for Swarm tasks (in case
  71. * the user is not using Swarm mode and names a network "ingress").
  72. */}}
  73. {{- if eq .Name "ingress" }}
  74. # {{ .Name }} (ignored)
  75. {{- continue }}
  76. {{- end }}
  77. {{- if eq .Name "host" }}
  78. {{- /* Handle containers in host nework mode */}}
  79. {{- if (index $.globals.networks "host") }}
  80. # both container and proxy are in host network mode, using localhost IP
  81. {{- $ip = "127.0.0.1" }}
  82. {{- continue }}
  83. {{- end }}
  84. {{- range sortObjectsByKeysAsc $.globals.CurrentContainer.Networks "Name" }}
  85. {{- if and . .Gateway (not .Internal) }}
  86. # container is in host network mode, using {{ .Name }} gateway IP
  87. {{- $ip = .Gateway }}
  88. {{- break }}
  89. {{- end }}
  90. {{- end }}
  91. {{- if $ip }}
  92. {{- continue }}
  93. {{- end }}
  94. {{- end }}
  95. {{- if and (not (index $.globals.networks .Name)) (not $.globals.networks.host) }}
  96. # {{ .Name }} (unreachable)
  97. {{- continue }}
  98. {{- end }}
  99. {{- /*
  100. * Do not emit multiple `server` directives for this container if it
  101. * is reachable over multiple networks. This avoids accidentally
  102. * inflating the effective round-robin weight of a server due to the
  103. * redundant upstream addresses that nginx sees as belonging to
  104. * distinct servers.
  105. */}}
  106. {{- if $ip }}
  107. # {{ .Name }} (ignored; reachable but redundant)
  108. {{- continue }}
  109. {{- end }}
  110. # {{ .Name }} (reachable)
  111. {{- if and . .IP }}
  112. {{- $ip = .IP }}
  113. {{- else }}
  114. # /!\ No IP for this network!
  115. {{- end }}
  116. {{- else }}
  117. # (none)
  118. {{- end }}
  119. # IP address: {{ if $ip }}{{ $ip }}{{ else }}(none usable){{ end }}
  120. {{- $_ := set $ "ip" $ip }}
  121. {{- end }}
  122. {{- /*
  123. * Template used as a function to get the port of the server in the given
  124. * container. This template only outputs debug comments; the port is
  125. * "returned" by storing the value in the provided dot dict.
  126. *
  127. * The provided dot dict is expected to have the following entries:
  128. * - "container": The container's RuntimeContainer struct.
  129. *
  130. * The return value will be added to the dot dict with key "port".
  131. */}}
  132. {{- define "container_port" }}
  133. {{- /* If only 1 port exposed, use that as a default, else 80. */}}
  134. # exposed ports (first ten):{{ range $index, $address := (sortObjectsByKeysAsc $.container.Addresses "Port") }}{{ if lt $index 10 }} {{ $address.Port }}/{{ $address.Proto }}{{ end }}{{ else }} (none){{ end }}
  135. {{- $default_port := when (eq (len $.container.Addresses) 1) (first $.container.Addresses).Port "80" }}
  136. # default port: {{ $default_port }}
  137. {{- $port := when (eq $.port "default") $default_port (when (eq $.port "legacy") (or $.container.Env.VIRTUAL_PORT $default_port) $.port) }}
  138. # using port: {{ $port }}
  139. {{- $addr_obj := where $.container.Addresses "Port" $port | first }}
  140. {{- if and $addr_obj $addr_obj.HostPort }}
  141. # /!\ WARNING: Virtual port published on host. Clients
  142. # might be able to bypass nginx-proxy and
  143. # access the container's server directly.
  144. {{- end }}
  145. {{- $_ := set $ "port" $port }}
  146. {{- end }}
  147. {{- define "ssl_policy" }}
  148. {{- if eq .ssl_policy "Mozilla-Modern" }}
  149. ssl_protocols TLSv1.3;
  150. {{- /*
  151. * This ssl_ciphers directive is not used but necessary to get TLSv1.3 only.
  152. * see https://serverfault.com/questions/1023766/nginx-with-only-tls1-3-cipher-suites
  153. */}}
  154. ssl_ciphers ECDHE-ECDSA-AES256-GCM-SHA384;
  155. ssl_conf_command Ciphersuites TLS_AES_128_GCM_SHA256:TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256;
  156. ssl_prefer_server_ciphers off;
  157. {{- else if eq .ssl_policy "Mozilla-Intermediate" }}
  158. ssl_protocols TLSv1.2 TLSv1.3;
  159. ssl_ciphers '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:DHE-RSA-CHACHA20-POLY1305';
  160. ssl_prefer_server_ciphers off;
  161. {{- else if eq .ssl_policy "Mozilla-Old" }}
  162. ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
  163. ssl_ciphers '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:DHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES256-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA:@SECLEVEL=0';
  164. ssl_prefer_server_ciphers on;
  165. {{- else if eq .ssl_policy "AWS-TLS13-1-3-2021-06" }}
  166. ssl_protocols TLSv1.3;
  167. {{- /*
  168. * This ssl_ciphers directive is not used but necessary to get TLSv1.3 only.
  169. * see https://serverfault.com/questions/1023766/nginx-with-only-tls1-3-cipher-suites
  170. */}}
  171. ssl_ciphers ECDHE-ECDSA-AES256-GCM-SHA384;
  172. ssl_conf_command Ciphersuites TLS_AES_128_GCM_SHA256:TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256;
  173. ssl_prefer_server_ciphers on;
  174. {{- else if eq .ssl_policy "AWS-TLS13-1-2-2021-06" }}
  175. ssl_protocols TLSv1.2 TLSv1.3;
  176. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384';
  177. ssl_prefer_server_ciphers on;
  178. {{- else if eq .ssl_policy "AWS-TLS13-1-2-Res-2021-06" }}
  179. ssl_protocols TLSv1.2 TLSv1.3;
  180. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384';
  181. ssl_prefer_server_ciphers on;
  182. {{- else if eq .ssl_policy "AWS-TLS13-1-2-Ext1-2021-06" }}
  183. ssl_protocols TLSv1.2 TLSv1.3;
  184. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:AES128-GCM-SHA256:AES128-SHA256:AES256-GCM-SHA384:AES256-SHA256';
  185. ssl_prefer_server_ciphers on;
  186. {{- else if eq .ssl_policy "AWS-TLS13-1-2-Ext2-2021-06" }}
  187. ssl_protocols TLSv1.2 TLSv1.3;
  188. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-GCM-SHA256:AES128-SHA256:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA';
  189. ssl_prefer_server_ciphers on;
  190. {{- else if eq .ssl_policy "AWS-TLS13-1-1-2021-06" }}
  191. ssl_protocols TLSv1.1 TLSv1.2 TLSv1.3;
  192. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-GCM-SHA256:AES128-SHA256:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA:@SECLEVEL=0';
  193. ssl_prefer_server_ciphers on;
  194. {{- else if eq .ssl_policy "AWS-TLS13-1-0-2021-06" }}
  195. ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
  196. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-GCM-SHA256:AES128-SHA256:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA:@SECLEVEL=0';
  197. ssl_prefer_server_ciphers on;
  198. {{- else if eq .ssl_policy "AWS-FS-1-2-Res-2020-10" }}
  199. ssl_protocols TLSv1.2;
  200. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384';
  201. ssl_prefer_server_ciphers on;
  202. {{- else if eq .ssl_policy "AWS-FS-1-2-Res-2019-08" }}
  203. ssl_protocols TLSv1.2;
  204. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384';
  205. ssl_prefer_server_ciphers on;
  206. {{- else if eq .ssl_policy "AWS-FS-1-2-2019-08" }}
  207. ssl_protocols TLSv1.2;
  208. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA';
  209. ssl_prefer_server_ciphers on;
  210. {{- else if eq .ssl_policy "AWS-FS-1-1-2019-08" }}
  211. ssl_protocols TLSv1.1 TLSv1.2;
  212. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:@SECLEVEL=0';
  213. ssl_prefer_server_ciphers on;
  214. {{- else if eq .ssl_policy "AWS-FS-2018-06" }}
  215. ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
  216. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:@SECLEVEL=0';
  217. ssl_prefer_server_ciphers on;
  218. {{- else if eq .ssl_policy "AWS-TLS-1-2-Ext-2018-06" }}
  219. ssl_protocols TLSv1.2;
  220. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-GCM-SHA256:AES128-SHA256:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA';
  221. ssl_prefer_server_ciphers on;
  222. {{- else if eq .ssl_policy "AWS-TLS-1-2-2017-01" }}
  223. ssl_protocols TLSv1.2;
  224. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:AES128-GCM-SHA256:AES128-SHA256:AES256-GCM-SHA384:AES256-SHA256';
  225. ssl_prefer_server_ciphers on;
  226. {{- else if eq .ssl_policy "AWS-TLS-1-1-2017-01" }}
  227. ssl_protocols TLSv1.1 TLSv1.2;
  228. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-GCM-SHA256:AES128-SHA256:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA:@SECLEVEL=0';
  229. ssl_prefer_server_ciphers on;
  230. {{- else if eq .ssl_policy "AWS-2016-08" }}
  231. ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
  232. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-GCM-SHA256:AES128-SHA256:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA:@SECLEVEL=0';
  233. ssl_prefer_server_ciphers on;
  234. {{- else if eq .ssl_policy "AWS-2015-05" }}
  235. ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
  236. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-GCM-SHA256:AES128-SHA256:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA:DES-CBC3-SHA:@SECLEVEL=0';
  237. ssl_prefer_server_ciphers on;
  238. {{- else if eq .ssl_policy "AWS-2015-03" }}
  239. ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
  240. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-GCM-SHA256:AES128-SHA256:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA:DHE-DSS-AES128-SHA:DES-CBC3-SHA:@SECLEVEL=0';
  241. ssl_prefer_server_ciphers on;
  242. {{- else if eq .ssl_policy "AWS-2015-02" }}
  243. ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
  244. ssl_ciphers 'ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-GCM-SHA256:AES128-SHA256:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA:DHE-DSS-AES128-SHA:@SECLEVEL=0';
  245. ssl_prefer_server_ciphers on;
  246. {{- end }}
  247. {{- end }}
  248. {{- define "location" }}
  249. {{- $vpath := .VPath }}
  250. {{- $override := printf "/etc/nginx/vhost.d/%s_%s_location_override" .Host (sha1 .Path) }}
  251. {{- if and (eq .Path "/") (not (exists $override)) }}
  252. {{- $override = printf "/etc/nginx/vhost.d/%s_location_override" .Host }}
  253. {{- end }}
  254. {{- if exists $override }}
  255. include {{ $override }};
  256. {{- else }}
  257. {{- $keepalive := $vpath.keepalive }}
  258. location {{ .Path }} {
  259. {{- if eq $vpath.network_tag "internal" }}
  260. # Only allow traffic from internal clients
  261. include /etc/nginx/network_internal.conf;
  262. {{- end }}
  263. {{ $proto := $vpath.proto }}
  264. {{ $upstream := $vpath.upstream }}
  265. {{ $dest := $vpath.dest }}
  266. {{- if eq $proto "uwsgi" }}
  267. include uwsgi_params;
  268. uwsgi_pass {{ trim $proto }}://{{ trim $upstream }};
  269. {{- else if eq $proto "fastcgi" }}
  270. {{- if (exists "/etc/nginx/fastcgi.conf") }}
  271. include fastcgi.conf;
  272. {{- else if (exists "/etc/nginx/fastcgi_params") }}
  273. include fastcgi_params;
  274. {{- else }}
  275. # neither /etc/nginx/fastcgi.conf nor /etc/nginx/fastcgi_params found, fastcgi won't work
  276. {{- end }}
  277. root {{ trim .VhostRoot }};
  278. fastcgi_pass {{ trim $upstream }};
  279. {{- if ne $keepalive "disabled" }}
  280. fastcgi_keep_conn on;
  281. {{- end }}
  282. {{- else if eq $proto "grpc" }}
  283. grpc_pass {{ trim $proto }}://{{ trim $upstream }};
  284. {{- else if eq $proto "grpcs" }}
  285. grpc_pass {{ trim $proto }}://{{ trim $upstream }};
  286. {{- else }}
  287. proxy_pass {{ trim $proto }}://{{ trim $upstream }}{{ trim $dest }};
  288. set $upstream_keepalive {{ if ne $keepalive "disabled" }}true{{ else }}false{{ end }};
  289. {{- end }}
  290. {{- if (exists (printf "/etc/nginx/htpasswd/%s_%s" .Host (sha1 .Path) )) }}
  291. auth_basic "Restricted {{ .Host }}{{ .Path }}";
  292. auth_basic_user_file {{ (printf "/etc/nginx/htpasswd/%s_%s" .Host (sha1 .Path)) }};
  293. {{- else if (exists (printf "/etc/nginx/htpasswd/%s" .Host)) }}
  294. auth_basic "Restricted {{ .HostIsRegexp | ternary "access" .Host }}";
  295. auth_basic_user_file {{ (printf "/etc/nginx/htpasswd/%s" .Host) }};
  296. {{- end }}
  297. {{- if (exists (printf "/etc/nginx/vhost.d/%s_%s_location" .Host (sha1 .Path) )) }}
  298. include {{ printf "/etc/nginx/vhost.d/%s_%s_location" .Host (sha1 .Path) }};
  299. {{- else if (exists (printf "/etc/nginx/vhost.d/%s_location" .Host)) }}
  300. include {{ printf "/etc/nginx/vhost.d/%s_location" .Host}};
  301. {{- else if (exists "/etc/nginx/vhost.d/default_location") }}
  302. include /etc/nginx/vhost.d/default_location;
  303. {{- end }}
  304. }
  305. {{- end }}
  306. {{- end }}
  307. {{- define "upstream" }}
  308. {{- $path := .Path }}
  309. {{- $vpath := .VPath }}
  310. upstream {{ $vpath.upstream }} {
  311. {{- $servers := 0 }}
  312. {{- $loadbalance := $vpath.loadbalance }}
  313. {{- if $loadbalance }}
  314. # From the container's loadbalance label:
  315. {{ $loadbalance }}
  316. {{- end }}
  317. {{- range $port, $containers := $vpath.ports }}
  318. {{- range $container := $containers }}
  319. # Container: {{ $container.Name }}
  320. {{- $args := dict "globals" $.globals "container" $container }}
  321. {{- template "container_ip" $args }}
  322. {{- $ip := $args.ip }}
  323. {{- $args = dict "container" $container "path" $path "port" $port }}
  324. {{- template "container_port" $args }}
  325. {{- if $ip }}
  326. {{- $servers = add1 $servers }}
  327. server {{ $ip }}:{{ $args.port }};
  328. {{- end }}
  329. {{- end }}
  330. {{- end }}
  331. {{- /* nginx-proxy/nginx-proxy#1105 */}}
  332. {{- if lt $servers 1 }}
  333. # Fallback entry
  334. server 127.0.0.1 down;
  335. {{- end }}
  336. {{- $keepalive := $vpath.keepalive }}
  337. {{- if and (ne $keepalive "disabled") (gt $servers 0) }}
  338. {{- if eq $keepalive "auto" }}
  339. keepalive {{ mul $servers 2 }};
  340. {{- else }}
  341. keepalive {{ $keepalive }};
  342. {{- end }}
  343. {{- end }}
  344. }
  345. {{- end }}
  346. {{- /* debug "endpoint" location template */}}
  347. {{- define "debug_location" }}
  348. {{- $debug_paths := dict }}
  349. {{- range $path, $vpath := .VHost.paths }}
  350. {{- $tmp_port := dict }}
  351. {{- range $port, $containers := $vpath.ports }}
  352. {{- $tmp_containers := list }}
  353. {{- range $container := $containers }}
  354. {{- $tmp_containers = dict "Name" $container.Name | append $tmp_containers }}
  355. {{- end }}
  356. {{- $_ := dict $port $tmp_containers | set $tmp_port "ports" }}
  357. {{- $tmp_port = deepCopy $vpath | merge $tmp_port }}
  358. {{- end }}
  359. {{- $_ := set $debug_paths $path $tmp_port }}
  360. {{- end }}
  361. {{- $debug_vhost := deepCopy .VHost }}
  362. {{- $_ := set $debug_vhost "paths" $debug_paths }}
  363. {{- $debug_response := dict
  364. "global" .GlobalConfig
  365. "hostname" .Hostname
  366. "request" (dict
  367. "host" "$host"
  368. "https" "$https"
  369. "http2" "$http2"
  370. "http3" "$http3"
  371. "ssl_cipher" "$ssl_cipher"
  372. "ssl_protocol" "$ssl_protocol"
  373. )
  374. "vhost" $debug_vhost
  375. }}
  376. {{- /*
  377. * The maximum line length in an nginx config is 4096 characters.
  378. * If we're nearing this limit (with headroom for the rest
  379. * of the directive), strip vhost.paths from the response.
  380. */}}
  381. {{- if gt (toJson $debug_response | len) 4000 }}
  382. {{- $_ := unset $debug_vhost "paths" }}
  383. {{- $_ := set $debug_response "warning" "Virtual paths configuration for this hostname is too large and has been stripped from response." }}
  384. {{- end }}
  385. location /nginx-proxy-debug {
  386. default_type application/json;
  387. return 200 '{{ toJson $debug_response }}';
  388. }
  389. {{- end }}
  390. {{- define "access_log" }}
  391. {{- when .Enable "access_log /var/log/nginx/access.log vhost;" "" }}
  392. {{- end }}
  393. # If we receive X-Forwarded-Proto, pass it through; otherwise, pass along the
  394. # scheme used to connect to this server
  395. map $http_x_forwarded_proto $proxy_x_forwarded_proto {
  396. default {{ if $globals.config.trust_downstream_proxy }}$http_x_forwarded_proto{{ else }}$scheme{{ end }};
  397. '' $scheme;
  398. }
  399. map $http_x_forwarded_host $proxy_x_forwarded_host {
  400. default {{ if $globals.config.trust_downstream_proxy }}$http_x_forwarded_host{{ else }}$host{{ end }};
  401. '' $host;
  402. }
  403. # If we receive X-Forwarded-Port, pass it through; otherwise, pass along the
  404. # server port the client connected to
  405. map $http_x_forwarded_port $proxy_x_forwarded_port {
  406. default {{ if $globals.config.trust_downstream_proxy }}$http_x_forwarded_port{{ else }}$server_port{{ end }};
  407. '' $server_port;
  408. }
  409. # Include the port in the Host header sent to the container if it is non-standard
  410. map $server_port $host_port {
  411. default :$server_port;
  412. 80 '';
  413. 443 '';
  414. }
  415. # If the request from the downstream client has an "Upgrade:" header (set to any
  416. # non-empty value), pass "Connection: upgrade" to the upstream (backend) server.
  417. # Otherwise, the value for the "Connection" header depends on whether the user
  418. # has enabled keepalive to the upstream server.
  419. map $http_upgrade $proxy_connection {
  420. default upgrade;
  421. '' $proxy_connection_noupgrade;
  422. }
  423. map $upstream_keepalive $proxy_connection_noupgrade {
  424. # Preserve nginx's default behavior (send "Connection: close").
  425. default close;
  426. # Use an empty string to cancel nginx's default behavior.
  427. true '';
  428. }
  429. # Abuse the map directive (see <https://stackoverflow.com/q/14433309>) to ensure
  430. # that $upstream_keepalive is always defined. This is necessary because:
  431. # - The $proxy_connection variable is indirectly derived from
  432. # $upstream_keepalive, so $upstream_keepalive must be defined whenever
  433. # $proxy_connection is resolved.
  434. # - The $proxy_connection variable is used in a proxy_set_header directive in
  435. # the http block, so it is always fully resolved for every request -- even
  436. # those where proxy_pass is not used (e.g., unknown virtual host).
  437. map "" $upstream_keepalive {
  438. # The value here should not matter because it should always be overridden in
  439. # a location block (see the "location" template) for all requests where the
  440. # value actually matters.
  441. default false;
  442. }
  443. # Apply fix for very long server names
  444. server_names_hash_bucket_size 128;
  445. # Default dhparam
  446. {{- if (exists "/etc/nginx/dhparam/dhparam.pem") }}
  447. ssl_dhparam /etc/nginx/dhparam/dhparam.pem;
  448. {{- end }}
  449. # Set appropriate X-Forwarded-Ssl header based on $proxy_x_forwarded_proto
  450. map $proxy_x_forwarded_proto $proxy_x_forwarded_ssl {
  451. default off;
  452. https on;
  453. }
  454. gzip_types text/plain text/css application/javascript application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript;
  455. {{- /* See https://nginx.org/en/docs/http/ngx_http_log_module.html#log_format for details and variables
  456. * LOG_FORMAT_ESCAPE sets the escape part of the log format
  457. * LOG_FORMAT sets the log format
  458. */}}
  459. {{- $logEscape := printf "escape=%s" (or $globals.Env.LOG_FORMAT_ESCAPE "default") }}
  460. {{- $logFormat := or $globals.Env.LOG_FORMAT `$host $remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" "$upstream_addr"` }}
  461. {{- if parseBool (or $globals.Env.LOG_JSON "false") }}
  462. {{- /* LOG_JSON is a shorthand
  463. * that sets logging defaults to JSON format
  464. */}}
  465. # JSON Logging enabled (via LOG_JSON env variable)
  466. {{- $logEscape = printf "escape=%s" (or $globals.Env.LOG_FORMAT_ESCAPE "json") }}
  467. {{- $logFormat = or $globals.Env.LOG_FORMAT `{"time_local":"$time_iso8601","client_ip":"$http_x_forwarded_for","remote_addr":"$remote_addr","request":"$request","status":"$status","body_bytes_sent":"$body_bytes_sent","request_time":"$request_time","upstream_response_time":"$upstream_response_time","upstream_addr":"$upstream_addr","http_referrer":"$http_referer","http_user_agent":"$http_user_agent","request_id":"$request_id"}` }}
  468. {{- end }}
  469. log_format vhost {{ $logEscape }} '{{ or $globals.Env.LOG_FORMAT $logFormat }}';
  470. access_log off;
  471. {{- /* Lower the SSL policy of the http context
  472. * if at least one vhost use a TLSv1 or TLSv1.1 policy
  473. * so TLSv1 and TLSv1.1 can be enabled on those vhosts
  474. */}}
  475. {{- $httpContextSslPolicy := $globals.config.ssl_policy }}
  476. {{- $inUseSslPolicies := groupByKeys $globals.containers "Env.SSL_POLICY" }}
  477. {{- range $tls1Policy := list "AWS-TLS13-1-1-2021-06" "AWS-TLS13-1-0-2021-06" "AWS-FS-1-1-2019-08" "AWS-FS-2018-06" "AWS-TLS-1-1-2017-01" "AWS-2016-08" "AWS-2015-05" "AWS-2015-03" "AWS-2015-02" "Mozilla-Old" }}
  478. {{- if has $tls1Policy $inUseSslPolicies }}
  479. # Using Mozilla-Old SSL policy on the http context to allow TLSv1 and TLSv1.1
  480. {{- $httpContextSslPolicy = "Mozilla-Old" }}
  481. {{- break }}
  482. {{- end }}
  483. {{- end }}
  484. {{- template "ssl_policy" (dict "ssl_policy" $httpContextSslPolicy) }}
  485. error_log /dev/stderr;
  486. {{- if $globals.Env.RESOLVERS }}
  487. resolver {{ $globals.Env.RESOLVERS }};
  488. {{- end }}
  489. {{- if (exists "/etc/nginx/proxy.conf") }}
  490. include /etc/nginx/proxy.conf;
  491. {{- else }}
  492. # HTTP 1.1 support
  493. proxy_http_version 1.1;
  494. proxy_set_header Host $host$host_port;
  495. proxy_set_header Upgrade $http_upgrade;
  496. proxy_set_header Connection $proxy_connection;
  497. proxy_set_header X-Real-IP $remote_addr;
  498. proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  499. proxy_set_header X-Forwarded-Host $proxy_x_forwarded_host;
  500. proxy_set_header X-Forwarded-Proto $proxy_x_forwarded_proto;
  501. proxy_set_header X-Forwarded-Ssl $proxy_x_forwarded_ssl;
  502. proxy_set_header X-Forwarded-Port $proxy_x_forwarded_port;
  503. proxy_set_header X-Original-URI $request_uri;
  504. # Mitigate httpoxy attack (see README for details)
  505. proxy_set_header Proxy "";
  506. {{- end }}
  507. {{- /* Precompute and store some information about vhost that use VIRTUAL_HOST_MULTIPORTS. */}}
  508. {{- range $vhosts_yaml, $containers := groupBy $globals.containers "Env.VIRTUAL_HOST_MULTIPORTS" }}
  509. {{- /* Print a warning in the config if VIRTUAL_HOST_MULTIPORTS can't be parsed. */}}
  510. {{- $parsedVhosts := fromYaml $vhosts_yaml }}
  511. {{- if (empty $parsedVhosts) }}
  512. {{- $containerNames := list }}
  513. {{- range $container := $containers }}
  514. {{- $containerNames = append $containerNames $container.Name }}
  515. {{- end }}
  516. # /!\ WARNING: the VIRTUAL_HOST_MULTIPORTS environment variable used for {{ len $containerNames | plural "this container" "those containers" }} is not a valid YAML string:
  517. # {{ $containerNames | join ", " }}
  518. {{- continue }}
  519. {{- end }}
  520. {{- range $hostname, $vhost := $parsedVhosts }}
  521. {{- $vhost_data := when (hasKey $globals.vhosts $hostname) (get $globals.vhosts $hostname) (dict) }}
  522. {{- $paths := coalesce $vhost_data.paths (dict) }}
  523. {{- if (empty $vhost) }}
  524. {{ $vhost = dict "/" (dict) }}
  525. {{- end }}
  526. {{- range $path, $vpath := $vhost }}
  527. {{- if (empty $vpath) }}
  528. {{- $vpath = dict "dest" "" "port" "default" }}
  529. {{- end }}
  530. {{- $dest := coalesce $vpath.dest "" }}
  531. {{- $port := when (hasKey $vpath "port") (toString $vpath.port) "default" }}
  532. {{- $path_data := when (hasKey $paths $path) (get $paths $path) (dict) }}
  533. {{- $path_ports := when (hasKey $path_data "ports") (get $path_data "ports") (dict) }}
  534. {{- $path_port_containers := when (hasKey $path_ports $port) (get $path_ports $port) (list) }}
  535. {{- $path_port_containers = concat $path_port_containers $containers }}
  536. {{- $_ := set $path_ports $port $path_port_containers }}
  537. {{- $_ := set $path_data "ports" $path_ports }}
  538. {{- if (not (hasKey $path_data "dest")) }}
  539. {{- $_ := set $path_data "dest" $dest }}
  540. {{- end }}
  541. {{- $_ := set $paths $path $path_data }}
  542. {{- end }}
  543. {{- $_ := set $vhost_data "paths" $paths }}
  544. {{- $is_regexp := hasPrefix "~" $hostname }}
  545. {{- $_ := set $vhost_data "upstream_name" (when (or $is_regexp $globals.config.sha1_upstream_name) (sha1 $hostname) $hostname) }}
  546. {{- $_ := set $globals.vhosts $hostname $vhost_data }}
  547. {{- end }}
  548. {{- end }}
  549. {{- /* Precompute and store some information about vhost that use VIRTUAL_HOST. */}}
  550. {{- range $hostname, $containers := groupByMulti $globals.containers "Env.VIRTUAL_HOST" "," }}
  551. {{- /* Ignore containers with VIRTUAL_HOST set to the empty string. */}}
  552. {{- $hostname = trim $hostname }}
  553. {{- if not $hostname }}
  554. {{- continue }}
  555. {{- end }}
  556. {{- /* Drop containers with both VIRTUAL_HOST and VIRTUAL_HOST_MULTIPORTS set
  557. * (VIRTUAL_HOST_MULTIPORTS takes precedence thanks to the previous loop).
  558. */}}
  559. {{- range $_, $containers_to_drop := groupBy $containers "Env.VIRTUAL_HOST_MULTIPORTS" }}
  560. {{- range $container := $containers_to_drop }}
  561. {{- $containers = without $containers $container }}
  562. {{- end }}
  563. {{- end }}
  564. {{- if (eq (len $containers) 0) }}
  565. {{- continue }}
  566. {{- end }}
  567. {{- $vhost_data := when (hasKey $globals.vhosts $hostname) (get $globals.vhosts $hostname) (dict) }}
  568. {{- $paths := coalesce $vhost_data.paths (dict) }}
  569. {{- $tmp_paths := groupByWithDefault $containers "Env.VIRTUAL_PATH" "/" }}
  570. {{- range $path, $containers := $tmp_paths }}
  571. {{- $dest := or (first (groupByKeys $containers "Env.VIRTUAL_DEST")) "" }}
  572. {{- $port := "legacy" }}
  573. {{- $path_data := when (hasKey $paths $path) (get $paths $path) (dict) }}
  574. {{- $path_ports := when (hasKey $path_data "ports") (get $path_data "ports") (dict) }}
  575. {{- $path_port_containers := when (hasKey $path_ports $port) (get $path_ports $port) (list) }}
  576. {{- $path_port_containers = concat $path_port_containers $containers }}
  577. {{- $_ := set $path_ports $port $path_port_containers }}
  578. {{- $_ := set $path_data "ports" $path_ports }}
  579. {{- if (not (hasKey $path_data "dest")) }}
  580. {{- $_ := set $path_data "dest" $dest }}
  581. {{- end }}
  582. {{- $_ := set $paths $path $path_data }}
  583. {{- end }}
  584. {{- $_ := set $vhost_data "paths" $paths }}
  585. {{- $is_regexp := hasPrefix "~" $hostname }}
  586. {{- $_ := set $vhost_data "upstream_name" (when (or $is_regexp $globals.config.sha1_upstream_name) (sha1 $hostname) $hostname) }}
  587. {{- $_ := set $globals.vhosts $hostname $vhost_data }}
  588. {{- end }}
  589. {{- /* Loop over $globals.vhosts and update it with the remaining informations about each vhost. */}}
  590. {{- range $hostname, $vhost_data := $globals.vhosts }}
  591. {{- $is_regexp := hasPrefix "~" $hostname }}
  592. {{- $vhost_containers := list }}
  593. {{- range $path, $vpath_data := $vhost_data.paths }}
  594. {{- $vpath_containers := list }}
  595. {{- range $port, $vport_containers := $vpath_data.ports }}
  596. {{ $vpath_containers = concat $vpath_containers $vport_containers }}
  597. {{- end }}
  598. {{- /* Get the VIRTUAL_PROTO defined by containers w/ the same vhost-vpath, falling back to "http". */}}
  599. {{- $proto := trim (or (first (groupByKeys $vpath_containers "Env.VIRTUAL_PROTO")) "http") }}
  600. {{- /* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external". */}}
  601. {{- $network_tag := or (first (groupByKeys $vpath_containers "Env.NETWORK_ACCESS")) "external" }}
  602. {{- $loadbalance := first (keys (groupByLabel $vpath_containers "com.github.nginx-proxy.nginx-proxy.loadbalance")) }}
  603. {{- $keepalive := coalesce (first (keys (groupByLabel $vpath_containers "com.github.nginx-proxy.nginx-proxy.keepalive"))) "disabled" }}
  604. {{- $upstream := $vhost_data.upstream_name }}
  605. {{- if (not (eq $path "/")) }}
  606. {{- $sum := sha1 $path }}
  607. {{- $upstream = printf "%s-%s" $upstream $sum }}
  608. {{- end }}
  609. {{- $_ := set $vpath_data "proto" $proto }}
  610. {{- $_ := set $vpath_data "network_tag" $network_tag }}
  611. {{- $_ := set $vpath_data "upstream" $upstream }}
  612. {{- $_ := set $vpath_data "loadbalance" $loadbalance }}
  613. {{- $_ := set $vpath_data "keepalive" $keepalive }}
  614. {{- $_ := set $vhost_data.paths $path $vpath_data }}
  615. {{ $vhost_containers = concat $vhost_containers $vpath_containers }}
  616. {{- end }}
  617. {{- $certName := first (groupByKeys $vhost_containers "Env.CERT_NAME") }}
  618. {{- $vhostCert := closest (dir "/etc/nginx/certs") (printf "%s.crt" $hostname) }}
  619. {{- $vhostCert = trimSuffix ".crt" $vhostCert }}
  620. {{- $vhostCert = trimSuffix ".key" $vhostCert }}
  621. {{- $cert := or $certName $vhostCert }}
  622. {{- $cert_ok := and (ne $cert "") (exists (printf "/etc/nginx/certs/%s.crt" $cert)) (exists (printf "/etc/nginx/certs/%s.key" $cert)) }}
  623. {{- $enable_debug_endpoint := coalesce (groupByLabel $vhost_containers "com.github.nginx-proxy.nginx-proxy.debug-endpoint" | keys | first) $globals.config.enable_debug_endpoint | parseBool }}
  624. {{- $default := eq $globals.Env.DEFAULT_HOST $hostname }}
  625. {{- $https_method := or (first (groupByKeys $vhost_containers "Env.HTTPS_METHOD")) $globals.Env.HTTPS_METHOD "redirect" }}
  626. {{- $enable_http_on_missing_cert := groupByKeys $vhost_containers "Env.ENABLE_HTTP_ON_MISSING_CERT" | first | default $globals.config.enable_http_on_missing_cert | parseBool }}
  627. {{- /* When the certificate is missing we want to ensure that HTTP is enabled; hence switching from 'nohttp' or 'redirect' to 'noredirect' */}}
  628. {{- if (and $enable_http_on_missing_cert (not $cert_ok) (or (eq $https_method "nohttp") (eq $https_method "redirect"))) }}
  629. {{- $https_method = "noredirect" }}
  630. {{- end }}
  631. {{- $http2_enabled := groupByLabel $vhost_containers "com.github.nginx-proxy.nginx-proxy.http2.enable" | keys | first | default $globals.config.enable_http2 | parseBool }}
  632. {{- $http3_enabled := groupByLabel $vhost_containers "com.github.nginx-proxy.nginx-proxy.http3.enable" | keys | first | default $globals.config.enable_http3 | parseBool }}
  633. {{- $acme_http_challenge := groupByKeys $vhost_containers "Env.ACME_HTTP_CHALLENGE_LOCATION" | first | default $globals.config.acme_http_challenge }}
  634. {{- $acme_http_challenge_legacy := eq $acme_http_challenge "legacy" }}
  635. {{- $acme_http_challenge_enabled := false }}
  636. {{- if (not $acme_http_challenge_legacy) }}
  637. {{- $acme_http_challenge_enabled = parseBool $acme_http_challenge }}
  638. {{- end }}
  639. {{- /* Get the SERVER_TOKENS defined by containers w/ the same vhost, falling back to "". */}}
  640. {{- $server_tokens := trim (or (first (groupByKeys $vhost_containers "Env.SERVER_TOKENS")) "") }}
  641. {{- /* Get the SSL_POLICY defined by containers w/ the same vhost, falling back to empty string (use default). */}}
  642. {{- $ssl_policy := or (first (groupByKeys $vhost_containers "Env.SSL_POLICY")) "" }}
  643. {{- /* Get the HSTS defined by containers w/ the same vhost, falling back to "max-age=31536000". */}}
  644. {{- $hsts := groupByKeys $vhost_containers "Env.HSTS" | first | default $globals.config.hsts }}
  645. {{- /* Get the VIRTUAL_ROOT By containers w/ use fastcgi root */}}
  646. {{- $vhost_root := or (first (groupByKeys $vhost_containers "Env.VIRTUAL_ROOT")) "/var/www/public" }}
  647. {{- $vhost_data = merge $vhost_data (dict
  648. "cert" $cert
  649. "cert_ok" $cert_ok
  650. "enable_debug_endpoint" $enable_debug_endpoint
  651. "default" $default
  652. "hsts" $hsts
  653. "https_method" $https_method
  654. "http2_enabled" $http2_enabled
  655. "http3_enabled" $http3_enabled
  656. "is_regexp" $is_regexp
  657. "acme_http_challenge_legacy" $acme_http_challenge_legacy
  658. "acme_http_challenge_enabled" $acme_http_challenge_enabled
  659. "server_tokens" $server_tokens
  660. "ssl_policy" $ssl_policy
  661. "vhost_root" $vhost_root
  662. ) }}
  663. {{- $_ := set $globals.vhosts $hostname $vhost_data }}
  664. {{- end }}
  665. {{- /*
  666. * If needed, create a catch-all fallback server to send an error code to
  667. * clients that request something from an unknown vhost.
  668. *
  669. * This server must appear first in the generated config because nginx uses
  670. * the first `server` directive to handle requests that don't match any of
  671. * the other `server` directives. An alternative approach would be to add
  672. * the `default_server` option to the `listen` directives inside this
  673. * `server`, but some users inject a custom `server` directive that uses
  674. * `default_server`. Using `default_server` here would cause nginx to fail
  675. * to start for those users. See
  676. * <https://github.com/nginx-proxy/nginx-proxy/issues/2212>.
  677. */}}
  678. {{- block "fallback_server" $globals }}
  679. {{- $globals := . }}
  680. {{- $http_exists := false }}
  681. {{- $https_exists := false }}
  682. {{- $default_http_exists := false }}
  683. {{- $default_https_exists := false }}
  684. {{- $http3_enabled := false }}
  685. {{- range $vhost := $globals.vhosts }}
  686. {{- $http := ne $vhost.https_method "nohttp" }}
  687. {{- $https := ne $vhost.https_method "nohttps" }}
  688. {{- $http_exists = or $http_exists $http }}
  689. {{- $https_exists = or $https_exists $https }}
  690. {{- $default_http_exists = or $default_http_exists (and $http $vhost.default) }}
  691. {{- $default_https_exists = or $default_https_exists (and $https $vhost.default) }}
  692. {{- $http3_enabled = or $http3_enabled $vhost.http3_enabled }}
  693. {{- end }}
  694. {{- $fallback_http := not $default_http_exists }}
  695. {{- $fallback_https := not $default_https_exists }}
  696. {{- /*
  697. * If there are no vhosts at all, create fallbacks for both plain http
  698. * and https so that clients get something more useful than a connection
  699. * refused error.
  700. */}}
  701. {{- if and (not $http_exists) (not $https_exists) }}
  702. {{- $fallback_https = true }}
  703. {{- end }}
  704. {{- if or $fallback_http $fallback_https }}
  705. server {
  706. server_name _; # This is just an invalid value which will never trigger on a real hostname.
  707. server_tokens off;
  708. {{ template "access_log" (dict "Enable" $globals.config.enable_access_log) }}
  709. http2 on;
  710. {{- if $fallback_http }}
  711. listen {{ $globals.config.external_http_port }}; {{- /* Do not add `default_server` (see comment above). */}}
  712. {{- if $globals.config.enable_ipv6 }}
  713. listen [::]:{{ $globals.config.external_http_port }}; {{- /* Do not add `default_server` (see comment above). */}}
  714. {{- end }}
  715. {{- end }}
  716. {{- if $fallback_https }}
  717. listen {{ $globals.config.external_https_port }} ssl; {{- /* Do not add `default_server` (see comment above). */}}
  718. {{- if $globals.config.enable_ipv6 }}
  719. listen [::]:{{ $globals.config.external_https_port }} ssl; {{- /* Do not add `default_server` (see comment above). */}}
  720. {{- end }}
  721. {{- if $http3_enabled }}
  722. http3 on;
  723. listen {{ $globals.config.external_https_port }} quic reuseport; {{- /* Do not add `default_server` (see comment above). */}}
  724. {{- if $globals.config.enable_ipv6 }}
  725. listen [::]:{{ $globals.config.external_https_port }} quic reuseport; {{- /* Do not add `default_server` (see comment above). */}}
  726. {{- end }}
  727. {{- end }}
  728. ssl_session_cache shared:SSL:50m;
  729. ssl_session_tickets off;
  730. {{- end }}
  731. {{- if $globals.config.default_cert_ok }}
  732. ssl_certificate /etc/nginx/certs/default.crt;
  733. ssl_certificate_key /etc/nginx/certs/default.key;
  734. {{- else }}
  735. # No default certificate found, so reject SSL handshake;
  736. ssl_reject_handshake on;
  737. {{- end }}
  738. {{- if (exists "/usr/share/nginx/html/errors/50x.html") }}
  739. error_page 500 502 503 504 /50x.html;
  740. location /50x.html {
  741. root /usr/share/nginx/html/errors;
  742. internal;
  743. }
  744. {{- end }}
  745. location ^~ / {
  746. return 503;
  747. }
  748. }
  749. {{- end }}
  750. {{- end }}
  751. {{- range $hostname, $vhost := $globals.vhosts }}
  752. {{- $default_server := when $vhost.default "default_server" "" }}
  753. {{- range $path, $vpath := $vhost.paths }}
  754. # {{ $hostname }}{{ $path }}
  755. {{ template "upstream" (dict "globals" $globals "Path" $path "VPath" $vpath) }}
  756. {{- end }}
  757. {{- if (eq $vhost.https_method "redirect") }}
  758. server {
  759. server_name {{ $hostname }};
  760. {{- if $vhost.server_tokens }}
  761. server_tokens {{ $vhost.server_tokens }};
  762. {{- end }}
  763. {{ template "access_log" (dict "Enable" $globals.config.enable_access_log) }}
  764. listen {{ $globals.config.external_http_port }} {{ $default_server }};
  765. {{- if $globals.config.enable_ipv6 }}
  766. listen [::]:{{ $globals.config.external_http_port }} {{ $default_server }};
  767. {{- end }}
  768. {{- if (or $vhost.acme_http_challenge_legacy $vhost.acme_http_challenge_enabled) }}
  769. # Do not HTTPS redirect Let's Encrypt ACME challenge
  770. location ^~ /.well-known/acme-challenge/ {
  771. auth_basic off;
  772. auth_request off;
  773. allow all;
  774. root /usr/share/nginx/html;
  775. try_files $uri =404;
  776. break;
  777. }
  778. {{- end }}
  779. {{- if $vhost.enable_debug_endpoint }}
  780. {{ template "debug_location" (dict "GlobalConfig" $globals.config "Hostname" $hostname "VHost" $vhost) }}
  781. {{- end }}
  782. location / {
  783. {{- if eq $globals.config.external_https_port "443" }}
  784. return 301 https://$host$request_uri;
  785. {{- else }}
  786. return 301 https://$host:{{ $globals.config.external_https_port }}$request_uri;
  787. {{- end }}
  788. }
  789. }
  790. {{- end }}
  791. server {
  792. {{- if $vhost.is_regexp }}
  793. {{- if or
  794. (printf "/etc/nginx/vhost.d/%s" $hostname | exists)
  795. (printf "/etc/nginx/vhost.d/%s_location" $hostname | exists)
  796. (printf "/etc/nginx/vhost.d/%s_location_override" $hostname | exists)
  797. (printf "/etc/nginx/htpasswd/%s" $hostname | exists)
  798. }}
  799. # https://github.com/nginx-proxy/nginx-proxy/issues/2529#issuecomment-2437609249
  800. # Support for vhost config file(s) named like a regexp ({{ $hostname }}) has been removed from nginx-proxy.
  801. # Please name your vhost config file(s) with the sha1 of the regexp instead ({{ $hostname }} -> {{ sha1 $hostname }}) :
  802. # - /etc/nginx/vhost.d/{{ sha1 $hostname }}
  803. # - /etc/nginx/vhost.d/{{ sha1 $hostname }}_location
  804. # - /etc/nginx/vhost.d/{{ sha1 $hostname }}_location_override
  805. # - /etc/nginx/htpasswd/{{ sha1 $hostname }}
  806. {{- end }}
  807. {{- end }}
  808. server_name {{ $hostname }};
  809. {{- if $vhost.server_tokens }}
  810. server_tokens {{ $vhost.server_tokens }};
  811. {{- end }}
  812. {{ template "access_log" (dict "Enable" $globals.config.enable_access_log) }}
  813. {{- if $vhost.http2_enabled }}
  814. http2 on;
  815. {{- end }}
  816. {{- if or (eq $vhost.https_method "nohttps") (eq $vhost.https_method "noredirect") }}
  817. listen {{ $globals.config.external_http_port }} {{ $default_server }};
  818. {{- if $globals.config.enable_ipv6 }}
  819. listen [::]:{{ $globals.config.external_http_port }} {{ $default_server }};
  820. {{- end }}
  821. {{- if (and (eq $vhost.https_method "noredirect") $vhost.acme_http_challenge_enabled) }}
  822. location /.well-known/acme-challenge/ {
  823. auth_basic off;
  824. allow all;
  825. root /usr/share/nginx/html;
  826. try_files $uri =404;
  827. break;
  828. }
  829. {{- end }}
  830. {{- end }}
  831. {{- if ne $vhost.https_method "nohttps" }}
  832. listen {{ $globals.config.external_https_port }} ssl {{ $default_server }};
  833. {{- if $globals.config.enable_ipv6 }}
  834. listen [::]:{{ $globals.config.external_https_port }} ssl {{ $default_server }};
  835. {{- end }}
  836. {{- if $vhost.http3_enabled }}
  837. http3 on;
  838. add_header alt-svc 'h3=":{{ $globals.config.external_https_port }}"; ma=86400;';
  839. listen {{ $globals.config.external_https_port }} quic {{ $default_server }};
  840. {{- if $globals.config.enable_ipv6 }}
  841. listen [::]:{{ $globals.config.external_https_port }} quic {{ $default_server }};
  842. {{- end }}
  843. {{- end }}
  844. {{- if $vhost.cert_ok }}
  845. {{- template "ssl_policy" (dict "ssl_policy" $vhost.ssl_policy) }}
  846. ssl_session_timeout 5m;
  847. ssl_session_cache shared:SSL:50m;
  848. ssl_session_tickets off;
  849. ssl_certificate /etc/nginx/certs/{{ (printf "%s.crt" $vhost.cert) }};
  850. ssl_certificate_key /etc/nginx/certs/{{ (printf "%s.key" $vhost.cert) }};
  851. {{- if (exists (printf "/etc/nginx/certs/%s.dhparam.pem" $vhost.cert)) }}
  852. ssl_dhparam {{ printf "/etc/nginx/certs/%s.dhparam.pem" $vhost.cert }};
  853. {{- end }}
  854. {{- if (exists (printf "/etc/nginx/certs/%s.chain.pem" $vhost.cert)) }}
  855. ssl_stapling on;
  856. ssl_stapling_verify on;
  857. ssl_trusted_certificate {{ printf "/etc/nginx/certs/%s.chain.pem" $vhost.cert }};
  858. {{- end }}
  859. {{- if (not (or (eq $vhost.https_method "noredirect") (eq $vhost.hsts "off"))) }}
  860. set $sts_header "";
  861. if ($https) {
  862. set $sts_header "{{ trim $vhost.hsts }}";
  863. }
  864. add_header Strict-Transport-Security $sts_header always;
  865. {{- end }}
  866. {{- else if $globals.config.default_cert_ok }}
  867. # No certificate found for this vhost, so use the default certificate and
  868. # return an error code if the user connects via https.
  869. ssl_certificate /etc/nginx/certs/default.crt;
  870. ssl_certificate_key /etc/nginx/certs/default.key;
  871. if ($https) {
  872. return 500;
  873. }
  874. {{- else }}
  875. # No certificate for this vhost nor default certificate found, so reject SSL handshake.
  876. ssl_reject_handshake on;
  877. {{- end }}
  878. {{- end }}
  879. {{- $vhostFileName := $vhost.is_regexp | ternary (sha1 $hostname) $hostname }}
  880. {{- if (exists (printf "/etc/nginx/vhost.d/%s" $vhostFileName)) }}
  881. include {{ printf "/etc/nginx/vhost.d/%s" $vhostFileName }};
  882. {{- else if (exists "/etc/nginx/vhost.d/default") }}
  883. include /etc/nginx/vhost.d/default;
  884. {{- end }}
  885. {{- if $vhost.enable_debug_endpoint }}
  886. {{ template "debug_location" (dict "GlobalConfig" $globals.config "Hostname" $hostname "VHost" $vhost) }}
  887. {{- end }}
  888. {{- range $path, $vpath := $vhost.paths }}
  889. {{- template "location" (dict
  890. "Path" $path
  891. "Host" $vhostFileName
  892. "HostIsRegexp" $vhost.is_regexp
  893. "VhostRoot" $vhost.vhost_root
  894. "VPath" $vpath
  895. ) }}
  896. {{- end }}
  897. {{- if and (not (contains $vhost.paths "/")) (ne $globals.config.default_root_response "none")}}
  898. location / {
  899. return {{ $globals.config.default_root_response }};
  900. }
  901. {{- end }}
  902. }
  903. {{- end }}