diff --git a/build/tidy/runtidy b/build/tidy/runtidy new file mode 100755 index 0000000000..a36b211035 --- /dev/null +++ b/build/tidy/runtidy @@ -0,0 +1,6 @@ +#!/bin/bash +# Run from docs folder +for i in `ls *.html` +do + tidy -m -config ../build/tidy/tidy.conf $i +done diff --git a/build/tidy/tidy.conf b/build/tidy/tidy.conf new file mode 100644 index 0000000000..503c428849 --- /dev/null +++ b/build/tidy/tidy.conf @@ -0,0 +1,5 @@ +new-blocklevel-tags: section +indent: auto +indent-spaces: 2 +wrap: 110 +preserve-entities: yes diff --git a/docs/0.about_zen_cart.html b/docs/0.about_zen_cart.html index 9cfe37da0c..84dafec45e 100644 --- a/docs/0.about_zen_cart.html +++ b/docs/0.about_zen_cart.html @@ -1,249 +1,357 @@ + * @license https://www.zen-cart.com/license/2_0.txt GNU Public License v2.0 + * @version $Id: 0.about_zen_cart.html Modified in v2.0 $ + */ + //--> + - About Zen Cart - - - - - - - - - - - + + + About Zen Cart + + + + + + + + + + + + -
- - - -
-

Welcome to Zen Cart®

-
- Dear Zen Cart® User, -

- Zen Cart® is made available to you for your use, addition, changes, modification, etc. without charge, under Version 2 of the GNU General Public License. -

-

- While we do not charge for this software, donations are greatly appreciated, each time you install a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum and the continued development of this software for your online E-Commerce store. -

-

- Donations can be made on the Zen Cart® Team Page -

-

- We appreciate your support. -
- The Zen Cart® Team -

-
-
- -
-

What is Zen Cart®?

-

Designed for Online Merchants

-

- Zen Cart® truly is the art of E-Commerce; a free, user-friendly, open source shopping cart system. The software has been developed and kept updated by group of like-minded shop owners, programmers, designers, and consultants that think E-Commerce could be and should be done differently. -

-

- Some "solutions" seem to be complicated programming exercises instead of responding to users' needs, Zen Cart® puts merchant and shopper requirements first. -

-

- Similarly, other programs are nearly impossible to install and use without an IT degree, while Zen Cart® can be installed and setup by anyone with the most basic computer skills. -

-

- Others are so expensive. Not Zen Cart® ... it is FREE! -

-
-
-

Designed for Online Shoppers

-

- Zen Cart® is the first Open Source Ecommerce platform to attain PA-DSS certification. -

-

- Zen Cart® delivers the ultimate online shopping experience to your customers. Navigating through your merchandise offerings is a breeze with Zen Cart®. -

-

- The program allows you to draw attention to products such as "featured" and "specials" etc in addition to the traditional category/product navigation. -

-

- Once a product is added to the shopping cart, secure checkout is a simple 3-Step process including collecting address information, shipping selection (multiple shipping methods including real-time internet shipping quotes are built-in), payment selection (PayPal™ and AuthorizeNet™ are just two of the various included modules) and confirming the final order including taxes and discounts/coupons/sales/gift-certificates applied. -

-

- You are immediately notified of the order and your customer automatically receives an e-mail confirmation.

-

- The goals of Zen Cart® include: -

- In short, Zen Cart® is shopping cart software the way it should have been all along. -

-

- We simply want to deliver a fast and easy to use shopping cart program that is freely available to everyone under the GNU General Public License. -

-

- The Zen Cart® development team encourages feedback and contributions from the community and we invite open discussion about e-commerce solutions. -

-
-
-

Designed for Web Designers

-

- Zen Cart® gives web designers a robust and customizable electronic storefront that is easy to keep up-to-date with new features. It provides usable, intuitive and unobtrusive purchase flows right out of the box based on proven industry best-practices. -

-

- One of the secrets behind its power lies in our robust template system that "abstracts" the look-and-feel from the code and logic behind the scenes. This enables you to give clients a truly custom solution that integrates quickly and perfectly with their existing website design. -

-
-
-

Designed for Developers and Hosting Providers

-

- Developers are able to deploy cutting edge solutions based on modern standards and technologies in Zen Cart®. Combining PHP server-side technology with the ability to choose from multiple databases on the back end, Zen Cart® is flexible software that you can customize and modify to suit your needs. -

-
-
- ^^ Back to Top ^^ -
-
-

Zen Cart® Features

-

Power and Flexibility at your Fingertips

- -
-
- ^^ Back to Top ^^ -
-
-

Zen Cart® Requirements

- -

- While Zen Cart® can run on Windows/IIS servers, Linux/Apache servers are recommended for best results. -

-
-
-

Zen Cart® Support

-

- For additional help and support, visit the Zen Cart® FAQ and the Zen Cart® Support Forum. -

-
- -
-
-

- Welcome! We are sure you will enjoy the Zen Cart® Experience! -

-

- ^^ Back to Top ^^ -

-

- Zen Cart® is derived from: Copyright 2003 osCommerce -

- This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; -
- without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE -
- and is redistributable under Version 2 of the GNU General Public License. -

-

- O S I Certified -
- This software is OSI Certified Open Source Software. -
- OSI Certified is a certification mark of the Open Source Initiative. -

-

- Copyright 2003 - 2018 Zen Ventures, LLC -

- Zen Cart® -
- www.zen-cart.com -

-
-
- -
+
+ + +
+

Welcome to Zen Cart®

+ +
+ Dear Zen Cart® User, + +

Zen Cart® is made available to you for your use, addition, changes, modification, etc. without + charge, under Version 2 of the GNU General Public License.

+ +

While we do not charge for this software, donations are greatly appreciated, each time you install + a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum + and the continued development of this software for your online E-Commerce store.

+ +

Donations can be made on the Zen + Cart® Team Page

+ +

We appreciate your support.
+ The Zen Cart® Team

+
+
+ +
+

What is Zen Cart®?

+ +

Designed for Online Merchants

+ +

Zen Cart® truly is the art of E-Commerce; a free, user-friendly, open source shopping + cart system. The software has been developed and kept updated by group of like-minded shop owners, + programmers, designers, and consultants that think E-Commerce could be and should be done + differently.

+ +

Some "solutions" seem to be complicated programming exercises instead of responding to users' needs, + Zen Cart® puts merchant and shopper requirements first.

+ +

Similarly, other programs are nearly impossible to install and use without an IT degree, while Zen + Cart® can be installed and setup by anyone with the most basic computer skills.

+ +

Others are so expensive. Not Zen Cart® ... it is FREE!

+
+ +
+

Designed for Online Shoppers

+ +

Zen Cart® is the first Open Source Ecommerce platform to attain PA-DSS certification.

+ +

Zen Cart® delivers the ultimate online shopping experience to your customers. Navigating through + your merchandise offerings is a breeze with Zen Cart®.

+ +

The program allows you to draw attention to products such as "featured" and "specials" etc in + addition to the traditional category/product navigation.

+ +

Once a product is added to the shopping cart, secure checkout is a simple 3-Step process including + collecting address information, shipping selection (multiple shipping methods including real-time + internet shipping quotes are built-in), payment selection (PayPal™ and + AuthorizeNet™ are just two of the various included modules) and confirming the final order + including taxes and discounts/coupons/sales/gift-certificates applied.

+ +

You are immediately notified of the order and your customer automatically receives an e-mail + confirmation.

+ +

The goals of Zen Cart® include:

+ + In short, Zen Cart® is shopping cart software the way it should have been all along. + +

We simply want to deliver a fast and easy to use shopping cart program that is freely available to + everyone under the GNU General Public License.

+ +

The Zen Cart® development team encourages feedback and contributions from the community and we + invite open discussion about e-commerce solutions.

+
+ +
+

Designed for Web Designers

+ +

Zen Cart® gives web designers a robust and customizable electronic storefront that is easy to + keep up-to-date with new features. It provides usable, intuitive and unobtrusive purchase flows right + out of the box based on proven industry best-practices.

+ +

One of the secrets behind its power lies in our robust template system that "abstracts" the + look-and-feel from the code and logic behind the scenes. This enables you to give clients a truly + custom solution that integrates quickly and perfectly with their existing website design.

+
+ +
+

Designed for Developers and Hosting Providers

+ +

Developers are able to deploy cutting edge solutions based on modern standards and technologies in + Zen Cart®. Combining PHP server-side technology with the ability to choose from multiple databases + on the back end, Zen Cart® is flexible software that you can customize and modify to suit your + needs.

+
+ +
+ ^^ Back to Top ^^ +
+ +
+

Zen Cart® Features

+ +

Power and Flexibility at your Fingertips

+ + +
+ +
+ ^^ Back to Top ^^ +
+ +
+

Zen Cart® Requirements

+ + + +

While Zen Cart® can run on Windows/IIS servers, Linux/Apache servers are recommended for + best results.

+
+ +
+

Zen Cart® Support

+ +

For additional help and support, visit the Zen Cart® FAQ and the Zen + Cart® Support Forum.

+
+ +
+
+

Welcome! We are sure you will enjoy the Zen Cart® Experience!

+ +

^^ Back to Top ^^

+ +

Zen Cart® is derived from: Copyright 2003 osCommerce
+
+ This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
+ and is redistributable under Version 2 of the GNU General Public License.

+ +

O S I Certified
+ This software is OSI Certified Open Source Software.
+ OSI Certified is a certification mark of the Open Source Initiative.

+ +

Copyright 2003 - 2018 Zen Ventures, LLC
+
+ Zen Cart®
+ www.zen-cart.com

+
+
+
diff --git a/docs/1.readme_installation.html b/docs/1.readme_installation.html index 873e4a3057..688b70162d 100644 --- a/docs/1.readme_installation.html +++ b/docs/1.readme_installation.html @@ -1,4 +1,5 @@ + + - Installing Zen Cart - - - - - - - - - - - + + + Installing Zen Cart + + + + + + + + + + + - -
+ +
- -
-

Welcome to Zen Cart®

-
- Dear Zen Cart® User, -

- Zen Cart® is made available to you for your use, addition, changes, modification, etc. without charge, under Version 2 of the GNU General Public License. -

-

- While we do not charge for this software, donations are greatly appreciated, each time you install a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum and the continued development of this software for your online E-Commerce store. -

-

- Donations can be made on the Zen Cart® Team Page -

-

- We appreciate your support. -
- The Zen Cart® Team -

+ + -
- +
+ + +
+

Welcome to Zen Cart®

+ +
+ Dear Zen Cart® User, + +

Zen Cart® is made available to you for your use, addition, changes, modification, etc. without + charge, under Version 2 of the GNU General Public License.

+ +

While we do not charge for this software, donations are greatly appreciated, each time you install + a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum + and the continued development of this software for your online E-Commerce store.

+ +

Donations can be made on the Zen + Cart® Team Page

+ +

We appreciate your support.
+ The Zen Cart® Team

+
+
+
-
-

Zen Cart® Requirements

-
    -
  • For up-to-date requirements, see: Zen Cart® Server Requirements
  • -
  • Apache must be configured with AllowOverride set to either "All" or at least both "Limit" and "Indexes" parameters, and preferably the "Options" parameter as well.
  • -
  • PHP must be configured to support CURL with OpenSSL
  • -
-

- While Zen Cart® can run on Windows/IIS servers, Linux/Apache servers are recommended for best results. -

-
-
- +
+

Zen Cart® Requirements

+ + + +

While Zen Cart® can run on Windows/IIS servers, Linux/Apache servers are recommended for + best results.

+
+ +
-
-

Installing for PA-DSS Compliance

-

- For installation instructions related to PA-DSS Compliance, see the Implementation Guide in your /docs/ folder. -

-
- -
-

Getting Started

-

The Basics

-

- You have downloaded the Zen Cart® software for an online shopping cart. -

-

- Since you're reading this file, you have likely already unzipped the Zen Cart® distribution file and its contents into a folder on your personal computer. If for some reason you have not already done so, unzip the files to your PC now, retaining the file structure within the zip file. -

-

- This is a basic guide for new installations of Zen Cart®. If you already have Zen Cart® installed and wish to upgrade from a previous version, please see the Upgrade Instructions and the What's New documentation. -

-

Preinstallation Questions

-
    -
  1. - Do you have a domain? -
  2. -
      -
    • - If No, stop ... see our Compatible Hosting list and find a fast, reliable web hosting provider who can help you register your own personal domain as well as provide for your hosting needs that meet the Zen Cart® software requirements. -
    • -
    -
  3. - Do you have reliable FTP software? -
  4. -
      -
    • - If No, stop ... you need to obtain a reliable FTP software package such as FileZilla (free), FlashFXP or another FTP software program to transfer files back and forth from your computer to your webserver. -
    • -
    • -
        - NOTES: -
      1. - "Webserver" is the computer on the internet where you have your domain hosted (See Item 1) -
      2. -
      3. - - Many users have had timeout and other problems when using programs like SmartFTP and CuteFTP. We recommend that you do NOT use these problematic programs. - -
      4. -
      5. - If your web hosting provider provides an FTP program that runs inside your browser, we recommend that you do NOT use that for uploading large amounts of files such as a fresh install of Zen Cart. Those are okay for single-file uploads, but unreliable for several files at once. -
      6. -
      -
    • -
    -
  5. - Do you have a good Text Editor? -
  6. -
      -
    • - If No, stop ... you will need a good Text Editing software such as UltraEdit, Notepad++ (free), CrimsonEditor (free), BBedit(Mac), Kedit (linux), or some other type of Text Editor for modifying the files in Zen Cart®. -
    • -
    • -
        - NOTES: -
      1. - - Do NOT use CPanel for editing files, nor MS Word or other software designed for fancy writing ... you want a nice clean Text Editor. - -
      2. -
      3. - You can use the Windows Notepad... but this is limited in capabilities and the size of files that it can open and often can cause more harm than good. -
      4. -
      -
    • -
    -
  7. - Do you have access to your webhosting control panel to create a MySQL database and user? -
  8. -
      -
    • - BEFORE YOU PROCEED, make sure you have access to a MySQL database, and username/password to that database. You may need to create the database using your webhosting control panel. Contact your web hosting provider for assistance. -
    • -
    • -
        - NOTES: -
      1. - Zen Cart® cannot create the database for you. -
      2. -
      3. - You need the following permissions on your MySQL user: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, INDEX, DROP. -
      4. -
      5. - On an hSphere host, this would be "dba" access, or at least read/write. -
      6. -
      -
    • -
    -
