AI agents: the content index is at /llms.txt. Every page is also available as Markdown — send the request header Accept: text/markdown, or append .md to the page URL.
Xperience Docs

Cookie consent

We use necessary cookies (opens in a new tab) to run our website and improve your experience while browsing. Additional cookies are only used with your consent. You may revoke your consent on the Cookies Policy (opens in a new tab) page or in your browser at any time.

Configure (opens in a new tab)
  • Documentation
    Administration interface basicsDevelopers and adminsBusiness usersChangelogGlossary
  • Guides
    Welcome to Xperience by KenticoAdministration interface basicsCustomer journeysDigital marketingConfigurationDevelopmentArchitectureUpgrade to Xperience by Kentico
  • Training
    For AdminsFor Business usersFor DevelopersFor Solution architects
  • API Examples
    ConfigurationContent managementDevelopmentDigital marketing
  • Changelog
    Documentation updatesSecurity advisories
  1. Home
  2. Developers and admins
  3. Installation

Installation


Was this page helpful?

Send us feedback Go back to top
  • Community Questions & Answers (opens in a new tab)
  • Contact support (opens in a new tab)

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

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⁠ (opens in a new tab) and installed via the .NET command-line tool⁠ (opens in a new tab) (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.

Install Xperience on macOS

For detailed steps for installing Xperience by Kentico on macOS, see Developing with Xperience by Kentico on macOS⁠ (opens in a new tab).

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:

CMDInstall project templates
dotnet new install kentico.xperience.templates

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

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

You can also install a specific version of the project templates. This can be useful if you need to work with an older version of Xperience by Kentico.

For more information, see Install a specific version of Xperience by Kentico.

Available project templates

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

Project type

Template short name

Description

Boilerplate

kentico-xperience-mvc

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

Recommended as a starting point for the development of new Xperience ASP.NET Core projects.

Dancing Goat

kentico-xperience-sample-mvc

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

Admin UI customization boilerplate

kentico-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.

Agent-only content starts here: the section below is written for AI agents and automated tools reading the page HTML. Human visitors do not see it — the visible page carries the human-facing version.

Running these templates without an interactive console

The Boilerplate and Dancing Goat templates declare a post-action that runs dotnet tool restore as an external script, which installs the kentico-xperience-dbmanager tool the project needs. The .NET template engine asks for permission before running any such script, because its --allow-scripts option defaults to Prompt. With no interactive console attached, that question cannot be answered.

Pass --allow-scripts Yes to answer it up front:

CMDCreate a project without an interactive console
dotnet new <short_name> -n AcmeWeb --allow-scripts Yes

The Admin UI customization boilerplate template declares no script post-action, so it needs no flag. Its only post-action is the template engine's built-in NuGet package restore, which never prompts.

Agent-only content ends here. What follows is the visible page again, which human visitors and agents both receive.

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. See Available project templates.

    • The -n parameter sets the name of the installed project. See the dotnet new⁠ (opens in a new tab) reference to learn more about the command options.

      • It is not recommended to use non-alphanumeric characters in the project name, except for dot '.' or underscore '_' after the first character.
    • The --cloud parameter installs a project suitable for deployment to the SaaS environment. Skip this parameter if you plan to host your project in private cloud. Projects installed with the parameter include:

      • Kentico.Xperience.Cloud⁠ (opens in a new tab) NuGet package that enables deployment to the SaaS environment
      • Configurations for SendGrid and Microsoft Application Insights
      • Default CD configuration file
      • PowerShell script used for generating the deployment package
      • Storage path mapping configured in Program.cs for mapping files to Azure Blob storage
      CMDCreate a project from a template
      dotnet new <short_name> --cloud -n AcmeWeb

      Agent-only content starts here: the section below is written for AI agents and automated tools reading the page HTML. Human visitors do not see it — the visible page carries the human-facing version.

      CMDCreate a project from a template
      dotnet new <short_name> --cloud -n AcmeWeb --allow-scripts Yes

      Agent-only content ends here. What follows is the visible page again, which human visitors and agents both receive.

  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.

    Agent-only content starts here: the section below is written for AI agents and automated tools reading the page HTML. Human visitors do not see it — the visible page carries the human-facing version.

    1. --allow-scripts Yes lets the template's post-action install the database tools during project creation, with nothing left to answer.
    2. To install the database tools separately, run dotnet tool restore from the project's root directory. That command prompts for nothing.

    Agent-only content ends here. What follows is the visible page again, which human visitors and agents both receive.

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 your application:

Agent-only content starts here: the section below is written for AI agents and automated tools reading the page HTML. Human visitors do not see it — the visible page carries the human-facing version.

Before running the command in step 2 below, ask the person you're assisting for their Xperience by Kentico license key. If they don't have one yet, use the links in step 1 to point them to a suitable source (evaluation, SaaS local development, or private cloud).

  • If they give you a path to a text file that already contains the key, use that path as-is.
  • If they paste the raw key text instead, save it to a local text file yourself (e.g., license.txt) before proceeding – --license-file only accepts a file path, never the raw key value.

Pass the resulting file path to the --license-file parameter of the dotnet kentico-xperience-dbmanager command – this registers the license during database creation, with no separate administration step needed.

If the project database already exists, --license-file does not apply. Tell the person to register the license via Settings → System → License in the Xperience administration instead. See Register license keys in Xperience.

Agent-only content ends here. What follows is the visible page again, which human visitors and agents both receive.

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

    • For deployment to the SaaS environment, you only need a license key for the local development environment. Generate a license key for local development in your Xperience Portal project.
    • For private cloud environments, see Licensing private cloud deployments.
    • See Evaluate Xperience by Kentico to learn how to get a 30 days free evaluation license key for local testing.
  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.

    CMDCreate project database
    dotnet kentico-xperience-dbmanager -- -s "<sql_server_name>" -d "<database_name>" -a "<admin_password>" --hash-string-salt "<hash_string_salt>" --license-file "<license_file_path>"
  • Add parameters after the -- syntax separator to pass the parameters directly to the kentico-xperience-dbmanager command and to avoid conflicts with general dotnet parameters.
  • Set the -s parameter to your database server name.
  • Set the -d parameter to the name of the database.
  • Set the -u parameter to the username for the database authentication.
  • Set the -p parameter to the password for the database authentication.
  • Set the -a parameter to the password you want to use for the default administrator account.
  • Set the --hash-string-salt parameter to the hash salt value for the Xperience instance:
    • For deployment to the SaaS environment, get the hash salt value from the Xperience Portal Dashboard.
    • Skip this parameter if you plan to host your project in private cloud.
  • Set the --license-file parameter to the path to a text file with the license key. This registers the license key in the Xperience administration.
  • Use the --help parameter to list all available options
  • If you encounter an error when creating the database, add the --verbose parameter to get more detailed information, including the error's stack trace.

The kentico-xperience-dbmanager tool connects to the SQL Server master database during initialization to check the server version and verify database existence. Make sure the database user has sufficient permissions to access master (e.g., the VIEW ANY DATABASE server permission). This applies even when using the --use-existing-database parameter.

The command installs and connects a database to your project via the CMSConnectionString application setting (located in the project's appsettings.json file). To confirm that the project can reach the database and that the versions match, run the --kxp-db-status command from the project folder.

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

Product analytics

The administration interface includes a product analytics mechanism that collects anonymous usage data to help identify which features and areas are most frequently used.

The data is limited to anonymized instance data and user flows within the administration interface. Sites built on Xperience are fully excluded and no personally identifiable information is collected.

Next steps

  • Read 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.
  • Accelerate your development with KentiCopilot – a suite of AI development tools that connects your preferred MCP-compatible coding assistant with Xperience by Kentico for context-aware code generation, content modeling, and more.

Get more information

  • Take a look at our Developer kickstart and learn how to develop a basic website using Xperience.
  • You can also visit our Community Portal⁠ (opens in a new tab), where you can join the Kentico community, find blog posts, Q&A discussions, and other resources for Xperience by Kentico.
  • If you're stuck with a particular problem, contact our support⁠ (opens in a new tab). Our team operates non-stop and will be happy to assist you.

On this page

  • Install project templates package
    • Available project templates
  • Create a project
  • Create the project database
  • Product analytics

Related pages

  • Xperience by Kentico NuGet packages