How to replace your current SquirrelMail or NutsMail 3.x installation with NutsMail 4 ===================================================================================== Welcome to NutsMail 4! The following steps will help you set up NutsMail 4 on your server. These instructions apply equally to SquirrelMail and any previous versions of NutsMail that you may have installed. NutsMail 4 is a complete rewrite of the program, so there's no quick upgrade that will turn your NutsMail 3.x to version 4. The previous version of NutsMail simply has to be replaced the same way that SquirrelMail does. (If you are upgrading from NutsMail 3.x, all the references to "SquirrelMail" in the following text apply to your current NutsMail setup.) 1. Take your current version of SquirrelMail off line ----------------------------------------------------- During the installation process, we will copy the users' data folders which include their preferences, so it's best to take your SquirrelMail off line for the duration of the setup. This way you'll make sure that your users don't make any changes to their preferences while you have already copied their data files to a new location. Please note that it's not enough to modify the index.php file in your SquirrelMail folder to take your SquirrelMail off line. Your users might have bookmarks that take them directly to the login page which is located at "src/login.php", or they might be currently logged in to their webmail. To effectively take your web mail off line you should rename the SquirrelMail folder. 2. Install NutsMail 4 --------------------- Copy all the files and folders from the NutsMail 4 package to an empty folder on your server. 3. Install the themes --------------------- Copy the themes you purchased to the NutsMail 4 "themes" folder. (Please note that the themes from NutsMail 3.x WILL NOT work on NutsMail 4.) 4. Change NutsMail file/folder permissions ----------------------------------- If you extracted NutsMail from the archive directly on the server using shell access, you will need to change the NutsMail file and folder permissions to be readable by the server. If you used FTP to copy the NutsMail files to the server you can skip this step. 5. Copy user data ----------------- There are two folders that store SquirrelMail user information and files: data and attach. These data and attach folders are located either in your SquirrelMail folder or outside of your web server directory. (It is safer to store them outside of your web server directory, since that minimizes the risk of someone gaining access to them.) The names and locations of these folders are specified in the file config/config.php located in your SquirrelMail folder (see $data_dir and $attachment_dir). Follow the instructions that best describe your situation: a) If the folders are located in your SquirrelMail directory and you're fine with keeping them under your server root (the way they were), simply copy the folders "data" and "attach" from the SquirrelMail directory to the NutsMail 4 directory. b) If the folders are located outside of your server root, you don't need to copy anything. When you start NutsMail 4 for the first time, you'll see a configuration screen where you'll be able to specify the location of these folders. c) If the folders are located in your SquirrelMail directory, but you'd like to secure your email system better (highly recommended), copy the user folders from your SquirrelMail directory to a directory outside of your server root. When you start NutsMail 4 for the first time, you'll see a configuration screen where you'll be able to specify the location of these folders. (You will need root access to copy the "data" and "attach" folders.) 6. Change configuration file permissions ---------------------------------------- The configuration files: config/config.php and data/default_pref (wherever your data folder is located) need to be writable to the server for the duration of the setup. Change their permissions to allow the server to write to them. 7. Install additional plugins ----------------------------- If you had any custom plugins installed in your SquirrelMail setup, copy them from your SquirrelMail plugins directory to the NutsMail 4 plugins directory, edit config/config.php and add their names to the plugin list. IMPORTANT: Do not overwrite any plugins that are already located in NutsMail 4 directory. NutsMail 4 comes with a lot of upgraded, improved and styled plugins, if you overwrite them, you will lose all that upgraded functionality and styling. 8. Start and configure NutsMail 4 --------------------------------- Navigate to the NutsMail folder using a browser to display the NutsMail configuration page. (If you see a blank page, your server most likely cannot access the NutsMail files due to permissions problems. Change the NutsMail files permissions to allow the server read-only access to the files and read/write access to the configuration files - points 4 and 6. If that doesn't help, check your server error log for clues as to what the problem is.) On this configuration page you should configure your NutsMail installation to the same settings that you used in your SquirrelMail. If you are not sure what any of the settings should be set to, you can check your SquirrelMail configuration by opening the config/config.php file in your SquirrelMail folder. Make sure to specify the correct paths to your "data" and "attach" folders on the Paths page, and enable the plugins you need on the Plugins pages. If you'd like to be able to access this configuration page in the future, specify your email address in the "Administrator's login" box. When you log in using the address specified there, you'll find the configuration page under Options / NutsMail Admin Panel. 9. Finish the installation -------------------------- Now your new NutsMail installation should be up and running! After you make sure that everything's working properly, you can start using it instead of your old SquirrelMail installation. The easiest way is to rename the NutsMail folder to the name of your old SquirrelMail folder. Please make sure to keep your SquirrelMail folder on the server for a while longer, in case you need to refer to it for any reason. Now that the configuration is completed, you can make the files config/config.php and data/default_pref read-only again. But remember that you'll need to make them writable if you want to configure NutsMail again using the NutsMail Admin Panel. For instructions on how to install additional languages, please visit the FAQ section at http://nutsmail.com. Congratulations! You have successfully upgraded to NutsMail 4! We hope you'll enjoy your web mail's new look! + + +