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

nginx module: improve documentation

Browse Source
This commit is contained in:
Robin Gloster 2016-05-09 14:46:44 +00:00
parent de8008a1b1
commit 5dd7cf964a
2 changed files with 31 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
nixos/modules/services/web-servers/nginx/default.nix
View File

@ -235,7 +235,7 @@ in
sslDhparam = mkOption {
type = types.nullOr types.path;
default = null;
example = literalExample "/path/to/dhparams.pem";
example = "/path/to/dhparams.pem";
description = "Path to DH parameters file.";
};
@ -246,9 +246,18 @@ in
default = {
localhost = {};
};
example = [];
description = ''
example = literalExample ''
{
"hydra.example.com" = {
forceSSL = true;
enableACME = true;
locations."/" = {
proxyPass = "http://localhost:3000";
};
};
};
'';
description = "Declarative vhost config";
};
};
};

23
nixos/modules/services/web-servers/nginx/vhost-options.nix
View File

@ -21,7 +21,7 @@ with lib;
type = types.nullOr types.int;
default = null;
description = ''
Port for the server. 80 for http
Port for the server. Defaults to 80 for http
and 443 for https (i.e. when enableSSL is set).
'';
};
@ -109,7 +109,17 @@ with lib;
basicAuth = mkOption {
type = types.attrsOf types.str;
default = {};
description = "user = password";
example = literalExample ''
{
user = "password";
};
'';
description = ''
Basic Auth protection for a vhost.
WARNING: This is implemented to store the password in plain text in the
nix store.
'';
};
locations = mkOption {
@ -117,9 +127,14 @@ with lib;
inherit lib;
}));
default = {};
example = {};
description = ''
example = literalExample ''
{
"/" = {
proxyPass = "http://localhost:3000";
};
};
'';
description = "Declarative location config";
};
};
}