Difference between revisions of "X-Payments:Upgrading"

From X-Payments Help
Jump to: navigation, search
(Created page with "<noinclude>{{XP manual TOC}}</noinclude> Upgrading is done with the help of a special upgrade pack. If you are using a downloadable version of X-Payments, and your license all...")
 
m
Line 1: Line 1:
<noinclude>{{XP manual TOC}}</noinclude>
+
<noinclude>{{Template:XP manual TOC}}</noinclude>
Upgrading is done with the help of a special upgrade pack. If you are using a downloadable version of X-Payments, and your license allows you to upgrade to later versions, you will find this pack in the <u>File area</u> section of your {{QA}} (Look for a file named like '''upgrade.pack.xp.2.1.1.zip''' (ZIP-archive) or '''upgrade.pack.xp.2.1.1.tgz''' (TGZ-archive)).  
+
Upgrading is done with the help of a special upgrade pack. If you are using a downloadable version of X-Payments, and your license allows you to upgrade to later versions, you will find this pack in the <u>File area</u> section of your {{QA}} (Look for a file named like '''upgrade.pack.xp.2.2.0.zip''' (ZIP-archive) or '''upgrade.pack.xp.2.2.0.tgz''' (TGZ-archive)).  
 
<br /><br />
 
<br /><br />
 
'''To upgrade X-Payments, complete the following steps:'''
 
'''To upgrade X-Payments, complete the following steps:'''
 
# Download the X-Payments upgrade pack.  
 
# Download the X-Payments upgrade pack.  
 
# Connect to your X-Payments server via SSH.
 
# Connect to your X-Payments server via SSH.
# Create a directory '''<xpay-dir>/upgrade'''.
+
# Extract the X-Payments upgrade pack that you downloaded and upload the extracted pack contents to the root of your X-Payments installation.
# Extract the X-Payments upgrade pack that you downloaded and upload the extracted pack contents to the directory '''<xpay-dir>/upgrade''' that you created at the previous step. The directory should now contain the following items:
+
# Run the script '''<xpay-dir>/upgrade/upgrade.php''' via the command line as follows:<br />&nbsp;&nbsp;&nbsp;'''php upgrade.php'''<br />The upgrade script will detect your current version automatically and will offer an upgrade to the latest X-Payments version available to you. You will only need to confirm your request by entering "y" (Use "n" to cancel the operation).<br />If necessary, the following parameters may be specified:<br />
#* changes
+
#* -vX.X.X - the version to which you want to upgrade; for example, "-v2.2.0";
#* source
+
#* -oY.Y.Y - the version from which you are upgrading; for example, "-o2.1.3" (This parameter should be used if, for example, the version in the config/config.ini.php file of your X-Payments installation is specified incorrectly);
#* upgrade.php
+
#* -y - specify this to skip the step where you need to confirm your intention to upgrade (where you need to enter y/n).<br />For example, to upgrade from version 1.0.4 to 1.0.6, you will need to use the command<br />&nbsp;&nbsp;&nbsp;'''php upgrade.php -o1.0.4 -v1.0.6'''<br />The upgrade script will recognize the following X-Payments versions: 1.0.3, 1.0.4, 1.0.5, 1.0.6, 2.0.0, 2.0.1, 2.1.0, 2.1.1, 2.1.2, 2.1.3, 2.2.0.<br />Note that for X-Payments versions 1.0.3 and 1.0.4 you ''must'' specify the version from which you are upgrading using the -o parameter, since the config/config.ini.php file of these versions does not contain the version information upgrade.php expects to find there.<br />
# Run the script '''upgrade.php''' via the command line specifying the current version of your X-Payments installation and the version to which you want to upgrade. Make sure the destination version is greater than the current one.<br />For example:<br />&nbsp; $ php upgrade.php 1.0.5 1.0.6<br />&nbsp; $ php upgrade.php 1.0.6 2.0.1<br />&nbsp; $ php upgrade.php 2.0.0 2.1.3<br /><br />To date, the following X-Payments versions have been released: 1.0.3, 1.0.4, 1.0.5, 1.0.6, 2.0.0, 2.0.1, 2.1.0, 2.1.1, 2.1.2, 2.1.3; the script will only recognize the versions specified here.<br /><br />X-Payments 1.0.3 and 1.0.4 users may need to add the '--force' option; for example:<br />&nbsp; $ php upgrade.php 1.0.3 2.1.3 --force<br />{{Note1|'''Note''': The upgrade script matches the number of the current version you enter against the version number specified in the config/config.ini.php file of your X-Payments installation and only continues with the upgrade if the versions actually match. The config/config.ini.php of X-Payments 1.0.3 and 1.0.4 does not contain the information upgrade.php expects to find there, so the upgrade process will fail unless you use '--force'.}}
+
Once the script is run, it will create a backup of your X-Payments installation and carry out the upgrade for you.  
The script will create a backup of your X-Payments installation and carry out the upgrade for you.  
+
After upgrading has been completed, be sure to remove the directory '''<xpay-dir>/upgrade/''' (That is done for security purposes; remember that X-Payments must be a stand alone service on a separate server, so you must not keep other applications - including the upgrade script - on the same server while using it).
Once the upgrade process has been completed, remove the directory '''<xpay-dir>/upgrade/''' (That is done for security purposes; remember that X-Payments must be a stand alone service on a separate server, so you must not keep other applications - including the upgrade script - on the same server while using it).
 
  
 
