From fbf3e2f4580a9faeac9115e10528bdbfc262839f Mon Sep 17 00:00:00 2001 From: Nicolas Duchon Date: Sun, 3 Nov 2024 11:43:16 +0100 Subject: [PATCH] docs: complete debug endpoint docs --- docs/README.md | 16 ++++++++++++++-- nginx.tmpl | 6 +++--- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index 06e6b23..ecbd724 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1038,19 +1038,29 @@ curl -s -H "Host: test.nginx-proxy.tld" localhost/nginx-proxy-debug | jq ```json { "global": { + "acme_http_challenge": "true", "default_cert_ok": false, + "default_host": null, "default_root_response": "404", "enable_access_log": true, "enable_debug_endpoint": "true", + "enable_http2": "true", + "enable_http3": "false", + "enable_http_on_missing_cert": "true", "enable_ipv6": false, + "enable_json_logs": false, "external_http_port": "80", "external_https_port": "443", - "nginx_proxy_version": "local", + "hsts": "max-age=31536000", + "https_method": "redirect", + "log_format": null, + "log_format_escape": null, + "nginx_proxy_version": "1.6.3", + "resolvers": "127.0.0.11", "sha1_upstream_name": false, "ssl_policy": "Mozilla-Intermediate", "trust_downstream_proxy": true }, - "hostname": "test.nginx-proxy.tld", "request": { "host": "test.nginx-proxy.tld", "http2": "", @@ -1066,10 +1076,12 @@ curl -s -H "Host: test.nginx-proxy.tld" localhost/nginx-proxy-debug | jq "cert_ok": false, "default": false, "enable_debug_endpoint": true, + "hostname": "test.nginx-proxy.tld", "hsts": "max-age=31536000", "http2_enabled": true, "http3_enabled": false, "https_method": "noredirect", + "is_regexp": false, "paths": { "/": { "dest": "", diff --git a/nginx.tmpl b/nginx.tmpl index bdb23e0..ba91048 100644 --- a/nginx.tmpl +++ b/nginx.tmpl @@ -1,10 +1,10 @@ # nginx-proxy{{ if $.Env.NGINX_PROXY_VERSION }} version : {{ $.Env.NGINX_PROXY_VERSION }}{{ end }} {{- /* - * Global values. Values are stored in this map rather than in individual + * 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.) + * templates (Go templates cannot access variables outside of their own + * scope) and displayed in the debug endpoint output. */}} {{- $globals := dict }} {{- $_ := set $globals "containers" $ }}