ef176dcf7e
conversions were done using https://github.com/pennae/nix-doc-munge using (probably) rev f34e145 running nix-doc-munge nixos/**/*.nix nix-doc-munge --import nixos/**/*.nix the tool ensures that only changes that could affect the generated manual *but don't* are committed, other changes require manual review and are discarded.
77 lines
2.1 KiB
Nix
77 lines
2.1 KiB
Nix
{ cfg }:
|
||
{ config, lib, name, ... }:
|
||
let
|
||
inherit (lib) literalExpression mkOption types;
|
||
in
|
||
{
|
||
options = {
|
||
|
||
hostName = mkOption {
|
||
type = types.str;
|
||
default = name;
|
||
description = lib.mdDoc "Canonical hostname for the server.";
|
||
};
|
||
|
||
serverAliases = mkOption {
|
||
type = with types; listOf str;
|
||
default = [ ];
|
||
example = [ "www.example.org" "example.org" ];
|
||
description = lib.mdDoc ''
|
||
Additional names of virtual hosts served by this virtual host configuration.
|
||
'';
|
||
};
|
||
|
||
listenAddresses = mkOption {
|
||
type = with types; listOf str;
|
||
description = lib.mdDoc ''
|
||
A list of host interfaces to bind to for this virtual host.
|
||
'';
|
||
default = [ ];
|
||
example = [ "127.0.0.1" "::1" ];
|
||
};
|
||
|
||
useACMEHost = mkOption {
|
||
type = types.nullOr types.str;
|
||
default = null;
|
||
description = lib.mdDoc ''
|
||
A host of an existing Let's Encrypt certificate to use.
|
||
This is mostly useful if you use DNS challenges but Caddy does not
|
||
currently support your provider.
|
||
|
||
*Note that this option does not create any certificates, nor
|
||
does it add subdomains to existing ones – you will need to create them
|
||
manually using [](#opt-security.acme.certs).*
|
||
'';
|
||
};
|
||
|
||
logFormat = mkOption {
|
||
type = types.lines;
|
||
default = ''
|
||
output file ${cfg.logDir}/access-${config.hostName}.log
|
||
'';
|
||
defaultText = ''
|
||
output file ''${config.services.caddy.logDir}/access-''${hostName}.log
|
||
'';
|
||
example = literalExpression ''
|
||
mkForce '''
|
||
output discard
|
||
''';
|
||
'';
|
||
description = lib.mdDoc ''
|
||
Configuration for HTTP request logging (also known as access logs). See
|
||
<https://caddyserver.com/docs/caddyfile/directives/log#log>
|
||
for details.
|
||
'';
|
||
};
|
||
|
||
extraConfig = mkOption {
|
||
type = types.lines;
|
||
default = "";
|
||
description = lib.mdDoc ''
|
||
Additional lines of configuration appended to this virtual host in the
|
||
automatically generated `Caddyfile`.
|
||
'';
|
||
};
|
||
|
||
};
|
||
}
|