Centralize license configuration #7463
Conversation
|
The Link Checker found broken links in your PR. Broken links found in: 10/umbraco-commerce/installation/licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 10/umbraco-ui-builder/installation/licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 10/umbraco-workflow/installation/licensing.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 13/umbraco-commerce/installation/the-licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 13/umbraco-deploy/installation/the-licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 13/umbraco-engage/installation/licensing.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 13/umbraco-forms/installation/the-licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 13/umbraco-ui-builder/installation/licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 13/umbraco-workflow/installation/licensing.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 15/umbraco-commerce/getting-started/the-licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 15/umbraco-deploy/installation/the-licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 15/umbraco-ui-builder/getting-started/licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 15/umbraco-workflow/installation/licensing.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 16/umbraco-commerce/getting-started/the-licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 16/umbraco-deploy/installation/the-licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 16/umbraco-engage/installation/licensing.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 16/umbraco-forms/installation/the-licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 16/umbraco-ui-builder/getting-started/licensing-model.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not Found Broken links found in: 16/umbraco-workflow/installation/licensing.md ❌ 404 Not Found → https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses | Rejected status code (this depends on your "accept" configuration): Not FoundFull Github Actions output |
|
|
||
| You can verify that your license is successfully installed by logging into your project's backoffice and navigating to the settings section. Here you will see a licenses dashboard which should display the status of your license. | ||
|
|
||
|  |
There was a problem hiding this comment.
This screenshot should be removed if not used elsewhere.
| Once you've purchased your license with the correct domains, you are ready to configure the license key on your Umbraco installation. | ||
|
|
||
| A header with a key of `X-AUTH-KEY` and value of the authorization key you have configured should be provided. | ||
| The license key should be added to your configuration using product ID: `Umbraco.Commerce`. |
There was a problem hiding this comment.
Instead of only specifying the product ID, should we use the configuration key to use instead? So for Commerce on v10 and v13, this would be Umbraco:Licenses:Umbraco.Commerce and on v14+ Umbraco:Licenses:Products:Umbraco.Commerce.
|
|
||
| You can verify that your license is successfully installed by logging into your project's backoffice and navigating to the settings section. Here you will see a license dashboard which should display the status of your license. | ||
|
|
||
|  |
There was a problem hiding this comment.
Same for this screenshot.
|
|
||
| You can view the status of the Umbraco Deploy On-premise license in the backoffice. This is available via the _Settings_ section, listed along with any other products using the same licensing service. | ||
|
|
||
|  |
There was a problem hiding this comment.
And this screenshot.
|
|
||
| You can verify that your license is successfully installed by logging into your project's backoffice and navigating to the settings section. Here you will see a license dashboard which should display the status of your license. | ||
|
|
||
|  |
|
|
||
| You can verify that your license is successfully installed by logging into your project's backoffice and navigating to the settings section. Here you will see a license dashboard which should display the status of your license. | ||
|
|
||
|  |
|
|
||
| You can view the status of the Umbraco Deploy On-premise license in the backoffice. This is available via the _Settings_ section, listed along with any other products using the same licensing service: | ||
|
|
||
|  |
There was a problem hiding this comment.
Lots of duplicated screenshots 😬
|
|
||
| You can verify that your license is successfully installed by logging into your project's backoffice and navigating to the settings section. Here you will see a license dashboard which should display the status of your license. | ||
|
|
||
|  |
|
|
||
| You can view the status of the Umbraco Deploy On-premise license in the backoffice. This is available via the _Settings_ section, listed along with any other products using the same licensing service: | ||
|
|
||
|  |
|
|
||
| You can verify that your license is successfully installed by logging into your project's backoffice and navigating to the **Engage** section. Here, you will see a license dashboard in the right pane, which should display the status of your license (**Valid**). | ||
|
|
||
| <figure><img src="../.gitbook/assets/image (13).png" alt=""><figcaption><p>Umbraco Engage start page with license information</p></figcaption></figure> |
There was a problem hiding this comment.
This screenshot even has a nice caption, almost sad to clean up this screenshot as well... 🤕
eshanrnh
left a comment
eshanrnh
left a comment
There was a problem hiding this comment.
Thanks a lot for the PR, @ronaldbarendse 🙌 The PR looks great.
Are there any unanswered questions/comments in here? If not, can I go ahead and merge this PR?
📋 Description
As mentioned in #7413, configuring license keys is the same between products, but slightly different between major versions. I've moved the duplicated documentation into a new page on the DXP site, which should be available on https://docs.umbraco.com/umbraco-dxp/commercial-products/configure-licenses.
Due to some differences in the configuration setup between versions and the DXP site not having version-specific pages, the differences are grouped into tabs.
Product & Version (if relevant)
Commerce 10, 13, 15 and 16
Deploy 13, 15 and 16 (v10 uses the license files)
Engage 13 and 16 (no other versions are released)
Forms 13 and 16 (supporting license keys in addition to files)
UI Builder 10, 13, 15 and 16
Workflow 10, 13, 15 and 16
📚 Helpful Resources