Deployment
Branding and white-label configuration
Set the application name and visual assets, host brand files safely, verify browser behavior, and coordinate branding across replicas.
Envoy can expose a deployment-specific application name, logo, compact icon, and browser favicon. Branding changes presentation; they do not change resource slugs, API paths, permissions, or data ownership.
Configure branding
In server configuration:
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.icoEmpty asset values fall back to the product defaults. Use the same configuration on every control-plane replica.
Host assets
Use HTTPS URLs reachable by each user's browser. The asset host should:
- return the correct content type;
- permit browser loading from the Envoy origin;
- avoid authentication redirects;
- have stable URLs and cache headers;
- serve vector or appropriately sized raster assets;
- avoid embedding private data or tracking parameters.
The browser, not only the Envoy server, must be able to reach the URLs.
Prepare visual variants
Supply:
- a horizontal logo that remains readable on the application background;
- a compact square icon for collapsed navigation;
- a standard favicon format for browser tabs;
- adequate contrast in light and dark themes, if both are enabled.
Do not encode environment-sensitive text into an image if it also needs to be available to screen readers. Keep app_name meaningful.
Apply and verify
- Update the deployment's server configuration.
- Roll or restart control-plane replicas using the supported procedure.
- Open the sign-in page and authenticated application.
- Check full and collapsed navigation.
- Check browser tab title and favicon.
- Test light and dark themes.
- Verify assets in a private browser session.
- Hard-refresh after changing a cached asset URL.
Use versioned asset URLs when a CDN or browser continues serving an old file.
Security considerations
- Host assets on an approved domain.
- Do not place credentials or signed short-lived URLs in configuration.
- Keep SVG files free of scripts and untrusted external references.
- Apply normal change review to brand assets.
- Confirm content-security policy allows the chosen origin.
Branding is returned by a public configuration endpoint so the sign-in page can render it. Treat every configured branding value as publicly visible.