Difference between revisions of "X-Cart:X-CloudBackup"

From X-Cart 4 Classic
Jump to: navigation, search
(Configuring the X-Backup add-on module)
Line 14: Line 14:
  
 
==System requirements==
 
==System requirements==
To be able to successfully install and use the <u>X-Backup</u> add-on module, you need to have an installed working copy of X-Cart 4.1.12, 4.2.3, 4.3.2, 4.4.0-4.4.5, 4.5.0 or later. Make sure that the version of the module is the same as the version of your installed copy of X-Cart.
+
To be able to successfully install and use the <u>X-CloudBackup</u> add-on module, you need to have an installed working copy of X-Cart 4.1.12, 4.2.3, 4.3.2, 4.4.0-4.4.5, 4.5.0 or later. Make sure that the version of the module is the same as the version of your installed copy of X-Cart.
  
 
{{Note1|Note: If you do not remember the version of X-Cart on which your store is based, you can look it up in the <u>Environment info</u> section of the [[X-Cart:Summary_Page |Summary]] page in X-Cart Admin area.}}
 
{{Note1|Note: If you do not remember the version of X-Cart on which your store is based, you can look it up in the <u>Environment info</u> section of the [[X-Cart:Summary_Page |Summary]] page in X-Cart Admin area.}}
Line 24: Line 24:
 
====Installation for X-Cart 4.4.x - 4.5.x====
 
====Installation for X-Cart 4.4.x - 4.5.x====
 
To install the module:
 
To install the module:
# Obtain the X-Backup add-on module distribution package by downloading it from the File Area section of your {{QA}}. The distribution package you need is contained in the archive file <u>x-backup-x.y.z.tgz</u> where <u>x</u>, <u>y</u> and <u>z</u> stand for X-Cart version (These need to match the version of X-Cart on which your store is based).
+
# Obtain the X-CloudBackup add-on module distribution package by downloading it from the File Area section of your {{QA}}. The distribution package you need is contained in the archive file <u>X-CloudBackup-x.y.z.tgz</u> where <u>x</u>, <u>y</u> and <u>z</u> stand for X-Cart version (These need to match the version of X-Cart on which your store is based).
 
# Copy the distribution package to the X-Cart root directory on your server or hosting account.
 
# Copy the distribution package to the X-Cart root directory on your server or hosting account.
 
#* If you use a Windows-based server, or a UNIX-based server without terminal access:
 
#* If you use a Windows-based server, or a UNIX-based server without terminal access:
#: a) Decompress the archive with the X-Backup distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
+
#: a) Decompress the archive with the X-CloudBackup distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
 
#: b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.
 
#: b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.
 
#* If you use a UNIX-based server with terminal access:
 
#* If you use a UNIX-based server with terminal access:
 
#: a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account.
 
#: a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account.
 
#: b) Decompress the package using the following command:
 
#: b) Decompress the package using the following command:
#: <pre>tar -xzvf x-backup-x.y.z.tgz</pre>
+
#: <pre>tar -xzvf X-CloudBackup-x.y.z.tgz</pre>
 
#: {{Note1|'''Important:''' Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten! }}
 
#: {{Note1|'''Important:''' Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten! }}
 
# In a web browser, run the installation script <u>httр://<YOUR_XCART_DOMAIN>/install-xbackup.php</u> replacing the variable <u><YOUR_XCART_DOMAIN></u> with the actual domain name of your X-Cart based store.
 
# In a web browser, run the installation script <u>httр://<YOUR_XCART_DOMAIN>/install-xbackup.php</u> replacing the variable <u><YOUR_XCART_DOMAIN></u> with the actual domain name of your X-Cart based store.
 
# Enter the [[X-Cart:FAQs#What_is_Auth_code_and_where_can_I_find_it.3F|Auth code]], accept the License Agreement and click the Next button.<br />
 
