Ian Wienand 882b730fdf Update to openstackdocstheme

This modernises the openstack-infra documentation by switching to
openstackdocstheme.  Update dependencies as required.

To remove non-relevant stuff from conf.py, I have just taken the demo
file from openstackdocstheme and lightly modified it.

It seems later sphinx has included it's own ":file:" role which now
conflicts.  Change it it ":cgit_file:" in our documentation.  Remove
the custom header template which no longer applies.  Add the
post-2.0-pbr sphinx-based warning-as-error, which fixes the original
problem that I actually noticed that errors could slip through the
gate tests :)

Change-Id: Ic7bec57b971bb4c75fc839e7269d1f69a576b85c

2018-06-25 11:19:43 +10:00

3.0 KiB

Raw Blame History

title: Mailing Lists

Mailing Lists

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

Projects

http://www.gnu.org/software/mailman/

Bugs

Resources

Mailman Documentation

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:

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:

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:

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:

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.

3.0 KiB Raw Blame History