Skip to the content

DocumentationWhite-label

Brand and deploy

White-label

Your own name, colour and logo on public pages

An organisation's public pages are its own (PLAN 7.9, concept note 14): its status page (also on its own verified domain, 3.12), its support page, and the page where a reporter follows a report wear the organisation's name, colour and logo instead of OpsCommand's.

Every planWith white-label (Enterprise, Private Enterprise)
Name, colour, logo on the public pagesyesyes
"Powered by OpsCommand" under themshownmay be left out

Administration → Brand (organisation.manage):

  • Name shown: left empty, the organisation's name.
  • Colour: a #rrggbb accent for the page's header. The text on it is white or black, whichever reads better; the better of the two is at least 4.58:1 for any colour, so a brand colour never breaks WCAG 2.2 AA.
  • Logo: PNG, JPEG or WebP, at most 256 kB, recognised by its first bytes; never SVG, which can carry script. It is served from the API with a fingerprint in its address (cached for a day), Content-Security-Policy: default-src 'none'; sandbox, and nosniff.
  • Leave out "Powered by OpsCommand": only on a plan with white-label. If the organisation later moves to a plan without it, the credit returns by itself: the public answer checks the plan every time.

Everything is audited; the logo's bytes are left out of the audit chain and its SHA-256 kept.

Where

  • Database: migration 0055_branding (comms.brands, comms.save_brand, comms.brand_of, comms.public_brand by short address or verified domain — only for an organisation with a public page open — comms.brand_for_track by a report's tracking link, comms.public_logo).
  • API: GET/PUT /v1/organisations/{org}/brand; GET /v1/public/brand/{org}, /v1/public/brand-by-host/{host}, /v1/public/brand-by-track/{token}, /v1/public/brand/{org}/logo.
  • Web: src/lib/brand.tsx (PublicFrame, BrandCard); each public route's layout puts its page in the organisation's frame, and the app's own header and footer step aside there (Shell, by route segment, since a status page on its own domain is served at /). The pages' security policy allows images from the API for the logos.

Not yet: the reporting widget on the organisation's own site keeps its plain look; e-mails to reporters and subscribers are still sent under OpsCommand's address (the sender's display name is the next step).