Installation - Revision history

Derek Mueller: /* System Requirements */

2016-02-04T20:40:26Z

‎System Requirements

Raymond Colebaugh: /* Installing Without All Requirements: What Won't Work */

2014-12-05T19:02:47Z

‎Installing Without All Requirements: What Won't Work

Tony Zavala at 16:48, 28 May 2014

2014-05-28T16:48:37Z

Demitri: /* Using The Command Line Installer */

2014-03-13T00:26:42Z

‎Using The Command Line Installer

Demitri: /* Using The Silent Installer */

2014-03-13T00:25:16Z

‎Using The Silent Installer

Demitri at 23:47, 6 February 2014

2014-02-06T23:47:05Z

Demitri: /* Installing Without All Requirements: What Won't Work */

2013-12-10T21:51:36Z

‎Installing Without All Requirements: What Won't Work

Demitri: /* Directory Ownership */

2013-12-10T19:15:32Z

‎Directory Ownership

Demitri: /* Required Knowledge */

2013-12-10T19:15:10Z

‎Required Knowledge

Demitri: /* Directory Ownership */

2013-12-10T18:54:45Z

‎Directory Ownership

@@ Line 21: / Line 21: @@
 * A web server that can execute PHP.
 * 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).
-* '''PHP version 5.3 or later'''
+* '''PHP version 5.3-5.6 (PHP 7 support will be introduced in X2CRM 5.4.4)'''
 * PHP must be run as the same system user that owns the directory where X2Engine will be installed.

@@ Line 64: / Line 64: @@
 ! scope="col" | Severity
 ! scope="col" | Problems/Notes
 |-
 ! scope="row" | Zip extension missing

@@ Line 1: / Line 1: @@
 [[Category:Support]]
