Setup Guide

Welcome to the Redakt CMS setup guide. Setting up a Redakt CMS website is very easy. This guide will get you up and running with a local installation in just a few minutes!

Also available, the even quicker 1 minute setup using a project template!

Step 1: Create a new project

If you haven't done so already, go ahead and create a new Visual Studio project.

This guide assumes you are using Visual Studio 2017, which is available for free for individuals and small businesses. Visual Studio 2015 with the latest updates should also be fine. Depending on your Visual Studio and .NET Core SDK versions, the create new project process may be slightly different.

Select the "ASP.NET Core Web Application (.NET Core)" project template from the "Web" or ".NET Core" folders.

New ASP.NET Core Project

In the following dialog, choose the "Web Application" template. This will create a new project with default MVC views and controller scaffolding. You may also choose "Empty" here if you are not going to make use of MVC at all.

Step 2: Install Redakt NuGet package

Right-click on your new project, and select "Manage NuGet Packages...". In the Browse tab, search for the package Redakt.Web. This is the main Redakt package suitable for almost all websites. Install the package. The package installer will automatically register required Redakt services and configuration in the Startup.cs file.

Step 3: Choose a Data Store

The package you have just installed contains almost everything to start your new website. One thing missing is the data layer. Because Redakt supports several different pluggable data stores, we have chosen not to include any specific one by default. This keeps the dependency tree to a minimum and improves overall performance.

For this guide we will be selecting LiteDB, a local file database. To add the LiteDB data store module to your project, simply search for and install the NuGet package Redakt.Data.LiteDb.

See the configuration guide for setting up other data stores instead.

After the package is installed, open the Startup.cs file of your web project. In the ConfigureServices method, you will see a line that starts with services.AddRedakt. You need to add the LiteDB implementation to the Redakt services collection. Modify the AddRedakt call so that it looks like the following:

services.AddRedakt(this.Configuration, builder =>

If you have selected a different data store package instead, change the call accordingly.

Step 4: Add the back office

The Redakt back office is not installed by default when you install the Web package. We will be needing it for our setup, so let's install it now. Search for and install the Redakt.BackOffice package with the NuGet Package Manager. The package installer will automatically register the back office in the Startup.cs file.

Step 5: Start your site

That's all setup done for now! Press the play button to start your website.

Redakt will detect that this is a first time installation and will come up with an install screen. Enter new administrator credentials and your new website information and press "Install". The installation procedure populates the database with system master data. This will be done in a few seconds and you will be taken to the Redakt back office of your new website.


You are now done with setting up a local website with Redakt CMS. You can access the back office at the default /redakt url. This url can optionally be changed through configuration. The current setup is suitable for small non-distributed websites. See the configuration guide section for setting up Redakt in more advanced scenarios.

NOTE: You will also need to start implementing content models and layouts, and the back office application will display a warning until you do. See the implementation guides for further information.