Skip to main content

Getting started

Prerequisites​

  1. Uniform account (free tier or greater)

  2. Node.js installed on your machine (version 14 or greater)

  3. Npm access token (contact Uniform Product Support if you need one).

  4. Sitecore instance (8.2, 9.0.2 or greater)

  5. Default Sitecore site (e.g. website) configured with an MVC application

    tip

    If you need one, you can use the Sample MVC site from GitHub.

  6. Sitecore admin user login (e.g. sitecore\admin)

  7. Uniform connector is installed on your Sitecore instance by following the installation instructions.

    info

    The Uniform connector comes in two varieties: one with Canvas + Deploy and one with only Deploy. You must install the one that includes Canvas.

  8. Uniform API token is configured on your Sitecore instance.

  9. Https access to your Sitecore instance. Communication between the Uniform app and Sitecore is done entirely client-side using cross-domain requests.

    info

    If you are accessing Sitecore using http://localhost then you do not need to enable https on your Sitecore server. However, this option only works for local development.

Create Uniform project​

A Uniform project is where all of the settings related to your web app are configured. You must create a new project for your web app.

  1. Log into https://uniform.app.
  2. Click (+) to create a new project.
  3. Enter the following values and click Continue.
    • Project name: My Sitecore Project
    • Setup option: Empty project

Disable Uniform Deploy​

In most cases, if you are using Uniform Canvas you probably are not using Uniform Deploy.

To disable Uniform Deploy, add the following config file to your Sitecore server:

<?xml version="1.0" encoding="utf-8" ?>
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
  <sitecore>
      <settings>
          <setting name="Uniform.Deploy.Enabled" value="false" />
      </settings>
  </sitecore>
</configuration>
tip

Having Deploy enabled will not cause any problems on your Sitecore server, but if you publish items from a site that isn't configured for Deploy you will see warning messages in the log. Disabling Deploy will prevent those warning messages from being logged.