X-Cart:Installing X-Cart Using the Installation Wizard

From X-Cart 4 Classic
Revision as of 17:12, 19 January 2010 by Admin (talk | contribs) (Created page with 'To install X-Cart using the Installation Wizard: 1. Download a distribution package from the File Area section of your HelpDesk account at [http://www.x-cart.com/xcart_manual/on…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

To install X-Cart using the Installation Wizard:

1. Download a distribution package from the File Area section of your HelpDesk account at https://secure.qtmsoft.com/ . The package you need is contained in the archive file x-cart-x.y.z.tgz, where x, y and x stand for the X-Cart version.

2. Put the files in the package to a web-accessible directory of your server or your hosting account.

If you use a Windows-based server, or a UNIX-based server without terminal access.
a) Decompress the archive with the package to a directory on your local computer.

To decompress the archive, use your favorite compression program like WinZIP or any other similar tool with support for TAR files.

b) Use an FTP client to upload the files and folders in the archive to the web-accessible directory of your server or your hosting account.

Make sure that the default file and directory structure of the package is retained.

Note: please make sure that before uploading X-Cart files to the server you set binary FTP transfer mode in your FTP client. Some of the uploaded files may be damaged if transferred in the ASCII mode.
If you use a UNIX-based server with terminal access.
a) Use an FTP client to upload the archive with the distribution package to the web-accessible directory of your server or your hosting account.
b) Decompress the package using one of the following commands.
gunzip < x-cart-x.y.z.tgz | tar -xvf -
tar -xzvf x-cart-x.y.z.tgz
As a result of extracting files from the archive, you should get the directory /xcart that would contain all X-Cart files and folders. The directory /xcart is created automatically; if necessary, you can rename the directory or move its content to a different location, e.g., your web root. Further in this manual we will refer to the directory with the X-Cart files and folders as the X-Cart root directory, X-Cart installation directory or /xcart directory.

