Xperience by Kentico is a content and digital experience management system built on the .NET platform. For an overview of the system and its features, read our product introduction.

Evaluate Xperience by Kentico in a local development environment for 30 days for free. See Evaluate Xperience by Kentico.

Xperience provides boilerplate .NET projects that are distributed as .NET project templates and installed via the .NET command-line tool (included with the .NET SDK).

Install an Xperience project:

  1. Familiarize yourself with the System requirements – make sure the target machine meets the minimum hardware requirements, runs a supported operating system, and contains the software that Xperience needs for the installation.
  2. Install the project templates package that provides project templates you can use to build your website.
  3. Select a project to create from the available project templates.
  4. Create the project and the project database.
On this page

Watch this video to quickly get started developing solutions with Xperience by Kentico. The video guides you through a brief Xperience project installation.

Install project templates package

Before creating new projects, you must install the Xperience by Kentico project templates package using the .NET CLI.

Open the command line and run the following command (depending on the .NET SDK version installed on your machine):

Install project templates (.NET 6 SDK)
dotnet new -i kentico.xperience.templates
Install project templates (.NET 7 SDK)
dotnet new install kentico.xperience.templates

This installs the project templates NuGet package. The package location depends on the operating system.

You can now create Xperience projects based on the project templates.

Available project templates

The following project types are available, each with a different use case:

Project typeTemplate short nameDescription

Creates an empty ASP.NET application that you can use as a base for your project. The application comes with a basic configuration required to run and develop Xperience sites.  

Recommended as a starting point for the development of new Xperience sites.

Dancing Goatkentico-xperience-sample-mvc

A sample company site of a fictional coffee shop franchise. Demonstrates the content management and digital marketing features of the Xperience solution.

Admin UI customization boilerplatekentico-xperience-admin-sample

A project for developers who wish to extend the Xperience by Kentico administration interface. Intended to be used together with another Xperience project (does not work as a standalone application).

Helps bootstrap your environment when developing custom client components for the admin UI. For more information, see Admin UI customization model overview and Prepare your environment for admin development.

The template short name of each project type needs to be specified when creating projects using the dotnet new command.

Create a project

Once you have installed the project templates package, you can install projects using the .NET command-line interface. You need to know the template short name for the corresponding project type.

  1. Open the command line prompt.
  2. Navigate to the location where you want to create the project.
  3. Run the following command:

    • Replace <short_name> with the template short name of the project type you want to install (either kentico-xperience-mvc or kentico-xperience-sample-mvc).

    • The -n parameter sets the name of the installed project. See the dotnet new reference to learn more about the command options.
      • It is not recommended to use non-alphanumeric (e.g. space ' ', dot '.', or underscore '_') characters in the project name.
    • The --cloud parameter installs a boilerplate project suitable for deployment to the SaaS environment. Omit this parameter if you wish to host a self-managed Xperience project.

      Create a project from a template
      dotnet new <short_name> --cloud -n AcmeWeb
  4. Install database .NET tools (kentico-xperience-dbmanager) for the project:

    1. You will be asked if you want to install the database tools during the installation of the .NET project (with the dotnet tool restore command).
    2. To install the database tools manually, run the dotnet tool restore command from the project's root directory.

The command creates the project files and sets up the database tools for the project.

Continue by creating the project database.

Create the project database

Before you can run an Xperience project, create a database and register a license key for the domain you want to use for your application in Xperience administration:

  1. Obtain a license key for your application and save it in a text file (e.g., license.txt):

  2. Run the dotnet kentico-xperience-dbmanager command from the root directory of the project:

    The kentico-xperience-dbmanager command is installed when creating a project. Run the dotnet tool restore command from the project's root directory if the command is unavailable.

    You can also list all command parameters using --help.

    Create project database
    dotnet kentico-xperience-dbmanager -- -s "<sql_server_name>" -a "<admin_password>" --hash-string-salt "<hash_string_salt>" --license-file "<license_file_path>"

The command installs and connects a database to your project via the CMSConnectionString application setting (located in the project's appsettings.json file).

This completes the installation process. Your Xperience project is now ready for Development and Deployment.

Next steps

  • Read the Website development basics for an introduction to the general development process of Xperience websites. The document guides you through basic development and hosting environment setups and introduces important Xperience concepts and features.
  • Set up local hosting for your site so that you can get started with development.
  • Access the Xperience administration by appending /admin to your site's URL. Sign in using the default administrator account and the password you specified when installing the project database.

Get more information

  • Take a look at our Tutorial and learn how to develop a basic website using Xperience.
  • You can also visit our Community Portal for developers, where you can find articles, Q&A discussions, and other documentation materials.
  • If you're stuck with a particular problem, contact our support. Our team operates non-stop and will be happy to assist you.