Skip to main content
Pentaho Documentation

Backup and Restore Pentaho Repositories

A complete backup and restore of your Pentaho repositories can be done through either the command (cmd) window or with Rest APIs

Backup and Restore the Pentaho Repository

The backup process exports all content from the Pentaho Repository and creates a ZIP file, which includes:

  • Users and roles
  • All files (dashboards, reports, etc.)
  • Schedules
  • Data connections
  • Mondrian schemas
  • Metadata entries
  • A manifest file

All of your content is pulled from this ZIP file when you restore the Pentaho Repository.

You must have appropriate administrator permissions on the server in order to perform a repository backup or restore.

Step 1: Backup the Pentaho Repository

Backing up up your Pentaho Repository is done through the use of command line arguments. There are some example arguments below that you can customize for your particular server. 

If an argument is required for successful backup and has not been provided, the missing requirement is displayed in the cmd window. Backup results are also displayed in the window.

  1. Open a cmd window and point the directory to the install location of your running Pentaho Server.
  2. Use the import-export script with your arguments for backing up the repository.
  3. Press Enter.

Windows

import-export.bat --backup --url=http://localhost:8080/pentaho --username=admin --password=password --file-path=c:/home/Downloads/backup.zip --logfile=c:/temp/logfile.log

Linux

./import-export.sh --backup --url=http://localhost:8080/pentaho --username=admin --password=password --file-path=/home/Downloads/backup.zip --logfile=/temp/logfile.log

Step 2: Restore the Pentaho Repository

Restoring your Pentaho Repository is also done through the use of command line arguments. The process for restoring both repositories is similar to the backup process, except for the differences shown in the examples below. These examples can be customized for your particular server. 

If an argument is required for successful restore and has not been provided, the missing requirement is displayed in the cmd window. Restore results are also displayed in the window.

  1. Open a terminal window and change the directory to the install location of your running Pentaho Server.
  2. Use the import-export script with your arguments for restoring the repository.
  3. Press Enter.

Windows

import-export.bat --restore --url=http://localhost:8080/pentaho --username=admin --password=password --file-path=c:/home/Downloads/backup.zip --overwrite=true --logfile=c:/temp/logfile.log

Linux

./import-export.sh --restore --url=http://localhost:8080/pentaho --username=admin --password=password --file-path=/home/Downloads/backup.zip --overwrite=true --logfile=/temp/logfile.log