Revision as of 00:25, 13 March 2014

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 Bitnami's X2Engine stack installers for download links.

Before Installation

Before installing X2Engine, you should first ensure that

• You have a web server
• You understand the basics of installing a PHP web application
• Your hosting environment is properly configured and meets all the minimum requirements

Required Knowledge

Installing X2Engine requires you are able to perform the following taks (and have basic knowledge of how to perform them):

1. Upload files to a web server via a hosting file manager, FTP/SFTP, or otherwise
2. Creating a MySQL database and a database user, if they aren't available already
3. Using a web browser, and knowing what URL to use to access a location on the server

If you are unsure of how to perform any of these, please ask for assistance on The X2Engine Forums.

System Requirements

You can quickly determine if your web server can run X2Engine by downloading the requirements checking script (link: 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 X2Engine will be installed.

If Requirements Are Not Met

Directory Ownership

If you are running a dedicated web server and/or have administrative access, please refer to Preparing a Webserver.

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 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 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. ^[1]

PHP Version

In some cases, it may be possible to enable PHP 5.3+ using an Apache override; see

• Velvet Blues: How to Activate PHP 5.3 on HostGator and GoDaddy
• SiteGround knowledge base: How to switch to a different PHP version

By adding the appropriate directives to the .htaccess 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.

PHP Extensions

If your server does not meet the minimum system requirements for running X2Engine, and you are a system administrator of your server, you will be able to install the necessary modules. Note, however, that as of the most recent version, the MySQL PDO extension is the only extension used by X2Engine that isn't included by default and always enabled in PHP 5.3; the reflection class and extensions SPL, PCRE and Ctype should all be available if PHP is at version 5.3 or later.

In most distributions of Linux, PHP extensions can be easily installed by the distribution's default Package management system. That is the recommended method of installing them; in most cases, the package manager will automatically configure and reload the HTTP server to enable them.

On Ubuntu & Debian: the extension mbstring will typically be included in the Apache module package.

sudo apt-get install php5-mysql php5-curl

On CentOS (6+), the mbstring extension must be installed separately with other missing modules:

sudo yum install php-pdo php-mbstring php-common curl

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 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:

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 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
• Apache 2.2 with mod_rewrite enabled.
• Ubuntu 12.04 LTS, CentOS 6.3, or Amazon Linux

If only Windows is available, the environment provided by WampServer is recommended, especially for development.

Installing

Using The Installation Page

Browser-based installation generally proceeds as follows:

1. Make sure a MySQL database and a database user with full permissions to that database are available from the web server.
2. Upload the contents of the x2engine folder to the document root of the web server, or a subdirectory if desired.
3. Navigate to the webroot (or subdirectory) where the contents of the folder were uploaded.
4. Fill out the installation form. Note the following:
   • If you leave "Create Sample Data" checked, the installer will insert fictitious contact, user, account and action records into the initial installation for testing purposes. Uncheck the box if this is not desired.
   • 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 Command Line Installer

It is possible to install X2Engine from the command line via SSH or otherwise. This is performed as follows:

1. There is a script in the root of the web application named installConfig.php. 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 $unique_id with your product key.
2. Change directory into the root folder of the web application.
3. Run:

   php initialize.php silent

The configuration variables in installConfig.php are as follows:

host

The (MySQL) database hostname

db

The database name

user

The database username

pass

The database password

app

The application name (i.e. "Company X CRM") that shows up in various places throughout the app.

currency

The 3-letter code for the currency to be used in quotes and opportunities. Currently supported currencies include: USD,EUR,GBP,CAD,JPY,CNY,CHF,INR, and BRL.

lang

The application's language.

timezone

The time zone. It must be a valid timezone alias; see List of supported time zones for more info.

adminEmail

The email address of the application's owner

adminPassword

The administrator's application password

adminUsername

The username of the administrator

dummyData

Whether to include sample data in the installation, for evaluative purposes

webLeadUrl

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.

visibleModules

Initial module visibility setting; a comma-delineated list of modules to be displayed in the menu at the top of the CRM.

test_db

Set this to 1 if constructing a unit/functional testing environment (see Test-driven Development: preparing a testing database)

test_url

If installing a testing environment, the URL to the "index-test.php" entry script that web tests will use.

installType

Installation type to report to the updates server. This is a setting that is used for internal reporting/statistical purposes and should be left as-is.

Miscellaneous Post-Installation Tasks

Configuring the "Email Dropbox"

This section has been moved to the article: "E-Mail Configuration"

References

1. ↑ In a discussion on our forums, "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.
2. ↑ X2Community Forums: "Can't open contact View"
3. ↑ PCRE Changelog