Kontent Backup Manager
The purpose of this project is to backup & restore Kentico Kontent projects. This project uses Management API to both get & restore data.
Installation
Install package globally:
npm i @kentico/kontent-backup-manager -g
Use via CLI
Configuration
| Config | Value |
|---|---|
| projectId | Id of Kentico Kontent project (required) |
| apiKey | Content management Api key (required) |
| action | Action. Possible values are: restore & backup & clean (required)
|
| zipFilename | Name of zip used for export / restoring data. (e.g. 'kontent-backup'). |
| enableLog | Indicates if default logging is enabled (useful to indicate progress) |
| skipValidation | Skips validation endpoint during project export |
| force | If enabled, project will we exported / restored even if there are data inconsistencies. Enabled by default. |
| baseUrl | Custom base URL for Management API calls. |
| enablePublish | Indicates if language variants published on the source project are also published on target. Enabled by default |
| exportFilter | Can be used to export only selected data types. Expects CSV of types. For example contentType,language will cause backup manager to export only content types & language data. List of data types can be found below. |
Data types
- taxonomy
- contentType
- contentTypeSnippet
- contentItem
- languageVariant
- language
- assetFolder
- binaryFile
- workflowSteps (only export)
Execution
We recommend restoring backups to clean (empty) projects. Restoration process may make changes to target project such as changing language codenames to match source project.
To backup a project run:
kbm --action=backup --apiKey=xxx --projectId=xxx
To restore a project run:
kbm --action=restore --apiKey=xxx --projectId=xxx --zipFilename=backupFile
To clean (delete) everything inside a project run:
kbm --action=clean --apiKey=xxx --projectId=xxx
To get some help you can use:
kbm --help
Use with config file
Create a json configuration file in the folder where you are attempting to run script. (e.g. backup-config.json)
{
"projectId": "xxx",
"apiKey": "xxx",
"zipFilename": "backup",
"action": "backup",
"enableLog": true,
"force": true,
"baseUrl": null,
"exportFilter": null
}To execute your action run:
kbm --config=backup-config.json
Use via code
Backup in code
import { ExportService, ImportService, ZipService } from "@kentico/kontent-backup-manager";
import { FileService } from '@kentico/kontent-backup-manager/dist/cjs/lib/node';
const run = async () => {
const exportService = new ExportService({
apiKey: 'sourceProjectApiKey',
projectId: 'sourceProjectId',
exportFilter: undefined,
onExport: item => {
// called when any content is exported
console.log(`Exported: ${item.title} | ${item.type}`);
}
});
// data contains entire project content
const data = await exportService.exportAllAsync();
// you can also save backup in file with ZipService
const zipService = new ZipService({
context: 'node.js',
enableLog: true
});
// prepare zip data
const zipData = await zipService.createZipAsync(data);
const fileService = new FileService({
enableLog: true,
});
// create file on FS
await fileService.writeFileAsync('backup', zipData);
};
run();Restore in code
import { ExportService, ImportService, ZipService } from "@kentico/kontent-backup-manager";
import { FileService } from '@kentico/kontent-backup-manager/dist/cjs/lib/node';
const run = async () => {
const fileService = new FileService({
enableLog: true,
});
// load file
const zipFile = await fileService.loadFileAsync('backup');
const zipService = new ZipService({
context: 'node.js',
enableLog: true
});
const importService = new ImportService({
onImport: item => {
// called when any content is imported
console.log(`Imported: ${item.title} | ${item.type}`);
},
canImport: {
asset: (item) => true, // assets will be imported
contentType: (item) => {
if (item.codename === 'article') {
// content type will be imported only with its codename is 'article'
return true;
}
// all other types will be excluded from import
return false;
},
assetFolder: item => true, // all folders will be imported
contentItem: item => true, // all content items will be imported
contentTypeSnippet: item => true, // all content type snippets will be imported
language: item => true, // all languages will be imported
languageVariant: item => true, // all language variants will be imported
taxonomy: item => true,// all taxonomies will be imported
},
enablePublish: true, // when enables, previously published language variants will be published after restore (does not affect unpublished variants)
projectId: 'targetProjectId',
apiKey: 'targetProjectId',
enableLog: true, // shows progress of immport in console
fixLanguages: true, // backup manager will attempt to create missing languages & map existing languages
workflowIdForImportedItems: '00000000-0000-0000-0000-000000000000' // id that items are assigned
});
// read export data from zip
const importData = await zipService.extractZipAsync(zipFile);
// restore into target project
await importService.importFromSourceAsync(importData);
};
run();Clean in code
const run = async () => {
const zipService = new ZipService({
filename: 'xxx',
enableLog: true,
context: 'node.js' // 'node.js' or 'browser'
});
const importService = new ImportService({
onDelete: item => {
// called when any content is deleted
console.log(`Deleted: ${item.title} | ${item.type}`);
},
fixLanguages: true,
projectId: 'targetProjectId',
apiKey: 'targetProjectId',
enableLog: true
});
// read export data from zip
const data = await zipService.extractZipAsync();
// restore into target project
await importService.importFromSourceAsync(data);
};
run();