> For the complete documentation index, see [llms.txt](https://docs.umbcheckout.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.umbcheckout.net/getting-started/installation.md).

# Installation

Installing UmbCheckout

{% hint style="info" %}
These pages are for UmbCheckout 1.x on Umbraco 10 and 13. For Umbraco 17, choose **UmbCheckout 17** in the version menu at the top of the page.
{% endhint %}

**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:

```csharp
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](/payment-providers/payment-providers.md).

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:

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

*Replacing* `YOUR LICENSE KEY HERE` *with the key found in your* [*UmbPanel account*](https://www.umbpanel.io)*.*

You are also required to configure the [UmbracoApplicationUrl](https://docs.umbraco.com/umbraco-cms/reference/configuration/webroutingsettings#umbraco-application-url) within the [Web routing settings](https://docs.umbraco.com/umbraco-cms/reference/configuration/webroutingsettings) 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.

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

{% hint style="info" %}
**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](/getting-started/developer-license.md). On your own machine you can also use [development mode](/getting-started/license-checks.md#development-mode).

Licensed features only work for the domains on your license. See [License Checks](/getting-started/license-checks.md).

*(These restrictions may change in the future)*
{% endhint %}