nginx.tmpl 45 KB

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