cafkafk/nixpkgs
cafkafk/nixpkgs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

Merge pull request #106080 from Ma27/nginx-config-doc

Browse source 
nixos/nginx: improve documentation for `config`
This commit is contained in:
Maximilian Bosch 2020-12-10 21:54:01 +01:00 committed by GitHub
commit 07aff199ad
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
nixos/modules/services/web-servers/nginx/default.nix
View file

@ -390,13 +390,24 @@ in
};
config = mkOption {
type = types.str;
default = "";
description = "
Verbatim nginx.conf configuration.
This is mutually exclusive with the structured configuration
via virtualHosts and the recommendedXyzSettings configuration
options. See appendConfig for appending to the generated http block.
";
description = ''
Verbatim <filename>nginx.conf</filename> configuration.
This is mutually exclusive to any other config option for
<filename>nginx.conf</filename> except for
<itemizedlist>
<listitem><para><xref linkend="opt-services.nginx.appendConfig" />
</para></listitem>
<listitem><para><xref linkend="opt-services.nginx.httpConfig" />
</para></listitem>
<listitem><para><xref linkend="opt-services.nginx.logError" />
</para></listitem>
</itemizedlist>
If additional verbatim config in addition to other options is needed,
<xref linkend="opt-services.nginx.appendConfig" /> should be used instead.
'';
};
appendConfig = mkOption {