Portal Branding

Your customers sign in to the customer portal to get their licenses, pull tokens and release files. Portal branding puts your logo, your name and your color on those pages, so your customers see your product rather than Breakwater's.

Portal branding is part of the Growth, Business and Enterprise plans.

Setting it up

Admins and owners set branding under Settings → Customer portal branding in the vendor portal. Everything is optional: anything you leave blank keeps Breakwater's default.

• Display name. Shown next to your logo and at the end of page titles, up to 60 characters. Left blank, your account name is used whenever you have a logo.
• Logo. PNG, JPEG or WebP, up to 256 KB, between 16 and 4,096 pixels on each side, and not animated. A transparent PNG at least 64 pixels tall looks best. SVG isn't accepted. The logo is shown up to 32 pixels tall in the sidebar, keeping its proportions.
• The logo includes our name. Tick this when your logo is a wordmark, so the name isn't repeated beside it.
• Logo for dark backgrounds (optional, once you have a logo). Shown instead of your logo in the dark theme, for logos that disappear on a dark background. Without one, your logo is used in both themes.
• Brand color. A hex color such as #1d4ed8. It replaces Breakwater's amber on primary buttons. The button text is black or white, whichever is easier to read on your color, so buttons always stay readable. A very light color gets a thin edge so the button still looks like a button.

The preview under the fields shows the saved branding in the light and dark themes. Use Remove logo, Remove logo for dark backgrounds and Reset to amber to go back to the defaults.

Where your customers see it

• Every portal page for one of your customers: licenses, setup, tokens, team, repositories, releases and pull history. Your logo and name replace Breakwater's in the sidebar, page titles end with your name, and primary buttons use your color. A small "Powered by Breakwater" line stays at the bottom of the sidebar.
• Invitations to your customers. When you or a customer admin invites someone to one of your customers, the page where they accept shows your branding, before they have an account.
• The customer selector. People who belong to customers of more than one vendor pick a customer first. That page stays Breakwater's, but each customer shows its vendor's logo.

If you set only a color, the sidebar keeps Breakwater's logo and name and only the buttons change.

Where it doesn't show

• Sign-in and password reset. Every vendor's customers sign in on the same page, so it stays Breakwater's.
• Emails. Invitation and license emails keep Breakwater's look. License emails already reply to your contact email.
• Account pages, the two-factor and Google or GitHub sign-in steps, and the browser tab icon.
• The registry hostname in your customers' docker login commands.

Plans

Portal branding is included on Growth, Business and Enterprise, not Starter.

If you move to Starter, your customers see Breakwater's look again, but nothing you set is deleted. Your logos, name and color are kept, and they show again as soon as you upgrade. While you're on Starter, the Settings card says your branding is saved and offers an upgrade instead of the fields.