Installation

Installing UmbCheckout

Support for Umbraco 17 is planned for V2.1

UmbCheckout currently only supports Umbraco v10 or v13.

UmbCheckout is installed using the NuGet package manager using the below command:

dotnet add package UmbCheckout

Next, you need to enable .NET sessions, if not already enabled. To do this add the app.UseSession(); line to your startup.cs before app.UseUmbraco() It should look similar to the below:

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseSession();

    app.UseUmbraco()
        .WithMiddleware(u =>
        {
            u.UseBackOffice();
            u.UseWebsite();
        })
        .WithEndpoints(u =>
        {
            u.UseInstallerEndpoints();
            u.UseBackOfficeEndpoints();
            u.UseWebsiteEndpoints();
        });
}

You will also need to install a payment provider.

Alternatively, you can install using the NuGet package manager GUI within Visual Studio.

Upgrades

UmbCheckout uses Umbraco Migrations to install all of the tables required to function, this means that upgrades follow the same process as installation, you can either run the command found above or upgrade using the NuGet package manager GUI.

Installing a License

If you have purchased a license to enable more features, you simply need to add the following to your appsettings.json file:

  "UmbCheckout": {
    "LicenseKey": "YOUR LICENSE KEY HERE"
  }

Replacing YOUR LICENSE KEY HERE with the key found in your account here.

You are also required to configure the UmbracoApplicationUrl within the Web routing settings within your appsettings.json file

"Umbraco": {
  "CMS": {
    "WebRouting": {
      "UmbracoApplicationUrl": "http://www.mysite.com/"
    }
  }
}

When do I need a license?

UmbCheckout requires a license to use any of the Addon packages.

Using UmbCheckout without a license will disable the Tax Rates and disables being able to store the Basket in a Cookie or the Database.

Licensed sites will also be able to make use of the support ticketing system.

If you require a development license, please see this linked page.

(These restrictions may change in the future)