commit cc786acdcecf95b75e5704e004b5a6d109fc0605 · pyrox.dev/nixpkgs

+13

nixos/doc/manual/release-notes/rl-2103.xml

···

       278
       278
        
         <itemizedlist>

     

       279
       279
        
          <listitem>

     

       280
       280
        
           <para>

     

       281
       281
       +
            The Mailman NixOS module (<literal>services.mailman</literal>) has a new

     

       282
       282
       +
            option <xref linkend="opt-services.mailman.enablePostfix" />, defaulting

     

       283
       283
       +
            to true, that controls integration with Postfix.

     

       284
       284
       +
           </para>

     

       285
       285
       +
           <para>

     

       286
       286
       +
            If this option is disabled, default MTA config becomes not set and you

     

       287
       287
       +
            should set the options in <literal>services.mailman.settings.mta</literal>

     

       288
       288
       +
            according to the desired configuration as described in

     

       289
       289
       +
            <link xlink:href="https://mailman.readthedocs.io/en/latest/src/mailman/docs/mta.html">Mailman documentation</link>.

     

       290
       290
       +
           </para>

     

       291
       291
       +
          </listitem>

     

       292
       292
       +
          <listitem>

     

       293
       293
       +
           <para>

     

       281
       294
        
            The default-version of <literal>nextcloud</literal> is <package>nextcloud20</package>.

     

       282
       295
        
            Please note that it's <emphasis>not</emphasis> possible to upgrade <literal>nextcloud</literal>

     

       283
       296
        
            across multiple major versions! This means that it's e.g. not possible to upgrade

+29 -7

nixos/modules/services/mail/mailman.nix

···

       38
       38
        
         webSettingsJSON = pkgs.writeText "settings.json" (builtins.toJSON webSettings);

     

       39
       39
        
       

     

       40
       40
        
         # TODO: Should this be RFC42-ised so that users can set additional options without modifying the module?

     

       41
       41
       -
         mtaConfig = pkgs.writeText "mailman-postfix.cfg" ''

     

       41
       41
       +
         postfixMtaConfig = pkgs.writeText "mailman-postfix.cfg" ''

     

       42
       42
        
           [postfix]

     

       43
       43
        
           postmap_command: ${pkgs.postfix}/bin/postmap

     

       44
       44
        
           transport_file_type: hash

     
