This package has been deprecated

Author message:

This package is deprecated and will no longer be maintained. Please, use the new data-ops (https://github.com/kontent-ai/data-ops) package instead.

@kontent-ai/backup-manager
TypeScript icon, indicating that this package has built-in type declarations

4.2.4 • Public • Published

npm version Build & Test

Kontent.ai Backup Manager

The purpose of this project is to backup & restore Kontent.ai projects. This project uses Management API to both get & restore data.

Installation

Install package globally:

npm i @kontent-ai/backup-manager -g

Use via CLI

Configuration

Config Value
environmentId Id of Kontent.ai 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)
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.
preserveWorkflow Indicates language variant workflow information should be preserved
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
  • asset
  • assetFolder
  • binaryFile
  • workflow
  • collection

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 --environmentId=xxx

To restore a project run:

kbm --action=restore --apiKey=xxx --environmentId=xxx --zipFilename=backupFile

To clean (delete) everything inside a project run:

kbm --action=clean --apiKey=xxx --environmentId=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)

{
    "environmentId": "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 "@kontent-ai/backup-manager";
import { FileService } from '@kontent-ai/backup-manager/dist/cjs/lib/node';

const run = async () => {
    const exportService = new ExportService({
        apiKey: 'sourceProjectApiKey',
        environmentId: 'sourceEnvironmentId',
        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 "@kontent-ai/backup-manager";
import { FileService } from '@kontent-ai/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 if the codename is equal to '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
        },
        preserveWorkflow: true, // when enabled, language variants will preserve their workflow information
        environmentId: 'targetEnvironmentId',
        apiKey: 'targetEnvironmentId',
        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({
        enableLog: true,
        context: 'node.js' // 'node.js' or 'browser'
    });

    const cleanService = new CleanService({
        onDelete: item => {
            // called when any content is deleted
            console.log(`Deleted: ${item.title} | ${item.type}`);
        },
        fixLanguages: true,
        environmentId: 'targetEnvironmentId',
        apiKey: 'targetEnvironmentId',
        enableLog: true
    });

    // read export data from zip
    const data = await zipService.extractZipAsync();

    // restore into target project
    await cleanService.importFromSourceAsync(data);
};

run();

FAQ

I'm getting Header overflow exception

The Node.js limits the maximum header size of HTTP requests. In some cases it may be required for you to increase this limitation to be able to successfully fetch data from Kontent.ai. You can do so by using the max-http-header-size option (https://nodejs.org/api/cli.html#--max-http-header-sizesize)

Example script call:

node --max-http-header-size 150000 %USERPROFILE%\AppData\Roaming\npm\node_modules\@kontent-ai\backup-manager\dist\cjs\lib\node\cli\app --action=backup --apiKey=<key> --environmentId=<environmentId>

Package Sidebar

Install

npm i @kontent-ai/backup-manager

Weekly Downloads

336

Version

4.2.4

License

MIT

Unpacked Size

913 kB

Total Files

278

Last publish

Collaborators

  • enngage
  • ivannk
  • jiri-lojda
  • pokornyd