AXIGEN MIGRATOR
===============

The Axigen Migrator is a cross platform application that allows admins
to migrate PIM (Calendars, Tasks, Notes, and Contacts) from a legacy 
mail server to Axigen. 

What is migrated - Personal Calendars, Tasks, Notes, and Contacts from 
supported legacy servers. 

What is not migrated - Public and shared Calendars, Tasks, Notes, and 
Contacts are not migrated.


SUPPORTED LEGACY SERVERS
------------------------
The currently supported legacy mail servers:
	* Kerio Connect: versions 9.0.0 - 9.2.x
	* Communigate Pro: versions 6.0.9 - 6.1.13

Important Notes:
    * For Communigate Pro, the "Non-Mail Mailboxes visible via IMAP" must be explicitly disabled in "Account defaults", or specifically, for each account to be migrated.
    * For Kerio Connect, the "Misc" / "IMAPFullListing" option in the configuration file must not be enabled (default is 0, disabled).


PRELIMINARY STEPS
-----------------
1. Unpack the archive and copy the "aximigrator" application folder
	(containing the binary and config file) to your Axigen working
	directory. Typically, this is:
		* For Linux and Solaris: /var/opt/axigen/
		* For Windows: C:\Program Files\Axigen Mail Server\


2. Edit the config.toml file, entering the IP / Hostname of the source 
	and destination IMAP servers and ports.


RUNNING THE APPLICATION
-----------------------
IMPORTANT NOTE!
The Axigen Migrator does not create users in Axigen. Before running 
it, please make sure that you already have the domains and the users 
created, with the same login credentials as in the source server. 

	* Linux:
		axigen-migrator
	* Windows:
		axigen-migrator.exe -o [-c pathToConfigFile] [-u AccountEmail] [-p AccountPassword]
	* macOS:
		axigen-migrator -o [-c pathToConfigFile] [-u AccountEmail] [-p AccountPassword]

	* Command line arguments:
		-c <config_file>
			Provide the path to the configuration file. The default value is "config.toml", in the working directory.
			If a relative path is specified, it is considered relative to the working directory. If a full path is specified, it is used without prepending the working directory.

		-u <username>
			Username (email address) to migrate.
			Must be used together with the password argument.
			Can be used in Oneshot (-o) and Queue (-q) modes.
			Must not be used together with a CSV input file (-f).

		-p <password>
			Password of the user to migrate.
			Must be used together with the username argument.
			Can be used in Oneshot (-o) and Queue (-q) modes.
			Must not be used together with a CSV input file (-f).

		-f <userlist_csv_file>
			Use a CSV file as input.
			The CSV file must contain one username/password pair per line, separated by comma (e.g.: user1,password1\r\nuser2,password2).
			May not be used together with username (-u) or password (-p) arguments.

		-q
			Queue mode
			Queue the specified username/password pair(s) and start the migration daemon.
			The daemon will exit after it no longer has username/password pairs in the DB for migration.
			May be used while the migration daemon is running (if the migration daemon is already running, the username/password pair(s) will be added to the DB without starting the daemon again).
			Mandatory (either -q or -o).

		-o
			Oneshot mode
			Will start migration for the user/password pair(s) provided, one by one.
			Will exit after all username/password pairs were migrated (successfully or failed).
			Only one migration attempt is performed for each user.
			Mandatory (either -q or -o)

	    -w <working directory>
	        Provide the path to the working directory. Default is current directory (".").
	        This is used for storing the logs directory, the AMI database (ami.db) and as base path for the config file, if an absolute path is not explicitly specified with the -c option below.

	    -s <source_server_IMAP_URI>
	    	Specifies the source server connection details in command line mode.
	    	When running in command line mode, this is mandatory together with -d and -l

	    -d <Axigen_server_IMAP_URI>
	    	Specifies the Axigen server connection details in command line mode.
	    	When running in command line mode, this is mandatory together with -s and -l

	    -l <logLevel>
	    	Specifies the log level in command line mode (INFO or DEBUG).
	    	When running in command line mode, this is mandatory together with -s and -d	    	

	    -v
	    	Displays the Axigen Migrator version.


		* Examples:
			./axigen-migrator -o -u user1@example.com -p u1passwd
			./axigen-migrator -o -f users.csv
			./axigen-migrator -q -u user1@example.com -p u1passwd

KNOWN ISSUES
------------
	* The -q mode on Windows can't find whether the daemon (PID) is already running.