Skip to content

Described option for using underscores in product keys when configuring product licenses with environment variables. #6747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Dec 16, 2024
Merged

Described option for using underscores in product keys when configuring product licenses with environment variables. #6747

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
38e497a
Described option for using understores in product keys when configuri…
AndyButland Dec 12, 2024
42b4e17
Linting
AndyButland Dec 12, 2024
2ddcc6b
Update licensing-model.md
sofietoft Dec 16, 2024
539c5e8
Update licensing-model.md
sofietoft Dec 16, 2024
9f9e6cf
Update the-licensing-model.md
sofietoft Dec 16, 2024
8527397
Update install-configure.md
sofietoft Dec 16, 2024
567373f
Update the-licensing-model.md
sofietoft Dec 16, 2024
b6607fe
Update licensing.md
sofietoft Dec 16, 2024
dfcadd1
Update licensing-model.md
sofietoft Dec 16, 2024
15ee8a0
Update the-licensing-model.md
sofietoft Dec 16, 2024
41931e5
Update install-configure.md
sofietoft Dec 16, 2024
6512e18
Update the-licensing-model.md
sofietoft Dec 16, 2024
3713798
Update licensing-model.md
sofietoft Dec 16, 2024
153afe3
Update the-licensing-model.md
sofietoft Dec 16, 2024
6ed3239
Update install-configure.md
sofietoft Dec 16, 2024
85da23b
Update the-licensing-model.md
sofietoft Dec 16, 2024
7147028
Update licensing-model.md
sofietoft Dec 16, 2024
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
8 changes: 8 additions & 0 deletions 10/umbraco-commerce/installation/licensing-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@
}
```

{% hint style="info" %}

Check warning on line 70 in 10/umbraco-commerce/installation/licensing-model.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "10/umbraco-commerce/installation/licensing-model.md", "range": {"start": {"line": 70, "column": 4}}}, "severity": "WARNING"}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:
Copy link
Contributor

@sofietoft sofietoft Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this, an potentially the rest, be stripped down to this? Or is it lacking too much detail? 🤔

Suggested change
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:
Use an underscore in the product name, to avoid issues when using environment variables.

Copy link
Contributor Author

@AndyButland AndyButland Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be OK, but the detail is kind of useful too for background, and also as we've documented above using the ".".

Copy link
Contributor

@sofietoft sofietoft Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I see 🤔

How about:

"When using environment variables you might run into issues when using a period in the product name. Use an underscore in the product name instead, to avoid issues."

Copy link
Contributor Author

@AndyButland AndyButland Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds fine, do you want me to make that update or will you do so?

Copy link
Contributor

@sofietoft sofietoft Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can update the notes 💪


```json
"Umbraco_Commerce": "YOUR_LICENSE_KEY"
```
{% endhint %}

### Verify the license installation

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.
Expand Down
8 changes: 8 additions & 0 deletions 10/umbraco-ui-builder/installation/licensing-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@
}
```

{% hint style="info" %}

Check warning on line 70 in 10/umbraco-ui-builder/installation/licensing-model.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "10/umbraco-ui-builder/installation/licensing-model.md", "range": {"start": {"line": 70, "column": 4}}}, "severity": "WARNING"}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_UIBuilder": "YOUR_LICENSE_KEY"
```
{% endhint %}

### Verify the license installation

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.
Expand Down
8 changes: 8 additions & 0 deletions 13/umbraco-commerce/installation/the-licensing-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@
}
```

{% hint style="info" %}

Check warning on line 70 in 13/umbraco-commerce/installation/the-licensing-model.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "13/umbraco-commerce/installation/the-licensing-model.md", "range": {"start": {"line": 70, "column": 4}}}, "severity": "WARNING"}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_Commerce": "YOUR_LICENSE_KEY"
```
{% endhint %}

### Verify the license installation

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.
Expand Down
8 changes: 8 additions & 0 deletions 13/umbraco-deploy/installation/install-configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,14 @@
}
```

{% hint style="info" %}

Check warning on line 295 in 13/umbraco-deploy/installation/install-configure.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "13/umbraco-deploy/installation/install-configure.md", "range": {"start": {"line": 295, "column": 4}}}, "severity": "WARNING"}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_Deploy_OnPrem": "YOUR_LICENSE_KEY"
```
{% endhint %}

Umbraco Cloud projects use a license file placed in the `/umbraco/Licenses` folder that is provided when your project is created.

Read more about the [Umbraco Deploy licensing model](../installation/the-licensing-model.md).
8 changes: 8 additions & 0 deletions 13/umbraco-deploy/installation/the-licensing-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@
}
```

{% hint style="info" %}

Check warning on line 70 in 13/umbraco-deploy/installation/the-licensing-model.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "13/umbraco-deploy/installation/the-licensing-model.md", "range": {"start": {"line": 70, "column": 4}}}, "severity": "WARNING"}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_Deploy_OnPrem": "YOUR_LICENSE_KEY"
```
{% endhint %}

Umbraco Cloud projects use a license file placed in the `/umbraco/Licenses` folder that is provided automatically when your project is created.

## Validating the license
Expand Down
9 changes: 9 additions & 0 deletions 13/umbraco-engage/installation/licensing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,15 @@
}
```

