Licensing

Component: NServiceBus
NuGet Package NServiceBus (7.1-pre)
This page targets a pre-release version and is subject to change prior to the final release.

License details

See the Licensing page for license specifics.

License validity

The license is valid if the ExpirationDate or the UpgradeProtectionExpiration attribute in the license data is greater than or equal to the release date of the {major}.{minor}.0 version of the NServiceBus assembly used by the endpoint. To view the release dates for the various versions, see NServiceBus Packages Versions.

Only the Major/Minor part is relevant. Eg. if using NServiceBus 6.1.1 it's the release date of 6.1.0 that counts.

Throughput limitations

No limitations are enforced when either no license is found or a license has expired.

License management

There are several options available for installing the license file.

Depending on the operating system, the paths may be case sensitive.

NServiceBus uses the Environment.GetFolderPath(SpecialFolder) method to determine the locations of some paths on each OS.

Application-specific license location

A license located at {AppDomain.CurrentDomain.BaseDirectory}/license.xml will be automatically detected.

User-specific license location

To install a license for all endpoints and Particular Service Platform applications run by a specific user, install the license file to {SpecialFolder.LocalApplicationData}\ParticularSoftware\license.xml.

This location can be expressed using environment variables on Windows, or a bash expression on Linux/macOS:

  • Windows: %LOCALAPPDATA%\ParticularSoftware\license.xml
  • Linux/macOS: ${XDG_DATA_HOME:-$HOME/.local/share}/ParticularSoftware/license.xml

Machine-wide license location

To install a license for all endpoints and Particular Service Platform applications on an entire machine, install the license file to {SpecialFolder.CommonApplicationData}\ParticularSoftware\license.xml.

This location can be expressed using environment variables on Windows, or as a literal path on Linux/macOS.

  • Windows: %PROGRAMDATA%\ParticularSoftware\license.xml
  • Linux/macOS: /usr/share/ParticularSoftware/license.xml

Code-first configuration

A license can be configured via code first configuration API:

7.x NServiceBus
endpointConfiguration.LicensePath("PathToLicense");
// or
endpointConfiguration.License("YourCustomLicenseText");

Application configuration file

This option is only available when targeting the full .NET Framework.

It is possible to specify the license in app.config:

  • Use the key NServiceBus/LicensePath to specify the path where NServiceBus looks for the license:
<appSettings>
  <add key="NServiceBus/LicensePath"
       value="C:\NServiceBus\License\License.xml" />
</appSettings>
  • Use the key NServiceBus/License to store the XML-encoded contents of the license directly in app.config:
<appSettings>
  <add key="NServiceBus/License" value="&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;&lt;
license id=&quot;1222e1d1-2222-4a46-b1c6-943c442ca710&quot; expiration=&quot;2013-11-30T00:00:00.0000000
&quot; type=&quot;Standard&quot; LicenseType=&quot;Standard&quot; LicenseVersion=&quot;4.0
&quot; MaxMessageThroughputPerSecond=&quot;Max&quot; WorkerThreads=&quot;Max
&quot; AllowedNumberOfWorkerNodes=&quot;Max&quot;&gt;
. . .
&lt;/license&gt;" />
</appSettings>

Windows Registry

This option is only available when targeting the full .NET Framework.

Licenses stored in a registry key named License in the following registry locations are automatically detected:

  • HKEY_LOCAL_MACHINE\Software\ParticularSoftware
  • HKEY_CURRENT_USER\Software\ParticularSoftware

To install a license as a registry key, use the following steps:

  • Start the Registry Editor.
  • Go to HKEY_LOCAL_MACHINE\Software\ParticularSoftware or HKEY_CURRENT_USER\Software\ParticularSoftware.
  • Create a new Multi-String Value (REG_MULTI_SZ) named License.
  • Paste the contents of the license file.
If HKEY_LOCAL_MACHINE is the chosen license location, and the operating system is 64-bit, then repeat the import process for the HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\ParticularSoftware key to support 32-bit clients.
If the license is stored in HKEY_CURRENT_USER, NServiceBus processes must run as the user account used to add the license file to the registry in order to access the license.

It is safe to ignore any warnings regarding empty strings.

Troubleshooting

Failed to initialize the license

The license management code requires write permissions to store metadata. If the process credentials don't have write permissions the following fatal event log item can be generated:

FATAL NServiceBus.Features.LicenseReminder Failed to initialize the license
System.UnauthorizedAccessException: Access to the path 'C:\Windows\system32\config\systemprofile' is denied.

Ensure that the process has write permissions at the specified location. If necessary, either modify the location, change permissions, or use another process that has appropriate permissions.

Related Articles


Last modified