Installation

Documentation for the Square Checkout payment provider for Vendr, the eCommerce solution for Umbraco v8+

There are currently two ways to install the Square payment provider for Vendr into your solution. Using the Umbraco package distribution, installed via the Umbraco back-office, or using our NuGet packages, installed directly into your projects code base via the NuGet Package Manager. Where possible, it is our recommendation to use the NuGet packages as these allow a great level of ease/control when upgrading later on.

Umbraco Package Installation

To install the Square payment provider Umbraco package, you will need to download the package file manually from the Vendr package page on the Umbraco Developer Portal. On this page, scroll down to the Package Files section and locate the Square payment provider package, clicking it to initiate a download.

Umbraco package files list

Once downloaded you should manually install the package by uploading it to the local package installer located in your back-office Packages > Install Local section. Once uploaded, follow the on-screen instructions provided to complete the install.

Installing an Umbraco Package via Local Umbraco Package

NuGet Package Installation

To install the Square payment provider via NuGet you can run the following command directly in the NuGet Manager Console window:

PM> Install-Package Vendr.Contrib.PaymentProviders.Square

Alternatively, you can also find and install the NuGet package via the NuGet Package Manager GUI.

Installing Vendr via the NuGet Package Manager GUI

Upgrading

Before upgrading, it is always advisable to take a complete backup of your site/database. Every effort has been made to ensure that Vendr will upgrade gracefully, but there is always a risk that something may not install as expected.

Vendr uses Umbraco Migrations to install all of it's features meaning upgrades follow the exact same process as the installation processes detailed above, installing the latest version of a package over the top of the existing package installation. Vendr is then clever enough to detect the current state of your site and only install the features that are missing.

Edit this page on GitHub

Site + logo design © 2021 Outfield Digital Ltd. Content contributions licensed under MIT.
Vendr® is a Registered Trademark of Outfield Digital Ltd.