eaa74543de
The zuul and zuulv3 docs need to be merged, but that seemed like too much for this. Also, the 3rd party CI doc is out of date, but in this patch only removed sections that linked to docs or files that don't exist anymore. Change-Id: Ie5497edd762d2146165608f3227b0bac88a913df
103 lines
2.9 KiB
ReStructuredText
103 lines
2.9 KiB
ReStructuredText
:title: Mailing Lists
|
|
|
|
.. _lists:
|
|
|
|
Mailing Lists
|
|
#############
|
|
|
|
`Mailman <http://www.gnu.org/software/mailman/>`_ is installed on
|
|
lists.openstack.org to run OpenStack related mailing lists, as well as
|
|
host list archives.
|
|
|
|
At a Glance
|
|
===========
|
|
|
|
:Hosts:
|
|
* http://lists.openstack.org
|
|
:Puppet:
|
|
* https://opendev.org/opendev/puppet-mailman
|
|
* :cgit_file:`modules/openstack_project/manifests/lists.pp`
|
|
:Projects:
|
|
* http://www.gnu.org/software/mailman/
|
|
:Bugs:
|
|
* https://storyboard.openstack.org/#!/project/748
|
|
* https://bugs.launchpad.net/mailman
|
|
:Resources:
|
|
* `Mailman Documentation <http://www.gnu.org/software/mailman/docs.html>`_
|
|
|
|
Adding a List
|
|
=============
|
|
|
|
A list may be added by adding it to the ``openstack-infra/system-config``
|
|
repository in ``modules/openstack_project/manifests/lists.pp``. For
|
|
example:
|
|
|
|
.. code-block:: ruby
|
|
|
|
mailman_list { 'openstack-foo@openstack':
|
|
require => Mailman::Site['openstack'],
|
|
ensure => present,
|
|
admin => 'admin@example.com',
|
|
password => $listpassword,
|
|
description => 'Discussion of OpenStack Foo',
|
|
}
|
|
|
|
Scripted Changes to Lists
|
|
=========================
|
|
|
|
This may only be performed with root access to the list server.
|
|
|
|
Mailman supports running a python code snippet in the context of
|
|
individual lists or every list on the system. The following example
|
|
adds an address to the list of banned addresses for every list. This
|
|
has proved useful in the case of attackers abusing the HTTP
|
|
subscription interface to subscribe a target's address to multiple
|
|
mailing lists.
|
|
|
|
Banning an Address from All Lists
|
|
---------------------------------
|
|
|
|
Create the file `/usr/lib/mailman/bin/ban.py` with the following
|
|
content:
|
|
|
|
.. code-block:: python
|
|
|
|
def ban(m, address):
|
|
try:
|
|
m.Lock()
|
|
if address not in m.ban_list:
|
|
m.ban_list.append(address)
|
|
m.Save()
|
|
finally:
|
|
m.Unlock()
|
|
|
|
And then run the withlist script as:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo -u list /usr/lib/mailman/bin/withlist -a -r ban "<address to ban>"
|
|
|
|
Because the script itself handles locking, do not use the `-l`
|
|
argument to withlist. To run the same script on a single list, use:
|
|
|
|
.. code-block:: bash
|
|
|
|
sudo -u list /usr/lib/mailman/bin/withlist -r ban listname "<address to ban>"
|
|
|
|
Note that the ban list accepts regular expressions, so to ban an
|
|
address and all suffixes, use '^address.*@example.com' as the "address
|
|
to ban".
|
|
|
|
Lock Files
|
|
----------
|
|
|
|
If a list stops handling traffic for some time, it may be due to a
|
|
stale lock file. Mailman locks are in /srv/mailman/openstack/locks.
|
|
If a lock is held for a list, then ``listname.lock`` will exist. The
|
|
contents of the file will be the name of the lock sequence file which
|
|
was used to obtain the lock. That file is in the form
|
|
``listname.lock.hostname.pid.sequence``. If the process id in that
|
|
string no longer exists, it's safe to assume the process died without
|
|
cleaning up the lock. It should generally be safe to remove the
|
|
lockfile in that case.
|