Product Branding
System administrators can white-label the registry UI with a custom product name, logo, colors, and login page appearance. Branding settings are stored in the database, applied app-wide, and cached client-side for faster portal load times. All branding input is sanitized against an allowlist to prevent unsafe text or URLs.
Branding is managed under Administration → Configuration → Branding.
Configure Branding
To view or edit branding settings:
- Expand Administration in the navigation pane.
- Click Configuration, then select Branding.
- Update the fields you want to customize (see the reference table below for all available fields).
- Click Save to apply the changes.
Changes take effect immediately for new sessions. Existing sessions pick up the new branding on the next page load.
What Branding Controls
The following aspects of the portal UI are driven by branding configuration:
| Setting | Effect |
|---|---|
| Product name | Browser tab title, About dialog, search placeholder |
| Logo | Header logo and favicon |
| Product Introduction | Login page welcome copy |
| Log-in title | browser tab title |
| Log-in background image | Full-image background on the login page (accepts a full image URL) |
| Header background color (light mode) | Header bar in light theme |
| Header background color (dark mode) | Header bar in dark theme |
API Reference
Branding can also be managed programmatically via the system info API.
| Endpoint | Method | Description |
|---|---|---|
/systeminfo/branding | GET | Returns the current BrandingConfig |
/systeminfo/branding | POST | Updates the BrandingConfig |
The BrandingConfig model includes fields for product name, logo, header colors (light and dark), introduction text, and sign-in background image URL.
Self-hosted portal branding configuration
Prerequisites
Before configuring branding on an upgraded instance, the database migration must be applied and the core service must be running the updated build:
- Apply migration
0171_8gears_2.14_branding.up.sqlto create thebrandingtable. - Regenerate the Swagger client and rebuild the portal after deploying the updated binaries.
- Restart the core service to pick up the new API endpoints.
Migration Notes
When upgrading an existing instance to this release:
- Run the database migration
0171_8gears_2.14_branding.up.sqlagainst your Harbor database to create the branding table. - Regenerate the Swagger client and rebuild the portal.
- Restart the core service.
If users report stale or incorrect branding values after the upgrade, instruct them to clear the branding key from their browser’s localStorage and reload the portal. This removes any previously cached branding data from before the migration.