X-CART README ============= Welcome! This file contains basic information about X-Cart. More detailed information on how to use X-Cart is available in X-Cart Reference Manual. I. SYSTEM REQUIREMENTS II. INSTALLATION III. COMMENTS FOR DEVELOPER IV. X-CART STRUCTURE V. X-CART FILES VI. DEFAULT ACCOUNTS VII. SETTING UP AND CONFIGURING VIII. BUG REPORTS I. SYSTEM REQUIREMENTS ====================== Minimal system requirements --------------------------- 1. Web server with support for PHP version 4.0.6 or better (PHP5 is also supported). Make sure the configuration file php.ini meets the following requirements: a. safe_mode must be disabled b. file_uploads must be enabled c. register_long_arrays must be enabled (only for hosts using PHP5; not required for PHP4) (all these values are default) 2. The web server must have support for MySQL databases. X-Cart is compatible with MySQL versions from 3.23. You will need to have access to a MySQL database, so make sure you have the following information: your MySQL server name, your database name, your username and password for MySQL access. 3. The performance of the server recommended for X-Cart to run on depends on how many visitors your store will have. An unpacked distribution of X-Cart requires about 25 megabytes of disk space, but you may need more if you are going to use additional files or custom templates for X-Cart. 4. The database size used by X-Cart depends on the number of products, customers and orders stored in it. For example, for small shops it may be 1 megabyte, for medium 10, and for huge stores over 100 megabytes. Advanced requirements and recommended settings ---------------------------------------------- Certain parts of X-Cart's functionality rely on using external files. Accordingly, your web server must be allowed to run external executable files (like Perl) and to make outgoing connections to the Internet (that is required for online payments). The following components may be required: 1. An HTTPS module (like Net::SSLeay perl module, CURL executable, OpenSSL executable or libCURL PHP extension) for some of the online credit card processing modules and for shipping modules. 2. EXPAT extension for PHP for Intershipper, UPS or USPS shipping modules. Make sure the functions "exec", "popen", "pclose" and "ini_set" are not included in the disabled functions list in php.ini: 1. PHP function "exec()" must be allowed for the correct functioning of most of the CC payment processing modules used with X-Cart (CyberCash, CyberPac (LaCaixa), VeriSign PayFlow Pro, PayBox, CyberSource, PaySystems Client, VaultX), HTTPS modules (Net::SSLeay, CURL, OpenSSL, https_cli), GnuPG/PGP, X-Carts Patch/Upgrade functionality. 2. PHP functions "popen()" & "pclose()" must be allowed for the correct functioning of some HTTPS modules (CURL, Net::SSLeay), payment modules (Saferpay, CyberSource, iDeb), shipping modules (DHL/Airborne, Canada Post, UPS Online Tools, Intershipper, AntiFraud module. 3. PHP function "ini_set()" is used for the session mechanism and enhances security. For help on this visit the PHP site at http://www.php.net An SSL certificate is highly recommended to ensure security of online transactions at your store. You can obtain a certificate using our "Security products" section. Note: The above-listed requirements are usually met by all web hosting service providers. If unsure, contact your provider for details. II. INSTALLATION ================ For detailed instructions on installation refer to INSTALL file in X-Cart directory. III. COMMENTS FOR DEVELOPER =========================== There are several ways to customize the look and feel of X-Cart: 1. You can modify the Smarty-templates. Use either FTP or the "Edit templates" or "Webmaster mode" features to do that. You can refer to http://smarty.php.net/manual/en/ to learn more about Smarty. 2. You can modify the color scheme by editing the '/skin1/skin1.css' file. Use either FTP or the "Edit templates" feature to do that. 3. You can re-upload the default images stored in the /skin1/images/ directory. Use either FTP or the "Edit templates" feature to do that. 4. Most of X-Cart texts are stored in the so-called "language variables". You can edit the language variables under the "Languages" section of the admin interface. You might want to modify the following templates: skin1/customer/home.tpl - the main template, all other templates are directly or indirectly included into this one. skin1/customer/categories.tpl - the categories list on the left side of the screen. skin1/customer/main/subcategories.tpl - the subcategories list in the central space. skin1/head.tpl - the header part of the screen. For more detailed consultations contact our support service over your personal support helpdesk account at https://secure.qualiteam.biz IV. X-CART STRUCTURE ==================== 1. PHP scripts: a) Customer related scripts are located in ./ (root) directory. b) Administrator related scripts are located in ./admin directory. c) Provider related scripts are located in ./provider directory. d) Common scripts are located in ./include directory. e) Newsletter Mail subsystem scripts are located in ./mail directory. f) Modules related scripts are located in ./modules directory. g) Customer/Administrator/Provider related scripts location is configured in ./top.inc.php script. 2. Configuration and Smarty class scripts are located in ./ directory. 3. CSS styles are described in ./skin1/*.css file. 4. Smarty templates configuration can be found in ./skin1/skin1.conf file. 5. Templates directory: a) Common templates are located in ./skin1 and ./skin1/main directories. b) Customer related templates are located in ./skin1/customer directory. c) Administrator related templates are located in ./skin1/admin directory. d) Provider related templates are located in ./skin1/provider directory. e) Mail templates are located in ./skin1/mail directory. f) Modules related templates are located in ./skin1/modules directory. 6. Compiled templates (for cache and Smarty internal use): ./var/templates_c 7. Dump of MySQL database is in ./sql/*.sql file. 8. Website images are located in ./skin1/images directory. 9. Files related to integrated shipping modules are located in ./shipping directory. V. X-CART FILES =============== Top level files: ./README - Documentation file ./INSTALL - Documentation file ./index.html - Welcome page ./shop_closed.html - Shop is closed page ./skin1/*.css - CSS files ./top.inc.php - Customer/Administrator/Provider areas location definition ./prepare.php - General preparation for application launching ./config.php - Main configuration file ./icon.php - Show category icon from SQL DB ./image.php - Show product thumbnail image from SQL DB ./product_image.php - Show product detailed image from SQL DB ./install.php - Installation Wizard script ./smarty.php - Smarty class declaration VI. DEFAULT ACCOUNTS ==================== There are default user accounts in your copy of X-Cart system. You can easily change/delete them as ordinary users. a. Administrator account (valid for X-Cart Gold version only): Usertype: Administrator/Provider Username: master Password: master Interface URL: http://www.example.com/[xcart_directory]/admin/ b. Administrator account (valid in X-Cart Pro version only): Usertype: Administrator Username: admin Password: admin Interface URL: http://www.example.com/[xcart_directory]/admin/ c. Provider account (valid in X-Cart Pro version only): Usertype: Provider Username: provider Password: provider Interface URL: http://www.example.com/[xcart_[directory]/provider/ d. 'Root' provider account (valid in X-Cart Pro version only): Usertype: Provider Username: root Password: root Interface URL: http://www.example.com/[xcart_directory]/provider/ VII. SETTING UP AND CONFIGURING =============================== X-Cart system configuration is divided into several files. Main configuration file - "config.php" - is located under main X-Cart directory. This file contains different types of variables: * SQL DB information * Single Store operation mode flag * Safe Administrator mode flag * Customer titles * Credit Card types accepted by your store * etc Template configuration file is "skin1.conf". Configuration variables from this file are used in templates and affect the look and feel of your web store. VIII. BUG REPORTS ================= Report bugs and suggestions on improving X-Cart to your personal support helpdesk account at https://secure.qualiteam.biz * * * * * X-Cart Copyright (c) 2001-2007 Ruslan R. Fazliev All rights reserved.