commit 84c6d60c263aa49c5430dec4ed9cefa9601f73e7 · pyrox.dev/nixpkgs

nixos/doc/manual/configuration/configuration.md

···

       22
       22
        
       

     

       23
       23
        
       ```{=include=} chapters

     

       24
       24
        
       profiles.chapter.md

     

       25
       25
       +
       mattermost.chapter.md

     

       25
       26
        
       kubernetes.chapter.md

     

       26
       27
        
       ```

     

       27
       28
        
       <!-- Apache; libvirtd virtualisation -->

+134

nixos/doc/manual/configuration/mattermost.chapter.md

···

       1
       1
       +
       # Mattermost {#sec-mattermost}

     

       2
       2
       +
       

     

       3
       3
       +
       The NixOS Mattermost module lets you build [Mattermost](https://mattermost.com)

     

       4
       4
       +
       instances for collaboration over chat, optionally with custom builds of plugins

     

       5
       5
       +
       specific to your instance.

     

       6
       6
       +
       

     

       7
       7
       +
       To enable Mattermost using Postgres, use a config like this:

     

       8
       8
       +
       

     

       9
       9
       +
       ```nix

     

       10
       10
       +
       {

     

       11
       11
       +
         services.mattermost = {

     

       12
       12
       +
           enable = true;

     

       13
       13
       +
       

     

       14
       14
       +
           # You can change this if you are reverse proxying.

     

       15
       15
       +
           host = "0.0.0.0";

     

       16
       16
       +
           port = 8065;

     

       17
       17
       +
       

     

       18
       18
       +
           # Allow modifications to the config from Mattermost.

     

       19
       19
       +
           mutableConfig = true;

     

       20
       20
       +
       

     

       21
       21
       +
           # Override modifications to the config with your NixOS config.

     

       22
       22
       +
           preferNixConfig = true;

     

       23
       23
       +
       

     

       24
       24
       +
           socket = {

     

       25
       25
       +
             # Enable control with the `mmctl` socket.

     

       26
       26
       +
             enable = true;

     

       27
       27
       +
       

     

       28
       28
       +
             # Exporting the control socket will add `mmctl` to your PATH, and export

     

       29
       29
       +
             # MMCTL_LOCAL_SOCKET_PATH systemwide. Otherwise, you can get the socket

     

       30
       30
       +
             # path out of `config.mattermost.socket.path` and set it manually.

     

       31
       31
       +
             export = true;

     

       32
       32
       +
           };

     

       33
       33
       +
       

     

       34
       34
       +
           # For example, to disable auto-installation of prepackaged plugins.

     

       35
       35
       +
           settings.PluginSettings.AutomaticPrepackagedPlugins = false;

     

       36
       36
       +
         }

     

       37
       37
       +
       }

     

       38
       38
       +
       ```

     

       39
       39
       +
       

     

       40
       40
       +
       As of NixOS 25.05, Mattermost uses peer authentication with Postgres or

     

       41
       41
       +
       MySQL by default. If you previously used password auth on localhost,

     

       42
       42
       +
       this will automatically be configured if your `stateVersion` is set to at least

     

       43
       43
       +
       `25.05`.

     

       44
       44
       +
       

     

       45
       45
       +
       ## Using the Mattermost derivation {#sec-mattermost-derivation}

     

       46
       46
       +
       

     

       47
       47
       +
       The nixpkgs `mattermost` derivation runs the entire test suite during the

     

       48
       48
       +
       `checkPhase`. This test suite is run with a live MySQL and Postgres database

     

       49
       49
       +
       instance in the sandbox. If you are building Mattermost, this can take a while,

     

       50
       50
       +
       especially if it is building on a resource-constrained system.

     

       51
       51
       +
       

     

       52
       52
       +
       The following passthrus are designed to assist with enabling or disabling

     

       53
       53
       +
       the `checkPhase`:

     

       54
       54
       +
       

     

       55
       55
       +
       - `mattermost.withTests`

     

       56
       56
       +
       - `mattermost.withoutTests`

     

       57
       57
       +
       

     

       58
       58
       +
       The default (`mattermost`) is an alias for `mattermost.withTests`.

     

       59
       59
       +
       

     

       60
       60
       +
       ## Using Mattermost plugins {#sec-mattermost-plugins}

     

       61
       61
       +
       

     

       62
       62
       +
       You can configure Mattermost plugins by either using prebuilt binaries or by

     

       63
       63
       +
       building your own. We test building and using plugins in the NixOS test suite.

     

       64
       64
       +
       

     

       65
       65
       +
       Mattermost plugins are tarballs containing a system-specific statically linked

     

       66
       66
       +
       Go binary and webapp resources.

     

       67
       67
       +
       

     

       68
       68
       +
       Here is an example with a prebuilt plugin tarball:

     

       69
       69
       +
       

     

       70
       70
       +
       ```nix

     

       71
       71
       +
       {

     

       72
       72
       +
         services.mattermost = {

     

       73
       73
       +
           plugins = with pkgs; [

     

       74
       74
       +
             /*

     

       75
       75
       +
              * todo

     

       76
       76
       +
              * 0.7.1

     

       77
       77
       +
              * https://github.com/mattermost/mattermost-plugin-todo/releases/tag/v0.7.1

     

       78
       78
       +
              */

     

       79
       79
       +
             (fetchurl {

     

       80
       80
       +
               # Note: Don't unpack the tarball; the NixOS module will repack it for you.

     

       81
       81
       +
               url = "https://github.com/mattermost-community/mattermost-plugin-todo/releases/download/v0.7.1/com.mattermost.plugin-todo-0.7.1.tar.gz";

     

       82
       82
       +
               hash = "sha256-P+Z66vqE7FRmc2kTZw9FyU5YdLLbVlcJf11QCbfeJ84=";

     

       83
       83
       +
             })

     

       84
       84
       +
           ];

     

       85
       85
       +
         };

     

       86
       86
       +
       }

     

       87
       87
       +
       ```

     

       88
       88
       +
       

     

       89
       89
       +
       Once the plugin is installed and the config rebuilt, you can enable this plugin

     

       90
       90
       +
       in the System Console.

     

       91
       91
       +
       

     

       92
       92
       +
       ## Building Mattermost plugins {#sec-mattermost-plugins-build}

     

       93
       93
       +
       

     

       94
       94
       +
       The `mattermost` derivation includes the `buildPlugin` passthru for building

     

       95
       95
       +
       plugins that use the "standard" Mattermost plugin build template at

     

       96
       96
       +
       [mattermost-plugin-demo](https://github.com/mattermost/mattermost-plugin-demo).

     

       97
       97
       +
       

     

       98
       98
       +
       Since this is a "de facto" standard for building Mattermost plugins that makes

     

       99
       99
       +
       assumptions about the build environment, the `buildPlugin` helper tries to fit

     

       100
       100
       +
       these assumptions the best it can.

     

       101
       101
       +
       

     

       102
       102
       +
       Here is how to build the above Todo plugin. Note that we rely on

     

       103
       103
       +
       package-lock.json being assembled correctly, so must use a version where it is!

     

       104
       104
       +
       If there is no lockfile or the lockfile is incorrect, Nix cannot fetch NPM build

     

       105
       105
       +
       and runtime dependencies for a sandbox build.

     

       106
       106
       +
       

     

       107
       107
       +
       ```nix

     

       108
       108
       +
       {

     

       109
       109
       +
         services.mattermost = {

     

       110
       110
       +
           plugins = with pkgs; [

     

       111
       111
       +
             (mattermost.buildPlugin {

     

       112
       112
       +
               pname = "mattermost-plugin-todo";

     

       113
       113
       +
               version = "0.8-pre";

     

       114
       114
       +
               src = fetchFromGitHub {

     

       115
       115
       +
                 owner = "mattermost-community";

     

       116
       116
       +
                 repo = "mattermost-plugin-todo";

     

       117
       117
       +
                 # 0.7.1 didn't work, seems to use an older set of node dependencies.

     

       118
       118
       +
                 rev = "f25dc91ea401c9f0dcd4abcebaff10eb8b9836e5";

     

       119
       119
       +
                 hash = "sha256-OM+m4rTqVtolvL5tUE8RKfclqzoe0Y38jLU60Pz7+HI=";

     

       120
       120
       +
               };

     

       121
       121
       +
               vendorHash = "sha256-5KpechSp3z/Nq713PXYruyNxveo6CwrCSKf2JaErbgg=";

     

       122
       122
       +
               npmDepsHash = "sha256-o2UOEkwb8Vx2lDWayNYgng0GXvmS6lp/ExfOq3peyMY=";

     

       123
       123
       +
               extraGoModuleAttrs = {

     

       124
       124
       +
                 npmFlags = [ "--legacy-peer-deps" ];

     

       125
       125
       +
               };

     

       126
       126
       +
             })

     

       127
       127
       +
           ];

     

       128
       128
       +
         };

     

       129
       129
       +
       }

     

       130
       130
       +
       ```

     

       131
       131
       +
       

     

       132
       132
       +
       See `pkgs/by-name/ma/mattermost/build-plugin.nix` for all the options.

     

       133
       133
       +
       As in the previous example, once the plugin is installed and the config rebuilt,

     

       134
       134
       +
       you can enable this plugin in the System Console.

+12

nixos/doc/manual/redirects.json

···

       47
       47
        
         "ch-installation": [

     

       48
       48
        
           "index.html#ch-installation"

     

       49
       49
        
         ],

     

       50
       50
       +
         "sec-mattermost": [

     

       51
       51
       +
           "index.html#sec-mattermost"

     

       52
       52
       +
         ],

     

       53
       53
       +
         "sec-mattermost-derivation": [

     

       54
       54
       +
           "index.html#sec-mattermost-derivation"

     

       55
       55
       +
         ],

     

       56
       56
       +
         "sec-mattermost-plugins": [

     

       57
       57
       +
           "index.html#sec-mattermost-plugins"

     

       58
       58
       +
         ],

     

       59
       59
       +
         "sec-mattermost-plugins-build": [

     

       60
       60
       +
           "index.html#sec-mattermost-plugins-build"

     

       61
       61
       +
         ],

     

       50
       62
        
         "sec-obtaining": [

     

       51
       63
        
           "index.html#sec-obtaining"

     

       52
       64
        
         ],