commit 60a3d9dd6b3216902626fabf6b7b8d5dbcd358db · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       820
       820
        
         ./services/web-apps/icingaweb2/icingaweb2.nix

     

       821
       821
        
         ./services/web-apps/icingaweb2/module-monitoring.nix

     

       822
       822
        
         ./services/web-apps/ihatemoney

     

       823
       823
       +
         ./services/web-apps/jirafeau.nix

     

       823
       824
        
         ./services/web-apps/limesurvey.nix

     

       824
       825
        
         ./services/web-apps/mattermost.nix

     

       825
       826
        
         ./services/web-apps/mediawiki.nix

+169

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

···

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

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       let

     

       5
       5
       +
         cfg = config.services.jirafeau;

     

       6
       6
       +
       

     

       7
       7
       +
         group = config.services.nginx.group;

     

       8
       8
       +
         user = config.services.nginx.user;

     

       9
       9
       +
       

     

       10
       10
       +
         withTrailingSlash = str: if hasSuffix "/" str then str else "${str}/";

     

       11
       11
       +
       

     

       12
       12
       +
         localConfig = pkgs.writeText "config.local.php" ''

     

       13
       13
       +
           <?php

     

       14
       14
       +
             $cfg['admin_password'] = '${cfg.adminPasswordSha256}';

     

       15
       15
       +
             $cfg['web_root'] = 'http://${withTrailingSlash cfg.hostName}';

     

       16
       16
       +
             $cfg['var_root'] = '${withTrailingSlash cfg.dataDir}';

     

       17
       17
       +
             $cfg['maximal_upload_size'] = ${builtins.toString cfg.maxUploadSizeMegabytes};

     

       18
       18
       +
             $cfg['installation_done'] = true;

     

       19
       19
       +
       

     

       20
       20
       +
             ${cfg.extraConfig}

     

       21
       21
       +
         '';

     

       22
       22
       +
       in

     

       23
       23
       +
       {

     

       24
       24
       +
         options.services.jirafeau = {

     

       25
       25
       +
           adminPasswordSha256 = mkOption {

     

       26
       26
       +
             type = types.str;

     

       27
       27
       +
             default = "";

     

       28
       28
       +
             description = ''

     

       29
       29
       +
               SHA-256 of the desired administration password. Leave blank/unset for no password.

     

       30
       30
       +
             '';

     

       31
       31
       +
           };

     

       32
       32
       +
       

     

       33
       33
       +
           dataDir = mkOption {

     

       34
       34
       +
             type = types.path;

     

       35
       35
       +
             default = "/var/lib/jirafeau/data/";

     

       36
       36
       +
             description = "Location of Jirafeau storage directory.";

     

       37
       37
       +
           };

     

       38
       38
       +
       

     

       39
       39
       +
           enable = mkEnableOption "Jirafeau file upload application.";

     

       40
       40
       +
       

     

       41
       41
       +
           extraConfig = mkOption {

     

       42
       42
       +
             type = types.lines;

     

       43
       43
       +
             default = "";

     

       44
       44
       +
             example = ''

     

       45
       45
       +
               $cfg['style'] = 'courgette';

     

       46
       46
       +
               $cfg['organisation'] = 'ACME';

     

       47
       47
       +
             '';

     

       48
       48
       +
             description = let

     

       49
       49
       +
               documentationLink =

     

       50
       50
       +
                 "https://gitlab.com/mojo42/Jirafeau/-/blob/${cfg.package.version}/lib/config.original.php";

     

       51
       51
       +
             in

     

       52
       52
       +
               ''

     

       53
       53
       +
                 Jirefeau configuration. Refer to <link xlink:href="${documentationLink}"/> for supported

     

       54
       54
       +
                 values.

     

       55
       55
       +
               '';

     

       56
       56
       +
           };

     

       57
       57
       +
       

     

       58
       58
       +
           hostName = mkOption {

     

       59
       59
       +
             type = types.str;

     

       60
       60
       +
             default = "localhost";

     

       61
       61
       +
             description = "URL of instance. Must have trailing slash.";

     

       62
       62
       +
           };

     

       63
       63
       +
       

     

       64
       64
       +
           maxUploadSizeMegabytes = mkOption {

     

       65
       65
       +
             type = types.int;

     

       66
       66
       +
             default = 0;

     

       67
       67
       +
             description = "Maximum upload size of accepted files.";

     

       68
       68
       +
           };

     

       69
       69
       +
       

     

       70
       70
       +
           maxUploadTimeout = mkOption {

     

       71
       71
       +
             type = types.str;

     

       72
       72
       +
             default = "30m";

     

       73
       73
       +
             description = let

     

       74
       74
       +
               nginxCoreDocumentation = "http://nginx.org/en/docs/http/ngx_http_core_module.html";

     

       75
       75
       +
             in

     

       76
       76
       +
               ''

     

       77
       77
       +
                 Timeout for reading client request bodies and headers. Refer to

     

       78
       78
       +
                 <link xlink:href="${nginxCoreDocumentation}#client_body_timeout"/> and

     

       79
       79
       +
                 <link xlink:href="${nginxCoreDocumentation}#client_header_timeout"/> for accepted values.

     

       80
       80
       +
               '';

     

       81
       81
       +
           };

     

       82
       82
       +
       

     

       83
       83
       +
           nginxConfig = mkOption {

     

       84
       84
       +
             type = types.submodule

     

       85
       85
       +
               (import ../web-servers/nginx/vhost-options.nix { inherit config lib; });

     

       86
       86
       +
             default = {};

     

       87
       87
       +
             example = {

     

       88
       88
       +
               serverAliases = [ "wiki.\${config.networking.domain}" ];

     

       89
       89
       +
             };

     

       90
       90
       +
             description = "Extra configuration for the nginx virtual host of Jirafeau.";

     

       91
       91
       +
           };

     

       92
       92
       +
       

     

       93
       93
       +
           package = mkOption {

     

       94
       94
       +
             type = types.package;

     

       95
       95
       +
             default = pkgs.jirafeau;

     

       96
       96
       +
             defaultText = "pkgs.jirafeau";

     

       97
       97
       +
             description = "Jirafeau package to use";

     

       98
       98
       +
             example = "pkgs.jirafeau";

     

       99
       99
       +
           };

     

       100
       100
       +
       

     

       101
       101
       +
           poolConfig = mkOption {

     

       102
       102
       +
             type = with types; attrsOf (oneOf [ str int bool ]);

     

       103
       103
       +
             default = {

     

       104
       104
       +
               "pm" = "dynamic";

     

       105
       105
       +
               "pm.max_children" = 32;

     

       106
       106
       +
               "pm.start_servers" = 2;

     

       107
       107
       +
               "pm.min_spare_servers" = 2;

     

       108
       108
       +
               "pm.max_spare_servers" = 4;

     

       109
       109
       +
               "pm.max_requests" = 500;

     

       110
       110
       +
             };

     

       111
       111
       +
             description = ''

     

       112
       112
       +
               Options for Jirafeau PHP pool. See documentation on <literal>php-fpm.conf</literal> for

     

       113
       113
       +
               details on configuration directives.

     

       114
       114
       +
             '';

     

       115
       115
       +
           };

     

       116
       116
       +
         };

     

       117
       117
       +
       

     

       118
       118
       +
       

     

       119
       119
       +
         config = mkIf cfg.enable {

     

       120
       120
       +
           services = {

     

       121
       121
       +
             nginx = {

     

       122
       122
       +
               enable = true;

     

       123
       123
       +
               virtualHosts."${cfg.hostName}" = mkMerge [

     

       124
       124
       +
                 cfg.nginxConfig

     

       125
       125
       +
                 {

     

       126
       126
       +
                   extraConfig = let

     

       127
       127
       +
                     clientMaxBodySize =

     

       128
       128
       +
                       if cfg.maxUploadSizeMegabytes == 0 then "0" else "${cfg.maxUploadSizeMegabytes}m";

     

       129
       129
       +
                   in

     

       130
       130
       +
                     ''

     

       131
       131
       +
                       index index.php;

     

       132
       132
       +
                       client_max_body_size ${clientMaxBodySize};

     

       133
       133
       +
                       client_body_timeout ${cfg.maxUploadTimeout};

     

       134
       134
       +
                       client_header_timeout ${cfg.maxUploadTimeout};

     

       135
       135
       +
                     '';

     

       136
       136
       +
                   locations = {

     

       137
       137
       +
                     "~ \\.php$".extraConfig = ''

     

       138
       138
       +
                       include ${pkgs.nginx}/conf/fastcgi_params;

     

       139
       139
       +
                       fastcgi_split_path_info ^(.+\.php)(/.+)$;

     

       140
       140
       +
                       fastcgi_index index.php;

     

       141
       141
       +
                       fastcgi_pass unix:${config.services.phpfpm.pools.jirafeau.socket};

     

       142
       142
       +
                       fastcgi_param PATH_INFO $fastcgi_path_info;

     

       143
       143
       +
                       fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;

     

       144
       144
       +
                     '';

     

       145
       145
       +
                   };

     

       146
       146
       +
                   root = mkForce "${cfg.package}";

     

       147
       147
       +
                 }

     

       148
       148
       +
               ];

     

       149
       149
       +
             };

     

       150
       150
       +
       

     

       151
       151
       +
             phpfpm.pools.jirafeau = {

     

       152
       152
       +
               inherit group user;

     

       153
       153
       +
               phpEnv."JIRAFEAU_CONFIG" = "${localConfig}";

     

       154
       154
       +
               settings = {

     

       155
       155
       +
                 "listen.mode" = "0660";

     

       156
       156
       +
                 "listen.owner" = user;

     

       157
       157
       +
                 "listen.group" = group;

     

       158
       158
       +
               } // cfg.poolConfig;

     

       159
       159
       +
             };

     

       160
       160
       +
           };

     

       161
       161
       +
       

     

       162
       162
       +
           systemd.tmpfiles.rules = [

     

       163
       163
       +
             "d ${cfg.dataDir} 0750 ${user} ${group} - -"

     

       164
       164
       +
             "d ${cfg.dataDir}/files/ 0750 ${user} ${group} - -"

     

       165
       165
       +
             "d ${cfg.dataDir}/links/ 0750 ${user} ${group} - -"

     

       166
       166
       +
             "d ${cfg.dataDir}/async/ 0750 ${user} ${group} - -"

     

       167
       167
       +
           ];

     

       168
       168
       +
         };

     

       169
       169
       +
       }

