docs: improve caddy config example

cachix · Jun 6, 2024 · 43135c5 · 43135c5
1 parent 8485851
commit 43135c5
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/modules/services/caddy.nix b/src/modules/services/caddy.nix
@@ -89,6 +89,12 @@ in
     config = mkOption {
       default = "";
       example = ''
+        # Global options block
+        {
+          debug
+        }
+
+        # Site block
         example.com {
           encode gzip
           log
@@ -98,6 +104,10 @@ in
       type = types.lines;
       description = ''
         Verbatim Caddyfile to use.
+
+        Refer to [https://caddyserver.com/docs/caddyfile](https://caddyserver.com/docs/caddyfile)
+        for more information.
+
         Caddy v2 supports multiple config formats via adapters (see [`services.caddy.adapter`](#servicescaddyconfig)).
       '';
     };