Skip to content

README.md

Latest commit

 

History

History
67 lines (47 loc) · 2.55 KB

README.md

File metadata and controls

67 lines (47 loc) · 2.55 KB
Raw

Roundcube Database Merge Script

This script merges data from one Roundcube database to another, focusing on the users, contacts, collected_addresses, identities, contactgroupmembers, and contactgroups tables. The primary use-case is for merging multiple Roundcube installations databases into a single one.

One of the significant challenges in merging databases is handling conflicts, especially with unique identifiers such as user IDs. This script addresses this by remapping user IDs from the source database (db1) to the destination database (db2). When a user from db1 is inserted into db2, a new user ID is generated. A mapping between the old and new user IDs is maintained to ensure that related records (like contacts and identities) are linked to the correct user in the merged database.

By default, the script will set mail_host under the users table to mail.site.tld where site.tld is the domain name. It's important that you change this record to match the mail server for the user. For example, to change the mail host to localhost for all merged users, replace the following line:

mail_host = "mail." + user['username'].split('@')[1]

with

mail_host = "localhost"

Prerequisites

  1. Ensure you have Python installed (the script was tested with Python 3.12).
  2. Install the mysql-connector-python package: 
    pip install mysql-connector-python

Configuration

  1. Clone the repository:

    git clone https://github.com/hostup/hostup-roundcube-merge.git
cd hostup-roundcube-merge

  2. Set up the database configurations: Open merge.py in your preferred text editor and edit the config_db1 and config_db2 dictionaries at the bottom of the script:

config_db1 = {
    'user': 'YOUR_DB1_USERNAME',
    'password': 'YOUR_DB1_PASSWORD',
    'host': 'YOUR_DB1_HOST',
    'database': 'YOUR_DB1_DATABASE_NAME',
}

config_db2 = {
    'user': 'YOUR_DB2_USERNAME',
    'password': 'YOUR_DB2_PASSWORD',
    'host': 'YOUR_DB2_HOST',
    'database': 'YOUR_DB2_DATABASE_NAME',
}

Replace the placeholders (YOUR_DB1_USERNAME, etc.) with your actual database configuration details.

Running the Script

After configuring, you can run the script using:

python merge.py

Monitor the console output for any errors or issues.

Warning

⚠️ This script directly modifies the databases. Before using it, make sure to take a backup of both databases. Always test the script on a non-production or staging environment before applying it to live data.