In case of any issues, you can find your backup in the directory '''<xpay-dir>/var/backup/'''.
 
In case of any issues, you can find your backup in the directory '''<xpay-dir>/var/backup/'''.
Line 18: Line 17:
  
 
<noinclude>{{pdf_single}}</noinclude>
 
<noinclude>{{pdf_single}}</noinclude>
 +
  
 
[[Category:X-Payments User Manual]]
 
[[Category:X-Payments User Manual]]

Revision as of 17:35, 7 August 2015

X-Payments user manual
  1. X-Payments:General information
  2. What's New
  3. System requirements
  4. Installation
  5. Two-factor user authentication
  6. Configuring X-Payments
  7. Managing users
  8. Customizing the interface
  9. Managing payments
  10. Unistalling X-Payments
  11. Upgrading
  12. Moving X-Payments from one host to another
  13. Viewing X-Payments logs
  14. FAQ
  15. Troubleshooting
  16. Glossary
  17. Supported payment gateways
  18. Popular Payment Methods Configuration Instructions

Upgrading is done with the help of a special upgrade pack. If you are using a downloadable version of X-Payments, and your license allows you to upgrade to later versions, you will find this pack in the File area section of your X-Cart Account (Look for a file named like upgrade.pack.xp.2.2.0.zip (ZIP-archive) or upgrade.pack.xp.2.2.0.tgz (TGZ-archive)).

To upgrade X-Payments, complete the following steps:

  1. Download the X-Payments upgrade pack.
  2. Connect to your X-Payments server via SSH.
  3. Extract the X-Payments upgrade pack that you downloaded and upload the extracted pack contents to the root of your X-Payments installation.
  4. Run the script <xpay-dir>/upgrade/upgrade.php via the command line as follows:
       php upgrade.php
    The upgrade script will detect your current version automatically and will offer an upgrade to the latest X-Payments version available to you. You will only need to confirm your request by entering "y" (Use "n" to cancel the operation).
    If necessary, the following parameters may be specified:
    • -vX.X.X - the version to which you want to upgrade; for example, "-v2.2.0";
    • -oY.Y.Y - the version from which you are upgrading; for example, "-o2.1.3" (This parameter should be used if, for example, the version in the config/config.ini.php file of your X-Payments installation is specified incorrectly);
    • -y - specify this to skip the step where you need to confirm your intention to upgrade (where you need to enter y/n).
      For example, to upgrade from version 1.0.4 to 1.0.6, you will need to use the command
         php upgrade.php -o1.0.4 -v1.0.6
      The upgrade script will recognize the following X-Payments versions: 1.0.3, 1.0.4, 1.0.5, 1.0.6, 2.0.0, 2.0.1, 2.1.0, 2.1.1, 2.1.2, 2.1.3, 2.2.0.
      Note that for X-Payments versions 1.0.3 and 1.0.4 you must specify the version from which you are upgrading using the -o parameter, since the config/config.ini.php file of these versions does not contain the version information upgrade.php expects to find there.

Once the script is run, it will create a backup of your X-Payments installation and carry out the upgrade for you. After upgrading has been completed, be sure to remove the directory <xpay-dir>/upgrade/ (That is done for security purposes; remember that X-Payments must be a stand alone service on a separate server, so you must not keep other applications - including the upgrade script - on the same server while using it).

In case of any issues, you can find your backup in the directory <xpay-dir>/var/backup/.


PDF button.png This article can be downloaded as a PDF file