···

       
5
       
 
       
  ...

     

       
6
       
 
       
}:

     

       
7
       
 
       


     

       
8
       
-
       
with lib;

     

       
9
       
-
       


     

       
10
       
 
       
let

     

       
11
       
 
       
  cfg = config.services.varnish;

     

       
12
       
 
       


     

       
13
       
 
       
  commandLine =

     

       
14
       
 
       
    "-f ${pkgs.writeText "default.vcl" cfg.config}"

     

       
15
       
 
       
    +

     

       
16
       
-
       
      optionalString (cfg.extraModules != [ ])

     

       
17
       
 
       
        " -p vmod_path='${

     

       
18
       
-
       
           makeSearchPathOutput "lib" "lib/varnish/vmods" ([ cfg.package ] ++ cfg.extraModules)

     

       
19
       
 
       
         }' -r vmod_path";

     

       
20
       
 
       
in

     

       
21
       
 
       
{

     

       
22
       
 
       
  options = {

     

       
23
       
 
       
    services.varnish = {

     

       
24
       
-
       
      enable = mkEnableOption "Varnish Server";

     

       
25
       
 
       


     

       
26
       
-
       
      enableConfigCheck = mkEnableOption "checking the config during build time" // {

     

       
27
       
 
       
        default = true;

     

       
28
       
 
       
      };

     

       
29
       
 
       


     

       
30
       
-
       
      package = mkPackageOption pkgs "varnish" { };

     

       
31
       
 
       


     

       
32
       
-
       
      http_address = mkOption {

     

       
33
       
-
       
        type = types.str;

     

       
34
       
 
       
        default = "*:6081";

     

       
35
       
 
       
        description = ''

     

       
36
       
 
       
          HTTP listen address and port.

     

       
37
       
 
       
        '';

     

       
38
       
 
       
      };

     

       
39
       
 
       


     

       
40
       
-
       
      config = mkOption {

     

       
41
       
-
       
        type = types.lines;

     

       
42
       
 
       
        description = ''

     

       
43
       
 
       
          Verbatim default.vcl configuration.

     

       
44
       
 
       
        '';

     

       
45
       
 
       
      };

     

       
46
       
 
       


     

       
47
       
-
       
      stateDir = mkOption {

     

       
48
       
-
       
        type = types.path;

     

       
49
       
 
       
        default = "/run/varnish/${config.networking.hostName}";

     

       
50
       
-
       
        defaultText = literalExpression ''"/run/varnish/''${config.networking.hostName}"'';

     

       
51
       
 
       
        description = ''

     

       
52
       
 
       
          Directory holding all state for Varnish to run. Note that this should be a tmpfs in order to avoid performance issues and crashes.

     

       
53
       
 
       
        '';

     

       
54
       
 
       
      };

     

       
55
       
-
       


     

       
56
       
-
       
      extraModules = mkOption {

     

       
57
       
-
       
        type = types.listOf types.package;

     

       
58
       
 
       
        default = [ ];

     

       
59
       
-
       
        example = literalExpression "[ pkgs.varnishPackages.geoip ]";

     

       
60
       
 
       
        description = ''

     

       
61
       
 
       
          Varnish modules (except 'std').

     

       
62
       
 
       
        '';

     

       
63
       
 
       
      };

     

       
64
       
 
       


     

       
65
       
-
       
      extraCommandLine = mkOption {

     

       
66
       
-
       
        type = types.str;

     

       
67
       
 
       
        default = "";

     

       
68
       
 
       
        example = "-s malloc,256M";

     

       
69
       
 
       
        description = ''

     
···

       
74
       
 
       


     

       
75
       
 
       
  };

     

       
76
       
 
       


     

       
77
       
-
       
  config = mkIf cfg.enable {

     

       
78
       
-
       


     

       
79
       
 
       
    systemd.services.varnish = {

     

       
80
       
 
       
      description = "Varnish";

     

       
81
       
 
       
      wantedBy = [ "multi-user.target" ];

     

       
82
       
 
       
      after = [ "network.target" ];

     

       
83
       
-
       
      preStart = mkIf (!(lib.hasPrefix "/run/" cfg.stateDir)) ''

     

       
84
       
 
       
        mkdir -p ${cfg.stateDir}

     

       
85
       
 
       
        chown -R varnish:varnish ${cfg.stateDir}

     

       
86
       
 
       
      '';

     

       
87
       
-
       
      postStop = mkIf (!(lib.hasPrefix "/run/" cfg.stateDir)) ''

     

       
88
       
 
       
        rm -rf ${cfg.stateDir}

     

       
89
       
 
       
      '';

     

       
90
       
 
       
      serviceConfig = {

     
···

       
95
       
 
       
        RestartSec = "5s";

     

       
96
       
 
       
        User = "varnish";

     

       
97
       
 
       
        Group = "varnish";

     

       
98
       
-
       
        RuntimeDirectory = mkIf (lib.hasPrefix "/run/" cfg.stateDir) (

     

       
99
       
 
       
          lib.removePrefix "/run/" cfg.stateDir

     

       
100
       
 
       
        );

     

       
101
       
 
       
        AmbientCapabilities = "cap_net_bind_service";

     
···

       
107
       
 
       
    environment.systemPackages = [ cfg.package ];

     

       
108
       
 
       


     

       
109
       
 
       
    # check .vcl syntax at compile time (e.g. before nixops deployment)

     

       
110
       
-
       
    system.checks = mkIf cfg.enableConfigCheck [

     

       
111
       
 
       
      (pkgs.runCommand "check-varnish-syntax" { } ''

     

       
112
       
 
       
        ${cfg.package}/bin/varnishd -C ${commandLine} 2> $out || (cat $out; exit 1)

     

       
113
       
 
       
      '')

     

···

       
5
       
 
       
  ...

     

       
6
       
 
       
}:

     

       
7
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
8
       
 
       
let

     

       
9
       
 
       
  cfg = config.services.varnish;

     

       
10
       
 
       


     

       
11
       
 
       
  commandLine =

     

       
12
       
 
       
    "-f ${pkgs.writeText "default.vcl" cfg.config}"

     

       
13
       
 
       
    +

     

       
14
       
+
       
      lib.optionalString (cfg.extraModules != [ ])

     

       
15
       
 
       
        " -p vmod_path='${

     

       
16
       
+
       
           lib.makeSearchPathOutput "lib" "lib/varnish/vmods" ([ cfg.package ] ++ cfg.extraModules)

     

       
17
       
 
       
         }' -r vmod_path";

     

       
18
       
 
       
in

     

       
19
       
 
       
{

     

       
20
       
 
       
  options = {

     

       
21
       
 
       
    services.varnish = {

     

       
22
       
+
       
      enable = lib.mkEnableOption "Varnish Server";

     

       
23
       
 
       


     

       
24
       
+
       
      enableConfigCheck = lib.mkEnableOption "checking the config during build time" // {

     

       
25
       
 
       
        default = true;

     

       
26
       
 
       
      };

     

       
27
       
 
       


     

       
28
       
+
       
      package = lib.mkPackageOption pkgs "varnish" { };

     

       
29
       
 
       


     

       
30
       
+
       
      http_address = lib.mkOption {

     

       
31
       
+
       
        type = lib.types.str;

     

       
32
       
 
       
        default = "*:6081";

     

       
33
       
 
       
        description = ''

     

       
34
       
 
       
          HTTP listen address and port.

     

       
35
       
 
       
        '';

     

       
36
       
 
       
      };

     

       
37
       
 
       


     

       
38
       
+
       
      config = lib.mkOption {

     

       
39
       
+
       
        type = lib.types.lines;

     

       
40
       
 
       
        description = ''

     

       
41
       
 
       
          Verbatim default.vcl configuration.

     

       
42
       
 
       
        '';

     

       
43
       
 
       
      };

     

       
44
       
 
       


     

       
45
       
+
       
      stateDir = lib.mkOption {

     

       
46
       
+
       
        type = lib.types.path;

     

       
47
       
 
       
        default = "/run/varnish/${config.networking.hostName}";

     

       
48
       
+
       
        defaultText = lib.literalExpression ''"/run/varnish/''${config.networking.hostName}"'';

     

       
49
       
 
       
        description = ''

     

       
50
       
 
       
          Directory holding all state for Varnish to run. Note that this should be a tmpfs in order to avoid performance issues and crashes.

     

       
51
       
 
       
        '';

     

       
52
       
 
       
      };

     

       
53
       
+
       
      extraModules = lib.mkOption {

     

       
54
       
+
       
        type = lib.types.listOf lib.types.package;

     

       
0
       
 
       

     

       
55
       
 
       
        default = [ ];

     

       
56
       
+
       
        example = lib.literalExpression "[ pkgs.varnishPackages.geoip ]";

     

       
57
       
 
       
        description = ''

     

       
58
       
 
       
          Varnish modules (except 'std').

     

       
59
       
 
       
        '';

     

       
60
       
 
       
      };

     

       
61
       
 
       


     

       
62
       
+
       
      extraCommandLine = lib.mkOption {

     

       
63
       
+
       
        type = lib.types.str;

     

       
64
       
 
       
        default = "";

     

       
65
       
 
       
        example = "-s malloc,256M";

     

       
66
       
 
       
        description = ''

     
···

       
71
       
 
       


     

       
72
       
 
       
  };

     

       
73
       
 
       


     

       
74
       
+
       
  config = lib.mkIf cfg.enable {

     

       
0
       
 
       

     

       
75
       
 
       
    systemd.services.varnish = {

     

       
76
       
 
       
      description = "Varnish";

     

       
77
       
 
       
      wantedBy = [ "multi-user.target" ];

     

       
78
       
 
       
      after = [ "network.target" ];

     

       
79
       
+
       
      preStart = lib.mkIf (!(lib.hasPrefix "/run/" cfg.stateDir)) ''

     

       
80
       
 
       
        mkdir -p ${cfg.stateDir}

     

       
81
       
 
       
        chown -R varnish:varnish ${cfg.stateDir}

     

       
82
       
 
       
      '';

     

       
83
       
+
       
      postStop = lib.mkIf (!(lib.hasPrefix "/run/" cfg.stateDir)) ''

     

       
84
       
 
       
        rm -rf ${cfg.stateDir}

     

       
85
       
 
       
      '';

     

       
86
       
 
       
      serviceConfig = {

     
···

       
91
       
 
       
        RestartSec = "5s";

     

       
92
       
 
       
        User = "varnish";

     

       
93
       
 
       
        Group = "varnish";

     

       
94
       
+
       
        RuntimeDirectory = lib.mkIf (lib.hasPrefix "/run/" cfg.stateDir) (

     

       
95
       
 
       
          lib.removePrefix "/run/" cfg.stateDir

     

       
96
       
 
       
        );

     

       
97
       
 
       
        AmbientCapabilities = "cap_net_bind_service";

     
···

       
103
       
 
       
    environment.systemPackages = [ cfg.package ];

     

       
104
       
 
       


     

       
105
       
 
       
    # check .vcl syntax at compile time (e.g. before nixops deployment)

     

       
106
       
+
       
    system.checks = lib.mkIf cfg.enableConfigCheck [

     

       
107
       
 
       
      (pkgs.runCommand "check-varnish-syntax" { } ''

     

       
108
       
 
       
        ${cfg.package}/bin/varnishd -C ${commandLine} 2> $out || (cat $out; exit 1)

     

       
109
       
 
       
      '')