Vtiger CRM 5.0.4 - Installation Manual for Linux
From vtiger.com
v5.0.4 Documents
- Release Notes
- Vtiger CRM 5.0.4 - Installation Manual for Windows
- vtiger CRM 5.0.4 - Installation Manual for Linux
- vtiger Outlook Plugin 5.0.4 - User Manual
- vtiger Office Plugin 5.0.4 - User Manual
- vtiger Thunderbird Extension 5.0.4 - User Manual
- vtiger Firefox Toolbar 5.0.4 - User Manual
- vtiger Customer Portal 5.0.4 - User Manual
- vtiger Web Forms 5.0.4 - User Manual
[edit] System Requirements
- Hardware: Hosted.
- Web Server: Apache 2.0.40 or above.
- Database: MySQL version 4.1.x through 5.1.x.
- PHP:PHP 5.0.x through 5.2.x.
- Web Browser: Firefox 1.5.x and above or Opera 7.21 and above.
- Operating System: RedHat Linux 7.2/8.0/9.0, SuSe 9.0, Debian 3.0/4.0, Mandrake 10.0, or Fedora Core 3/6.
[edit] Operating System (Linux) Dependency Packages
Disclaimer: This chapter is for informational purposes only and is provided "AS IS", without any express or implied warranties.
|
Red Hat |
Debian |
SuSe |
Mandrake |
Fedora |
Mac OS |
|
libpng |
Xlibs |
Bison-1.35.tar.gz |
libxfree86-dev |
libpng |
freetype2 |
|
libpng-devel |
xlibs-dev |
flex-2.5.4a.tar.gz |
libjpeg |
libpng-devel |
expat |
|
libjpeg |
libgd2 |
libpng-1.2.5.tar.gz |
freetype |
libjpeg |
jpegsrc |
|
libjpeg-devel |
libfreetype6 |
lib-1.2.1.tar.gz |
libfreetype |
libjpeg-devel |
libpng |
|
freetype |
libfreetype6-dev |
pm-3.4g.tar.gz |
libpng |
freetype |
zlib |
|
freetype-devel |
zlibc |
jpegsrc.v6b.tar.gz |
zlib |
freetype-devel |
imap-2004d |
|
zlib |
zlib-1.2.1 |
freetype2-devel-2.1.7-53.i586.rpm |
xfree86 |
zlib-devel |
|
|
Xfree86-dev |
libpng12-dev |
xFree86-devel-4.3.99.902-40.i586.rpm |
libxfree86 |
xorg-x11 |
|
|
openssl |
jpeg-6b |
openssl | openssl |
xorg-x11-dev |
|
| openssl-devel |
/usr/lib/libjpeg.so.62.0.0 or |
openssl-devel | openssl-devel | openssl-devel | |
| krb5-devel |
/usr/lib/libjpeg.so.62.0.0 or |
heimdal-devel | krb5-devel | krb5-devel | |
| imap-2004d |
/usr/local/lib/libpng12.so.0 or /usr/local/lib/libpng12.so |
Imap-2004d | imap-2004d | imap-2004d | |
|
/usr/local/lib/libpng12.so.0 |
|||||
| Unzip | |||||
| openssl | |||||
| libssl-dev | |||||
| libkrb5-dev | |||||
| imap-2004d | |||||
| build-essential | |||||
| libxml2 | |||||
| libxml2-dev | |||||
| m4 | |||||
| bison | |||||
| flex |
[edit] Mandriva 2007.1
- libjpeg
- freetype
- libfreetype6 (in repository)
- libpng3
- zlib1
- openssl
- libopenssl0.9.8-devel
- imap2006
- php packages
- php-adodb
- php-imap
[edit] Choose the Correct Linux Distribution
vTiger CRM software is available two formats:
- executable
- source
Type of Distribution |
Factors |
You* must have:
(From a search of issues in 5.0.4 this appears to be a deal breaker. If you can’t set max_execution_time = 600 then you probably will not be able to complete the building of all 317 tables. Your install will finish without apparent error but you will only have a fraction of the necessary tables.
References:
(not sure if this is manditory or not)
References:
(not sure if this is manditory or not)
allow_call_time_pass_reference= ? safe_mode = Off display_errors = On file_uploads = On register_globals = Off output_buffering= On error_reporting=E_WARNING& ~E_NOTICE log_errors = Off short_open_tag= On (not sure if this is manditory or not)
The more you know about:
…the better your day will go. |
|
This is a good choice if:
|
|
This is a good choice if:
|
|
[edit] Choose the Correct Linux Distribution--Keep this???
vTiger CRM software is available two formats:
- executable
- source
|
Type of User |
Type of Distribution |
|
Novice Users Those who:
|
|
|
Intermediate Users Those who:
|
|
|
Advanced PHP Users &
Developers Those who:
|
|
[edit] Binary Installation
[edit] Prerequisites
- Please ensure that you have administrator privileges on the system. If you are installing without administrator privilege, vtiger CRM software will not be installed properly.
- Before installing vtiger CRM 5.0.4 software, stop the Apache and MySQL services. If you are using a hosted facility, you should .............
- vtiger CRM 5.0.4 software is compatible with Apache 2.0.40 and above, MySQL 4.1.x through 5.1.x and PHP 5.0.x through 5.2.x. If these software are already installed in your system, you can use the same. Otherwise use the Apache and MySQL bundled with vtiger CRM software.
- Read/Write permissions for some of the vtiger CRM directories – Applicable to vtiger CRM Source Installation
- PHP settings (php.ini) configuration - Applicable to vtiger CRM Source Installation
[edit] Installing Code
To work with vtiger CRM, you must have Apache, MySQL, and PHP installed in you system. You can install vtiger CRM according to your software requirements:
Install vtiger CRM complete package – <a href="http://prdownloads.sourceforge.net/vtigercrm/vtigercrm-5.0.4.bin?download">vtigercrm-5.0.4.bin</a>.
|
Note: Use this package if you have not installed Apache, MySQL, and PHP packages in your system. |
Install vtiger CRM with bundled PHP – <a href="http://prdownloads.sourceforge.net/vtigercrm/vtigercrm-5.0.4.bin?download">vtigercrm-5.0.4.bin
</a>
|
Note: This package is same as above except that you may not install Apache and MySQL. Please note that PHP package will be installed even though it is available in your system. Use this package if you have already installed Apache and MySQL, packages in your system. |
Install only vtiger CRM source – <a href="http://prdownloads.sourceforge.net/vtigercrm/vtigercrm-5.0.4.tar.gz?download">vtigercrm-5-0-4.tar.gz</a>.
|
Note: Use this package if you have already installed Apache, MySQL, and PHP in your system. |
[edit] Complete Binary Package
For the convenience of first time users, vtiger CRM is bundled with compatible versions of Apache, MySQL, and PHP. Follow the procedure given below to install the complete package of vtiger CRM:
1.Download <a href="http://prdownloads.sourceforge.net/vtigercrm/vtigercrm-5.0.4.bin?download">vtigercrm-5.0.4.bin</a> from the Sourceforge.net.
2.Log in as a root user.
3.Grant execute permission to run the vtigercrm-5.0.4.bin file:
#chmod 777 vtigercrm-5.0.4.bin
4. Run the vtigercrm-5.0.4.bin file as given below:
#./vtigercrm-5.0.4.bin
Please read the license agreement and enter Y to start the installation process or N to abort the installation.
5.To install the Apache follow the procedure given below:
I. Press Y key to install the Apache when the following message is displayed:
Do you want to install Apache 2.0.50 that is bundled with vtiger CRM.
II. Specify the absolute path for installing the Apache when the following message is displayed:
Specify the absolute path for installing vtiger CRM (For example /home/vtiger) and then press ENTER
III. Press Y key to create a new directory if it does not exist, when the following message is displayed:
Please type yes (y) or no (n): /home/<vtiger CRM directory > directory does not exist. Create it now?
IV. Specify the Apache port number when the following message is displayed:
Specify the port where you wish to start Apache: Port Number
6.To install the MySQL follow the procedure given below:
I. Press Y key to install the MySQL when the following message is displayed:
Do you want to install MySQL 5.0.19 that is bundled with vtiger CRM?
II. Specify the MySQL port number, user name, and password. If the port you have specified is free, installation process will continue otherwise specify a different port.
7.Installation details, such as Apache, MySQL, PHP, and GD library are displayed. Press C to continue or Q to abort the installation. Installation process takes approximately 5 minutes.
8.Press Y to start vtiger CRM server immediately when the following message is displayed:
Do you want to start vtiger CRM server?
Otherwise, you can start the server by running the startvTiger.sh file present under the <vtiger CRM Home>/bin directory.
[edit] Without Apache and MySQL
If you have already installed Apache version 2.0.40 and MySQL 4.1.x and above in your system, follow the steps given below:
1.Download <a href="http://prdownloads.sourceforge.net/vtigercrm/vtigercrm-5.0.4.bin?download">vtigercrm-5.0.4.bin</a> from the Sourceforge.net.
2.Log in as a root user into the system.
3. Grant execute permission to run the vtigercrm-5.0.4.bin file:
#chmod 777 vtigercrm-5.0.4.bin
4.Run the vtigercrm-5.0.0.bin file as given below:
#./vtigercrm-5.0.4.bin
Please read the license agreement and enter Y to start the installation process or N to abort the installation.
5.Follow the steps given below to use the existing Apache:
i. Type “n” to use the existing Apache, when you get the following message:
Do you want to install Apache, 2.0.50 that is bundled with vtiger CRM ? Yes(y)/No(n):
ii. Type “y” to continue to use the existing Apache when you get the following message:
Do you want to continue Yes(Y)/No(N): <Enter y if you are sure>
iii. Enter the location of the Apache directory:
Specify the location of Apache in your system (For example /etc/httpd)
If you are not providing the correct path, following message is displayed:
Kindly provide the location for httpd file in your system (example: /usr/sbin):
|
Note: If the specified path or Apache version is not compatible, system prompts to install the bundled Apache. |
iv. Enter the port where you wish to start the Apache, when the following message is displayed:
Specify the port where you wish to start the Apache:
|
Note: If some other application is running in the specified port, you can chose a different port by typing N or close the application by typing C. |
6.Follow the steps given below to use the existing MySQL:
i. Type “n” to use the existing Apache, when you get the following message:
Do you want to install the MySQL 5_1_19 that is bundled with vtiger CRM? Yes(Y)/No(N):
ii. Enter the MySQL directory, when the following message is displayed:
Enter the absolute path of MySQL installed in your system:
iii. Enter the MySQL connection parameters, such as Port number, User name, Password, and MySQL socket file location. If you enter wrong details, following message is displayed:
Either some other application is running on the port specified or there might be some errors in the connection parameters. Kindly start the specified mysql server and press C to continue with installation, press Y to re-enter the connection parameters, N to install the bundled MySQL or Q to quit: y
Kindly re-enter the mysql connection parameters
7.If you have provided correct details in Step 1 through 6, all your input details are displayed. Read the details and type C to continue or Q to abort the installation.
8.Installation process takes approximately 5 minutes. Please ignore the messages displayed in console during installation.
9.Once installation is successfully completed, the following message is displayed:
************************ INFO ****************************
Product Successfully installed
Kindly use the link http://<hostname>/vtiger/install.php through your browser to start using the product
**********************************************************
Copy the URL displayed in the console to the Web browser and configure vtiger CRM server.
10. Start your existing Apache and complete vtiger CRM configuration.
  If you are already using WAMP environment for other PHP based applications, you can very well use the same setup for vTiger CRM installation, provided your setup meets the vTiger CRM requirements.
|
IMPORTANT NOTE vtiger CRM Source installation is only for the Advanced Users, Developers, and hosted environments. Beginners and Intermediate Users of PHP based applications are strongly recommended to use the vTiger optimized LAMP setup (vtigercrm-5.0.4.bin)if the situation warrants. If you are using PHP- based application first time, please consider skipping this section and follow the steps in <a href="#_5.1_Installing_Complete">5.1 Installing Complete Package</a> |
|
How to get LAMP? LAMP stands for Linux, Apache, MySQL, and PHP. You can download the optimized Apache, MySQL, and PHP package from various sources. The most popular sites that provide LAMP package are <a href="http://www.bitrock.com/download_lamp_download.html">BitRock</a> and <a href="http://www.apachefriends.org/lampp-en.html">LAMPP</a>. There are many other Websites offers LAMP distributions freely. Before using your own LAMP setup, please ensure that Apache, MySQL, and PHP versions meet the vtiger CRM requirements. Apache – 2.0.40 and above
|
[edit] Source Installation
[edit] Prerequisites
- vtiger CRM 5 software is compatible with Apache 2.0.40 and above, MySQL 4.1.x through 5.1.x and PHP 5.0.x through 5.2.x. If these software are already installed in your system, you can use the same. Otherwise use the Apache and MySQL bundled with vtiger CRM software.
- Read/Write permissions for some of the vtiger CRM directories – Applicable to vtiger CRM Source Installation
- PHP settings (php.ini) configuration - Applicable to vtiger CRM Source Installation
[edit] Prerequisites - PHP
- Verify:
|
PHP Configuration Check List |
|
2. Your php.ini must configured with the following parameters:
|
[edit] Install Source
- Download http://prdownloads.sourceforge.net/vtigercrm/vtigercrm-5.0.4.tar.gz from the Sourceforge.net.
- Extract the vtigercrm-5.0.4.tar.gz file into the Apache root directory. Alternately you may extract it in a subdirectory.
- Start a Web Browser and follow the procedure given in the Configuring vtiger CRM Server chapter for completing vTiger CRM installation.
- Follow the Wizard: (ref)
- Post install
[edit] Post Install Checklist
|
Post-installation Check List |
|
1. You must have READ/WRITE permissions on the following vtiger CRM folders and Files within those folders:
|
|
In Linux shell use the following command: #Never chmod 777 for security reasons, at the parent directory of vtiger, chown apache:root directoryname -R (This will change the owner of all sub folders and directories to apache and root. All directories and files should have the correct access, If not use chmod to set the access, more information can be found with "man chmod" for access permissions
|
[edit] Starting & Stopping vtiger CRM
To start vtiger CRM server, run the following command from the <vtiger Home>/bin directory:
#sh startvtiger.sh
To stop vtiger CRM server, run the following command from the <vtiger Home>/bin directory:
#sh stopvtiger.sh
|
Note: The start and stop scripts are not bundled with vtigercrm-5.0.0-source.tar.gz. Hence you have to start MySQL and Apache in your LAMP environment manually and then configure vtiger CRM server. |
[edit] Configuring vTiger CRM Server
After installing vTiger CRM, you must configure it further with database, Website, currency, and administration access details. You may elect to have the database tables and demo data populated during configuration, which will take about 5 minutes time.
To configure vtiger CRM server
1. Start Web browser and enter http://<host-name>/vtigerCRM/index.php in location bar.
2. In the Registration page, complete the product registration (optional). Click the Start button.
3. In the System Check page, PHP, MySQL database, files/directories that have read/write permissions, and GD graphics library version status are displayed. If the all the parameters are OK, click the Next button.
|
Note: Please ensure that all the directories have the read/write permission; otherwise, you cannot work with features that require file upload and download. |
4. In the System Configuration page, enter the appropriate values for Database, Site Configuration, and Administration sections. Afterwards click the Next button.
Database Configuration
- Host Name (mandatory) – By default, Host Name is set as <System Name>: <Port No>. Please do not change the port number as it is added during installation.
- User Name (mandatory)– Specify username for accessing the database.
- Password– Specify password for the username.
- Database Name (mandatory)– By default database name is vtigercrm5. You can also create a database as per your requirements.
- Root User Name (mandatory)– If you have selected the create data option in Database Name field, specify root user name for creating database.
- Root Password– Specify password for the root username.
Site Configuration
- URL (mandatory) – Enter the host name. By default, it is http://<system name>.
- Path (mandatory) – By default, this is the path where vtiger CRM is installed.
- Path to Cache Directory (must have write permission) - By default, this is cache/. This folder is used to store the files, such as attachments, and import/export- related files temporarily.
Admin Configuration
- User name – By default, the user name is set as “admin”.
- Admin password (mandatory) – By default, the password is set as “admin”. You can change password after logging in to vtiger CRM.
- Email ID – By default email ID is admin@your-domain.com. You can also change the administrator’s e-mail ID.
Currency Configuration
- Name (mandatory) – Specify your fiscal currency name (For example, Dollar).
- Symbol (mandatory) – Specify your currency symbol (For example, $).
- Code (mandatory) – Specify international code of your currency (For example, USD).
5. In the Confirm Settings page, review the configuration information. If you want to change some of the details, click the Change button and go to previous step. If you want to populate some data, select the Also populate demo data? check box. Once you are ready click the Next button.
6. In the Config File Creation page, click the Next button. It will take approximately 4 minutes to complete the configuration.
7. In the Create Database Tables page, click the Finish button to complete the vtiger CRM configuration.
Once installation is completed successfully, installation directory will be locked to secure your installation against unauthorized access.
In the Login page, by default the User Name field is set as “admin”. In Password field, enter the admin password you have set during installation process. Once you have logged in successfully, you can view the vtiger CRM Home page as shown below: <img width="575" height="412" border="0" alt="" src="./vtigerCRM-Installation-Manual-Linux_files/image005.jpg" />
[edit] Configuring Notification Scheduler
You can schedule the notifications, such Big deals, pending tasks, event reminder, support start and end dates, and others by changing your Apache Web server port in sendreminder.sh file present under <vtiger CRM Home>cron/ directory as given below:
wget http://localhost:APACHEPORT/SendReminder.php -O intimatelog.tx
Some extra hints for getting this running :
In SendReminder.php : Change line 94 to a recognised local address
To check events every minute, add the following to crontab :
*/1 * * * * root /path_to/sendreminder.sh >/dev/null 2>&1
If you use this method you will need to make sendreminder.sh executable
Or alternatively
*/1 * * * * root wget http://localhost/crm/Sendreminder.php -O intimatelog.txt >/dev/null 2>&1
The line that calculates when to send the reminder is line 76 in SendReminder.php :
if (($activity_time - $curr_time) > 0 && ($activity_time - $curr_time) == $reminder_time)
If you only wanted to check say every 5 minutes then you can readjust the formula accordingly
Refs :
http://forums.vtiger.com/viewtopic.php?t=19536
http://forums.vtiger.com/viewtopic.php?p=65363
http://www.adminschoice.com/docs/crontab.htm
[edit] Troubleshooting Tips
1. The “Forbidden” message is displayed in Web browser while starting vtiger CRM through Web browser:
Edit the httpd.conf file present in the <vtiger_CRM _home>/installs/apache/conf directory and make the following changes:
old <Directory /> new <Directory /home/<user>
Grant permission to execute the httpd.conf file:#chmod -R 777 /home/<user>
Restart the Apache server from the Apache installation directory:
#./bin/httpd -d . -f ./conf/httpd.conf -k stop
#./bin/httpd -d . -f ./conf/httpd.conf -k start
2. By default, the value for log4php.rootLogger is set as “debug” in log4php.properties file present under <vtiger CRM Home> directory. If you experience any problems, change the logging level to “fatal” or “warning”
Line: 10
log4php.rootLogger=debug, A2
[edit] Known Issues
During vtiger CRM installation if you aborted the installation process, a temporary directory called vtigerCRM_linux is created under installation directory. This directory is not deleted automatically and you have to delete it manually.
[edit] Installing vtiger on PHP 5.2.x
See <a href="http://wiki.vtiger.com/index.php/Vtiger_CRM_on_PHP_5.2.x ">vtiger CRM on PHP 5.2.x</a>
[edit] Related Documents
You can refer to the following documents to work with other vtiger CRM Add-ons:
- <a href="../../index.php/Vtiger_Outlook_Plugin_5.0.4_-_User_Manual" title="Vtiger Outlook Plugin 5.0.3 - User Manual">vtiger Outlook Plugin 5.0.4 - User Manual</a>
- <a href="../../index.php/Vtiger_Office_Plugin_5.0.4_-_User_Manual" title="Vtiger Office Plugin 5.0.3 - User Manual">vtiger Office Plugin 5.0.4 - User Manual</a>
- <a href="../../index.php/Vtiger_Thunderbird_Extension_5.0.4_-_User_Manual" title="Vtiger Thunderbird Extension 5.0.3 - User Manual">vtiger Thunderbird Extension 5.0.4 - User Manual</a>
- <a href="../../index.php/Vtiger_Firefox_Toolbar_5.0.4_-_User_Manual" title="Vtiger Firefox Toolbar 5.0.3 - User Manual">vtiger Firefox Toolbar 5.0.4 - User Manual</a>
- <a href="../../index.php/Vtiger_Customer_Portal_5.0.4_-_User_Manual" title="Vtiger Customer Portal 5.0.3 - User Manual">vtiger Customer Portal 5.0.4 - User Manual</a>
- <a href="../../index.php/Vtiger_Web_Forms_5.0.4_-_User_Manual" title="Vtiger Web Forms 5.0.3 - User Manual">vtiger Web Forms 5.0.4 - User Manual</a>
|
Note: The vtiger Outlook Plug-in, vtiger Office Plug-in, and vtiger Thunderbird Extension are browser-side software works only with Microsoft Outlook, Microsoft Office, and Thunderbird/Mozilla E-mail clients respectively. |
[edit] Upgrading vtiger CRM
This section is only for the existing vtiger CRM users (v4.2.3 / v5.0.0 / v5.0.1 / v5.0.2 / v5.0.3). If you are planning to use vtiger CRM first time, please skip this section.
Important Note: We recommend users to take a backup of the existing database and source code before migrating to vtiger CRM 5.0.4.
Warning: Please don't forget to take the source code backup before extracting the Patch, otherwise all your custom code will be overwritten by the new code.
Step 1: Download <a href="http://prdownloads.sourceforge.net/vtigercrm/vtigercrm-5.0.0-patch4.zip">vtiger CRM 5.0.0 – Patch 4</a> file.
Step 2: Extract vtigercrm-5.0.0-patch4.zip file in to your vtiger CRM root directory.
Step 3: Migrate your database from earlier version to the latest version.
To upgrade from v4.2.3, 5.0.0, 5.0.1, 5.0.2, 5.0.3, 5.0.4rc to the v5.0.4.
- Select Settings --> Other Settings --> Migration Wizard
- In the Migration Wizard, select the options according to your requirements.
It will take few minutes to migrate your database. Kindly do not kill the browser while migration process in in progress.
For detailed procedure, refer to the <a href="http://wiki.vtiger.com/index.php/Vtiger_CRM_5.0.4_-_Release_Notes#Migration_Steps">Migration Steps</a> in release notes.
Step 4: Remove unwanted files and directories.
For a better security of the vtiger CRM - Source files, we have reorganized the files location. Hence it is better to remove the files listed below permanently. Please take necessary precautions, while removing files.
Files to be removed from <vtiger CRM Home>/modules/Users directory
|
Announcement.php |
listgroups.php |
[edit] Customer Support
Please post your valuable comments, feature requests, and issues in vtiger Discussions (<a href="http://forums.vtiger.com">http://forums.vtiger.com</a>) so that we can provide technical support for you.
Contact Information:
vtiger Systems India Pvt. Ltd.
Sree Narayana Complex,
11 Sarathy Nagar,
Vijayanagar, Velachery,
Chennai 600 042,
INDIA
India Phone No: +91-80-23146984
USA & Canada: +1-408-716-8592
Public Support: <a href="http://forums.vtiger.com">http://forums.vtiger.com</a>