···

       81
       81
        
             enable = mkOption {

     

       82
       82
        
               type = types.bool;

     

       83
       83
        
               default = false;

     

       84
       84
       -
               description = "Enable Mailman on this host. Requires an active Postfix installation.";

     

       84
       84
       +
               description = "Enable Mailman on this host. Requires an active MTA on the host (e.g. Postfix).";

     

       85
       85
        
             };

     

       86
       86
        
       

     

       87
       87
        
             package = mkOption {

     
···

       90
       90
        
               defaultText = "pkgs.mailman";

     

       91
       91
        
               example = literalExample "pkgs.mailman.override { archivers = []; }";

     

       92
       92
        
               description = "Mailman package to use";

     

       93
       93
       +
             };

     

       94
       94
       +
       

     

       95
       95
       +
             enablePostfix = mkOption {

     

       96
       96
       +
               type = types.bool;

     

       97
       97
       +
               default = true;

     

       98
       98
       +
               example = false;

     

       99
       99
       +
               description = ''

     

       100
       100
       +
                 Enable Postfix integration. Requires an active Postfix installation.

     

       101
       101
       +
       

     

       102
       102
       +
                 If you want to use another MTA, set this option to false and configure

     

       103
       103
       +
                 settings in services.mailman.settings.mta.

     

       104
       104
       +
       

     

       105
       105
       +
                 Refer to the Mailman manual for more info.

     

       106
       106
       +
               '';

     

       93
       107
        
             };

     

       94
       108
        
       

     

       95
       109
        
             siteOwner = mkOption {

     
···

       182
       196
        
               pid_file = "/run/mailman/master.pid";

     

       183
       197
        
             };

     

       184
       198
        
       

     

       185
       185
       -
             mta.configuration = lib.mkDefault "${mtaConfig}";

     

       199
       199
       +
             mta.configuration = lib.mkDefault (if cfg.enablePostfix then "${postfixMtaConfig}" else throw "When Mailman Postfix integration is disabled, set `services.mailman.settings.mta.configuration` to the path of the config file required to integrate with your MTA.");

     

       186
       200
        
       

     

       187
       201
        
             "archiver.hyperkitty" = lib.mkIf cfg.hyperkitty.enable {

     

       188
       202
        
               class = "mailman_hyperkitty.Archiver";

     
···

       211
       225
        
                     See <https://mailman.readthedocs.io/en/latest/src/mailman/docs/mta.html>.

     

       212
       226
        
                   '';

     

       213
       227
        
                 };

     

       214
       214
       -
           in [

     

       228
       228
       +
           in (lib.optionals cfg.enablePostfix [

     

       215
       229
        
             { assertion = postfix.enable;

     

       216
       216
       -
               message = "Mailman requires Postfix";

     

       230
       230
       +
               message = ''

     

       231
       231
       +
                 Mailman's default NixOS configuration requires Postfix to be enabled.

     

       232
       232
       +
       

     

       233
       233
       +
                 If you want to use another MTA, set services.mailman.enablePostfix

     

       234
       234
       +
                 to false and configure settings in services.mailman.settings.mta.

     

       235
       235
       +
       

     

       236
       236
       +
                 Refer to <https://mailman.readthedocs.io/en/latest/src/mailman/docs/mta.html>

     

       237
       237
       +
                 for more info.

     

       238
       238
       +
               '';

     

       217
       239
        
             }

     

       218
       240
        
             (requirePostfixHash [ "relayDomains" ] "postfix_domains")

     

       219
       241
        
             (requirePostfixHash [ "config" "transport_maps" ] "postfix_lmtp")

     

       220
       242
        
             (requirePostfixHash [ "config" "local_recipient_maps" ] "postfix_lmtp")

     

       221
       221
       -
           ];

     

       243
       243
       +
           ]);

     

       222
       244
        
       

     

       223
       245
        
           users.users.mailman = {

     

       224
       246
        
             description = "GNU Mailman";

     
···

       275
       297
        
             '';

     

       276
       298
        
           }) ];

     

       277
       299
        
       

     

       278
       278
       -
           services.postfix = {

     

       300
       300
       +
           services.postfix = lib.mkIf cfg.enablePostfix {

     

       279
       301
        
             recipientDelimiter = "+";         # bake recipient addresses in mail envelopes via VERP

     

       280
       302
        
             config = {

     

       281
       303
        
               owner_request_special = "no";   # Mailman handles -owner addresses on its own

+37 -2

nixos/modules/services/mail/mailman.xml

···

       13
       13
        
         </para>

     

       14
       14
        
       

     

       15
       15
        
         <section xml:id="module-services-mailman-basic-usage">

     

       16
       16
       -
           <title>Basic usage</title>

     

       16
       16
       +
           <title>Basic usage with Postfix</title>

     

       17
       17
        
           <para>

     

       18
       18
       -
             For a basic configuration, the following settings are suggested:

     

       18
       18
       +
             For a basic configuration with Postfix as the MTA, the following settings are suggested:

     

       19
       19
        
             <programlisting>{ config, ... }: {

     

       20
       20
        
         services.postfix = {

     

       21
       21
        
           enable = true;

     
···

       54
       54
        
             avoid spam -- a number of additional measures for authenticating

     

       55
       55
        
             incoming and outgoing mails, such as SPF, DMARC and DKIM are

     

       56
       56
        
             necessary, but outside the scope of the Mailman module.

     

       57
       57
       +
           </para>

     

       58
       58
       +
         </section>

     

       59
       59
       +
         <section xml:id="module-services-mailman-other-mtas">

     

       60
       60
       +
           <title>Using with other MTAs</title>

     

       61
       61
       +
           <para>

     

       62
       62
       +
             Mailman also supports other MTA, though with a little bit more configuration. For example, to use Mailman with Exim, you can use the following settings:

     

       63
       63
       +
             <programlisting>{ config, ... }: {

     

       64
       64
       +
         services = {

     

       65
       65
       +
           mailman = {

     

       66
       66
       +
             enable = true;

     

       67
       67
       +
             siteOwner = "mailman@example.org";

     

       68
       68
       +
             <link linkend="opt-services.mailman.enablePostfix">enablePostfix</link> = false;

     

       69
       69
       +
             settings.mta = {

     

       70
       70
       +
               incoming = "mailman.mta.exim4.LMTP";

     

       71
       71
       +
               outgoing = "mailman.mta.deliver.deliver";

     

       72
       72
       +
               lmtp_host = "localhost";

     

       73
       73
       +
               lmtp_port = "8024";

     

       74
       74
       +
               smtp_host = "localhost";

     

       75
       75
       +
               smtp_port = "25";

     

       76
       76
       +
               configuration = "python:mailman.config.exim4";

     

       77
       77
       +
             };

     

       78
       78
       +
           };

     

       79
       79
       +
           exim = {

     

       80
       80
       +
             enable = true;

     

       81
       81
       +
             # You can configure Exim in a separate file to reduce configuration.nix clutter

     

       82
       82
       +
             config = builtins.readFile ./exim.conf;

     

       83
       83
       +
           };

     

       84
       84
       +
         };

     

       85
       85
       +
       }</programlisting>

     

       86
       86
       +
           </para>

     

       87
       87
       +
           <para>

     

       88
       88
       +
             The exim config needs some special additions to work with Mailman. Currently

     

       89
       89
       +
             NixOS can't manage Exim config with such granularity. Please refer to

     

       90
       90
       +
             <link xlink:href="https://mailman.readthedocs.io/en/latest/src/mailman/docs/mta.html">Mailman documentation</link>

     

       91
       91
       +
             for more info on configuring Mailman for working with Exim.

     

       57
       92
        
           </para>

     

       58
       93
        
         </section>

     

       59
       94
        
       </chapter>