From fd9eed5bf351ba90c754f2479a56455d101cb597 Mon Sep 17 00:00:00 2001 From: Bryan Richter Date: Mon, 14 Nov 2022 11:38:12 +0200 Subject: [PATCH 1/2] nixos/nginx: Extend acmeFallbackHost documentation This extra example would have saved me a lot of uncertainty and doubt. --- nixos/modules/services/web-servers/nginx/vhost-options.nix | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/nixos/modules/services/web-servers/nginx/vhost-options.nix b/nixos/modules/services/web-servers/nginx/vhost-options.nix index ccf8804943ac..b708f5b3be5c 100644 --- a/nixos/modules/services/web-servers/nginx/vhost-options.nix +++ b/nixos/modules/services/web-servers/nginx/vhost-options.nix @@ -99,6 +99,10 @@ with lib; description = lib.mdDoc '' Host which to proxy requests to if acme challenge is not found. Useful if you want multiple hosts to be able to verify the same domain name. + + For example, you could request certificates for the present domain with + an acme client that is running on another host, which you would specify + here. ''; }; From e3fc19b301f7467df9920cdf721adcb705a783f7 Mon Sep 17 00:00:00 2001 From: Bryan Richter Date: Mon, 14 Nov 2022 12:17:12 +0200 Subject: [PATCH 2/2] nixos/nginx: docs: Update formatting * Capitalize ACME * Use bold instead of ALL CAPS * Tweak sentence structure --- .../services/web-servers/nginx/vhost-options.nix | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/nixos/modules/services/web-servers/nginx/vhost-options.nix b/nixos/modules/services/web-servers/nginx/vhost-options.nix index b708f5b3be5c..e3d4afc074cf 100644 --- a/nixos/modules/services/web-servers/nginx/vhost-options.nix +++ b/nixos/modules/services/web-servers/nginx/vhost-options.nix @@ -88,7 +88,7 @@ with lib; type = types.nullOr types.str; default = "/var/lib/acme/acme-challenge"; description = lib.mdDoc '' - Directory for the acme challenge which is PUBLIC, don't put certs or keys in here. + Directory for the ACME challenge, which is **public**. Don't put certs or keys in here. Set to null to inherit from config.security.acme. ''; }; @@ -97,12 +97,12 @@ with lib; type = types.nullOr types.str; default = null; description = lib.mdDoc '' - Host which to proxy requests to if acme challenge is not found. Useful + Host which to proxy requests to if ACME challenge is not found. Useful if you want multiple hosts to be able to verify the same domain name. - For example, you could request certificates for the present domain with - an acme client that is running on another host, which you would specify - here. + With this option, you could request certificates for the present domain + with an ACME client that is running on another host, which you would + specify here. ''; };