Skip to content

branding

Tenant branding tokens (title, description, site URL, accent colour, logo, layout preset, optional custom CSS) read by managed pages, mail and PDF renderers and the document designer; set via config:write:set on branding:config:*, read via branding:query:tokens. Keys are write-validated (hex colour, https URLs, FileRef id) and readable anonymously so public pages can render them; a configEdit self-service screen (branding:screen:branding-settings) edits them. Raw custom CSS exists only when the app passes allowCustomCss and is additionally gated per tenant by the branding-css toggle. Requires config.

What this feature needs to run (Requires).

flowchart TB
  n_branding["branding"]
  subgraph how_reqs["Requires"]
    n_config["config"]
  end
  n_config --> n_branding
  • Requires: config
  • Activation: always on (not toggleable)

Per-tenant config keys, set via the tenant-admin UI or a seed. 🔒 = encrypted at rest.

KeyTypeDefaultScopeWho can writeWho can read
accent-colortext""tenantsystem, TenantAdmin, Admin, SystemAdminall
custom-csstext""tenantTenantAdmin, Admin, SystemAdminall
descriptiontext""tenantsystem, TenantAdmin, Admin, SystemAdminall
layout-presetselect (minimal | centered | wide)centeredtenantsystem, TenantAdmin, Admin, SystemAdminall
logo-filetext""tenantsystem, TenantAdmin, Admin, SystemAdminall
logo-urltext""tenantsystem, TenantAdmin, Admin, SystemAdminall
site-urltext""tenantsystem, TenantAdmin, Admin, SystemAdminall
titletext""tenantsystem, TenantAdmin, Admin, SystemAdminall