Skip to content

Migration tool helping you to carry your data over to MUM

License

Notifications You must be signed in to change notification settings

mum-project/migrator

Repository files navigation

MUM Migrator

This is a tool for migrating old data from other mailbox administration systems into MUM. The idea of this console program is to save you from having to copy every address over by hand. Instead, configure the necessary database connection options in a .env file and let this tool do the rest. We chunk results from the database, so there should not be a problem with large numbers of domains / mailboxes / aliases. MUM Migrator currently only supports migrating data from ViMbAdmin.

Installation

Firstly, clone this repository and configure the necessary database options. Secondly, install the dependencies with composer.

git clone https://github.com/mum-project/migrator.git
cd migrator/
cp .env.example .env
nano .env
composer install --optimize-autoloader --no-dev

Migrating from ViMbAdmin

The first step is to configure all database options for both the already migrated MUM database (prefixed with MUM_DB_ in the .env file) and the ViMbAdmin database (prefixed with VIMBADMIN_DB_ in the .env file).

Since ViMbAdmin does not save a root folder path for home directories in their database, you will need to provide that path with a console option when calling the migrator script. We assume your home directories are created according to the following scheme: /path/to/root/%d/%m where %d stands for the domain and %m for the mailbox (it does not matter if this is the local part or the address).

To migrate your data, call MUM Migrator:

php migrator migrate:vimbadmin --homedir-root /path/to/root

MUM's database should now contain your migrated data.

Contributing

You want to help? Awesome! Have a look at the Contribution Guide and start coding.

License

The MIT license. Please see the license file for more information.

Copyright © 2018-2020 Martin Bock.