aboutsummaryrefslogtreecommitdiff
path: root/modules/websites/location-options.nix
blob: 8ea88f94f973fd73cb28b5e1dc32a68ed28d9e93 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{ config, lib, name, ... }:
let
  inherit (lib) mkOption types;
in
{
  options = {

    proxyPass = mkOption {
      type = with types; nullOr str;
      default = null;
      example = "http://www.example.org/";
      description = ''
        Sets up a simple reverse proxy as described by <link xlink:href="https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html#simple" />.
      '';
    };

    index = mkOption {
      type = with types; nullOr str;
      default = null;
      example = "index.php index.html";
      description = ''
        Adds DirectoryIndex directive. See <link xlink:href="https://httpd.apache.org/docs/2.4/mod/mod_dir.html#directoryindex" />.
      '';
    };

    alias = mkOption {
      type = with types; nullOr path;
      default = null;
      example = "/your/alias/directory";
      description = ''
        Alias directory for requests. See <link xlink:href="https://httpd.apache.org/docs/2.4/mod/mod_alias.html#alias" />.
      '';
    };

    extraConfig = mkOption {
      type = types.lines;
      default = "";
      description = ''
        These lines go to the end of the location verbatim.
      '';
    };

    priority = mkOption {
      type = types.int;
      default = 1000;
      description = ''
        Order of this location block in relation to the others in the vhost.
        The semantics are the same as with `lib.mkOrder`. Smaller values have
        a greater priority.
      '';
    };

  };
}