summary refs log tree commit diff
path: root/nixos/modules/security
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2023-01-05 06:16:46 +0100
committerpennae <github@quasiparticle.net>2023-01-10 10:32:00 +0100
commitbf92eaebe4afd03f029292f8cf5efa333fd0078a (patch)
tree09d11e228801022c45c3edae5c609e291b3c206b /nixos/modules/security
parentdc7788efb8bcbe68d1183cf7ee281186315802ca (diff)
nixos/manual: generate module chapters with md-to-db.sh
Diffstat (limited to 'nixos/modules/security')
-rw-r--r--nixos/modules/security/acme/default.md (renamed from nixos/modules/security/acme/doc.md)0
-rw-r--r--nixos/modules/security/acme/default.nix5
-rw-r--r--nixos/modules/security/acme/default.xml (renamed from nixos/modules/security/acme/doc.xml)24
3 files changed, 14 insertions, 15 deletions
diff --git a/nixos/modules/security/acme/doc.md b/nixos/modules/security/acme/default.md
index 8ff97b55f6856..8ff97b55f6856 100644
--- a/nixos/modules/security/acme/doc.md
+++ b/nixos/modules/security/acme/default.md
diff --git a/nixos/modules/security/acme/default.nix b/nixos/modules/security/acme/default.nix
index dfa3742daccc2..baa7a516ce34d 100644
--- a/nixos/modules/security/acme/default.nix
+++ b/nixos/modules/security/acme/default.nix
@@ -916,8 +916,7 @@ in {
 
   meta = {
     maintainers = lib.teams.acme.members;
-    # Don't edit the docbook xml directly, edit the md and generate it:
-    # `pandoc doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > doc.xml`
-    doc = ./doc.xml;
+    # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh
+    doc = ./default.xml;
   };
 }
diff --git a/nixos/modules/security/acme/doc.xml b/nixos/modules/security/acme/default.xml
index 42c73300d8b98..766421c623731 100644
--- a/nixos/modules/security/acme/doc.xml
+++ b/nixos/modules/security/acme/default.xml
@@ -19,25 +19,24 @@
     <para>
       To use the ACME module, you must accept the provider’s terms of
       service by setting
-      <xref linkend="opt-security.acme.acceptTerms"></xref> to
+      <xref linkend="opt-security.acme.acceptTerms" /> to
       <literal>true</literal>. The Let’s Encrypt ToS can be found
       <link xlink:href="https://letsencrypt.org/repository/">here</link>.
     </para>
     <para>
       You must also set an email address to be used when creating
       accounts with Let’s Encrypt. You can set this for all certs with
-      <xref linkend="opt-security.acme.defaults.email"></xref> and/or on
-      a per-cert basis with
-      <xref linkend="opt-security.acme.certs._name_.email"></xref>. This
+      <xref linkend="opt-security.acme.defaults.email" /> and/or on a
+      per-cert basis with
+      <xref linkend="opt-security.acme.certs._name_.email" />. This
       address is only used for registration and renewal reminders, and
       cannot be used to administer the certificates in any way.
     </para>
     <para>
       Alternatively, you can use a different ACME server by changing the
-      <xref linkend="opt-security.acme.defaults.server"></xref> option
-      to a provider of your choosing, or just change the server for one
-      cert with
-      <xref linkend="opt-security.acme.certs._name_.server"></xref>.
+      <xref linkend="opt-security.acme.defaults.server" /> option to a
+      provider of your choosing, or just change the server for one cert
+      with <xref linkend="opt-security.acme.certs._name_.server" />.
     </para>
     <para>
       You will need an HTTP server or DNS server for verification. For
@@ -173,7 +172,7 @@ security.acme.certs.&quot;foo.example.com&quot; = {
       <filename>/var/lib/acme/foo.example.com</filename>.
     </para>
     <para>
-      Refer to <xref linkend="ch-options"></xref> for all available
+      Refer to <xref linkend="ch-options" /> for all available
       configuration options for the
       <link linkend="opt-security.acme.certs">security.acme</link>
       module.
@@ -275,9 +274,10 @@ systemd.services.dns-rfc2136-conf = {
     <para>
       You must follow the guide above on configuring DNS-01 validation
       first, however instead of setting the options for one certificate
-      (e.g. <xref linkend="opt-security.acme.certs._name_.dnsProvider"></xref>)
-      you will set them as defaults
-      (e.g. <xref linkend="opt-security.acme.defaults.dnsProvider"></xref>).
+      (e.g.
+      <xref linkend="opt-security.acme.certs._name_.dnsProvider" />) you
+      will set them as defaults (e.g.
+      <xref linkend="opt-security.acme.defaults.dnsProvider" />).
     </para>
     <programlisting>
 # Configure ACME appropriately