[Pkg-mailman-hackers] Bug#999861: mailman3-web: Please include instructions for migrating from mailman 2.1

[Alex King]

Package: mailman3-web
Version: 0+20200530-2
Severity: normal
Tags: newcomer patch

Dear Maintainer,

I had an install running on mailman 2.1, which was working (mostly) fine.
Mailman 2.1 is no longer available, so I upgraded to mailman 3.

I followed the instructions in /usr/share/doc/mailman3/README.Debian which
worked, but there were no instructions for migrating the old archives to
hyperkitty.  I googled and found several sites purporting to say how to do
this but none of the ones I found was specific to Debian.

In the end, this site (https://docs.mailman3.org/en/latest/migration.html)
combined with some information from
https://lists.mailman3.org/archives/list/mailman-users@mailman3.org/thread/75BSXEULXUJ7XXJX5AYLDE3OD7RLNYYM/
allowed me to import the archives, using the following 2 commands per list:

sudo -u www-data /usr/share/mailman3-web/manage.py hyperkitty_import -l mylist at list.king.net.nz /var/lib/mailman/archives/private/mylist.mbox/mylist.mbox
sudo -u www-data /usr/share/mailman3-web/manage.py update_index_one_list mylist at list.king.net.nz

This was successful.  However, it took some hours of research and trial and
error to find it.  The important information that would have helped me a
great deal was 1. to run the import as the www-data user, and 2. that
manage.py is located in /usr/share/mailman3-web/ in Debian.

Since I'm moving my production list server on a Debian install, I expect
sufficient notes in README.Debian to upgrade from previous releases without
having to do extensive searches and trial and error.

I suggest the follwing is added at the end of
/usr/share/doc/mailman3-web/README.Debian.gz:

Migrating archives to mailman 3 and HyperKitty
==============================================

To migrate list archives from Mailman 2.1 to mailman3 and the HyperKitty
archiver, follow the instructions at
https://docs.mailman3.org/en/latest/migration.html.

The mailman command should be run as mailman_wrapper on Debian systems.  A
new empty list needs to be created with the name you want in mailman3, then
the following command will import the list from mailman 2.1:

mailman-wrapper import21 foo-list at example.com /var/lib/mailman/lists/foo-list/config.pck

The manage.py script is installed at /usr/share/mailman3-web/manage.py.  The
script should be run as the user www-data, so (given the caveate that your
existing mbox file is in good shape per note 2 on the migration
instructions,) the commands required to migrate the archives are:

sudo -u www-data /usr/share/mailman3-web/manage.py hyperkitty_import -l foo-list at example.com /var/lib/mailman/archives/private/foo-list.mbox/foo-list.mbox
sudo -u www-data /usr/share/mailman3-web/manage.py update_index_one_list foo-list at example.com

-- System Information:
Debian Release: 11.1
  APT prefers stable
  APT policy: (990, 'stable'), (500, 'stable-security'), (500, 'testing')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 5.10.0-9-amd64 (SMP w/4 CPU threads)
Locale: LANG=en_NZ.UTF-8, LC_CTYPE=en_NZ.UTF-8 (charmap=UTF-8), LANGUAGE=en_NZ:en
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled

Versions of packages mailman3-web depends on:
ii  cdebconf [debconf-2.0]     0.260
ii  dbconfig-mysql             2.0.19
ii  dbconfig-sqlite3           2.0.19
ii  debconf [debconf-2.0]      1.5.77
ii  init-system-helpers        1.60
ii  lsb-base                   11.1.0
ii  python3                    3.9.2-3
ii  python3-django-hyperkitty  1.3.4-4
ii  python3-django-postorius   1.3.4-2+deb11u1
ii  python3-mysqldb            1.4.4-2+b3
ii  python3-psycopg2           2.8.6-2
ii  python3-whoosh             2.7.4+git6-g9134ad92-5
ii  ucf                        3.0043
ii  uwsgi-core                 2.0.19.1-7.1
ii  uwsgi-plugin-python3       2.0.19.1-7.1

Versions of packages mailman3-web recommends:
ii  libapache2-mod-proxy-uwsgi  2.4.48-3.1+deb11u1

Versions of packages mailman3-web suggests:
ii  default-mysql-server                        1.0.7
ii  mariadb-server-10.5 [virtual-mysql-server]  1:10.5.12-0+deb11u1

-- debconf information:
  mailman3-web/pgsql/authmethod-user: password
  mailman3-web/nginx-choice:
  mailman3-web/configure-webserver: none
  mailman3-web/missing-db-package-error: abort
  mailman3-web/dbconfig-install: true
  mailman3-web/pgsql/changeconf: false
  mailman3-web/dbconfig-remove: true
  mailman3-web/remote/newhost:
  mailman3-web/remote/host: localhost
  mailman3-web/pgsql/method: TCP/IP
  mailman3-web/mysql/method: Unix socket
  mailman3-web/dbconfig-upgrade: true
  mailman3-web/remove-error: abort
* mailman3-web/mysql/admin-user: debian-sys-maint
  mailman3-web/emailname: localhost.local
* mailman3-web/superuser-mail: alex at king.net.nz
  mailman3-web/db/dbname: mailman3web
  mailman3-web/upgrade-backup: true
  mailman3-web/remote/port:
  mailman3-web/restart-webserver: true
  mailman3-web/db/app-user: mailman3web at localhost
  mailman3-web/internal/skip-preseed: false
  mailman3-web/upgrade-error: abort
  mailman3-web/mysql/authplugin: default
* mailman3-web/database-type: mysql
  mailman3-web/pgsql/admin-user: postgres
  mailman3-web/pgsql/manualconf:
  mailman3-web/pgsql/no-empty-passwords:
  mailman3-web/dbconfig-reinstall: false
  mailman3-web/install-error: abort
  mailman3-web/purge: false
  mailman3-web/internal/reconfiguring: false
  mailman3-web/passwords-do-not-match:
  mailman3-web/superuser-name: admin
  mailman3-web/pgsql/authmethod-admin: ident
  mailman3-web/db/basepath: