Skip to main content

Sitecore components

Add Uniform license#

Uniform Optimize is activated using a license key. This license key must be added to your Sitecore instance.

caution

Uniform uses an online license validation service. Your Sitecore instance must have internet access in order for this process to work properly.

Uniform can read your license key in several ways. Select the option that works best in your environment:

Option 1. Connection string#

Uniform can read your license key from a connection string named Uniform.LicenseKey. The following is an example of what you need to add to the file App_Config\ConnectionStrings.config on your Sitecore instance:

<add name="Uniform.LicenseKey" connectionString="[!!! LICENSE KEY !!!]" />

Option 2. Sitecore configuration setting#

You can add a patch file for Sitecore configuration and specify your license key in a setting named Uniform.LicenseKey. The following is an example:

<configuration>  <sitecore>    <settings>      <setting name="Uniform.LicenseKey" value="[!!! LICENSE KEY !!!]" />    </settings>  </sitecore></configuration>

Option 3. Windows environment variable#

Uniform can read your license key from an environment variable named UNIFORM_LICENSE_KEY.

tip

If you are running Sitecore in Docker, this is the recommended option.

Install module#

Installing the Uniform Optimize module results in files and Sitecore items being deployed to your Sitecore instance. This process can be completed in a couple of different ways. Select the option that works best in your environment.

Option 1. Sitecore installation package#

Complete the following steps to install the module using a Sitecore installation package.

  1. Upload the zip file to your Sitecore instance.

  2. Use the Sitecore Installation Wizard to install the package.

Option 2. SDK#

The Uniform Optimize SDK provides Visual Studio projects that can be used to install the product. This enables you to add Uniform Optimize to your CI/CD process.

  1. Add the projects from the SDK to your Visual Studio solution.

  2. Build and deploy the projects to your Sitecore instance.

  3. Use Unicorn to sync the items.

Disable Uniform Deploy (optional)#

When you install the module, you actually install both Uniform Deploy and Uniform Optimize. If you are not using Deploy, you can disable Deploy.

  1. Create a new config file and deploy it to your Sitecore instance:

    <configuration>  <sitecore>    <settings>      <setting name="Uniform.Deploy.Enabled" value="false" />    </settings>  </sitecore></configuration>

Publish changes#

After the module is installed, republish the site.

Troubleshooting#

Uniform includes an admin page that provides information about the module, including license key status. You can access this page in your browser by navigating to /sitecore/admin/uniform.