system-config/doc/source/lists.rst
Jeremy Stanley c2ba2b3177 Add documentation about Django/Mailman super user
The Django admin account is also a super user in Hyperkitty and
Postorius, providing a backdoor for systems administrators in a
pinch.

Change-Id: Ic2a8763186c8b6f689c7e8c2f016429944aad753
2024-10-29 16:42:50 +00:00

74 lines
2.3 KiB
ReStructuredText

:title: Mailing Lists
.. _lists:
Mailing Lists
#############
`The Mailman Suite <https://www.list.org/>`_ (Mailman Core, Postorius,
Hyperkitty) is installed on lists.opendev.org to run mailing lists for the
OpenDev Collaboratory and projects it hosts, as well as archives of those
lists.
At a Glance
===========
:Hosts:
* https://lists.opendev.org (and numerous other aliases)
:Ansible:
* :git_file:`playbooks/service-lists3.yaml`
* :git_file:`playbooks/roles/mailman3`
:Projects:
* https://www.list.org/
* https://gitlab.com/mailman/
:Bugs:
* https://storyboard.openstack.org/#!/project/748
* https://gitlab.com/mailman/
:Resources:
* `Mailman Documentation <https://docs.mailman3.org/>`_
Adding a List
=============
A list may be added by adding it to the ``openstack-infra/system-config``
repository in :git_file:`inventory/service/group_vars/mailman3.yaml`.
For example:
.. code-block:: yaml
- name: Example list
description: 'This is an example'
admin: 'admin@example.com'
password: "{{ mailman_list_password }}"
Scripted Interaction with Lists
===============================
This may only be performed with root access to the list server.
.. code-block:: bash
sudo docker-compose -f /etc/mailman-compose/docker-compose.yaml exec -T -u mailman mailman-core mailman help
Use context help for the CLI's many subcommands, or see the Mailman v3
documentation for more details.
Django Admin Interface
======================
There is an admin WebUI at ``/admin/``, but it's only accessible over a
loopback from localhost. If you need to use it, you'll want to connect an
SSH tunnel from your own system and then override DNS resolution for
``lists.opendev.org`` to point to your loopback address.
List Configuration and Moderation Backdoor
==========================================
If you need to step in and assist a list moderator or owner with
configuration and moderation tasks, you can log into the appropriate
Postorius URL for the corresponding list domain with the Django admin
credentials. This is effectively a Mailman "super user" account (as well as
being the account for administering the underlying Django installation).
This same account can be similarly used in Hyperkitty to delete spam
messages and threads in an emergency if the list owner is unavailable.