···

       
1
       
 
       
{ config, lib, pkgs, ... }:

     

       
2
       
 
       


     

       
3
       
-
       
with lib;

     

       
4
       
-
       


     

       
5
       
 
       
let

     

       
6
       
 
       


     

       
7
       
 
       
  cfg = config.services.tomcat;

     
···

       
9
       
 
       
in

     

       
10
       
 
       


     

       
11
       
 
       
{

     

       
12
       
-
       


     

       
13
       
 
       
  meta = {

     

       
14
       
-
       
    maintainers = with maintainers; [ danbst ];

     

       
15
       
 
       
  };

     

       
16
       
 
       


     

       
17
       
 
       
  ###### interface

     

       
18
       
 
       


     

       
19
       
 
       
  options = {

     

       
20
       
-
       


     

       
21
       
 
       
    services.tomcat = {

     

       
22
       
-
       
      enable = mkEnableOption (lib.mdDoc "Apache Tomcat");

     

       
23
       
 
       


     

       
24
       
-
       
      package = mkOption {

     

       
25
       
-
       
        type = types.package;

     

       
26
       
-
       
        default = pkgs.tomcat9;

     

       
27
       
-
       
        defaultText = literalExpression "pkgs.tomcat9";

     

       
28
       
-
       
        example = lib.literalExpression "pkgs.tomcat9";

     

       
29
       
-
       
        description = lib.mdDoc ''

     

       
30
       
-
       
          Which tomcat package to use.

     

       
31
       
-
       
        '';

     

       
32
       
-
       
      };

     

       
33
       
 
       


     

       
34
       
-
       
      purifyOnStart = mkOption {

     

       
35
       
-
       
        type = types.bool;

     

       
36
       
 
       
        default = false;

     

       
37
       
 
       
        description = lib.mdDoc ''

     

       
38
       
 
       
          On startup, the `baseDir` directory is populated with various files,

     
···

       
43
       
 
       
        '';

     

       
44
       
 
       
      };

     

       
45
       
 
       


     

       
46
       
-
       
      baseDir = mkOption {

     

       
47
       
 
       
        type = lib.types.path;

     

       
48
       
 
       
        default = "/var/tomcat";

     

       
49
       
 
       
        description = lib.mdDoc ''

     
···

       
53
       
 
       
        '';

     

       
54
       
 
       
      };

     

       
55
       
 
       


     

       
56
       
-
       
      logDirs = mkOption {

     

       
57
       
-
       
        default = [];

     

       
58
       
-
       
        type = types.listOf types.path;

     

       
59
       
 
       
        description = lib.mdDoc "Directories to create in baseDir/logs/";

     

       
60
       
 
       
      };

     

       
61
       
 
       


     

       
62
       
-
       
      extraConfigFiles = mkOption {

     

       
63
       
-
       
        default = [];

     

       
64
       
-
       
        type = types.listOf types.path;

     

       
65
       
 
       
        description = lib.mdDoc "Extra configuration files to pull into the tomcat conf directory";

     

       
66
       
 
       
      };

     

       
67
       
 
       


     

       
68
       
-
       
      extraEnvironment = mkOption {

     

       
69
       
-
       
        type = types.listOf types.str;

     

       
70
       
-
       
        default = [];

     

       
71
       
 
       
        example = [ "ENVIRONMENT=production" ];

     

       
72
       
 
       
        description = lib.mdDoc "Environment Variables to pass to the tomcat service";

     

       
73
       
 
       
      };

     

       
74
       
 
       


     

       
75
       
-
       
      extraGroups = mkOption {

     

       
76
       
-
       
        default = [];

     

       
77
       
-
       
        type = types.listOf types.str;

     

       
78
       
 
       
        example = [ "users" ];

     

       
79
       
 
       
        description = lib.mdDoc "Defines extra groups to which the tomcat user belongs.";

     

       
80
       
 
       
      };

     

       
81
       
 
       


     

       
82
       
-
       
      user = mkOption {

     

       
83
       
-
       
        type = types.str;

     

       
84
       
 
       
        default = "tomcat";

     

       
85
       
 
       
        description = lib.mdDoc "User account under which Apache Tomcat runs.";

     

       
86
       
 
       
      };

     

       
87
       
 
       


     

       
88
       
-
       
      group = mkOption {

     

       
89
       
-
       
        type = types.str;

     

       
90
       
 
       
        default = "tomcat";

     

       
91
       
 
       
        description = lib.mdDoc "Group account under which Apache Tomcat runs.";

     

       
92
       
 
       
      };

     

       
93
       
 
       


     

       
94
       
-
       
      javaOpts = mkOption {

     

       
95
       
-
       
        type = types.either (types.listOf types.str) types.str;

     

       
96
       
 
       
        default = "";

     

       
97
       
 
       
        description = lib.mdDoc "Parameters to pass to the Java Virtual Machine which spawns Apache Tomcat";

     

       
98
       
 
       
      };

     

       
99
       
 
       


     

       
100
       
-
       
      catalinaOpts = mkOption {

     

       
101
       
-
       
        type = types.either (types.listOf types.str) types.str;

     

       
102
       
 
       
        default = "";

     

       
103
       
 
       
        description = lib.mdDoc "Parameters to pass to the Java Virtual Machine which spawns the Catalina servlet container";

     

       
104
       
 
       
      };

     

       
105
       
 
       


     

       
106
       
-
       
      sharedLibs = mkOption {

     

       
107
       
-
       
        type = types.listOf types.str;

     

       
108
       
-
       
        default = [];

     

       
109
       
 
       
        description = lib.mdDoc "List containing JAR files or directories with JAR files which are libraries shared by the web applications";

     

       
110
       
 
       
      };

     

       
111
       
 
       


     

       
112
       
-
       
      serverXml = mkOption {

     

       
113
       
-
       
        type = types.lines;

     

       
114
       
 
       
        default = "";

     

       
115
       
 
       
        description = lib.mdDoc ''

     

       
116
       
 
       
          Verbatim server.xml configuration.

     
···

       
118
       
 
       
        '';

     

       
119
       
 
       
      };

     

       
120
       
 
       


     

       
121
       
-
       
      commonLibs = mkOption {

     

       
122
       
-
       
        type = types.listOf types.str;

     

       
123
       
-
       
        default = [];

     

       
124
       
 
       
        description = lib.mdDoc "List containing JAR files or directories with JAR files which are libraries shared by the web applications and the servlet container";

     

       
125
       
 
       
      };

     

       
126
       
 
       


     

       
127
       
-
       
      webapps = mkOption {

     

       
128
       
-
       
        type = types.listOf types.path;

     

       
129
       
 
       
        default = [ tomcat.webapps ];

     

       
130
       
-
       
        defaultText = literalExpression "[ config.services.tomcat.package.webapps ]";

     

       
131
       
 
       
        description = lib.mdDoc "List containing WAR files or directories with WAR files which are web applications to be deployed on Tomcat";

     

       
132
       
 
       
      };

     

       
133
       
 
       


     

       
134
       
-
       
      virtualHosts = mkOption {

     

       
135
       
-
       
        type = types.listOf (types.submodule {

     

       
136
       
 
       
          options = {

     

       
137
       
-
       
            name = mkOption {

     

       
138
       
-
       
              type = types.str;

     

       
139
       
 
       
              description = lib.mdDoc "name of the virtualhost";

     

       
140
       
 
       
            };

     

       
141
       
-
       
            aliases = mkOption {

     

       
142
       
-
       
              type = types.listOf types.str;

     

       
143
       
 
       
              description = lib.mdDoc "aliases of the virtualhost";

     

       
144
       
-
       
              default = [];

     

       
145
       
 
       
            };

     

       
146
       
-
       
            webapps = mkOption {

     

       
147
       
-
       
              type = types.listOf types.path;

     

       
148
       
 
       
              description = lib.mdDoc ''

     

       
149
       
 
       
                List containing web application WAR files and/or directories containing

     

       
150
       
 
       
                web applications and configuration files for the virtual host.

     

       
151
       
 
       
              '';

     

       
152
       
-
       
              default = [];

     

       
153
       
 
       
            };

     

       
154
       
 
       
          };

     

       
155
       
 
       
        });

     

       
156
       
-
       
        default = [];

     

       
157
       
 
       
        description = lib.mdDoc "List consisting of a virtual host name and a list of web applications to deploy on each virtual host";

     

       
158
       
 
       
      };

     

       
159
       
 
       


     

       
160
       
-
       
      logPerVirtualHost = mkOption {

     

       
161
       
-
       
        type = types.bool;

     

       
162
       
 
       
        default = false;

     

       
163
       
 
       
        description = lib.mdDoc "Whether to enable logging per virtual host.";

     

       
164
       
 
       
      };

     

       
165
       
 
       


     

       
166
       
-
       
      jdk = mkOption {

     

       
167
       
-
       
        type = types.package;

     

       
168
       
-
       
        default = pkgs.jdk;

     

       
169
       
-
       
        defaultText = literalExpression "pkgs.jdk";

     

       
170
       
-
       
        description = lib.mdDoc "Which JDK to use.";

     

       
171
       
-
       
      };

     

       
172
       
 
       


     

       
173
       
 
       
      axis2 = {

     

       
174
       
-
       


     

       
175
       
-
       
        enable = mkOption {

     

       
176
       
-
       
          default = false;

     

       
177
       
-
       
          type = types.bool;

     

       
178
       
-
       
          description = lib.mdDoc "Whether to enable an Apache Axis2 container";

     

       
179
       
-
       
        };

     

       
180
       
 
       


     

       
181
       
-
       
        services = mkOption {

     

       
182
       
-
       
          default = [];

     

       
183
       
-
       
          type = types.listOf types.str;

     

       
184
       
 
       
          description = lib.mdDoc "List containing AAR files or directories with AAR files which are web services to be deployed on Axis2";

     

       
185
       
 
       
        };

     

       
186
       
-
       


     

       
187
       
 
       
      };

     

       
188
       
-
       


     

       
189
       
 
       
    };

     

       
190
       
-
       


     

       
191
       
 
       
  };

     

       
192
       
 
       


     

       
193
       
-
       


     

       
194
       
 
       
  ###### implementation

     

       
195
       
 
       


     

       
196
       
-
       
  config = mkIf config.services.tomcat.enable {

     

       
197
       
 
       


     

       
198
       
 
       
    users.groups.tomcat.gid = config.ids.gids.tomcat;

     

       
199
       
 
       


     

       
200
       
 
       
    users.users.tomcat =

     

       
201
       
-
       
      { uid = config.ids.uids.tomcat;

     

       
0
       
 
       

     

       
202
       
 
       
        description = "Tomcat user";

     

       
203
       
 
       
        home = "/homeless-shelter";

     

       
204
       
 
       
        group = "tomcat";

     
···

       
234
       
 
       
          ln -sfn ${tomcat}/conf/$i ${cfg.baseDir}/conf/`basename $i`

     

       
235
       
 
       
        done

     

       
236
       
 
       


     

       
237
       
-
       
        ${optionalString (cfg.extraConfigFiles != []) ''

     

       
238
       
 
       
          for i in ${toString cfg.extraConfigFiles}; do

     

       
239
       
 
       
            ln -sfn $i ${cfg.baseDir}/conf/`basename $i`

     

       
240
       
 
       
          done

     
···

       
253
       
 
       
            hostElementForVirtualHost = virtualHost: ''

     

       
254
       
 
       
              <Host name="${virtualHost.name}" appBase="virtualhosts/${virtualHost.name}/webapps"

     

       
255
       
 
       
                    unpackWARs="true" autoDeploy="true" xmlValidation="false" xmlNamespaceAware="false">

     

       
256
       
-
       
            '' + concatStrings (innerElementsForVirtualHost virtualHost) + ''

     

       
257
       
 
       
              </Host>

     

       
258
       
 
       
            '';

     

       
259
       
 
       
            innerElementsForVirtualHost = virtualHost:

     

       
260
       
 
       
              (map (alias: ''

     

       
261
       
 
       
                <Alias>${alias}</Alias>

     

       
262
       
 
       
              '') virtualHost.aliases)

     

       
263
       
-
       
              ++ (optional cfg.logPerVirtualHost ''

     

       
264
       
 
       
                <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs/${virtualHost.name}"

     

       
265
       
 
       
                       prefix="${virtualHost.name}_access_log." pattern="combined" resolveHosts="false"/>

     

       
266
       
 
       
              '');

     

       
267
       
-
       
            hostElementsString = concatMapStringsSep "\n" hostElementForVirtualHost cfg.virtualHosts;

     

       
268
       
-
       
            hostElementsSedString = replaceStrings ["\n"] ["\\\n"] hostElementsString;

     

       
269
       
 
       
          in ''

     

       
270
       
 
       
            # Create a modified server.xml which also includes all virtual hosts

     

       
271
       
-
       
            sed -e "/<Engine name=\"Catalina\" defaultHost=\"localhost\">/a\\"${escapeShellArg hostElementsSedString} \

     

       
272
       
 
       
                  ${tomcat}/conf/server.xml > ${cfg.baseDir}/conf/server.xml

     

       
273
       
 
       
          ''

     

       
274
       
 
       
        }

     

       
275
       
-
       
        ${optionalString (cfg.logDirs != []) ''

     

       
276
       
 
       
          for i in ${toString cfg.logDirs}; do

     

       
277
       
 
       
            mkdir -p ${cfg.baseDir}/logs/$i

     

       
278
       
 
       
            chown ${cfg.user}:${cfg.group} ${cfg.baseDir}/logs/$i

     

       
279
       
 
       
          done

     

       
280
       
 
       
        ''}

     

       
281
       
-
       
        ${optionalString cfg.logPerVirtualHost (toString (map (h: ''

     

       
282
       
 
       
          mkdir -p ${cfg.baseDir}/logs/${h.name}

     

       
283
       
 
       
          chown ${cfg.user}:${cfg.group} ${cfg.baseDir}/logs/${h.name}

     

       
284
       
 
       
        '') cfg.virtualHosts))}

     
···

       
345
       
 
       


     

       
346
       
 
       
          # Symlink all the given web applications files or paths into the webapps/ directory

     

       
347
       
 
       
          # of this virtual host

     

       
348
       
-
       
          for i in "${optionalString (virtualHost ? webapps) (toString virtualHost.webapps)}"; do

     

       
349
       
 
       
            if [ -f $i ]; then

     

       
350
       
 
       
              # If the given web application is a file, symlink it into the webapps/ directory

     

       
351
       
 
       
              ln -sfn $i ${cfg.baseDir}/virtualhosts/${virtualHost.name}/webapps/`basename $i`

     
···

       
368
       
 
       
          done

     

       
369
       
 
       
        '') cfg.virtualHosts)}

     

       
