Documentation by ClonePartner

Start typing to search.

Deployment

Branding

View Markdown

Set the application name, logo, icon, and favicon in server config, understand the public branding endpoint, and verify assets.

Branding

Envoy can expose a deployment-specific application name, logo, compact icon, and browser favicon. Branding changes presentation only; it does not change resource slugs, API paths, permissions, or data ownership.

Configure branding

The branding section of envoy-server.yaml has four keys (src/server/config.ts):

branding:
  app_name: Acme Data Operations
  logo_url: https://assets.example.com/envoy/logo.svg
  icon_url: https://assets.example.com/envoy/icon.svg
  favicon_url: https://assets.example.com/envoy/favicon.ico

app_name defaults to Envoy; the three asset URLs default to empty strings, which fall back to the product defaults. Use the same configuration on every control-plane replica.

Docker first-boot generation reads ENVOY_APP_NAME, ENVOY_LOGO_URL, ENVOY_ICON_URL, and ENVOY_FAVICON_URL; the remote deploy script also patches the persisted YAML's asset URLs on later deploys.

How the API serves it

src/server/api/branding.ts exposes one route that returns the configured values, with empty asset URLs converted to null:

{
  "app_name": "Acme Data Operations",
  "logo_url": "https://assets.example.com/envoy/logo.svg",
  "icon_url": "https://assets.example.com/envoy/icon.svg",
  "favicon_url": "https://assets.example.com/envoy/favicon.ico"
}

The endpoint is public so the sign-in page can render branding before authentication. Treat every configured branding value as publicly visible.

Where it appears in the UI

  • the sign-in page (name and logo);
  • the sidebar navigation (logo expanded, icon collapsed);
  • the browser tab title and favicon.

Host assets

Use HTTPS URLs reachable by each user's browser — the browser loads them, not the Envoy server. The asset host should return the correct content type, permit loading from the Envoy origin, avoid authentication redirects, and have stable URLs and cache headers. Relative URLs refer to assets served with the UI, which is how customer builds ship bundled brand files.

Supply a horizontal logo readable on the application background, a compact square icon for collapsed navigation, a standard favicon, and adequate contrast in light and dark themes.

Apply and verify

  1. Update the deployment's server configuration.
  2. Restart control-plane replicas using the supported procedure.
  3. Open the sign-in page and the authenticated application.
  4. Check full and collapsed navigation, browser tab title, and favicon.
  5. Verify in a private browser session and hard-refresh after changing a cached asset URL.

Use versioned asset URLs when a CDN or browser keeps serving an old file.

Security considerations

  • Host assets on an approved domain; keep SVG files free of scripts and untrusted external references.
  • Do not place credentials or signed short-lived URLs in configuration.
  • Apply normal change review to brand assets.