# $Id: INSTALL.ANY.txt,v 1.67 2025/09/12 13:29:26 gilles Exp gilles $ # # This is the main INSTALL file for imapsync. # imapsync : IMAP sync and migrate tool. This documentation is also located online at https://imapsync.lamiral.info/INSTALL.d/ https://imapsync.lamiral.info/INSTALL.d/INSTALL.ANY.txt ======================================================================= INTRODUCTION ======================================================================= The Perl script imapsync works fine under any operating system with Perl and Perl modules (listed below). The Windows binary imapsync.exe works fine standalone under Windows Seven, Ten, Eleven, 20XX, but only 64bit, which is the standard these days. ======================================================================= Installing imapsync on WINDOWS ======================================================================= Read the file README_Windows.txt Also available at https://imapsync.lamiral.info/README_Windows.txt ======================================================================= Installing imapsync on Unix ======================================================================= There are specific INSTALL files in the imapsync directory INSTALL.d/ Those documents are also available at the page https://imapsync.lamiral.info/INSTALL.d/ - Mac OS X - Debian - Docker - AlmaLinux and CentOS - CPanel - Ubuntu - AWS EC2 - Arch Linux - FreeBSD - Online UI like /X If you are not familiar with any of these systems, but you have to choose one to install imapsync, imapsync online, or the latest imapsync, then Debian 10 or above is the easiest system to consider (August 2025), using the command apt. If you are not on one of these systems, or if you want to see what is under the hood, then read the last section below, called "Installing imapsync on other Unixes". ======================================================================= Installing imapsync on Mac OS X ======================================================================= Easy. But not always. Read the file INSTALL.d/INSTALL.Darwin.txt This document is also available at https://imapsync.lamiral.info/INSTALL.d/INSTALL.Darwin.txt ======================================================================= Installing imapsync on Debian ======================================================================= Easy. See the file INSTALL.d/INSTALL.Debian.txt This document is also available at https://imapsync.lamiral.info/INSTALL.d/INSTALL.Debian.txt ======================================================================= Installing imapsync with Docker ======================================================================= Easy. Read the file FAQ.d/FAQ.Docker.txt This document is also available at https://imapsync.lamiral.info/FAQ.d/FAQ.Docker.txt ======================================================================= Installing imapsync on AlmaLinux and CentOS ======================================================================= Not so easy. Read the file INSTALL.d/INSTALL.Centos.txt This document is also available at https://imapsync.lamiral.info/INSTALL.d/INSTALL.Centos.txt ======================================================================= Installing imapsync on CPanel ======================================================================= Easy. Read the file INSTALL.d/INSTALL.CPanel.txt This document is also available at https://imapsync.lamiral.info/INSTALL.d/INSTALL.CPanel.txt ======================================================================= Installing imapsync on Ubuntu ======================================================================= Not so easy. See the file INSTALL.d/INSTALL.Ubuntu.txt This document is also available at https://imapsync.lamiral.info/INSTALL.d/INSTALL.Ubuntu.txt ======================================================================= Installing imapsync on AWS ======================================================================= Not so easy. See the file INSTALL.d/INSTALL.AWS_EC2.txt This document is also available at https://imapsync.lamiral.info/INSTALL.d/INSTALL.AWS_EC2.txt ======================================================================= Installing imapsync on ArchLinux ======================================================================= Not so easy. See the file INSTALL.d/INSTALL.ArchLinux.txt This document is also available at https://imapsync.lamiral.info/INSTALL.d/INSTALL.ArchLinux.txt ======================================================================= Installing imapsync on FreeBSD ======================================================================= Easy. Read the file INSTALL.d/INSTALL.FreeBSD.txt This document is also available at https://imapsync.lamiral.info/INSTALL.d/INSTALL.FreeBSD.txt ======================================================================= Installing imapsync online like /X ======================================================================= Easy and not easy. Follow the document INSTALL.d/INSTALL.OnlineUI.txt This document is also available at https://imapsync.lamiral.info/INSTALL.d/INSTALL.OnlineUI.txt ======================================================================= Installing imapsync on other Unixes ======================================================================= Not easy. Purchase imapsync at https://imapsync.lamiral.info/ or get it anywhere. You have access to a compressed tarball called imapsync-2.xxx.tgz where 2.xxx is the version number. Untar the tarball where you want: cd tar xzvf imapsync-2.xxx.tgz Go into the directory imapsync-1.xxx cd imapsync-2.xxx You can easily detect any missing Perl modules via the script prerequisites_imapsync located in the INSTALL.d directory: sh INSTALL.d/prerequisites_imapsync or cd INSTALL.d/ sh prerequisites_imapsync You don't need to be root to run the previous command. You have to be root if you want the Perl modules to be available for the whole system, for all users. You may be in one of following cases: - you are not root. - you are in a environment where modifying system Perl modules can break other things or where you're not allowed to change the whole system. The "make" command is a prerequisite to build some Perl modules. Install make in case it is not already installed. Run the "cpanm" command with the missing Perl modules as arguments. For example it can be: cpanm Authen::NTLM Data::Uniqid File::Copy::Recursive IO::Tee \ Mail::IMAPClient Unicode::String Encode::IMAPUTF7 Once you've run the "cpanm" command, you can rerun "sh prerequisites_imapsync" to verify everything is ok: sh prerequisites_imapsync When everything is ok the script execution ends with this sentence "All needed modules are already installed". Now imapsync should work on your system. To check it run: ./imapsync --testslive ======================================================================= =======================================================================