3. If you are installing X-Cart on a UNIX-based server, change the permissions for the /xcart directory, the configuration file config.php, and the scripts admin/newsletter.sh and payment/*.pl as shown below.

> cd xcart
> chmod 777 .
> chmod 666 config.php
> chmod 755 admin/newsletter.sh
> chmod 755 payment/*.pl

4. Use your favorite web browser to run the installation script install.php.

To run the script correctly, in the address bar of your browser type the URL of the X-Cart installation directory followed by the script's filename. For example, if your domain name is www.example.com, and the X-Cart files are in the directory /xcart in your web root, the URL should be http://www.example.com/xcart/install.php .

This will open the Installation Wizard that will guide you through the installation process and help you install X-Cart. The Wizard includes several steps, and at every step the Wizard solves some specific tasks like checking server environment, gathering necessary details, etc. The picture below shows you a sample step of the Wizard. Beneath the header, the page is divided into two section. The section on the left shows you the progress of the installation process: the name of current step appears in dark blue, the steps that have been completed successfully are marked in green, the forthcoming steps are shown in grey. The section on the right contains different details about the current step of the installation process.

It is important to complete all the steps of the Wizard. At the final step the Wizard will display a screen saying that the installation is complete.

Installation 01.gif

5. Follow the instruction on the screen to complete all the steps of the Installation Wizard. The steps of the Wizard are described below in the order how they appear. To move between the steps, use the buttons Back and Next.

a) License agreement

At the first step of the Installation Wizard, you are supposed to accept the X-Cart Software License Agreement. Read the Agreement thoughtfully, and select the check box below the text of the Agreement.

Important: By selecting the check box you confirm that you agree with all the terms and conditions expressed in the X-Cart Software License Agreement. If you do not agree with any part of the Agreement, do not install the software and quit the Installation Wizard by closing the respective page of the web browser.
Installation 02.gif

If it is not the first time that you have run the installation script install.php, the Wizard will ask you to enter an authorization code for the existing copy of X-Cart. The authorization code (Auth code) is used in X-Cart to prevent unauthorized access to the installation scripts, and you need to enter the Auth code every time you re-install X-Cart, or change the skin, or install an add-on module.

Installation 03.gif
Note: If you do not remember the Auth code, find it in the Summary section of the X-Cart Admin area (Administration menu -> Summary). Alternatively, retrieve the code from the variable $installation_auth_code in the file include/install.php inside the X-Cart installation directory.

Click the Next button.

b) Checking PHP configuration

At this step, the installation script checks that the web server meets the minimum system requirements, verifies that the files and folders from the distribution package have not been modified, and checks that the necessary files and folders have correct permissions. The test result is displayed in a special table that contains the list of tested requirements and the status of every tested parameter. A sample test result is shown in the picture below.

Installation 04.gif

The statuses mean as follows:

  • [OK] - Requirement is satisfied completely);
  • [FAILED] - Requirement is not satisfied. Installation cannot be continued as this dependency is critical;
  • [WARNING] - Requirement is not satisfied. Installation can be continued as this dependency is not critical.

Ideally, all the parameters in the test result should have the [OK] status. It is also recommended that you solve the issues with the [WARNING] status. The issues marked with the [FAILED] status must be fixed without fail. Otherwise you will not be able to continue with the installation and use X-Cart.

To help you find out how to fix a particular issue, for each failed requirement the Wizard provides a short description and a possible solution. This information is presented in special warning messages on the right to the test results. The detected issues are grouped according to the failure type: environment checking errors, failed critical dependencies and failed non-critical dependencies.

Installation 16.gif

To see the available information about a particular error or failure, click on the Installation 17.gif link. This will expand the warning message and open a description of a possible solution.

If you are not sure you have enough resources to fix the detected issue(s) on your own, you can send a report to the X-Cart Support Team so that they could provide you with a solution. The report would contain a detailed description of the detected issue(s) together with some important information about your web server configuration.

To send the report click the Send report button below the the warning and error messages.

Installation 14.gif

This will open a new screen with an automatically generated technical report and a text field where you can put your comments.

Installation 15.gif

If necessary, put your comments to the Additional comment field and click the Send report button to send the report with your comments (if any) to the X-Cart Support Team. You message will posted to the HelpDesk system as a regular support ticket, and will be processed by our Support Team, who will post their reply in the same ticket. To read the answer of the responsible support engineer you will need to log in to your HelpDesk account at https://secure.qtmsoft.com .

Click the Next button.

c) Preparing to install X-Cart database

Here you must specify the host name of the server on which your are installing the store, the host name of your secure (HTTPS) server and the details of the MySQL database that will keep all your store's data.

Installation 05.gif

The fields in this form mean as follows:

  • Server host name: The host name of the server on which you are installing your copy of X-Cart.
  • Secure server host name: The host name of the secure server that will provide access to your X-Cart based store via the HTTPS protocol.

Important: Server host names must not include the protocols ('http://' or 'https://' prefixes). Enter only the domain name, e.g., www.example.com. Also pay attention that the name of the secure HTTPS server can either coincide with the name of the HTTP server or have a different name. If you do not have an HTTPS server now, or if you do not remember its name, instead of the secure server name temporarily enter the name of your HTTP server. You will be able to change it later by editing the variable $xcart_https_host in the configuration file config.php.

  • X-Cart web directory: The web-accessible directory of your server or hosting account where X-Cart files are located.

Note: As a rule, the installation script detects this directory automatically; however, if the detection has not been a success, you need to enter the name of the appropriate web directory manually. Put a slash before the name of the directory and no slash at the end (for example, /xcart). If you are installing X-Cart to the web root, leave the field empty.

  • MySQL host name: The DNS name or the IP-address of your MySQL server.
  • MySQL user name: The username for your MySQL user account.
  • MySQL database name: The name of your MySQL database.
  • MySQL password: The password for your MySQL user account.

Note: The database server name is typically localhost, but it is not the rule and the actual name of the database server may be different. If you do not know the name of your database server, your database name, etc. please check it with your hosting provider.

  • Your e-mail address: The email address that you would like to use as a default company email address. This address will be assigned to the default Administrator and Provider (in X-Cart Pro) accounts that are created automatically during the installation. If necessary, you will be able to change the default email address after the installation is complete. An email notification about the successful installation of X-Cart software will also be sent to that address.

Click the Next button to continue. This will reload the page and you will see a new screen that will display the information that you have entered at the previous screen and a few more fields.

Installation 06.gif

The fields in this form mean as follows:

  • Languages: The languages that you wish to use in your store. By default X-Cart is delivered with the English language pack only, and English is selected as an only language to be installed. Later on you will be able modify the default set of languages in the Languages section of the Admin area. The instructions on how to manage languages are available in the Managing Languages section of this manual.
  • States table: If your company is based in a country that has states, or if you are planning to sell internationally and your customers are going to be from countries that have states, you may want to import the names of the states for each of these countries. Later on you will be able use the imported state names for setting up destination zones, your company address and user addresses.

In the selectbox you can choose as many countries as you wish. To select a country, simply click on its name and highlight the item. To select more than one country, hold down the CTRL key while clicking the appropriate country names. If you do not wish to import states, select No states.

If a particular country is missing from the list, you will be able to manually add the country and its states later. The instructions on how to carry out this task are available in the States section of this manual.

  • Sample categories/products: The installation script enables you to import a sample product catalog so that you could test the newly installed store. The sample catalog here is very similar to the one you could try with the online demo available at the product website www.x-cart.com . Later on you will be able to remove the sample catalog using the Remove data tool available in the Summary/Tools section of the Admin area. To import the sample catalog, select Yes; otherwise, select No.
  • Configuration settings: For some countries X-Cart allows you to use pre-configured store settings. These settings include generic tax rules and rates, destination zones, default company and customer addresses and phone numbers, language variables which may differ from one country to another (e.g. postal code instead of zip code), etc.

If you find it helpful to use these pre-configured settings to make the process of configuring your store faster, choose the name of your country from the drop-down box. The installation script will import settings for the selected country then.

  • Update config.php only: This option allows you to decide if you wish to preserve the data in the MySQL database that you have specified at the previous screen. If you leave the check box unselected, the installation script will drop all the existing X-Cart tables in the database, create new tables and populate them with new data. If you select the check box, the installation script will only update the information in the X-Cart configuration file config.php, but keep the existing database untouched.
  • Blowfish key: You should complete this field only if you are installing X-Cart with a database that was used by another X-Cart installation and you want to preserve the data from the database. If you complete the Blowfish key field, make sure the Update config.php only check box is selected.
  • Store images in (Database / File system): This setting allows you to choose where you wish to keep the store images (including product thumbnails and full-size product images, category icons, etc.): on the file system where X-Cart is installed or in the X-Cart database. Storing images in the database makes it easier to backup images, because they will be kept directly in the database dump. Storing images on a file system makes the database more compact and generally increases the performance level of your store.

Click the Next button.

d) Installing X-Cart database

Now the installation script updates the main configuration file config.php and writes the server and MySQL details that you have specified at the previous step of the Installation Wizard. If you have also forced to perform any of these tasks, the script updates the database, populates the database with demo data, import states, moves images to the file system, etc.

Installation 07.gif
Important: Depending on the performance level of your server, this process may take several minutes; however, it should not take more than 5-6 minutes.

Click the Next button.

e) Layout settings

At this step of the Installation Wizard, you can choose a skin for the Customer area (storefront) of your store. To choose a skin you need to select the skin name from the drop-down box.

Installation 08.gif

Click the Next button.

The installation script will check the existing skin files (if any). If any of the existing skin templates were ever modified, the system will display a message saying that such templates have been found. To see the list of templates, click on the Installation 19.gif link.

Installation 18.gif

You can choose the keep the modified templates and preserve the modifications, overwrite the modified templates and loose the modifications, or cancel the installation. The latter option is good when you want to backup the modified files before you resume the installation. Use the button Back and Next to either return to the previous screen where you can choose a different skin or move to the next step and continue the installation.

f) Setting up templates

Now the installation script creates the necessary X-Cart folders and copies the files for the chosen skin. After the process is completed, the installation script will display a preview of the Customer area with the chosen skin. If you want to choose a different skin, click the Back button and move to the previous step of the Installation Wizard. If you are satisfied with the preview and wish to accept the skin, click the Next button to move to the next step and continue the installation.

Installation 09.gif

g) PayPal payment processing

At this step the Installation Wizard you can enable the PayPal payment method in your store. To enable PayPal right now, select Yes from the Do you wish to enable PayPal payment processing now? drop-down box. Or select No to skip this step.

Installation 10.gif
Note: Do not worry about making the final decision right now: you will be able to enable/disable PayPal in the Admin area of your store later.

Click the Next button.

h) Enabling PayPal payment processing

You get to this step only if you chose to enable the PayPal payment method. Here you are supposed to specify the email address that your current PayPal account is registered to or the email address that you wish to use for registering with PayPal (if you do not have an account yet).

Installation 11.gif

Click the Next button to move to the next step and continue the installation.

When the installation is complete, the installation script will send a verification message to the email address provided at this step. To enable PayPal payments in your store, follow the link in the massage. If you did not have a PayPal account before you started to install X-Cart, you need not create one right now. When somebody pays for the products in your store using the PayPal payment method for the first time, you will receive an email message from PayPal saying that there is a payment waiting for you at that email address and you need to open an account in order to receive the payment. If you miss opening an account within a limited period of time, PayPal will consider the payment to be unclaimed and send the money back to the person who made the payment.

i) Generating a system fingerprint

Now the installation script generates the system fingerprint.

In X-Cart, a system fingerprint is a list of MD5 checksums of all X-Cart files. The system fingerprint generated during the software installation captures the default/unmodified state of the store and can be used later to control the integrity of the store files. For details, see the System Fingerprints section further in this manual.

When the the fingerprint is generated, you will see a message saying that the system fingerprint has been generated successfully.

Installation 12.gif
Note: System fingerprint generation may take several minutes, please be patient.

Click the Next button.

j) Installation complete

This is the final step of the Installation Wizard. Here the installation script reports that X-Cart has been installed successfully and provides direct links to the Customer, Admin and Provider areas of your store. For the Admin and Provider areas the page displays the default login credentials (a username and a password) generated during the installation. Do not forget to change the default passwords after your have logged in to either the Admin area or the Provider area for the first time.

In addition, the message also contain the authorization code (Auth code) for the installed copy of X-Cart. The code is used to prevent unauthorized access to the X-Cart installation scripts, and you will be asked to provide the Auth code if you decide to reinstall X-Cart, change the skin, or install an add-on module. It is not necessary to remember the as you will be able to find it in the Summary section of the Admin area or retrieve it from the variable $installation_auth_code in the file include/install.php in the X-Cart root directory.

Installation 13.gif

All this information will be duplicated to email address that you specified as the company email address at the step "Preparing to install X-Cart database".