- If you have answered "Yes" to ALL four questions, you are ready to go on. -
- -
-

Upload the Zen Cart® Fileset

-

How do I Upload Files?

-

- Using FTP software, upload the whole Zen Cart® fileset into a directory on your server. Example: /catalog/ -

-

- We will use "/catalog/" as an example here. You can choose "no" foldername, or something else if you prefer, such as "/zencart", or "/store/" etc -

-

What Folder do I Upload Into?

-

- Each web hosting provider has their own preference in naming folders running a website. -

-

- You can have many files that do not even get shown to the public. The ones that are available for access via a browser are usually in a folder called something like: -

-

- /home/YOURNAME/public_html -
- or - -
/var/www/YOURNAME/httpdocs -
- or - -
/usr/accounts/a/b/YOURNAME/httpd -
- or - -
- etc, etc, etc - -

-

- Basically, in your FTP software, look for a "www" or "public_html" or "htdocs" or "httpdocs" or "wwwroot" folder. These are the common folder names for what is referred to as the "webroot", which is where all website content is served from. -

-

- Your Zen Cart files need to be under that folder. If they are not, then you will get "not found" errors ... because the content is not found! -

-

- If it is unclear where the publicly accessible files are to be uploaded, ask your web hosting provider for assistance. -

-
- -
-

Creating Configure.php Files

-
    -
  1. - Two files need to be created on the server. These are the configure.php files that identify the settings of your particular server and the location of the files that you just loaded. After they have been created, you will then need to change the permissions on these files. -
      -
    1. - Changing permissions can be done via your FTP program with the chmod feature. -
    2. -
    3. - Usually right clicking on a directory or filename will open a menu with this option (perhaps under "Properties") -
    4. -
    -
  2. -
  3. - On the server locate the file: /catalog/includes/dist-configure.php -
      -
    • - Rename this file to configure.php and change the permissions to 777 (read-write-execute for all) -
    • -
    -
  4. -
  5. - Next, on the server locate the file: /catalog/admin/includes/dist-configure.php -
      -
    • - Rename this file to configure.php and change the permissions to 777 (read-write-execute for all) -
    • -
    -
  6. +
    +

    Installing for PA-DSS Compliance

    + +

    For installation instructions related to PA-DSS Compliance, see the Implementation Guide in your + /docs/ folder.

    +
    + +
    +

    Getting Started

    + +

    The Basics

    + +

    You have downloaded the Zen Cart® software for an online shopping cart.

    + +

    Since you're reading this file, you have likely already unzipped the Zen Cart® distribution file + and its contents into a folder on your personal computer. If for some reason you have not already + done so, unzip the files to your PC now, retaining the file structure within the zip file.

    + +

    This is a basic guide for new installations of Zen Cart®. If you already have Zen Cart® + installed and wish to upgrade from a previous version, please see the Upgrade Instructions and the What's New documentation.

    + +

    Preinstallation Questions

    + +
      +
    1. + Do you have a domain? + +
        +
      • If No, stop ... see our Compatible Hosting list and find a fast, reliable web hosting provider who can + help you register your own personal domain as well as provide for your hosting needs that meet + the Zen Cart® software requirements.
      • +
      +
    2. + +
    3. + Do you have reliable FTP software? + +
        +
      • If No, stop ... you need to obtain a reliable FTP software package such as FileZilla (free), FlashFXP or another FTP software program to + transfer files back and forth from your computer to your webserver.
      • + +
      • +
          +
        1. NOTES:
        2. + +
        3. "Webserver" is the computer on the internet where you have your domain hosted (See Item + 1)
        4. + +
        5. Many users have had timeout and other problems when using + programs like SmartFTP and CuteFTP. We recommend that you do NOT use these + problematic programs.
        6. + +
        7. If your web hosting provider provides an FTP program that runs inside your browser, we + recommend that you do NOT use that for uploading large amounts of files such as a fresh + install of Zen Cart. Those are okay for single-file uploads, but unreliable for several + files at once.
        8. +
        +
      • +
      +
    4. + +
    5. + Do you have a good Text Editor? + +
        +
      • If No, stop ... you will need a good Text Editing software such as UltraEdit, Notepad++ (free), CrimsonEditor (free), BBedit(Mac), Kedit (linux), or some other type + of Text Editor for modifying the files in Zen Cart®.
      • + +
      • +
          +
        1. NOTES:
        2. + +
        3. Do NOT use CPanel for editing files, nor MS Word or + other software designed for fancy writing ... you want a nice clean Text + Editor.
        4. + +
        5. You can use the Windows Notepad... but this is limited in capabilities and the size of + files that it can open and often can cause more harm than good.
        6. +
        +
      • +
      +
    6. + +
    7. + Do you have access to your webhosting control panel to create a MySQL database and user? + +
        +
      • BEFORE YOU PROCEED, make sure you have access to a MySQL database, and username/password to + that database. You may need to create the database using your webhosting control panel. Contact + your web hosting provider for assistance.
      • + +
        1. - NOTES FOR IIS USERS: -
        2. - If using IIS for Windows hosting, the "chmod 777" idea for permissions settings is likely foreign to you. In IIS, under Windows, you need to right-click on the file (or folders in the next section below), and choose "Properties". -
        3. -
        4. - Then under the Security tab, ensure that the"Internet Guest Account", identified usually as: MACHINE_NAME\IUSR_MACHINE_NAME ... has at least "read" and "write" privileges ... likely best to give "modify" as well. -
        5. -
        6. - This should be done on each file/folder indicated. -
        7. -
        8. - If the IUSR_MACHINE_NAME account is not listed, click "Add" and add that account from the list, and then set the required permissions. -
        9. -
        10. - "_MACHINE_NAME" above refers to the "machine name" or "computer name" configured by the server administrator to "name" the server. -
        11. +
        12. NOTES:
        13. + +
        14. Zen Cart® cannot create the database for you.
        15. + +
        16. You need the following permissions on your MySQL user: SELECT, INSERT, UPDATE, DELETE, + CREATE, ALTER, INDEX, DROP.
        17. + +
        18. On an hSphere host, this would be "dba" access, or at least read/write.
        +
      • +
      +
    8. +
    If you have answered "Yes" to ALL four questions, you are ready to go on. +
    + +
    +

    Upload the Zen Cart® Fileset

    + +

    How do I Upload Files?

    + +

    Using FTP software, upload the whole Zen Cart® fileset into a directory on your server. + Example: /catalog/

    + +

    We will use "/catalog/" as an example here. You can choose "no" + foldername, or something else if you prefer, such as "/zencart", or + "/store/" etc

    + +

    What Folder do I Upload Into?

    + +

    Each web hosting provider has their own preference in naming folders running a website.

    + +

    You can have many files that do not even get shown to the public. The ones that are available for + access via a browser are usually in a folder called something like:

    + +

    /home/YOURNAME/public_html
    + - or -
    + /var/www/YOURNAME/httpdocs
    + - or -
    + /usr/accounts/a/b/YOURNAME/httpd
    + - or -
    + - etc, etc, etc -

    + +

    Basically, in your FTP software, look for a "www" or "public_html" or + "htdocs" or "httpdocs" or "wwwroot" folder. These are the common folder + names for what is referred to as the "webroot", which is where all website content is + served from.

    + +

    Your Zen Cart files need to be under that folder. If they are not, then you will get "not + found" errors ... because the content is not found!

    + +

    If it is unclear where the publicly accessible files are to be uploaded, ask your web hosting + provider for assistance.

    +
    + +
    +

    Creating Configure.php Files

    + +
      +
    1. Two files need to be created on the server. These are the configure.php files that identify the + settings of your particular server and the location of the files that you just loaded. After they + have been created, you will then need to change the permissions on these files. + +
        +
      1. Changing permissions can be done via your FTP program with the chmod feature.
      2. + +
      3. Usually right clicking on a directory or filename will open a menu with this option + (perhaps under "Properties")
      -
    - -
    -

    Setting Permissions

    - -
    -

    Main Folder Permissions

    -
      - Now, change the permissions on the following directories to 777 (read/write/execute): -
    • /catalog/cache
    • -
    • /catalog/images
    • -
    • /catalog/includes/languages/english/html_includes
    • -
    • /catalog/logs
    • -
    • /catalog/media
    • -
    • /catalog/pub
    • -
    • /catalog/admin/backups
    • -
    • /catalog/admin/images/graphs
    • -
    -
      - Open the /catalog/images directory and change ALL of the subdirectories and their subdirectories to 777 as well. For example (this is a partial list): -
    • /catalog/images/attributes
    • -
    • /catalog/images/dvd
    • -
    • /catalog/images/large
    • -
    • /catalog/images/large/dvd
    • -
    • /catalog/images/medium
    • -
    • /catalog/images/upload
    • -
    -
      -
    • - If you miss any of the images directories and subdirectories inside /images and try to use them later, you will get an error message that you cannot write to these directories. -
    • -
    -
    - -
    -

    Other Folder and File Permissions

    -
      - Depending on your webserver configuration, other folders and files can be set to: -
    • - Folders: CHMOD 755 -
        -
      • - "CHMOD" is a linux/unix term for setting/changing permission levels -
      • -
      -
    • -
    • - Files: CHMOD 644
      -
        -
      • - These are typically the defaults that your FTP program will use when uploading, so usually do not need to be set manually. -
      • -
      -
    • -
    -
    -
    - -
    -
    - ^^ Back to Top ^^ -
    -
- -
- -
-

Before Running the Installer

-

- The installer is fairly intelligent and should be able to automatically supply answers to the questions listed below. -

-

- You will, however, need to confirm that the auto-detected answers are, in fact, correct as on some servers they may differ. -

-

