colin/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix docs.

Browse Source
This commit is contained in:
David Warde-Farley 2022-09-26 03:00:16 +01:00 committed by Yt
parent c3e75d4931
commit a81954b818
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
nixos/modules/services/web-servers/caddy/default.nix
View File

@ -159,26 +159,24 @@ in
adapter = mkOption { adapter = mkOption {
default = null; default = null;
example = "nginx"; example = literalExpression "nginx";
type = with types; nullOr str; type = with types; nullOr str;
description = '' description = lib.mdDoc ''
Name of the config adapter to use. Name of the config adapter to use.
See <https://caddyserver.com/docs/config-adapters> See <https://caddyserver.com/docs/config-adapters>
for the full list. for the full list.
If <literal>null</literal> is specified, the <literal>--adapter</literal> If `null` is specified, the `--adapter` argument is omitted when
argument is omitted when starting or restarting Caddy. Notably, this starting or restarting Caddy. Notably, this allows specification of a
allows specification of a configuration file in Caddy's native JSON configuration file in Caddy's native JSON format, as long as the
format, as long as the filename does not start with filename does not start with `Caddyfile` (in which case the `caddyfile`
<literal>Caddyfile</literal> (in which case the adapter is implicitly enabled). See
<literal>caddyfile</literal> adapter is implicitly enabled). See <https://caddyserver.com/docs/command-line#caddy-run> for details.
<link xlink:href="https://caddyserver.com/docs/command-line#caddy-run"/>
for details.
<note><para> ::: {.note}
Any value other than <literal>null</literal> or <literal>caddyfile</literal> Any value other than `null` or `caddyfile` is only valid when providing
is only valid when providing your own <option>configFile</option>. your own `configFile`.
</para></note> :::
''; '';
}; };