modules/websites/location-options.nix

   1 { config, lib, name, ... }:
   2 let
   3   inherit (lib) mkOption types;
   4 in
   5 {
   6   options = {
   7
   8     proxyPass = mkOption {
   9       type = with types; nullOr str;
  10       default = null;
  11       example = "http://www.example.org/";
  12       description = ''
  13         Sets up a simple reverse proxy as described by <link xlink:href="https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html#simple" />.
  14       '';
  15     };
  16
  17     index = mkOption {
  18       type = with types; nullOr str;
  19       default = null;
  20       example = "index.php index.html";
  21       description = ''
  22         Adds DirectoryIndex directive. See <link xlink:href="https://httpd.apache.org/docs/2.4/mod/mod_dir.html#directoryindex" />.
  23       '';
  24     };
  25
  26     alias = mkOption {
  27       type = with types; nullOr path;
  28       default = null;
  29       example = "/your/alias/directory";
  30       description = ''
  31         Alias directory for requests. See <link xlink:href="https://httpd.apache.org/docs/2.4/mod/mod_alias.html#alias" />.
  32       '';
  33     };
  34
  35     extraConfig = mkOption {
  36       type = types.lines;
  37       default = "";
  38       description = ''
  39         These lines go to the end of the location verbatim.
  40       '';
  41     };
  42
  43     priority = mkOption {
  44       type = types.int;
  45       default = 1000;
  46       description = ''
  47         Order of this location block in relation to the others in the vhost.
  48         The semantics are the same as with `lib.mkOrder`. Smaller values have
  49         a greater priority.
  50       '';
  51     };
  52
  53   };
  54 }