Previous Docs Version

The documentation you are viewing is for a previous version of the Vendr product. Click here to jump to the current stable version.

Installation

Installing Vendr, the eCommerce solution for Umbraco v8+

There are currently two ways to install Vendr into your solution. Using the Umbraco package distribution of Vendr, 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 Vendr Umbraco package, you can navigate to the Packages section in your back-office and then search to find the Vendr package in the central Umbraco package repository. Once located, you can click the package entry and follow the on-screen instructions provided to complete the install.

Installing Vendr via Local Umbraco Package

Alternatively, you can download the Umbraco package file from the Umbraco Developer Portal and install it manually 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 Vendr via Local Umbraco Package

NuGet Package Installation

Vendr is also available via NuGet.Org.

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

PM> Install-Package Vendr

Alternatively, you can also find and install the NuGet package via the NuGet Package Manager GUI. You will see a number of packages available, however you will want to install the main Vendr package.

Installing Vendr via the NuGet Package Manager GUI

For most basic sites using a single solution/project, this should be all you need to install Vendr into your project. If you have a more complex solution structure however, consisting of multiple projects, Vendr is available in multiple sub-packages with varying dependencies.

  • Vendr.Core The core Vendr functionality that doesn't require a web context.
  • Vendr.Web The core Vendr functionality that requires a web context.
  • Vendr The main Vendr package containing all DLL's and web project files.

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.

Installing a License

Once you have purchased a license you can install it by dropping the license file directly into your sites App_Data folder. Vendr will automatically scan this directory for any valid licenses.

If you need to store your licenses in an alternative directory, you can change where Vendr looks for licenses by setting a UmbracoLicensesDirectory app setting with a path to the alternative location.

If you are using an Umbraco Cloud website, please note that the UmbracoLicensesDirectory is automatically set to ~\App_Plugins\UmbracoLicenses\ so when using Vendr on an Umbraco Cloud site you should place your licenses in this directory and not the default App_Data folder.

You only need to install a license when you are ready to go live.

Vendr is fully functional during development, and whilst it is hosted on a local server (localhost or .local domains).

You can also host a staging site on a *.azurewebsite.net or *.umbraco.io domain without the need of a license.

Hosting on any other public domains without a license will be limited to a maximum of 20 orders.

If you require an unrestricted staging environment, all licenses support two methods of allowing this:

  • staging.client.com - Licenses allow unlimited subdomains so you can host the staging site on a subdomain of the licensed domain
  • clientcom.agency.com - Licenses allow a concatenation of the licensed domain as a subdomain of any other domain

If you wish to host the site on any other URL, then an additional license file will be required for that domain.

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.