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:
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).
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:
dotnet new install kentico.xperience.templatesThis 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.
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.
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.
Open the command line prompt.
Navigate to the location where you want to create the project.
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.
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:
Program.cs for mapping files to Azure Blob storagedotnet new <short_name> --cloud -n AcmeWebInstall database .NET tools (kentico-xperience-dbmanager) for the project:
dotnet tool restore command).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.
Before you can run an Xperience project, create a database and register a license key for your application:
Obtain a license key for your application and save it in a text file (e.g., license.txt):
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.
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>"-- syntax separator to pass the parameters directly to the kentico-xperience-dbmanager command and to avoid conflicts with general dotnet parameters.-s parameter to your database server name.-d parameter to the name of the database.-u parameter to the username for the database authentication.-p parameter to the password for the database authentication.-a parameter to the password you want to use for the default administrator account.--hash-string-salt parameter to the hash salt value for the Xperience instance:
--license-file parameter to the path to a text file with the license key. This registers the license key in the Xperience administration.--help parameter to list all available options--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.
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
Get more information