370
       
 
       


     

       
371
       
-
       
        ${optionalString cfg.axis2.enable ''

     

       
372
       
 
       
          # Copy the Axis2 web application

     

       
373
       
 
       
          cp -av ${pkgs.axis2}/webapps/axis2 ${cfg.baseDir}/webapps

     

       
374
       
 
       


     
···

       
405
       
 
       
      serviceConfig = {

     

       
406
       
 
       
        Type = "forking";

     

       
407
       
 
       
        PermissionsStartOnly = true;

     

       
408
       
-
       
        PIDFile="/run/tomcat/tomcat.pid";

     

       
409
       
 
       
        RuntimeDirectory = "tomcat";

     

       
410
       
 
       
        User = cfg.user;

     

       
411
       
-
       
        Environment=[

     

       
412
       
 
       
          "CATALINA_BASE=${cfg.baseDir}"

     

       
413
       
 
       
          "CATALINA_PID=/run/tomcat/tomcat.pid"

     

       
414
       
 
       
          "JAVA_HOME='${cfg.jdk}'"

     

···

       
1
       
 
       
{ config, lib, pkgs, ... }:

     

       
2
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
3
       
 
       
let

     

       
4
       
 
       


     

       
5
       
 
       
  cfg = config.services.tomcat;

     
···

       
7
       
 
       
in

     

       
8
       
 
       


     

       
9
       
 
       
{

     

       
0
       
 
       

     

       
10
       
 
       
  meta = {

     

       
11
       
+
       
    maintainers = with lib.maintainers; [ danbst ];

     

       
12
       
 
       
  };

     

       
13
       
 
       


     

       
14
       
 
       
  ###### interface

     

       
15
       
 
       


     

       
16
       
 
       
  options = {

     

       
0
       
 
       

     

       
17
       
 
       
    services.tomcat = {

     

       
18
       
+
       
      enable = lib.mkEnableOption (lib.mdDoc "Apache Tomcat");

     

       
19
       
 
       


     

       
20
       
+
       
      package = lib.mkPackageOptionMD pkgs "tomcat9" { };

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
21
       
 
       


     

       
22
       
+
       
      purifyOnStart = lib.mkOption {

     

       
23
       
+
       
        type = lib.types.bool;

     

       
24
       
 
       
        default = false;

     

       
25
       
 
       
        description = lib.mdDoc ''

     

       
26
       
 
       
          On startup, the `baseDir` directory is populated with various files,

     
···

       
31
       
 
       
        '';

     

       
32
       
 
       
      };

     

       
33
       
 
       


     

       
34
       
+
       
      baseDir = lib.mkOption {

     

       
35
       
 
       
        type = lib.types.path;

     

       
36
       
 
       
        default = "/var/tomcat";

     

       
37
       
 
       
        description = lib.mdDoc ''

     
···

       
41
       
 
       
        '';

     

       
42
       
 
       
      };

     

       
43
       
 
       


     

       
44
       
+
       
      logDirs = lib.mkOption {

     

       
45
       
+
       
        default = [ ];

     

       
46
       
+
       
        type = lib.types.listOf lib.types.path;

     

       
47
       
 
       
        description = lib.mdDoc "Directories to create in baseDir/logs/";

     

       
48
       
 
       
      };

     

       
49
       
 
       


     

       
50
       
+
       
      extraConfigFiles = lib.mkOption {

     

       
51
       
+
       
        default = [ ];

     

       
52
       
+
       
        type = lib.types.listOf lib.types.path;

     

       
53
       
 
       
        description = lib.mdDoc "Extra configuration files to pull into the tomcat conf directory";

     

       
54
       
 
       
      };

     

       
55
       
 
       


     

       
56
       
+
       
      extraEnvironment = lib.mkOption {

     

       
57
       
+
       
        type = lib.types.listOf lib.types.str;

     

       
58
       
+
       
        default = [ ];

     

       
59
       
 
       
        example = [ "ENVIRONMENT=production" ];

     

       
60
       
 
       
        description = lib.mdDoc "Environment Variables to pass to the tomcat service";

     

       
61
       
 
       
      };

     

       
62
       
 
       


     

       
63
       
+
       
      extraGroups = lib.mkOption {

     

       
64
       
+
       
        default = [ ];

     

       
65
       
+
       
        type = lib.types.listOf lib.types.str;

     

       
66
       
 
       
        example = [ "users" ];

     

       
67
       
 
       
        description = lib.mdDoc "Defines extra groups to which the tomcat user belongs.";

     

       
68
       
 
       
      };

     

       
69
       
 
       


     

       
70
       
+
       
      user = lib.mkOption {

     

       
71
       
+
       
        type = lib.types.str;

     

       
72
       
 
       
        default = "tomcat";

     

       
73
       
 
       
        description = lib.mdDoc "User account under which Apache Tomcat runs.";

     

       
74
       
 
       
      };

     

       
75
       
 
       


     

       
76
       
+
       
      group = lib.mkOption {

     

       
77
       
+
       
        type = lib.types.str;

     

       
78
       
 
       
        default = "tomcat";

     

       
79
       
 
       
        description = lib.mdDoc "Group account under which Apache Tomcat runs.";

     

       
80
       
 
       
      };

     

       
81
       
 
       


     

       
82
       
+
       
      javaOpts = lib.mkOption {

     

       
83
       
+
       
        type = lib.types.either (lib.types.listOf lib.types.str) lib.types.str;

     

       
84
       
 
       
        default = "";

     

       
85
       
 
       
        description = lib.mdDoc "Parameters to pass to the Java Virtual Machine which spawns Apache Tomcat";

     

       
86
       
 
       
      };

     

       
87
       
 
       


     

       
88
       
+
       
      catalinaOpts = lib.mkOption {

     

       
89
       
+
       
        type = lib.types.either (lib.types.listOf lib.types.str) lib.types.str;

     

       
90
       
 
       
        default = "";

     

       
91
       
 
       
        description = lib.mdDoc "Parameters to pass to the Java Virtual Machine which spawns the Catalina servlet container";

     

       
92
       
 
       
      };

     

       
93
       
 
       


     

       
94
       
+
       
      sharedLibs = lib.mkOption {

     

       
95
       
+
       
        type = lib.types.listOf lib.types.str;

     

       
96
       
+
       
        default = [ ];

     

       
97
       
 
       
        description = lib.mdDoc "List containing JAR files or directories with JAR files which are libraries shared by the web applications";

     

       
98
       
 
       
      };

     

       
99
       
 
       


     

       
100
       
+
       
      serverXml = lib.mkOption {

     

       
101
       
+
       
        type = lib.types.lines;

     

       
102
       
 
       
        default = "";

     

       
103
       
 
       
        description = lib.mdDoc ''

     

       
104
       
 
       
          Verbatim server.xml configuration.

     
···

       
106
       
 
       
        '';

     

       
107
       
 
       
      };

     

       
108
       
 
       


     

       
109
       
+
       
      commonLibs = lib.mkOption {

     

       
110
       
+
       
        type = lib.types.listOf lib.types.str;

     

       
111
       
+
       
        default = [ ];

     

       
112
       
 
       
        description = lib.mdDoc "List containing JAR files or directories with JAR files which are libraries shared by the web applications and the servlet container";

     

       
113
       
 
       
      };

     

       
114
       
 
       


     

       
115
       
+
       
      webapps = lib.mkOption {

     

       
116
       
+
       
        type = lib.types.listOf lib.types.path;

     

       
117
       
 
       
        default = [ tomcat.webapps ];

     

       
118
       
+
       
        defaultText = lib.literalExpression "[ config.services.tomcat.package.webapps ]";

     

       
119
       
 
       
        description = lib.mdDoc "List containing WAR files or directories with WAR files which are web applications to be deployed on Tomcat";

     

       
120
       
 
       
      };

     

       
121
       
 
       


     

       
122
       
+
       
      virtualHosts = lib.mkOption {

     

       
123
       
+
       
        type = lib.types.listOf (lib.types.submodule {

     

       
124
       
 
       
          options = {

     

       
125
       
+
       
            name = lib.mkOption {

     

       
126
       
+
       
              type = lib.types.str;

     

       
127
       
 
       
              description = lib.mdDoc "name of the virtualhost";

     

       
128
       
 
       
            };

     

       
129
       
+
       
            aliases = lib.mkOption {

     

       
130
       
+
       
              type = lib.types.listOf lib.types.str;

     

       
131
       
 
       
              description = lib.mdDoc "aliases of the virtualhost";

     

       
132
       
+
       
              default = [ ];

     

       
133
       
 
       
            };

     

       
134
       
+
       
            webapps = lib.mkOption {

     

       
135
       
+
       
              type = lib.types.listOf lib.types.path;

     

       
136
       
 
       
              description = lib.mdDoc ''

     

       
137
       
 
       
                List containing web application WAR files and/or directories containing

     

       
138
       
 
       
                web applications and configuration files for the virtual host.

     

       
139
       
 
       
              '';

     

       
140
       
+
       
              default = [ ];

     

       
141
       
 
       
            };

     

       
142
       
 
       
          };

     

       
143
       
 
       
        });

     

       
144
       
+
       
        default = [ ];

     

       
145
       
 
       
        description = lib.mdDoc "List consisting of a virtual host name and a list of web applications to deploy on each virtual host";

     

       
146
       
 
       
      };

     

       
147
       
 
       


     

       
148
       
+
       
      logPerVirtualHost = lib.mkOption {

     

       
149
       
+
       
        type = lib.types.bool;

     

       
150
       
 
       
        default = false;

     

       
151
       
 
       
        description = lib.mdDoc "Whether to enable logging per virtual host.";

     

       
152
       
 
       
      };

     

       
153
       
 
       


     

       
154
       
+
       
      jdk = lib.mkPackageOptionMD pkgs "jdk" { };

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
155
       
 
       


     

       
156
       
 
       
      axis2 = {

     

       
157
       
+
       
        enable = lib.mkEnableOption "Apache Axis2 container";

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
158
       
 
       


     

       
159
       
+
       
        services = lib.mkOption {

     

       
160
       
+
       
          default = [ ];

     

       
161
       
+
       
          type = lib.types.listOf lib.types.str;

     

       
162
       
 
       
          description = lib.mdDoc "List containing AAR files or directories with AAR files which are web services to be deployed on Axis2";

     

       
163
       
 
       
        };

     

       
0
       
 
       

     

       
164
       
 
       
      };

     

       
0
       
 
       

     

       
165
       
 
       
    };

     

       
0
       
 
       

     

       
166
       
 
       
  };

     

       
167
       
 
       


     

       
0
       
 
       

     

       
168
       
 
       
  ###### implementation

     

       
169
       
 
       


     

       
170
       
+
       
  config = lib.mkIf config.services.tomcat.enable {

     

       
171
       
 
       


     

       
172
       
 
       
    users.groups.tomcat.gid = config.ids.gids.tomcat;

     

       
173
       
 
       


     

       
174
       
 
       
    users.users.tomcat =

     

       
175
       
+
       
      {

     

       
176
       
+
       
        uid = config.ids.uids.tomcat;

     

       
177
       
 
       
        description = "Tomcat user";

     

       
178
       
 
       
        home = "/homeless-shelter";

     

       
179
       
 
       
        group = "tomcat";

     
···

       
209
       
 
       
          ln -sfn ${tomcat}/conf/$i ${cfg.baseDir}/conf/`basename $i`

     

       
210
       
 
       
        done

     

       
211
       
 
       


     

       
212
       
+
       
        ${lib.optionalString (cfg.extraConfigFiles != []) ''

     

       
213
       
 
       
          for i in ${toString cfg.extraConfigFiles}; do

     

       
214
       
 
       
            ln -sfn $i ${cfg.baseDir}/conf/`basename $i`

     

       
215
       
 
       
          done

     
···

       
228
       
 
       
            hostElementForVirtualHost = virtualHost: ''

     

       
229
       
 
       
              <Host name="${virtualHost.name}" appBase="virtualhosts/${virtualHost.name}/webapps"

     

       
230
       
 
       
                    unpackWARs="true" autoDeploy="true" xmlValidation="false" xmlNamespaceAware="false">

     

       
231
       
+
       
            '' + lib.concatStrings (innerElementsForVirtualHost virtualHost) + ''

     

       
232
       
 
       
              </Host>

     

       
233
       
 
       
            '';

     

       
234
       
 
       
            innerElementsForVirtualHost = virtualHost:

     

       
235
       
 
       
              (map (alias: ''

     

       
236
       
 
       
                <Alias>${alias}</Alias>

     

       
237
       
 
       
              '') virtualHost.aliases)

     

       
238
       
+
       
              ++ (lib.optional cfg.logPerVirtualHost ''

     

       
239
       
 
       
                <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs/${virtualHost.name}"

     

       
240
       
 
       
                       prefix="${virtualHost.name}_access_log." pattern="combined" resolveHosts="false"/>

     

       
241
       
 
       
              '');

     

       
242
       
+
       
            hostElementsString = lib.concatMapStringsSep "\n" hostElementForVirtualHost cfg.virtualHosts;

     

       
243
       
+
       
            hostElementsSedString = lib.replaceStrings ["\n"] ["\\\n"] hostElementsString;

     

       
244
       
 
       
          in ''

     

       
245
       
 
       
            # Create a modified server.xml which also includes all virtual hosts

     

       
246
       
+
       
            sed -e "/<Engine name=\"Catalina\" defaultHost=\"localhost\">/a\\"${lib.escapeShellArg hostElementsSedString} \

     

       
247
       
 
       
                  ${tomcat}/conf/server.xml > ${cfg.baseDir}/conf/server.xml

     

       
248
       
 
       
          ''

     

       
249
       
 
       
        }

     

       
250
       
+
       
        ${lib.optionalString (cfg.logDirs != []) ''

     

       
251
       
 
       
          for i in ${toString cfg.logDirs}; do

     

       
252
       
 
       
            mkdir -p ${cfg.baseDir}/logs/$i

     

       
253
       
 
       
            chown ${cfg.user}:${cfg.group} ${cfg.baseDir}/logs/$i

     

       
254
       
 
       
          done

     

       
255
       
 
       
        ''}

     

       
256
       
+
       
        ${lib.optionalString cfg.logPerVirtualHost (toString (map (h: ''

     

       
257
       
 
       
          mkdir -p ${cfg.baseDir}/logs/${h.name}

     

       
258
       
 
       
          chown ${cfg.user}:${cfg.group} ${cfg.baseDir}/logs/${h.name}

     

       
259
       
 
       
        '') cfg.virtualHosts))}

     
···

       
320
       
 
       


     

       
321
       
 
       
          # Symlink all the given web applications files or paths into the webapps/ directory

     

       
322
       
 
       
          # of this virtual host

     

       
323
       
+
       
          for i in "${lib.optionalString (virtualHost ? webapps) (toString virtualHost.webapps)}"; do

     

       
324
       
 
       
            if [ -f $i ]; then

     

       
325
       
 
       
              # If the given web application is a file, symlink it into the webapps/ directory

     

       
326
       
 
       
              ln -sfn $i ${cfg.baseDir}/virtualhosts/${virtualHost.name}/webapps/`basename $i`

     
···

       
343
       
 
       
          done

     

       
344
       
 
       
        '') cfg.virtualHosts)}

     

       
345
       
 
       


     

       
346
       
+
       
        ${lib.optionalString cfg.axis2.enable ''

     

       
347
       
 
       
          # Copy the Axis2 web application

     

       
348
       
 
       
          cp -av ${pkgs.axis2}/webapps/axis2 ${cfg.baseDir}/webapps

     

       
349
       
 
       


     
···

       
380
       
 
       
      serviceConfig = {

     

       
381
       
 
       
        Type = "forking";

     

       
382
       
 
       
        PermissionsStartOnly = true;

     

       
383
       
+
       
        PIDFile = "/run/tomcat/tomcat.pid";

     

       
384
       
 
       
        RuntimeDirectory = "tomcat";

     

       
385
       
 
       
        User = cfg.user;

     

       
386
       
+
       
        Environment = [

     

       
387
       
 
       
          "CATALINA_BASE=${cfg.baseDir}"

     

       
388
       
 
       
          "CATALINA_PID=/run/tomcat/tomcat.pid"

     

       
389
       
 
       
          "JAVA_HOME='${cfg.jdk}'"

     

···

       
1
       
-
       
import ./make-test-python.nix ({ pkgs, ... }:

     

       
2
       
-
       


     

       
3
       
-
       
{

     

       
4
       
 
       
  name = "tomcat";

     

       
5
       
 
       


     

       
6
       
 
       
  nodes.machine = { pkgs, ... }: {

     

       
7
       
-
       
    services.tomcat.enable = true;

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
8
       
 
       
  };

     

       
9
       
 
       


     

       
10
       
 
       
  testScript = ''

     

       
11
       
 
       
    machine.wait_for_unit("tomcat.service")

     

       
12
       
 
       
    machine.wait_for_open_port(8080)

     

       
13
       
 
       
    machine.wait_for_file("/var/tomcat/webapps/examples");

     

       
0
       
 
       

     

       
14
       
 
       
    machine.succeed(

     

       
15
       
-
       
        "curl --fail http://localhost:8080/examples/servlets/servlet/HelloWorldExample | grep 'Hello World!'"

     

       
16
       
 
       
    )

     

       
17
       
 
       
    machine.succeed(

     

       
18
       
-
       
        "curl --fail http://localhost:8080/examples/jsp/jsp2/simpletag/hello.jsp | grep 'Hello, world!'"

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
19
       
 
       
    )

     

       
20
       
 
       
  '';

     

       
21
       
 
       
})

     

···

       
1
       
+
       
import ./make-test-python.nix ({ pkgs, ... }: {

     

       
0
       
 
       

     

       
0
       
 
       

     

       
2
       
 
       
  name = "tomcat";

     

       
3
       
 
       


     

       
4
       
 
       
  nodes.machine = { pkgs, ... }: {

     

       
5
       
+
       
    services.tomcat = {

     

       
6
       
+
       
      enable = true;

     

       
7
       
+
       
      axis2.enable = true;

     

       
8
       
+
       
    };

     

       
9
       
 
       
  };

     

       
10
       
 
       


     

       
11
       
 
       
  testScript = ''

     

       
12
       
 
       
    machine.wait_for_unit("tomcat.service")

     

       
13
       
 
       
    machine.wait_for_open_port(8080)

     

       
14
       
 
       
    machine.wait_for_file("/var/tomcat/webapps/examples");

     

       
15
       
+
       


     

       
16
       
 
       
    machine.succeed(

     

       
17
       
+
       
        "curl -sS --fail http://localhost:8080/examples/servlets/servlet/HelloWorldExample | grep 'Hello World!'"

     

       
18
       
 
       
    )

     

       
19
       
 
       
    machine.succeed(

     

       
20
       
+
       
        "curl -sS --fail http://localhost:8080/examples/jsp/jsp2/simpletag/hello.jsp | grep 'Hello, world!'"

     

       
21
       
+
       
    )

     

       
22
       
+
       
    machine.succeed(

     

       
23
       
+
       
        "curl -sS --fail http://localhost:8080/axis2/axis2-web/HappyAxis.jsp | grep 'Found Axis2'"

     

       
24
       
 
       
    )

     

       
25
       
 
       
  '';

     

       
26
       
 
       
})

     

···

       
2
       
 
       


     

       
3
       
 
       
stdenv.mkDerivation rec {

     

       
4
       
 
       
  pname = "axis2";

     

       
5
       
-
       
  version = "1.7.9";

     

       
6
       
 
       


     

       
7
       
 
       
  src = fetchurl {

     

       
8
       
-
       
    url = "http://apache.proserve.nl/axis/axis2/java/core/${version}/${pname}-${version}-bin.zip";

     

       
9
       
-
       
    sha256 = "0dh0s9bfh95wmmw8nyf2yw95biq7d9zmrbg8k4vzcyz1if228lac";

     

       
10
       
 
       
  };

     

       
11
       
 
       


     

       
12
       
 
       
  nativeBuildInputs = [ unzip ];

     
···

       
15
       
 
       


     

       
16
       
 
       
  meta = {

     

       
17
       
 
       
    description = "Web Services / SOAP / WSDL engine, the successor to the widely used Apache Axis SOAP stack";

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
18
       
 
       
    platforms = lib.platforms.unix;

     

       
19
       
 
       
    sourceProvenance = with lib.sourceTypes; [ binaryBytecode ];

     

       
20
       
 
       
    license = lib.licenses.asl20;

     

···

       
2
       
 
       


     

       
3
       
 
       
stdenv.mkDerivation rec {

     

       
4
       
 
       
  pname = "axis2";

     

       
5
       
+
       
  version = "1.8.2";

     

       
6
       
 
       


     

       
7
       
 
       
  src = fetchurl {

     

       
8
       
+
       
    url = "mirror://apache/axis/axis2/java/core/${version}/${pname}-${version}-bin.zip";

     

       
9
       
+
       
    hash = "sha256-oilPVFFpl3F61nVDxcYx/bc81FopS5fzoIdXzeP8brk=";

     

       
10
       
 
       
  };

     

       
11
       
 
       


     

       
12
       
 
       
  nativeBuildInputs = [ unzip ];

     
···

       
15
       
 
       


     

       
16
       
 
       
  meta = {

     

       
17
       
 
       
    description = "Web Services / SOAP / WSDL engine, the successor to the widely used Apache Axis SOAP stack";

     

       
18
       
+
       
    homepage = "https://axis.apache.org/axis2/java/core/";

     

       
19
       
+
       
    changelog = "https://axis.apache.org/axis2/java/core/release-notes/${version}.html";

     

       
20
       
+
       
    maintainers = [ lib.maintainers.anthonyroussel ];

     

       
21
       
 
       
    platforms = lib.platforms.unix;

     

       
22
       
 
       
    sourceProvenance = with lib.sourceTypes; [ binaryBytecode ];

     

       
23
       
 
       
    license = lib.licenses.asl20;

     

···

       
1
       
-
       
{ stdenv, lib, fetchurl }:

     

       
2
       
 
       


     

       
3
       
 
       
let

     

       
4
       
 
       


     

       
5
       
-
       
  common = { versionMajor, versionMinor, sha256 }: stdenv.mkDerivation (rec {

     

       
6
       
 
       
    pname = "apache-tomcat";

     

       
7
       
 
       
    version = "${versionMajor}.${versionMinor}";

     

       
8
       
 
       


     

       
9
       
 
       
    src = fetchurl {

     

       
10
       
-
       
      url = "mirror://apache/tomcat/tomcat-${versionMajor}/v${version}/bin/${pname}-${version}.tar.gz";

     

       
11
       
 
       
      inherit sha256;

     

       
12
       
 
       
    };

     

       
13
       
 
       


     
···

       
20
       
 
       
        mv $out/webapps $webapps/

     

       
21
       
 
       
      '';

     

       
22
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
23
       
 
       
    meta = with lib; {

     

       
24
       
 
       
      homepage = "https://tomcat.apache.org/";

     

       
25
       
 
       
      description = "An implementation of the Java Servlet and JavaServer Pages technologies";

     

       
26
       
 
       
      platforms = platforms.all;

     

       
27
       
-
       
      maintainers = [ ];

     

       
28
       
 
       
      license = [ licenses.asl20 ];

     

       
29
       
 
       
      sourceProvenance = with sourceTypes; [ binaryBytecode ];

     

       
30
       
 
       
    };

     
···

       
33
       
 
       
in {

     

       
34
       
 
       
  tomcat9 = common {

     

       
35
       
 
       
    versionMajor = "9";

     

       
36
       
-
       
    versionMinor = "0.75";

     

       
37
       
-
       
    sha256 = "sha256-VWfKg789z+ns1g3hDsCZFYQ+PsdqUEBeBHCihkGZelk=";

     

       
38
       
 
       
  };

     

       
39
       
 
       


     

       
40
       
 
       
  tomcat10 = common {

     

       
41
       
 
       
    versionMajor = "10";

     

       
42
       
-
       
    versionMinor = "0.27";

     

       
43
       
-
       
    sha256 = "sha256-N2atmOdhVrGx88eXOc9Wziq8kn7IWzTeFyFpir/5HLc=";

     

       
44
       
 
       
  };

     

       
45
       
 
       
}

     

···

       
1
       
+
       
{ stdenv, lib, fetchurl, nixosTests, testers, jre }:

     

       
2
       
 
       


     

       
3
       
 
       
let

     

       
4
       
 
       


     

       
5
       
+
       
  common = { versionMajor, versionMinor, sha256 }: stdenv.mkDerivation (finalAttrs: {

     

       
6
       
 
       
    pname = "apache-tomcat";

     

       
7
       
 
       
    version = "${versionMajor}.${versionMinor}";

     

       
8
       
 
       


     

       
9
       
 
       
    src = fetchurl {

     

       
10
       
+
       
      url = "mirror://apache/tomcat/tomcat-${versionMajor}/v${finalAttrs.version}/bin/${finalAttrs.pname}-${finalAttrs.version}.tar.gz";

     

       
11
       
 
       
      inherit sha256;

     

       
12
       
 
       
    };

     

       
13
       
 
       


     
···

       
20
       
 
       
        mv $out/webapps $webapps/

     

       
21
       
 
       
      '';

     

       
22
       
 
       


     

       
23
       
+
       
    passthru.tests = {

     

       
24
       
+
       
      inherit (nixosTests) tomcat;

     

       
25
       
+
       
      version = testers.testVersion {

     

       
26
       
+
       
        package = finalAttrs.finalPackage;

     

       
27
       
+
       
        command = "JAVA_HOME=${jre} ${finalAttrs.finalPackage}/bin/version.sh";

     

       
28
       
+
       
      };

     

       
29
       
+
       
    };

     

       
30
       
+
       


     

       
31
       
 
       
    meta = with lib; {

     

       
32
       
 
       
      homepage = "https://tomcat.apache.org/";

     

       
33
       
 
       
      description = "An implementation of the Java Servlet and JavaServer Pages technologies";

     

       
34
       
 
       
      platforms = platforms.all;

     

       
35
       
+
       
      maintainers = with maintainers; [ anthonyroussel ];

     

       
36
       
 
       
      license = [ licenses.asl20 ];

     

       
37
       
 
       
      sourceProvenance = with sourceTypes; [ binaryBytecode ];

     

       
38
       
 
       
    };

     
···

       
41
       
 
       
in {

     

       
42
       
 
       
  tomcat9 = common {

     

       
43
       
 
       
    versionMajor = "9";

     

       
44
       
+
       
    versionMinor = "0.82";

     

       
45
       
+
       
    sha256 = "sha256-xvRGXDUkYaHFYacUPg81Xf0xyTbdsc1XP/PmqMR8bQc=";

     

       
46
       
 
       
  };

     

       
47
       
 
       


     

       
48
       
 
       
  tomcat10 = common {

     

       
49
       
 
       
    versionMajor = "10";

     

       
50
       
+
       
    versionMinor = "1.15";

     

       
51
       
+
       
    sha256 = "sha256-cqQW3Dc3sC/1zoidMIGDBNw4G5bnxYvhmHz7U7K6Djg=";

     

       
52
       
 
       
  };

     

       
53
       
 
       
}