summaryrefslogtreecommitdiff
path: root/src/mailman/config/docs/config.rst
blob: 16c3d40bc1121d8527fb5cd808b76217f7ec8901 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
.. _configuration:

=====================
 Configuring Mailman
=====================

This is Mailman's default configuration, directly included from the source
code.  The format is standard "ini"-style.

You can override these in your configuration to modify the behavior of Mailman
Core.  To override these settings, these file system paths are search in
order:

* The file system path specified by the environment variable
  ``$MAILMAN_CONFIG_FILE``;
* ``mailman.cfg`` in the current working directory;
* ``var/etc/mailman.cfg`` relative to the current working directory;
* ``$HOME/.mailman.cfg``
* ``/etc/mailman.cfg``
* ``../../etc/mailman.cfg`` relative to the working directory of ``argv[0]``

You only need to include the settings you want to override.  They must be
specified inside the appropriate section.  For example, to override the "no
reply address" only, put this in your ``mailman.cfg`` file::

    [mailman]
    noreply_address: ignore@example.com

You will need to restart Mailman for any changes to take effect.


schema.cfg
==========

``schema.cfg`` defines the ini-file schema and contains documentation for
every section and configuration variable.  Sections that are named with a
suffix of ``.master`` or ``.template`` (e.g. ``paths.master``) are "template"
sections which must be defined in the ``mailman.cfg`` file [#]_.

.. literalinclude:: ../schema.cfg


mailman.cfg
===========

Configuration options provided in the source code's ``mailman.cfg`` override
those provided in ``schema.cfg``.  Your own ``mailman.cfg`` file overrides
these.

.. literalinclude:: ../mailman.cfg


.. [#] The technical differences are described in the `lazr.config
       <http://pythonhosted.org/lazr.config/>`_ package, upon which Mailman's
       configuration system is based.