iredmail-doc/en_US/migrations/1-migrate.to.new.iredmail.server.md

# Migrate old iRedMail server to the latest stable release

[TOC]

!!! warning

    Please practise the migration on a test server first, make sure you understand
    the whole procedure and migrate all required data.

Since new iRedMail server will install same components as old server, you can choose what data you want to migrate.

Most important data are:

* email accounts stored in SQL/LDAP.
* user mailboxes. Stored under /var/vmail by default.
* SQL database of Roundcube webmail. It stores per-user webmail preferences, and address book.
* <strike>Policyd/Cluebringer database. It stores white/blacklists records, greylisting records, etc.</strike> Note: Policyd/Cluebringer were removed since iRedMail-0.9.3.
* Amavisd database.
    * It stores per-recipient white/blacklists in SQL tables: `mailaddr`, `policy`, `users`, `wblist`.
    * Basic info of in/out emails are stored in SQL tables: `maddr`, `msgs`, `msgrcpt`. Quarantined emails are stored in `quarantine`, it requires other 3 tables. If you don't have any quarantined emails, it's safe to delete all records in these 4 tables.

!!! warning

    Do not restore database `mysql` exported from old server, it contains SQL
    usernames/passwords for Roundcube/Amavisd/iRedAPD/iRedAdmin/... used on
    old server. New iRedMail server has the same SQL usernames, but different
    passwords. So please do not restore it.

## Client settings (Outlook, Thunderbird)

Since iRedMail-0.8.7, iRedMail enforces secure POP3/IMAP/SMTP connections,
please update your mail client applications to use TLS connection.

* For SMTP service, use port `587` with `STARTTLS` (or `TLS`).
* For IMAP service, use port `143` with `STARTTLS` (or `TLS`), or port `993` with `SSL`.
* For POP3 service, use port `110` with `STARTTLS` (or `TLS`), or port `995` with `SSL`.

!!! note

    * If you want to enable smtp authentication on port `25` (again, not
      recommended), please comment out Postfix parameter `smtpd_tls_auth_only = yes`
      in its config file `/etc/postfix/main.cf`.

    * if you want to enable SMTPS (SMTP over SSL, port `465`) to support
      legency mail clients, please follow this tutorial:
      [How to enable SMTPS service](./enable.smtps.html).

## LDAP: migrate mail accounts

Steps to migrate LDAP mail accounts:

* Setup a new server with the latest iRedMail, and make iRedAdmin-Pro-LDAP work as expected.
* Export mail accounts from LDAP on OLD mail server.

Normally, LDAP data can be exported into LDIF format. Here's backup/restore procedure: [Backup and Restore](./backup.restore.html).

Notes:

* There might be some changes in LDAP schema, please find scripts [here](https://bitbucket.org/zhb/iredmail/src/default/extra/update/) to apply all required changes.
* Here are all [upgrade tutorials for iRedMail](https://docs.iredmail.org/iredmail.releases.html).

## MySQL/PostgreSQL: Migrate mail accounts

All mail accounts are stored in database `vmail`.

* If both old and new servers are running same iRedMail version, you can simply
  export `vmail` database on old server, then import it on new server.

* If old server is running an old iRedMail version, there might be some changes
  in SQL structure, please read all upgrade tutorials for the old iRedMail
  release, then apply SQL structure related changes to make sure old server
  has same SQL structure. After you have same SQL structure on both servers,
  you can simply export `vmail` database on old server, then import it on new
  server. Check [upgrade tutorials for iRedMail](./iredmail.releases.html).

## Migrate mailboxes (Maildir format)

!!! warning

    * Make sure the maildir path stored in SQL/LDAP matches the mailbox
      path on file system, so that mail clients can find migrated mail messages.
    * After migrated mailboxes, you may want to recalculate mailbox quota by
      following our tutorial:
      [Force Dovecot to recalculate mailbox quota](./recalculate.mailbox.quota.html)

* Copy all mailboxes (in Maildir format) to new iRedMail server with tools like `rsync`.
* Set correct file owner and permission of mailboxes. Default owner is `vmail`,
  group is `vmail`, permission is `0700`.

* With SQL backends, you can get full maildir path of user with below SQL command:

```
mysql> USE vmail;
mysql> SELECT CONCAT(storagebasedirectory, '/', storagenode, '/', maildir) FROM mailbox WHERE username='user@domain.com';
```

* With OpenLDAP backend, full maildir path is stored in LDAP attribute
  `homeDirectory` of mail user object. You can query with `ldapsearch` command:

```
$ ldapsearch -x -D 'cn=Manager,dc=xx,dc=xx' -b 'o=domains,dc=xx,dc=xx' -W "(mail=user@domain.com)" homeDirectory
```

## Migrate (mlmmj) mailing lists

!!! attention

    mlmmj mailing list was introduced in iRedMail-0.9.8.

Mailing lists are stored in 2 places:

- Mailing list accounts are stored in SQL database (for iRedMail SQL backends)
  or LDAP (for LDAP backends)
- Mailing list data:
    - `/var/vmail/mlmmj`: it stores active mailing lists.
    - `/var/vmail/mlmmj-archive`: it stores removed mailing lists.

For mailing list accounts, they should be migrated while migrating mail
accounts mentioned in steps above.

For mailing list data, you can simply copy them to new server. After copied,
the data must be owned by user/group `mlmmj:mlmmj` with permission `0700`.

## Migrate Roundcube webmail data

* Export/import roundcube webmail database, and upgrade database to work with
  new version of Roundcube.

Reference: <https://github.com/roundcube/roundcubemail/wiki/Upgrade>

## Migrate Amavisd, iRedAPD, iRedAdmin databases

Export those database on old server, then import them on new server.

## Migrate DKIM keys

Amavisd will read DKIM keys and sign outgoing emails. DKIM keys are stored
under `/var/lib/dkim` by default, you can copy all keys under this directory to
new server, and make sure they have correct file owner `amavis:amavis` and
permission `0600`.

If you prefer generating new DKIM keys on new server, don't forget to update
DNS records for mail domain names.

## Post-migration

After migration, please recalculate mailbox quota by following this tutorial:

* [Force Dovecot to recalculate mailbox quota](./recalculate.mailbox.quota.html)

# References

* [Password hashes](./password.hashes.html)
* [Reset user password](./reset.user.password.html)
* [Why append timestamp in maildir path](./why.append.timestamp.in.maildir.path.html)