1. Curator Styles

    2. Homepage

    3. Titles and Toolbars

    4. Group Overrides

    1. Pages Overview

    2. Tiles

    3. Error Pages

    4. SSRS Embedding

    5. Explorer

    6. User Customized Metrics

    7. Box Embedding

    8. Forms

    9. Blogs

    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. Import Data

    4. Connecting to Data Manager

    5. User Commenting

    6. 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

    5. Username Mapping

    6. User Sync and Membership Sync Overview

    7. Custom Attributes

    1. Frontend User Permissions

    2. Password Change

    3. Password Reset

    4. Password Expiration and Complexity

    5. Bypass Link-preview Security

    1. E-mail Configuration

    2. System Notifications

    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. Manual Restoration of Curator Backup

    9. Updating Curator Logging

    10. Third Party Cookies

    11. Troubleshooting Load Times

    12. Tableau API Debugging

    13. Curator Backup

    14. Taking a Manual Full Backup

    1. System Upgrade

    2. Disable Curator Upgrades

    3. Offline Upgrades (Airgapped)

    4. Dependency Updates

    5. 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

    Documentation: System Administration

    Taking a Manual Full Backup

    While we highly recommend using the built-in Full Backup functionality within Curator, there are times where that isn't possible or when implementing your own full backup process. This guide will cover the steps and commands that Curator uses to take a full backup. You may need to customize these steps for your own purposes.

    There are 2 sets of data that will need to be included in a full backup:

    1. Curator's Database
    2. Curator's File System

    Database Dump

    The way Curator backs up its database is by dumping the structure and data contained in that database to a SQL file. This SQL file will include the actual SQL code needed to recreate the tables and insert all of the data.

    The command Curator runs is:

    mysqldump -h $host -u $user -p --port=$port --databases $databaseName > $backupFilename


    • $host is the host name where the database lives. This is almost always localhost or
    • $user is the database user. Get this from your <web root>/config/database.php configuration file.
    • $port is the port the database runs on. This is almost always 3306. Get this from your <web root>/config/database.php configuration file if it's something other than 3306.
    • $databaseName is the name of the database inside of MariaDB/MySQL that houses Curator's data. Get this from your <web root>/config/database.php configuration file.
    • $backupFilename is the file to save the SQL dump into. Curator names this file $databaseName_$currentTimestamp.sql

    You will be prompted for the password when running this command. Get the password from your /config/database.php configuration file.

    Filesystem Backup

    To back up Curator's files, Curator just zips the entire web root directory (i.e. /var/www/html or C:\InterWorks\Curator), excluding any other full backup files. Curator stores its full backup files in the <web root>/storage/temp directory as full_backup_$currentTimestamp.zip by default, but this backup location may be configured to be a different directory.

    Curator Compatible Backups

    If you are trying to create a backup that's compatible with Curator's Full Backup functionality so that it can be restored with the click of a button, here are the details that will be important:

    1. The full backup zip archive must follow this naming convention, where the the middle part is replaced by an appropriate timestamp: full_backup_YYYYMMDD_HHMMSS.zip.
    2. The full backup zip archive must consist of 2 files:
      1. The database dump with the name of the database as the prefix (e.g. curator_), a timestamp that matches the full backup timestamp, and a .sql file extension. The name should look something like: curator_YYYYMMDD_HHMMSS.sql.
      2. The backup of the file system as a zip archive that must follow this naming convention, where the middle part is replaced by the same timestamp as the full backup: webroot_YYYYMMDD_HHMMSS.zip.
    3. In order to be restored by Curator, this file must be placed in <web root>/storage/temp/.