Skip to content

Installation

The product is supplied as a ZIP file. This includes the NuGet packages, documentation and example projects. Simply unzip to a convenient location on your file system (e.g. C:\OpenID for ASP.NET Core).

NuGet Packages

The recommended way to retrieve the OpenID for ASP.NET Core packages and stay up to date is via nuget.org.

The following packages are available:

Package Purpose Notes
ComponentSpace.OpenID OpenID Connect functionality Required

Trial Version

The product includes a free 30-day trial period.

Note

Production use requires a commercial license.

Installing the License Key

After purchasing a license, the supplied license key must be installed in the application before deploying to production. It's delivered as a ComponentSpace.lic file.

The installation options are:

  1. Copy the ComponentSpace.lic file to the application's root folder. The license key will be loaded automatically.

  2. Copy the ComponentSpace.lic file to a different folder and specify its location at application startup by calling SetOpenIDLicenseKeyFileName.

    For example:

    builder.Services
        .AddOpenIDProvider(builder.Configuration.GetSection("OpenIDProvider"))
        .SetOpenIDLicenseKeyFileName(@"Licenses\ComponentSpace.lic");
    
  3. Copy the license key string from the ComponentSpace.lic file and set it at application startup by calling SetOpenIDLicenseKey.

    For example:

    builder.Services
        .AddOpenIDProvider(builder.Configuration.GetSection("OpenIDProvider"))
        .SetOpenIDLicenseKey("license key string goes here...");
    
  4. Store the license key string elsewhere (e.g. in an environment variable or the app settings), retrieve it and set it at application startup by calling SetOpenIDLicenseKey.

Note

The license key is safe to store and distribute as required. It's specific to your organization but doesn't contain any sensitive or personally identifiable information.

Uninstallation

  1. Uninstall the ComponentSpace.OpenID packages from any ASP.NET Core web application projects.

  2. Delete the unzipped product folder from your file system.