Vous êtes sur la page 1sur 9

Installation - X2Engine http://wiki.x2crm.com/index.php?title=Installa...

Installation
From X2Engine

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 (http://bitnami.org/stack/X2CRM) for download links.

Contents
1 Before Installation
1.1 Required Knowledge
1.2 System Requirements
1.3 If Requirements Are Not Met
1.3.1 Directory Ownership
1.3.2 PHP Version
1.3.3 PHP Extensions
1.4 Installing Without All Requirements: What Won't Work
1.5 Recommended System
2 Installing
2.1 Using The Installation Page
2.2 Using The Command Line Installer
3 Miscellaneous Post-Installation Tasks
3.1 Configuring the "Email Dropbox"
4 References

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
40:56
Téléchargements opentaps-1.5.0.zip 112 Kio/s 40:56 :: 112 Kio/s :: 3% Retirer

1 sur 9 18/02/2019 à 12:58


Installation - X2Engine http://wiki.x2crm.com/index.php?title=Installa...

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 (http://x2community.com).

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

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
(http://docs.cpanel.net/twiki/bin/vief/EasyApache3
40:56
Téléchargements opentaps-1.5.0.zip 112 Kio/s 40:56 :: 112 Kio/s :: 3% Retirer

2 sur 9 18/02/2019 à 12:58


Installation - X2Engine http://wiki.x2crm.com/index.php?title=Installa...

/ApachePHPRequestHandling)).

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 (http://httpd.apache.org/docs/2.2/howto/htaccess.html); see

Velvet Blues: How to Activate PHP 5.3 on HostGator and GoDaddy


(http://www.velvetblues.com/web-development-blog/activate-php-5-3-
hostgator-godaddy/)
SiteGround knowledge base: How to switch to a different PHP version
(http://kb.siteground.com/article
/How_to_have_different_Php__MySQL_versions.html)

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
Téléchargements extensions SPL,
opentaps-1.5.0.zip 40:56PCRE and Ctype
112 Kio/s 40:56should all::be
:: 112 Kio/s 3%available
Retirer

3 sur 9 18/02/2019 à 12:58


Installation - X2Engine http://wiki.x2crm.com/index.php?title=Installa...

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 opentaps-1.5.0.zip
Téléchargements 40:56
112 Kio/s 40:56 :: 112 Kio/s :: 3% Retirer

4 sur 9 18/02/2019 à 12:58


Installation - X2Engine http://wiki.x2crm.com/index.php?title=Installa...

Deficiency Severity Problems/Notes

IMAP extension The email manager depends on the IMAP


Minor
missing extension.

Zip extension
Minor Cannot import or export custom modules.
missing

Google integration will not work


Time zone widget will not work
cURL extension
Minor Contact views may be inaccessible [2]
missing Cannot use local scripts that make API
calls
Cannot use built-in error reporter

allow_url_fopen Cannot receive software updates using the


set to "No"/0 in built-in update utility, and cannot receive
Major
PHP notifications of new software versions from
configuration within the app.

Application cannot be updated and cannot


run unless the permissions on all files and
directories are set to allow any system user
Directory
to read/write (not recommended). The
ownership Major
application uses file-based caching and also
mismatch
creates files and folders during software
updates, both of which require write access
to the filesystem.

Numerous components and features will not


json extension
Major work; the json_encode function is used
missing
throughout the application

PHP version Numerous fatal errors, including errors that


Fatal
earlier than 5.3 inhibit installation

mbstring
Application crashes upon login with "invalid
extension Fatal
unicode sequence" error.
missing 40:56
Téléchargements opentaps-1.5.0.zip 112 Kio/s 40:56 :: 112 Kio/s :: 3% Retirer

5 sur 9 18/02/2019 à 12:58


Installation - X2Engine http://wiki.x2crm.com/index.php?title=Installa...

Application cannot run; no database


pdo_mysql
connection is possible. It is a requirement of
extension Fatal
Yii Framework
missing
(http://www.yiiframework.com/).

Any other PHP


extensions listed
Fatal Application cannot run (requirements of Yii)
as required but
missing

Application cannot run. Regex used in URL


Outdated PCRE rules requires the "?J" group type, which was
Fatal
library version added to PCRE in version 7.4 (September 21,
2007)[3]

Apache 2.2 with mod_rewrite (http://httpd.apache.org/docs/2.0


/mod/mod_rewrite.html) enabled.
Ubuntu 12.04 LTS, CentOS 6.3, or Amazon Linux

If only Windows is available, the environment provided by WampServer


(http://www.wampserver.com/) 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 opentaps-1.5.0.zip
Téléchargements clicking the install40:56
button is highly recommended.
40:56 :: 112 Kio/s :: 3% Retirer
112 Kio/s

6 sur 9 18/02/2019 à 12:58


Installation - X2Engine http://wiki.x2crm.com/index.php?title=Installa...

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 a
commercial edition of X2Engine, 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 (http://php.net/manual/en/timezones.php) 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 opentaps-1.5.0.zip 11240:56
Téléchargements Kio/s 40:56 :: 112 Kio/s :: 3% Retirer

7 sur 9 18/02/2019 à 12:58


Installation - X2Engine http://wiki.x2crm.com/index.php?title=Installa...

webLeadUrl
The base URL of the web application.
unique_id
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.
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"
(http://x2community.com/topic/703-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"
(http://x2community.com/index.php?/topic/386-cant-open-contact-view/)
3. PCRE Changelog (http://www.pcre.org/changelog.txt)

Retrieved from "http://wiki.x2crm.com/index.php?title=Installation&


40:56
Téléchargements opentaps-1.5.0.zip 112 Kio/s 40:56 :: 112 Kio/s :: 3% Retirer

8 sur 9 18/02/2019 à 12:58


Installation - X2Engine http://wiki.x2crm.com/index.php?title=Installa...

oldid=1948"

Category: Support

This page was last modified on 4 February 2016, at 20:40.

40:56
Téléchargements opentaps-1.5.0.zip 112 Kio/s 40:56 :: 112 Kio/s :: 3% Retirer

9 sur 9 18/02/2019 à 12:58