![]() |
||
![]() |
1.0.4 Documentation | ![]() |
![]() |
![]() |
2. InstallationThis section will guide you through the installation procedure for Zelerate AllCommerce.This installation procedure assumes that you have installed and configured all the needed prerequisites to run AllCommerce and are familiar with command-line arguments. 2.1 Prerequisites
All of these prerequisites are readily available for the Linux operating system. Other operating environments, such as Unix, Solaris, FreeBSD, and Windows 2000, are also supported. If you have not installed all of the prerequisites that are needed for AllCommerce we strongly advise that you install these prerequisites before continuing on with the installation procedure. 2.1.1 PerlAllCommerce requires that you have Perl installed and working properly. You can find out if you have Perl installed by entering perl -v from a shell prompt. If you have Perl installed, this command will return a response like:This is perl, version 5.005_03 built for i386-linux Copyright 1987-1999, Larry Wall ... The version number should be of the form "5.005_xx" or "5.x.y". If you do not receive this response, or if your Perl version is not at the supported version, you will have to install (or update) Perl before continuing with this installation. 2.1.2 DatabasesAllCommerce requires an installed database management system. Currently, it has built-in support for these databases:
2.1.3 Database Drivers (DBI and DBD)Perl will need DBI and DBD drivers, in order to communicate with your selected database.DBI is a database interface API for Perl. It allows AllCommerce to smoothly connect to a database. DBI defines an API, but it omits the implementation-dependent details for the specific database. DBD Drivers are written to bridge the gap, implementing the API for a specific independent database. The DBI alone is not sufficient, as it is merely an interface between your Perl code and a specific database driver. Therefore, the DBI Driver needs a functional DBD Driver to communicate with the database. 2.1.4 A Web ServerAllCommerce requires that you have a Web server installed and working properly before installing AllCommerce.At this time AllCommerce is optimized to only run with the Apache Web server. However, there is a ported version of AllCommerce available which runs under the Microsoft IIS server. In future releases of AllCommerce the ported functionality for IIS will be included in the standard release. 2.1.5 Cookieless ShoppingAllCommerce can provide cookieless browsing, using the "wrapper" interface. The wrapper interface is dependent on the libwww library for Perl. To get libwww-perl working properly, the following packages must be installed:
These packages can be obtained from www.linpro.no/lwp or www.cpan.org. 2.2 Expanding the TarballBefore expanding the AllCommerce tarball, move the file os_allcommerce.1.0.4.tar.gz to the directory which your Web Server uses for served data.If you have Apache installed, the Apache default directory should be /home/httpd. Untar Zelerate AllCommerce by entering: tar -zxvf os_allcommerce.1.0.4.tar.gz Now check the directory ownership: ls -ld os_allcommerce In the case of a default Apache installation, you should see something like: drwxr-xr-x 15 nobody nobody {size} {mm dd time} os_allcommerce If the directory is not owned by nobody.nobody, enter: chown -R nobody.nobody os_allcommerce using ls to verify that the change in ownership took effect. In general, you will want all files and directories to be owned by the account under which the Web server will be run (typically, this is nobody). If you wish to conserve disk space, you may now remove the tarball by entering: rm os_allcommerce.1.0.4.tar.gz 2.3 Automated InstallationZelerate AllCommerce can be installed by means of an automated installation procedure that will set up and configure various aspects of the product. This procedure prompts the user for various data throughout the installation process and is recommended for non-technical users. 2.3.1 Installation using configure.plconfigure.pl is a Perl script which will assist you in the installation and configuration of Zelerate AllCommerce.Please note: At this time, configure.pl is limited to the MySQL database (running locally) and to the Apache Web Server. If you are not using MySQL as your database for AllCommerce, you will need to configure AllCommerce manually (see section 2.4, Manual Installation). 2.3.2 Executing the ScriptIf you are ready to run configure.pl and begin the installation process, you will need to be in the os_allcommerce directory.From a shell prompt, type: ./configure.pl to execute the script and begin the installation process. * The command line arguments assume that you are in the os_allcommerce directory. 2.3.3 The Installation Processconfigure.pl will perform several dependency checks, then allow you to perform a step-by-step installation of Zelerate AllCommerce.2.3.3.1 Check for DependenciesAllCommerce has several prerequisites; these must be installed before AllCommerce will work properly. The configure.pl script will make sure that the prerequisites are installed and working properly.2.3.3.1.1 Perl and Perl ModulesThis step will perform a check to see if Perl is installed and will check to see if the libraries needed for cookieless shopping are present.##### # # Zelerate AllCommerce Version 1.0.4 # ##### Welcome to the Install Script for Zelerate AllCommerce. This script will guide you through the installation process. Do you wish to continue with this installation? (y/n) ##### # # Perl Setup # ##### Checking Perl version ... using Version 5.00503 ... ok. libwww-perl and other needed libraries from CPAN are not installed for cookieless shopping, please refer to the install notes for more details. If you are missing Perl or the needed Perl library for cookieless shopping, a message is displayed on the screen explaining which is missing. For more information on the prerequisites needed to run AllCommerce, please refer to section 2.1. 2.3.3.1.2 DBI and DBD DriversThis step will perform a check to make sure that DBI (including the needed DBD drivers) are installed and working properly.##### # # DBI Queries # ##### Checking for available DBI drivers ... done. Listing each DBI driver with recognized data sources (databases) ... Driver: mysql (1)Data Source is DBI:mysql:mysql (2)Data Source is DBI:mysql:test If DBI and DBD are installed and working properly, you will see a list of data sources that can be used with AllCommerce. 2.3.3.2 DatabaseThis step will allow you to create a new database table or use an existing database.If you have multiple databases installed, you will be prompted to select the appropriate data driver for use with AllCommerce. ##### # # Database Driver # ##### Which database driver will you be using? [mysql]If you are using mysql as your database, press the return key. If you are using one of the other stable supported databases, enter the name of the data driver and press return.
##### # # Database Table Setup # ##### Do you wish to create a new database table? (y/n) Type [y] to Continue and create a new database table. See section 2.3.2.2.1 (Create New Database Table). Type [n] to Continue and use an existing database table. See section 2.3.2.3.2 (Use Existing Database Table). 2.3.3.2.1 Create New Database TableThis step will walk you through the creation of a new database table for use with AllCommerce.Default values are shown in brackets. Which database driver will you be using? [mysql] This step is asking for the name of the database driver you are using for AllCommerce. For example, if you are using MySQL as your database driver, you would enter mysql. What is the name of the database? [osallcommerce] This step is asking for the name of the database table you wish to create, for use with AllCommerce. Suppose you are setting up a store to sell shoes; you may want to call the database table shoes or even bigfeet. What is the database username? [root] This step is asking for the database account user name. If you have not set up an account for the database user in MySQL, the default user will be root. What is the database password? [] This step is asking for the database account user name's password. If you have not set up a password for the database user in MySQL, the default password for the database user should be left empty. What is the database servername? [] This step is asking for the server name of the machine which is hosting your database. This machine can be either a separate server or the same server on which you have AllCommerce installed. If you are running AllCommerce and the database server on the same machine, this setting can either left blank or set to localhost. What is the database port? [3306] This step is asking for the communications port is used to communicate with the database server. In the case of MySQL, if you are using a separate database server, the default communications port should be 3306. 2.3.3.2.2 Use Existing Database TableThis step will walk you through the recreation of a new database table, for use with AllCommerce.Do you wish to recreate the database (i.e. drop and create) (y/n)? Type [y] to Continue and select an existing database table. Type [n] to abort the installation. Driver: mysql (1) Data Source is DBI:mysql:mysql (2) Data Source is DBI:mysql:osallcommerce (3) Data Source is DBI:mysql:test Which database ( e.g. 2 for (2) ) do you want to recreate? This step is asking for the number of the database that you wish to drop and have recreated. Use the number that is listed next to the name you desire. What is the username? [root] This step is asking for the database account user name. If you have not set up an account for the database user in MySQL, the default user will be root. What is the password? [] This step is asking for the database account user name's password. If you have not set up a password for the database user in MySQL, the default password for the database user should be left empty. What is the servername? [localhost] This step is asking for the server name of the machine which is hosting your database. This machine can be either a separate server or the same server on which you have AllCommerce installed. If you are running AllCommerce and the database server on the same machine, this setting can either be left blank or set to localhost. What is the port? [3306] This step is asking for the communications port which is used to communicate with the database server. In the case of MySQL, if you are using a separate database server, the default communications port should be 3306. Are you sure you want to recreate the database osallcommerce (recreating the database will destroy any existing information in the database)? (y/n) Type [y] to continue the installation. Type [n] to abort the installation. Please note: If you answer "y" to this step, all data in the database you are recreating will be dropped and overwritten and all information stored in this table will be lost. 2.3.3.2.3 Setting up the AllCommerce Data StructureA data structure for AllCommerce will need to be imported into the database table that you have just created. If the database table was created successfully, this step will create the AllCommerce data structure without any prompting.##### # # AllCommerce Data Structure # ##### Creating tables ... done. If this step was not automated or displayed error messages, please refer to database creation in a manual installation (section 2.4.2.2). 2.3.3.3 Web Server ConfigurationA Web server will need to be configured for use with AllCommerce. At this time, configure.pl only supports the Apache Web server.2.3.3.3.1 Apache Virtual HostThis step will walk you through the configuration of a Virtual Host for the Apache Web server.Please note: due to the variations of Apache and SSL, you may need to hand-edit your httpd.conf file in order for the system to work properly. The Apache configuration part of this configure script can be bypassed at the appropriate prompt, if necessary (this allows AllCommerce to be run with other Web servers). ##### # # Apache Virtual Host Setup # ##### Do you want to add virtual host entries into your Apache httpd.conf (httpsd.conf) file? (y/n)
Type [n] to skip automated configuration of the Apache Web Server and go to
section 2.3.2.4 (AllCommerce Configuration Files).
Please give the directory where your Apache httpd.conf or httpsd.conf file is located. This step is asking for the directory in which your Apache Web server keeps the configuration files on your server. In a default Apache installation, this will be either /etc/httpd/conf or /usr/local/httpd. Will you be running ssl? (y/n) If you wish to run AllCommerce through a secure Web server, so user information is encrypted, you will want to enable ssl. This setting is used in various areas of AllCommerce which run in a secure mode. ServerName? This is the server name for the virtual host which you are configuring. Remember, this server name must either have a DNS record or an entry in your /etc/hosts file for Apache to work properly. Server Name Example: www.mydomain.com Port? This is the port the Apache Web server uses to communicate. The default port for the Apache Web server is 80. Server Admin? This is an email address the Web Server can contact if a problem occurs. Document Root? This Document Root setting should be set to the directory which holds your AllCommerce file tree. In the case of a default AllCommerce installation, this will be /home/httpd/os_allcommerce. Error Log? The Error Log is the error log file name. Transfer Log? The Transfer Log is the transfer (access) log file name. cgi-bin Directory? The cgi-bin Directory should be set to the directory which contains your AllCommerce cgi-bin scripts. In the case of a default AllCommerce installation, this will be /home/httpd/os_allcommerce/cgi-bin. configure.pl will now show you a preview of the entry it wishes to make in the httpd.conf or httpsd.conf file. Write this output to Apache httpd (httpsd) conf file? [n]
Type [n] to skip saving the configuration
for your Apache Web Server.
2.3.3.4 AllCommerce Configuration FilesAllCommerce has four configuration files that need to be configured in order to run the product. These configuration files contain almost all of the business rules for your site. The three configuration files which are set up with configure.pl are: site.conf, machine.conf, and database.conf. These files are opened automatically and will prompt you for the answers to various configuration parameters.##### # # Configuration Files Setup # ##### Configuration file settings ... 2.3.3.5 Initial Data LoadAn initial data load needs to be primed into AllCommerce in order for the platform to take on its personality as a commerce application. The initial data load is performed automatically if the database was created successfully and the import of the AllCommerce data structure was completed.##### # # Initial Data Load # ##### Adding initial data load ... done. If this step was not automated or displayed error messages, please refer to "importing the initial data load in a manual installation" (section 2.4.2.5). 2.3.3.6 Shipping Methods and Rates Data LoadThe shipping methods and rates data load allows you to use the download information from United Parcel Service (UPS), the U.S. Postal Service (USPS), and Federal Express (FedEx) to calculate shipping costs for a customer transaction.Using information that you download from the shippers you want to use, this step translates these files into SQL insert statements that can be imported into your database. ##### # # Shipping Tables Data Load # ##### Running import_shipping_tables.pl ... done. Adding shipping entries (This may take a few minutes) ... No shipping entries to add. If this step was not automated or displayed error messages, please refer to "shipping methods and rates data load in a manual installation" (section 2.4.2.6). 2.3.3.7 Successful InstallationAfter configure.pl has been successfully executed, you should be able to proceed to login to the AllCommerce admin screen and start creating your site.https://sitename.sitedomain/cgi-bin/om/admin/login.cgi username: admin password: allcommerce For more information on how to use the AllCommerce Administrators, see section 3 (Administration). 2.3.4 configure.pl Optionsconfigure.pl also has several command-line options that can be used while invoking the script, as: ./configure.pl help Please note: if no keyword is provided after the script name, the entire installation process above is invoked. * The command line arguments assume that you are in the os_allcommerce directory. The options supported in configure.pl are:
2.4 Manual InstallationThe manual installation procedure should be used if you cannot run configure.pl or choose this method to install and configure AllCommerce. This procedure will walk you through the various steps of installing and configuring AllCommerce, creating a database, and setting up a virtual host for your Web server.2.4.1 Taking over from configure.plIf you had problems installing AllCommerce using configure.pl, you can start from the first manual step and begin the installation process again or you can move forward to the step where configure.pl ran into difficulties.2.4.2 The Installation ProcessThe manual, step-by-step installation of AllCommerce requires that you have access to a command prompt. In the manual installation procedure, you are walked through the database creation, the Web server configuration, and the various configurations and data loads that are needed for AllCommerce.2.4.2.1 Check for DependenciesAllCommerce has several prerequisites that need to be installed in order for the system to work properly. Please make sure (manually) that the prerequisites are installed and working properly.If you have not installed all the prerequisites that are needed for AllCommerce (described in section 2.1), we strongly advise that you install them before continuing on with the installation procedure. 2.4.2.2 Database Table CreationAllCommerce uses a database table to store information that will be accessed by the commerce application. The information stored in the database table allows a centralized point for all data within your site.There are two options in the creation of the database table: create a new database or use an existing database table. We strongly recommend that you choose to create a new database table for use with AllCommerce. 2.4.2.2.1 Create New Database TableThis step will walk you through the creation of a new database table, for use with AllCommerce.To create a new database table go to a command prompt and type: mysqladmin create {new database name} 2.4.2.2.2 Use Existing Database TableIn future releases there will be a better way to integrate with an existing database table.To integrate with an existing table we recommend that you follow the steps below. From a command prompt type: mysqldump -t mysql {existing database table} > data/{existing database table}.mysqldThis will save all data from the existing table you wish to use with AllCommerce. A copy of this data is stored in a file named {existing database table}.mysqld located in the data directory of AllCommerce. mysqladmin drop {existing database table} You will then see the following warning message: Dropping the database is potentially a very bad thing to do. Any data stored in the database will be destroyed. Do you really want to drop the '{existing database table}' database [y/N] Please be sure you really are prepared to drop this data. By answering 'y' to this step all data stored in this database table will be lost. * The command line arguments assume that you are in the os_allcommerce directory. 2.4.2.2.3 Setting up the AllCommerce Data StructureAllCommerce requires that your database table be configured with a set of data structures specific to AllCommerce. This specific set of data structures is known as the AllCommerce data structure.To import the AllCommerce data structure into the database table you created for AllCommerce, from a command line type: For MySQL: mysql {name of database table} < conf/tables.mysql.skelFor PostgreSQL: PostgreSQL {name of database table} < conf/tables.postgresql.skelFor Oracle: You must use the configure script, configure.pl, for Oracle. * The command line arguments assume that you are in the os_allcommerce directory. 2.4.2.3 Web Server ConfigurationAllCommerce requires that you have a Web server installed and working properly.At this time AllCommerce is optimized to only run with the Apache Web server. However, there is a ported version of the AllCommerce available which runs under the Microsoft IIS server. In future releases of AllCommerce the ported functionality for IIS will be included in the standard release. 2.4.2.3.1 Apache Virtual HostThe Apache Web server will need to have several changes to the default configuration in order to work properly with AllCommerce. The Apache Web server configuration file which will need to be edited is named httpd.conf. This file is located in the server root for Apache in a directory named conf.For example, on a default installation of Apache the server root will be either /etc/httpd or /usr/local/httpd. It is recommended that you create a Apache virtual host for the site you wish to use with AllCommerce. Here's an example virtual host entry for a typical AllCommerce installation: <VirtualHost host.some_domain.com> ServerAdmin Webmaster@host.some_domain.com DocumentRoot /home/httpd/os_allcommerce/ ServerName host.some_domain.com DirectoryIndex index.html index.shtml index.htm index.cgi ErrorLog logs/host.some_domain.com-error_log TransferLog logs/host.some_domain.com-access_log AddHandler cgi-script .cgi AddType text/html .shtml AddHandler server-parsed .shtml ScriptAlias /cgi-bin/ /home/httpd/os_allcommerce/cgi-bin/ # allow access to the site <Directory "/home/httpd/os_allcommerce"> AllowOverride all Options Includes FollowSymlinks ExecCGI Allow from all </Directory> # disallow access to everything else <DirectoryMatch "/home/httpd/os_allcommerce/(DOCS|bits|conf|crons |data|lib|skel|tools|transit|var)"> Options None Order deny,allow deny from all </DirectoryMatch> </VirtualHost>There are several important elements that need to be configured for Apache to work properly with AllCommerce.
2.4.2.4 AllCommerce Configuration FilesIn order to configure your site parameters for AllCommerce, you will need to edit four configuration files located in the os_allcommerce/conf directory.These configuration files are site.conf, database.conf, machine.conf, and cluster.conf.
./update_conf.plNote for users of openmerchant0.7.pre6 and earlier versions: The site configuration file store.pm has been changed to site.pm, which is now a machine-generated file. Some variables within have also had name changes. It is therefore (strongly) recommended that you do not attempt to re-use any existing store.pm files you may have and upgrade to this version of AllCommerce. 2.4.2.5 AllCommerce Initial Data LoadYou will have to load an initial data load into AllCommerce which contains default behaviors for this application.To import the AllCommerce initial data load, from a command line: Change directory to the os_allcommerce directory and run: ./configure.pl idl 2.4.2.6 Shipping Methods and Rates Data LoadAllCommerce uses real-time shipping methods in checkout. The shipping carriers supported in this release are: UPS, Fed Ex and USPS.
2.4.2.7 Successful InstallationAfter manual installation has been successfully completed, you should be able to proceed to login to the AllCommerce admin screen and start creating your site.https://sitename.sitedomain/cgi-bin/om/admin/login.cgi username: admin password: allcommerce For more information on how to use the AllCommerce Administrators, see section 3 (Administration). 2.5 Site Templates and CustomizationAllCommerce uses a template based publishing model. In this template based model, html templates are stored in the file system and template names are stored in the database using the AllCommerce Content Manager.The templates are in the os_allcommerce directory:
2.6 Loading YOUR DataAllCommerce provides a Content and Inventory manager to load data into the system. For more information on loading your data into AllCommerce, see section 3 on administration.2.6.1 Critical ConceptsSee section 3 on AllCommerce administration.2.6.2 Importing Existing DataAt this time, there is no tool in this AllCommerce release to load existing data. For more information on the AllCommerce data structure see section 5.3 (Data Structures).2.6.3 Loading ImagesAllCommerce stores images in the filesystem in the os_allcommerce/images directory. On most systems this directory can be mounted which allows for a drag and drop interface. If you are running AllCommerce on one server images can be transferred through your systems secure copy.As items are created using the AllCommerce Content manager, unique object identifiers are assigned. These unique identifiers should be used in naming the assets in the images directory. 2.6.4 Tax TablesThere are no tax tables used in this release of AllCommerce. The tax information is handled in the configuration file site.conf.2.7 General System SecurityAllCommerce is fully capable of taking advantage of the secure encryption schemes offered by secure Web servers.You can offer secure online ordering and processing of data by utilizing an SSL-enabled Web server such as IBM httpd or Stronghold. 2.7.1 BlowfishAllCommerce utilizes the Blowfish algorithm for password, gift certificate, and other internal data encryption. This 64-bit, variable-length key designed by Bruce Schneier is gaining wide acceptance as a very strong encryption algorithm. It is unlicensed and freely available.For more information on Blowfish visit: www.counterpane.com/blowfish.html 2.8 Upgrading from 0.7.x to 0.9.x or 1.0.xThere is no upgrade for this version available at this time.2.9 Server Farms and Cluster OperationThis release of AllCommerce supports only one server farm operation. |