From c117ae8fd8cb9b9e2b082ac70ab9d92c63b7b340 Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Mon, 28 Mar 2022 01:03:04 -0400 Subject: [PATCH 01/11] chore: Use boolean for `$server_found` variable --- nginx.tmpl | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/nginx.tmpl b/nginx.tmpl index e7d77c9..33df00a 100644 --- a/nginx.tmpl +++ b/nginx.tmpl @@ -90,7 +90,7 @@ {{ $networks := .Networks }} {{ $debug_all := .Debug }} upstream {{ .Upstream }} { - {{ $server_found := "false" }} + {{ $server_found := false }} {{ range $container := .Containers }} {{ $debug := (eq (coalesce $container.Env.DEBUG $debug_all "false") "true") }} {{/* If only 1 port exposed, use that as a default, else 80 */}} @@ -112,19 +112,19 @@ upstream {{ .Upstream }} { {{ if $address }} {{/* If we got the containers from swarm and this container's port is published to host, use host IP:PORT */}} {{ if and $container.Node.ID $address.HostPort }} - {{ $server_found = "true" }} + {{ $server_found = true }} # {{ $container.Node.Name }}/{{ $container.Name }} server {{ $container.Node.Address.IP }}:{{ $address.HostPort }}; {{/* If there is no swarm node or the port is not published on host, use container's IP:PORT */}} {{ else if $containerNetwork }} - {{ $server_found = "true" }} + {{ $server_found = true }} # {{ $container.Name }} server {{ $containerNetwork.IP }}:{{ $address.Port }}; {{ end }} {{ else if $containerNetwork }} # {{ $container.Name }} {{ if $containerNetwork.IP }} - {{ $server_found = "true" }} + {{ $server_found = true }} server {{ $containerNetwork.IP }}:{{ $port }}; {{ else }} # /!\ No IP for this network! @@ -137,7 +137,7 @@ upstream {{ .Upstream }} { {{ end }} {{ end }} {{/* nginx-proxy/nginx-proxy#1105 */}} - {{ if (eq $server_found "false") }} + {{ if not $server_found }} # Fallback entry server 127.0.0.1 down; {{ end }} From 05423c681af6e50e958f46e056dc126941ed6784 Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Mon, 28 Mar 2022 01:04:20 -0400 Subject: [PATCH 02/11] fix: Use `parseBool` to parse boolean strings --- nginx.tmpl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nginx.tmpl b/nginx.tmpl index 33df00a..14616d4 100644 --- a/nginx.tmpl +++ b/nginx.tmpl @@ -92,7 +92,7 @@ upstream {{ .Upstream }} { {{ $server_found := false }} {{ range $container := .Containers }} - {{ $debug := (eq (coalesce $container.Env.DEBUG $debug_all "false") "true") }} + {{ $debug := parseBool (coalesce $container.Env.DEBUG $debug_all "false") }} {{/* If only 1 port exposed, use that as a default, else 80 */}} {{ $defaultPort := (when (eq (len $container.Addresses) 1) (first $container.Addresses) (dict "Port" "80")).Port }} {{ $port := (coalesce $container.Env.VIRTUAL_PORT $defaultPort) }} @@ -229,7 +229,7 @@ proxy_set_header Proxy ""; {{ $access_log := (or (and (not $.Env.DISABLE_ACCESS_LOGS) "access_log /var/log/nginx/access.log vhost;") "") }} -{{ $enable_ipv6 := eq (or ($.Env.ENABLE_IPV6) "") "true" }} +{{ $enable_ipv6 := parseBool (coalesce $.Env.ENABLE_IPV6 "false") }} server { server_name _; # This is just an invalid value which will never trigger on a real hostname. server_tokens off; From 14d0f3f222b0d6e627c23bebc80878d79b475d58 Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Mon, 28 Mar 2022 02:13:16 -0400 Subject: [PATCH 03/11] chore: Rename `$container` to `$containers` The value is actually a slice/array of containers so it should be pluralized. --- nginx.tmpl | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/nginx.tmpl b/nginx.tmpl index 14616d4..10dd720 100644 --- a/nginx.tmpl +++ b/nginx.tmpl @@ -397,15 +397,15 @@ server { {{ $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} {{ template "location" (dict "Path" "/" "Proto" $proto "Upstream" $upstream_name "Host" $host "VhostRoot" $vhost_root "Dest" "" "NetworkTag" $network_tag) }} {{ else }} - {{ range $path, $container := $paths }} + {{ range $path, $containers := $paths }} {{/* Get the VIRTUAL_PROTO defined by containers w/ the same vhost-vpath, falling back to "http" */}} - {{ $proto := trim (or (first (groupByKeys $container "Env.VIRTUAL_PROTO")) "http") }} + {{ $proto := trim (or (first (groupByKeys $containers "Env.VIRTUAL_PROTO")) "http") }} {{/* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external" */}} - {{ $network_tag := or (first (groupByKeys $container "Env.NETWORK_ACCESS")) "external" }} + {{ $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} {{ $sum := sha1 $path }} {{ $upstream := printf "%s-%s" $upstream_name $sum }} - {{ $dest := (or (first (groupByKeys $container "Env.VIRTUAL_DEST")) "") }} + {{ $dest := (or (first (groupByKeys $containers "Env.VIRTUAL_DEST")) "") }} {{ template "location" (dict "Path" $path "Proto" $proto "Upstream" $upstream "Host" $host "VhostRoot" $vhost_root "Dest" $dest "NetworkTag" $network_tag) }} {{ end }} {{ if (not (contains $paths "/")) }} @@ -445,15 +445,15 @@ server { {{ $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} {{ template "location" (dict "Path" "/" "Proto" $proto "Upstream" $upstream_name "Host" $host "VhostRoot" $vhost_root "Dest" "" "NetworkTag" $network_tag) }} {{ else }} - {{ range $path, $container := $paths }} + {{ range $path, $containers := $paths }} {{/* Get the VIRTUAL_PROTO defined by containers w/ the same vhost-vpath, falling back to "http" */}} - {{ $proto := trim (or (first (groupByKeys $container "Env.VIRTUAL_PROTO")) "http") }} + {{ $proto := trim (or (first (groupByKeys $containers "Env.VIRTUAL_PROTO")) "http") }} {{/* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external" */}} - {{ $network_tag := or (first (groupByKeys $container "Env.NETWORK_ACCESS")) "external" }} + {{ $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} {{ $sum := sha1 $path }} {{ $upstream := printf "%s-%s" $upstream_name $sum }} - {{ $dest := (or (first (groupByKeys $container "Env.VIRTUAL_DEST")) "") }} + {{ $dest := (or (first (groupByKeys $containers "Env.VIRTUAL_DEST")) "") }} {{ template "location" (dict "Path" $path "Proto" $proto "Upstream" $upstream "Host" $host "VhostRoot" $vhost_root "Dest" $dest "NetworkTag" $network_tag) }} {{ end }} {{ if (not (contains $paths "/")) }} From 491642b1e92cb1c058ebd72d6bc0074eec6af387 Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Tue, 5 Apr 2022 04:59:54 -0400 Subject: [PATCH 04/11] chore: Factor out duplicate virtual path code --- nginx.tmpl | 52 ++++++++++++++++++++++------------------------------ 1 file changed, 22 insertions(+), 30 deletions(-) diff --git a/nginx.tmpl b/nginx.tmpl index 10dd720..c2409e1 100644 --- a/nginx.tmpl +++ b/nginx.tmpl @@ -269,15 +269,17 @@ server { {{ $nPaths := len $paths }} {{ if eq $nPaths 0 }} - # {{ $host }} - {{ template "upstream" (dict "Upstream" $upstream_name "Containers" $containers "Networks" $CurrentContainer.Networks "Debug" $debug_all) }} -{{ else }} - {{ range $path, $containers := $paths }} + {{ $paths = dict "/" $containers }} +{{ end }} + +{{ range $path, $containers := $paths }} + {{ $upstream := $upstream_name }} + {{ if gt $nPaths 0 }} {{ $sum := sha1 $path }} - {{ $upstream := printf "%s-%s" $upstream_name $sum }} + {{ $upstream = printf "%s-%s" $upstream $sum }} + {{ end }} # {{ $host }}{{ $path }} {{ template "upstream" (dict "Upstream" $upstream "Containers" $containers "Networks" $CurrentContainer.Networks "Debug" $debug_all) }} - {{ end }} {{ end }} {{ $default_host := or ($.Env.DEFAULT_HOST) "" }} @@ -389,23 +391,19 @@ server { include /etc/nginx/vhost.d/default; {{ end }} - {{ if eq $nPaths 0 }} - {{/* Get the VIRTUAL_PROTO defined by containers w/ the same vhost, falling back to "http" */}} - {{ $proto := trim (or (first (groupByKeys $containers "Env.VIRTUAL_PROTO")) "http") }} - - {{/* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external" */}} - {{ $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} - {{ template "location" (dict "Path" "/" "Proto" $proto "Upstream" $upstream_name "Host" $host "VhostRoot" $vhost_root "Dest" "" "NetworkTag" $network_tag) }} - {{ else }} {{ range $path, $containers := $paths }} {{/* Get the VIRTUAL_PROTO defined by containers w/ the same vhost-vpath, falling back to "http" */}} {{ $proto := trim (or (first (groupByKeys $containers "Env.VIRTUAL_PROTO")) "http") }} {{/* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external" */}} {{ $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} - {{ $sum := sha1 $path }} - {{ $upstream := printf "%s-%s" $upstream_name $sum }} - {{ $dest := (or (first (groupByKeys $containers "Env.VIRTUAL_DEST")) "") }} + {{ $upstream := $upstream_name }} + {{ $dest := "" }} + {{ if gt $nPaths 0 }} + {{ $sum := sha1 $path }} + {{ $upstream = printf "%s-%s" $upstream $sum }} + {{ $dest = (or (first (groupByKeys $containers "Env.VIRTUAL_DEST")) "") }} + {{ end }} {{ template "location" (dict "Path" $path "Proto" $proto "Upstream" $upstream "Host" $host "VhostRoot" $vhost_root "Dest" $dest "NetworkTag" $network_tag) }} {{ end }} {{ if (not (contains $paths "/")) }} @@ -413,7 +411,6 @@ server { return {{ $default_root_response }}; } {{ end }} - {{ end }} } {{ end }} @@ -437,23 +434,19 @@ server { include /etc/nginx/vhost.d/default; {{ end }} - {{ if eq $nPaths 0 }} - {{/* Get the VIRTUAL_PROTO defined by containers w/ the same vhost, falling back to "http" */}} - {{ $proto := trim (or (first (groupByKeys $containers "Env.VIRTUAL_PROTO")) "http") }} - - {{/* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external" */}} - {{ $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} - {{ template "location" (dict "Path" "/" "Proto" $proto "Upstream" $upstream_name "Host" $host "VhostRoot" $vhost_root "Dest" "" "NetworkTag" $network_tag) }} - {{ else }} {{ range $path, $containers := $paths }} {{/* Get the VIRTUAL_PROTO defined by containers w/ the same vhost-vpath, falling back to "http" */}} {{ $proto := trim (or (first (groupByKeys $containers "Env.VIRTUAL_PROTO")) "http") }} {{/* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external" */}} {{ $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} - {{ $sum := sha1 $path }} - {{ $upstream := printf "%s-%s" $upstream_name $sum }} - {{ $dest := (or (first (groupByKeys $containers "Env.VIRTUAL_DEST")) "") }} + {{ $upstream := $upstream_name }} + {{ $dest := "" }} + {{ if gt $nPaths 0 }} + {{ $sum := sha1 $path }} + {{ $upstream = printf "%s-%s" $upstream $sum }} + {{ $dest = (or (first (groupByKeys $containers "Env.VIRTUAL_DEST")) "") }} + {{ end }} {{ template "location" (dict "Path" $path "Proto" $proto "Upstream" $upstream "Host" $host "VhostRoot" $vhost_root "Dest" $dest "NetworkTag" $network_tag) }} {{ end }} {{ if (not (contains $paths "/")) }} @@ -461,7 +454,6 @@ server { return {{ $default_root_response }}; } {{ end }} - {{ end }} } {{ if (and (not $is_https) (exists "/etc/nginx/certs/default.crt") (exists "/etc/nginx/certs/default.key")) }} From 744bd82c5491e46f1ab2bfc7ad803edd1bb37b9b Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Tue, 19 Apr 2022 15:37:53 -0400 Subject: [PATCH 05/11] chore: Combine identical HTTP and HTTPS servers --- nginx.tmpl | 72 ++++++++++++------------------------------------------ 1 file changed, 16 insertions(+), 56 deletions(-) diff --git a/nginx.tmpl b/nginx.tmpl index c2409e1..a262a96 100644 --- a/nginx.tmpl +++ b/nginx.tmpl @@ -239,25 +239,19 @@ server { {{ end }} {{ $access_log }} return 503; -} {{ if (and (exists "/etc/nginx/certs/default.crt") (exists "/etc/nginx/certs/default.key")) }} -server { - server_name _; # This is just an invalid value which will never trigger on a real hostname. - server_tokens off; listen {{ $external_https_port }} ssl http2; {{ if $enable_ipv6 }} listen [::]:{{ $external_https_port }} ssl http2; {{ end }} - {{ $access_log }} - return 503; ssl_session_cache shared:SSL:50m; ssl_session_tickets off; ssl_certificate /etc/nginx/certs/default.crt; ssl_certificate_key /etc/nginx/certs/default.key; -} {{ end }} +} {{ range $host, $containers := groupByMulti $ "Env.VIRTUAL_HOST" "," }} @@ -317,9 +311,7 @@ server { {{ $is_https := (and (ne $https_method "nohttps") (ne $cert "") (exists (printf "/etc/nginx/certs/%s.crt" $cert)) (exists (printf "/etc/nginx/certs/%s.key" $cert))) }} -{{ if $is_https }} - -{{ if eq $https_method "redirect" }} +{{ if and $is_https (eq $https_method "redirect") }} server { server_name {{ $host }}; {{ if $server_tokens }} @@ -356,11 +348,18 @@ server { {{ if $server_tokens }} server_tokens {{ $server_tokens }}; {{ end }} + {{ $access_log }} + {{- if or (not $is_https) (eq $https_method "noredirect") }} + listen {{ $external_http_port }} {{ $default_server }}; + {{ if $enable_ipv6 }} + listen [::]:{{ $external_http_port }} {{ $default_server }}; + {{ end }} + {{- end }} + {{- if $is_https }} listen {{ $external_https_port }} ssl http2 {{ $default_server }}; {{ if $enable_ipv6 }} listen [::]:{{ $external_https_port }} ssl http2 {{ $default_server }}; {{ end }} - {{ $access_log }} {{ template "ssl_policy" (dict "ssl_policy" $ssl_policy) }} @@ -382,51 +381,13 @@ server { {{ end }} {{ if (not (or (eq $https_method "noredirect") (eq $hsts "off"))) }} - add_header Strict-Transport-Security "{{ trim $hsts }}" always; + set $sts_header ""; + if ($https) { + set $sts_header "{{ trim $hsts }}"; + } + add_header Strict-Transport-Security $sts_header always; {{ end }} - - {{ if (exists (printf "/etc/nginx/vhost.d/%s" $host)) }} - include {{ printf "/etc/nginx/vhost.d/%s" $host }}; - {{ else if (exists "/etc/nginx/vhost.d/default") }} - include /etc/nginx/vhost.d/default; - {{ end }} - - {{ range $path, $containers := $paths }} - {{/* Get the VIRTUAL_PROTO defined by containers w/ the same vhost-vpath, falling back to "http" */}} - {{ $proto := trim (or (first (groupByKeys $containers "Env.VIRTUAL_PROTO")) "http") }} - - {{/* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external" */}} - {{ $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} - {{ $upstream := $upstream_name }} - {{ $dest := "" }} - {{ if gt $nPaths 0 }} - {{ $sum := sha1 $path }} - {{ $upstream = printf "%s-%s" $upstream $sum }} - {{ $dest = (or (first (groupByKeys $containers "Env.VIRTUAL_DEST")) "") }} - {{ end }} - {{ template "location" (dict "Path" $path "Proto" $proto "Upstream" $upstream "Host" $host "VhostRoot" $vhost_root "Dest" $dest "NetworkTag" $network_tag) }} - {{ end }} - {{ if (not (contains $paths "/")) }} - location / { - return {{ $default_root_response }}; - } - {{ end }} -} - -{{ end }} - -{{ if or (not $is_https) (eq $https_method "noredirect") }} - -server { - server_name {{ $host }}; - {{ if $server_tokens }} - server_tokens {{ $server_tokens }}; - {{ end }} - listen {{ $external_http_port }} {{ $default_server }}; - {{ if $enable_ipv6 }} - listen [::]:{{ $external_http_port }} {{ $default_server }}; - {{ end }} - {{ $access_log }} + {{- end }} {{ if (exists (printf "/etc/nginx/vhost.d/%s" $host)) }} include {{ printf "/etc/nginx/vhost.d/%s" $host }}; @@ -475,4 +436,3 @@ server { {{ end }} {{ end }} -{{ end }} From 4651bf411d05b196f75b6af448ef4b33742d0b6e Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Mon, 28 Mar 2022 02:49:58 -0400 Subject: [PATCH 06/11] chore: Fix comment for `$proxy_connection` variable --- nginx.tmpl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nginx.tmpl b/nginx.tmpl index a262a96..68fd3bb 100644 --- a/nginx.tmpl +++ b/nginx.tmpl @@ -167,8 +167,8 @@ map $http_x_forwarded_port $proxy_x_forwarded_port { '' $server_port; } -# If we receive Upgrade, set Connection to "upgrade"; otherwise, delete any -# Connection header that may have been passed to this server +# If we receive Upgrade, set Connection to "upgrade"; otherwise, preserve +# NGINX's default behavior ("Connection: close"). map $http_upgrade $proxy_connection { default upgrade; '' close; From d6d8b2205fcc5e87bf21581cf6a466ce9ba62b1d Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Tue, 17 May 2022 00:47:40 -0400 Subject: [PATCH 07/11] chore: Fix comment terminators --- nginx.tmpl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nginx.tmpl b/nginx.tmpl index 68fd3bb..cf2fd2c 100644 --- a/nginx.tmpl +++ b/nginx.tmpl @@ -11,8 +11,8 @@ {{ define "ssl_policy" }} {{ if eq .ssl_policy "Mozilla-Modern" }} ssl_protocols TLSv1.3; - {{/* nginx currently lacks ability to choose ciphers in TLS 1.3 in configuration, see https://trac.nginx.org/nginx/ticket/1529 /*}} - {{/* a possible workaround can be modify /etc/ssl/openssl.cnf to change it globally (see https://trac.nginx.org/nginx/ticket/1529#comment:12 ) /*}} + {{/* nginx currently lacks ability to choose ciphers in TLS 1.3 in configuration, see https://trac.nginx.org/nginx/ticket/1529 */}} + {{/* a possible workaround can be modify /etc/ssl/openssl.cnf to change it globally (see https://trac.nginx.org/nginx/ticket/1529#comment:12 ) */}} {{/* explicitly set ngnix default value in order to allow single servers to override the global http value */}} ssl_ciphers HIGH:!aNULL:!MD5; ssl_prefer_server_ciphers off; From f20662eeaa877c577bd5712190234ce819dfdef0 Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Tue, 17 May 2022 00:56:06 -0400 Subject: [PATCH 08/11] chore: Use `{{-` instead of `{{` to clean up whitespace --- nginx.tmpl | 368 ++++++++++++++++++++++++++--------------------------- 1 file changed, 184 insertions(+), 184 deletions(-) diff --git a/nginx.tmpl b/nginx.tmpl index cf2fd2c..a320def 100644 --- a/nginx.tmpl +++ b/nginx.tmpl @@ -1,152 +1,152 @@ -{{ $CurrentContainer := where $ "ID" .Docker.CurrentContainerID | first }} +{{- $CurrentContainer := where $ "ID" .Docker.CurrentContainerID | first }} -{{ $nginx_proxy_version := coalesce $.Env.NGINX_PROXY_VERSION "" }} -{{ $external_http_port := coalesce $.Env.HTTP_PORT "80" }} -{{ $external_https_port := coalesce $.Env.HTTPS_PORT "443" }} -{{ $debug_all := $.Env.DEBUG }} -{{ $sha1_upstream_name := parseBool (coalesce $.Env.SHA1_UPSTREAM_NAME "false") }} -{{ $default_root_response := coalesce $.Env.DEFAULT_ROOT "404" }} -{{ $trust_downstream_proxy := parseBool (coalesce $.Env.TRUST_DOWNSTREAM_PROXY "true") }} +{{- $nginx_proxy_version := coalesce $.Env.NGINX_PROXY_VERSION "" }} +{{- $external_http_port := coalesce $.Env.HTTP_PORT "80" }} +{{- $external_https_port := coalesce $.Env.HTTPS_PORT "443" }} +{{- $debug_all := $.Env.DEBUG }} +{{- $sha1_upstream_name := parseBool (coalesce $.Env.SHA1_UPSTREAM_NAME "false") }} +{{- $default_root_response := coalesce $.Env.DEFAULT_ROOT "404" }} +{{- $trust_downstream_proxy := parseBool (coalesce $.Env.TRUST_DOWNSTREAM_PROXY "true") }} -{{ define "ssl_policy" }} - {{ if eq .ssl_policy "Mozilla-Modern" }} +{{- define "ssl_policy" }} + {{- if eq .ssl_policy "Mozilla-Modern" }} ssl_protocols TLSv1.3; - {{/* nginx currently lacks ability to choose ciphers in TLS 1.3 in configuration, see https://trac.nginx.org/nginx/ticket/1529 */}} - {{/* a possible workaround can be modify /etc/ssl/openssl.cnf to change it globally (see https://trac.nginx.org/nginx/ticket/1529#comment:12 ) */}} - {{/* explicitly set ngnix default value in order to allow single servers to override the global http value */}} + {{- /* nginx currently lacks ability to choose ciphers in TLS 1.3 in configuration, see https://trac.nginx.org/nginx/ticket/1529 */}} + {{- /* a possible workaround can be modify /etc/ssl/openssl.cnf to change it globally (see https://trac.nginx.org/nginx/ticket/1529#comment:12 ) */}} + {{- /* explicitly set ngnix default value in order to allow single servers to override the global http value */}} ssl_ciphers HIGH:!aNULL:!MD5; ssl_prefer_server_ciphers off; - {{ else if eq .ssl_policy "Mozilla-Intermediate" }} + {{- else if eq .ssl_policy "Mozilla-Intermediate" }} ssl_protocols TLSv1.2 TLSv1.3; 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'; ssl_prefer_server_ciphers off; - {{ else if eq .ssl_policy "Mozilla-Old" }} + {{- else if eq .ssl_policy "Mozilla-Old" }} ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; 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'; ssl_prefer_server_ciphers on; - {{ else if eq .ssl_policy "AWS-TLS-1-2-2017-01" }} + {{- else if eq .ssl_policy "AWS-TLS-1-2-2017-01" }} ssl_protocols TLSv1.2 TLSv1.3; 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'; ssl_prefer_server_ciphers on; - {{ else if eq .ssl_policy "AWS-TLS-1-1-2017-01" }} + {{- else if eq .ssl_policy "AWS-TLS-1-1-2017-01" }} ssl_protocols TLSv1.1 TLSv1.2 TLSv1.3; 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'; ssl_prefer_server_ciphers on; - {{ else if eq .ssl_policy "AWS-2016-08" }} + {{- else if eq .ssl_policy "AWS-2016-08" }} ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; 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'; ssl_prefer_server_ciphers on; - {{ else if eq .ssl_policy "AWS-2015-05" }} + {{- else if eq .ssl_policy "AWS-2015-05" }} ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; 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'; ssl_prefer_server_ciphers on; - {{ else if eq .ssl_policy "AWS-2015-03" }} + {{- else if eq .ssl_policy "AWS-2015-03" }} ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; 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'; ssl_prefer_server_ciphers on; - {{ else if eq .ssl_policy "AWS-2015-02" }} + {{- else if eq .ssl_policy "AWS-2015-02" }} ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; 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'; ssl_prefer_server_ciphers on; - {{ end }} -{{ end }} + {{- end }} +{{- end }} -{{ define "location" }} +{{- define "location" }} location {{ .Path }} { - {{ if eq .NetworkTag "internal" }} + {{- if eq .NetworkTag "internal" }} # Only allow traffic from internal clients include /etc/nginx/network_internal.conf; - {{ end }} + {{- end }} - {{ if eq .Proto "uwsgi" }} + {{- if eq .Proto "uwsgi" }} include uwsgi_params; uwsgi_pass {{ trim .Proto }}://{{ trim .Upstream }}; - {{ else if eq .Proto "fastcgi" }} + {{- else if eq .Proto "fastcgi" }} root {{ trim .VhostRoot }}; include fastcgi_params; fastcgi_pass {{ trim .Upstream }}; - {{ else if eq .Proto "grpc" }} + {{- else if eq .Proto "grpc" }} grpc_pass {{ trim .Proto }}://{{ trim .Upstream }}; - {{ else }} + {{- else }} proxy_pass {{ trim .Proto }}://{{ trim .Upstream }}{{ trim .Dest }}; - {{ end }} + {{- end }} - {{ if (exists (printf "/etc/nginx/htpasswd/%s" .Host)) }} + {{- if (exists (printf "/etc/nginx/htpasswd/%s" .Host)) }} auth_basic "Restricted {{ .Host }}"; auth_basic_user_file {{ (printf "/etc/nginx/htpasswd/%s" .Host) }}; - {{ end }} + {{- end }} - {{ if (exists (printf "/etc/nginx/vhost.d/%s_%s_location" .Host (sha1 .Path) )) }} + {{- if (exists (printf "/etc/nginx/vhost.d/%s_%s_location" .Host (sha1 .Path) )) }} include {{ printf "/etc/nginx/vhost.d/%s_%s_location" .Host (sha1 .Path) }}; - {{ else if (exists (printf "/etc/nginx/vhost.d/%s_location" .Host)) }} + {{- else if (exists (printf "/etc/nginx/vhost.d/%s_location" .Host)) }} include {{ printf "/etc/nginx/vhost.d/%s_location" .Host}}; - {{ else if (exists "/etc/nginx/vhost.d/default_location") }} + {{- else if (exists "/etc/nginx/vhost.d/default_location") }} include /etc/nginx/vhost.d/default_location; - {{ end }} + {{- end }} } -{{ end }} +{{- end }} -{{ define "upstream" }} - {{ $networks := .Networks }} - {{ $debug_all := .Debug }} +{{- define "upstream" }} + {{- $networks := .Networks }} + {{- $debug_all := .Debug }} upstream {{ .Upstream }} { - {{ $server_found := false }} - {{ range $container := .Containers }} - {{ $debug := parseBool (coalesce $container.Env.DEBUG $debug_all "false") }} - {{/* If only 1 port exposed, use that as a default, else 80 */}} - {{ $defaultPort := (when (eq (len $container.Addresses) 1) (first $container.Addresses) (dict "Port" "80")).Port }} - {{ $port := (coalesce $container.Env.VIRTUAL_PORT $defaultPort) }} - {{ $address := where $container.Addresses "Port" $port | first }} - {{ if $debug }} + {{- $server_found := false }} + {{- range $container := .Containers }} + {{- $debug := parseBool (coalesce $container.Env.DEBUG $debug_all "false") }} + {{- /* If only 1 port exposed, use that as a default, else 80 */}} + {{- $defaultPort := (when (eq (len $container.Addresses) 1) (first $container.Addresses) (dict "Port" "80")).Port }} + {{- $port := (coalesce $container.Env.VIRTUAL_PORT $defaultPort) }} + {{- $address := where $container.Addresses "Port" $port | first }} + {{- if $debug }} # Exposed ports: {{ $container.Addresses }} # Default virtual port: {{ $defaultPort }} # VIRTUAL_PORT: {{ $container.Env.VIRTUAL_PORT }} - {{ if not $address }} + {{- if not $address }} # /!\ Virtual port not exposed - {{ end }} - {{ end }} - {{ range $knownNetwork := $networks }} - {{ range $containerNetwork := sortObjectsByKeysAsc $container.Networks "Name" }} - {{ if (and (ne $containerNetwork.Name "ingress") (or (eq $knownNetwork.Name $containerNetwork.Name) (eq $knownNetwork.Name "host"))) }} + {{- end }} + {{- end }} + {{- range $knownNetwork := $networks }} + {{- range $containerNetwork := sortObjectsByKeysAsc $container.Networks "Name" }} + {{- if (and (ne $containerNetwork.Name "ingress") (or (eq $knownNetwork.Name $containerNetwork.Name) (eq $knownNetwork.Name "host"))) }} ## Can be connected with "{{ $containerNetwork.Name }}" network - {{ if $address }} - {{/* If we got the containers from swarm and this container's port is published to host, use host IP:PORT */}} - {{ if and $container.Node.ID $address.HostPort }} - {{ $server_found = true }} + {{- if $address }} + {{- /* If we got the containers from swarm and this container's port is published to host, use host IP:PORT */}} + {{- if and $container.Node.ID $address.HostPort }} + {{- $server_found = true }} # {{ $container.Node.Name }}/{{ $container.Name }} server {{ $container.Node.Address.IP }}:{{ $address.HostPort }}; - {{/* If there is no swarm node or the port is not published on host, use container's IP:PORT */}} - {{ else if $containerNetwork }} - {{ $server_found = true }} + {{- /* If there is no swarm node or the port is not published on host, use container's IP:PORT */}} + {{- else if $containerNetwork }} + {{- $server_found = true }} # {{ $container.Name }} server {{ $containerNetwork.IP }}:{{ $address.Port }}; - {{ end }} - {{ else if $containerNetwork }} + {{- end }} + {{- else if $containerNetwork }} # {{ $container.Name }} - {{ if $containerNetwork.IP }} - {{ $server_found = true }} + {{- if $containerNetwork.IP }} + {{- $server_found = true }} server {{ $containerNetwork.IP }}:{{ $port }}; - {{ else }} + {{- else }} # /!\ No IP for this network! - {{ end }} - {{ end }} - {{ else }} + {{- end }} + {{- end }} + {{- else }} # Cannot connect to network '{{ $containerNetwork.Name }}' of this container - {{ end }} - {{ end }} - {{ end }} - {{ end }} - {{/* nginx-proxy/nginx-proxy#1105 */}} - {{ if not $server_found }} + {{- end }} + {{- end }} + {{- end }} + {{- end }} + {{- /* nginx-proxy/nginx-proxy#1105 */}} + {{- if not $server_found }} # Fallback entry server 127.0.0.1 down; - {{ end }} + {{- end }} } -{{ end }} +{{- end }} -{{ if ne $nginx_proxy_version "" }} +{{- if ne $nginx_proxy_version "" }} # nginx-proxy version : {{ $nginx_proxy_version }} -{{ end }} +{{- end }} # If we receive X-Forwarded-Proto, pass it through; otherwise, pass along the # scheme used to connect to this server @@ -178,9 +178,9 @@ map $http_upgrade $proxy_connection { server_names_hash_bucket_size 128; # Default dhparam -{{ if (exists "/etc/nginx/dhparam/dhparam.pem") }} +{{- if (exists "/etc/nginx/dhparam/dhparam.pem") }} ssl_dhparam /etc/nginx/dhparam/dhparam.pem; -{{ end }} +{{- end }} # Set appropriate X-Forwarded-Ssl header based on $proxy_x_forwarded_proto map $proxy_x_forwarded_proto $proxy_x_forwarded_ssl { @@ -197,18 +197,18 @@ log_format vhost '$host $remote_addr - $remote_user [$time_local] ' access_log off; -{{/* Get the SSL_POLICY defined by this container, falling back to "Mozilla-Intermediate" */}} -{{ $ssl_policy := or ($.Env.SSL_POLICY) "Mozilla-Intermediate" }} -{{ template "ssl_policy" (dict "ssl_policy" $ssl_policy) }} +{{- /* Get the SSL_POLICY defined by this container, falling back to "Mozilla-Intermediate" */}} +{{- $ssl_policy := or ($.Env.SSL_POLICY) "Mozilla-Intermediate" }} +{{- template "ssl_policy" (dict "ssl_policy" $ssl_policy) }} error_log /dev/stderr; -{{ if $.Env.RESOLVERS }} +{{- if $.Env.RESOLVERS }} resolver {{ $.Env.RESOLVERS }}; -{{ end }} +{{- end }} -{{ if (exists "/etc/nginx/proxy.conf") }} +{{- if (exists "/etc/nginx/proxy.conf") }} include /etc/nginx/proxy.conf; -{{ else }} +{{- else }} # HTTP 1.1 support proxy_http_version 1.1; proxy_buffering off; @@ -225,102 +225,102 @@ proxy_set_header X-Original-URI $request_uri; # Mitigate httpoxy attack (see README for details) proxy_set_header Proxy ""; -{{ end }} +{{- end }} -{{ $access_log := (or (and (not $.Env.DISABLE_ACCESS_LOGS) "access_log /var/log/nginx/access.log vhost;") "") }} +{{- $access_log := (or (and (not $.Env.DISABLE_ACCESS_LOGS) "access_log /var/log/nginx/access.log vhost;") "") }} -{{ $enable_ipv6 := parseBool (coalesce $.Env.ENABLE_IPV6 "false") }} +{{- $enable_ipv6 := parseBool (coalesce $.Env.ENABLE_IPV6 "false") }} server { server_name _; # This is just an invalid value which will never trigger on a real hostname. server_tokens off; listen {{ $external_http_port }}; - {{ if $enable_ipv6 }} + {{- if $enable_ipv6 }} listen [::]:{{ $external_http_port }}; - {{ end }} + {{- end }} {{ $access_log }} return 503; -{{ if (and (exists "/etc/nginx/certs/default.crt") (exists "/etc/nginx/certs/default.key")) }} +{{- if (and (exists "/etc/nginx/certs/default.crt") (exists "/etc/nginx/certs/default.key")) }} listen {{ $external_https_port }} ssl http2; - {{ if $enable_ipv6 }} + {{- if $enable_ipv6 }} listen [::]:{{ $external_https_port }} ssl http2; - {{ end }} + {{- end }} ssl_session_cache shared:SSL:50m; ssl_session_tickets off; ssl_certificate /etc/nginx/certs/default.crt; ssl_certificate_key /etc/nginx/certs/default.key; -{{ end }} +{{- end }} } -{{ range $host, $containers := groupByMulti $ "Env.VIRTUAL_HOST" "," }} +{{- range $host, $containers := groupByMulti $ "Env.VIRTUAL_HOST" "," }} -{{ $host := trim $host }} -{{ $is_regexp := hasPrefix "~" $host }} -{{ $upstream_name := when (or $is_regexp $sha1_upstream_name) (sha1 $host) $host }} +{{- $host := trim $host }} +{{- $is_regexp := hasPrefix "~" $host }} +{{- $upstream_name := when (or $is_regexp $sha1_upstream_name) (sha1 $host) $host }} -{{ $paths := groupBy $containers "Env.VIRTUAL_PATH" }} -{{ $nPaths := len $paths }} +{{- $paths := groupBy $containers "Env.VIRTUAL_PATH" }} +{{- $nPaths := len $paths }} -{{ if eq $nPaths 0 }} - {{ $paths = dict "/" $containers }} -{{ end }} +{{- if eq $nPaths 0 }} + {{- $paths = dict "/" $containers }} +{{- end }} -{{ range $path, $containers := $paths }} - {{ $upstream := $upstream_name }} - {{ if gt $nPaths 0 }} - {{ $sum := sha1 $path }} - {{ $upstream = printf "%s-%s" $upstream $sum }} - {{ end }} +{{- range $path, $containers := $paths }} + {{- $upstream := $upstream_name }} + {{- if gt $nPaths 0 }} + {{- $sum := sha1 $path }} + {{- $upstream = printf "%s-%s" $upstream $sum }} + {{- end }} # {{ $host }}{{ $path }} {{ template "upstream" (dict "Upstream" $upstream "Containers" $containers "Networks" $CurrentContainer.Networks "Debug" $debug_all) }} -{{ end }} +{{- end }} -{{ $default_host := or ($.Env.DEFAULT_HOST) "" }} -{{ $default_server := index (dict $host "" $default_host "default_server") $host }} +{{- $default_host := or ($.Env.DEFAULT_HOST) "" }} +{{- $default_server := index (dict $host "" $default_host "default_server") $host }} -{{/* Get the SERVER_TOKENS defined by containers w/ the same vhost, falling back to "" */}} -{{ $server_tokens := trim (or (first (groupByKeys $containers "Env.SERVER_TOKENS")) "") }} +{{- /* Get the SERVER_TOKENS defined by containers w/ the same vhost, falling back to "" */}} +{{- $server_tokens := trim (or (first (groupByKeys $containers "Env.SERVER_TOKENS")) "") }} -{{/* Get the HTTPS_METHOD defined by containers w/ the same vhost, falling back to "redirect" */}} -{{ $https_method := or (first (groupByKeys $containers "Env.HTTPS_METHOD")) (or $.Env.HTTPS_METHOD "redirect") }} +{{- /* Get the HTTPS_METHOD defined by containers w/ the same vhost, falling back to "redirect" */}} +{{- $https_method := or (first (groupByKeys $containers "Env.HTTPS_METHOD")) (or $.Env.HTTPS_METHOD "redirect") }} -{{/* Get the SSL_POLICY defined by containers w/ the same vhost, falling back to empty string (use default) */}} -{{ $ssl_policy := or (first (groupByKeys $containers "Env.SSL_POLICY")) "" }} +{{- /* Get the SSL_POLICY defined by containers w/ the same vhost, falling back to empty string (use default) */}} +{{- $ssl_policy := or (first (groupByKeys $containers "Env.SSL_POLICY")) "" }} -{{/* Get the HSTS defined by containers w/ the same vhost, falling back to "max-age=31536000" */}} -{{ $hsts := or (first (groupByKeys $containers "Env.HSTS")) (or $.Env.HSTS "max-age=31536000") }} +{{- /* Get the HSTS defined by containers w/ the same vhost, falling back to "max-age=31536000" */}} +{{- $hsts := or (first (groupByKeys $containers "Env.HSTS")) (or $.Env.HSTS "max-age=31536000") }} -{{/* Get the VIRTUAL_ROOT By containers w/ use fastcgi root */}} -{{ $vhost_root := or (first (groupByKeys $containers "Env.VIRTUAL_ROOT")) "/var/www/public" }} +{{- /* Get the VIRTUAL_ROOT By containers w/ use fastcgi root */}} +{{- $vhost_root := or (first (groupByKeys $containers "Env.VIRTUAL_ROOT")) "/var/www/public" }} -{{/* Get the first cert name defined by containers w/ the same vhost */}} -{{ $certName := (first (groupByKeys $containers "Env.CERT_NAME")) }} +{{- /* Get the first cert name defined by containers w/ the same vhost */}} +{{- $certName := (first (groupByKeys $containers "Env.CERT_NAME")) }} -{{/* Get the best matching cert by name for the vhost. */}} -{{ $vhostCert := (closest (dir "/etc/nginx/certs") (printf "%s.crt" $host))}} +{{- /* Get the best matching cert by name for the vhost. */}} +{{- $vhostCert := (closest (dir "/etc/nginx/certs") (printf "%s.crt" $host))}} -{{/* vhostCert is actually a filename so remove any suffixes since they are added later */}} -{{ $vhostCert := trimSuffix ".crt" $vhostCert }} -{{ $vhostCert := trimSuffix ".key" $vhostCert }} +{{- /* vhostCert is actually a filename so remove any suffixes since they are added later */}} +{{- $vhostCert := trimSuffix ".crt" $vhostCert }} +{{- $vhostCert := trimSuffix ".key" $vhostCert }} -{{/* Use the cert specified on the container or fallback to the best vhost match */}} -{{ $cert := (coalesce $certName $vhostCert) }} +{{- /* Use the cert specified on the container or fallback to the best vhost match */}} +{{- $cert := (coalesce $certName $vhostCert) }} -{{ $is_https := (and (ne $https_method "nohttps") (ne $cert "") (exists (printf "/etc/nginx/certs/%s.crt" $cert)) (exists (printf "/etc/nginx/certs/%s.key" $cert))) }} +{{- $is_https := (and (ne $https_method "nohttps") (ne $cert "") (exists (printf "/etc/nginx/certs/%s.crt" $cert)) (exists (printf "/etc/nginx/certs/%s.key" $cert))) }} -{{ if and $is_https (eq $https_method "redirect") }} +{{- if and $is_https (eq $https_method "redirect") }} server { server_name {{ $host }}; - {{ if $server_tokens }} + {{- if $server_tokens }} server_tokens {{ $server_tokens }}; - {{ end }} + {{- end }} listen {{ $external_http_port }} {{ $default_server }}; - {{ if $enable_ipv6 }} + {{- if $enable_ipv6 }} listen [::]:{{ $external_http_port }} {{ $default_server }}; - {{ end }} + {{- end }} {{ $access_log }} # Do not HTTPS redirect Let'sEncrypt ACME challenge @@ -334,34 +334,34 @@ server { } location / { - {{ if eq $external_https_port "443" }} + {{- if eq $external_https_port "443" }} return 301 https://$host$request_uri; - {{ else }} + {{- else }} return 301 https://$host:{{ $external_https_port }}$request_uri; - {{ end }} + {{- end }} } } -{{ end }} +{{- end }} server { server_name {{ $host }}; - {{ if $server_tokens }} + {{- if $server_tokens }} server_tokens {{ $server_tokens }}; - {{ end }} + {{- end }} {{ $access_log }} {{- if or (not $is_https) (eq $https_method "noredirect") }} listen {{ $external_http_port }} {{ $default_server }}; - {{ if $enable_ipv6 }} + {{- if $enable_ipv6 }} listen [::]:{{ $external_http_port }} {{ $default_server }}; - {{ end }} + {{- end }} {{- end }} {{- if $is_https }} listen {{ $external_https_port }} ssl http2 {{ $default_server }}; - {{ if $enable_ipv6 }} + {{- if $enable_ipv6 }} listen [::]:{{ $external_https_port }} ssl http2 {{ $default_server }}; - {{ end }} + {{- end }} - {{ template "ssl_policy" (dict "ssl_policy" $ssl_policy) }} + {{- template "ssl_policy" (dict "ssl_policy" $ssl_policy) }} ssl_session_timeout 5m; ssl_session_cache shared:SSL:50m; @@ -370,69 +370,69 @@ server { ssl_certificate /etc/nginx/certs/{{ (printf "%s.crt" $cert) }}; ssl_certificate_key /etc/nginx/certs/{{ (printf "%s.key" $cert) }}; - {{ if (exists (printf "/etc/nginx/certs/%s.dhparam.pem" $cert)) }} + {{- if (exists (printf "/etc/nginx/certs/%s.dhparam.pem" $cert)) }} ssl_dhparam {{ printf "/etc/nginx/certs/%s.dhparam.pem" $cert }}; - {{ end }} + {{- end }} - {{ if (exists (printf "/etc/nginx/certs/%s.chain.pem" $cert)) }} + {{- if (exists (printf "/etc/nginx/certs/%s.chain.pem" $cert)) }} ssl_stapling on; ssl_stapling_verify on; ssl_trusted_certificate {{ printf "/etc/nginx/certs/%s.chain.pem" $cert }}; - {{ end }} + {{- end }} - {{ if (not (or (eq $https_method "noredirect") (eq $hsts "off"))) }} + {{- if (not (or (eq $https_method "noredirect") (eq $hsts "off"))) }} set $sts_header ""; if ($https) { set $sts_header "{{ trim $hsts }}"; } add_header Strict-Transport-Security $sts_header always; - {{ end }} + {{- end }} {{- end }} - {{ if (exists (printf "/etc/nginx/vhost.d/%s" $host)) }} + {{- if (exists (printf "/etc/nginx/vhost.d/%s" $host)) }} include {{ printf "/etc/nginx/vhost.d/%s" $host }}; - {{ else if (exists "/etc/nginx/vhost.d/default") }} + {{- else if (exists "/etc/nginx/vhost.d/default") }} include /etc/nginx/vhost.d/default; - {{ end }} + {{- end }} - {{ range $path, $containers := $paths }} - {{/* Get the VIRTUAL_PROTO defined by containers w/ the same vhost-vpath, falling back to "http" */}} - {{ $proto := trim (or (first (groupByKeys $containers "Env.VIRTUAL_PROTO")) "http") }} + {{- range $path, $containers := $paths }} + {{- /* Get the VIRTUAL_PROTO defined by containers w/ the same vhost-vpath, falling back to "http" */}} + {{- $proto := trim (or (first (groupByKeys $containers "Env.VIRTUAL_PROTO")) "http") }} - {{/* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external" */}} - {{ $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} - {{ $upstream := $upstream_name }} - {{ $dest := "" }} - {{ if gt $nPaths 0 }} - {{ $sum := sha1 $path }} - {{ $upstream = printf "%s-%s" $upstream $sum }} - {{ $dest = (or (first (groupByKeys $containers "Env.VIRTUAL_DEST")) "") }} - {{ end }} - {{ template "location" (dict "Path" $path "Proto" $proto "Upstream" $upstream "Host" $host "VhostRoot" $vhost_root "Dest" $dest "NetworkTag" $network_tag) }} - {{ end }} - {{ if (not (contains $paths "/")) }} + {{- /* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external" */}} + {{- $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} + {{- $upstream := $upstream_name }} + {{- $dest := "" }} + {{- if gt $nPaths 0 }} + {{- $sum := sha1 $path }} + {{- $upstream = printf "%s-%s" $upstream $sum }} + {{- $dest = (or (first (groupByKeys $containers "Env.VIRTUAL_DEST")) "") }} + {{- end }} + {{- template "location" (dict "Path" $path "Proto" $proto "Upstream" $upstream "Host" $host "VhostRoot" $vhost_root "Dest" $dest "NetworkTag" $network_tag) }} + {{- end }} + {{- if (not (contains $paths "/")) }} location / { return {{ $default_root_response }}; } - {{ end }} + {{- end }} } -{{ if (and (not $is_https) (exists "/etc/nginx/certs/default.crt") (exists "/etc/nginx/certs/default.key")) }} +{{- if (and (not $is_https) (exists "/etc/nginx/certs/default.crt") (exists "/etc/nginx/certs/default.key")) }} server { server_name {{ $host }}; - {{ if $server_tokens }} + {{- if $server_tokens }} server_tokens {{ $server_tokens }}; - {{ end }} + {{- end }} listen {{ $external_https_port }} ssl http2 {{ $default_server }}; - {{ if $enable_ipv6 }} + {{- if $enable_ipv6 }} listen [::]:{{ $external_https_port }} ssl http2 {{ $default_server }}; - {{ end }} + {{- end }} {{ $access_log }} return 500; ssl_certificate /etc/nginx/certs/default.crt; ssl_certificate_key /etc/nginx/certs/default.key; } -{{ end }} +{{- end }} -{{ end }} +{{- end }} From 0da38122bd17c42d826a714cc05a4160a1a9f63e Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Tue, 17 May 2022 01:19:32 -0400 Subject: [PATCH 09/11] chore: Consistent indentation --- nginx.tmpl | 533 ++++++++++++++++++++++++++--------------------------- 1 file changed, 266 insertions(+), 267 deletions(-) diff --git a/nginx.tmpl b/nginx.tmpl index a320def..2cb0fe4 100644 --- a/nginx.tmpl +++ b/nginx.tmpl @@ -9,138 +9,138 @@ {{- $trust_downstream_proxy := parseBool (coalesce $.Env.TRUST_DOWNSTREAM_PROXY "true") }} {{- define "ssl_policy" }} - {{- if eq .ssl_policy "Mozilla-Modern" }} - ssl_protocols TLSv1.3; - {{- /* nginx currently lacks ability to choose ciphers in TLS 1.3 in configuration, see https://trac.nginx.org/nginx/ticket/1529 */}} - {{- /* a possible workaround can be modify /etc/ssl/openssl.cnf to change it globally (see https://trac.nginx.org/nginx/ticket/1529#comment:12 ) */}} - {{- /* explicitly set ngnix default value in order to allow single servers to override the global http value */}} - ssl_ciphers HIGH:!aNULL:!MD5; - ssl_prefer_server_ciphers off; - {{- else if eq .ssl_policy "Mozilla-Intermediate" }} - ssl_protocols TLSv1.2 TLSv1.3; - 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'; - ssl_prefer_server_ciphers off; - {{- else if eq .ssl_policy "Mozilla-Old" }} - ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; - 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'; - ssl_prefer_server_ciphers on; - {{- else if eq .ssl_policy "AWS-TLS-1-2-2017-01" }} - ssl_protocols TLSv1.2 TLSv1.3; - 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'; - ssl_prefer_server_ciphers on; - {{- else if eq .ssl_policy "AWS-TLS-1-1-2017-01" }} - ssl_protocols TLSv1.1 TLSv1.2 TLSv1.3; - 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'; - ssl_prefer_server_ciphers on; - {{- else if eq .ssl_policy "AWS-2016-08" }} - ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; - 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'; - ssl_prefer_server_ciphers on; - {{- else if eq .ssl_policy "AWS-2015-05" }} - ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; - 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'; - ssl_prefer_server_ciphers on; - {{- else if eq .ssl_policy "AWS-2015-03" }} - ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; - 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'; - ssl_prefer_server_ciphers on; - {{- else if eq .ssl_policy "AWS-2015-02" }} - ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; - 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'; - ssl_prefer_server_ciphers on; - {{- end }} + {{- if eq .ssl_policy "Mozilla-Modern" }} + ssl_protocols TLSv1.3; + {{- /* nginx currently lacks ability to choose ciphers in TLS 1.3 in configuration, see https://trac.nginx.org/nginx/ticket/1529 */}} + {{- /* a possible workaround can be modify /etc/ssl/openssl.cnf to change it globally (see https://trac.nginx.org/nginx/ticket/1529#comment:12 ) */}} + {{- /* explicitly set ngnix default value in order to allow single servers to override the global http value */}} + ssl_ciphers HIGH:!aNULL:!MD5; + ssl_prefer_server_ciphers off; + {{- else if eq .ssl_policy "Mozilla-Intermediate" }} + ssl_protocols TLSv1.2 TLSv1.3; + 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'; + ssl_prefer_server_ciphers off; + {{- else if eq .ssl_policy "Mozilla-Old" }} + ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; + 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'; + ssl_prefer_server_ciphers on; + {{- else if eq .ssl_policy "AWS-TLS-1-2-2017-01" }} + ssl_protocols TLSv1.2 TLSv1.3; + 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'; + ssl_prefer_server_ciphers on; + {{- else if eq .ssl_policy "AWS-TLS-1-1-2017-01" }} + ssl_protocols TLSv1.1 TLSv1.2 TLSv1.3; + 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'; + ssl_prefer_server_ciphers on; + {{- else if eq .ssl_policy "AWS-2016-08" }} + ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; + 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'; + ssl_prefer_server_ciphers on; + {{- else if eq .ssl_policy "AWS-2015-05" }} + ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; + 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'; + ssl_prefer_server_ciphers on; + {{- else if eq .ssl_policy "AWS-2015-03" }} + ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; + 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'; + ssl_prefer_server_ciphers on; + {{- else if eq .ssl_policy "AWS-2015-02" }} + ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; + 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'; + ssl_prefer_server_ciphers on; + {{- end }} {{- end }} {{- define "location" }} - location {{ .Path }} { - {{- if eq .NetworkTag "internal" }} - # Only allow traffic from internal clients - include /etc/nginx/network_internal.conf; - {{- end }} + location {{ .Path }} { + {{- if eq .NetworkTag "internal" }} + # Only allow traffic from internal clients + include /etc/nginx/network_internal.conf; + {{- end }} - {{- if eq .Proto "uwsgi" }} - include uwsgi_params; - uwsgi_pass {{ trim .Proto }}://{{ trim .Upstream }}; - {{- else if eq .Proto "fastcgi" }} - root {{ trim .VhostRoot }}; - include fastcgi_params; - fastcgi_pass {{ trim .Upstream }}; - {{- else if eq .Proto "grpc" }} - grpc_pass {{ trim .Proto }}://{{ trim .Upstream }}; - {{- else }} - proxy_pass {{ trim .Proto }}://{{ trim .Upstream }}{{ trim .Dest }}; - {{- end }} + {{- if eq .Proto "uwsgi" }} + include uwsgi_params; + uwsgi_pass {{ trim .Proto }}://{{ trim .Upstream }}; + {{- else if eq .Proto "fastcgi" }} + root {{ trim .VhostRoot }}; + include fastcgi_params; + fastcgi_pass {{ trim .Upstream }}; + {{- else if eq .Proto "grpc" }} + grpc_pass {{ trim .Proto }}://{{ trim .Upstream }}; + {{- else }} + proxy_pass {{ trim .Proto }}://{{ trim .Upstream }}{{ trim .Dest }}; + {{- end }} - {{- if (exists (printf "/etc/nginx/htpasswd/%s" .Host)) }} - auth_basic "Restricted {{ .Host }}"; - auth_basic_user_file {{ (printf "/etc/nginx/htpasswd/%s" .Host) }}; - {{- end }} + {{- if (exists (printf "/etc/nginx/htpasswd/%s" .Host)) }} + auth_basic "Restricted {{ .Host }}"; + auth_basic_user_file {{ (printf "/etc/nginx/htpasswd/%s" .Host) }}; + {{- end }} - {{- if (exists (printf "/etc/nginx/vhost.d/%s_%s_location" .Host (sha1 .Path) )) }} - include {{ printf "/etc/nginx/vhost.d/%s_%s_location" .Host (sha1 .Path) }}; - {{- else if (exists (printf "/etc/nginx/vhost.d/%s_location" .Host)) }} - include {{ printf "/etc/nginx/vhost.d/%s_location" .Host}}; - {{- else if (exists "/etc/nginx/vhost.d/default_location") }} - include /etc/nginx/vhost.d/default_location; - {{- end }} -} + {{- if (exists (printf "/etc/nginx/vhost.d/%s_%s_location" .Host (sha1 .Path) )) }} + include {{ printf "/etc/nginx/vhost.d/%s_%s_location" .Host (sha1 .Path) }}; + {{- else if (exists (printf "/etc/nginx/vhost.d/%s_location" .Host)) }} + include {{ printf "/etc/nginx/vhost.d/%s_location" .Host}}; + {{- else if (exists "/etc/nginx/vhost.d/default_location") }} + include /etc/nginx/vhost.d/default_location; + {{- end }} + } {{- end }} {{- define "upstream" }} - {{- $networks := .Networks }} - {{- $debug_all := .Debug }} + {{- $networks := .Networks }} + {{- $debug_all := .Debug }} upstream {{ .Upstream }} { - {{- $server_found := false }} - {{- range $container := .Containers }} + {{- $server_found := false }} + {{- range $container := .Containers }} {{- $debug := parseBool (coalesce $container.Env.DEBUG $debug_all "false") }} {{- /* If only 1 port exposed, use that as a default, else 80 */}} {{- $defaultPort := (when (eq (len $container.Addresses) 1) (first $container.Addresses) (dict "Port" "80")).Port }} {{- $port := (coalesce $container.Env.VIRTUAL_PORT $defaultPort) }} {{- $address := where $container.Addresses "Port" $port | first }} {{- if $debug }} - # Exposed ports: {{ $container.Addresses }} - # Default virtual port: {{ $defaultPort }} - # VIRTUAL_PORT: {{ $container.Env.VIRTUAL_PORT }} + # Exposed ports: {{ $container.Addresses }} + # Default virtual port: {{ $defaultPort }} + # VIRTUAL_PORT: {{ $container.Env.VIRTUAL_PORT }} {{- if not $address }} - # /!\ Virtual port not exposed + # /!\ Virtual port not exposed {{- end }} {{- end }} - {{- range $knownNetwork := $networks }} - {{- range $containerNetwork := sortObjectsByKeysAsc $container.Networks "Name" }} - {{- if (and (ne $containerNetwork.Name "ingress") (or (eq $knownNetwork.Name $containerNetwork.Name) (eq $knownNetwork.Name "host"))) }} - ## Can be connected with "{{ $containerNetwork.Name }}" network + {{- range $knownNetwork := $networks }} + {{- range $containerNetwork := sortObjectsByKeysAsc $container.Networks "Name" }} + {{- if (and (ne $containerNetwork.Name "ingress") (or (eq $knownNetwork.Name $containerNetwork.Name) (eq $knownNetwork.Name "host"))) }} + ## Can be connected with "{{ $containerNetwork.Name }}" network {{- if $address }} {{- /* If we got the containers from swarm and this container's port is published to host, use host IP:PORT */}} {{- if and $container.Node.ID $address.HostPort }} {{- $server_found = true }} - # {{ $container.Node.Name }}/{{ $container.Name }} - server {{ $container.Node.Address.IP }}:{{ $address.HostPort }}; - {{- /* If there is no swarm node or the port is not published on host, use container's IP:PORT */}} + # {{ $container.Node.Name }}/{{ $container.Name }} + server {{ $container.Node.Address.IP }}:{{ $address.HostPort }}; + {{- /* If there is no swarm node or the port is not published on host, use container's IP:PORT */}} {{- else if $containerNetwork }} {{- $server_found = true }} - # {{ $container.Name }} - server {{ $containerNetwork.IP }}:{{ $address.Port }}; + # {{ $container.Name }} + server {{ $containerNetwork.IP }}:{{ $address.Port }}; {{- end }} {{- else if $containerNetwork }} - # {{ $container.Name }} + # {{ $container.Name }} {{- if $containerNetwork.IP }} {{- $server_found = true }} - server {{ $containerNetwork.IP }}:{{ $port }}; + server {{ $containerNetwork.IP }}:{{ $port }}; {{- else }} - # /!\ No IP for this network! - {{- end }} - {{- end }} - {{- else }} - # Cannot connect to network '{{ $containerNetwork.Name }}' of this container - {{- end }} - {{- end }} - {{- end }} - {{- end }} - {{- /* nginx-proxy/nginx-proxy#1105 */}} - {{- if not $server_found }} - # Fallback entry - server 127.0.0.1 down; - {{- end }} + # /!\ No IP for this network! + {{- end }} + {{- end }} + {{- else }} + # Cannot connect to network '{{ $containerNetwork.Name }}' of this container + {{- end }} + {{- end }} + {{- end }} + {{- end }} + {{- /* nginx-proxy/nginx-proxy#1105 */}} + {{- if not $server_found }} + # Fallback entry + server 127.0.0.1 down; + {{- end }} } {{- end }} @@ -151,27 +151,27 @@ upstream {{ .Upstream }} { # If we receive X-Forwarded-Proto, pass it through; otherwise, pass along the # scheme used to connect to this server map $http_x_forwarded_proto $proxy_x_forwarded_proto { - default {{ if $trust_downstream_proxy }}$http_x_forwarded_proto{{ else }}$scheme{{ end }}; - '' $scheme; + default {{ if $trust_downstream_proxy }}$http_x_forwarded_proto{{ else }}$scheme{{ end }}; + '' $scheme; } map $http_x_forwarded_host $proxy_x_forwarded_host { - default {{ if $trust_downstream_proxy }}$http_x_forwarded_host{{ else }}$http_host{{ end }}; - '' $http_host; + default {{ if $trust_downstream_proxy }}$http_x_forwarded_host{{ else }}$http_host{{ end }}; + '' $http_host; } # If we receive X-Forwarded-Port, pass it through; otherwise, pass along the # server port the client connected to map $http_x_forwarded_port $proxy_x_forwarded_port { - default {{ if $trust_downstream_proxy }}$http_x_forwarded_port{{ else }}$server_port{{ end }}; - '' $server_port; + default {{ if $trust_downstream_proxy }}$http_x_forwarded_port{{ else }}$server_port{{ end }}; + '' $server_port; } # If we receive Upgrade, set Connection to "upgrade"; otherwise, preserve # NGINX's default behavior ("Connection: close"). map $http_upgrade $proxy_connection { - default upgrade; - '' close; + default upgrade; + '' close; } # Apply fix for very long server names @@ -184,8 +184,8 @@ ssl_dhparam /etc/nginx/dhparam/dhparam.pem; # Set appropriate X-Forwarded-Ssl header based on $proxy_x_forwarded_proto map $proxy_x_forwarded_proto $proxy_x_forwarded_ssl { - default off; - https on; + default off; + https on; } gzip_types text/plain text/css application/javascript application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript; @@ -231,208 +231,207 @@ proxy_set_header Proxy ""; {{- $enable_ipv6 := parseBool (coalesce $.Env.ENABLE_IPV6 "false") }} server { - server_name _; # This is just an invalid value which will never trigger on a real hostname. - server_tokens off; - listen {{ $external_http_port }}; - {{- if $enable_ipv6 }} - listen [::]:{{ $external_http_port }}; - {{- end }} - {{ $access_log }} - return 503; + server_name _; # This is just an invalid value which will never trigger on a real hostname. + server_tokens off; + listen {{ $external_http_port }}; +{{- if $enable_ipv6 }} + listen [::]:{{ $external_http_port }}; +{{- end }} + {{ $access_log }} + return 503; {{- if (and (exists "/etc/nginx/certs/default.crt") (exists "/etc/nginx/certs/default.key")) }} - listen {{ $external_https_port }} ssl http2; - {{- if $enable_ipv6 }} - listen [::]:{{ $external_https_port }} ssl http2; - {{- end }} + listen {{ $external_https_port }} ssl http2; + {{- if $enable_ipv6 }} + listen [::]:{{ $external_https_port }} ssl http2; + {{- end }} - ssl_session_cache shared:SSL:50m; - ssl_session_tickets off; - ssl_certificate /etc/nginx/certs/default.crt; - ssl_certificate_key /etc/nginx/certs/default.key; + ssl_session_cache shared:SSL:50m; + ssl_session_tickets off; + ssl_certificate /etc/nginx/certs/default.crt; + ssl_certificate_key /etc/nginx/certs/default.key; {{- end }} } {{- range $host, $containers := groupByMulti $ "Env.VIRTUAL_HOST" "," }} -{{- $host := trim $host }} -{{- $is_regexp := hasPrefix "~" $host }} -{{- $upstream_name := when (or $is_regexp $sha1_upstream_name) (sha1 $host) $host }} + {{- $host := trim $host }} + {{- $is_regexp := hasPrefix "~" $host }} + {{- $upstream_name := when (or $is_regexp $sha1_upstream_name) (sha1 $host) $host }} -{{- $paths := groupBy $containers "Env.VIRTUAL_PATH" }} -{{- $nPaths := len $paths }} + {{- $paths := groupBy $containers "Env.VIRTUAL_PATH" }} + {{- $nPaths := len $paths }} + {{- if eq $nPaths 0 }} + {{- $paths = dict "/" $containers }} + {{- end }} -{{- if eq $nPaths 0 }} - {{- $paths = dict "/" $containers }} -{{- end }} + {{- range $path, $containers := $paths }} + {{- $upstream := $upstream_name }} + {{- if gt $nPaths 0 }} + {{- $sum := sha1 $path }} + {{- $upstream = printf "%s-%s" $upstream $sum }} + {{- end }} +# {{ $host }}{{ $path }} +{{ template "upstream" (dict "Upstream" $upstream "Containers" $containers "Networks" $CurrentContainer.Networks "Debug" $debug_all) }} + {{- end }} -{{- range $path, $containers := $paths }} - {{- $upstream := $upstream_name }} - {{- if gt $nPaths 0 }} - {{- $sum := sha1 $path }} - {{- $upstream = printf "%s-%s" $upstream $sum }} - {{- end }} - # {{ $host }}{{ $path }} - {{ template "upstream" (dict "Upstream" $upstream "Containers" $containers "Networks" $CurrentContainer.Networks "Debug" $debug_all) }} -{{- end }} + {{- $default_host := or ($.Env.DEFAULT_HOST) "" }} + {{- $default_server := index (dict $host "" $default_host "default_server") $host }} -{{- $default_host := or ($.Env.DEFAULT_HOST) "" }} -{{- $default_server := index (dict $host "" $default_host "default_server") $host }} - -{{- /* Get the SERVER_TOKENS defined by containers w/ the same vhost, falling back to "" */}} -{{- $server_tokens := trim (or (first (groupByKeys $containers "Env.SERVER_TOKENS")) "") }} + {{- /* Get the SERVER_TOKENS defined by containers w/ the same vhost, falling back to "" */}} + {{- $server_tokens := trim (or (first (groupByKeys $containers "Env.SERVER_TOKENS")) "") }} -{{- /* Get the HTTPS_METHOD defined by containers w/ the same vhost, falling back to "redirect" */}} -{{- $https_method := or (first (groupByKeys $containers "Env.HTTPS_METHOD")) (or $.Env.HTTPS_METHOD "redirect") }} + {{- /* Get the HTTPS_METHOD defined by containers w/ the same vhost, falling back to "redirect" */}} + {{- $https_method := or (first (groupByKeys $containers "Env.HTTPS_METHOD")) (or $.Env.HTTPS_METHOD "redirect") }} -{{- /* Get the SSL_POLICY defined by containers w/ the same vhost, falling back to empty string (use default) */}} -{{- $ssl_policy := or (first (groupByKeys $containers "Env.SSL_POLICY")) "" }} + {{- /* Get the SSL_POLICY defined by containers w/ the same vhost, falling back to empty string (use default) */}} + {{- $ssl_policy := or (first (groupByKeys $containers "Env.SSL_POLICY")) "" }} -{{- /* Get the HSTS defined by containers w/ the same vhost, falling back to "max-age=31536000" */}} -{{- $hsts := or (first (groupByKeys $containers "Env.HSTS")) (or $.Env.HSTS "max-age=31536000") }} + {{- /* Get the HSTS defined by containers w/ the same vhost, falling back to "max-age=31536000" */}} + {{- $hsts := or (first (groupByKeys $containers "Env.HSTS")) (or $.Env.HSTS "max-age=31536000") }} -{{- /* Get the VIRTUAL_ROOT By containers w/ use fastcgi root */}} -{{- $vhost_root := or (first (groupByKeys $containers "Env.VIRTUAL_ROOT")) "/var/www/public" }} + {{- /* Get the VIRTUAL_ROOT By containers w/ use fastcgi root */}} + {{- $vhost_root := or (first (groupByKeys $containers "Env.VIRTUAL_ROOT")) "/var/www/public" }} -{{- /* Get the first cert name defined by containers w/ the same vhost */}} -{{- $certName := (first (groupByKeys $containers "Env.CERT_NAME")) }} + {{- /* Get the first cert name defined by containers w/ the same vhost */}} + {{- $certName := (first (groupByKeys $containers "Env.CERT_NAME")) }} -{{- /* Get the best matching cert by name for the vhost. */}} -{{- $vhostCert := (closest (dir "/etc/nginx/certs") (printf "%s.crt" $host))}} + {{- /* Get the best matching cert by name for the vhost. */}} + {{- $vhostCert := (closest (dir "/etc/nginx/certs") (printf "%s.crt" $host))}} -{{- /* vhostCert is actually a filename so remove any suffixes since they are added later */}} -{{- $vhostCert := trimSuffix ".crt" $vhostCert }} -{{- $vhostCert := trimSuffix ".key" $vhostCert }} + {{- /* vhostCert is actually a filename so remove any suffixes since they are added later */}} + {{- $vhostCert := trimSuffix ".crt" $vhostCert }} + {{- $vhostCert := trimSuffix ".key" $vhostCert }} -{{- /* Use the cert specified on the container or fallback to the best vhost match */}} -{{- $cert := (coalesce $certName $vhostCert) }} + {{- /* Use the cert specified on the container or fallback to the best vhost match */}} + {{- $cert := (coalesce $certName $vhostCert) }} -{{- $is_https := (and (ne $https_method "nohttps") (ne $cert "") (exists (printf "/etc/nginx/certs/%s.crt" $cert)) (exists (printf "/etc/nginx/certs/%s.key" $cert))) }} + {{- $is_https := (and (ne $https_method "nohttps") (ne $cert "") (exists (printf "/etc/nginx/certs/%s.crt" $cert)) (exists (printf "/etc/nginx/certs/%s.key" $cert))) }} -{{- if and $is_https (eq $https_method "redirect") }} + {{- if and $is_https (eq $https_method "redirect") }} server { - server_name {{ $host }}; - {{- if $server_tokens }} - server_tokens {{ $server_tokens }}; - {{- end }} - listen {{ $external_http_port }} {{ $default_server }}; - {{- if $enable_ipv6 }} - listen [::]:{{ $external_http_port }} {{ $default_server }}; - {{- end }} - {{ $access_log }} + server_name {{ $host }}; + {{- if $server_tokens }} + server_tokens {{ $server_tokens }}; + {{- end }} + listen {{ $external_http_port }} {{ $default_server }}; + {{- if $enable_ipv6 }} + listen [::]:{{ $external_http_port }} {{ $default_server }}; + {{- end }} + {{ $access_log }} - # Do not HTTPS redirect Let'sEncrypt ACME challenge - location ^~ /.well-known/acme-challenge/ { - auth_basic off; - auth_request off; - allow all; - root /usr/share/nginx/html; - try_files $uri =404; - break; - } + # Do not HTTPS redirect Let's Encrypt ACME challenge + location ^~ /.well-known/acme-challenge/ { + auth_basic off; + auth_request off; + allow all; + root /usr/share/nginx/html; + try_files $uri =404; + break; + } - location / { - {{- if eq $external_https_port "443" }} - return 301 https://$host$request_uri; - {{- else }} - return 301 https://$host:{{ $external_https_port }}$request_uri; - {{- end }} - } + location / { + {{- if eq $external_https_port "443" }} + return 301 https://$host$request_uri; + {{- else }} + return 301 https://$host:{{ $external_https_port }}$request_uri; + {{- end }} + } } -{{- end }} + {{- end }} server { - server_name {{ $host }}; - {{- if $server_tokens }} - server_tokens {{ $server_tokens }}; - {{- end }} - {{ $access_log }} + server_name {{ $host }}; + {{- if $server_tokens }} + server_tokens {{ $server_tokens }}; + {{- end }} + {{ $access_log }} {{- if or (not $is_https) (eq $https_method "noredirect") }} - listen {{ $external_http_port }} {{ $default_server }}; - {{- if $enable_ipv6 }} - listen [::]:{{ $external_http_port }} {{ $default_server }}; - {{- end }} + listen {{ $external_http_port }} {{ $default_server }}; + {{- if $enable_ipv6 }} + listen [::]:{{ $external_http_port }} {{ $default_server }}; + {{- end }} {{- end }} {{- if $is_https }} - listen {{ $external_https_port }} ssl http2 {{ $default_server }}; - {{- if $enable_ipv6 }} - listen [::]:{{ $external_https_port }} ssl http2 {{ $default_server }}; - {{- end }} + listen {{ $external_https_port }} ssl http2 {{ $default_server }}; + {{- if $enable_ipv6 }} + listen [::]:{{ $external_https_port }} ssl http2 {{ $default_server }}; + {{- end }} - {{- template "ssl_policy" (dict "ssl_policy" $ssl_policy) }} + {{- template "ssl_policy" (dict "ssl_policy" $ssl_policy) }} - ssl_session_timeout 5m; - ssl_session_cache shared:SSL:50m; - ssl_session_tickets off; + ssl_session_timeout 5m; + ssl_session_cache shared:SSL:50m; + ssl_session_tickets off; - ssl_certificate /etc/nginx/certs/{{ (printf "%s.crt" $cert) }}; - ssl_certificate_key /etc/nginx/certs/{{ (printf "%s.key" $cert) }}; + ssl_certificate /etc/nginx/certs/{{ (printf "%s.crt" $cert) }}; + ssl_certificate_key /etc/nginx/certs/{{ (printf "%s.key" $cert) }}; - {{- if (exists (printf "/etc/nginx/certs/%s.dhparam.pem" $cert)) }} - ssl_dhparam {{ printf "/etc/nginx/certs/%s.dhparam.pem" $cert }}; - {{- end }} + {{- if (exists (printf "/etc/nginx/certs/%s.dhparam.pem" $cert)) }} + ssl_dhparam {{ printf "/etc/nginx/certs/%s.dhparam.pem" $cert }}; + {{- end }} - {{- if (exists (printf "/etc/nginx/certs/%s.chain.pem" $cert)) }} - ssl_stapling on; - ssl_stapling_verify on; - ssl_trusted_certificate {{ printf "/etc/nginx/certs/%s.chain.pem" $cert }}; - {{- end }} + {{- if (exists (printf "/etc/nginx/certs/%s.chain.pem" $cert)) }} + ssl_stapling on; + ssl_stapling_verify on; + ssl_trusted_certificate {{ printf "/etc/nginx/certs/%s.chain.pem" $cert }}; + {{- end }} - {{- if (not (or (eq $https_method "noredirect") (eq $hsts "off"))) }} - set $sts_header ""; - if ($https) { - set $sts_header "{{ trim $hsts }}"; - } - add_header Strict-Transport-Security $sts_header always; - {{- end }} + {{- if (not (or (eq $https_method "noredirect") (eq $hsts "off"))) }} + set $sts_header ""; + if ($https) { + set $sts_header "{{ trim $hsts }}"; + } + add_header Strict-Transport-Security $sts_header always; + {{- end }} {{- end }} - {{- if (exists (printf "/etc/nginx/vhost.d/%s" $host)) }} - include {{ printf "/etc/nginx/vhost.d/%s" $host }}; - {{- else if (exists "/etc/nginx/vhost.d/default") }} - include /etc/nginx/vhost.d/default; - {{- end }} + {{- if (exists (printf "/etc/nginx/vhost.d/%s" $host)) }} + include {{ printf "/etc/nginx/vhost.d/%s" $host }}; + {{- else if (exists "/etc/nginx/vhost.d/default") }} + include /etc/nginx/vhost.d/default; + {{- end }} - {{- range $path, $containers := $paths }} - {{- /* Get the VIRTUAL_PROTO defined by containers w/ the same vhost-vpath, falling back to "http" */}} - {{- $proto := trim (or (first (groupByKeys $containers "Env.VIRTUAL_PROTO")) "http") }} + {{- range $path, $containers := $paths }} + {{- /* Get the VIRTUAL_PROTO defined by containers w/ the same vhost-vpath, falling back to "http" */}} + {{- $proto := trim (or (first (groupByKeys $containers "Env.VIRTUAL_PROTO")) "http") }} - {{- /* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external" */}} - {{- $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} - {{- $upstream := $upstream_name }} - {{- $dest := "" }} - {{- if gt $nPaths 0 }} - {{- $sum := sha1 $path }} - {{- $upstream = printf "%s-%s" $upstream $sum }} - {{- $dest = (or (first (groupByKeys $containers "Env.VIRTUAL_DEST")) "") }} - {{- end }} - {{- template "location" (dict "Path" $path "Proto" $proto "Upstream" $upstream "Host" $host "VhostRoot" $vhost_root "Dest" $dest "NetworkTag" $network_tag) }} - {{- end }} - {{- if (not (contains $paths "/")) }} - location / { - return {{ $default_root_response }}; - } - {{- end }} + {{- /* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external" */}} + {{- $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} + {{- $upstream := $upstream_name }} + {{- $dest := "" }} + {{- if gt $nPaths 0 }} + {{- $sum := sha1 $path }} + {{- $upstream = printf "%s-%s" $upstream $sum }} + {{- $dest = (or (first (groupByKeys $containers "Env.VIRTUAL_DEST")) "") }} + {{- end }} + {{- template "location" (dict "Path" $path "Proto" $proto "Upstream" $upstream "Host" $host "VhostRoot" $vhost_root "Dest" $dest "NetworkTag" $network_tag) }} + {{- end }} + {{- if (not (contains $paths "/")) }} + location / { + return {{ $default_root_response }}; + } + {{- end }} } -{{- if (and (not $is_https) (exists "/etc/nginx/certs/default.crt") (exists "/etc/nginx/certs/default.key")) }} + {{- if (and (not $is_https) (exists "/etc/nginx/certs/default.crt") (exists "/etc/nginx/certs/default.key")) }} server { - server_name {{ $host }}; - {{- if $server_tokens }} - server_tokens {{ $server_tokens }}; - {{- end }} - listen {{ $external_https_port }} ssl http2 {{ $default_server }}; - {{- if $enable_ipv6 }} - listen [::]:{{ $external_https_port }} ssl http2 {{ $default_server }}; - {{- end }} - {{ $access_log }} - return 500; + server_name {{ $host }}; + {{- if $server_tokens }} + server_tokens {{ $server_tokens }}; + {{- end }} + listen {{ $external_https_port }} ssl http2 {{ $default_server }}; + {{- if $enable_ipv6 }} + listen [::]:{{ $external_https_port }} ssl http2 {{ $default_server }}; + {{- end }} + {{ $access_log }} + return 500; - ssl_certificate /etc/nginx/certs/default.crt; - ssl_certificate_key /etc/nginx/certs/default.key; + ssl_certificate /etc/nginx/certs/default.crt; + ssl_certificate_key /etc/nginx/certs/default.key; } -{{- end }} + {{- end }} {{- end }} From 1b253cd9086133fa0f9caa0e5b9a00a9aead4681 Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Mon, 9 Jan 2023 17:21:35 -0500 Subject: [PATCH 10/11] chore: Wrap long comments --- nginx.tmpl | 68 +++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 54 insertions(+), 14 deletions(-) diff --git a/nginx.tmpl b/nginx.tmpl index 2cb0fe4..4f90880 100644 --- a/nginx.tmpl +++ b/nginx.tmpl @@ -11,9 +11,15 @@ {{- define "ssl_policy" }} {{- if eq .ssl_policy "Mozilla-Modern" }} ssl_protocols TLSv1.3; - {{- /* nginx currently lacks ability to choose ciphers in TLS 1.3 in configuration, see https://trac.nginx.org/nginx/ticket/1529 */}} - {{- /* a possible workaround can be modify /etc/ssl/openssl.cnf to change it globally (see https://trac.nginx.org/nginx/ticket/1529#comment:12 ) */}} - {{- /* explicitly set ngnix default value in order to allow single servers to override the global http value */}} + {{- /* + * nginx currently lacks ability to choose ciphers in TLS 1.3 in + * configuration; see https://trac.nginx.org/nginx/ticket/1529. A + * possible workaround can be modify /etc/ssl/openssl.cnf to change + * it globally (see + * https://trac.nginx.org/nginx/ticket/1529#comment:12). Explicitly + * set ngnix default value in order to allow single servers to + * override the global http value. + */}} ssl_ciphers HIGH:!aNULL:!MD5; ssl_prefer_server_ciphers off; {{- else if eq .ssl_policy "Mozilla-Intermediate" }} @@ -110,12 +116,19 @@ upstream {{ .Upstream }} { {{- if (and (ne $containerNetwork.Name "ingress") (or (eq $knownNetwork.Name $containerNetwork.Name) (eq $knownNetwork.Name "host"))) }} ## Can be connected with "{{ $containerNetwork.Name }}" network {{- if $address }} - {{- /* If we got the containers from swarm and this container's port is published to host, use host IP:PORT */}} + {{- /* + * If we got the containers from swarm and this + * container's port is published to host, use host + * IP:PORT. + */}} {{- if and $container.Node.ID $address.HostPort }} {{- $server_found = true }} # {{ $container.Node.Name }}/{{ $container.Name }} server {{ $container.Node.Address.IP }}:{{ $address.HostPort }}; - {{- /* If there is no swarm node or the port is not published on host, use container's IP:PORT */}} + {{- /* + * If there is no swarm node or the port is not + * published on host, use container's IP:PORT. + */}} {{- else if $containerNetwork }} {{- $server_found = true }} # {{ $container.Name }} @@ -197,7 +210,10 @@ log_format vhost '$host $remote_addr - $remote_user [$time_local] ' access_log off; -{{- /* Get the SSL_POLICY defined by this container, falling back to "Mozilla-Intermediate" */}} +{{- /* + * Get the SSL_POLICY defined by this container, falling back to + * "Mozilla-Intermediate". + */}} {{- $ssl_policy := or ($.Env.SSL_POLICY) "Mozilla-Intermediate" }} {{- template "ssl_policy" (dict "ssl_policy" $ssl_policy) }} error_log /dev/stderr; @@ -278,17 +294,29 @@ server { {{- $default_host := or ($.Env.DEFAULT_HOST) "" }} {{- $default_server := index (dict $host "" $default_host "default_server") $host }} - {{- /* Get the SERVER_TOKENS defined by containers w/ the same vhost, falling back to "" */}} + {{- /* + * Get the SERVER_TOKENS defined by containers w/ the same vhost, + * falling back to "". + */}} {{- $server_tokens := trim (or (first (groupByKeys $containers "Env.SERVER_TOKENS")) "") }} - {{- /* Get the HTTPS_METHOD defined by containers w/ the same vhost, falling back to "redirect" */}} + {{- /* + * Get the HTTPS_METHOD defined by containers w/ the same vhost, falling + * back to "redirect". + */}} {{- $https_method := or (first (groupByKeys $containers "Env.HTTPS_METHOD")) (or $.Env.HTTPS_METHOD "redirect") }} - {{- /* Get the SSL_POLICY defined by containers w/ the same vhost, falling back to empty string (use default) */}} + {{- /* + * Get the SSL_POLICY defined by containers w/ the same vhost, falling + * back to empty string (use default). + */}} {{- $ssl_policy := or (first (groupByKeys $containers "Env.SSL_POLICY")) "" }} - {{- /* Get the HSTS defined by containers w/ the same vhost, falling back to "max-age=31536000" */}} + {{- /* + * Get the HSTS defined by containers w/ the same vhost, falling back to + * "max-age=31536000". + */}} {{- $hsts := or (first (groupByKeys $containers "Env.HSTS")) (or $.Env.HSTS "max-age=31536000") }} {{- /* Get the VIRTUAL_ROOT By containers w/ use fastcgi root */}} @@ -301,11 +329,17 @@ server { {{- /* Get the best matching cert by name for the vhost. */}} {{- $vhostCert := (closest (dir "/etc/nginx/certs") (printf "%s.crt" $host))}} - {{- /* vhostCert is actually a filename so remove any suffixes since they are added later */}} + {{- /* + * vhostCert is actually a filename so remove any suffixes since they + * are added later. + */}} {{- $vhostCert := trimSuffix ".crt" $vhostCert }} {{- $vhostCert := trimSuffix ".key" $vhostCert }} - {{- /* Use the cert specified on the container or fallback to the best vhost match */}} + {{- /* + * Use the cert specified on the container or fallback to the best vhost + * match. + */}} {{- $cert := (coalesce $certName $vhostCert) }} {{- $is_https := (and (ne $https_method "nohttps") (ne $cert "") (exists (printf "/etc/nginx/certs/%s.crt" $cert)) (exists (printf "/etc/nginx/certs/%s.key" $cert))) }} @@ -395,10 +429,16 @@ server { {{- end }} {{- range $path, $containers := $paths }} - {{- /* Get the VIRTUAL_PROTO defined by containers w/ the same vhost-vpath, falling back to "http" */}} + {{- /* + * Get the VIRTUAL_PROTO defined by containers w/ the same + * vhost-vpath, falling back to "http". + */}} {{- $proto := trim (or (first (groupByKeys $containers "Env.VIRTUAL_PROTO")) "http") }} - {{- /* Get the NETWORK_ACCESS defined by containers w/ the same vhost, falling back to "external" */}} + {{- /* + * Get the NETWORK_ACCESS defined by containers w/ the same vhost, + * falling back to "external". + */}} {{- $network_tag := or (first (groupByKeys $containers "Env.NETWORK_ACCESS")) "external" }} {{- $upstream := $upstream_name }} {{- $dest := "" }} From 2427b383b5beedc5a04bb2e8fb91c66795539fcc Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Sat, 14 Jan 2023 22:59:33 -0500 Subject: [PATCH 11/11] chore: Move global variables to a `$globals` dict Planned future changes will introduce more embedded templates, and the ability to pass the globals to the templates will be useful. --- nginx.tmpl | 116 +++++++++++++++++++++++++++-------------------------- 1 file changed, 60 insertions(+), 56 deletions(-) diff --git a/nginx.tmpl b/nginx.tmpl index 4f90880..fb4f76f 100644 --- a/nginx.tmpl +++ b/nginx.tmpl @@ -1,12 +1,24 @@ -{{- $CurrentContainer := where $ "ID" .Docker.CurrentContainerID | first }} - -{{- $nginx_proxy_version := coalesce $.Env.NGINX_PROXY_VERSION "" }} -{{- $external_http_port := coalesce $.Env.HTTP_PORT "80" }} -{{- $external_https_port := coalesce $.Env.HTTPS_PORT "443" }} -{{- $debug_all := $.Env.DEBUG }} -{{- $sha1_upstream_name := parseBool (coalesce $.Env.SHA1_UPSTREAM_NAME "false") }} -{{- $default_root_response := coalesce $.Env.DEFAULT_ROOT "404" }} -{{- $trust_downstream_proxy := parseBool (coalesce $.Env.TRUST_DOWNSTREAM_PROXY "true") }} +{{- /* + * Global values. Values are stored in this map rather than in individual + * global variables so that the values can be easily passed to embedded + * templates. (Go templates cannot access variables outside of their own + * scope.) + */}} +{{- $globals := dict }} +{{- $_ := set $globals "containers" $ }} +{{- $_ := set $globals "Env" $.Env }} +{{- $_ := set $globals "Docker" $.Docker }} +{{- $_ := set $globals "CurrentContainer" (where $globals.containers "ID" $globals.Docker.CurrentContainerID | first) }} +{{- $_ := set $globals "nginx_proxy_version" (coalesce $globals.Env.NGINX_PROXY_VERSION "") }} +{{- $_ := set $globals "external_http_port" (coalesce $globals.Env.HTTP_PORT "80") }} +{{- $_ := set $globals "external_https_port" (coalesce $globals.Env.HTTPS_PORT "443") }} +{{- $_ := set $globals "debug_all" $globals.Env.DEBUG }} +{{- $_ := set $globals "sha1_upstream_name" (parseBool (coalesce $globals.Env.SHA1_UPSTREAM_NAME "false")) }} +{{- $_ := set $globals "default_root_response" (coalesce $globals.Env.DEFAULT_ROOT "404") }} +{{- $_ := set $globals "trust_downstream_proxy" (parseBool (coalesce $globals.Env.TRUST_DOWNSTREAM_PROXY "true")) }} +{{- $_ := set $globals "access_log" (or (and (not $globals.Env.DISABLE_ACCESS_LOGS) "access_log /var/log/nginx/access.log vhost;") "") }} +{{- $_ := set $globals "enable_ipv6" (parseBool (coalesce $globals.Env.ENABLE_IPV6 "false")) }} +{{- $_ := set $globals "ssl_policy" (or ($globals.Env.SSL_POLICY) "Mozilla-Intermediate") }} {{- define "ssl_policy" }} {{- if eq .ssl_policy "Mozilla-Modern" }} @@ -157,26 +169,26 @@ upstream {{ .Upstream }} { } {{- end }} -{{- if ne $nginx_proxy_version "" }} -# nginx-proxy version : {{ $nginx_proxy_version }} +{{- if ne $globals.nginx_proxy_version "" }} +# nginx-proxy version : {{ $globals.nginx_proxy_version }} {{- end }} # If we receive X-Forwarded-Proto, pass it through; otherwise, pass along the # scheme used to connect to this server map $http_x_forwarded_proto $proxy_x_forwarded_proto { - default {{ if $trust_downstream_proxy }}$http_x_forwarded_proto{{ else }}$scheme{{ end }}; + default {{ if $globals.trust_downstream_proxy }}$http_x_forwarded_proto{{ else }}$scheme{{ end }}; '' $scheme; } map $http_x_forwarded_host $proxy_x_forwarded_host { - default {{ if $trust_downstream_proxy }}$http_x_forwarded_host{{ else }}$http_host{{ end }}; + default {{ if $globals.trust_downstream_proxy }}$http_x_forwarded_host{{ else }}$http_host{{ end }}; '' $http_host; } # If we receive X-Forwarded-Port, pass it through; otherwise, pass along the # server port the client connected to map $http_x_forwarded_port $proxy_x_forwarded_port { - default {{ if $trust_downstream_proxy }}$http_x_forwarded_port{{ else }}$server_port{{ end }}; + default {{ if $globals.trust_downstream_proxy }}$http_x_forwarded_port{{ else }}$server_port{{ end }}; '' $server_port; } @@ -210,16 +222,11 @@ log_format vhost '$host $remote_addr - $remote_user [$time_local] ' access_log off; -{{- /* - * Get the SSL_POLICY defined by this container, falling back to - * "Mozilla-Intermediate". - */}} -{{- $ssl_policy := or ($.Env.SSL_POLICY) "Mozilla-Intermediate" }} -{{- template "ssl_policy" (dict "ssl_policy" $ssl_policy) }} +{{- template "ssl_policy" (dict "ssl_policy" $globals.ssl_policy) }} error_log /dev/stderr; -{{- if $.Env.RESOLVERS }} -resolver {{ $.Env.RESOLVERS }}; +{{- if $globals.Env.RESOLVERS }} +resolver {{ $globals.Env.RESOLVERS }}; {{- end }} {{- if (exists "/etc/nginx/proxy.conf") }} @@ -243,23 +250,20 @@ proxy_set_header X-Original-URI $request_uri; proxy_set_header Proxy ""; {{- end }} -{{- $access_log := (or (and (not $.Env.DISABLE_ACCESS_LOGS) "access_log /var/log/nginx/access.log vhost;") "") }} - -{{- $enable_ipv6 := parseBool (coalesce $.Env.ENABLE_IPV6 "false") }} server { server_name _; # This is just an invalid value which will never trigger on a real hostname. server_tokens off; - listen {{ $external_http_port }}; -{{- if $enable_ipv6 }} - listen [::]:{{ $external_http_port }}; + listen {{ $globals.external_http_port }}; +{{- if $globals.enable_ipv6 }} + listen [::]:{{ $globals.external_http_port }}; {{- end }} - {{ $access_log }} + {{ $globals.access_log }} return 503; {{- if (and (exists "/etc/nginx/certs/default.crt") (exists "/etc/nginx/certs/default.key")) }} - listen {{ $external_https_port }} ssl http2; - {{- if $enable_ipv6 }} - listen [::]:{{ $external_https_port }} ssl http2; + listen {{ $globals.external_https_port }} ssl http2; + {{- if $globals.enable_ipv6 }} + listen [::]:{{ $globals.external_https_port }} ssl http2; {{- end }} ssl_session_cache shared:SSL:50m; @@ -269,11 +273,11 @@ server { {{- end }} } -{{- range $host, $containers := groupByMulti $ "Env.VIRTUAL_HOST" "," }} +{{- range $host, $containers := groupByMulti $globals.containers "Env.VIRTUAL_HOST" "," }} {{- $host := trim $host }} {{- $is_regexp := hasPrefix "~" $host }} - {{- $upstream_name := when (or $is_regexp $sha1_upstream_name) (sha1 $host) $host }} + {{- $upstream_name := when (or $is_regexp $globals.sha1_upstream_name) (sha1 $host) $host }} {{- $paths := groupBy $containers "Env.VIRTUAL_PATH" }} {{- $nPaths := len $paths }} @@ -288,10 +292,10 @@ server { {{- $upstream = printf "%s-%s" $upstream $sum }} {{- end }} # {{ $host }}{{ $path }} -{{ template "upstream" (dict "Upstream" $upstream "Containers" $containers "Networks" $CurrentContainer.Networks "Debug" $debug_all) }} +{{ template "upstream" (dict "Upstream" $upstream "Containers" $containers "Networks" $globals.CurrentContainer.Networks "Debug" $globals.debug_all) }} {{- end }} - {{- $default_host := or ($.Env.DEFAULT_HOST) "" }} + {{- $default_host := or ($globals.Env.DEFAULT_HOST) "" }} {{- $default_server := index (dict $host "" $default_host "default_server") $host }} {{- /* @@ -305,7 +309,7 @@ server { * Get the HTTPS_METHOD defined by containers w/ the same vhost, falling * back to "redirect". */}} - {{- $https_method := or (first (groupByKeys $containers "Env.HTTPS_METHOD")) (or $.Env.HTTPS_METHOD "redirect") }} + {{- $https_method := or (first (groupByKeys $containers "Env.HTTPS_METHOD")) (or $globals.Env.HTTPS_METHOD "redirect") }} {{- /* * Get the SSL_POLICY defined by containers w/ the same vhost, falling @@ -317,7 +321,7 @@ server { * Get the HSTS defined by containers w/ the same vhost, falling back to * "max-age=31536000". */}} - {{- $hsts := or (first (groupByKeys $containers "Env.HSTS")) (or $.Env.HSTS "max-age=31536000") }} + {{- $hsts := or (first (groupByKeys $containers "Env.HSTS")) (or $globals.Env.HSTS "max-age=31536000") }} {{- /* Get the VIRTUAL_ROOT By containers w/ use fastcgi root */}} {{- $vhost_root := or (first (groupByKeys $containers "Env.VIRTUAL_ROOT")) "/var/www/public" }} @@ -350,11 +354,11 @@ server { {{- if $server_tokens }} server_tokens {{ $server_tokens }}; {{- end }} - listen {{ $external_http_port }} {{ $default_server }}; - {{- if $enable_ipv6 }} - listen [::]:{{ $external_http_port }} {{ $default_server }}; + listen {{ $globals.external_http_port }} {{ $default_server }}; + {{- if $globals.enable_ipv6 }} + listen [::]:{{ $globals.external_http_port }} {{ $default_server }}; {{- end }} - {{ $access_log }} + {{ $globals.access_log }} # Do not HTTPS redirect Let's Encrypt ACME challenge location ^~ /.well-known/acme-challenge/ { @@ -367,10 +371,10 @@ server { } location / { - {{- if eq $external_https_port "443" }} + {{- if eq $globals.external_https_port "443" }} return 301 https://$host$request_uri; {{- else }} - return 301 https://$host:{{ $external_https_port }}$request_uri; + return 301 https://$host:{{ $globals.external_https_port }}$request_uri; {{- end }} } } @@ -381,17 +385,17 @@ server { {{- if $server_tokens }} server_tokens {{ $server_tokens }}; {{- end }} - {{ $access_log }} + {{ $globals.access_log }} {{- if or (not $is_https) (eq $https_method "noredirect") }} - listen {{ $external_http_port }} {{ $default_server }}; - {{- if $enable_ipv6 }} - listen [::]:{{ $external_http_port }} {{ $default_server }}; + listen {{ $globals.external_http_port }} {{ $default_server }}; + {{- if $globals.enable_ipv6 }} + listen [::]:{{ $globals.external_http_port }} {{ $default_server }}; {{- end }} {{- end }} {{- if $is_https }} - listen {{ $external_https_port }} ssl http2 {{ $default_server }}; - {{- if $enable_ipv6 }} - listen [::]:{{ $external_https_port }} ssl http2 {{ $default_server }}; + listen {{ $globals.external_https_port }} ssl http2 {{ $default_server }}; + {{- if $globals.enable_ipv6 }} + listen [::]:{{ $globals.external_https_port }} ssl http2 {{ $default_server }}; {{- end }} {{- template "ssl_policy" (dict "ssl_policy" $ssl_policy) }} @@ -451,7 +455,7 @@ server { {{- end }} {{- if (not (contains $paths "/")) }} location / { - return {{ $default_root_response }}; + return {{ $globals.default_root_response }}; } {{- end }} } @@ -462,11 +466,11 @@ server { {{- if $server_tokens }} server_tokens {{ $server_tokens }}; {{- end }} - listen {{ $external_https_port }} ssl http2 {{ $default_server }}; - {{- if $enable_ipv6 }} - listen [::]:{{ $external_https_port }} ssl http2 {{ $default_server }}; + listen {{ $globals.external_https_port }} ssl http2 {{ $default_server }}; + {{- if $globals.enable_ipv6 }} + listen [::]:{{ $globals.external_https_port }} ssl http2 {{ $default_server }}; {{- end }} - {{ $access_log }} + {{ $globals.access_log }} return 500; ssl_certificate /etc/nginx/certs/default.crt;