commit 826418fc35e4cd6e85a88edd389cb249a7aa9671 · pyrox.dev/nixpkgs

+91 -30

nixos/modules/services/web-apps/mediawiki.nix

···

       8
       8
        
         cfg = config.services.mediawiki;

     

       9
       9
        
         fpm = config.services.phpfpm.pools.mediawiki;

     

       10
       10
        
         user = "mediawiki";

     

       11
       11
       -
         group = config.services.httpd.group;

     

       11
       11
       +
         group = if cfg.webserver == "apache" then "apache" else "mediawiki";

     

       12
       12
       +
       

     

       12
       13
        
         cacheDir = "/var/cache/mediawiki";

     

       13
       14
        
         stateDir = "/var/lib/mediawiki";

     

       14
       15
        
       

     
···

       73
       74
        
             $wgScriptPath = "";

     

       74
       75
        
       

     

       75
       76
        
             ## The protocol and server name to use in fully-qualified URLs

     

       76
       76
       -
             $wgServer = "${if cfg.virtualHost.addSSL || cfg.virtualHost.forceSSL || cfg.virtualHost.onlySSL then "https" else "http"}://${cfg.virtualHost.hostName}";

     

       77
       77
       +
             $wgServer = "${cfg.url}";

     

       77
       78
        
       

     

       78
       79
        
             ## The URL path to static resources (images, scripts, etc.)

     

       79
       80
        
             $wgResourceBasePath = $wgScriptPath;

     
···

       87
       88
        
             $wgEnableEmail = true;

     

       88
       89
        
             $wgEnableUserEmail = true; # UPO

     

       89
       90
        
       

     

       90
       90
       -
             $wgEmergencyContact = "${if cfg.virtualHost.adminAddr != null then cfg.virtualHost.adminAddr else config.services.httpd.adminAddr}";

     

       91
       91
       -
             $wgPasswordSender = $wgEmergencyContact;

     

       91
       91
       +
             $wgPasswordSender = "${cfg.passwordSender}";

     

       92
       92
        
       

     

       93
       93
        
             $wgEnotifUserTalk = false; # UPO

     

       94
       94
        
             $wgEnotifWatchlist = false; # UPO

     
