Barry Warsaw pushed to branch master at mailman / Mailman
Commits:
2ef893bc by Abhilash Raj at 2017-01-08T11:46:31-05:00
Add default configuration to the documentation.
- - - - -
983fc0b6 by Abhilash Raj at 2017-01-08T11:46:31-05:00
Swap order of configs and describe use of both config files
- - - - -
1e4b216b by Barry Warsaw at 2017-01-08T12:07:13-05:00
Rebase and elaborate.
- - - - -
609739ee by Barry Warsaw at 2017-01-08T18:17:45+00:00
Merge branch 'mr206' into 'master'
Document the configuration settings
Closes #278
See merge request !231
- - - - -
2 changed files:
- README.rst
- + src/mailman/config/docs/config.rst
Changes:
=====================================
README.rst
=====================================
--- a/README.rst
+++ b/README.rst
@@ -47,6 +47,7 @@ Table of Contents
src/mailman/docs/INTRODUCTION
src/mailman/docs/RELEASENOTES
+ src/mailman/config/docs/config
src/mailman/docs/DATABASE
src/mailman/docs/MTA
src/mailman/docs/WebUIin5
=====================================
src/mailman/config/docs/config.rst
=====================================
--- /dev/null
+++ b/src/mailman/config/docs/config.rst
@@ -0,0 +1,53 @@
+=======================
+ Mailman Configuration
+=======================
+
+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: ign...@example.com
+
+You will need to restart Mailman for any changes to take effect.
+
+
+schema.cfg
+==========
+
+``schema.cfg`` includes templates for several configuration options that are
+instantiated inside of ``mailman.cfg``. Sections that are named with a suffix
+of ``.master`` or ``.template`` (e.g. ``paths.master``) are "template"
+sections which require an instantiation in ``mailman.cfg`` [#]_.
+
+.. 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.
View it on GitLab:
https://gitlab.com/mailman/mailman/compare/4b3fc1792a62b8c49f0c8cb5cd44c2ef9ce7ebd2...609739ee390447a8feb99bb52d13c6e3f0bf3caa
_______________________________________________
Mailman-checkins mailing list
Mailman-checkins@python.org
Unsubscribe:
https://mail.python.org/mailman/options/mailman-checkins/archive%40jab.org
