nixos/modules/services/web-servers/apache-httpd/location-options.nix

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