nixos/tests/all-tests.nix

···

       137
       137
        
         jackett = handleTest ./jackett.nix {};

     

       138
       138
        
         jellyfin = handleTest ./jellyfin.nix {};

     

       139
       139
        
         jenkins = handleTest ./jenkins.nix {};

     

       140
       140
       +
         jirafeau = handleTest ./jirafeau.nix {};

     

       140
       141
        
         kafka = handleTest ./kafka.nix {};

     

       141
       142
        
         keepalived = handleTest ./keepalived.nix {};

     

       142
       143
        
         kerberos = handleTest ./kerberos/default.nix {};

+22

nixos/tests/jirafeau.nix

···

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

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       {

     

       6
       6
       +
         name = "jirafeau";

     

       7
       7
       +
         meta.maintainers = with maintainers; [ davidtwco ];

     

       8
       8
       +
       

     

       9
       9
       +
         nodes.machine = { pkgs, ... }: {

     

       10
       10
       +
           services.jirafeau = {

     

       11
       11
       +
             enable = true;

     

       12
       12
       +
           };

     

       13
       13
       +
         };

     

       14
       14
       +
       

     

       15
       15
       +
         testScript = ''

     

       16
       16
       +
           machine.start()

     

       17
       17
       +
           machine.wait_for_unit("phpfpm-jirafeau.service")

     

       18
       18
       +
           machine.wait_for_unit("nginx.service")

     

       19
       19
       +
           machine.wait_for_open_port(80)

     

       20
       20
       +
           machine.succeed("curl -sSfL http://localhost/ | grep 'Jirafeau'")

     

       21
       21
       +
         '';

     

       22
       22
       +
       })