···

       190
       190
        
               description = lib.mdDoc "Which MediaWiki package to use.";

     

       191
       191
        
             };

     

       192
       192
        
       

     

       193
       193
       +
             finalPackage = mkOption {

     

       194
       194
       +
               type = types.package;

     

       195
       195
       +
               readOnly = true;

     

       196
       196
       +
               default = pkg;

     

       197
       197
       +
               defaultText = literalExpression "pkg";

     

       198
       198
       +
               description = lib.mdDoc ''

     

       199
       199
       +
                 The final package used by the module. This is the package that will have extensions and skins installed.

     

       200
       200
       +
               '';

     

       201
       201
       +
             };

     

       202
       202
       +
       

     

       193
       203
        
             name = mkOption {

     

       194
       204
        
               type = types.str;

     

       195
       205
        
               default = "MediaWiki";

     
···

       197
       207
        
               description = lib.mdDoc "Name of the wiki.";

     

       198
       208
        
             };

     

       199
       209
        
       

     

       210
       210
       +
             url = mkOption {

     

       211
       211
       +
               type = types.str;

     

       212
       212
       +
               default = if cfg.webserver == "apache" then

     

       213
       213
       +
                   "${if cfg.httpd.virtualHost.addSSL || cfg.httpd.virtualHost.forceSSL || cfg.httpd.virtualHost.onlySSL then "https" else "http"}://${cfg.httpd.virtualHost.hostName}"

     

       214
       214
       +
                 else

     

       215
       215
       +
                   "http://localhost";

     

       216
       216
       +
               defaultText = literalExpression ''

     

       217
       217
       +
                 if cfg.webserver == "apache" then

     

       218
       218
       +
                   "''${if cfg.httpd.virtualHost.addSSL || cfg.httpd.virtualHost.forceSSL || cfg.httpd.virtualHost.onlySSL then "https" else "http"}://''${cfg.httpd.virtualHost.hostName}"

     

       219
       219
       +
                 else

     

       220
       220
       +
                   "http://localhost";

     

       221
       221
       +
               '';

     

       222
       222
       +
               example = "https://wiki.example.org";

     

       223
       223
       +
               description = lib.mdDoc "URL of the wiki.";

     

       224
       224
       +
             };

     

       225
       225
       +
       

     

       200
       226
        
             uploadsDir = mkOption {

     

       201
       227
        
               type = types.nullOr types.path;

     

       202
       228
        
               default = "${stateDir}/uploads";

     
···

       212
       238
        
               example = "/run/keys/mediawiki-password";

     

       213
       239
        
             };

     

       214
       240
        
       

     

       241
       241
       +
             passwordSender = mkOption {

     

       242
       242
       +
               type = types.str;

     

       243
       243
       +
               default =

     

       244
       244
       +
                 if cfg.webserver == "apache" then

     

       245
       245
       +
                   if cfg.httpd.virtualHost.adminAddr != null then

     

       246
       246
       +
                     cfg.httpd.virtualHost.adminAddr

     

       247
       247
       +
                   else

     

       248
       248
       +
                     config.services.httpd.adminAddr else "root@localhost";

     

       249
       249
       +
               defaultText = literalExpression ''

     

       250
       250
       +
                 if cfg.webserver == "apache" then

     

       251
       251
       +
                   if cfg.httpd.virtualHost.adminAddr != null then

     

       252
       252
       +
                     cfg.httpd.virtualHost.adminAddr

     

       253
       253
       +
                   else

     

       254
       254
       +
                     config.services.httpd.adminAddr else "root@localhost"

     

       255
       255
       +
               '';

     

       256
       256
       +
               description = lib.mdDoc "Contact address for password reset.";

     

       257
       257
       +
             };

     

       258
       258
       +
       

     

       215
       259
        
             skins = mkOption {

     

       216
       260
        
               default = {};

     

       217
       261
        
               type = types.attrsOf types.path;

     
···

       241
       285
        
               '';

     

       242
       286
        
             };

     

       243
       287
        
       

     

       288
       288
       +
             webserver = mkOption {

     

       289
       289
       +
               type = types.enum [ "apache" "none" ];

     

       290
       290
       +
               default = "apache";

     

       291
       291
       +
               description = lib.mdDoc "Webserver to use.";

     

       292
       292
       +
             };

     

       293
       293
       +
       

     

       244
       294
        
             database = {

     

       245
       295
        
               type = mkOption {

     

       246
       296
        
                 type = types.enum [ "mysql" "postgres" "sqlite" "mssql" "oracle" ];

     
···

       318
       368
        
               };

     

       319
       369
        
             };

     

       320
       370
        
       

     

       321
       321
       -
             virtualHost = mkOption {

     

       371
       371
       +
             httpd.virtualHost = mkOption {

     

       322
       372
        
               type = types.submodule (import ../web-servers/apache-httpd/vhost-options.nix);

     

       323
       373
        
               example = literalExpression ''

     

       324
       374
        
                 {

     
···

       366
       416
        
           };

     

       367
       417
        
         };

     

       368
       418
        
       

     

       419
       419
       +
         imports = [

     

       420
       420
       +
           (lib.mkRenamedOptionModule [ "services" "mediawiki" "virtualHost" ] [ "services" "mediawiki" "httpd" "virtualHost" ])

     

       421
       421
       +
         ];

     

       422
       422
       +
       

     

       369
       423
        
         # implementation

     

       370
       424
        
         config = mkIf cfg.enable {

     

       371
       425
        
       

     
···

       412
       466
        
           services.phpfpm.pools.mediawiki = {

     

       413
       467
        
             inherit user group;

     

       414
       468
        
             phpEnv.MEDIAWIKI_CONFIG = "${mediawikiConfig}";

     

       415
       415
       -
             settings = {

     

       469
       469
       +
             settings = (if (cfg.webserver == "apache") then {

     

       416
       470
        
               "listen.owner" = config.services.httpd.user;

     

       417
       471
        
               "listen.group" = config.services.httpd.group;

     

       418
       418
       -
             } // cfg.poolConfig;

     

       472
       472
       +
             } else {

     

       473
       473
       +
               "listen.owner" = user;

     

       474
       474
       +
               "listen.group" = group;

     

       475
       475
       +
             }) // cfg.poolConfig;

     

       419
       476
        
           };

     

       420
       477
        
       

     

       421
       421
       -
           services.httpd = {

     

       478
       478
       +
           services.httpd = lib.mkIf (cfg.webserver == "apache") {

     

       422
       479
        
             enable = true;

     

       423
       480
        
             extraModules = [ "proxy_fcgi" ];

     

       424
       424
       -
             virtualHosts.${cfg.virtualHost.hostName} = mkMerge [ cfg.virtualHost {

     

       425
       425
       -
               documentRoot = mkForce "${pkg}/share/mediawiki";

     

       426
       426
       -
               extraConfig = ''

     

       427
       427
       -
                 <Directory "${pkg}/share/mediawiki">

     

       428
       428
       -
                   <FilesMatch "\.php$">

     

       429
       429
       -
                     <If "-f %{REQUEST_FILENAME}">

     

       430
       430
       -
                       SetHandler "proxy:unix:${fpm.socket}|fcgi://localhost/"

     

       431
       431
       -
                     </If>

     

       432
       432
       -
                   </FilesMatch>

     

       481
       481
       +
             virtualHosts.${cfg.httpd.virtualHost.hostName} = mkMerge [

     

       482
       482
       +
               cfg.httpd.virtualHost

     

       483
       483
       +
               {

     

       484
       484
       +
                 documentRoot = mkForce "${pkg}/share/mediawiki";

     

       485
       485
       +
                 extraConfig = ''

     

       486
       486
       +
                   <Directory "${pkg}/share/mediawiki">

     

       487
       487
       +
                     <FilesMatch "\.php$">

     

       488
       488
       +
                       <If "-f %{REQUEST_FILENAME}">

     

       489
       489
       +
                         SetHandler "proxy:unix:${fpm.socket}|fcgi://localhost/"

     

       490
       490
       +
                       </If>

     

       491
       491
       +
                     </FilesMatch>

     

       433
       492
        
       

     

       434
       434
       -
                   Require all granted

     

       435
       435
       -
                   DirectoryIndex index.php

     

       436
       436
       -
                   AllowOverride All

     

       437
       437
       -
                 </Directory>

     

       438
       438
       -
               '' + optionalString (cfg.uploadsDir != null) ''

     

       439
       439
       -
                 Alias "/images" "${cfg.uploadsDir}"

     

       440
       440
       -
                 <Directory "${cfg.uploadsDir}">

     

       441
       441
       -
                   Require all granted

     

       442
       442
       -
                 </Directory>

     

       443
       443
       -
               '';

     

       444
       444
       -
             } ];

     

       493
       493
       +
                     Require all granted

     

       494
       494
       +
                     DirectoryIndex index.php

     

       495
       495
       +
                     AllowOverride All

     

       496
       496
       +
                   </Directory>

     

       497
       497
       +
                 '' + optionalString (cfg.uploadsDir != null) ''

     

       498
       498
       +
                   Alias "/images" "${cfg.uploadsDir}"

     

       499
       499
       +
                   <Directory "${cfg.uploadsDir}">

     

       500
       500
       +
                     Require all granted

     

       501
       501
       +
                   </Directory>

     

       502
       502
       +
                 '';

     

       503
       503
       +
               }

     

       504
       504
       +
             ];

     

       445
       505
        
           };

     

       446
       506
        
       

     

       447
       507
        
           systemd.tmpfiles.rules = [

     
···

       489
       549
        
             };

     

       490
       550
        
           };

     

       491
       551
        
       

     

       492
       492
       -
           systemd.services.httpd.after = optional (cfg.database.createLocally && cfg.database.type == "mysql") "mysql.service"

     

       493
       493
       -
             ++ optional (cfg.database.createLocally && cfg.database.type == "postgres") "postgresql.service";

     

       552
       552
       +
           systemd.services.httpd.after = optional (cfg.webserver == "apache" && cfg.database.createLocally && cfg.database.type == "mysql") "mysql.service"

     

       553
       553
       +
             ++ optional (cfg.webserver == "apache" && cfg.database.createLocally && cfg.database.type == "postgres") "postgresql.service";

     

       494
       554
        
       

     

       495
       555
        
           users.users.${user} = {

     

       496
       556
        
             group = group;

     

       497
       557
        
             isSystemUser = true;

     

       498
       558
        
           };

     

       559
       559
       +
           users.groups.${group} = {};

     

       499
       560
        
       

     

       500
       561
        
           environment.systemPackages = [ mediawikiScripts ];

     

       501
       562
        
         };

+22 -2

nixos/tests/mediawiki.nix

···

       7
       7
        
       let

     

       8
       8
        
         shared = {

     

       9
       9
        
           services.mediawiki.enable = true;

     

       10
       10
       -
           services.mediawiki.virtualHost.hostName = "localhost";

     

       11
       11
       -
           services.mediawiki.virtualHost.adminAddr = "root@example.com";

     

       10
       10
       +
           services.mediawiki.httpd.virtualHost.hostName = "localhost";

     

       11
       11
       +
           services.mediawiki.httpd.virtualHost.adminAddr = "root@example.com";

     

       12
       12
        
           services.mediawiki.passwordFile = pkgs.writeText "password" "correcthorsebatterystaple";

     

       13
       13
        
           services.mediawiki.extensions = {

     

       14
       14
        
             Matomo = pkgs.fetchzip {

     
···

       52
       52
        
       

     

       53
       53
        
             page = machine.succeed("curl -fL http://localhost/")

     

       54
       54
        
             assert "MediaWiki has been installed" in page

     

       55
       55
       +
           '';

     

       56
       56
       +
         };

     

       57
       57
       +
       

     

       58
       58
       +
         nohttpd = testLib.makeTest {

     

       59
       59
       +
           name = "mediawiki-nohttpd";

     

       60
       60
       +
           nodes.machine = {

     

       61
       61
       +
             services.mediawiki.webserver = "none";

     

       62
       62
       +
           };

     

       63
       63
       +
           testScript = { nodes, ... }: ''

     

       64
       64
       +
             start_all()

     

       65
       65
       +
             machine.wait_for_unit("phpfpm-mediawiki.service")

     

       66
       66
       +
             env = (

     

       67
       67
       +
               "SCRIPT_NAME=/index.php",

     

       68
       68
       +
               "SCRIPT_FILENAME=${nodes.machine.services.mediawiki.finalPackage}/share/mediawiki/index.php",

     

       69
       69
       +
               "REMOTE_ADDR=127.0.0.1",

     

       70
       70
       +
               'QUERY_STRING=title=Main_Page',

     

       71
       71
       +
               "REQUEST_METHOD=GET",

     

       72
       72
       +
             );

     

       73
       73
       +
             page = machine.succeed(f"{' '.join(env)} ${pkgs.fcgi}/bin/cgi-fcgi -bind -connect ${nodes.machine.services.phpfpm.pools.mediawiki.socket}")

     

       74
       74
       +
             assert "MediaWiki has been installed" in page, f"no 'MediaWiki has been installed' in:\n{page}"

     

       55
       75
        
           '';

     

       56
       76
        
         };

     

       57
       77
        
       }