# Enter the [[X-Cart:FAQs#What_is_Auth_code_and_where_can_I_find_it.3F|Auth code]], accept the License Agreement and click the Next button.<br />
# The installation script patches the files and activates the module. Click '''Next''' to continue the installation.<br />{{Note1|Note: if you are using a custom skin, you will need to manually apply the patches to it. Otherwise, the module will not work in this skin. For more info, see [[#How to patch a 3rd party skin after the installation of the Rich Google Search Results module|How to patch a 3rd party skin after the installation of the X-Backup module]].}}
+
# The installation script patches the files and activates the module. Click '''Next''' to continue the installation.<br />{{Note1|Note: if you are using a custom skin, you will need to manually apply the patches to it. Otherwise, the module will not work in this skin. For more info, see [[#How to patch a 3rd party skin after the installation of the Rich Google Search Results module|How to patch a 3rd party skin after the installation of the X-CloudBackup module]].}}
 
# The installation script generates a new system fingerprint. Click '''Next''' to complete the installation.
 
# The installation script generates a new system fingerprint. Click '''Next''' to complete the installation.
 
# Use the ADMINISTRATOR AREA link to log in to the Admin area.
 
# Use the ADMINISTRATOR AREA link to log in to the Admin area.
Line 44: Line 44:
 
To install the module:
 
To install the module:
  
# Obtain the X-Backup add-on module distribution package by downloading it from the File Area section of your {{QA}}. The distribution package you need is contained in the archive file <u>x-rich-gsearch-results-x.y.z-without-installer.tgz</u> where <u>x</u>, <u>y</u> and <u>z</u> stand for X-Cart version (These need to match the version of X-Cart on which your store is based).
+
# Obtain the X-CloudBackup add-on module distribution package by downloading it from the File Area section of your {{QA}}. The distribution package you need is contained in the archive file <u>x-rich-gsearch-results-x.y.z-without-installer.tgz</u> where <u>x</u>, <u>y</u> and <u>z</u> stand for X-Cart version (These need to match the version of X-Cart on which your store is based).
 
# Copy the distribution package to the X-Cart root directory on your server or hosting account:
 
# Copy the distribution package to the X-Cart root directory on your server or hosting account:
 
#* If you use a Windows-based server, or a UNIX-based server without terminal access:
 
#* If you use a Windows-based server, or a UNIX-based server without terminal access:
#: a) Decompress the archive with the X-Backup distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
+
#: a) Decompress the archive with the X-CloudBackup distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
 
#: b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.
 
#: b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.
 
#* If you use a UNIX-based server with terminal access:
 
#* If you use a UNIX-based server with terminal access:
 
#: a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account.
 
#: a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account.
 
#: b) Decompress the package using the following command:
 
#: b) Decompress the package using the following command:
#: <pre>tar -xzvf x-backup-x.y.z.tgz</pre>
+
#: <pre>tar -xzvf X-CloudBackup-x.y.z.tgz</pre>
 
#: {{Note1|'''Important:''' Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten! }}
 
#: {{Note1|'''Important:''' Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten! }}
# In the X-Cart root directory locate the document 'INSTALL.X-BACKUP' and use the instructions from this file to manually install the module.
+
# In the X-Cart root directory locate the document 'INSTALL.X-CloudBackup' and use the instructions from this file to manually install the module.
 
<br />
 
<br />
  
== Enabling the X-Backup add-on module==
+
== Enabling the X-CloudBackup add-on module==
  
After the <u>X-Backup</u> add-on module installation has been completed, the module you have installed needs to be enabled in your store:
+
After the <u>X-CloudBackup</u> add-on module installation has been completed, the module you have installed needs to be enabled in your store:
  
 
# In Admin area, go to the <u>Modules</u> section (<u>Settings menu->Modules</u>).
 
# In Admin area, go to the <u>Modules</u> section (<u>Settings menu->Modules</u>).
# Choose the <u>X-Backup</u> module by selecting the respective check box on the left.
+
# Choose the <u>X-CloudBackup</u> module by selecting the respective check box on the left.
 
# Click the '''Apply changes''' button. This activates the module.<br /><br />
 
