Skip to content
UmbCheckout Documentation

Installation

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

Section titled “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

Section titled “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 UmbPanel account.

You are also required to configure the UmbracoApplicationUrl within the Web routing settings within your appsettings.json file. It must be an absolute http or https URL, and its host must be one of the domains on your license.

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