@@ -490,6 +490,52 @@ auth required pam_succeed_if.so uid >= 1000 quiet
490490 All other display managers in NixOS are configured like this.
491491 </para>
492492 </listitem>
493+ <listitem>
494+ <para>
495+ There have been lots of improvements to the Mailman module. As
496+ a result,
497+ </para>
498+ <itemizedlist>
499+ <listitem>
500+ <para>
501+ The <option>services.mailman.hyperkittyBaseUrl</option>
502+ option has been renamed to <xref
503+ linkend="opt-services.mailman.hyperkitty.baseUrl"/>.
504+ </para>
505+ </listitem>
506+ <listitem>
507+ <para>
508+ The <option>services.mailman.hyperkittyApiKey</option>
509+ option has been removed. This is because having an option
510+ for the Hyperkitty API key meant that the API key would be
511+ stored in the world-readable Nix store, which was a
512+ security vulnerability. A new Hyperkitty API key will be
513+ generated the first time the new Hyperkitty service is run,
514+ and it will then be persisted outside of the Nix store. To
515+ continue using Hyperkitty, you must set <xref
516+ linkend="opt-services.mailman.hyperkitty.enable"/> to
517+ <literal>true</literal>.
518+ </para>
519+ </listitem>
520+ <listitem>
521+ <para>
522+ Additionally, some Postfix configuration must now be set
523+ manually instead of automatically by the Mailman module:
524+<programlisting>
525+<xref linkend="opt-services.postfix.relayDomains"/> = [ "hash:/var/lib/mailman/data/postfix_domains" ];
526+<xref linkend="opt-services.postfix.config"/>.transport_maps = [ "hash:/var/lib/mailman/data/postfix_lmtp" ];
527+<xref linkend="opt-services.postfix.config"/>.local_recipient_maps = [ "hash:/var/lib/mailman/data/postfix_lmtp" ];
528+</programlisting>
529+ This is because some users may want to include other values
530+ in these lists as well, and this was not possible if they
531+ were set automatically by the Mailman module. It would not
532+ have been possible to just concatenate values from multiple
533+ modules each setting the values they needed, because the
534+ order of elements in the list is significant.
535+ </para>
536+ </listitem>
537+ </itemizedlist>
538+ </listitem>
493539 </itemizedlist>
494540 </section>
495541