# Click the '''Apply changes''' button. This activates the module.<br /><br />
  
Line 70: Line 70:
  
  
==Configuring the X-Backup add-on module==
+
==Configuring the X-CloudBackup add-on module==
  
After the <u>X-Backup</u> add-on module has been enabled in your store, you should check and adjust its configuration:
+
After the <u>X-CloudBackup</u> add-on module has been enabled in your store, you should check and adjust its configuration:
  
# In the <u>Modules</u> section (<u>Settings menu->Modules</u>), click the <u>Configure</u> link opposite the module name ('X-Backup').<br />The module configuration page (titled by the name of the module) opens:
+
# In the <u>Modules</u> section (<u>Settings menu->Modules</u>), click the <u>Configure</u> link opposite the module name ('X-CloudBackup').<br />The module configuration page (titled by the name of the module) opens:
 
#: [[Image:settings_cloud_backup.png |border]]
 
#: [[Image:settings_cloud_backup.png |border]]
 +
# Adjust the settings on the module configuration page:
 +
...................
 +
# Click the '''Apply changes''' button to save the changes.
 +
<br />
 +
 +
 +
 +
 +
 +
 +
==Configuring the X-CloudBackup add-on module==
 +
 +
 +
 +
# In the <u>Modules</u> section (<u>Settings menu->Modules</u>), click the <u>Configure</u> link opposite the module name ('X-CloudBackup').<br />The module configuration page (titled by the name of the module) opens:
 +
#: [[Image:Manage_cloud_backup.png |border]]
 
# Adjust the settings on the module configuration page:
 
# Adjust the settings on the module configuration page:
 
...................
 
...................
 
# Click the '''Apply changes''' button to save the changes.
 
# Click the '''Apply changes''' button to save the changes.
 
<br />
 
<br />

Revision as of 17:05, 29 January 2013

X-Cart4.1.x-4.5.x

Overview

What X-CloudBackup add-on module does

X-CloudBackup module allows to protect your most valuable asset – your e-commerce data – with this easy-to-use module that allows you to schedule automatic and manual X-Cart backups that can be set to upload to Dropbox or any FTP server you specify. Configure regularly scheduled backups of your files, database or both and augment with manual backups to ensure none of your irreplaceable data is permanently lost.

Why use X-CloudBackup ?

Never worry again about losing your priceless X-Cart data with this convenient module that lets you set and forget regular backups that are automatically uploaded when and where you want. Ready to upgrade or make a change? Run a manual backup first “just in case” something goes wrong.

Key features

  1. One-click backup of your X-Cart data. With just one-click, you can back-up your X-Cart database, files or both—just configure your preferences and rest assured that your precious data will be safe.
  2. Automatic, regularly-scheduled backups.Schedule automatic back-ups as frequently as every day, or however often you like. Once you configure your settings, your data will automatically back up as scheduled – no chance of “forgetting” a vital backup and permanently losing irreplaceable data.
  3. Instant uploading to Dropbox or FTP server.Add an extra layer of protection by housing your back-up somewhere other than your primary server, so if something goes wrong with your server, your data will be safe. This module can automatically upload generated backups to Dropbox or any FTP server of your choice.

System requirements

To be able to successfully install and use the X-CloudBackup add-on module, you need to have an installed working copy of X-Cart 4.1.12, 4.2.3, 4.3.2, 4.4.0-4.4.5, 4.5.0 or later. Make sure that the version of the module is the same as the version of your installed copy of X-Cart.

Note: If you do not remember the version of X-Cart on which your store is based, you can look it up in the Environment info section of the Summary page in X-Cart Admin area.

