Skip to content

Exports Roundcube webmail configuration (users, identities, contacts, groups...) for a given domain, so it can be easily migrated to a target Roundcube host.

License

Notifications You must be signed in to change notification settings

derhelge/export-roundcube-sql

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 

Repository files navigation

Description

Exports Roundcube webmail configuration (users, identities, contacts, groups...) for a given domain, so it can be easily migrated to a target Roundcube system.

This script reads all the registers (i.e, users, contacts, groups...) from a given domain in a Roundcube database, and outputs the required SQL queries to reproduce them in a different Roundcube database without facing primary key conflicts, thus easing the migration of user data from one installation to another.

It has been tested with Roundcube versions 2013011000 and 2015030800 (as seen with SELECT `value` FROM system WHERE `name` = "roundcube-version"). There are great chances it will work too with all other versions in-between, and even versions out of this range but close to it.

Usage

Usage: $php export-roundcube-sql.php db-user db-pass domain-to-export

Example (in a Parallels Plesk setup):

$php export-roundcube-sql.php admin `cat /etc/psa/.psa.shadow` mydomain.com > dump.sql

Then run dump.sql on your target database.

Troubleshooting

  • Problem: Getting Duplicate entry 'xxxxxxxxxxxxx' for key 'username' when running the generated queries on the target server. Solution: The script assumes no identities/contacts exist on the target machine. As Roundcube may generate some registers upon first login, this may lead to conflicts. Delete these identities/contacts from the target database and re-run the queries.

Additional info

  • This script only performs database reads. It won't actually run any query on the target setup, nor delete the migrated records from the original database.

  • The output queries are not idempotent: running them more than once will lead to unexpected result. So do a backup your target database first and restore it before retrying if something goes wrong in the first place.

  • The script will cowardly refuse to run if Roundcube database version is not between the tested ones. Feel free to tamper this restriction if you are running a different version with the same SQL schema as the versions aforementioned.

  • It would probably be a good idea to empty the cache tables in the target database after completing the migration.

  • This script is thought to be used in-house, so it does little to no data sanitization. Run it only if you trust your inputs.

Author

First released on August 2014, by Jaime Gómez Obregón (@JaimeObregon), from ITEISA (@ITEISA).

Has this been useful to you? Spread the love by dropping a tweet :-)

About

Exports Roundcube webmail configuration (users, identities, contacts, groups...) for a given domain, so it can be easily migrated to a target Roundcube host.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 100.0%