Backups overview
Save installation files before a change and choose the right way to recover them.
A backup saves files from one Sprocket Rocket installation so you can restore them later. Use a recent backup to recover custom code, reverse a module change, or restore files after an unsuccessful update.
Create a manual backup before a major update or a change to custom code, and wait for it to finish. Updates do not automatically create a fresh backup. An initial backup can be useful, but it does not include work added since it was created.
Start here
| What you want to do | Guide |
|---|---|
| Save the current installation and name the recovery point | Create and manage backups |
| Recover files across an installation | Restore an installation |
| Recover one module or file, or choose a published release | Restore modules and files |
| Prepare an older client installation or recover from a failed update | Legacy updates and recovery |
Backups belong to an installation
A HubSpot portal can contain several installations, each with its own folder and backup history. Backing up one installation does not back up the other installations in that portal.
Open the correct organization, portal, and installation before creating or restoring a backup. From an open installation, open the user menu using the profile icon and select Backups. This menu item appears when you are inside an installation.
What a backup can recover
Manual backups capture the files in the installation folder at the time of the scan, including custom files found there. Recovery is limited to the files captured in the selected backup.
| Content | What to expect |
|---|---|
| Module code and field definitions | Restore captured HTML, CSS, JavaScript, and module configuration. |
| Core files and templates | Restore captured theme files, macros, stylesheets, scripts, and templates. |
| Images and other files inside the installation folder | Restore them when they are included in the backup. |
| Page text, images selected in page fields, and page layouts edited in HubSpot | A file restore does not roll these edits back. It restores the code used to render the pages. |
| HubSpot File Manager, CRM data, forms, domains, and account settings | An installation backup is not a whole HubSpot account backup. |
| Files outside the installation folder | Do not assume they are covered. This includes separately stored shared libraries or assets. |
Restoring code can change the appearance or behavior of every page that uses it, even though the pages' saved field values have not changed. Always check affected pages after a restore.
Initial and manual backups
The Initial backup is the first recovery point recorded when Sprocket Rocket installs or adopts an installation. For a fresh installation, it may contain only the files deployed in that first stage. Modules or templates installed afterward are not added retroactively to that backup.
A Manual backup captures the installation as it exists when you create it. Give it a useful name, such as “Before navigation update,” so you can identify it later. Check both its creation date and file count; a larger count does not by itself mean it is the right recovery point.
A backup and a catalog version are different
A Backup restores your captured files, including customizations present when it was created. A Catalog version installs the published Sprocket Rocket release and can replace customizations. Choose a backup when your goal is to recover your own previous work.
See Restore modules and files for the available actions and their scope.