Testing Upgrades in a Non-Production Environment
Before upgrading a production instance, we strongly recommend validating the upgrade against a separate dev or staging instance that mirrors production. This catches version-specific issues against your actual data and configuration before they affect end users. A standard Curator license covers up to three instances, so a dedicated non-production instance is available at no additional cost in most cases. The recommended workflow is:- Export production data. From the production instance, navigate to Settings > Curator > Import/Export and run a full export. Download the resulting archive.
- Stand up a dev instance at the same version as production. Install a fresh Curator instance running the exact same version as production, then use the Import/Export tool on the dev instance to import the archive from step 1. The dev instance should now closely match production.
- Upgrade and validate the dev instance. Perform the upgrade on the dev instance using whichever method you plan to use in production (One-click, Manual, or API). Once the upgrade completes, exercise the integrations and pages most critical to your users — Tableau, Power BI, or ThoughtSpot dashboards, SSO sign-in, scheduled syncs, and any custom themes or pages. Confirm everything renders and behaves as expected.
- Back up and upgrade production. Only after the dev upgrade is validated, take a full Curator Backup of production and then run the same upgrade against production.
Upgrading Curator
One-click Upgrade:- Login to the backend of your Curator instance (e.g.
https://curator.example.com/backend). - Navigate to the Settings > Curator > System Upgrade section using the left-hand menu.
- Click the button at the top right, which names the newest release (for example “Upgrade to 2026.09-02”).
- To upgrade to a release other than the newest one, click “Upgrade to This Version” on that release in the timeline instead.
- Login to the backend of your Curator instance (e.g.
https://curator.example.com/backend). - Navigate to the Settings > Curator > System Upgrade section using the left-hand menu.
- On a machine that does have internet access, open the same page and click “Download Archive” on the release you want. This downloads a .zip file containing the upgrade contents.
- Back on the Curator server, click “Upgrade From an Archive” below the tiles. This opens the panel of the same name.
- Click “Choose Archive”, select the .zip file you downloaded, and click “Upload and Upgrade”.
- Login to the backend of your Curator instance (e.g.
https://curator.example.com/backend). - Navigate to the Settings > Curator > API Keys section using the left-hand menu.
- Select an existing key or create a new key
- If creating a new key, save the key.
- From the REST API dropdowns, select ‘Portal’ in the left dropdown and ‘Upgrade’ in the right dropdown.
- Click the link that was generated below the drop-downs.
- This will open a new tab, when upgrade is successful a small success text display will populate.
Changing Your License Key
The status line at the top of the System Upgrade page shows when your license expires, followed by a “Change License Key” link. That link opens a page which repeats the current expiry date and takes the new key. Paste the full key from your InterWorks license email exactly as it appears there and click “Save Key”. The key is saved as entered and is not checked first, and upgrades need a valid key, so a mistyped or partial key leaves the instance unable to upgrade until it is corrected. “Back to System Upgrade” returns to the page without saving. If the license has expired or no key is set, the status line says so instead of showing an expiry date, and every upgrade control on the page is withdrawn: the button at the top, the archive upload, and the per-release actions. Entering a valid key restores them. This link does not appear on a portal hosted by InterWorks, because InterWorks manages the license there.Troubleshooting
Having Issues With the Upgrade? Try our Upgrade Troubleshooting Documentation.PHP Version Compatibility
The System Upgrade page automatically checks your server’s PHP version against each release’s minimum PHP requirement. If your server’s PHP version is too old for a given release:- That release’s action is disabled and reads “PHP X.X+ Required” in red, with the version this server runs on the line below it.
- If the newest release needs a newer PHP, the button at the top of the page is disabled and carries the same label, so an upgrade to it cannot be started from there either.
- That release is never put forward as the “Recommended next step”. The recommendation moves to the newest release of that month your server can actually install.
- If you reach an incompatible release another way, the confirmation dialog blocks the upgrade and directs you to update PHP first.
Database Version Compatibility
Starting with 2026.06-01, Curator also checks your server’s MySQL or MariaDB version against each release’s minimum database requirement. Older database versions are no longer compatible with the underlying framework. If your server’s database version is too old for a given release, the upgrade will be blocked and you will see an error similar to:ERROR: Your Curator server’s MariaDB version (10.3.39) is too old. You need MariaDB 10.5 or newer before upgrading Curator. Reach out to Curator support if you need help with this.The minimum supported versions are MySQL 8.0 and MariaDB 10.5. To resolve this, upgrade your database engine before upgrading Curator. See the Database Dependencies by Curator Version section of our Dependency Updates page for the version table and platform-specific upgrade instructions.
Known Issues
The System Upgrade page also shows the known issues InterWorks has published for each release, so you can see what affects a release before you upgrade to it and what affects the release you are running today. When a release has known issues:- An “N known issues” badge appears under the release in the timeline.
- A “Known Issues (N)” heading appears under the release notes. The list is collapsed by default; click the heading to expand it.
- Each entry is a bullet that starts with an impact badge (Small, Medium, or Large), followed by a short note describing the behavior. An entry without a note shows the issue title instead.
- A smaller line under the note lists the affected areas of Curator. When known, it also shows “Since X” with the release where the issue first appeared. When a later release fixes the issue, it shows “Fixed in X” with that release version.
Multi-month Upgrades
We recommend upgrading no more than one month of releases at a time. Curator releases are tagged by year and month, such as2026.08-03. Moving to another release in the same month, or
to any release in the month after it, is a normal step. Moving two or more months ahead is the jump we recommend
against, and the confirmation dialog warns about it.
If your instance is several months out of date, step through the months rather than jumping straight to the newest
release. The timeline marks the release to take next as the “Recommended Next Step”: it is the newest release of the
month after the one you are running. Upgrade to that release, then repeat until you reach the newest release. Use
the per-release “Upgrade to This Version” action for each step, rather than the button at the top of the page, which
always targets the newest release.
The recommended step never raises the warning itself, however far ahead it sits. If no release was published in the
months right after the one you are running, the nearest later release is both the recommended step and more than a
month away, and taking it is the move we are asking for.
Common Upgrade Gotchas
When planning an upgrade — especially when jumping several versions — keep the following in mind. Most of these are covered in more detail elsewhere in the docs; this list is a quick pre-upgrade checklist so you know what to watch for.- PHP version requirement — Each release declares a minimum PHP version. The System Upgrade page disables the upgrade action for that release, showing a red note naming the PHP version it needs, and blocks one-click upgrades if your server’s PHP is too old. Upgrade PHP first. See the PHP Version Compatibility section above and the Dependency Updates page.
- Database version requirement — Starting with 2026.06-01, the upgrade is also blocked if your MySQL or MariaDB version is too old (minimums are MySQL 8.0 and MariaDB 10.5). Upgrade your database engine first. See the Database Version Compatibility section above.
- Upgrading too many months at once. Jumping two or more months of releases in a single step is not recommended. For an instance several months out of date, follow the “Recommended next step” marker on the timeline and upgrade one month at a time. See Multi-month Upgrades above.
- Database migrations not applied — If the upgrade completes but new features appear missing or the system behaves unexpectedly, the database migrations may not have finished. You can safely re-run them multiple times; follow the steps in Updating the Curator Database (Running Migrations).
- Stale cache after upgrade — Unexpected behavior immediately after an upgrade is often a stale cache. Ask
end users to hard-refresh their browser (
Ctrl+Shift+R/Cmd+Shift+R). To flush Curator’s server-side cache, use the Clear Cache button in the backend, or append?cache=clearto any Curator page URL. - Authentication and session changes — Some releases adjust session handling or SSO sign-in. If users are unexpectedly signed out or cannot authenticate after an upgrade, review the release notes for any intermediate versions you skipped and consult the Upgrade Troubleshooting guide.
- Always upgrade non-production first — Validate the upgrade against a dev or staging instance before touching production. See Testing Upgrades in a Non-Production Environment above.