system-config/doc/source/lists.rst
Jeremy Stanley 73f0a5336a Merge production and test node mailman configs
Now that the Mailman v3 migration is complete, we no longer need any
divergence between the lists01 (production) and lists99 (test node)
host vars, so put everything into the group vars file instead.

Change-Id: If92943694e95ef261fbd254eff65a51d8d3f7ce5
2023-10-30 19:26:03 +00:00

55 lines
1.4 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.