{% hint style="info" %}

Check warning on line 76 in 13/umbraco-engage/installation/licensing.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "13/umbraco-engage/installation/licensing.md", "range": {"start": {"line": 76, "column": 4}}}, "severity": "WARNING"}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_Engage": "YOUR_LICENSE_KEY"
```
{% endhint %}


### Verify the license installation

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.
Expand Down
8 changes: 8 additions & 0 deletions 13/umbraco-ui-builder/installation/licensing-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@ Once you have received your license code it needs to be installed on your site.
}
```

{% hint style="info" %}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_UIBuilder": "YOUR_LICENSE_KEY"
```
{% endhint %}

### Verify the license installation

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.
Expand Down
8 changes: 8 additions & 0 deletions 14/umbraco-commerce/getting-started/the-licensing-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,14 @@ Once you have received your license code it needs to be installed on your site.
}
```

{% hint style="info" %}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_Commerce": "YOUR_LICENSE_KEY"
```
{% endhint %}

### Verify the license installation

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.
Expand Down
8 changes: 8 additions & 0 deletions 14/umbraco-deploy/installation/install-configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,14 @@ For example, in `appsettings.json`:
}
```

{% hint style="info" %}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_Deploy_OnPrem": "YOUR_LICENSE_KEY"
```
{% endhint %}

Umbraco Cloud projects use a license file placed in the `/umbraco/Licenses` folder that is provided when your project is created.

Read more about the [Umbraco Deploy licensing model](../installation/the-licensing-model.md).
8 changes: 8 additions & 0 deletions 14/umbraco-deploy/installation/the-licensing-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,14 @@ For example, in `appsettings.json`:
}
```

{% hint style="info" %}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_Deploy_OnPrem": "YOUR_LICENSE_KEY"
```
{% endhint %}

Umbraco Cloud projects use a license file placed in the `/umbraco/Licenses` folder that is provided automatically when your project is created.

## Validating the license
Expand Down
11 changes: 10 additions & 1 deletion 14/umbraco-ui-builder/installation/licensing-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,19 @@ Once you have received your license code it needs to be installed on your site.
"Products": {
"Umbraco.UIBuilder": "YOUR_LICENSE_KEY"
}
}
}
}
```


{% hint style="info" %}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_UIBuilder": "YOUR_LICENSE_KEY"
```
{% endhint %}

### Verify the license installation

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.
Expand Down
6 changes: 6 additions & 0 deletions 15/umbraco-commerce/getting-started/the-licensing-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,13 @@
}
```

{% hint style="info" %}

Check warning on line 72 in 15/umbraco-commerce/getting-started/the-licensing-model.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "15/umbraco-commerce/getting-started/the-licensing-model.md", "range": {"start": {"line": 72, "column": 4}}}, "severity": "WARNING"}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_Commerce": "YOUR_LICENSE_KEY"
```
{% endhint %}

### Verify the license installation

Expand Down
8 changes: 8 additions & 0 deletions 15/umbraco-deploy/installation/install-configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,14 @@
}
```

{% hint style="info" %}

Check warning on line 295 in 15/umbraco-deploy/installation/install-configure.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "15/umbraco-deploy/installation/install-configure.md", "range": {"start": {"line": 295, "column": 4}}}, "severity": "WARNING"}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_Deploy_OnPrem": "YOUR_LICENSE_KEY"
```
{% endhint %}

Umbraco Cloud projects use a license file placed in the `/umbraco/Licenses` folder that is provided when your project is created.

Read more about the [Umbraco Deploy licensing model](../installation/the-licensing-model.md).
8 changes: 8 additions & 0 deletions 15/umbraco-deploy/installation/the-licensing-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,14 @@
}
```

{% hint style="info" %}

Check warning on line 72 in 15/umbraco-deploy/installation/the-licensing-model.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "15/umbraco-deploy/installation/the-licensing-model.md", "range": {"start": {"line": 72, "column": 4}}}, "severity": "WARNING"}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_Deploy_OnPrem": "YOUR_LICENSE_KEY"
```
{% endhint %}

Umbraco Cloud projects use a license file placed in the `/umbraco/Licenses` folder that is provided automatically when your project is created.

## Validating the license
Expand Down
10 changes: 9 additions & 1 deletion 15/umbraco-ui-builder/installation/licensing-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,18 @@
"Products": {
"Umbraco.UIBuilder": "YOUR_LICENSE_KEY"
}
}
}
}
```

{% hint style="info" %}

Check warning on line 72 in 15/umbraco-ui-builder/installation/licensing-model.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "15/umbraco-ui-builder/installation/licensing-model.md", "range": {"start": {"line": 72, "column": 4}}}, "severity": "WARNING"}
If using environment variables rather than a JSON file for configuration you may run into issues with the periods used in the product key. If so, an underscore can be used instead:

```json
"Umbraco_UIBuilder": "YOUR_LICENSE_KEY"
```
{% endhint %}

### Verify the license installation

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.
Expand Down
Loading