#288 Update mailman documentation
Merged 10 months ago by zlopez. Opened a year ago by zlopez.
zlopez/infra-docs-fpo mailman  into  master

@@ -7,7 +7,7 @@ 

  Contact::

    #fedora-admin, sysadmin-main, sysadmin-tools, sysadmin-hosted

  Servers::

-   mailman01, mailman02, mailman01.stg

+   mailman01, mailman01.stg

  Purpose::

    Provides mailing list services.

  
@@ -29,6 +29,54 @@ 

  (to avoid [no description available] on listinfo index)

  ====

  

+ === Adding user as admin

+ 

+ . Log in to db01 server

+ . Start the postgreSQL console

+ +

+ ``sudo -u postgres psql``

+ +

+ . Connect to hyperkitty DB

+ +

+ ``\connect hyperkitty``

+ +

+ . Add admin permissions to user

+ ** By username

+ +

+ ``UPDATE auth_user SET is_staff = TRUE, is_superuser = TRUE WHERE username=<username>;``

+ +

+ ** By email (only primary mail is used)

+ +

+ ``UPDATE auth_user SET is_staff = TRUE, is_superuser = TRUE WHERE email=<email>;``

+ 

+ 

+ === Accessing admin page in mailman

+ 

+ Admin page will allow you to change some of the settings that are not able to be changed

+ anywhere else. The admin page could be accessed link:https://lists.fedoraproject.org/django-admin

+ or link:https://lists.stg.fedoraproject.org/django-admin for staging.

+ 

+ [NOTE]

+ ====

+ You need to be added as admin to mailman to access the admin console.

+ ====

+ 

+ == Deployment

+ 

+ In case of new deployment of mailman in infrastructure, there are few tasks

+ that need to be done manually.

+ 

+ === Migrating social accounts from OpenID Fedora to OpenIDC

+ 

+ This needs to be done only once when you update from old OpenID Fedora auth provider

+ to OpenIDC version. Doing this will correctly map the old accounts to new auth provider.

+ 

+ . Log into mailman01

+ . ``cd /srv/webui/bin/``

+ . ``python migrate_fedora_auth.py``

+ +

+ This script does nothing if the users were already migrated.

+ 

  == Removing content from archives

  

  We don't.
@@ -85,13 +133,21 @@ 

  sudo -u mailman mailman3 members -R moderator example@example.com

  ....

  

+ == How to delete a mailing list

+ 

+ Delete a list, but keep the archives:

+ 

+ ....

+ sudo -u mailman mailman3 remove <listname>

+ ....

+ 

  == Troubleshooting and Resolution

  

  === List Administration

  

  Specific users are marked as 'site admins' in the database.

  

- Please file a issue if you feel you need to have this access.

+ Please file an issue if you feel you need to have this access.

  

  === Restart Procedure

  
@@ -99,14 +155,21 @@ 

  own. Otherwise each service on it can be restarted:

  

  ....

- sudo service mailman3 restart

- sudo service postfix restart

+ systemctl restart mailman3

+ systemctl restart postfix

+ systemctl restart mailmanweb

  ....

  

- == How to delete a mailing list

+ === Log locations

  

- Delete a list, but keep the archives:

+ Most of the logs are located in `/var/log/mailman3/`. In case you are looking for

+ postfix logs, they could be found in `/var/log/maillog`.

  

- ....

- sudo -u mailman mailman3 remove <listname>

- ....

+ === Known error messages

+ 

+ These are the error messages that are common in mailman3 logs:

+ 

+ * `NNTP error for list <listname>`

+ +

+ We don't have NNTP server and this couldn't be disabled in mailman3, so you

+ can saw this error in logs, but it could be ignored.

Are last systemctl commands runnable without sudo ?

Otherwise looks good to me.

@copperi systemctl doesn't need to be run with sudo, it will ask for user you want to run it as. But you need to have the sudo permissions to be able to run it. But it's expected that restart of service could be only done by somebody with admin rights.

rebased onto 5a0d618289d95e39b90025e6b6ebd7013f6e5833

11 months ago

Removed Adding Fedora authorization provider as this will be done automatically by ansible playbook.

1 new commit added

  • Add info how to access admin page in mailman
11 months ago

rebased onto d035653

11 months ago

rebased onto d9ddcc9

10 months ago

1 new commit added

  • Add log locations
10 months ago

1 new commit added

  • Add known error messages
10 months ago

This PR is no longer WIP as the mailman3 deployment is getting ready for production deployment.

Looks good to me. Is the NNTP thing still happening? Or was that only before it was disabled?

@kevin Unfortunately I couldn't find a way to disable it, setting it to 0 just throws error on mailman startup, so I just set it to default values.

Ah, ok... then this looks good to merge to me!

rebased onto e95876f

10 months ago

Pull-Request has been merged by zlopez

10 months ago
Metadata