© 2015 X2Engine Inc.

Difference between revisions of "Installation"

From X2Engine
Jump to: navigation, search
(Prerequisites)
Line 1: Line 1:
 
 
== Prerequisites ==
 
== Prerequisites ==
  
Line 5: Line 4:
  
 
* '''PHP version 5.3 or later'''
 
* '''PHP version 5.3 or later'''
* [//http://php.net/manual/en/book.curl.php:PHP's cURL library]
+
* [http://php.net/manual/en/book.curl.php PHP's cURL library]
 
* A password-protected '''MySQL''' database server connection, and a database on which the user of the connection has all rights (i.e. select, drop, create and update).
 
* A password-protected '''MySQL''' database server connection, and a database on which the user of the connection has all rights (i.e. select, drop, create and update).
* The [//http://httpd.apache.org/:Apache 2] web server, with [//http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html:mod_rewrite] enabled.
+
* The [http://httpd.apache.org/ Apache 2] web server, with [http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html mod_rewrite] enabled.
  
Next, ensure that the requirements of [//http://www.yiiframework.com"Yii Framework"], the application building framework on which X2Engine is designed, are met. To do this:[list=1]
+
Next, ensure that the requirements of [http://www.yiiframework.com Yii Framework], the application building framework on which X2Engine is designed, are met. To do this:
 
* Download the "yii-requirements" file attached to this post, and upload/unpack it into your web server.
 
* Download the "yii-requirements" file attached to this post, and upload/unpack it into your web server.
 
* Navigate to the yii-requirements folder on your web server. You should see a page that looks similar to this:
 
* Navigate to the yii-requirements folder on your web server. You should see a page that looks similar to this:
  
 
[sharedmedia=core:attachments:13]
 
[sharedmedia=core:attachments:13]
* Note that the following requirements are not necessary:
+
'''Note that the following requirements are not necessary:'''
 +
 
 
- The SQLite and PostgreSQL extensions; X2Engine depends on MySQL, so these other extensions will not be used.
 
- The SQLite and PostgreSQL extensions; X2Engine depends on MySQL, so these other extensions will not be used.
 
- The DOM extension; it is not required.
 
- The DOM extension; it is not required.
Line 20: Line 20:
 
- The SOAP extension; the classes that depend on it are not used
 
- The SOAP extension; the classes that depend on it are not used
  
Note to users of CentOS Linux, esp. release version 6:[/b] two additional PHP packages that are non-default (but very common, and almost ubiquitous) and not installed by default with the CentOS's base php package are [i]php-mbstring[/i] and the [i]mcrypt[/i] module[i]. [/i]In a shared hosting environment, these will most likely be installed already. However, if you plan on setting up your own server and using CentOS, you must install mbstring package by running [b][color=#006400]yum install php-mbstring[/color][/b] as root and restarting Apache (i.e. [b][color=#006400]sudo service httpd restart[/color][/b]). To install mcrypt, the recommended method is to first [//http://linuxmoz.com/centos-epel-repo-install-tutorial/:add the EPEL repository] (php's mcrypt is unavailable in the default repositories). Then, it can be installed via running [b][color=#006400]yum install php-mcrypt[/color][/b] as root.
+
Note to users of CentOS Linux, esp. release version 6:[/b] two additional PHP packages that are non-default (but very common, and almost ubiquitous) and not installed by default with the CentOS's base php package are [i]php-mbstring[/i] and the [i]mcrypt[/i] module[i]. [/i]In a shared hosting environment, these will most likely be installed already. However, if you plan on setting up your own server and using CentOS, you must install mbstring package by running [b][color=#006400]yum install php-mbstring[/color][/b] as root and restarting Apache (i.e. [b][color=#006400]sudo service httpd restart[/color][/b]). To install mcrypt, the recommended method is to first [//http://linuxmoz.com/centos-epel-repo-install-tutorial/ add the EPEL repository] (php's mcrypt is unavailable in the default repositories). Then, it can be installed via running [b][color=#006400]yum install php-mcrypt[/color][/b] as root.

Revision as of 21:49, 12 September 2012

Prerequisites

Before installing X2EngineCRM, you should first ascertain whether your hosting environment is properly configured. The following features are *required* for X2EngineCRM to function properly:

  • PHP version 5.3 or later
  • PHP's cURL library
  • A password-protected MySQL database server connection, and a database on which the user of the connection has all rights (i.e. select, drop, create and update).
  • The Apache 2 web server, with mod_rewrite enabled.

Next, ensure that the requirements of Yii Framework, the application building framework on which X2Engine is designed, are met. To do this:

  • Download the "yii-requirements" file attached to this post, and upload/unpack it into your web server.
  • Navigate to the yii-requirements folder on your web server. You should see a page that looks similar to this:

[sharedmedia=core:attachments:13] Note that the following requirements are not necessary:

- The SQLite and PostgreSQL extensions; X2Engine depends on MySQL, so these other extensions will not be used. - The DOM extension; it is not required. - The caching extensions (Memcache, APC cache); caching is not currently required, although APC can increase performance - The SOAP extension; the classes that depend on it are not used

Note to users of CentOS Linux, esp. release version 6:[/b] two additional PHP packages that are non-default (but very common, and almost ubiquitous) and not installed by default with the CentOS's base php package are [i]php-mbstring[/i] and the [i]mcrypt[/i] module[i]. [/i]In a shared hosting environment, these will most likely be installed already. However, if you plan on setting up your own server and using CentOS, you must install mbstring package by running [b][color=#006400]yum install php-mbstring[/color][/b] as root and restarting Apache (i.e. [b][color=#006400]sudo service httpd restart[/color][/b]). To install mcrypt, the recommended method is to first add the EPEL repository (php's mcrypt is unavailable in the default repositories). Then, it can be installed via running [b][color=#006400]yum install php-mcrypt[/color][/b] as root.