Skip to content

Commit 9807ba1

Browse files
Fix incorrect product license configuration keys on v16
1 parent 712b23e commit 9807ba1

File tree

6 files changed

+71
-57
lines changed

6 files changed

+71
-57
lines changed

16/umbraco-commerce/getting-started/the-licensing-model.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ If you require to add addition domains to the license, [reach out the sales team
5656
Once you have received your license code it needs to be installed on your site.
5757

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

6262
```json
@@ -90,7 +90,7 @@ If you are running on a single domain for both your frontend and backend environ
9090
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.
9191

9292

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

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

109109
#### Configuring `UmbracoApplicationUrl` on Umbraco Cloud
110110

111-
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.
111+
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.
112112

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

135135
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.
136136

137-
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`.
138-
139137
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:
140138

141139
```json
140+
{
142141
"Umbraco": {
143142
"Licenses": {
144-
"Umbraco.Commerce": "<your license key>"
145-
},
146-
"LicensesOptions": {
143+
"Products": {
144+
"Umbraco.Commerce": "<your license key>"
145+
},
147146
"EnableScheduledValidation": false,
148147
"ValidatedLicenseRelayAuthKey": "<your authorization key>"
149148
}
149+
}
150+
}
150151
```
151152

152153
Your Internet-enabled server should make a request of the following form to the online license validation service:

16/umbraco-deploy/installation/the-licensing-model.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ You can look at the pricing, plans, features, and purchase the license on the [U
5050

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

53-
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`.
53+
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`.
5454

5555
For example, in `appsettings.json`:
5656

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

9696
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.
9797

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

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

124124
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.
125125

126-
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`.
127-
128126
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:
129127

130128
```json
129+
{
131130
"Umbraco": {
132131
"Licenses": {
133132
"Products": {
134133
"Umbraco.Deploy.OnPrem": "<your license key>"
135-
}
136-
},
137-
"LicensesOptions": {
134+
},
138135
"EnableScheduledValidation": false,
139136
"ValidatedLicenseRelayAuthKey": "<your authorization key>"
140137
}
138+
}
139+
}
141140
```
142141

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

16/umbraco-engage/installation/licensing.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,17 @@ To add additional domains to your license, [reach out to the sales team](https:/
6262
Once you have received your license code, it needs to be installed on your site.
6363

6464
1. Open the root directory for your project files.
65-
2. Locate and open the `appSettings.json` file.
66-
3. Add your Umbraco Engage license key to `Umbraco:Licenses:Umbraco.Engage`:
65+
2. Locate and open the `appsettings.json` file.
66+
3. Add your Umbraco Engage license key to `Umbraco:Licenses:Products:Umbraco.Engage`:
6767

6868
```json
69-
"Umbraco": {
70-
"Licenses": {
71-
"Umbraco.Engage": "YOUR_LICENSE_KEY"
69+
{
70+
"Umbraco": {
71+
"Licenses": {
72+
"Products": {
73+
"Umbraco.Engage": "YOUR_LICENSE_KEY"
74+
}
75+
}
7276
}
7377
}
7478
```
@@ -95,7 +99,7 @@ If you are running on a single domain for both your frontend and backend environ
9599

96100
If you have different domains for your frontend and backend, then it's advised that you configure `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.
97101

98-
An `UmbracoApplicationUrl` can be configured in your `appSettings.json` file like so:
102+
An `UmbracoApplicationUrl` can be configured in your `appsettings.json` file like so:
99103

100104
```json
101105
{

16/umbraco-forms/installation/the-licensing-model.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,12 +123,14 @@ Once you have received your license code it needs to be installed on your site.
123123

124124
1. Open the root directory for your project files.
125125
2. Locate and open the `appsettings.json` file.
126-
3. Add your Umbraco Forms license key to `Umbraco:Licenses:Umbraco.Forms`:
126+
3. Add your Umbraco Forms license key to `Umbraco:Licenses:Products:Umbraco.Forms`:
127127

128128
```json
129129
"Umbraco": {
130130
"Licenses": {
131-
"Umbraco.Forms": "YOUR_LICENSE_KEY"
131+
"Products": {
132+
"Umbraco.Forms": "YOUR_LICENSE_KEY"
133+
}
132134
}
133135
}
134136
```
@@ -151,7 +153,7 @@ If you are running on a single domain for both your frontend and backend environ
151153

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

154-
An `UmbracoApplicationUrl` can be configured in your `appSettings.json` file like so:
156+
An `UmbracoApplicationUrl` can be configured in your `appsettings.json` file like so:
155157

156158
```json
157159
{
@@ -201,14 +203,17 @@ Then configure a random string as an authorization key in the configuration. Thi
201203
Alternatively, you can also disable the normal regular license checks, as there is no point in these running if they will be blocked:
202204

203205
```json
206+
{
204207
"Umbraco": {
205208
"Licenses": {
206-
"Umbraco.Forms": "<your license key>"
207-
},
208-
"LicensesOptions": {
209+
"Products": {
210+
"Umbraco.Forms": "<your license key>"
211+
},
209212
"EnableScheduledValidation": false,
210213
"ValidatedLicenseRelayAuthKey": "<your authorization key>"
211214
}
215+
}
216+
}
212217
```
213218

214219
Your Internet-enabled server requests the following form from the online license validation service:

16/umbraco-ui-builder/getting-started/licensing-model.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,17 @@ If you require to add additional domains to the license, [reach out to the sales
6262
Once you have received your license code it needs to be installed on your site.
6363

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

6868
```json
69-
"Umbraco": {
69+
{
70+
"Umbraco": {
7071
"Licenses": {
71-
"Products": {
72-
"Umbraco.UIBuilder": "YOUR_LICENSE_KEY"
73-
}
72+
"Products": {
73+
"Umbraco.UIBuilder": "YOUR_LICENSE_KEY"
74+
}
75+
}
7476
}
7577
}
7678
```
@@ -104,19 +106,20 @@ If such a change is not feasible, there is another approach you can use.
104106

105107
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.
106108

107-
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`.
108-
109109
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:
110110

111111
```json
112+
{
112113
"Umbraco": {
113114
"Licenses": {
114-
"Umbraco.UIBuilder": "<your license key>"
115-
},
116-
"LicensesOptions": {
115+
"Products": {
116+
"Umbraco.UIBuilder": "<your license key>"
117+
},
117118
"EnableScheduledValidation": false,
118119
"ValidatedLicenseRelayAuthKey": "<your authorization key>"
119120
}
121+
}
122+
}
120123
```
121124

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

16/umbraco-workflow/installation/licensing.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,16 @@ In the free version, a maximum of five approval groups can be created.
2626
Once you have received your license code it needs to be installed on your site.
2727

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

3232
```json
33-
"Umbraco": {
34-
"Licenses": {
35-
"Products": {
36-
"Umbraco.Workflow": "YOUR_LICENSE_KEY"
33+
{
34+
"Umbraco": {
35+
"Licenses": {
36+
"Products": {
37+
"Umbraco.Workflow": "YOUR_LICENSE_KEY"
38+
}
3739
}
3840
}
3941
}
@@ -59,25 +61,25 @@ If you are running on a single domain for both your frontend and backend environ
5961

6062
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.
6163

62-
An `UmbracoApplicationUrl` can be configured in your `appSettings.json` file like so:
64+
An `UmbracoApplicationUrl` can be configured in your `appsettings.json` file like so:
6365

6466
```json
6567
{
66-
"Umbraco": {
67-
"CMS": {
68-
"WebRouting": {
69-
"UmbracoApplicationUrl": "https://admin.my-custom-domain.com/"
70-
}
71-
}
68+
"Umbraco": {
69+
"CMS": {
70+
"WebRouting": {
71+
"UmbracoApplicationUrl": "https://admin.my-custom-domain.com/"
72+
}
7273
}
74+
}
7375
}
7476
```
7577

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

7880
#### Configuring `UmbracoApplicationUrl` on Umbraco Cloud
7981

80-
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.
82+
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.
8183

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

9698
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.
9799

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

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

124126
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.
125127

126-
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`.
127-
128128
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:
129129

130130
```json
131+
{
131132
"Umbraco": {
132133
"Licenses": {
133-
"Umbraco.Workflow": "<your license key>"
134-
},
135-
"LicensesOptions": {
134+
"Products": {
135+
"Umbraco.Workflow": "<your license key>"
136+
},
136137
"EnableScheduledValidation": false,
137138
"ValidatedLicenseRelayAuthKey": "<your authorization key>"
138139
}
139140
}
141+
}
140142
```
141143

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

0 commit comments

Comments
 (0)