nginx.tmpl 49 KB

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