- You will need the following information for the installation: + + +

  • On the server locate the file: /catalog/includes/dist-configure.php +
      -
    • - The physical path to your new Zen Cart® directory -
      - Example: /home2/zencart/public_html/catalog -
    • -
    • - The Virtual HTTP Path (the URL to your domain and directory for your shop) -
      - Example: http://www.mydomain.com/catalog -
    • +
    • Rename this file to configure.php and change the permissions to 777 + (read-write-execute for all)
    -
  • - -
    -

    SSL Considerations

    -

    - A Secure Sockets Layer (SSL) is the standard security technology for establishing an encrypted link between a web server and a browser. -

    -

    - If you are installing onto a live webserver where you intend to process real transactions, you should plan on securing your customers' transaction data with SSL. -

    -

    - If you do not already have an SSL certificate, talk to your web hosting provider about your available options. You will need to enter your SSL details as below. In most cases they will be correct, unless you are using a "shared SSL" service. Your web hosting provider can give you the correct details. -

    + + +
  • Next, on the server locate the file: + /catalog/admin/includes/dist-configure.php +
      -
    • - The Virtual HTTPS Server (the secure URL to your domain) -
      - Example: https://www.mydomain.com -
        - If you have a shared certificate on a virtual server this may look like: -
      • - https://mydomain.secureservername.net/ -
      • - - or - -
      • - https://secure.sharedservername.net/~username -
      • -
      -
    • -
    • - The Virtual HTTPS Path (the secure URL to your domain and directory for your shop) -
      - Example: https://www.mydomain.com/catalog -
      - - or - -
      - https://secure.sharedservername.net/~username/catalog -
    • +
    • Rename this file to configure.php and change the permissions to 777 + (read-write-execute for all)
    -

    - If you are installing to a local PC or to a development server where you do not need to protect sensitive data, you can leave the SSL settings at their defaults, and when asked about enabling SSL later in the installation process, just leave it off if you are not on a live production server. -

    -
  • - -
    -
    - ^^ Back to Top ^^ -
    -
    - + +
      +
    1. NOTES FOR IIS USERS:
    2. + +
    3. If using IIS for Windows hosting, the "chmod 777" idea for permissions settings + is likely foreign to you. In IIS, under Windows, you need to right-click on the file (or + folders in the next section below), and choose + "Properties".
    4. + +
    5. Then under the Security tab, ensure that the"Internet Guest + Account", identified usually as: MACHINE_NAME\IUSR_MACHINE_NAME ... has at least + "read" and "write" privileges ... likely best to give "modify" as + well.
    6. + +
    7. This should be done on each file/folder indicated.
    8. + +
    9. If the IUSR_MACHINE_NAME account is not listed, click "Add" and add that account + from the list, and then set the required permissions.
    10. + +
    11. "_MACHINE_NAME" above refers to the "machine name" or "computer + name" configured by the server administrator to "name" the server.
    12. +
    + + +
    + +
    +

    Setting Permissions

    + +
    +

    Main Folder Permissions

    + + + + + + +
    + +
    +

    Other Folder and File Permissions

    + + +
    +
    +
    + +
    + ^^ Back to Top ^^ +
    + + +
    +
    +

    Before Running the Installer

    + +

    The installer is fairly intelligent and should be able to automatically supply answers to the + questions listed below.

    + +

    You will, however, need to confirm that the auto-detected answers are, in fact, correct as on some + servers they may differ.

    + +

    You will need the following information for the installation:

    + + +
    + +
    +

    SSL Considerations

    + +

    A Secure Sockets Layer (SSL) is the standard security technology for establishing an encrypted + link between a web server and a browser.

    + +

    If you are installing onto a live webserver where you intend to process real transactions, you + should plan on securing your customers' transaction data with SSL.

    + +

    If you do not already have an SSL certificate, talk to your web hosting provider about your + available options. You will need to enter your SSL details as below. In most cases they will be + correct, unless you are using a "shared SSL" service. Your web hosting provider can give you the + correct details.

    + + + +

    If you are installing to a local PC or to a development server where you do not need to protect + sensitive data, you can leave the SSL settings at their defaults, and when asked about enabling SSL + later in the installation process, just leave it off if you are not on a live production server.

    +
    +
    + +
    + ^^ Back to Top ^^ +
    +
    +
    -
    -

    Running the Installer

    - -
    -

    Starting the Installer

    -
      -
    • - In your browser, enter the URL to your new shop, and the Installer should automatically start. -
        -
      • - Example: http://www.mydomain.com/catalog -
        - - or - , to start the installer directly, -
        - http://www.mydomain.com/catalog/zc_install -
      • -
      -
    • -
    -
      - You will be presented with a "Welcome to Zen Cart®" page, explaining the features of Zen Cart®. -
    • - If you now see a list of filenames and directories, you should speak to your web hosting provider about how to setup your server to auto-detect PHP filename extensions -
    • -
    -

    - Clicking on Continue takes you to the license screen where you are asked to read and confirm acceptance of the GPL licensing agreement. -

    -
    - -
    -

    System Inspection Step

    -
    -

    - The Installer examines your server for compliance with technical requirements for running Zen Cart®, presenting you with several items you may need or want to address with your host. -

    -

    - Anything marked in red or with an "X" must be addressed before the installer can continue. Things marked with an orange or yellow "caution" symbol are simply warnings that may or may not apply to your setup now. The image folders and others as described earlier in this document are also noted. -

    -

    - If you make changes to your server, you can click Re-Check or press F5 in your browser to refresh the display and reflect the changes you've made before proceeding. -

    -

    - If a previous version of Zen Cart® is found on your server, the installer will attempt to determine the database patch level and display that on the screen as well. In this case, an "upgrade" button will display at the bottom of the screen offering you the ability to upgrade if needed. -

    -

    - See the Upgrade Instructions. -

    -
      - Once you are satisfied that the "pre-flight-check" inspection is OK for your needs (ideally, all green check-marks), you may click the "Install" button at the bottom of the screen. -
    • - If you receive any of the following error messages, go through the above steps to make sure you have not left anything out. All error messages have context-sensitive help via a popup window if you click on the "more info..." links supplied. -
    • -
    -
    -
    -
      - Warning: Problems Found -
    • - - /includes/configure.php does not exist.  more info... - -
    • -
    • - - /admin/includes/configure.php does not exist.  more info... - -
    • -
    -
    -
    - -
    -

    Database Setup Step

    -
    -

    - On the next screen, you are asked for Database Information about your MySQL database, username and password. These can be obtained from your cPanel or equivalent control screen provided by your host. -

    -

    - If you do not have a clean MySQL database setup with a username and password, you will need to create one. -

    -
      - Contact your web hosting provider if you need assistance in creating a MySQL database table and/or username and password. -
    • - You need to have your database and userID created before the Zen Cart® installer can continue past this screen. -
    • -
    -
    -
    -
      - Other information on this screen: -
    • - At this time, MySQL is the primary operational database type. -
      - Future releases may support other database types. -
    • -
    • - We recommend that you store your Database Sessions in your database for security purposes. -
    • -
    -
    -
    - -
    -

    System Setup Step

    -

    - On the System Setup page you will need to complete the information we described in "Before Running the Installer" earlier in this document. -

    -

    - Indicate if you want to Enable SSL (the secure pages where required, in Login, Checkout, and optionally Admin areas) on your server. -

    -

    - If you do not have an SSL certificate yet, do not enable this feature now. It can be changed at a later date. -

    -

    - See the Enabling SSL Tutorial for detailed instructions. -

    -
    - -
    -

    Store Setup Step

    -
    -

    - Now, complete the Store Information about your Shop.
    -

    -
    -
    - Demo Data -

    - If you would like to install the demo data, select "Yes". -

    -
    -
    -

    - We recommend that you install the demo data to familiarize yourself with many of the examples created that explain and demonstrate the vast number of features available in Zen Cart®. -

    -
      - You may also decide later, to set up a test site with the demo data AND a separate working site for your live data so that you have the ability to refer back to the demo data for help and to see examples of a feature. -
    • - Except for "demo data", all of the information here can be (re)configured later in the Admin area of your shop. -
    • -
    -

    - After you click Save Store Settings, there will a brief delay as the database tables are created and the demo data is optionally loaded. -

    -
    -
    - -
    -

    Admin Setup Step

    -
      -
    • - Now, complete the Admin Information to set your Login name, Admin email address and password. -
        -
      1. - Both the login name and password are case sensitive. -
      2. -
      3. - Admin passwords must contain letters and numbers and be a minimum of 7 characters. -
      4. -
      5. - The admin password you enter here IS ONLY TEMPORARY, and will be expired on first use, for your protection. -
      6. -
      -
    • -
    -
    -
    - -
    -
    - ^^ Back to Top ^^ -
    -
    - -
    -
    -

    Post Installation

    -

    Delete the "zc_install" Directory

    -

    - You must DELETE the /catalog/zc_install directory so that nobody can misuse the scripts in there to wipe out your store. -

    -

    NOTE: if you're using Nginx, do the following before deleting zc_install since the files are in your zc_install directory!

    -

    Update Nginx Directives if Required (not relevant on Apache Web Server)

    +
    +

    Running the Installer

    + +
    +

    Starting the Installer

    + +
      +
    • In your browser, enter the URL to your new shop, and the Installer + should automatically start. + +
        +
      • Example: http://www.mydomain.com/catalog
        + - or - , to start the installer directly,
        + http://www.mydomain.com/catalog/zc_install
      • +
      +
    • +
    + +
      +
    • You will be presented with a "Welcome to Zen Cart®" + page, explaining the features of Zen Cart®.
    • + +
    • If you now see a list of filenames and directories, you + should speak to your web hosting provider about how to setup your server to auto-detect PHP + filename extensions
    • +
    + +

    Clicking on Continue takes you to the license screen where you are asked to read and + confirm acceptance of the GPL licensing agreement.

    +
    + +
    +

    System Inspection Step

    + +
    +

    The Installer examines your server for compliance with technical requirements for running Zen + Cart®, presenting you with several items you may need or want to address with your host.

    + +

    Anything marked in red or with an "X" must be addressed before the installer can + continue. Things marked with an orange or yellow "caution" symbol are simply warnings + that may or may not apply to your setup now. The image folders and others as described earlier in + this document are also noted.

    + +

    If you make changes to your server, you can click Re-Check or press F5 in your + browser to refresh the display and reflect the changes you've made before proceeding.

    + +

    If a previous version of Zen Cart® is found on your server, the installer will attempt to + determine the database patch level and display that on the screen as well. In this case, an + "upgrade" button will display at the bottom of the screen offering you the + ability to upgrade if needed.

    + +

    See the Upgrade Instructions.

    +
      -
    • - The Zen Cart® Installer includes base directives equivalent to ".htaccess" rules to help secure your store. -
        -
      • - These should be activated and Nginx reloaded before going live with the store -
      • -
      -
    • +
    • Once you are satisfied that the "pre-flight-check" + inspection is OK for your needs (ideally, all green check-marks), you may click the + "Install" button at the bottom of the screen.
    • + +
    • If you receive any of the following error messages, go + through the above steps to make sure you have not left anything out. All error messages have + context-sensitive help via a popup window if you click on the "more info..." links + supplied.
    -
    -
    -
    - ^^ Back to Top ^^ -
    -
    - -
    -
    -

    Next Steps

    -

    - To set up your online store, see the Zen Cart® Wiki entry outlining a Basic Checklist -

    +
    + +
    + +
    + + +
    +

    Database Setup Step

    + +
    +

    On the next screen, you are asked for Database Information about your MySQL database, username + and password. These can be obtained from your cPanel or equivalent control screen provided by + your host.

    + +

    If you do not have a clean MySQL database setup with a username and password, you will need to + create one.

    +
      - Familiarize yourself with the Zen Cart® Developers Toolkit -
    • - Located in your store Admin area, under "Tools". -
    • -
    • - This will help you locate almost anything you want to customize in your Zen Cart® store! -
    • +
    • Contact your web hosting provider if you need assistance in + creating a MySQL database table and/or username and password.
    • + +
    • You need to have your database and userID created + before the Zen Cart® installer can continue past this screen.
    • +
    +
    + +
    +
      +
    • Other information on this screen:
    • + +
    • At this time, MySQL is the primary operational database type.
      + Future releases may support other database types.
    • + +
    • We recommend that you store your Database Sessions in your database for security + purposes.
    +
    +
    + +
    +

    System Setup Step

    + +

    On the System Setup page you will need to complete the information we described in "Before + Running the Installer" earlier in this document.

    + +

    Indicate if you want to Enable SSL (the secure pages where required, in Login, Checkout, and + optionally Admin areas) on your server.

    + +

    If you do not have an SSL certificate yet, do not enable this feature now. It can be + changed at a later date.

    + +

    See the Enabling SSL + Tutorial for detailed instructions.

    +
    + +
    +

    Store Setup Step

    + +
    +

    Now, complete the Store Information about your Shop.

    +
    + +
    + Demo Data + +

    If you would like to install the demo data, select "Yes".

    +
    + +
    +

    We recommend that you install the demo data to familiarize yourself with many of the examples + created that explain and demonstrate the vast number of features available in Zen Cart®.

    +
      - Review the Zen Cart® Site Security Recommendations to be sure your site is not vulnerable to hackers -
    • - The most up-to-date version of the security recommendations can be found on the Zen Cart® Wiki -
    • +
    • You may also decide later, to set up a test site with the demo + data AND a separate working site for your live data so that you have the ability to refer back + to the demo data for help and to see examples of a feature.
    • + +
    • Except for "demo data", all of the + information here can be (re)configured later in the Admin area of your shop.
    -
    -
    -
    - ^^ Back to Top ^^ -
    -
    - + +

    After you click Save Store Settings, there will a brief delay as the database tables + are created and the demo data is optionally loaded.

    + + + +
    +

    Admin Setup Step

    + + +
    + +
    + +
    + ^^ Back to Top ^^ +
    + + +
    +
    +

    Post Installation

    + +

    Delete the "zc_install" Directory

    + +

    You must DELETE the /catalog/zc_install directory so that nobody can misuse the scripts + in there to wipe out your store.

    + +

    NOTE: if you're using Nginx, do the following before deleting zc_install since the files are in + your zc_install directory!

    + +

    Update Nginx Directives if Required (not relevant on Apache Web Server)

    + + +

    + +
    + ^^ Back to Top ^^ +
    +
    + +
    +
    +

    Next Steps

    + +

    To set up your online store, see the Zen Cart® Wiki entry outlining a Basic + Checklist

    + + + + +

    + +
    + ^^ Back to Top ^^ +
    +
    +
    -
    -

    Help and Support

    -

    - For additional help and support, visit the Zen Cart® FAQ and the Zen Cart® Support Forum. -

    -
    -
    - +
    +

    Help and Support

    + +

    For additional help and support, visit the Zen Cart® FAQ and the Zen Cart® Support Forum.

    +
    + +
    -
    -

    - Zen Cart® is derived from: Copyright 2003 osCommerce -

    - This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; -
    - without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE -
    - and is redistributable under Version 2 of the GNU General Public License. -

    -

    - O S I Certified -
    - This software is OSI Certified Open Source Software. -
    - OSI Certified is a certification mark of the Open Source Initiative. -

    -

    - Copyright 2003 - 2018 Zen Ventures, LLC -

    - Zen Cart® -
    - www.zen-cart.com -

    -
    -
    - - +
    +

    Zen Cart® is derived from: Copyright 2003 osCommerce
    +
    + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
    + without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
    + and is redistributable under Version 2 of the GNU General Public License.

    + +

    O S I Certified
    + This software is OSI Certified Open Source Software.
    + OSI Certified is a certification mark of the Open Source Initiative.

    + +

    Copyright 2003 - 2018 Zen Ventures, LLC
    +
    + Zen Cart®
    + www.zen-cart.com

    +
    + + diff --git a/docs/2.readme_how_to_upgrade.html b/docs/2.readme_how_to_upgrade.html index 074ab731d0..6f104b34ca 100644 --- a/docs/2.readme_how_to_upgrade.html +++ b/docs/2.readme_how_to_upgrade.html @@ -1,528 +1,545 @@ + + * @license https://www.zen-cart.com/license/2_0.txt GNU Public License v2.0 + * @version $Id: 2.readme_how_to_upgrade.html Modified in v2.0 $ + */ + //--> + - Upgrading Zen Cart - - - - - - - - - - - + + + Upgrading Zen Cart + + + + + + + + + + + + -
    - - - -
    -

    Welcome to Zen Cart®

    -
    - Dear Zen Cart® User, -

    - Zen Cart® is made available to you for your use, addition, changes, modification, etc. without charge, under Version 2 of the GNU General Public License. -

    -

    - While we do not charge for this software, donations are greatly appreciated, each time you install a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum and the continued development of this software for your online E-Commerce store. -

    -

    - Donations can be made on the Zen Cart® Team Page -

    -

    - We appreciate your support. -
    - The Zen Cart® Team -

    -
    -
    - -
    -
    -

    Zen Cart® Requirements

    -
      -
    • For up-to-date requirements, see: Zen Cart® Server Requirements
    • -
    • Apache must be configured with AllowOverride set to either "All" or at least both "Limit" and "Indexes" parameters, and preferably the "Options" parameter as well.
    • -
    • PHP must be configured to support CURL with OpenSSL
    • -
    -

    - While Zen Cart® can run on Windows/IIS servers, Linux/Apache servers are recommended for best results. -

    -
    -
    - -
    -

    Before You Start

    -
    -

    Getting Started

    -

    - This is a basic guide to upgrading Zen Cart®. If you have not yet installed Zen Cart, please see the 1.readme_installation.html file for installation instructions. -

    -
      - To upgrade Zen Cart®, you will need the same basic tools you used to install and customize it in the first place: -
    • - An FTP program -
    • -
    • - A text editor friendly to HTML/PHP code -
    • -
    • - phpMyAdmin or equivalent access to your MySQL database -
    • -
    • - Your Control Panel for managing your webspace -
    • -
    -

    - Additionally, you will find that a file comparison tool such as WinMerge, Beyond Compare or ExamDiff (Linux) to be very helpful. (There is also BBedit for the Mac.) -

    -
    - -
    -

    Online Documentation

    -

    - You can find the lastest upgrade instructions, and alternate ways of upgrading, by visiting: www.zen-cart.com/upgrade. -

    -
    - -
    -

    Payment and Shipping Modules

    -

    - You will need to re-install all your active payment and shipping modules as part of your upgrade: -

    -
      -
    • - BEFORE UPGRADING, Take note of the login IDs, transaction keys, email addresses and other settings already configured in EACH of your Payment and Shipping modules. -
        -
      • - You will need this information so you can re-enter it after re-installing the modules. -
      • -
      -
    • -
    • - Remove each module by clicking the "Remove" button for each one. -
      -
    • -
    • - AFTER UPGRADING, Install each module (that you are using) in Admin->Modules->Payment and Admin->Modules->Shipping in order to take advantage of the bugfixes and feature improvements in each module. -
        -
      1. - You do NOT need to do this with modules you are NOT using. -
      2. -
      3. - If you are no longer using a certain module anymore and it does not have a red dot next to it, click the "Remove" button to save on processing performance. -
      4. -
      -
    • -
    • - REMEMBER: Re-enter all your configuration settings for each module as you go along. -
        -
      • - BE SURE TO TEST each one before you take your store live again, to make sure you've got all your settings entered correctly. -
      • -
      -
    • -
    -
    -
    -
    - ^^ Back to Top ^^ -
    -
    - -
    -

    The 3-Step Zen Cart® Upgrade

    - -
    -

    Introduction

    -

    - Upgrading follows three easy steps. Take your time going through each stage carefully and methodically. -

    -

    - Do not rush the process and always ensure you made backups before you attempt an upgrade. -

    -

    - Spend time getting familiar with the demo data to become comfortable with new features of the new release. -

    -
    - -
    -

    Step 1: Zen Cart® Upgrade Preparation

    - -
    -

    Backup Current Zen Cart® Installation

    -
      -
    • - Make a list of any add-ons you have installed, for later reference. -
      -
    • -
    • - Create a backup of your current Zen Cart® installation on your Local PC -
        -
      1. - Perhaps call this folder "zen_backup" -
      2. -
      3. - Make a full backup of your database (dump to SQL file). Store this file on your PC for later reference. -
      4. -
      5. - Make a full backup of your site files (ftp to your PC and zip it up for safe-keeping). -
      6. -
      -
    • -
    -
    - -
    -

    Try New Zen Cart® Version

    -
      -
    • - Download and unzip the latest Zen Cart® version to your Local PC -
      -
    • -
    • - Upload this fileset to your website under a "demo" folder -
        -
      1. - Install this new version into a separate database and include the Demo products. -
      2. -
      3. - This is just for a place for you to play with the new version and get used to its new features. -
      4. -
      5. - This can be deleted after conversion is complete. -
      6. -
      -
    • -
    • - Study the new features and any documented changes to the template structure as well as the "changelog". -
        -
      1. - Use the demo products in the demo shop as examples. -
      2. -
      3. - See also the supporting documentation provided with the new release. -
      4. -
      -
    • -
    -
    - -
    -

    Determine Customizations and Edits

    -
      -
    • - Download and unzip a copy of the Zen Cart® version you originally installed or last upgraded to. -
        -
      1. - Place in a separate working folder on your Local PC (perhaps "zen_orig"). -
      2. -
      3. - This should be a "vanilla" version without any changes or modifications. - -
      4. -
      -
    • -
    • - Run a tool like WinMerge to compare the files in "zen_orig" against those in "zen_backup" to determine the customization details/differences between your installation and the "vanilla" Zen Cart version. -
        -
      1. - Make a list of all the files that are "different". -
      2. -
      3. - In WinMerge, double-click on each file and note what the differences are. -
          -
        • - If the differences are just language defines for display text, those will be simple to carry forward. -
        • -
        • - If the differences are actual programming/code differences, you will need to make detailed notes in order to carry over those changes to the new new new version. -
        • -
        -
      4. -
      -
    • -
    • - Any mods/add-ons installed may contain programming changes not compatible with a new release. -
        -
      1. - Your list of add-ons may help you narrow down the source of any differences you find between versions. -
      2. -
      3. - You may have to download the add-on again to take a look at the readme or code contained in it. -
      4. -
      5. - You may have to contact the author to ask for an updated version. -
      6. -
      -
    • -
    • - As you make a list of changes, you may want to move things into the Zen Cart® template override system - -
    • -
    -
    - -
    -

    Personalize Zen Cart® Upgrade

    -
      -
    • - Create another copy of the latest Zen Cart® version on your Local PC. -
        -
      • - Place in a 3rd directory (perhaps "zen_new"), separate from the other two folders compared above. -
      • -
      -
    • -
    • - Using the list of files you made earlier, go through each "changed" file, and make your changes from the old version into the new version. -
        -
      1. - Simple language edits will be just a matter of copy-and-paste. -
      2. -
      3. - Programming changes to core components will be more difficult and require significant testing. -
      4. -
      -
    • -
    • - You may find WinMerge handy at this stage as well -
        -
      1. - However, you may find many extra differences that may not be related to your own customizations, or that may conflict. -
      2. -
      3. - Be careful making changes to program code. -
      4. -
      -
    • -
    • - There may be several changes to be made to files previously overridden using the template overrides system -
        - -
      1. - Compare files from /includes/templates/MYTEMPLATE/* to /includes/template/template_default/*. -
      2. -
      3. - Also with language file overrides, sideboxes, etc -
      4. -
      -
    • -
    -
    -
    - -
    -

    Step 2: Zen Cart® Upgrade Testing

    -
    -
      -
    • - Make a NEW database to install the new version of Zen Cart® into. -
        -
      1. - Use your hosting control panel or phpMyAdmin to do this. -
      2. -
      3. - If the last backup you made of your data is older than the last order that might have been processed or customer registration, make a fresh database backup. -
      4. -
      5. - Restore your database from the backup in Step 1 into the new database just created. -
      6. -
      -
    • -
    • - Edit the "/zen_new/includes/configure.php" file -
        -
      1. - Ensure that your DATABASE_NAME matches your NEW database. -
      2. -
      3. - Also verify database username and password in case that information has changed. -
      4. -
      5. - Save this file, and be sure to upload it as part of the next step. -
      6. -
      -
    • -
    • - Upload the files from your modified "new version" (created in Personalize Upgrade) to your server -
        -
      1. - Place in an alternate folder (perhaps called "/store_new") -
      2. -
      3. - Ensure that you have uploaded the "/zen_new/zc_install" folder to your server. -
      4. -
      5. - If your /zen_new folder does not have the "/includes/configure.php"  file, copy this from the "zen_backup" folder. -
      6. -
      -
    • -
    • - Navigate to /store_new/zc_install/index.php using your browser -
        -
      1. - Choose "Database Upgrade" when prompted. -
      2. -
      3. - Do not select "Install", or you will overwrite your database. -
      4. -
      5. - If "Upgrade" is not offered, then the installer was unable to connect to your database to confirm what version its structure is at. -
      6. -
      7. - Check your configure.php settings. -
      8. -
      -
    • -
    • - Install each module in Admin->Modules->Payment and Admin->Modules->Shipping. -
        -
      1. - You do NOT need to do this with modules you are NOT using. -
      2. -
      3. - If you are no longer using a certain module and it does not have a red dot next to it, click the "Remove" button to save on processing performance. -
      4. -
      -
    • -
    • - Test your customizations. -
        -
      1. - Compare with the test/demo install performed earlier. -
      2. -
      3. - Edit as needed. -
      4. -
      -
    • -
    -
    -
    - -
    -

    Step 3: Zen Cart® Upgrade Execution

    -
    -
      -
    • - When satisfied that all is OK, go live. -
      -
    • -
    • - If significant time has passed since you did your last backup, you may want to repeat the steps in this "Testing" section again, using a fresh backup from your live shop. -
        -
      • - You do not need to re-upload files again ... simply do the database restore, and run the installer to do the database upgrade again. -
      • -
      -
    • -
    • - Put your shop into "Down for Maintenance" mode in the admin area. -
        -
      • - Be sure to add your IP address to the list of allowed addresses to get into the site for previewing. -
      • -
      -
    • -
    • - Rename the existing Zen Cart® folder (perhaps "store") on your site to "store_old" -
      -
    • -
    • - Rename the "store_new" folder to "store" -
        -
      • - At this point the new version is live. -
      • -
      -
    • -
    • - Test it to be sure that things are operating as desired. -
        -
      • - If you have small problems to repair, turn "Down for maintenance" on and off again as necessary. -
      • -
      -
    • -
    -
    -
    -
    -
    - ^^ Back to Top ^^ -
    -
    - -
    -
    -

    Help and Support

    -

    - For additional help and support, visit the Zen Cart® FAQ and the Zen Cart® Support Forum. -

    -
    -
    - -
    -
    -

    - Zen Cart® is derived from: Copyright 2003 osCommerce -

    - This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; -
    - without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE -
    - and is redistributable under Version 2 of the GNU General Public License. -

    -

    - O S I Certified -
    - This software is OSI Certified Open Source Software. -
    - OSI Certified is a certification mark of the Open Source Initiative. -

    -

    - Copyright 2003 - 2018 Zen Ventures, LLC -

    - Zen Cart® -
    - www.zen-cart.com -

    -
    -
    - -
    +
    + + +
    +

    Welcome to Zen Cart®

    + +
    + Dear Zen Cart® User, + +

    Zen Cart® is made available to you for your use, addition, changes, modification, etc. without + charge, under Version 2 of the GNU General Public License.

    + +

    While we do not charge for this software, donations are greatly appreciated, each time you install + a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum + and the continued development of this software for your online E-Commerce store.

    + +

    Donations can be made on the Zen + Cart® Team Page

    + +

    We appreciate your support.
    + The Zen Cart® Team

    +
    +
    + +
    +
    +

    Zen Cart® Requirements

    + +
      +
    • For up-to-date requirements, see: Zen Cart® Server Requirements
    • + +
    • Apache must be configured with AllowOverride set to either "All" or at least both + "Limit" and "Indexes" parameters, and preferably the "Options" + parameter as well.
    • + +
    • PHP must be configured to support CURL with OpenSSL
    • +
    + +

    While Zen Cart® can run on Windows/IIS servers, Linux/Apache servers are recommended for + best results.

    +
    +
    + +
    +

    Before You Start

    + +
    +

    Getting Started

    + +

    This is a basic guide to upgrading Zen Cart®. If you have not yet installed Zen Cart, please + see the 1.readme_installation.html file for installation + instructions.

    + +
      +
    • To upgrade Zen Cart®, you will need the same basic tools you used + to install and customize it in the first place:
    • + +
    • An FTP program
    • + +
    • A text editor friendly to HTML/PHP code
    • + +
    • phpMyAdmin or equivalent access to your MySQL database
    • + +
    • Your Control Panel for managing your webspace
    • +
    + +

    Additionally, you will find that a file comparison tool such as WinMerge, Beyond + Compare or ExamDiff (Linux) to be very helpful. (There is also BBedit for the Mac.)

    +
    + +
    +

    Online Documentation

    + +

    You can find the lastest upgrade instructions, and alternate ways of upgrading, by visiting: + www.zen-cart.com/upgrade.

    +
    + +
    +

    Payment and Shipping Modules

    + +

    You will need to re-install all your active payment and shipping modules as + part of your upgrade:

    + +
      +
    • + BEFORE UPGRADING, Take note of the login IDs, transaction keys, email addresses and + other settings already configured in EACH of your Payment and Shipping modules. + +
        +
      • You will need this information so you can re-enter it + after re-installing the modules.
      • +
      +
    • + +
    • Remove each module by clicking the "Remove" button for each one. + +
        + +
      +
    • + +
    • + AFTER UPGRADING, Install each module (that you are using) in + Admin->Modules->Payment and Admin->Modules->Shipping in order to take advantage of + the bugfixes and feature improvements in each module. + +
        +
      1. You do NOT need to do this with modules you are NOT using.
      2. + +
      3. If you are no longer using a certain module anymore and it does not have a red dot next to + it, click the "Remove" button to save on processing performance.
      4. +
      +
    • + +
    • + REMEMBER: Re-enter all your configuration settings for each module as you go along. + +
        +
      • BE SURE TO TEST each one before you take your store + live again, to make sure you've got all your settings entered correctly.
      • +
      +
    • +
    +
    +
    + +
    + ^^ Back to Top ^^ +
    +
    + +
    +

    The 3-Step Zen Cart® Upgrade

    + +
    +

    Introduction

    + +

    Upgrading follows three easy steps. Take your time going through each stage carefully and + methodically.

    + +

    Do not rush the process and always ensure you made backups before you attempt an upgrade.

    + +

    Spend time getting familiar with the demo data to become comfortable with new features of the new + release.

    +
    + +
    +

    Step 1: Zen Cart® Upgrade Preparation

    + +
    +

    Backup Current Zen Cart® Installation

    + +
      +
    • Make a list of any add-ons you have installed, for later reference. + +
        + +
      +
    • + +
    • Create a backup of your current Zen Cart® installation on your + Local PC + +
        +
      1. Perhaps call this folder "zen_backup"
      2. + +
      3. Make a full backup of your database (dump to SQL file). Store this file on your PC for + later reference.
      4. + +
      5. Make a full backup of your site files (ftp to your PC and zip it up for + safe-keeping).
      6. +
      +
    • +
    +
    + +
    +

    Try New Zen Cart® Version

    + +
      +
    • Download and unzip the latest Zen Cart® version to your Local PC + +
        + +
      +
    • + +
    • Upload this fileset to your website under a "demo" folder + +
        +
      1. Install this new version into a separate database and include the Demo products.
      2. + +
      3. This is just for a place for you to play with the new version and get used to its new + features.
      4. + +
      5. This can be deleted after conversion is complete.
      6. +
      +
    • + +
    • Study the new features and any documented changes to the template + structure as well as the "changelog". + +
        +
      1. Use the demo products in the demo shop as examples.
      2. + +
      3. See also the supporting documentation provided with the new release.
      4. +
      +
    • +
    +
    + +
    +

    Determine Customizations and Edits

    + +
      +
    • Download and unzip a copy of the Zen Cart® version you + originally installed or last upgraded to. + +
        +
      1. Place in a separate working folder on your Local PC (perhaps "zen_orig").
      2. + +
      3. This should be a "vanilla" version without any changes or modifications. + + +
      4. +
      +
    • + +
    • Run a tool like WinMerge to compare the files in "zen_orig" against those in + "zen_backup" to determine the customization details/differences between your + installation and the "vanilla" Zen Cart version. + +
        +
      1. Make a list of all the files that are "different".
      2. + +
      3. In WinMerge, double-click on each file and note what the differences are. + +
          +
        • If the differences are just language defines for display text, those will be simple + to carry forward.
        • + +
        • If the differences are actual programming/code differences, you will need to make + detailed notes in order to carry over those changes to the new new new version.
        • +
        +
      4. +
      +
    • + +
    • Any mods/add-ons installed may contain programming changes not + compatible with a new release. + +
        +
      1. Your list of add-ons may help you narrow down the source of any differences you find + between versions.
      2. + +
      3. You may have to download the add-on again to take a look at the readme or code contained + in it.
      4. + +
      5. You may have to contact the author to ask for an updated version.
      6. +
      +
    • + +
    • As you make a list of changes, you may want to move things into the + Zen Cart® template override system + + +
    • +
    +
    + +
    +

    Personalize Zen Cart® Upgrade

    + +
      +
    • Create another copy of the latest Zen Cart® version on your Local + PC. + +
        +
      • Place in a 3rd directory (perhaps + "zen_new"), separate from the other two folders compared above.
      • +
      +
    • + +
    • Using the list of files you made earlier, go through each "changed" + file, and make your changes from the old version into the new version. + +
        +
      1. Simple language edits will be just a matter of copy-and-paste.
      2. + +
      3. Programming changes to core components will be more difficult and require significant + testing.
      4. +
      +
    • + +
    • You may find WinMerge handy at this stage as well + +
        +
      1. However, you may find many extra differences that may not be related to your own + customizations, or that may conflict.
      2. + +
      3. Be careful making changes to program code.
      4. +
      +
    • + +
    • There may be several changes to be made to files previously overridden + using the template overrides system + +
        +
      1. + +
      2. Compare files from /includes/templates/MYTEMPLATE/* to + /includes/template/template_default/*.
      3. + +
      4. Also with language file overrides, sideboxes, etc
      5. +
      +
      +
      + +
      +

      Step 2: Zen Cart® Upgrade Testing

      + +
      +
        +
      • Make a NEW database to install the new version of Zen Cart® into. + +
          +
        1. Use your hosting control panel or phpMyAdmin to do this.
        2. + +
        3. If the last backup you made of your data is older than the last order that might have + been processed or customer registration, make a fresh database backup.
        4. + +
        5. Restore your database from the backup in Step 1 into the new database just created.
        6. +
        +
      • + +
      • Edit the "/zen_new/includes/configure.php" file + +
          +
        1. Ensure that your DATABASE_NAME matches your NEW database.
        2. + +
        3. Also verify database username and password in case that information has changed.
        4. + +
        5. Save this file, and be sure to upload it as part of the next step.
        6. +
        +
      • + +
      • Upload the files from your modified "new version" (created in + Personalize Upgrade) to your server + +
          +
        1. Place in an alternate folder (perhaps called "/store_new")
        2. + +
        3. Ensure that you have uploaded the "/zen_new/zc_install" folder to your + server.
        4. + +
        5. If your /zen_new folder does not have the + "/includes/configure.php"  file, copy this from the + "zen_backup" folder.
        6. +
        +
      • + +
      • Navigate to /store_new/zc_install/index.php using your + browser + +
          +
        1. Choose "Database Upgrade" when prompted.
        2. + +
        3. Do not select "Install", or you will overwrite your database.
        4. + +
        5. If "Upgrade" is not offered, then the installer was unable to connect to your database to + confirm what version its structure is at.
        6. + +
        7. Check your configure.php settings.
        8. +
        +
      • + +
      • Install each module in Admin->Modules->Payment and + Admin->Modules->Shipping. + +
          +
        1. You do NOT need to do this with modules you are NOT using.
        2. + +
        3. If you are no longer using a certain module and it does not have a red dot next to it, + click the "Remove" button to save on processing performance.
        4. +
        +
      • + +
      • Test your customizations. + +
          +
        1. Compare with the test/demo install performed earlier.
        2. + +
        3. Edit as needed.
        4. +
        +
      • +
      +
      +
      + +
      +

      Step 3: Zen Cart® Upgrade Execution

      + +
      +
        +
      • When satisfied that all is OK, go live. + +
          + +
        +
      • + +
      • If significant time has passed since you did your last backup, you may + want to repeat the steps in this "Testing" section again, using a fresh backup from your live + shop. + +
          +
        • You do not need to re-upload files again ... simply + do the database restore, and run the installer to do the database upgrade again.
        • +
        +
      • + +
      • Put your shop into "Down for Maintenance" mode in the admin area. + +
          +
        • Be sure to add your IP address to the list of allowed + addresses to get into the site for previewing.
        • +
        +
      • + +
      • Rename the existing Zen Cart® folder (perhaps "store") on + your site to "store_old" + +
          + +
        +
      • + +
      • Rename the "store_new" folder to "store" + +
          +
        • At this point the new version is live.
        • +
        +
      • + +
      • Test it to be sure that things are operating as desired. + +
          +
        • If you have small problems to repair, turn "Down for + maintenance" on and off again as necessary.
        • +
        +
      • +
      +
      +
      +
      + +
      + ^^ Back to Top ^^ +
      +
      + +
      +
      +

      Help and Support

      + +

      For additional help and support, visit the Zen Cart® FAQ and the Zen Cart® Support Forum.

      +
      +
      + +
      +
      +

      Zen Cart® is derived from: Copyright 2003 osCommerce
      +
      + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
      + without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
      + and is redistributable under Version 2 of the GNU General Public License.

      + +

      O S I Certified
      + This software is OSI Certified Open Source Software.
      + OSI Certified is a certification mark of the Open Source Initiative.

      + +

      Copyright 2003 - 2018 Zen Ventures, LLC
      +
      + Zen Cart®
      + www.zen-cart.com

      +
      +
      +
      diff --git a/docs/changed_files-v2-0.html b/docs/changed_files-v2-0.html index 79822e3482..7590ae0d04 100644 --- a/docs/changed_files-v2-0.html +++ b/docs/changed_files-v2-0.html @@ -1,169 +1,177 @@ + + * @license https://www.zen-cart.com/license/2_0.txt GNU Public License v2.0 + * @version $Id: changed_files-v2-0.html New in v2.0 $ + */ + //--> + - Zen Cart® Changed Files - - - - - - - - - - - + + + Zen Cart® Changed Files + + + + + + + + + + + + -
      - - - -
      -

      Welcome to Zen Cart®

      -
      - Dear Zen Cart® User, -

      - Zen Cart® is made available to you for your use, addition, changes, modification, etc. without charge, under Version 2 of the GNU General Public License. -

      -

      - While we do not charge for this software, donations are greatly appreciated, each time you install a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum and the continued development of this software for your online E-Commerce store. -

      -

      - Donations can be made on the Zen Cart® Team Page -

      -

      - We appreciate your support. -
      - The Zen Cart® Team -

      -
      -
      - -
      -
      -

      Zen Cart® Version 2.0

      -

      - For a listing of what is new in this release, please see the whatsnew_2.0.html file in the /docs folder. -
      - You may also consult the Zen Cart® Support Forum. -

      -
      -
      - -
      -
      -

      DELETED Files (since v1.5.6)

      -
        -
      • PENDING FROM ZC TEAM
      • -
      • /docs/ <VARIOUS FILES HERE>
      • -
      -
      -
      - ^^ Back to Top ^^ -
      -
      - -
      -
      -

      NEW Files (since v1.5.6)

      -
        -
      • PENDING FROM ZC TEAM
      • -
      -
      -
      - ^^ Back to Top ^^ -
      -
      - -
      -
      -

      CHANGED Files (since v1.5.6)

      -
        -
      • PENDING FROM ZC TEAM
      • -
      • /ipn_main_handler.php
      • -
      • /includes/...
      • -
      • /includes/dist-configure.php (this is ONLY a basic example file, and is not used by a live store, so doesn't need upgrading on a live site)
      • -
      • /docs/ <VARIOUS FILES HERE>
      • -
      • /zc_install/ ... assume *all* of /zc_install/ has changed -
      -
      -
      - ^^ Back to Top ^^ -
      -
      - -
      -
      -

      Moved Files (since v1.5.6)

      -
        -
      • PENDING FROM ZC TEAM
      • -
      -
      -
      - ^^ Back to Top ^^ -
      -
      - -
      -
      -

      Help and Support

      -

      - For additional help and support, visit the Zen Cart® FAQ and the Zen Cart® Support Forum. -

      -
      -
      - -
      -
      -

      - Zen Cart® is derived from: Copyright 2003 osCommerce -

      - This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; -
      - without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE -
      - and is redistributable under Version 2 of the GNU General Public License. -

      -

      - O S I Certified -
      - This software is OSI Certified Open Source Software. -
      - OSI Certified is a certification mark of the Open Source Initiative. -

      -

      - Copyright 2003 - 2019 Zen Ventures, LLC -

      - Zen Cart® -
      - www.zen-cart.com -

      -
      -
      - -
      +
      + + +
      +

      Welcome to Zen Cart®

      + +
      + Dear Zen Cart® User, + +

      Zen Cart® is made available to you for your use, addition, changes, modification, etc. without + charge, under Version 2 of the GNU General Public License.

      + +

      While we do not charge for this software, donations are greatly appreciated, each time you install + a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum + and the continued development of this software for your online E-Commerce store.

      + +

      Donations can be made on the Zen + Cart® Team Page

      + +

      We appreciate your support.
      + The Zen Cart® Team

      +
      +
      + +
      +
      +

      Zen Cart® Version 2.0

      + +

      For a listing of what is new in this release, please see the whatsnew_2.0.html file in the /docs folder.
      + You may also consult the Zen + Cart® Support Forum.

      +
      +
      + +
      +
      +

      DELETED Files (since v1.5.6)

      + +
        +
      • PENDING FROM ZC TEAM
      • + +
      • /docs/ <VARIOUS FILES HERE>
      • +
      +
      + +
      + ^^ Back to Top ^^ +
      +
      + +
      +
      +

      NEW Files (since v1.5.6)

      + +
        +
      • PENDING FROM ZC TEAM
      • +
      +
      + +
      + ^^ Back to Top ^^ +
      +
      + +
      +
      +

      CHANGED Files (since v1.5.6)

      + +
        +
      • PENDING FROM ZC TEAM
      • + +
      • /ipn_main_handler.php
      • + +
      • /includes/...
      • + +
      • /includes/dist-configure.php (this is ONLY a basic example file, and is not used by a live + store, so doesn't need upgrading on a live site)
      • + +
      • /docs/ <VARIOUS FILES HERE>
      • + +
      • /zc_install/ ... assume *all* of /zc_install/ has changed
      • +
      +
      + +
      + ^^ Back to Top ^^ +
      +
      + +
      +
      +

      Moved Files (since v1.5.6)

      + +
        +
      • PENDING FROM ZC TEAM
      • +
      +
      + +
      + ^^ Back to Top ^^ +
      +
      + +
      +
      +

      Help and Support

      + +

      For additional help and support, visit the Zen Cart® FAQ and the Zen Cart® Support Forum.

      +
      +
      + +
      +
      +

      Zen Cart® is derived from: Copyright 2003 osCommerce
      +
      + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
      + without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
      + and is redistributable under Version 2 of the GNU General Public License.

      + +

      O S I Certified
      + This software is OSI Certified Open Source Software.
      + OSI Certified is a certification mark of the Open Source Initiative.

      + +

      Copyright 2003 - 2019 Zen Ventures, LLC
      +
      + Zen Cart®
      + www.zen-cart.com

      +
      +
      +
      - diff --git a/docs/important_site_security_recommendations.html b/docs/important_site_security_recommendations.html index 044f12a17e..911c004730 100644 --- a/docs/important_site_security_recommendations.html +++ b/docs/important_site_security_recommendations.html @@ -1,540 +1,570 @@ + + * @license https://www.zen-cart.com/license/2_0.txt GNU Public License v2.0 + * @version $Id: important_site_security_recommendations.html Modified in v2.0 $ + */ + //--> + - Zen Cart® Site Security Recommendations - - - - - - - - - - - + + + Zen Cart® Site Security Recommendations + + + + + + + + + + + + -
      - - - -
      -

      Welcome to Zen Cart®

      -
      - Dear Zen Cart® User, -

      - Zen Cart® is made available to you for your use, addition, changes, modification, etc. without charge, under Version 2 of the GNU General Public License. -

      -

      - While we do not charge for this software, donations are greatly appreciated, each time you install a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum and the continued development of this software for your online E-Commerce store. -

      -

      - Donations can be made on the Zen Cart® Team Page -

      -

      - We appreciate your support. -
      - The Zen Cart® Team -

      -
      -
      - -
      -

      Zen Cart® Site Security

      -
      -

      Leveraging Resources on the Zen Cart® Website

      -

      - The Zen Cart® Team, along with Zen Cart® Users and Contributors, regularly update security recommendations on the Zen Cart® Website. -

      -

      - You may wish to also consult recommendations posted on the Zen Cart® Website. -

      -
      -
      +
      + + +
      +

      Welcome to Zen Cart®

      + +
      + Dear Zen Cart® User, + +

      Zen Cart® is made available to you for your use, addition, changes, modification, etc. without + charge, under Version 2 of the GNU General Public License.

      + +

      While we do not charge for this software, donations are greatly appreciated, each time you install + a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum + and the continued development of this software for your online E-Commerce store.

      + +

      Donations can be made on the Zen + Cart® Team Page

      + +

      We appreciate your support.
      + The Zen Cart® Team

      +
      +
      + +
      +

      Zen Cart® Site Security

      + +
      +

      Leveraging Resources on the Zen Cart® Website

      + +

      The Zen Cart® Team, along with Zen Cart® Users and Contributors, regularly update security + recommendations on the Zen Cart® Website.

      + +

      You may wish to also consult recommendations posted on the + Zen Cart® Website.

      +
      + +
      +
      +

      SSL Protection

      + +

      A Secure Sockets Layer (SSL) connection is the standard security technology for establishing a + secure and encrypted connection between a web server and a browser. This requires a SSL certificate + from your web hosting provider or a third party certificate provider.

      + +

      The preferred would be to have a dedicated SSL certificate but there may be additional expense + involved in obtaining this. As a bare minimum, you should use a shared SSL certificate provided by + your web hosting provider.

      +
      +
      -

      SSL Protection

      -

      - A Secure Sockets Layer (SSL) connection is the standard security technology for establishing a secure and encrypted connection between a web server and a browser. This requires a SSL certificate from your web hosting provider or a third party certificate provider. -

      -

      - The preferred would be to have a dedicated SSL certificate but there may be additional expense involved in obtaining this. As a bare minimum, you should use a shared SSL certificate provided by your web hosting provider. -

      -
      -
      -

      Accessing your Site Files Securely

      -

      - Instead of using regular FTP to access your server files, it is advisable to use an FTP program that allows Secure FTP (SFTP or FTPS). -

      - This method will encrypt the information you transmit and receive. This is important especially when you are downloading database backups or configuration files which contain usernames and passwords, etc. -

      -

      - If your web hosting provider does not support Secure FTP, you may wish to consider a web hosting provider that takes security seriously. -

      -
      -
      - ^^ Back to Top ^^ -
      -
      - -
      -
      -

      Securing your Zen Cart® Store

      - -
      -

      Remove Extra Folders from your Server after Install

      -
      -

      - It is important that after you have installed your Zen Cart® Store and are satisfied that it is working properly, including test transactions to test ALL the payment and shipping modules you are using. -

      -
        - Remove the following folders and all the files inside them, to minimize security risks: -
      • /docs
      • -
      • /extras
      • -
      • /zc_install
      • -
      • /install.txt
      • -
      -

      - It is safe to keep these files on your Local PC, since they can be used as references/documentation, or used to aid in troubleshooting as diagnostic tools, or for upgrading/installing again in the future. However, those folders and files should NOT be on a live webserver. -

      -

      - You will need to go to Admin->Configuration->Attribute Settings->Enable Downloads, and set it to False to turn off the warning message about the missing download folder. -

      -

      - If you choose to add downloadable products to your site or music-products, you will want to re-upload these appropriate folders (and their contents) to your server again, and assign appropriate permissions. -

      -
      -
      - -
      -

      Use "SMTPAUTH" or "SMTP" as your Email Transport Method Instead of the Generic "PHP" Setting

      -
      -

      - Go to Admin->Configuration->Email Options, and change your Email Transport Protocol to SMTPAUTH, and then fill in the SMTP Credentials in the other settings lower on that same screen. -

      -

      - This will not only help prevent outgoing emails from ending up in spam folders, but will also prevent the disclosure of your admin foldername when sending emails from your admin screens. -

      -
      -
      - - -
      -

      Delete Unused Admin Accounts

      -
      -

      - In your ADMIN AREA, open the "Admin Access" menu and choose "Admin Users". -

      -

      - Delete any unused admin accounts. Especially the "Demo" account, if it exists. -

      -
      -
      - -
      -

      Maintain Admin Password Security

      -
      -

      - It is wise to use complicated passwords so that a would-be hacker cannot easily guess them. -

      -

      - You can change your admin password in Admin->Admin Access->Admin Users, and click on the "Reset Password" button. -

      -

      - We recommend that you use passwords that are at least 8 characters long. - Making them alpha-numeric (including letters, numbers, upper-and-lower-case, etc) helps. -

      -

      - If you are going to use normal words, it is a good idea to join two words that do not normally go together. -

      -
      -
      - -
      -

      Admin Access Protection

      -
      -
        - Exercise caution while working in your admin area: -
      • - Use only one browser tab to access your ADMIN AREA -
      • -
      • - Do not visit other sites when you have an active admin session, even if it is in another browser tab -
      • -
      • - Always log out of your ADMIN AREA when not using it -
      • -
      -
      -
      - -
      -

      Protect "define pages" in "html_includes"

      -
      -
        - Protect define pages (Admin->Tools->Define Pages Editor) after editing: -
      • - Download a copy to your Local PC using your FTP software. -
          -
        1. - They are located in the /includes/languages/english/html_includes/ folder and subfolders. -
        2. -
        -
      • -
      • Make them CHMOD 644 or 444 (ie: "Read Only"). -
          -
        1. - /includes/languages/english/html_includes – and all files/folders underneath -
        2. -
        3. - With some web hosting providers, you must use at least CHMOD 645 or CHMOD 555 for pages to display -
        4. -
        -
      • -
      -
        - If you make them "Read Only", then a would-be hacker cannot edit them if they gain access to your system, unless they can get permissions to change the "Read Only" status, which is more complicated. -
      • - - Once you set them "Read Only", you will need to go and set them back to "Read/Write" before making additional changes using the define-pages editor, or uploading replacements via FTP, and then set back as "Read Only" again when done. - -
      • -
      -
      -
      - -
      -

      Use ".htaccess" Files to Protect against Snooping

      -
      -

      - Several folders, contain are ".htaccess" files to prevent users from being able to browse through the files on your site unless they know exact filenames. Some also prevent access to "any" .PHP scripts, since it is expected that all PHP files in those folders will be accessed by other PHP files, and not by a browser directly. -

      -

      - If you delete these files, you run the risk of leaving yourself open to people snooping around. -

      -
        - There are also some blank index.html files in several folders. -
      • - These files are there to protect you in case your FTP software would not upload ".htaccess" files, or your server would not accept them. -
      • -
      • - These only prevent directory browsing, and do not stop execution of .PHP files. -
      • -
      • - This is a good "alternative", although using .htaccess files in all of these folders is the better choice for servers that accept these. -
      • -
      -

      - In order for the .htaccess settings supplied with Zen Cart® to work, your web hosting provider must include either "All" or all of these: "Limit Options Indexes" parameters to the "AllowOverride" configuration in the server apache/conf/httpd.conf file. -

      -

      - If your web hosting provider does not allow setting the "OPTIONS" directive, you will need to leave that line out or put a "#" in front of it. -

      -

      - If your web hosting provider does not allow you to create/use your own .htaccess files, they may provide an interface in your hosting control panel where you can set the desired .htaccess settings. - Work with your web hosting provider to configure these settings if this is the method they require. -

      -

      - Your web hosting provider may use web serving software, such as Nginx, which do not use .htaccess files. -

      -

      - In the case of Nginx, directives equivalent to the .htaccess rules are provided after installation of Zen Cart® to serve as a start point. - These can be found in the "/<YourStoreFolderName>/zc_install/nginx_conf/" folder. -

      -

      - It is best to work with your web hosting provider to select and implement the best method for your specific server. -

      -

      - You need to choose, and use, the appropriate method for your server. - We cannot tell you what to use for your specific server, but we offer these guidelines as a starting point. -

      -
      -
      - -
      -

      Protect your "images" and other Folders

      -
      -

      - During initial installation, you are advised to set your images folder to "Read/Write", so that you can use the Admin interface to upload product/category images without having to use FTP for each one. Similar recommendations are made to other files for various reasons. -

      -

      - However, leaving the images (or any other) folder in read/write mode means that hackers might be able to put malicious files in this (or other) folder(s) and thus create access points from which to attempt nasty exploits. -

      -
        - Hence, once your site is built and your images have been created/loaded, you should change the permission setting from "Read/Write" to "Read Only". -
      • - On Linux/Unix hosts, permission setting recommendations for basic security are: -
          -
        1. - Folders and Directories: CHMOD 755 -
        2. -
        3. - Files: CHMOD 644 -
        4. -
        -
      • -
      • - On Windows hosts, setting files as "Read Only" is usually sufficient. -
          -
        • - Double check that the Internet Guest Account has limited ("Read Only") access. -
        • -
        -
      • -
      -

      - The folders for which installation suggests "Read/Write" access for setup are outlined below. -

      -

      - If your site supports .htaccess protection, then you should use it for these folders. (The ".htaccess" files included with v1.3.9 and newer should already cover the basics.) -

      -
        -
      • - /cache -
          -
        1. - This is used to cache database information. -
        2. -
        3. - The BEST security protection for this is to move it to a folder "above" the webroot (public_html or htdocs or www) area, so that it is not accessible via a browser. -
        4. -
        5. - This requires changes to DIR_FS_SQL_CACHE setting in the configure.php file as well as the setting in the ADMIN AREA for the Admin->Configuration->Sessions->Session Directory. -
        6. -
        -
      • -
      • - /images -
          -
        • - This is discussed earlier in this article. -
        • -
        -
      • -
      • - /includes/languages/english/html_includes -
          -
        • - This is discussed earlier in this article. -
        • -
        -
      • -
      • - /logs -
          -
        1. - This is used to cache database information. -
        2. -
        3. - The BEST security protection for this is to move it to a folder "above" the webroot (public_html or htdocs or www) area, so that it is not accessible via a browser. -
        4. -
        5. - This requires changes to DIR_FS_SQL_CACHE setting in the configure.php file as well as the setting in the ADMIN AREA for the Admin->Configuration->Sessions->Session Directory. -
        6. -
        -
      • -
      • - /media -
          -
        1. - This is only suggested "Read/Write" for the sake of being able to upload music product media files via the admin. -
        2. -
        3. - Could be done by FTP as an alternative. -
        4. -
        -
      • -
      • - /pub -
          -
        1. - This is used on Linux/Unix hosts to have downloadable products made available to customers via a secure delivery method which does not disclose the 'real' location of files/data on your server. -
        2. -
        3. - This is to prevent the sharing of links by your customers that enable unauthorised downloads from your site. -
        4. -
        -
      • -
      • - /admin/backups -
          -
        1. - Optional. -
        2. -
        3. - This is used by the backup module to store database backups. -
        4. -
        -
      • -
      • - /admin/images/graphs -
          -
        1. - This is used by Admin->Tools->Banner Manager for updating and displaying bar graphs related to banner usage. -
        2. -
        3. - If not writable, this feature is ignored. -
        4. -
        -
      • -
      -
      -
      - -
      -

      Remove Print URLs from Browser Headers

      -
      -
        - Stop your browser from printing a URL (which discloses your ADMIN folder name) when printing pages in the Admin, such as invoices: -
      • - On Internet Explorer: -
          -
        1. - Click on "File" then "Page Setup". -
        2. -
        3. - At page setup, remove this two character combination: "&u" from the header and/or footer text box. -
        4. -
        -
      • -
      • - On Firefox: -
          -
        1. - Click on "File" then "Page Setup". -
        2. -
        3. - In the "Page Setup" window, click on the "Margins & Header/Footer" tab. -
        4. -
        5. - In the "Header & Footer" section, set all of the drop downs to --blank--. -
        6. -
        7. - Remove all references to "Title" and "URL" if they appear. -
        8. -
        -
      • -
      -
      -
      - -
      -

      Things to Check Regularly

      -
      -

      - Be sure you have done all the steps listed in this document -

      -
        - Keep good backups of your website files and database (frequently) -
      • - Backup the database over a secure connection (ie: if you are using phpMyAdmin to backup, then make sure you are using HTTPS addresses in your URLs). -
      • -
      • - Backup the website files over a secure connection (If you are copying files via FTP, be sure to use Secure FTP). -
      • -
      • - Store the backed up database and website files into an encrypted file. -
          -
        1. - You should NOT keep your backups on your server. If you do however, encrypt them securely. -
        2. -
        3. - Ask your web hosting provider for advice. -
        4. -
        -
      • -
      -
        - Check your server errorlog regularly for odd or suspicious activity (Your hosting control panel should give you access to the Apache error_log) -
      • - Look for links that lead to pages outside your site -
      • -
      • - Look for links where "http" appears after "index.php" -
      • -
      -

      - Check your website files regularly to be sure nothing has been added or altered -

      -

      - Ask your web hosting provider what they have done to be sure the server you are on is safe and secure so that outsiders cannot do any harm, and so that other websites on your server cannot be used to get to your site and cause any harm (in case they have security holes in them) -

      -

      - If your business warrants, or you still want additional assurance (if running ther scripts outside of Zen Cart®), hire a security consultant to audit your site regularly. -

      -

      - Check your Zen Cart /cache/ folder for leftover files that do not belong there. -

      -

      - Check your Zen Cart /logs/ folder for "myDebug-XXXXX.log" files to see whether any errors are happening which need to be fixed. Delete the log files after you have addressed the errors. -

      -
      -
      - -
      - ^^ Back to Top ^^ -
      -
      -
      - -
      -
      -

      Help and Support

      -

      - For additional help and support, visit the Zen Cart® FAQ and the Zen Cart® Support Forum. -

      -
      -
      - -
      -
      -

      - Zen Cart® is derived from: Copyright 2003 osCommerce -

      - This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; -
      - without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE -
      - and is redistributable under Version 2 of the GNU General Public License. -

      -

      - O S I Certified -
      - This software is OSI Certified Open Source Software. -
      - OSI Certified is a certification mark of the Open Source Initiative. -

      -

      - Copyright 2003 - 2018 Zen Ventures, LLC -

      - Zen Cart® -
      - www.zen-cart.com -

      -
      -
      - -
      +

      Accessing your Site Files Securely

      + +

      Instead of using regular FTP to access your server files, it is advisable to use an FTP program + that allows Secure FTP (SFTP or FTPS).

      + +

      This method will encrypt the information you transmit and receive. This is important especially + when you are downloading database backups or configuration files which contain usernames and + passwords, etc.

      + +

      If your web hosting provider does not support Secure FTP, you may wish to consider a web hosting + provider that takes security seriously.

      +
      + +
      + ^^ Back to Top ^^ +
      +
      + + +
      +
      +

      Securing your Zen Cart® Store

      + +
      +

      Remove Extra Folders from your Server after Install

      + +
      +

      It is important that after you have installed your Zen Cart® Store and are satisfied that + it is working properly, including test transactions to test ALL the payment and shipping + modules you are using.

      + +
        +
      • Remove the following folders and all the files inside them, to + minimize security risks:
      • + +
      • /docs
      • + +
      • /extras
      • + +
      • /zc_install
      • + +
      • /install.txt
      • +
      + +

      It is safe to keep these files on your Local PC, since they can be used as + references/documentation, or used to aid in troubleshooting as diagnostic tools, or for + upgrading/installing again in the future. However, those folders and files should NOT be + on a live webserver.

      + +

      You will need to go to Admin->Configuration->Attribute Settings->Enable + Downloads, and set it to False to turn off the warning message about the missing + download folder.

      + +

      If you choose to add downloadable products to your site or music-products, you will want to + re-upload these appropriate folders (and their contents) to your server again, and assign + appropriate permissions.

      +
      +
      + +
      +

      Use "SMTPAUTH" or "SMTP" as your Email Transport Method Instead of the Generic "PHP" + Setting

      + +
      +

      Go to Admin->Configuration->Email Options, and change your Email Transport + Protocol to SMTPAUTH, and then fill in the SMTP Credentials in the other settings lower + on that same screen.

      + +

      This will not only help prevent outgoing emails from ending up in spam folders, but will also + prevent the disclosure of your admin foldername when sending emails from your admin screens.

      +
      +
      + +
      +

      Delete Unused Admin Accounts

      + +
      +

      In your ADMIN AREA, open the "Admin Access" menu and choose "Admin + Users".

      + +

      Delete any unused admin accounts. Especially the "Demo" account, if it exists.

      +
      +
      + +
      +

      Maintain Admin Password Security

      + +
      +

      It is wise to use complicated passwords so that a would-be hacker cannot easily guess + them.

      + +

      You can change your admin password in Admin->Admin Access->Admin Users, and + click on the "Reset Password" button.

      + +

      We recommend that you use passwords that are at least 8 characters long. Making them + alpha-numeric (including letters, numbers, upper-and-lower-case, etc) helps.

      + +

      If you are going to use normal words, it is a good idea to join two words that do not normally + go together.

      +
      +
      + +
      +

      Admin Access Protection

      + +
      +
        +
      • Exercise caution while working in your admin area:
      • + +
      • Use only one browser tab to access your ADMIN AREA
      • + +
      • Do not visit other sites when you have an active admin session, even if it is in another + browser tab
      • + +
      • Always log out of your ADMIN AREA when not using it
      • +
      +
      +
      + +
      +

      Protect "define pages" in "html_includes"

      + +
      +
        +
      • Protect define pages (Admin->Tools->Define Pages + Editor) after editing:
      • + +
      • Download a copy to your Local PC using your FTP software. + +
          +
        1. They are located in the + /includes/languages/english/html_includes/ folder and subfolders.
        2. +
        +
      • + +
      • Make them CHMOD 644 or 444 (ie: "Read Only"). + +
          +
        1. /includes/languages/english/html_includes – and all files/folders + underneath
        2. + +
        3. With some web hosting providers, you must use at least CHMOD 645 or CHMOD + 555 for pages to display
        4. +
        +
      • +
      + +
        +
      • If you make them "Read Only", then a would-be hacker + cannot edit them if they gain access to your system, unless they can get permissions to change + the "Read Only" status, which is more complicated.
      • + +
      • Once you set them "Read Only", you will need to go and + set them back to "Read/Write" before making additional changes using the define-pages + editor, or uploading replacements via FTP, and then set back as "Read Only" again when + done.
      • +
      +
      +
      + +
      +

      Use ".htaccess" Files to Protect against Snooping

      + +
      +

      Several folders, contain are ".htaccess" files to prevent users from being able to + browse through the files on your site unless they know exact filenames. Some also prevent access + to "any" .PHP scripts, since it is expected that all PHP files in those folders will be accessed + by other PHP files, and not by a browser directly.

      + +

      If you delete these files, you run the risk of leaving yourself open to people snooping + around.

      + +
        +
      • There are also some blank index.html files in several + folders.
      • + +
      • These files are there to protect you in case your FTP software would not upload + ".htaccess" files, or your server would not accept them.
      • + +
      • These only prevent directory browsing, and do not stop execution of .PHP files.
      • + +
      • This is a good "alternative", although using .htaccess files in all of these + folders is the better choice for servers that accept these.
      • +
      + +

      In order for the .htaccess settings supplied with Zen Cart® to work, your web hosting + provider must include either "All" or all of these: "Limit Options Indexes" + parameters to the "AllowOverride" configuration in the server + apache/conf/httpd.conf file.

      + +

      If your web hosting provider does not allow setting the "OPTIONS" directive, you will + need to leave that line out or put a "#" in front of it.

      + +

      If your web hosting provider does not allow you to create/use your own .htaccess + files, they may provide an interface in your hosting control panel where you can set the desired + .htaccess settings. Work with your web hosting provider to configure these settings if + this is the method they require.

      + +

      Your web hosting provider may use web serving software, such as Nginx, which do not + use .htaccess files.

      + +

      In the case of Nginx, directives equivalent to the .htaccess rules are + provided after installation of Zen Cart® to serve as a start point. These can be found in the + "/<YourStoreFolderName>/zc_install/nginx_conf/" folder.

      + +

      It is best to work with your web hosting provider to select and implement the best method for + your specific server.

      + +

      You need to choose, and use, the appropriate method for your + server. We cannot tell you what to use for your specific server, but we offer these + guidelines as a starting point.

      +
      +
      + +
      +

      Protect your "images" and other Folders

      + +
      +

      During initial installation, you are advised to set your images folder to + "Read/Write", so that you can use the Admin interface to upload product/category images + without having to use FTP for each one. Similar recommendations are made to other files for + various reasons.

      + +

      However, leaving the images (or any other) folder in read/write mode means that hackers might + be able to put malicious files in this (or other) folder(s) and thus create access points from + which to attempt nasty exploits.

      + +
        +
      • Hence, once your site is built and your images have been + created/loaded, you should change the permission setting from "Read/Write" to + "Read Only".
      • + +
      • On Linux/Unix hosts, permission setting recommendations for basic security are: + +
          +
        1. Folders and Directories: CHMOD 755
        2. + +
        3. Files: CHMOD 644
        4. +
        +
      • + +
      • On Windows hosts, setting files as "Read Only" is usually sufficient. + +
          +
        • Double check that the Internet Guest Account has limited + ("Read Only") access.
        • +
        +
      • +
      + +

      The folders for which installation suggests "Read/Write" access for setup are + outlined below.

      + +

      If your site supports .htaccess protection, then you should use it for these folders. (The + ".htaccess" files included with v1.3.9 and newer should already cover the basics.)

      + +
        +
      • + /cache + +
          +
        1. This is used to cache database information.
        2. + +
        3. The BEST security protection for this is to move it to a folder "above" the webroot + (public_html or htdocs or www) area, so that it is not accessible via a browser.
        4. + +
        5. This requires changes to DIR_FS_SQL_CACHE setting in the configure.php file as well as + the setting in the ADMIN AREA for the + Admin->Configuration->Sessions->Session Directory.
        6. +
        +
      • + +
      • + /images + +
          +
        • This is discussed earlier in this article.
        • +
        +
      • + +
      • + /includes/languages/english/html_includes + +
          +
        • This is discussed earlier in this article.
        • +
        +
      • + +
      • + /logs + +
          +
        1. This is used to cache database information.
        2. + +
        3. The BEST security protection for this is to move it to a folder "above" the webroot + (public_html or htdocs or www) area, so that it is not accessible via a browser.
        4. + +
        5. This requires changes to DIR_FS_SQL_CACHE setting in the configure.php file as well as + the setting in the ADMIN AREA for the + Admin->Configuration->Sessions->Session Directory.
        6. +
        +
      • + +
      • + /media + +
          +
        1. This is only suggested "Read/Write" for the sake of being able to upload music + product media files via the admin.
        2. + +
        3. Could be done by FTP as an alternative.
        4. +
        +
      • + +
      • + /pub + +
          +
        1. This is used on Linux/Unix hosts to have downloadable products made available to + customers via a secure delivery method which does not disclose the 'real' location of + files/data on your server.
        2. + +
        3. This is to prevent the sharing of links by your customers that enable unauthorised + downloads from your site.
        4. +
        +
      • + +
      • + /admin/backups + +
          +
        1. Optional.
        2. + +
        3. This is used by the backup module to store database backups.
        4. +
        +
      • + +
      • + /admin/images/graphs + +
          +
        1. This is used by Admin->Tools->Banner Manager for updating and displaying + bar graphs related to banner usage.
        2. + +
        3. If not writable, this feature is ignored.
        4. +
        +
      • +
      +
      +
      + +
      +

      Remove Print URLs from Browser Headers

      + +
      +
        +
      • Stop your browser from printing a URL (which discloses your ADMIN + folder name) when printing pages in the Admin, such as invoices:
      • + +
      • On Internet Explorer: + +
          +
        1. Click on "File" then "Page Setup".
        2. + +
        3. At page setup, remove this two character combination: "&u" from the header and/or + footer text box.
        4. +
        +
      • + +
      • On Firefox: + +
          +
        1. Click on "File" then "Page Setup".
        2. + +
        3. In the "Page Setup" window, click on the "Margins & + Header/Footer" tab.
        4. + +
        5. In the "Header & Footer" section, set all of the drop downs to + --blank--.
        6. + +
        7. Remove all references to "Title" and "URL" if they appear.
        8. +
        +
      • +
      +
      +
      + +
      +

      Things to Check Regularly

      + +
      +

      Be sure you have done all the steps listed in this document

      + +
        +
      • Keep good backups of your website files and database + (frequently)
      • + +
      • Backup the database over a secure connection (ie: if you are using phpMyAdmin to backup, + then make sure you are using HTTPS addresses in your URLs).
      • + +
      • Backup the website files over a secure connection (If you are copying files via FTP, be + sure to use Secure FTP).
      • + +
      • Store the backed up database and website files into an encrypted file. + +
          +
        1. You should NOT keep your backups on your server. If you do however, encrypt + them securely.
        2. + +
        3. Ask your web hosting provider for advice.
        4. +
        +
      • +
      + +
        +
      • Check your server errorlog regularly for odd or suspicious + activity (Your hosting control panel should give you access to the Apache error_log)
      • + +
      • Look for links that lead to pages outside your site
      • + +
      • Look for links where "http" appears after "index.php"
      • +
      + +

      Check your website files regularly to be sure nothing has been added or altered

      + +

      Ask your web hosting provider what they have done to be sure the server you are on is safe and + secure so that outsiders cannot do any harm, and so that other websites on your server cannot be + used to get to your site and cause any harm (in case they have security holes in them)

      + +

      If your business warrants, or you still want additional assurance (if running ther scripts + outside of Zen Cart®), hire a security consultant to audit your site regularly.

      + +

      Check your Zen Cart /cache/ folder for leftover files that do not belong there.

      + +

      Check your Zen Cart /logs/ folder for "myDebug-XXXXX.log" files to see + whether any errors are happening which need to be fixed. Delete the log files after you have + addressed the errors.

      +
      +
      + +
      + ^^ Back to Top ^^ +
      +
      +
      + +
      +
      +

      Help and Support

      + +

      For additional help and support, visit the Zen Cart® FAQ and the Zen Cart® Support Forum.

      +
      +
      + +
      +
      +

      Zen Cart® is derived from: Copyright 2003 osCommerce
      +
      + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
      + without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
      + and is redistributable under Version 2 of the GNU General Public License.

      + +

      O S I Certified
      + This software is OSI Certified Open Source Software.
      + OSI Certified is a certification mark of the Open Source Initiative.

      + +

      Copyright 2003 - 2018 Zen Ventures, LLC
      +
      + Zen Cart®
      + www.zen-cart.com

      +
      +
      + diff --git a/docs/index.html b/docs/index.html index 726d4ba8d0..dc824eaaa3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,165 +1,152 @@ + + * @license https://www.zen-cart.com/license/2_0.txt GNU Public License v2.0 + * @version $Id: index.html Modified in v2.0 $ + */ + //--> + - Zen Cart Documentation - - - - - - - - - - - - + + + Zen Cart Documentation + + + + + + + + + + + + + -
      - - - -
      -
      -

      Welcome to Zen Cart®

      -
      -
      - -
      -
      -
      -

      Zen Cart® Documentation

      -
      -
      -
        -
      1. - Introduction - -
      2. -
      3. - Read Me First - -
      4. -
      5. - New Features and Bug Fixes - -
      6. -
      7. - Changed Files - -
      8. -
      9. - Help and Support - -
      10. -
      -
      -
      -
      -
      -
      - - Smart Payment Processing with Square - -
      -
      -
      -
      - -
      -
      -

      - Zen Cart® is derived from: Copyright 2003 osCommerce -

      - This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; -
      - without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE -
      - and is redistributable under Version 2 of the GNU General Public License. -

      -

      - O S I Certified -
      - This software is OSI Certified Open Source Software. -
      - OSI Certified is a certification mark of the Open Source Initiative. -

      -

      - Copyright 2003 - 2018 Zen Ventures, LLC -

      - Zen Cart® -
      - www.zen-cart.com -

      -
      -
      - -
      +
      + + +
      +
      +

      Welcome to Zen Cart®

      +
      +
      + +
      +
      +
      +

      Zen Cart® Documentation

      +
      + +
      +
        +
      1. + Introduction + + +
      2. + +
      3. + Read Me First + + +
      4. + +
      5. + New Features and Bug Fixes + + +
      6. + +
      7. + Changed Files + + +
      8. + +
      9. + Help and Support + + +
      10. +
      +
      +

      + +
      +
      + + +

      +
      +
      + +
      +
      +

      Zen Cart® is derived from: Copyright 2003 osCommerce
      +
      + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
      + without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
      + and is redistributable under Version 2 of the GNU General Public License.

      + +

      O S I Certified
      + This software is OSI Certified Open Source Software.
      + OSI Certified is a certification mark of the Open Source Initiative.

      + +

      Copyright 2003 - 2018 Zen Ventures, LLC
      +
      + Zen Cart®
      + www.zen-cart.com

      +
      +
      +
      diff --git a/docs/whatsnew_2.0.html b/docs/whatsnew_2.0.html index d5173af587..bc18df8491 100644 --- a/docs/whatsnew_2.0.html +++ b/docs/whatsnew_2.0.html @@ -1,424 +1,469 @@ + + * @license https://www.zen-cart.com/license/2_0.txt GNU Public License v2.0 + * @version $Id: whatsnew_2.0.html New in v2.0 $ + */ + //--> + - What's New in Zen Cart® v2.0 - - - - - - - - - - - + + + What's New in Zen Cart® v2.0 + + + + + + + + + + + + -
      - - - -
      -

      Welcome to Zen Cart®

      -
      - Dear Zen Cart® User, -

      - Zen Cart® is made available to you for your use, addition, changes, modification, etc. without charge, under Version 2 of the GNU General Public License. -

      -

      - While we do not charge for this software, donations are greatly appreciated, each time you install a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum and the continued development of this software for your online E-Commerce store. -

      -

      - Donations can be made on the Zen Cart® Team Page -

      -

      - We appreciate your support. -
      - The Zen Cart® Team -

      -
      -
      - -
      -
      -

      - About PHP versions -

      -

      - Zen Cart® v2.0 is compatible with PHP 5.6 to 7.3, with MySQL 5.1 to 5.7 (or MariaDB 10.0-10.3) and Apache 2.2/2.4 -

      -

      - While it is compatible with PHP 5.4.9 through PHP 7.3 for backward-compatibility while upgrading your site, you should be using a newer version whenever possible. As of the time of writing this, PHP 5.6 is considered obsolete. and you should be using PHP 7.1 or greater. -

      -
      -
      - -
      -
      -

      - Upgrade Instructions -

      -

      - The standard complete site upgrade instructions apply for upgrading to Zen Cart® v2.0 from any previous version. -

      -
      -
      - -
      -
      -

      - CHANGELOG - List of Changed Files -

      -

      - For a list of files that have been changed since v1.5.6, see the changed_files-v2-0.html document. -

      -
      -
      - ^^ Back to Top ^^ -
      -
      - -
      -
      -

      - Whats New ... Changes from v1.5.6 to v2.0 -

      -

      - Improvements and Fixes since v1.5.6 -

      -
      -
      -

      - Improvements: -

      -
        -
      • - Infrastructure -
          -
        • - Comprehensive Unit Test framework -
            -
          1. Many functions are now automatically tested at build with with phpUnit.
          2. -
          -
        • -
        • - Separation of vendor-provided files -
        • -
        -
      • -
      • - Installation and Setup: -
          -
        • - Streamlined Configuration -
            -
          1. All site settings now only in /includes/configure.php.
          2. -
          3. The /admin/includes/configure.php file is no longer required.
          4. -
          -
        • -
        -
      • -
      • - Guest Checkout: -
          -
        • - Guest checkout is now natively available in Zen Cart. -
            -
          1. No mods required.
          2. -
          3. Can be disabled by storeowner.
          4. -
          -
        • -
        -
      • -
      • - Standard Checkout: -
          -
        • - Product Shipping Insurance Support. -
            -
          1. For shipping carriers that offer this in their modules.
          2. -
          -
        • -
        • - Improvements to Checkout Flows. -
            -
          1. Passwords are not required until end of checkout.
          2. -
          3. Optional abbreviated checkout for virtual+free purchases.
          4. -
          -
        • -
        -
      • -
      • - Order Processing: -
          -
        • - Order Weight tracking. -
            -
          1. Total order weight and per product weight recorded at checkout time.
          2. -
          -
        • -
        -
      • -
      • - Languages: -
          -
        • - Multilingual Configuration Menu for Country Names. -
          -
        • -
        • - Remembers Customer's Order Language. -
            -
          1. Order updates automaitically sent in saved language.
          2. -
          -
        • -
        • - Language files simplified to relocate locale-specific content into a new locale.php file. -
            -
          1. Most sites will now touch fewer files for customization.
          2. -
          -
        • -
        -
      • -
      • - Product Features: -
          -
        • - Product Microdata Markup. -
          -
        • -
        • - New Product Indicators. -
            -
          1. Product stock availability and product condition indicators.
          2. -
          -
        • -
        • - Single Attribute Products Improvements. -
            -
          1. Can now be added to cart from product listing.
          2. -
          3. Instead of via "more info" taking you to the product page first
          4. -
          -
        • -
        • - Externally Hosted Downloadable Virtual Products. -
            -
          1. Storable on AWS S3, Dropbox and any other service with an available plugin.
          2. -
          -
        • -
        -
      • -
      • - Admin Improvements: -
          -
        • - Date Selection Improvements. -
            -
          1. Spiffycal replaced with powerful jQuery plugin.
          2. -
          -
        • -
        • - Reporting Tools -
            -
          1. Duplicate model reporting.
          2. -
          3. System inspection to report on database changes from a base install.
          4. -
          -
        • -
        • - Flexible Admin Templating System. -
            -
          1. Allows restyling to suit theme preferences.
          2. -
          -
        • -
        • - Admin Home Page Dashboard Widgets. -
            -
          1. - Displays metrics such as: -
              -
            1. current customer activity
            2. -
            3. banner imprint graphs
            4. -
            5. sales history graphs
            6. -
            7. ... and more.
            8. -
            -
          2. -
          -
        • -
        -
      • -
      • - Promotional Tools: -
          -
        • - Allow or Disallow Gift Certificates to be put on "Special". -
          -
        • -
        • - Coupon Capability Improvements. -
            -
          1. Combine free shipping with amount or percent discount
          2. -
          3. - Support rules such as: -
              -
            1. combining with sales
            2. -
            3. minimum order amount
            4. -
            5. limit by number of orders
            6. -
            7. export option
            8. -
            9. ... and more.
            10. -
            -
          4. -
          -
        • -
        -
      • -
      • - Designers will Love: -
          -
        • - HTML 5 Codebase. -
            -
          1. The codebase has been modernised to leverage HTML 5 features
          2. -
          -
        • -
        • - No Need for Custom Graphics. -
            -
          1. Use CSS buttons and font icons in place of custom graphics.
          2. -
          -
        • -
        • - Flexibile CSS Framework Adaption. -
            -
          1. Templating system allows for adoption of CSS frameworks such as Bootstrap.
          2. -
          -
        • -
        • - Painless Minification of CSS, JS and More. -
            -
          1. Template hooks provided to trigger minification of CSS, JS and more.
          2. -
          -
        • -
        • - Flexibile CSS and JS Placement. -
            -
          1. Increased flexibility for custom "per page" CSS and JS placement on pages.
          2. -
          -
        • -
        • - Powerful New Template "Middle Tier". -
            -
          1. Allows for "shared" customizations which might apply to multiple templates.
          2. -
          -
        • -
        -
      • -
      • - Developers will Love: -
          -
        • - Multi Tenancy Capability. -
          -
        • -
        • - Nginx Configuration Template. -
            -
          1. Nginx directives equivalent to Apache htaccess rules to secure Zen Cart® are provided after installation to serve as a start point.
          2. -
          -
        • -
        • - Cart Content Inspector Functions. -
            -
          1. Allows custom actions to be built around cart contents.
          2. -
          3. Includes reacting to product weight, category, value, ... and more.
          4. -
          -
        • -
        • - Additional Notifier Hooks. -
            -
          1. Allows for customizing category tabs, reviews, cart contents, downloads, product images and popups.
          2. -
          -
        • -
        • - In-depth Code Modernization. -
            -
          1. Progressively incorporating namespaced "OOP" rewrites of various segments.
          2. -
          -
        • -
        • - Function Consolidation. -
            -
          1. Previously duplicated functions, across admin and catalog, are now shared from one instance.
          2. -
          -
        • -
        - Documentation for developers on features of v2.0 is available on the Zen Cart® Developer Documentation Page. -
      • -
      -
      - ^^ Back to Top ^^ -
      -
      -
      - -
      -
      -

      Help and Support

      -

      - For additional help and support, visit the Zen Cart® FAQ and the Zen Cart® Support Forum. -

      -
      -
      - -
      -
      -

      - Zen Cart® is derived from: Copyright 2003 osCommerce -

      - This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; -
      - without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE -
      - and is redistributable under Version 2 of the GNU General Public License. -

      -

      - O S I Certified -
      - This software is OSI Certified Open Source Software. -
      - OSI Certified is a certification mark of the Open Source Initiative. -

      -

      - Copyright 2003 - 2019 Zen Ventures, LLC -

      - Zen Cart® -
      - www.zen-cart.com -

      -
      -
      - -
      +
      + + +
      +

      Welcome to Zen Cart®

      + +
      + Dear Zen Cart® User, + +

      Zen Cart® is made available to you for your use, addition, changes, modification, etc. without + charge, under Version 2 of the GNU General Public License.

      + +

      While we do not charge for this software, donations are greatly appreciated, each time you install + a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum + and the continued development of this software for your online E-Commerce store.

      + +

      Donations can be made on the Zen + Cart® Team Page

      + +

      We appreciate your support.
      + The Zen Cart® Team

      +
      +
      + +
      +
      +

      About PHP versions

      + +

      Zen Cart® v2.0 is compatible with PHP 5.6 to 7.3, with MySQL 5.1 to 5.7 (or MariaDB 10.0-10.3) + and Apache 2.2/2.4

      + +

      While it is compatible with PHP 5.4.9 through PHP 7.3 for + backward-compatibility while upgrading your site, you should be using a newer version whenever + possible. As of the time of writing this, PHP 5.6 is considered obsolete. and you should be using PHP 7.1 or greater.

      +
      +
      + +
      +
      +

      Upgrade Instructions

      + +

      The standard complete site upgrade instructions + apply for upgrading to Zen Cart® v2.0 from any previous version.

      +
      +
      + +
      +
      +

      CHANGELOG - List of Changed Files

      + +

      For a list of files that have been changed since v1.5.6, see the changed_files-v2-0.html document.

      +
      + +
      + ^^ Back to Top ^^ +
      +
      + +
      +
      +

      Whats New ... Changes from v1.5.6 to v2.0

      + +

      Improvements and Fixes since v1.5.6

      +
      + +
      +

      Improvements:

      + +
        +
      • Infrastructure + +
          +
        • Comprehensive Unit Test framework + +
            +
          1. Many functions are now automatically tested at build with with phpUnit.
          2. +
          +
        • + +
        • Separation of vendor-provided files
        • +
        +
      • + +
      • Installation and Setup: + +
          +
        • Streamlined Configuration + +
            +
          1. All site settings now only in /includes/configure.php.
          2. + +
          3. The /admin/includes/configure.php file is no longer required.
          4. +
          +
        • +
        +
      • + +
      • Guest Checkout: + +
          +
        • Guest checkout is now natively available in Zen Cart. + +
            +
          1. No mods required.
          2. + +
          3. Can be disabled by storeowner.
          4. +
          +
        • +
        +
      • + +
      • Standard Checkout: + +
          +
        • Product Shipping Insurance Support. + +
            +
          1. For shipping carriers that offer this in their modules.
          2. +
          +
        • + +
        • Improvements to Checkout Flows. + +
            +
          1. Passwords are not required until end of checkout.
          2. + +
          3. Optional abbreviated checkout for virtual+free purchases.
          4. +
          +
        • +
        +
      • + +
      • Order Processing: + +
          +
        • Order Weight tracking. + +
            +
          1. Total order weight and per product weight recorded at checkout time.
          2. +
          +
        • +
        +
      • + +
      • Languages: + +
          +
        • Multilingual Configuration Menu for Country Names. + +
            + +
          +
        • + +
        • Remembers Customer's Order Language. + +
            +
          1. Order updates automaitically sent in saved language.
          2. +
          +
        • + +
        • Language files simplified to relocate locale-specific content into a new locale.php file. + +
            +
          1. Most sites will now touch fewer files for customization.
          2. +
          +
        • +
        +
      • + +
      • Product Features: + +
          +
        • Product Microdata Markup. + +
            + +
          +
        • + +
        • New Product Indicators. + +
            +
          1. Product stock availability and product condition indicators.
          2. +
          +
        • + +
        • Single Attribute Products Improvements. + +
            +
          1. Can now be added to cart from product listing.
          2. + +
          3. Instead of via "more info" taking you to the product page first
          4. +
          +
        • + +
        • Externally Hosted Downloadable Virtual Products. + +
            +
          1. Storable on AWS S3, Dropbox and any other service with an available plugin.
          2. +
          +
        • +
        +
      • + +
      • Admin Improvements: + +
          +
        • Date Selection Improvements. + +
            +
          1. Spiffycal replaced with powerful jQuery plugin.
          2. +
          +
        • + +
        • Reporting Tools + +
            +
          1. Duplicate model reporting.
          2. + +
          3. System inspection to report on database changes from a base install.
          4. +
          +
        • + +
        • Flexible Admin Templating System. + +
            +
          1. Allows restyling to suit theme preferences.
          2. +
          +
        • + +
        • Admin Home Page Dashboard Widgets. + +
            +
          1. Displays metrics such as: + +
              +
            1. current customer activity
            2. + +
            3. banner imprint graphs
            4. + +
            5. sales history graphs
            6. + +
            7. ... and more.
            8. +
            +
          2. +
          +
        • +
        +
      • + +
      • Promotional Tools: + +
          +
        • Allow or Disallow Gift Certificates to be put on "Special". + +
            + +
          +
        • + +
        • Coupon Capability Improvements. + +
            +
          1. Combine free shipping with amount or percent discount
          2. + +
          3. Support rules such as: + +
              +
            1. combining with sales
            2. + +
            3. minimum order amount
            4. + +
            5. limit by number of orders
            6. + +
            7. export option
            8. + +
            9. ... and more.
            10. +
            +
          4. +
          +
        • +
        +
      • + +
      • Designers will Love: + +
          +
        • HTML 5 Codebase. + +
            +
          1. The codebase has been modernised to leverage HTML 5 features
          2. +
          +
        • + +
        • No Need for Custom Graphics. + +
            +
          1. Use CSS buttons and font icons in place of custom graphics.
          2. +
          +
        • + +
        • Flexibile CSS Framework Adaption. + +
            +
          1. Templating system allows for adoption of CSS frameworks such as Bootstrap.
          2. +
          +
        • + +
        • Painless Minification of CSS, JS and More. + +
            +
          1. Template hooks provided to trigger minification of CSS, JS and more.
          2. +
          +
        • + +
        • Flexibile CSS and JS Placement. + +
            +
          1. Increased flexibility for custom "per page" CSS and JS placement on + pages.
          2. +
          +
        • + +
        • Powerful New Template "Middle Tier". + +
            +
          1. Allows for "shared" customizations which might apply to multiple + templates.
          2. +
          +
        • +
        +
      • + +
      • Developers will Love: + +
          +
        • Multi Tenancy Capability. + +
            + +
          +
        • + +
        • Nginx Configuration Template. + +
            +
          1. Nginx directives equivalent to Apache htaccess rules to secure Zen Cart® are + provided after installation to serve as a start point.
          2. +
          +
        • + +
        • Cart Content Inspector Functions. + +
            +
          1. Allows custom actions to be built around cart contents.
          2. + +
          3. Includes reacting to product weight, category, value, ... and more.
          4. +
          +
        • + +
        • Additional Notifier Hooks. + +
            +
          1. Allows for customizing category tabs, reviews, cart contents, downloads, product images + and popups.
          2. +
          +
        • + +
        • In-depth Code Modernization. + +
            +
          1. Progressively incorporating namespaced "OOP" rewrites of various + segments.
          2. +
          +
        • + +
        • Function Consolidation. + +
            +
          1. Previously duplicated functions, across admin and catalog, are now shared from one + instance.
          2. +
          +
        • +
        Documentation for developers on features of v2.0 is available on the Zen Cart® Developer Documentation Page. +
      • +
      + +
      + ^^ Back to Top ^^ +
      +
      +
      + +
      +
      +

      Help and Support

      + +

      For additional help and support, visit the Zen Cart® FAQ and the Zen Cart® Support Forum.

      +
      +
      + +
      +
      +

      Zen Cart® is derived from: Copyright 2003 osCommerce
      +
      + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
      + without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
      + and is redistributable under Version 2 of the GNU General Public License.

      + +

      O S I Certified
      + This software is OSI Certified Open Source Software.
      + OSI Certified is a certification mark of the Open Source Initiative.

      + +

      Copyright 2003 - 2019 Zen Ventures, LLC
      +
      + Zen Cart®
      + www.zen-cart.com

      +
      +
      +