nginx.tmpl 51 KB

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