Please note that X-Cart versions 4.2.3 and earlier do not support the star ratings feature out of the box (This feature is enabled by X-Cart's built-in module Customer Reviews starting with version 4.3.0; before version 4.3.0, the Customer Reviews module did not support the star ratings feature, but operated with ratings like "excellent", "very good", "good", etc). Accordingly, if you use the Rich Google Search Results add-on module in a store based on X-Cart 4.1.12 or 4.2.3, star ratings will not be included in the 'rich' format search results. However, the star ratings feature can be implemented in X-Cart versions 4.2.3 and earlier by installing the add-on module Advanced Customer Reviews. With the star ratings feature enabled by Advanced Customer Reviews, the 'rich' format search results will include star ratings even on versions 4.1.12 and 4.2.3.

Installing the Rich Google Search Results add-on module

Installation for X-Cart 4.4.x - 4.5.x

To install the module:

  1. Obtain the X-CloudBackup add-on module distribution package by downloading it from the File Area section of your X-Cart Account. The distribution package you need is contained in the archive file X-CloudBackup-x.y.z.tgz where x, y and z stand for X-Cart version (These need to match the version of X-Cart on which your store is based).
  2. Copy the distribution package to the X-Cart root directory on your server or hosting account.
    • If you use a Windows-based server, or a UNIX-based server without terminal access:
    a) Decompress the archive with the X-CloudBackup distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
    b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.
    • If you use a UNIX-based server with terminal access:
    a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account.
    b) Decompress the package using the following command:
    tar -xzvf X-CloudBackup-x.y.z.tgz
    Important: Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten!
  3. In a web browser, run the installation script httр://<YOUR_XCART_DOMAIN>/install-xbackup.php replacing the variable <YOUR_XCART_DOMAIN> with the actual domain name of your X-Cart based store.
  4. Enter the Auth code, accept the License Agreement and click the Next button.
  5. The installation script patches the files and activates the module. Click Next to continue the installation.
    Note: if you are using a custom skin, you will need to manually apply the patches to it. Otherwise, the module will not work in this skin. For more info, see How to patch a 3rd party skin after the installation of the X-CloudBackup module.
  6. The installation script generates a new system fingerprint. Click Next to complete the installation.
  7. Use the ADMINISTRATOR AREA link to log in to the Admin area.

Installation for X-Cart 4.1.12, 4.2.3, 4.3.2

To install the module:

  1. Obtain the X-CloudBackup add-on module distribution package by downloading it from the File Area section of your X-Cart Account. The distribution package you need is contained in the archive file x-rich-gsearch-results-x.y.z-without-installer.tgz where x, y and z stand for X-Cart version (These need to match the version of X-Cart on which your store is based).
  2. Copy the distribution package to the X-Cart root directory on your server or hosting account:
    • If you use a Windows-based server, or a UNIX-based server without terminal access:
    a) Decompress the archive with the X-CloudBackup distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
    b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.
    • If you use a UNIX-based server with terminal access:
    a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account.
    b) Decompress the package using the following command:
    tar -xzvf X-CloudBackup-x.y.z.tgz
    Important: Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten!
  3. In the X-Cart root directory locate the document 'INSTALL.X-CloudBackup' and use the instructions from this file to manually install the module.


Enabling the X-CloudBackup add-on module

After the X-CloudBackup add-on module installation has been completed, the module you have installed needs to be enabled in your store:

  1. In Admin area, go to the Modules section (Settings menu->Modules).
  2. Choose the X-CloudBackup module by selecting the respective check box on the left.
  3. Click the Apply changes button. This activates the module.




Configuring the X-CloudBackup add-on module

After the X-CloudBackup add-on module has been enabled in your store, you should check and adjust its configuration:

  1. In the Modules section (Settings menu->Modules), click the Configure link opposite the module name ('X-CloudBackup').
    The module configuration page (titled by the name of the module) opens:
    Settings cloud backup.png
  2. Adjust the settings on the module configuration page:

...................

  1. Click the Apply changes button to save the changes.





Configuring the X-CloudBackup add-on module

  1. In the Modules section (Settings menu->Modules), click the Configure link opposite the module name ('X-CloudBackup').
    The module configuration page (titled by the name of the module) opens:
    Manage cloud backup.png
  2. Adjust the settings on the module configuration page:

...................

  1. Click the Apply changes button to save the changes.