-This article covers manual installation of X2Engine on a webserver. If this is your first time working with a web server, it is recommended that you first try installing via an automatic full-stack installer that will set up a self-contained web server environment for you. See [http://bitnami.org/stack/X2Engine Bitnami's X2Engine stack installers] for download links.
+This article covers manual installation of X2Engine on a webserver. If this is your first time working with a web server, it is recommended that you first try installing via an automatic full-stack installer that will set up a self-contained web server environment for you. See [http://bitnami.org/stack/X2CRM Bitnami's X2Engine stack installers] for download links.
 = Before Installation =

@@ Line 150: / Line 150: @@
 == Using The Command Line Installer ==
 It is possible to install X2Engine from the command line via SSH or otherwise. This is performed as follows:
-# There is a script in the root of the web application named <tt>installConfig.php</tt>. Fill it with the same information that would be submitted by the installation page form. If you are installing X2Engine Professional Edition, fill the variable <tt>$unique_id</tt> with your product key.
+# There is a script in the root of the web application named <tt>installConfig.php</tt>. Fill it with the same information that would be submitted by the installation page form. If you are installing a commercial edition of X2Engine, fill the variable <tt>$unique_id</tt> with your product key.
 # Change directory into the root folder of the web application.
 # Run: <pre>php initialize.php silent</pre>
@@ Line 182: / Line 182: @@
 : The base URL of the web application.
 ;unique_id
-: The product key, if installing Professional Edition. In Open Source Edition, it can simply be left "none". If it is "none" in either Open Source or Professional Edition, the user will need to enable software updates separately by going to "Updater Settings" in the administrative index, in the "System Settings" section.
+: The product key, if installing a commercial edition. In Open Source Edition, it can simply be left "none". If it is "none" in Open Source Edition, the user will need to enable software updates separately by going to "Updater Settings" in the administrative index, in the "System Settings" section.
 ;visibleModules
 : Initial module visibility setting; a comma-delineated list of modules to be displayed in the menu at the top of the CRM.

@@ Line 148: / Line 148: @@
 #* You can first test the database connection without losing the installation form by using the "Test Connection" button. Doing this before clicking the install button is highly recommended.
-== Using The Silent Installer ==
+== Using The Command Line Installer ==
 It is possible to install X2Engine from the command line via SSH or otherwise. This is performed as follows:
 # There is a script in the root of the web application named <tt>installConfig.php</tt>. Fill it with the same information that would be submitted by the installation page form. If you are installing X2Engine Professional Edition, fill the variable <tt>$unique_id</tt> with your product key.

@@ Line 1: / Line 1: @@
 [[Category:Support]]
-This article covers manual installation of X2CRM on a webserver. If this is your first time working with a web server, it is recommended that you first try installing via an automatic full-stack installer that will set up a self-contained web server environment for you. See [http://bitnami.org/stack/x2crm Bitnami's X2CRM stack installers] for download links.
+This article covers manual installation of X2Engine on a webserver. If this is your first time working with a web server, it is recommended that you first try installing via an automatic full-stack installer that will set up a self-contained web server environment for you. See [http://bitnami.org/stack/X2Engine Bitnami's X2Engine stack installers] for download links.
 = Before Installation =
-Before installing X2CRM, you should first ensure that
+Before installing X2Engine, you should first ensure that
 * You have a web server
 * You understand the basics of installing a PHP web application
@@ Line 9: / Line 9: @@
 == Required Knowledge ==
-Installing X2CRM requires you are able to perform the following taks (and have basic knowledge of how to perform them):
+Installing X2Engine requires you are able to perform the following taks (and have basic knowledge of how to perform them):
 # Upload files to a web server via a hosting file manager, FTP/SFTP, or otherwise
 # Creating a MySQL database and a database user, if they aren't available already
@@ Line 17: / Line 17: @@
 == System Requirements ==
-You can quickly determine if your web server can run X2CRM by downloading the requirements checking script (link: [[requirements:|requirements.php]]), uploading it to your web server, and opening it in a web browser. When finished using the script, delete it; it displays detailed information about the server's PHP configuration. Displaying it publicly for indefinite time can pose a security risk; it could be useful to attackers. In general, the following are the absolute minimum requirements for installation:
+You can quickly determine if your web server can run X2Engine by downloading the requirements checking script (link: [[requirements:|requirements.php]]), uploading it to your web server, and opening it in a web browser. When finished using the script, delete it; it displays detailed information about the server's PHP configuration. Displaying it publicly for indefinite time can pose a security risk; it could be useful to attackers. In general, the following are the absolute minimum requirements for installation:
 * A web server that can execute PHP.
 * 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).
 * '''PHP version 5.3 or later'''
-* PHP must be run as the same system user that owns the directory where X2CRM will be installed.
+* PHP must be run as the same system user that owns the directory where X2Engine will be installed.
 == If Requirements Are Not Met ==
@@ Line 32: / Line 32: @@
 You should also use a method of uploading files to the server that results in them having the same ownership as the "domain owner" (this terminology is used by most shared hosting providers). FTP services have been known to fail in this regard, whereas web-based file managers available in hosting control panels are often much more consistent. Uploading files with proper ownership will completely circumvent file permission and ownership issues.
-In any case, refer to your hosting provider's documentation. If the option to change the PHP execution mode does not appear to be available, contact the system administrator or customer service department of the hosting provider. If they don't give you a satisfactory answer, consider switching to a better web host. <ref>In a discussion on our forums, [http://x2community.com/topic/703-hosting-that-works/ "Hosting that works"], some users propose or advocate web hosts that they have had experiences with. A general consensus on GoDaddy (and our own professional opinion, based on repeated bad experiences) is that it is a very poor choice for hosting X2CRM.</ref>
+In any case, refer to your hosting provider's documentation. If the option to change the PHP execution mode does not appear to be available, contact the system administrator or customer service department of the hosting provider. If they don't give you a satisfactory answer, consider switching to a better web host. <ref>In a discussion on our forums, [http://x2community.com/topic/703-hosting-that-works/ "Hosting that works"], some users propose or advocate web hosts that they have had experiences with. A general consensus on GoDaddy (and our own professional opinion, based on repeated bad experiences) is that it is a very poor choice for hosting X2Engine.</ref>
 === PHP Version ===
@@ Line 38: / Line 38: @@
 * [http://www.velvetblues.com/web-development-blog/activate-php-5-3-hostgator-godaddy/ Velvet Blues: How to Activate PHP 5.3 on HostGator and GoDaddy]
 * [http://kb.siteground.com/article/How_to_have_different_Php__MySQL_versions.html SiteGround knowledge base: How to switch to a different PHP version]
-By adding the appropriate directives to the <tt>.htaccess</tt> file in the web root of X2CRM (NOT replacing the file, but changing it), the PHP version can ideally be set. You can test whether this method succeeds by re-visiting the requirements checker script and verifying that the PHP version in use is 5.3 or later.
+By adding the appropriate directives to the <tt>.htaccess</tt> file in the web root of X2Engine (NOT replacing the file, but changing it), the PHP version can ideally be set. You can test whether this method succeeds by re-visiting the requirements checker script and verifying that the PHP version in use is 5.3 or later.
 In other cases, it may be possible to enable later versions of PHP via the web hosting control interface (i.e. CPanel or Webmin). Otherwise, the only option will be to contact the hosting provider and request that version 5.3 be made available.
@@ Line 130: / Line 130: @@
 == Recommended System ==
-The following attributes of the hosting environment are by no means required. However, they are the same as the primary servers on which X2CRM is most commonly developed and tested, and thus would be the most likely to never cause problems:
+The following attributes of the hosting environment are by no means required. However, they are the same as the primary servers on which X2Engine is most commonly developed and tested, and thus would be the most likely to never cause problems:
 * PHP 5.3.10 and later
 * MySQL 5.5
@@ Line 149: / Line 149: @@
 == Using The Silent Installer ==
-It is possible to install X2CRM from the command line via SSH or otherwise. This is performed as follows:
+It is possible to install X2Engine from the command line via SSH or otherwise. This is performed as follows:
-# There is a script in the root of the web application named <tt>installConfig.php</tt>. Fill it with the same information that would be submitted by the installation page form. If you are installing X2CRM Professional Edition, fill the variable <tt>$unique_id</tt> with your product key.
+# There is a script in the root of the web application named <tt>installConfig.php</tt>. Fill it with the same information that would be submitted by the installation page form. If you are installing X2Engine Professional Edition, fill the variable <tt>$unique_id</tt> with your product key.
 # Change directory into the root folder of the web application.
 # Run: <pre>php initialize.php silent</pre>

@@ Line 55: / Line 55: @@
 == Installing Without All Requirements: What Won't Work ==
-'''This section is obsolete as of 3/26/2013.''' The severity of each missing requirement, in addition to explanation of what functionality will be unavailable/broken for each missing requirement, has been written directly into the requirements check script and should be displayed there. Thus, it is no longer necessary to list them here, although they still here for archival/demonstrative purposes.
+'''This section is obsolete as of 3/26/2013.''' The severity of each missing requirement, in addition to explanation of what functionality will be unavailable/broken for each missing requirement, has been written directly into the requirements check script and should be displayed there. Thus, it is no longer necessary to list them here, although the list as it was last maintained is left here for archival/demonstrative purposes.
 If your server environment does not meet the minimum system requirements, and it is not possible to add PHP extensions, you can still install X2Engine, though it is '''not''' recommended. Note the following issues that can occur:

@@ Line 30: / Line 30: @@
 This is a hosting environment misconfiguration wherein files uploaded to the server are owned by a different system user than the user as whom PHP executes. It is an ease-of-use issue that many shared hosting providers still haven't gotten right. It can in most cases be resolved by changing the PHP gateway interface, i.e. from SuPHP to FCGI, using your hosting control panel ('''To correct this issue in CPanel''': see [http://docs.cpanel.net/twiki/bin/vief/EasyApache3/ApachePHPRequestHandling Apache PHP Request Handling]).
-You should also use a method of uploading files to the server that results in them having the same ownership as the "domain owner" (this terminology is used by most shared hosting providers). FTP services have been known to fail in this regard, whereas web-based file managers available in hosting control panels are much more consistent. Uploading files with proper ownership will completely circumvent file permission and ownership issues.
+You should also use a method of uploading files to the server that results in them having the same ownership as the "domain owner" (this terminology is used by most shared hosting providers). FTP services have been known to fail in this regard, whereas web-based file managers available in hosting control panels are often much more consistent. Uploading files with proper ownership will completely circumvent file permission and ownership issues.
 In any case, refer to your hosting provider's documentation. If the option to change the PHP execution mode does not appear to be available, contact the system administrator or customer service department of the hosting provider. If they don't give you a satisfactory answer, consider switching to a better web host. <ref>In a discussion on our forums, [http://x2community.com/topic/703-hosting-that-works/ "Hosting that works"], some users propose or advocate web hosts that they have had experiences with. A general consensus on GoDaddy (and our own professional opinion, based on repeated bad experiences) is that it is a very poor choice for hosting X2CRM.</ref>