Skip to content
Docs

Site branding

Site branding lets a company put its own logo and colour on its site. People see them in the top bar and across the interface. It is for site administrators.

Branding belongs to a site, the workspace on <company>.orbit.inortix.com. Everyone on the site sees it.

What you can set

Section titled “What you can set”
Setting What it does
Logo Replaces the Orbit mark in the top bar
Accent colour Colours the interface in both the light and the dark theme: buttons, accent text and tints

Only a site administrator signed in as a person can change branding. An API token can read it but not change it.

Today every site administrator can set a logo and colour, whatever the plan. In the plan catalogue planned for launch, your own logo and colour come with Business and Enterprise. That split is Planned. See Pricing and Plans and billing.

Section titled “Set the logo”

  1. Open the Branding section of site administration.

  2. Upload a picture, or replace the current one. The file must be PNG, JPEG, GIF or WebP, up to 512 KB. Orbit checks the file before it sends it. SVG files are refused.

  3. Check the top bar. The logo is shown at most 26 pixels high and 120 pixels wide.

If the picture cannot be loaded, the top bar falls back to the Orbit mark. To go back to the Orbit mark on purpose, remove the logo.

Set the accent colour

Section titled “Set the accent colour”

  1. In the Branding section, choose a colour from the ready colours, choose the theme’s own colour, or enter your own as #rrggbb.

  2. Look at the preview. It shows the colour in a light and a dark theme.

  3. Read the contrast notes, then save.

How the colour field behaves:

  • While you type, only a complete #rrggbb value counts.
  • A short value such as #36d counts when you press Enter or leave the field.
  • An empty field means the theme’s own colour.
  • Text that is not a colour is never saved.

Contrast checks

Section titled “Contrast checks”

Orbit checks your colour against WCAG AA in both themes.

Check Rule
Button text White text on a button of your colour must reach a contrast of 4.5 to 1. If it does not, the page warns you, and you decide.
Dark theme If the dark background would hide your colour, Orbit lightens it and says so. The aim is a contrast of at least 3 to 1.

Orbit derives the shades of the accent for each theme. Accent text stays at a contrast of 4.5 to 1 on the page, on panels and on every tint.

Read branding from the API

Section titled “Read branding from the API”

Anyone on the site can read its branding. A missing logo or colour is null, which means the theme default.

Read the branding of a site
curl -H "Authorization: Bearer opt_..." \
  https://acme.orbit.inortix.com/api/v1/site/branding

The answer holds siteId, name, host, logoUrl, accentColor and canManage. A site administrator changes the accent colour with PUT /site/branding, and the logo with PUT /site/branding/logo and DELETE /site/branding/logo. A bad value answers 400 invalid_branding, and anyone who is not a site administrator gets 403 site_admin_required.

What is not available yet

Section titled “What is not available yet”
Not yet branded Status
Browser tab icon Planned
Site name Planned
E-mail sender Planned
Login page Planned
Branding for a whole organization Planned
Your own domain (Enterprise) Planned
Section titled “Related”