Skip to main content

Branding backup and restore

Custom branding configuration is stored on the file system rather than in the database. To protect your branding customizations during upgrades, migrations, or disaster recovery, include the branding files in your backup procedures.

Files to back up

The authoritative source for all branding data is the design/custom/branding/ directory. Back up the following:

  • design/custom/branding/branding.json — The branding configuration file containing color settings, logo metadata, and file references.

  • design/custom/branding/ — All uploaded logo files in this directory (named with content hashes, for example primary-light-a1b2c3d4.png).

Note

The ui/v2/assets/branding/ directory also contains copies of these files for runtime use, but it is not necessary to back up this location separately. It is populated from design/custom/branding/ during deployment.

Backup procedure

  1. Navigate to the instance directory: <instance>\design\custom\branding\

  2. Copy the entire branding\ directory (including branding.json and all logo files) to your backup location.

  3. Verify the backup contains all logo files referenced in branding.json.

Restore procedure

  1. Copy the backed-up branding\ directory to <instance>\design\custom\branding\.

  2. Copy the same files to <instance>\ui\v2\assets\branding\ to restore React UI branding immediately.

  3. To restore branding for the legacy Angular UI, trigger a skin rebuild from the branding admin interface or run the following commands from the <instance>\design\ directory:

    make.bat default en-us
make.bat install default en-us

    Repeat for each installed language.

  4. Verify the branding appears correctly by loading the application in a browser (clear browser cache if needed).

Upgrades and migrations

During a Bravura Security Fabric upgrade:

  • The design/custom/branding/ directory is preserved by the upgrade process. Custom branding should survive upgrades without manual intervention.

  • After upgrading, verify that ui/v2/assets/branding/branding.json is present. If it is missing, copy it from design/custom/branding/branding.json or trigger a rebuild from the admin interface.

  • As a precaution, always back up your branding files before performing an upgrade.

Fresh installations

On a fresh install, no custom branding exists. The make.bat process seeds default branding configuration on first run. To apply previously backed-up branding to a fresh installation, follow the restore procedure above after the initial installation is complete.

In this section: