commit 73fc80e0d7f84d3354137fd26bcb5fd861b2bbaf · pyrox.dev/nixpkgs

+154 -19

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

···

       8
        
       

     

       9
        
         database = "postgres://${cfg.localDatabaseUser}:${cfg.localDatabasePassword}@localhost:5432/${cfg.localDatabaseName}?sslmode=disable&connect_timeout=10";

     

       10
        
       

     

       11
       -
         mattermostConf = recursiveUpdate

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       12
        
           { ServiceSettings.SiteURL = cfg.siteUrl;

     

       13
        
             ServiceSettings.ListenAddress = cfg.listenAddress;

     

       14
        
             TeamSettings.SiteName = cfg.siteName;

     
···

       17
        
           }

     

       18
        
           cfg.extraConfig;

     

       19
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       20
        
         mattermostConfJSON = pkgs.writeText "mattermost-config.json" (builtins.toJSON mattermostConf);

     

       21
        
       

     

       22
        
       in

     
···

       25
        
         options = {

     

       26
        
           services.mattermost = {

     

       27
        
             enable = mkEnableOption "Mattermost chat server";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       28
        
       

     

       29
        
             statePath = mkOption {

     

       30
        
               type = types.str;

     
···

       90
        
               '';

     

       91
        
             };

     

       92
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       93
        
             localDatabaseCreate = mkOption {

     

       94
        
               type = types.bool;

     

       95
        
               default = true;

     
···

       140
        
       

     

       141
        
             matterircd = {

     

       142
        
               enable = mkEnableOption "Mattermost IRC bridge";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       143
        
               parameters = mkOption {

     

       144
        
                 type = types.listOf types.str;

     

       145
        
                 default = [ ];

     
···

       182
        
       

     

       183
        
               preStart = ''

     

       184
        
                 mkdir -p ${cfg.statePath}/{data,config,logs}

     

       185
       -
                 ln -sf ${pkgs.mattermost}/{bin,fonts,i18n,templates,client} ${cfg.statePath}

     

       186
        
               '' + lib.optionalString (!cfg.mutableConfig) ''

     

       187
        
                 rm -f ${cfg.statePath}/config/config.json

     

       188
       -
                 ${pkgs.jq}/bin/jq -s '.[0] * .[1]' ${pkgs.mattermost}/config/config.json ${mattermostConfJSON} > ${cfg.statePath}/config/config.json

     

       189
       -
                 ${pkgs.mattermost}/bin/mattermost config migrate ${cfg.statePath}/config/config.json ${database}

     

       190
        
               '' + lib.optionalString cfg.mutableConfig ''

     

       191
        
                 if ! test -e "${cfg.statePath}/config/.initial-created"; then

     

       192
        
                   rm -f ${cfg.statePath}/config/config.json

     

       193
       -
                   ${pkgs.jq}/bin/jq -s '.[0] * .[1]' ${pkgs.mattermost}/config/config.json ${mattermostConfJSON} > ${cfg.statePath}/config/config.json

     

       194
        
                   touch ${cfg.statePath}/config/.initial-created

     

       195
        
                 fi

     

       196
        
               '' + lib.optionalString (cfg.mutableConfig && cfg.preferNixConfig) ''

     
···

       198
        
       

     

       199
        
                 rm -f ${cfg.statePath}/config/config.json

     

       200
        
                 echo "$newConfig" > ${cfg.statePath}/config/config.json

     

       201
       -
               '' + lib.optionalString cfg.localDatabaseCreate ''

     

       202
       -
                 if ! test -e "${cfg.statePath}/.db-created"; then

     

       203
       -
                   ${pkgs.sudo}/bin/sudo -u ${config.services.postgresql.superUser} \

     

       204
       -
                     ${config.services.postgresql.package}/bin/psql postgres -c \

     

       205
       -
                       "CREATE ROLE ${cfg.localDatabaseUser} WITH LOGIN NOCREATEDB NOCREATEROLE ENCRYPTED PASSWORD '${cfg.localDatabasePassword}'"

     

       206
       -
                   ${pkgs.sudo}/bin/sudo -u ${config.services.postgresql.superUser} \

     

       207
       -
                     ${config.services.postgresql.package}/bin/createdb \

     

       208
       -
                       --owner ${cfg.localDatabaseUser} ${cfg.localDatabaseName}

     

       209
       -
                   touch ${cfg.statePath}/.db-created

     

       210
       -
                 fi

     

       211
       -
               '' + ''

     

       212
        
                 chown ${cfg.user}:${cfg.group} -R ${cfg.statePath}

     

       213
        
                 chmod u+rw,g+r,o-rwx -R ${cfg.statePath}

     

       214
        
               '';

     
···

       217
        
                 PermissionsStartOnly = true;

     

       218
        
                 User = cfg.user;

     

       219
        
                 Group = cfg.group;

     

       220
       -
                 ExecStart = "${pkgs.mattermost}/bin/mattermost" +

     

       221
       -
                   (lib.optionalString (!cfg.mutableConfig) " -c ${database}");

     

       0
        
       
     

       0
        
       
     

       222
        
                 WorkingDirectory = "${cfg.statePath}";

     

       223
        
                 Restart = "always";

     

       224
        
                 RestartSec = "10";

     
···

       234
        
               serviceConfig = {

     

       235
        
                 User = "nobody";

     

       236
        
                 Group = "nogroup";

     

       237
       -
                 ExecStart = "${pkgs.matterircd}/bin/matterircd ${concatStringsSep " " cfg.matterircd.parameters}";

     

       238
        
                 WorkingDirectory = "/tmp";

     

       239
        
                 PrivateTmp = true;

     

       240
        
                 Restart = "always";

···

       8
        
       

     

       9
        
         database = "postgres://${cfg.localDatabaseUser}:${cfg.localDatabasePassword}@localhost:5432/${cfg.localDatabaseName}?sslmode=disable&connect_timeout=10";

     

       10
        
       

     

       11
       +
         postgresPackage = config.services.postgresql.package;

     

       12
       +
       

     

       13
       +
         createDb = {

     

       14
       +
           statePath ? cfg.statePath,

     

       15
       +
           localDatabaseUser ? cfg.localDatabaseUser,

     

       16
       +
           localDatabasePassword ? cfg.localDatabasePassword,

     

       17
       +
           localDatabaseName ? cfg.localDatabaseName,

     

       18
       +
           useSudo ? true

     

       19
       +
         }: ''

     

       20
       +
           if ! test -e "${statePath}/.db-created"; then

     

       21
       +
             ${lib.optionalString useSudo "${pkgs.sudo}/bin/sudo -u ${config.services.postgresql.superUser} \\"}

     

       22
       +
               ${postgresPackage}/bin/psql postgres -c \

     

       23
       +
                 "CREATE ROLE ${localDatabaseUser} WITH LOGIN NOCREATEDB NOCREATEROLE ENCRYPTED PASSWORD '${localDatabasePassword}'"

     

       24
       +
             ${lib.optionalString useSudo "${pkgs.sudo}/bin/sudo -u ${config.services.postgresql.superUser} \\"}

     

       25
       +
               ${postgresPackage}/bin/createdb \

     

       26
       +
                 --owner ${localDatabaseUser} ${localDatabaseName}

     

       27
       +
             touch ${statePath}/.db-created

     

       28
       +
           fi

     

       29
       +
         '';

     

       30
       +
       

     

       31
       +
         mattermostPluginDerivations = with pkgs;

     

       32
       +
           if cfg.plugins == null then null

     

       33
       +
           else map (plugin: stdenv.mkDerivation {

     

       34
       +
             name = "mattermost-plugin";

     

       35
       +
             installPhase = ''

     

       36
       +
               mkdir -p $out/share

     

       37
       +
               cp ${plugin} $out/share/plugin.tar.gz

     

       38
       +
             '';

     

       39
       +
             dontUnpack = true;

     

       40
       +
             dontPatch = true;

     

       41
       +
             dontConfigure = true;

     

       42
       +
             dontBuild = true;

     

       43
       +
             preferLocalBuild = true;

     

       44
       +
           }) cfg.plugins;

     

       45
       +
       

     

       46
       +
         mattermostPlugins = with pkgs;

     

       47
       +
           if cfg.plugins == null then null

     

       48
       +
           else stdenv.mkDerivation {

     

       49
       +
             name = "${cfg.package.name}-plugins";

     

       50
       +
             nativeBuildInputs = [

     

       51
       +
               autoPatchelfHook

     

       52
       +
               postgresPackage

     

       53
       +
             ] ++ mattermostPluginDerivations;

     

       54
       +
             buildInputs = [

     

       55
       +
               cfg.package

     

       56
       +
             ];

     

       57
       +
             installPhase = ''

     

       58
       +
               # Create a temporary Mattermost install to unpack plugins

     

       59
       +
               ln -sf ${cfg.package}/{bin,fonts,i18n,templates,client} .

     

       60
       +
               mkdir -p ./{data,logs}

     

       61
       +
       

     

       62
       +
               # Create the database

     

       63
       +
               db_dir="$(pwd)/db"

     

       64
       +
               db_socket_dir="$db_dir/run"

     

       65
       +
               initdb --no-locale --encoding=utf8 --pgdata="$db_dir"

     

       66
       +
               mkdir -p "$db_socket_dir"

     

       67
       +
               echo "unix_socket_directories = '$db_socket_dir'" >> db/postgresql.conf

     

       68
       +
               echo "listen_addresses = '''" >> db/postgresql.conf

     

       69
       +
       

     

       70
       +
               # Start it

     

       71
       +
               pg_ctl start --pgdata="$db_dir"

     

       72
       +
               cleanup() {

     

       73
       +
                 pg_ctl stop --pgdata="$db_dir"

     

       74
       +
               }

     

       75
       +
               trap cleanup EXIT

     

       76
       +
       

     

       77
       +
               # Create the Mattermost user

     

       78
       +
               export PGHOST="$db_socket_dir"

     

       79
       +
               ${createDb {

     

       80
       +
                 statePath = ".";

     

       81
       +
                 localDatabaseUser = "mattermost";

     

       82
       +
                 localDatabasePassword = "mattermost";

     

       83
       +
                 localDatabaseName = "mattermost";

     

       84
       +
                 useSudo = false;

     

       85
       +
               }}

     

       86
       +
       

     

       87
       +
               # Create destination paths for client and server plugins

     

       88
       +
               mkdir -p $out/client $out/server

     

       89
       +
       

     

       90
       +
               # Create the Mattermost config

     

       91
       +
               ${jq}/bin/jq -s \

     

       92
       +
                 --arg serverPlugins $out/server \

     

       93
       +
                 --arg clientPlugins $out/client \

     

       94
       +
                 --arg socketDir "$db_socket_dir" \ '

     

       95
       +
                 .[0] |

     

       96
       +
                 .PluginSettings.Directory = $serverPlugins |

     

       97
       +
                 .PluginSettings.ClientDirectory = $clientPlugins |

     

       98
       +
                 .SqlSettings.DriverName = "postgres" |

     

       99
       +
                 .SqlSettings.DataSource = "postgres://mattermost:mattermost@/mattermost?host=" + $socketDir

     

       100
       +
               ' ${cfg.package}/config/config.json > $out/config.json

     

       101
       +
       

     

       102
       +
               # Add the plugins

     

       103
       +
               plugins=(${escapeShellArgs (map (plugin: "${plugin}/share/plugin.tar.gz") mattermostPluginDerivations)})

     

       104
       +
               if [ ''${#plugins[@]} -gt 0 ]; then

     

       105
       +
                 mattermost plugin add "''${plugins[@]}" --config $out/config.json

     

       106
       +
               fi

     

       107
       +
             '';

     

       108
       +
       

     

       109
       +
             dontUnpack = true;

     

       110
       +
             dontPatch = true;

     

       111
       +
             dontConfigure = true;

     

       112
       +
             dontBuild = true;

     

       113
       +
             preferLocalBuild = true;

     

       114
       +
           };

     

       115
       +
       

     

       116
       +
         mattermostConfWithoutPlugins = recursiveUpdate

     

       117
        
           { ServiceSettings.SiteURL = cfg.siteUrl;

     

       118
        
             ServiceSettings.ListenAddress = cfg.listenAddress;

     

       119
        
             TeamSettings.SiteName = cfg.siteName;

     
···

       122
        
           }

     

       123
        
           cfg.extraConfig;

     

       124
        
       

     

       125
       +
         mattermostConf = recursiveUpdate

     

       126
       +
           mattermostConfWithoutPlugins

     

       127
       +
           (

     

       128
       +
             if mattermostPlugins == null then {}

     

       129
       +
             else {

     

       130
       +
               PluginSettings = {

     

       131
       +
                 Enable = true;

     

       132
       +
                 EnableUploads = false;

     

       133
       +
                 Directory = "${mattermostPlugins}/server";

     

       134
       +
                 ClientDirectory = "${mattermostPlugins}/client";

     

       135
       +
               };

     

       136
       +
             }

     

       137
       +
           );

     

       138
       +
       

     

       139
        
         mattermostConfJSON = pkgs.writeText "mattermost-config.json" (builtins.toJSON mattermostConf);

     

       140
        
       

     

       141
        
       in

     
···

       144
        
         options = {

     

       145
        
           services.mattermost = {

     

       146
        
             enable = mkEnableOption "Mattermost chat server";

     

       147
       +
       

     

       148
       +
             package = mkOption {

     

       149
       +
               type = types.package;

     

       150
       +
               default = pkgs.mattermost;

     

       151
       +
               defaultText = "pkgs.mattermost";

     

       152
       +
               description = "Mattermost derivation to use.";

     

       153
       +
             };

     

       154
        
       

     

       155
        
             statePath = mkOption {

     

       156
        
               type = types.str;

     
···

       216
        
               '';

     

       217
        
             };

     

       218
        
       

     

       219
       +
             plugins = mkOption {

     

       220
       +
               type = types.nullOr (types.listOf (types.oneOf [types.path types.package]));

     

       221
       +
               default = null;

     

       222
       +
               example = "[ ./com.github.moussetc.mattermost.plugin.giphy-2.0.0.tar.gz ]";

     

       223
       +
               description = ''

     

       224
       +
                 Plugins to add to the configuration. Overrides any installed if non-null.

     

       225
       +
                 This is a list of paths to .tar.gz files or derivations evaluating to

     

       226
       +
                 .tar.gz files. All entries will be passed to `mattermost plugin add`.

     

       227
       +
               '';

     

       228
       +
             };

     

       229
       +
       

     

       230
        
             localDatabaseCreate = mkOption {

     

       231
        
               type = types.bool;

     

       232
        
               default = true;

     
···

       277
        
       

     

       278
        
             matterircd = {

     

       279
        
               enable = mkEnableOption "Mattermost IRC bridge";

     

       280
       +
               package = mkOption {

     

       281
       +
                 type = types.package;

     

       282
       +
                 default = pkgs.matterircd;

     

       283
       +
                 defaultText = "pkgs.matterircd";

     

       284
       +
                 description = "matterircd derivation to use.";

     

       285
       +
               };

     

       286
        
               parameters = mkOption {

     

       287
        
                 type = types.listOf types.str;

     

       288
        
                 default = [ ];

     
···

       325
        
       

     

       326
        
               preStart = ''

     

       327
        
                 mkdir -p ${cfg.statePath}/{data,config,logs}

     

       328
       +
                 ln -sf ${cfg.package}/{bin,fonts,i18n,templates,client} ${cfg.statePath}

     

       329
        
               '' + lib.optionalString (!cfg.mutableConfig) ''

     

       330
        
                 rm -f ${cfg.statePath}/config/config.json

     

       331
       +
                 ${pkgs.jq}/bin/jq -s '.[0] * .[1]' ${cfg.package}/config/config.json ${mattermostConfJSON} > ${cfg.statePath}/config/config.json

     

       332
       +
                 ${cfg.package}/bin/mattermost config migrate ${cfg.statePath}/config/config.json ${database}

     

       333
        
               '' + lib.optionalString cfg.mutableConfig ''

     

       334
        
                 if ! test -e "${cfg.statePath}/config/.initial-created"; then

     

       335
        
                   rm -f ${cfg.statePath}/config/config.json

     

       336
       +
                   ${pkgs.jq}/bin/jq -s '.[0] * .[1]' ${cfg.package}/config/config.json ${mattermostConfJSON} > ${cfg.statePath}/config/config.json

     

       337
        
                   touch ${cfg.statePath}/config/.initial-created

     

       338
        
                 fi

     

       339
        
               '' + lib.optionalString (cfg.mutableConfig && cfg.preferNixConfig) ''

     
···

       341
        
       

     

       342
        
                 rm -f ${cfg.statePath}/config/config.json

     

       343
        
                 echo "$newConfig" > ${cfg.statePath}/config/config.json

     

       344
       +
               '' + lib.optionalString cfg.localDatabaseCreate (createDb {}) + ''

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       345
        
                 chown ${cfg.user}:${cfg.group} -R ${cfg.statePath}

     

       346
        
                 chmod u+rw,g+r,o-rwx -R ${cfg.statePath}

     

       347
        
               '';

     
···

       350
        
                 PermissionsStartOnly = true;

     

       351
        
                 User = cfg.user;

     

       352
        
                 Group = cfg.group;

     

       353
       +
                 ExecStart = "${cfg.package}/bin/mattermost " + (

     

       354
       +
                   escapeShellArgs

     

       355
       +
                   (lib.optionals (!cfg.mutableConfig) ["-c" database])

     

       356
       +
                 );

     

       357
        
                 WorkingDirectory = "${cfg.statePath}";

     

       358
        
                 Restart = "always";

     

       359
        
                 RestartSec = "10";

     
···

       369
        
               serviceConfig = {

     

       370
        
                 User = "nobody";

     

       371
        
                 Group = "nogroup";

     

       372
       +
                 ExecStart = "${cfg.matterircd.package}/bin/matterircd ${escapeShellArgs cfg.matterircd.parameters}";

     

       373
        
                 WorkingDirectory = "/tmp";

     

       374
        
                 PrivateTmp = true;

     

       375
        
                 Restart = "always";

nixos/tests/mattermost.nix

···

       37
        
           mostlyMutable = makeMattermost {

     

       38
        
             mutableConfig = true;

     

       39
        
             preferNixConfig = true;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       40
        
           };

     

       41
        
           immutable = makeMattermost {

     

       42
        
             mutableConfig = false;

···

       37
        
           mostlyMutable = makeMattermost {

     

       38
        
             mutableConfig = true;

     

       39
        
             preferNixConfig = true;

     

       40
       +
             plugins = let

     

       41
       +
               mattermostDemoPlugin = pkgs.fetchurl {

     

       42
       +
                 url = "https://github.com/mattermost/mattermost-plugin-demo/releases/download/v0.9.0/com.mattermost.demo-plugin-0.9.0.tar.gz";

     

       43
       +
                 sha256 = "1h4qi34gcxcx63z8wiqcf2aaywmvv8lys5g8gvsk13kkqhlmag25";

     

       44
       +
               };

     

       45
       +
             in [

     

       46
       +
               mattermostDemoPlugin

     

       47
       +
             ];

     

       48
        
           };

     

       49
        
           immutable = makeMattermost {

     

       50
        
             mutableConfig = false;