Changes

Page history
mm3: make a tutorial section out of the most accessible howto entries (#40471) authored by anarcat's avatar anarcat
Show whitespace changes
Inline Side-by-side
service/lists.md
View page @ 0494201e
...@@ -22,63 +22,6 @@ tracking this work, which includes updating this document. ...@@ -22,63 +22,6 @@ tracking this work, which includes updating this document.
# Tutorial # Tutorial
<!-- simple, brainless step-by-step instructions requiring little or -->
<!-- no technical background -->
# How-to
## Create a list
A list can be created by running `mailman-wrapper create` on the mailing list server
(currently `lists-01`):
```
ssh lists-01.torproject.org mailman-wrapper create LISTNAME
```
If you do not have root access, proceed with the mailman admin
password on the [list creation form](https://lists.torproject.org/mailman3/postorius/lists/new/), which is, however, only
accessible to Mailman administrators. This also allows you to pick a
different [style](https://docs.mailman3.org/projects/mailman/en/latest/src/mailman/styles/docs/styles.html) for the new list, something which is not
available from the commandline before Mailman 3.3.10.
Mailman creates the list name with an upper case letter. Usually
people like all lower-case more. So log in to the newly created list
at <https://lists.torproject.org/> and change the list name and the
subject line to lower case.
If people want to have specific settings (no archive, no public
listing, etc.), can you set them also at this stage.
Be careful that new mailing lists do *not* have the proper DMARC
mitigations set, which will make deliverability problematic. To
workaround this, run this mitigation in a shell:
```
ssh lists-01.torproject.org mailman-wrapper shell -l LISTNAME -r tpa.mm3_tweaks.mitigate
```
This is tracked in [issue 41853](https://gitlab.torproject.org/tpo/tpa/team/-/issues/41853).
## Remove a list
To remove a list, use the `mailman-wrapper remove` command. Be careful
because this removes the list without confirmation!
```
ssh lists-01.torproject.org mailman-wrapper remove LISTNAME
```
## Changing list settings from the CLI
The [shell subcommand](https://docs.mailman3.org/projects/mailman/en/latest/src/mailman/commands/docs/shell.html) is the equivalent of the old `withlit`
command. By calling:
mailman-wrapper shell -l LISTNAME
... you end up in a Python interpreter with the `mlist` object
accessible for modification.
## What are our most important lists? ## What are our most important lists?
New to Tor? If so then welcome! Our most important lists are as New to Tor? If so then welcome! Our most important lists are as
...@@ -207,6 +150,60 @@ Debian for this reason. See [TPA-RFC-71][] for more background. The ...@@ -207,6 +150,60 @@ Debian for this reason. See [TPA-RFC-71][] for more background. The
[TPA-RFC-71]: https://gitlab.torproject.org/tpo/tpa/team/-/wikis/policy/tpa-rfc-71-emergency-email-deployments-round-2 [TPA-RFC-71]: https://gitlab.torproject.org/tpo/tpa/team/-/wikis/policy/tpa-rfc-71-emergency-email-deployments-round-2
# How-to
## Create a list
A list can be created by running `mailman-wrapper create` on the mailing list server
(currently `lists-01`):
```
ssh lists-01.torproject.org mailman-wrapper create LISTNAME
```
If you do not have root access, proceed with the mailman admin
password on the [list creation form](https://lists.torproject.org/mailman3/postorius/lists/new/), which is, however, only
accessible to Mailman administrators. This also allows you to pick a
different [style](https://docs.mailman3.org/projects/mailman/en/latest/src/mailman/styles/docs/styles.html) for the new list, something which is not
available from the commandline before Mailman 3.3.10.
Mailman creates the list name with an upper case letter. Usually
people like all lower-case more. So log in to the newly created list
at <https://lists.torproject.org/> and change the list name and the
subject line to lower case.
If people want to have specific settings (no archive, no public
listing, etc.), can you set them also at this stage.
Be careful that new mailing lists do *not* have the proper DMARC
mitigations set, which will make deliverability problematic. To
workaround this, run this mitigation in a shell:
```
ssh lists-01.torproject.org mailman-wrapper shell -l LISTNAME -r tpa.mm3_tweaks.mitigate
```
This is tracked in [issue 41853](https://gitlab.torproject.org/tpo/tpa/team/-/issues/41853).
## Remove a list
To remove a list, use the `mailman-wrapper remove` command. Be careful
because this removes the list without confirmation!
```
ssh lists-01.torproject.org mailman-wrapper remove LISTNAME
```
## Changing list settings from the CLI
The [shell subcommand](https://docs.mailman3.org/projects/mailman/en/latest/src/mailman/commands/docs/shell.html) is the equivalent of the old `withlit`
command. By calling:
mailman-wrapper shell -l LISTNAME
... you end up in a Python interpreter with the `mlist` object
accessible for modification.
## Pager playbook ## Pager playbook
<!-- information about common errors from the monitoring system and --> <!-- information about common errors from the monitoring system and -->
... ...
......