vtiger CRM 5.0.2 Installation Manual (For Wiindows OS) (For W ndows OS) Document History Revision 5.0.2 Date: October 30, 2006 -2Table of Contents 1. System Requirements .......................................................................3 2. How do I choose right distribution? .....................................................4 3. Installation Prerequisites ...................................................................5 4. Installing in Apache Web Server .........................................................6 4.1 Installing Complete Package ................................................................ 6 4.2 Installing without Apache and MySQL.................................................... 8 4.3. Installing vtiger CRM Source ..............................................................10 5. Installing vtiger CRM in Microsoft IIS................................................. 13 6. Starting & Stopping vtiger CRM Server .............................................. 14 7. Configuring vtiger CRM Server.......................................................... 15 8. Starting vtiger CRM in Web Browser .................................................. 18 9. Upgrading to 5.0.2 ......................................................................... 19 10. Troubleshooting Tips ..................................................................... 20 11. Known Issues............................................................................... 22 12. Related Documents ....................................................................... 23 13. Customer Support......................................................................... 24 Copyright 2003-2006 vtiger.com. All rights reserved. vtiger is a trademark of vtiger.com. All other trademarks are the property of their respective owners. 1.x version. Web Browser: IE 5. Operating System: Windows 2000/NT/XP.1.1.0. System Requirements • • • • • • Hardware: x486 with 512 MB RAM or higher with a minimum of 250 MB disk space. or Opera version 7.com.0.x and above. Firefox 1.x through 5. Database: MySQL version 4. PHP: 5.com.40 and higher or Microsoft version IIS 5 and higher.5. Web Server: Apache version 2.5/6.-3- 1. All other trademarks are the property of their respective owners. .0. All rights reserved. Copyright 2003-2006 vtiger.x through 5.21 and above. vtiger is a trademark of vtiger.x. com.0. Recommended vtiger CRM Distributions Type of User I am new to Web-based software – Beginners I have hands-on experience with Apache and MySQL.0.-4- 2.exe vtigercrm-5. How do I choose right distribution? vtiger CRM software is available in both executable and source formats. but not familiar with PHP – Intermediate Users I have hands-on experience with MySQL and PHP-based applications – Advanced PHP Users/Developers/Hosting Service Providers Distribution Type vtigercrm-5. vtiger is a trademark of vtiger.exe vtigercrm-5. All other trademarks are the property of their respective owners.2.com.tar. You can choose the right distribution according to your experience with LAMP/WAMP based applications.gz Copyright 2003-2006 vtiger.2. All rights reserved. .2.0. All rights reserved.x.1. If you are installing without Administrator privileges.1. MySQL 4. and PHP 5.0. Otherwise use the Apache and MySQL bundled with vtiger CRM software.0x through 5. . All other trademarks are the property of their respective owners. vtiger CRM software is compatible with Apache 2.ini) configuration .com. Read/Write permissions for some of the vtiger CRM directories – Applicable to vtiger CRM Source Installation PHP settings (php. Installation Prerequisites • You must have "Administrator privileges" on the system. you can use the same. vtiger is a trademark of vtiger. stop the Apache and MySQL services.x.-5- 3. vtiger CRM software will not be installed properly. If these software are already installed in your system.Applicable to vtiger CRM Source Installation • • • • Copyright 2003-2006 vtiger.1.x through 5. Before installing vtiger CRM software.40.com. 0. Use this package if you have already installed Apache and MySQL. 4. 4. In the Welcome to the InstallShield Wizard for vtiger CRM dialog.2.0. MySQL. You can install vtiger CRM according to your software requirements: • Install complete package of vtiger CRM .-6- 4. and PHP packages in your system. 5. But PHP package will be installed even though it is available in your system.vtigercrm-5.net. Note: Use this package if you have not installed Apache. Follow the steps given below to install Apache Web server bundled with vtiger CRM: Copyright 2003-2006 vtiger. MySQL. To install the complete package of vtiger CRM: 1.tar.gz. vtiger CRM is bundled with optimized versions of Apache.com. 3.exe. In vtiger CRM Software License Agreement dialog.exe. MySQL. packages in your system. Apache. and PHP are very essential.0. Note: This package is same as above except that you may not install Apache and MySQL. Installation process starts within a few seconds. and PHP in your system. read the license agreement and click the Yes button if you accept the license agreement.2. • Install vtiger CRM source – vtigercrm-5. All other trademarks are the property of their respective owners.0. Note: Use this package if you have already installed Apache or Microsoft IIS. All rights reserved.2. and PHP along with vtiger CRM core modules. Download vtigercrm-5.0.2.2.exe. MySQL. Run the vtigercrm-5. vtiger is a trademark of vtiger.vtigercrm-5. 2.1 Installing Complete Package For the convenience of business community and novice PHP.exe from the Sourceforge. Installing in Apache Web Server To install vtiger CRM.com. • Install vtiger CRM with bundled PHP . . click the Next button. conf and %SystemRoot%/php. select the Install MySQL option and click the Next button. In the Start Copying Files dialog. Follow the steps given below to install MySQL bundled with vtiger CRM: i.com. use the default Port as 3306. ii. Click the Next button to start the installation or click the Cancel button to abort the installation. ii. you can use the default port number "80". enter the following MySQL connection parameters and click the Next button: Port Number: The port at which MySQL database server to must be started. In the MySQL Connection Parameters Configuration dialog. After selecting the destination directory. and PHP configuration settings. In the Chose Destination Location dialog. iii. 6. If you are not sure. It will take approximately five minutes to complete the installation. Please proceed further if you accept these changes. 9. Also a backup copy of these files will be stored under %SystemRoot%/vtigerbackup folder. vtiger is a trademark of vtiger. and User Name as root. In the Install MySQL Options dialog. All other trademarks are the property of their respective owners. select the Install Apache option and click the Next button. In the Install Apache Options dialog. Password: The password for the user. 7. review Apache. select the Start the apache as a service check box to automatically start vtiger CRM as a service during startup. Note: During vtiger CRM installation. User Name: The user name to login in to the MySQL database. All rights reserved.ini files will be modified. either use the default directory C:\Program Files\vtigerCRM5_0 or select a new directory.com. In the Select Program Folder dialog. Now click the Next button. <Apache Home>/conf/httpd. click the Next button. Keep the Password field empty. . enter the port number in which Apache Web server must be started and click the Next button. In the Install Apache Web Server Port Selection dialog. Copyright 2003-2006 vtiger. If you are not sure.-7i. In the Apache Service Option dialog. 8. either use the default program folder vtiger CRM 5 or enter a new folder. MySQL. 4. installation will not proceed further.net. 4. iii. Follow the steps given below to use the existing Apache Web server: i. Copyright 2003-2006 vtiger. Follow the steps given below to use the existing MySQL: i.com. Follow the procedure given below to install only vtiger CRM: 1. 5. 6. I want vtiger CRM icon on desktop option if you want a desktop shortcut.com. 2. In the Welcome to the InstallShield Wizard for vtiger CRM dialog. 3.conf file of the Apache installed in your system. read the license agreement and click the Yes button. In vtiger CRM Software License Agreement dialog. Also select the Yes. browse the directory where MySQL is installed and click the Next button. Click Yes if you accept the “This selection will take backup and modify the httpd. vtiger is a trademark of vtiger. browse the directory where the Apache is installed. In the Apache Web Server Home Selection dialog. All rights reserved. if you accept the license agreement.conf present under the <Apache Home>/conf directory. In the Apache Web Server Home Selection. click the Next button. select the Use Installed Apache option and click the Next button.-810. In the MySQL Path Selection dialog. Click the Finish button. Download vtigercrm-5. Run the vtigercrm-5. Do you want to continue?” message. In the Install MySQL Options dialog. select the Yes I want to start the server option if you want to start vtiger CRM server immediately. .exe from the Sourceforge. It will take a few minutes to start vtiger CRM server. Installation process starts within a few seconds. ii. iv.exe. Please note that if you give a wrong directory. will be modified during vtiger CRM installation.2. In the Installation Wizard Complete dialog. All other trademarks are the property of their respective owners.2 Installing without Apache and MySQL Use the existing Apache and MySQL if already installed in your system provided these versions are compatible with vtiger CRM. select the Use Installed MySQL option and click the Next button. In the Install Apache Options dialog.0. ii. The Apache configuration file httpd. click the Next button.2.0. backup. 8. Click the Finish button. and PHP configuration settings. 7.com. All rights reserved.ini files will be modified. 9. enter the following MySQL connection parameters and click the Next button: Port Number: The port at which MySQL database server is running. iii. I want vtiger CRM icon on desktop check box if you want a desktop shortcut. review the Apache. select the Yes I want to start the server check box if you want to start vtiger CRM server immediately. In the Installation Wizard Complete dialog. If you are not sure.com. Note: During vtiger CRM software installation. you can use the default Port – 3306. the <Apache Home>/conf/httpd. Password: The password for the user. Copyright 2003-2006 vtiger. User Name: The user name to log in to the MySQL database. In the Start Copying Files dialog. vtiger is a trademark of vtiger.conf and %SystemRoot%/php. installation will not proceed further. Click the Next button to start the installation or click the Cancel button to abort the installation.-9Warning: If you give a wrong directory. Also a backup copy of these files will be stored with file extension as vtigercrm. either use the default program folder or enter a new folder. . Please proceed further if you accept the changes. User Name – root. MySQL. Now click the Next button. Also select the Yes. In the MySQL Connection Parameters Configuration dialog. Keep the Password field empty. In the Choose Destination Location dialog. It takes approximately five minutes to complete the installation. All other trademarks are the property of their respective owners. 10 - 4.tar.1 Installing Complete Package How to get WAMP? WAMP stands for Windows.gz from the Sourceforge.x (you must configure php.6.ini settings as per Pre-installation Check List.exe).0. The most popular sites that provide WAMP setup are WAMPP and XAMPP (apachefriends. There are many Websites offers WAMP distributions freely. Beginners are strongly recommended to use the vtiger optimized WAMP setup (vtigercrm-5.5. IMPORTANT NOTE vtiger CRM Source installation is targeted only for the Advanced Users/Developers/Hosting Providers.2.com). and PHP with some other Add-on packages from various sources.x PHP – 5. You can download optimized Apache. Installing vtiger CRM Source If you are already using WAMP environment for other PHP based applications.2. To install vtiger CRM Source 1. All other trademarks are the property of their respective owners. If you are using PHP based application first time. you can very well use the same setup for vtiger CRM installation. vtiger is a trademark of vtiger. All rights reserved. .gz file into Apache root directory (For example.x through 5.com. Download vtigercrm-5.1. Otherwise some of the features will not work. MySQL. • • • Apache – 2.5 XAMPP: Version 1.1. Extract the vtigercrm-5.40 and above MySQL – 4.com.3.0.0.2. C:\Program Files\Apache Group\Apache2\htdocs) Copyright 2003-2006 vtiger. please skip this section and follow the steps in 5.tar.0. provided your setup meets the vtiger CRM requirements. 2. MySQL.1. MySQL.net. Recommended WAMP Distributions: WAMP: Version 1.3a Before using your own WAMP setup. Apache.. and PHP versions meet the vtiger CRM requirements. and PHP. please ensure that Apache. 11 3.com.. vtiger is a trademark of vtiger.php Cache Directory .test/user/ Contact Image Directory.user_privileges/ Smarty Compile Directory . All rights reserved.inc.tabdata.parent_tabdata. You must have READ/WRITE permissions on the following vtiger CRM folders: • • • • • • • • • • • • • • • • PHP Configuration .com. All other trademarks are the property of their respective owners. Your php.cache/ Mail Merge Template Directory -test/wordtemplatedownload/ Uploads Directory .php Product Image Directory -test/product/ User Image Directory .config. .storage/ Install Directory . Start Web Browser and follow the procedure given in the "Configuring vtiger CRM Server" section for completing vtiger CRM installation.test/contact/ Logo Directory.test/logo/ Email Templates Directory -modules/Emails/templates/ User Privileges .ini must configured with following parameters: • • • safe_mode = Off display_errors = On file_uploads = On Copyright 2003-2006 vtiger.Smarty/templates_c Tabdata File Permission . Pre-installation Check List 1.php ParentTabdata File Permission .php Smarty Cache Directory .Smarty/cache 2.install/ Installation file -install. .12 Pre-installation Check List • • • • • • • • • • • • register_globals = Off max_execution_time = 600 output_buffering= On memory_limit = 32M error_reporting = E_WARNING & ~E_NOTICE allow_call_time_reference = On log_errors = Off short_open_tag= On extension=php_gd2.dll extension=php_mysql. vtiger is a trademark of vtiger.dll Copyright 2003-2006 vtiger.dll extension=php_imap..com. All rights reserved.dll extension=php_mysqli. All other trademarks are the property of their respective owners.com. com.ini in your Windows folder (C:\WINNT on my computer): cgi. 2. Open the PHP. All other trademarks are the property of their respective owners.0. Once you've downloaded it. Please refer to the following sites for more details: • http://in.force_redirect = 0 2. . Otherwise.gz from the Sourceforge. Installing vtiger CRM in Microsoft IIS vtiger CRM source can be installed in Microsoft IIS.net/manual/en/install. All rights reserved.ini file: Download the Windows binary for the latest version of PHP (vtiger CRM supports PHP version 5.2.cgi. Configuring Microsoft IIS to work with PHP-based application Please follow the procedure given below to execute PHP scripts in Microsoft IIS: 1.phpbuddy. To install vtiger CRM in Microsoft IIS.x). unzip it to a C:\ and rename the folder to "php".windows. Make the necessary changes and save the file as php. Copyright 2003-2006 vtiger. and PHP before installing vtiger CRM. some of the images/files cannot be executed. MySQL.13 - 5..gz file into IIS root directory (For example. C:\Inetpub\wwwroot\).com/category.0.iis.tar. follow the procedure given below: 1.net. You must have already installed the Microsoft IIS 5 or above.php?cat_id=INST Note: All the directories under vtigerCRM should have READ access permission. Start Web browser and follow the procedure given in the "Configuring vtiger CRM Server" section for completing vtiger CRM installation.com.php. Download vtigercrm-5.tar.php • http://www.INI-DIST file from the C:\PHP folder and locate the following line: . 3.2. Extract the vtigercrm-5.1. vtiger is a trademark of vtiger. Configuring PHP in Microsoft IIS.force_redirect = 1 Remove comment in the above line and change the setting to 0 as shown below to run PHP under IIS. Configuring the php. php. Copyright 2003-2006 vtiger.14 - 6. Starting & Stopping vtiger CRM Server You can start or stopped according to the type of distribution. start vtiger CRM server as given below: • • • Select Start Program Files vtiger CRM Start vtiger CRM Click vtiger CRM desktop shortcut. and PHP with vtiger CRM. start Apache manually and connect to vtiger CRM from http://<host Name>:<port number>/<vtigerCRM Home>/index.. vtiger is a trademark of vtiger. select Start Program Files vtiger CRM Stop vtiger CRM. To stop vtiger CRM Server • • If you have installed the bundled Apache.com. All rights reserved. If you are using your own WAMP setup. MySQL.com. To start vtiger CRM Server • If you have installed the Apache and MySQL that are bundled with vtiger CRM. . stop the Apache and MySQL manually. If you are using your own WAMP setup. All other trademarks are the property of their respective owners. Note: Please ensure that all the directories have the read/write permission.15 - 7. config. Start Web browser and enter <localhost>/vtigerCRM/index. All rights reserved. 3. You can also create a database as per your requirements. All other trademarks are the property of their respective owners. you cannot work with features that require file upload and download. Password (optional)– Specify password for the username. In the System Configuration page. In the System Check page. .php. otherwise. Please do not change the port number as it is added during installation. you must configure vtiger CRM server with database. Root Password (mandatory)– Specify password for the root username. User Name (mandatory)– Specify username for accessing the database. Website. Host Name is set as <System Name>:<Port No>. 2. which will take about 5 minutes time. Afterwards click Next button. MySQL database. currency. and GD graphics library version status are displayed. specify root user name for creating database. complete the product registration (optional). PHP. Database Configuration • Host Name (mandatory) – By default. In the Registration page. • • • • • Site Configuration Copyright 2003-2006 vtiger. directories that have read/write permissions. enter the appropriate values for Database.com.com. Click the Start button.php in location bar. Click the Next button.. Root User Name (mandatory)– If you have selected the create data option in Database Name field. 4. The vtiger CRM database tables and demo data are populated during configuration. Configuring vtiger CRM Server After installing vtiger CRM. and administration access details. Database Name (mandatory)– By default database name is vtigercrm5. vtiger is a trademark of vtiger. 1. and Administration sections. Site Configuration. Once you have logged in successfully. by default the User Name field is set as “admin”. review the configuration information. Path to Cache Directory (must have write permission) . You can change password after logging in to vtiger CRM. This folder is used to store the files. this is cache/. Once installation is completed successfully. If you want to change the details. such as attachments. enter the admin password you have set during installation process. USD). select the Also populate demo data? check box. You can also change the administrator’s e-mail ID. the password is set as “admin”. Click the Finish button to complete the installation process. installation directory will be locked to secure your installation against unauthorized access. 6.. 5. In the Config File Creation page. the created database tables are displayed.com. Admin Configuration • • User name – By default. Code (mandatory) – Specify international code of your currency (For example.related files temporarily. $). In the Confirm Settings page. . By default. Dollar). All rights reserved.com. and import/export.By default. In Password field. All other trademarks are the property of their respective owners. this is the path where vtiger CRM is installed. click the Next button. • Currency Configuration • • • Name (mandatory) – Specify your fiscal currency name (For example. In the Login page. vtiger is a trademark of vtiger. Admin password (mandatory) – By default. you can view the vtiger CRM Home page as shown Copyright 2003-2006 vtiger.com. Now click the Next button.16 • • • URL (mandatory) – Enter the host name. It will take approximately 4 minutes to complete the configuration. In the Create Database Tables page. Path (mandatory) – By default. click the Change button. the user name is set as “admin”. it is http://<system name>. 7. If you want to populate some data. Email ID – By default email ID is admin@your-domain. Symbol (mandatory) – Specify your currency symbol (For example. .. All other trademarks are the property of their respective owners. vtiger is a trademark of vtiger.com.com. All rights reserved.17 below: Copyright 2003-2006 vtiger. Copyright 2003-2006 vtiger.. .com.com. All rights reserved. Starting vtiger CRM in Web Browser • • If you installed the Apache and MySQL that are bundled with vtiger CRM. open the http://<host-name/<vtiger CRM Home>/index.php in Web browser.18 - 8. vtiger is a trademark of vtiger. select Start Program Files vtiger CRM vtiger CRM Client If you are using vtiger CRM source with your own WAMP environment. All other trademarks are the property of their respective owners. 2 Warning: Please don't forget to take the source code backup before extracting the patch. Download the vtiger CRM 5 .com. .0.com.x V 5.0_Patch_2. 5. open the vtiger CRM in Web browser and login as a Admin user 4.net 2. To upgrade to version 5. otherwise all your custom code will be overwritten by the new code.2 V 5.0 V 5.0.Patch 2 patch from Sourceforge.0. Currently we are providing UI based data migration for the following versions • • • V 4. vtiger is a trademark of vtiger. follow the steps given the wizard. All rights reserved.0.2 1.2.2 We strongly recommend users to migrate from the vtiger CRM previous version to the latest version vtiger CRM 5.2.0. In the Migration Wizard. Now. All other trademarks are the property of their respective owners.zip to<vtiger CRM Home> directory 3.2 V 5.1 V 5.0.19 - 9.0. Extract the vtiger_CRM_5. Click the Settings Other Settings Migration Wizard link.0. Copyright 2003-2006 vtiger.. Upgrading to 5.0. 2. If you experience any problems.com.rootLogger is set as “debug” in log4php. 4. change the logging level to “fatal” or “warning” Copyright 2003-2006 vtiger. All rights reserved. Drop the existing vtigercrm database from MySQL as given below: mysql>drop database vtigercrm. I am unable to complete the initial configuration process and the following error message is displayed in Web browser: Warning: mysql_connect(): Host <'Server Name'> is not allowed to connect to this MySQL server in C:\Program Files\vtigerCRM\apache\htdocs\vtigerCRM\database\DatabaseConnection. start vtiger CRM client from Start Program Files vtiger CRM Start vtiger CRM..php on line 42 Could not connect to server <Server Name>:<port no> as vtigercrm.Host <'Server Name'> is not allowed to connect to this MySQL server Solution: This error message is displayed when you have not uninstalled the older version of vtiger CRM fully. Start vtiger CRM server from Start --> Program Files -->vtiger CRM ->Start vtiger CRM. the value for log4php. how to start vtiger CRM. . • If you are using bundled Apache and MySQL with vtiger CRM Start vtiger CRM server from Start Program Files vtiger CRM Start vtiger CRM. Follow the procedure given below to overcome this issue: 1.php 3. All other trademarks are the property of their respective owners. Program Files vtiger CRM Stop 2.properties file present under <vtiger CRM Home> directory.com. Stop vtiger CRM server from Start vtiger CRM. After completing the installation I am not sure. Troubleshooting Tips 1. Start the Command Prompt and enter the following command: :\mysql –u root –port 3. By default.20 - 10. • If are using the existing Apache and MySQL Start the Apache Web server manually from the <Apache Home>/bin directory then start Web browser and enter the following URL: http://<Host-name>/<vtiger Home>/index. After a few seconds. vtiger is a trademark of vtiger. A2 Please refer to: vtiger Knowledge Base for more troubleshooting tips. If your problem is not solved please feel free to post in vtiger Discussions. . All other trademarks are the property of their respective owners. Copyright 2003-2006 vtiger.com..21 Line: 10 log4php.com.rootLogger=debug. vtiger is a trademark of vtiger. All rights reserved. com. Note: vtiger CRM does not stop the Apache and MySQL as you may be using Apache and MySQL software for some other applications. To overcome this issue. If you create a new role with space in the name (for example. • • While uninstalling vtiger CRM.conf file. All rights reserved. . • • • • Copyright 2003-2006 vtiger. bundled PHP cannot be associated with the existing Apache.com. You cannot change the user’s role once specific role is assigned to the user.conf).. vtiger is a trademark of vtiger.22 - 11. stopping vtiger CRM using Start Program Files vtiger CRM Stop vtiger CRM will not work. First you have to start Apache manually then use Start Program Files vtiger CRM start vtiger CRM to start vtiger CRM. The user has to manually edit the httpd. All other trademarks are the property of their respective owners. then you will have issues allocating permissions. Known Issues • If you select Start Program Files vtiger CRM start vtiger CRM.conf then the httpd. You have to stop Apache and MySQL manually. you have to install another instance of Apache and associate the bundled PHP with this instance. Sales User). If the user-specific Apache is selected and PHP is already associated with the existing Apache (conf/httpd. if the entry "ScriptAlias /cgi-bin/ <cgi-bin directory path>” is not present in <Apache Home>/conf/httpd. You have to delete those files manually. some of the files are not deleted. If you select to use the existing Apache and (or) MySQL options during installation.conf file will not be updated to associate PHP with Apache. In case of user Apache. vtiger is a trademark of vtiger. All other trademarks are the property of their respective owners.com.. . vtiger Office Plug-in.23 - 12. and Thunderbird/Mozilla respectively. Copyright 2003-2006 vtiger. and vtiger Thunderbird/Mozilla Extension are browser-side software and work only with Microsoft Outlook.com. Microsoft Office. All rights reserved. Related Documents You can refer to the following documents to work with other vtiger CRM Add-ons: • • • • • • vtiger Outlook Plug-in User Manual vtiger Office Plug-in User Manual vtiger Thunderbird Extension User Manual vtiger Customer Portal User Manual vtiger Web Forms User Manual vtiger Firfox Toolbar User Manual Note: The vtiger Outlook Plug-in. Chennai – 600 042.24 - 13. vtiger is a trademark of vtiger.com. 40-41-42. Sivasundar Apartments.com.. Ltd. Velachery. and issues in vtiger CRM Discussions (http://www. . INDIA Phone No: +91-44-4202-1990 Toll Free (USA & Canada): +1-877-788-4437 Public Support: http://discussions. Shastri Street.com/discussions/) so that we can provide technical support for you. All other trademarks are the property of their respective owners. Contact Information: vtiger Systems India Pvt. Flat D-II. All rights reserved.com Copyright 2003-2006 vtiger.vtiger. Customer Support Please post your valuable comments.vtiger. feature requests.