diff options
author | Reuben D'Netto <rdnetto@gmail.com> | 2018-04-05 18:43:56 +1000 |
---|---|---|
committer | Reuben D'Netto <rdnetto@gmail.com> | 2018-04-12 09:39:14 +1000 |
commit | 42a84598fb7baacc991c03e228a07a536bc0624a (patch) | |
tree | a851974a590af5863bc2235e33a4670ce6c72a0c /nixos/modules/security/acme.xml | |
parent | a683d2cd00780cf7d20caeeef44deb4cc60d2add (diff) | |
download | nixpkgs-42a84598fb7baacc991c03e228a07a536bc0624a.tar nixpkgs-42a84598fb7baacc991c03e228a07a536bc0624a.tar.gz nixpkgs-42a84598fb7baacc991c03e228a07a536bc0624a.tar.bz2 nixpkgs-42a84598fb7baacc991c03e228a07a536bc0624a.tar.lz nixpkgs-42a84598fb7baacc991c03e228a07a536bc0624a.tar.xz nixpkgs-42a84598fb7baacc991c03e228a07a536bc0624a.tar.zst nixpkgs-42a84598fb7baacc991c03e228a07a536bc0624a.zip |
Added cross-references to NixOS manual
Diffstat (limited to 'nixos/modules/security/acme.xml')
-rw-r--r-- | nixos/modules/security/acme.xml | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/nixos/modules/security/acme.xml b/nixos/modules/security/acme.xml index 6130ed82ed3..7cdc554989e 100644 --- a/nixos/modules/security/acme.xml +++ b/nixos/modules/security/acme.xml @@ -48,9 +48,9 @@ http { <filename>configuration.nix</filename>: <programlisting> -security.acme.certs."foo.example.com" = { - webroot = "/var/www/challenges"; - email = "foo@example.com"; +<xref linkend="opt-security.acme.certs"/>."foo.example.com" = { + <link linkend="opt-security.acme.certs._name_.webroot">webroot</link> = "/var/www/challenges"; + <link linkend="opt-security.acme.certs._name_.email">email</link> = "foo@example.com"; }; </programlisting> </para> @@ -58,17 +58,17 @@ security.acme.certs."foo.example.com" = { <para>The private key <filename>key.pem</filename> and certificate <filename>fullchain.pem</filename> will be put into <filename>/var/lib/acme/foo.example.com</filename>. The target directory can -be configured with the option <literal>security.acme.directory</literal>. +be configured with the option <xref linkend="opt-security.acme.directory"/>. </para> <para>Refer to <xref linkend="ch-options" /> for all available configuration -options for the <literal>security.acme</literal> module.</para> +options for the <link linkend="opt-security.acme.certs">security.acme</link> module.</para> </section> <section><title>Using ACME certificates in Nginx</title> <para>NixOS supports fetching ACME certificates for you by setting -<literal>enableACME = true;</literal> in a virtualHost config. We + <literal><link linkend="opt-services.nginx.virtualHosts._name_.enableACME">enableACME</link> = true;</literal> in a virtualHost config. We first create self-signed placeholder certificates in place of the real ACME certs. The placeholder certs are overwritten when the ACME certs arrive. For <literal>foo.example.com</literal> the config would @@ -77,13 +77,13 @@ look like. <programlisting> services.nginx = { - enable = true; - virtualHosts = { + <link linkend="opt-services.nginx.enable">enable = true;</link> + <link linkend="opt-services.nginx.virtualHosts">virtualHosts</link> = { "foo.example.com" = { - forceSSL = true; - enableACME = true; + <link linkend="opt-services.nginx.virtualHosts._name_.forceSSL">forceSSL</link> = true; + <link linkend="opt-services.nginx.virtualHosts._name_.enableACME">enableACME</link> = true; locations."/" = { - root = "/var/www"; + <link linkend="opt-services.nginx.virtualHosts._name_.locations._name_.root">root</link> = "/var/www"; }; }; }; |