1. Titles and Toolbars

    2. Homepage

    3. Curator Styles

    4. Group Overrides

    1. Pages Overview

    2. Tiles

    3. Error Pages

    4. SSRS Embedding

    5. Explorer

    6. User Customized Metrics

    1. Tutorials

    2. Search

    3. Managing Menus

    4. Menu Items

    5. Keywords

    6. Files

    7. Notices

    8. Loading Screens

    1. Embedded Tableau Server Views

    2. Thumbnails

    3. Tagged Workbooks

    4. Favorites

    5. Email Subscriptions

    6. Data Export

    7. Download Workbook

    8. Share Workbook

    9. Custom Views

    10. Pause/Resume Changes

    11. Dashboard Titles

    1. Filters

    2. Parameters

    3. Apply Button

    4. Filter Categories

    5. Hidden Sticky Filters/Parameters

    6. Specify Filter Sheet

    7. Mark Commenting

    8. URL Action Overrides (Link Target)

    9. Hidden Dashboards

    10. Replace Dashboard URLs

    11. Site Switcher

    12. Cache Filter/Parameter Options

    1. Data Manager Basics

    2. Web Data Connector (WDC)

    3. Connecting to Data Manager

    4. User Commenting

    5. Field Calculations

    1. Overview and Enabling

    2. Report Builder: Scheduled Reports Option

    3. Report Builder: Email Option

    4. Report Builder: Watermark Text

    1. Automatic License Provisioning

    2. Just-in-time (JIT) Provisioning

    3. Users and Groups

    4. Reset User's Password

    1. Frontend User Permissions

    2. Password Change

    3. Password Reset

    4. Password Expiration and Complexity

    1. E-mail Configuration

    1. Force SSL

    2. Trusted Tickets

    3. Basic HTTP Authentication

    1. Import / Export

    2. Backend Users

    3. Frontend Users

    4. Updating License Key

    5. Linux: Cron Troubleshooting

    6. Filesystem Permissions

    7. Backend Administrator Password Reset

    8. Dependency Updates

    9. Manual Restoration of Curator Backup

    10. Updating Curator Logging

    11. Third Party Cookies

    12. Troubleshooting Load Times

    13. Curator Backup

    14. Taking a Manual Full Backup

    1. System Upgrade

    2. Disable Curator Upgrades

    3. Offline Upgrades (Airgapped)

    4. Troubleshooting Upgrades

    1. Scripts

    2. Commands

    3. Subscription Routing

    1. Curator API Overview

    2. Integration

    3. Curator API

    4. Tableau API

    5. Content

    6. User API

    1. Username Mapping

Documentation: System Administration

Manual Restoration of Curator Backup

Warning

If you haven't attempted to use the Curator interface to restore from a full backup, go do that now (Backend > Settings > Curator > Import/Export > Full Backup tab). This guide is only needed if that fails for some hard-to-fix reason and it's an emergency to restore from a full backup.

It's also worth noting that, by default, Curator's full backups are stored on the same server as Curator. If something were to happen to the server, these could potentially disappear at the same time that Curator does. Please take steps to set up a server-level backup and/or store Curator's full backups in a safe, external location.

Preface

Curator's full backups are a zip archive containing the following files:

  • MySQL/MariaDB database dump (as a SQL script)
  • The contents of Curator's web root directory, which contains all of the code, configuration, and uploads (as a zip archive)

The restoration process essentially overwrites all of the files on the server with the contents of the web root directory and runs the SQL script to overwrite the database.  These are the steps you'll need to perform when manually restoring from a full backup.

Handling Different Database Connections

Curator stores the database connection details in <web root>/config/database.php.  The zip archive of the web root within a full backup also contains these connection details.  If the database connection differs from the system the backup originated from to the system being restored over, you'll need to perform these steps prior to restoring:

  1. Unzip the full backup zip archive to a temporary location (i.e. not inside either Curator portal’s actual web root).
  2. Unzip the web root zip archive.
  3. Modify the config/database.php file as needed in the extracted web root folder to match the connection details of the database you'll be restoring over.
  4. Re-zip the extracted web root folder (use the same file name for the resulting zip archive).
  5. If the MySQL/MariaDB database name (not to be confused with host or username) differs, rename that part of the database dump SQL script. Be sure to retain the datestamp and file extension portions of the file name.
  6. Re-zip the web root zip archive (not to be confused with the extracted web root directory) and the database dump SQL script as the full backup (use the same file name for the resulting zip archive).
  7. Transfer the updated full backup zip archive to the system you wish to restore over and place it in the directory where full backups are stored (default is <web root>/storage/temp/).

Manually Restoring the Database

If you haven't already, unzip the full backup zip archive to extract the database dump and transfer that SQL script to the system you'll be restoring over.

Make the following replacements in the commands below.  If you don't know the values, look at the <web root>/config/database.php file on the system you'll be restoring over.

  • $host: The database host.  This is normally localhost unless you have an external database.
  • $user: The database username.
  • $port: This is almost always 3306, unless you've customized your database configuration to run on a different port.
  • $name: This is the database name.  Each MySQL/MariaDB host can store many different databases, usually this is curator, but it could be different.
  • $dbDumpFilename: This is the file name to the database dump file.  Include the full file path if running the command from a different directory that where the SQL script lives.

NOTE: You will be prompted for the database password while the command runs.

mysql -h $host -u $user -p --port=$port --database $name < $dbDumpFilename

Manually Restoring the File System

Step 0 for Linux Systems

Before beginning on Linux systems, run the following commands to determine which system user and group owns Curator's web root.  It will be needed during the process.

cd /var/www/html
ls -l

The user and group should either be apache or www-data and should be listed next to all of the files.  The commands below will assume apache, but replace it with www-data if your system lists it here instead.

Restoration Process

  1. If you haven't already, unzip the full backup zip archive to extract the web root directory backup and transfer that zip archive to the system you'll be restoring over.
  2. In a temporary location on the Curator server outside of Curator's web root directory (make note of the location), unzip the web root directory backup (i.e. the file that matches the pattern: webroot_YYYYMMDD_HHMM.zip).
    • Linux Command:
      sudo -u apache unzip webroot_YYYYMMDD_HHMM.zip
    • On Windows systems, you should be able to utilize the built-in zip extract function, though alternatives like 7-zip may be faster.
  3. In the web root directory, delete directories as follows:
    • Linux Command:
      sudo rm -Rf /var/www/html/modules /var/www/html/plugins /var/www/html/themes /var/www/html/vendor
    • On Windows systems, delete these folders using Windows Explorer:
      • modules
      • plugins
      • themes
      • vendor
  4. Copy the contents of the extracted web root backup to the actual web root directory.
    • Linux Command:
      sudo -u apache cp -a /path/to/extracted/webroot/backup/* /var/www/html/
    • On Windows systems, use a copy/paste or select/drag operation within Windows Explorer.
  5. Fix file permissions as needed.  See this document for details: https://curator.interworks.com/page/kb?doc=Filesystem%20Permissions