Xperience by Kentico: Kentico Migration Tool

Description

This repository is part of the Xperience by Kentico Migration Toolkit.

The Kentico Migration Tool transfers content and other data from Kentico Xperience 13, Kentico 12 or Kentico 11 to Xperience by Kentico.

This repository contains several README documents containing information necessary for the correct usage of the Kentico Migration Tool. Namely:

• Migration CLI -- information about the necessary set up before running the Kentico Migration Tool.
• Usage Guide -- information about what kind of projects the Kentico Migration Tool supports.
• Supported Data -- lists all available data for migration
• Migration Protocol -- provides information about the results of the migration and required manual steps, etc.

Library Version Matrix

Xperience Version	Library Version
29.6.0	1.4.0
29.5.2	1.3.0
29.3.3	1.2.0
29.2.0	1.1.0
29.1.0	1.0.0

Dependencies

• ASP.NET Core 8.0
• Xperience by Kentico

Quick Start

Follow the steps below to run the Kentico Migration Tool:

1. Clone or download the Migration.Tool source code from this repository.

2. Open the Migration.Tool.sln solution in Visual Studio.

3. Configure the options in the Migration.Tool.CLI/appsettings.json configuration file. See Migration.Tool.CLI/README.md - Configuration for details.

4. Rebuild the solution and restore all required NuGet packages.

5. Open the command line prompt.

6. Navigate to the output directory of the Migration.Tool.CLI project. (under .\Migration.Toolkit.CLI\bin\Debug\net8.0\)

7. Run the Migration.Tool.CLI.exe migrate command.

   • The following example shows the command with all parameters for complete migration:

     .\Migration.Tool.CLI.exe  migrate --sites --custom-modules --users --settings-keys --page-types --pages --attachments --contact-management --forms --media-libraries --data-protection --countries --custom-tables --members --categories

   • You can migrate your projects iteratively. For repeated runs bypass depency checks by using the --bypass-dependency-check parameter, if you know that required dependencies were already migrated succesfully.

8. Observe the command line output. The command output is also stored in a log file (logs\log-<date>.txt under the output directory by default), which you can review later.

9. Review the migration protocol, which provides information about the result of the migration, lists required manual steps, etc.

   • You can find the protocol in the location specified by the MigrationProtocolPath key in the appsettings.json configuration file.
   • For more information, see Migration.Tool.CLI/MIGRATION_PROTOCOL_REFERENCE.md.

The data is now migrated to the target Xperience by Kentico instance according to your configuration. See Migration.Tool.CLI/README.md for detailed information about the migration CLI, configuration options, instructions related to individual object types, and manual migration steps.

Full Requirements

View the Usage Guide for information about what kind of projects the Kentico Migration Tool supports.

Changelog of recent updates

• September 4, 2024
  • Migration of media libraries and attachments to assets is available
  • Media libraries and attachments are now migrated to content item assets by default
• June 13, 2024
  • Migration of categories to taxonomies is available
• March 11, 2024
  • Kentico Xperience 11 instances are supported as a source of migration
• February 1, 2024
  • Kentico Xperience 12 instances are supported as a source of migration

Contributing

To see the guidelines for Contributing to Kentico open source software, please see Kentico's CONTRIBUTING.md for more information and follow the Kentico's CODE_OF_CONDUCT.

Instructions and technical details for contributing to this project can be found in Contributing Setup.

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

This project has Full support by 7-day bug-fix policy.

See SUPPORT.md for more information.

Security

For any security issues see Kentico's SECURITY.md.