installation.rst

Installation

To install the :productname:`PayPal Checkout` payment module, follow different procedures depending on your OXID eShop version:

• If you have OXID eShop version 6.1.x or 6.2.x, install :productname:`PayPal Checkout` 1.3.x (see :ref:`installation:Installing PayPal Checkout for OXID eShop version 6.1.x or 6.2.x`).
• If you have OXID eShop version 6.3.x to 6.5.x, install :productname:`PayPal Checkout` 2.3.x. |br| For more Informationen, see the corresponding module documentation under Installing PayPal Checkout 2.3.x.
• If you have OXID eShop version 7.x, install :productname:`PayPal Checkout` 3.3.x. |br| For more Informationen, see the corresponding module documentation under Installing PayPal Checkout 3.3.x.

Earlier versions of OXID eShop are not supported.

Installing PayPal Checkout for OXID eShop version 6.1.x or 6.2.x

To install :productname:`PayPal Checkout` for OXID eShop version 6.1.x or 6.2.x, install :productname:`PayPal Checkout` V. 1.3.x.

|prerequisites|

• You have installed OXID eShop 6.1.x or 6.2.x.

• You have configured https.

  1. In the :file:`<root directory of the eShop>/source` directory, open the :file:`config.inc.php` file.

  2. Make sure that https is set for the base URL (:technicalname:`shopURL` parameter). |br| Example:

     $this->sShopURL = 'https://www.example.org';
     

|procedure|

1. Open a shell and change to the root directory of the eShop (where the file :file:`composer.json` is located). |br| Example:

   cd /var/www/oxideshop

2. Execute the following commands:

   composer require oxid-solution-catalysts/paypal-module ^1.3.0

3. Optional: To activate the module, run the following command. |br| Alternatively: Activate the module manually during configuration (see :ref:`configuration:Activating PayPal Checkout`).

   ./vendor/bin/oe-console oe:module:activate osc_paypal

|result|

When the installation process is finished, the module :guilabel:`PayPal Checkout for OXID` appears in the administration area under :menuselection:`Extensions --> Modules` (:ref:`oxdajq01`).

Figure: PayPal Checkout for OXID installed successfully

Installing a minor update

If you use a deprecated version, perform a minor update, for example from :productname:`PayPal Checkout` version 1.2.1 to version 1.3.0.

composer require oxid-solution-catalysts/paypal-module ^1.3.0
composer update

Installing a patch update

If required, install a patch update, from :productname:`PayPal Checkout` version 1.3.0 to version 1.3.1, for example.

|procedure|

1. Execute the following command:

   composer update

2. Confirm the prompt whether to overwrite the :file:`oxid-solution-catalysts/paypal-module` files.

Attention!

Checking country mappings after update to PayPal Checkout version 1.1.5

With version 1.1.5, the country coverage of individual :productname:`PayPal Checkout` payment methods has been extended.

Make sure that you can use the extended country coverage.

Background: With :productname:`PayPal Checkout` version 1.1.5, countries are automatically assigned to payment methods during initial installation (see :ref:`configuration:Optional: Configuring the country mapping of PayPal Checkout payment methods`).

This may cause configuration settings of your existing version to block the use of extended country mappings.

Do the following:

1. Choose :menuselection:`Shop Settings --> Payment Methods --> <payment method> --> Country --> Assign Countries`.
2. To use the entire country coverage of a payment type, delete existing mappings.