|gha| |codecov|
A simple Modoboa <http://modoboa.org/>
extension which provides a
way to migrate existing mailboxes using OfflineIMAP <http://offlineimap.org/>
.
This extension mainly provides a cron script which periodically synchronize user mailboxes from an existing IMAP server to a new one. The workflow is pretty simple:
A user from the old server logs into Modoboa using the same credentials
A new account is automatically created and a new migration task is created using the provided credentials
The cron script periodically synchronizes mailboxes corresponding to migration tasks
Once a migration is done, it can be disabled through the admin panel
Install this extension system-wide or inside a virtual environment by running the following command::
$ python setup.py install
Then, edit the settings.py
file of your modoboa instance and
add modoboa_imap_migration
inside the MODOBOA_APPS
variable
like this::
MODOBOA_APPS = (
'modoboa_imap_migration',
)
Then, add the following at the end of the file::
from modoboa_imap_migration import settings as modoboa_imap_migration_settings modoboa_imap_migration_settings.apply(globals())
Restart the python process running modoboa (uwsgi, gunicorn, apache, whatever).
Run the following commands to setup the database tables::
$ cd
You also need to install <http://offlineimap.org/doc/installation.html>
_ OfflineIMAP.
.. warning::
Please make sure automatic domain/mailbox creation is enabled, otherwise the authentication won't work. Go to the online settings panel (admin tab) and check your current state.
An IMAP authentication backend is provided by the extension and must be enabled.
Edit the settings.py
file and modify the
AUTHENTICATION_BACKENDS
variable as follows:
.. sourcecode:: python
AUTHENTICATION_BACKENDS = ( 'django.contrib.auth.backends.ModelBackend', 'modoboa_imap_migration.auth_backends.IMAPBackend', )
The synchronization script must be configured to run periodically on
your new server. Since it will copy mailboxes content to its final
destination, filesystem permissions must be respected. To do that, it
must be executed by the user which owns mailboxes (generally
vmail
).
Here is a configuration example where the script is executed every
hours. You can copy it inside the /etc/cron.d/modoboa
file:
.. sourcecode:: shell
PYTHON=/srv/modoboa/env/bin/python INSTANCE=/srv/modoboa/instance
0 /1 vmail cd /srv/vmail && $PYTHON $INSTANCE/manage.py generate_offlineimap_config --output .offlineimaprc && /usr/local/bin/offlineimap > /dev/null 2>&1
Feel free to adapt it.
You need to configure the access to the old IMAP server.
All the configuration is done from the admin panel (Modoboa > Parameters > IMAP migration).
.. |gha| image:: https://github.com/modoboa/modoboa-imap-migration/actions/workflows/plugin.yml/badge.svg :target: https://github.com/modoboa/modoboa-imap-migration/actions/workflows/plugin.yml
.. |codecov| image:: https://codecov.io/gh/modoboa/modoboa-imap-migration/branch/master/graph/badge.svg :target: https://codecov.io/gh/modoboa/modoboa-imap-migration