Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions 15/umbraco-commerce/getting-started/the-licensing-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,16 @@ If you require to add addition domains to the license, [reach out the sales team
Once you have received your license code it needs to be installed on your site.

1. Open the root directory for your project files.
2. Locate and open the `appSettings.json` file.
2. Locate and open the `appsettings.json` file.
3. Add your Umbraco Commerce license key to `Umbraco:Licenses:Products:Umbraco.Commerce`:

```json
"Umbraco": {
"Licenses": {
"Products": {
"Umbraco.Commerce": "YOUR_LICENSE_KEY"
{
"Umbraco": {
"Licenses": {
"Products": {
"Umbraco.Commerce": "YOUR_LICENSE_KEY"
}
}
}
}
Expand All @@ -90,7 +92,7 @@ If you are running on a single domain for both your frontend and backend environ
If you have different domains for your frontend and backend, then it's advised that you configure an `UmbracoApplicationUrl` set to your backoffice URL. This helps the licensing engine know which URL should be used for validation checks. Without this configuration setting, the licensing engine will try and work out the domain to validate from the HTTP request object. This can lead to errors when switching between domains.


An `UmbracoApplicationUrl` can be configured in your `appSettings.json` file like so:
An `UmbracoApplicationUrl` can be configured in your `appsettings.json` file like so:

```json
{
Expand All @@ -108,7 +110,7 @@ See the [Fixed Application URL](https://docs.umbraco.com/umbraco-cms/extending/h

#### Configuring `UmbracoApplicationUrl` on Umbraco Cloud

If you are hosting on Umbraco Cloud you will find the configuration described above won't be reflected in your environment. The reason for this is that Umbraco Cloud sets this value as an environment variable set to the Cloud project domain (`<your project>.umbraco.io`). This overrides what is set via the `appSettings.json` file.
If you are hosting on Umbraco Cloud you will find the configuration described above won't be reflected in your environment. The reason for this is that Umbraco Cloud sets this value as an environment variable set to the Cloud project domain (`<your project>.umbraco.io`). This overrides what is set via the `appsettings.json` file.

There are two options in this case:
- Either the domains for each of your Cloud environments can be added to your license.
Expand All @@ -134,19 +136,20 @@ If such a change is not feasible, there is another approach you can use.

You will need to have a server, or serverless function, that is running and can make a request to the online license validation service. That needs to run on a daily schedule, making a request and relaying it onto the restricted Umbraco environment.

To set this up, firstly ensure you have a reference to `Umbraco.Licenses` version 13.1 or higher. If the version of Commerce you are using depends on an earlier version, you can add a direct package reference for `Umbraco.Licenses`.

Then configure a random string as an authorization key in configuration. This is used as protection to ensure only valid requests are handled. You can also disable the normal regular license checks - as there is no point in these running if they will be blocked:

```json
{
"Umbraco": {
"Licenses": {
"Umbraco.Commerce": "<your license key>"
},
"LicensesOptions": {
"Products": {
"Umbraco.Commerce": "<your license key>"
},
"EnableScheduledValidation": false,
"ValidatedLicenseRelayAuthKey": "<your authorization key>"
}
}
}
```

Your Internet-enabled server should make a request of the following form to the online license validation service:
Expand Down
13 changes: 6 additions & 7 deletions 15/umbraco-deploy/installation/the-licensing-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ You can look at the pricing, plans, features, and purchase the license on the [U

Once you've configured your license with the correct domains, you are ready to install the license on your Umbraco installation.

For Umbraco Deploy On-Premise 12 and above, this will be a key provided to you when taking out your subscription to the product. It should be added to your configuration at the key `Umbraco:Licenses:Umbraco.Deploy.OnPrem`.
For Umbraco Deploy On-Premise 12 and above, this will be a key provided to you when taking out your subscription to the product. It should be added to your configuration at the key `Umbraco:Licenses:Products:Umbraco.Deploy.OnPrem`.

For example, in `appsettings.json`:

Expand Down Expand Up @@ -95,7 +95,7 @@ If you are running on a single domain for both your frontend and backend environ

If you have different domains for your frontend and backend, then it's advised that you configure an `UmbracoApplicationUrl` set to your backoffice URL. This helps the licensing engine know which URL should be used for validation checks. Without this configuration setting, the licensing engine will try and work out the domain to validate from the HTTP request object. This can lead to errors when switching between domains.

An `UmbracoApplicationUrl` can be configured in your `appSettings.json` file like so:
An `UmbracoApplicationUrl` can be configured in your `appsettings.json` file like so:

```json
{
Expand Down Expand Up @@ -123,21 +123,20 @@ If such a change is not feasible, there is another approach you can use.

You will need to have a server, or serverless function, that is running and can make a request to the online license validation service. That needs to run on a daily schedule, making a request and relaying it onto the restricted Umbraco environment.

To set this up, firstly ensure you have a reference to `Umbraco.Licenses` version 13.1 or higher. This will be the case if you are running Umbraco Deploy 13.1 or higher. If you are on an earlier version, you can add a direct package reference for `Umbraco.Licenses`.

Then configure a random string as an authorization key in configuration. This is used as protection to ensure only valid requests are handled. You can also disable the normal regular license checks - as there is no point in these running if they will be blocked:

```json
{
"Umbraco": {
"Licenses": {
"Products": {
"Umbraco.Deploy.OnPrem": "<your license key>"
}
},
"LicensesOptions": {
},
"EnableScheduledValidation": false,
"ValidatedLicenseRelayAuthKey": "<your authorization key>"
}
}
}
```

Your Internet enabled server should make a request of the following form to the online license validation service:
Expand Down
2 changes: 1 addition & 1 deletion 15/umbraco-forms/installation/the-licensing-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ You can install multiple Umbraco Forms license files without merging them. Place

If you can't include the license file in the `/umbraco/Licenses` directory for any reason, it is possible to configure an alternative location for the file.

It can be configured in the Umbraco installation's `appSettings.json` file by adding the following configuration:
It can be configured in the Umbraco installation's `appsettings.json` file by adding the following configuration:

```json
{
Expand Down
25 changes: 14 additions & 11 deletions 15/umbraco-ui-builder/getting-started/licensing-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ There are a few differences as to what the licenses cover:
* The license also includes `localhost` and `*.local` as a valid domain.

{% hint style="info" %}
If you have multiple backoffice domains pointing at the same installation, you can purchase and [add **additional domains**](licensing-model.md#add-additional-domains) to your license.
If you have multiple backoffice domains pointing at the same installation, you can purchase and [add **additional domains**](licensing-model.md#adding-additional-domains) to your license.

This is an add-on domain for existing licenses. Refunds will not be given for this product.
{% endhint %}
Expand All @@ -62,15 +62,17 @@ If you require to add additional domains to the license, [reach out to the sales
Once you have received your license code it needs to be installed on your site.

1. Open the root directory of your project files.
2. Locate and open the `appSettings.json` file.
2. Locate and open the `appsettings.json` file.
3. Add your Umbraco UI builder license key under `Umbraco:Licenses:Products:Umbraco.UIBuilder`:

```json
"Umbraco": {
{
"Umbraco": {
"Licenses": {
"Products": {
"Umbraco.UIBuilder": "YOUR_LICENSE_KEY"
}
"Products": {
"Umbraco.UIBuilder": "YOUR_LICENSE_KEY"
}
}
}
}
```
Expand Down Expand Up @@ -104,19 +106,20 @@ If such a change is not feasible, there is another approach you can use.

You will need to have a server, or serverless function, that is running and can make a request to the online license validation service. That needs to run on a daily schedule, making a request and relaying it onto the restricted Umbraco environment.

To set this up, firstly ensure you have a reference to `Umbraco.Licenses` version 13.1 or higher. If the version of UIBuilder you are using depends on an earlier version, you can add a direct package reference for `Umbraco.Licenses`.

Then configure a random string as an authorization key in configuration. This is used as protection to ensure only valid requests are handled. You can also disable the normal regular license checks - as there is no point in these running if they will be blocked:

```json
{
"Umbraco": {
"Licenses": {
"Umbraco.UIBuilder": "<your license key>"
},
"LicensesOptions": {
"Products": {
"Umbraco.UIBuilder": "<your license key>"
},
"EnableScheduledValidation": false,
"ValidatedLicenseRelayAuthKey": "<your authorization key>"
}
}
}
```

Your Internet enabled server should make a request of the following form to the online license validation service:
Expand Down
42 changes: 22 additions & 20 deletions 15/umbraco-workflow/installation/licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,16 @@ In the free version, a maximum of five approval groups can be created.
Once you have received your license code it needs to be installed on your site.

1. Open the root directory for your project files.
2. Locate and open the `appSettings.json` file.
3. Add your Umbraco Workflow license key to `Umbraco:Licenses:Umbraco.Workflow`:
2. Locate and open the `appsettings.json` file.
3. Add your Umbraco Workflow license key to `Umbraco:Licenses:Products:Umbraco.Workflow`:

```json
"Umbraco": {
"Licenses": {
"Products": {
"Umbraco.Workflow": "YOUR_LICENSE_KEY"
{
"Umbraco": {
"Licenses": {
"Products": {
"Umbraco.Workflow": "YOUR_LICENSE_KEY"
}
}
}
}
Expand All @@ -59,25 +61,25 @@ If you are running on a single domain for both your frontend and backend environ

If you have different domains for your frontend and backend, then it's advised that you configure an `UmbracoApplicationUrl` set to your backoffice URL. This helps the licensing engine know which URL should be used for validation checks. Without this configuration setting, the licensing engine will try and work out the domain to validate from the HTTP request object. This can lead to errors when switching between domains.

An `UmbracoApplicationUrl` can be configured in your `appSettings.json` file like so:
An `UmbracoApplicationUrl` can be configured in your `appsettings.json` file like so:

```json
{
"Umbraco": {
"CMS": {
"WebRouting": {
"UmbracoApplicationUrl": "https://admin.my-custom-domain.com/"
}
}
"Umbraco": {
"CMS": {
"WebRouting": {
"UmbracoApplicationUrl": "https://admin.my-custom-domain.com/"
}
}
}
}
```

See the [Fixed Application URL](https://docs.umbraco.com/umbraco-cms/extending/health-check/guides/fixedapplicationurl) documentation for more details about this setting.

#### Configuring `UmbracoApplicationUrl` on Umbraco Cloud

If you are hosting on Umbraco Cloud you will find the configuration described above won't be reflected in your environment. The reason for this is that Umbraco Cloud sets this value as an environment variable set to the Cloud project domain (`<your project>.umbraco.io`). This overrides what is set via the `appSettings.json` file.
If you are hosting on Umbraco Cloud, you will find that the configuration described above won't be reflected in your environment. The reason for this is that Umbraco Cloud sets this value as an environment variable set to the Cloud project domain (`<your project>.umbraco.io`). This overrides what is set via the `appsettings.json` file.

There are two options in this case:
- Either the domains for each of your Cloud environments can be added to your license.
Expand All @@ -95,7 +97,7 @@ In practice, you will probably want to make this a bit more sophisticated. You c

The trial license introduces some restrictions around advanced features but is otherwise a full-featured workflow platform. The paid license is valid for one top-level domain and all its subdomains.

To impersonate the full license on a local site, set `EnableTestLicense` to `true` in the `appSettings.json` file:
To impersonate the full license on a local site, set `EnableTestLicense` to `true` in the `appsettings.json` file:

```json
{
Expand Down Expand Up @@ -123,20 +125,20 @@ If such a change is not feasible, there is another approach you can use.

You will need to have a server, or serverless function, that is running and can make a request to the online license validation service. That needs to run on a daily schedule, making a request and relaying it onto the restricted Umbraco environment.

To set this up, firstly ensure you have a reference to `Umbraco.Licenses` version 13.1 or higher. If the version of Workflow you are using depends on an earlier version, you can add a direct package reference for `Umbraco.Licenses`.

Then configure a random string as an authorization key in configuration. This is used as protection to ensure only valid requests are handled. You can also disable the normal regular license checks - as there is no point in these running if they will be blocked:

```json
{
"Umbraco": {
"Licenses": {
"Umbraco.Workflow": "<your license key>"
},
"LicensesOptions": {
"Products": {
"Umbraco.Workflow": "<your license key>"
},
"EnableScheduledValidation": false,
"ValidatedLicenseRelayAuthKey": "<your authorization key>"
}
}
}
```

Your Internet enabled server should make a request of the following form to the online license validation service:
Expand Down
17 changes: 9 additions & 8 deletions 16/umbraco-commerce/getting-started/the-licensing-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ If you require to add addition domains to the license, [reach out the sales team
Once you have received your license code it needs to be installed on your site.

1. Open the root directory for your project files.
2. Locate and open the `appSettings.json` file.
2. Locate and open the `appsettings.json` file.
3. Add your Umbraco Commerce license key to `Umbraco:Licenses:Products:Umbraco.Commerce`:

```json
Expand Down Expand Up @@ -90,7 +90,7 @@ If you are running on a single domain for both your frontend and backend environ
If you have different domains for your frontend and backend, then it's advised that you configure an `UmbracoApplicationUrl` set to your backoffice URL. This helps the licensing engine know which URL should be used for validation checks. Without this configuration setting, the licensing engine will try and work out the domain to validate from the HTTP request object. This can lead to errors when switching between domains.


An `UmbracoApplicationUrl` can be configured in your `appSettings.json` file like so:
An `UmbracoApplicationUrl` can be configured in your `appsettings.json` file like so:

```json
{
Expand All @@ -108,7 +108,7 @@ See the [Fixed Application URL](https://docs.umbraco.com/umbraco-cms/extending/h

#### Configuring `UmbracoApplicationUrl` on Umbraco Cloud

If you are hosting on Umbraco Cloud you will find the configuration described above won't be reflected in your environment. The reason for this is that Umbraco Cloud sets this value as an environment variable set to the Cloud project domain (`<your project>.umbraco.io`). This overrides what is set via the `appSettings.json` file.
If you are hosting on Umbraco Cloud you will find the configuration described above won't be reflected in your environment. The reason for this is that Umbraco Cloud sets this value as an environment variable set to the Cloud project domain (`<your project>.umbraco.io`). This overrides what is set via the `appsettings.json` file.

There are two options in this case:
- Either the domains for each of your Cloud environments can be added to your license.
Expand All @@ -134,19 +134,20 @@ If such a change is not feasible, there is another approach you can use.

You will need to have a server, or serverless function, that is running and can make a request to the online license validation service. That needs to run on a daily schedule, making a request and relaying it onto the restricted Umbraco environment.

To set this up, firstly ensure you have a reference to `Umbraco.Licenses` version 13.1 or higher. If the version of Commerce you are using depends on an earlier version, you can add a direct package reference for `Umbraco.Licenses`.

Then configure a random string as an authorization key in configuration. This is used as protection to ensure only valid requests are handled. You can also disable the normal regular license checks - as there is no point in these running if they will be blocked:

```json
{
"Umbraco": {
"Licenses": {
"Umbraco.Commerce": "<your license key>"
},
"LicensesOptions": {
"Products": {
"Umbraco.Commerce": "<your license key>"
},
"EnableScheduledValidation": false,
"ValidatedLicenseRelayAuthKey": "<your authorization key>"
}
}
}
```

Your Internet-enabled server should make a request of the following form to the online license validation service:
Expand Down
13 changes: 6 additions & 7 deletions 16/umbraco-deploy/installation/the-licensing-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ You can look at the pricing, plans, features, and purchase the license on the [U

Once you've configured your license with the correct domains, you are ready to install the license on your Umbraco installation.

For Umbraco Deploy On-Premise 12 and above, this will be a key provided to you when taking out your subscription to the product. It should be added to your configuration at the key `Umbraco:Licenses:Umbraco.Deploy.OnPrem`.
For Umbraco Deploy On-Premise 12 and above, this will be a key provided to you when taking out your subscription to the product. It should be added to your configuration at the key `Umbraco:Licenses:Products:Umbraco.Deploy.OnPrem`.

For example, in `appsettings.json`:

Expand Down Expand Up @@ -95,7 +95,7 @@ If you are running on a single domain for both your frontend and backend environ

If you have different domains for your frontend and backend, then it's advised that you configure an `UmbracoApplicationUrl` set to your backoffice URL. This helps the licensing engine know which URL should be used for validation checks. Without this configuration setting, the licensing engine will try and work out the domain to validate from the HTTP request object. This can lead to errors when switching between domains.

An `UmbracoApplicationUrl` can be configured in your `appSettings.json` file like so:
An `UmbracoApplicationUrl` can be configured in your `appsettings.json` file like so:

```json
{
Expand Down Expand Up @@ -123,21 +123,20 @@ If such a change is not feasible, there is another approach you can use.

You will need to have a server, or serverless function, that is running and can make a request to the online license validation service. That needs to run on a daily schedule, making a request and relaying it onto the restricted Umbraco environment.

To set this up, firstly ensure you have a reference to `Umbraco.Licenses` version 13.1 or higher. This will be the case if you are running Umbraco Deploy 13.1 or higher. If you are on an earlier version, you can add a direct package reference for `Umbraco.Licenses`.

Then configure a random string as an authorization key in configuration. This is used as protection to ensure only valid requests are handled. You can also disable the normal regular license checks - as there is no point in these running if they will be blocked:

```json
{
"Umbraco": {
"Licenses": {
"Products": {
"Umbraco.Deploy.OnPrem": "<your license key>"
}
},
"LicensesOptions": {
},
"EnableScheduledValidation": false,
"ValidatedLicenseRelayAuthKey": "<your authorization key>"
}
}
}
```

Your Internet enabled server should make a request of the following form to the online license validation service:
Expand Down
Loading
Loading