Brand Kindo as your own
Set your own app name, logo, favicon, footer disclaimer, and policy URLs for Self-Managed Kindo. Set defaults for the whole instance, and use a feature flag for per-organization changes.
How branding resolves
Section titled “How branding resolves”Branding uses the first available value in this order:
- The JSON value set for the organization.
- The environment-variable default for that field.
- The built-in Kindo default for an optional field without an environment-variable value.
Omit a field to inherit its environment-variable default. The app name also changes the API documentation titles; the other fields affect only the Kindo web app.
Defaults for the whole instance
Section titled “Defaults for the whole instance”Every field has a Kindo default, so branding is optional. Set the values below to rebrand.
| Environment variable | Application | Set to rebrand | Purpose |
|---|---|---|---|
NEXT_PUBLIC_DEFAULT_APP_NAME | next | Yes | Product name in the web app |
NEXT_PUBLIC_DEFAULT_LOGO_URL | next | Yes | HTTPS URL to the logo image |
NEXT_PUBLIC_DEFAULT_FAVICON_URL | next | Yes | HTTPS URL to the favicon |
NEXT_PUBLIC_DEFAULT_PRIVACY_URL | next | Yes | HTTPS URL to the privacy policy |
NEXT_PUBLIC_DEFAULT_TERMS_OF_USE_URL | next | Yes | HTTPS URL to the terms of use |
NEXT_PUBLIC_DEFAULT_TERMS_OF_SERVICE_URL | next | Yes | HTTPS URL to the terms of service |
NEXT_PUBLIC_DEFAULT_MARKETING_WEBSITE_CONTACT_URL | next | Yes | HTTPS URL for the “Contact us” link |
NEXT_PUBLIC_DEFAULT_PUBLIC_DOCS_URL | next | No | HTTPS URL to your Kindo Docs site |
NEXT_PUBLIC_DEFAULT_DISCLAIMER | next | No | Footer disclaimer text |
NEXT_PUBLIC_DEFAULT_DISCLAIMER_POLICY_URL | next | No | HTTPS URL linked from the disclaimer |
DEFAULT_APP_NAME | api, task-worker-ts | Yes | Product name in API documentation and server-rendered text |
DEFAULT_PUBLIC_DOCS_URL | task-worker-ts | No | Base URL for Kindo Docs search results |
Configured URL fields must use HTTPS.
To set the defaults for the whole instance, set each value for the application the table names, then apply:
kindo config set overrides.serviceEnv.next.NEXT_PUBLIC_DEFAULT_APP_NAME="Acme AI"kindo config set overrides.serviceEnv.next.NEXT_PUBLIC_DEFAULT_LOGO_URL=https://cdn.acme.example.com/logo.svgkindo config set overrides.serviceEnv.api.DEFAULT_APP_NAME="Acme AI"kindo config set overrides.serviceEnv.task-worker-ts.DEFAULT_APP_NAME="Acme AI"Apply the change:
kindo config applyKindo Docs search is off until all of these are true:
| Requirement | Name |
|---|---|
| The Kindo Docs search flag is on. | KINDO_DOCS_SEARCH |
| The docs URL, empty by default, points to a Kindo Docs site for the same version as your instance. | DEFAULT_PUBLIC_DOCS_URL |
| The requesting organization has no enabled branding flag. Enabling it for an organization turns off Kindo Docs search for that organization, even when its JSON value sets a docs URL or is invalid. | CUSTOM_WHITELABEL, publicDocsUrl |
JSON schema
Section titled “JSON schema”Use a JSON value to override fields for an organization. All fields are optional; omitted fields inherit the environment-variable defaults.
| Field | Type | Purpose |
|---|---|---|
appName | string | Product name in the web app, API documentation, and server-rendered titles |
logoUrl | HTTPS URL | Top navigation and login logo |
faviconUrl | HTTPS URL | Browser tab favicon |
disclaimer | string | Footer disclaimer text |
disclaimerPolicyUrl | HTTPS URL | Link from the disclaimer |
privacyUrl | HTTPS URL | Privacy policy link |
termsOfUseUrl | HTTPS URL | Terms of use link |
termsOfServiceUrl | HTTPS URL | Terms of service link |
marketingWebsiteContactUrl | HTTPS URL | ”Contact us” link |
publicDocsUrl | HTTPS URL | Public docs link |
An invalid value, such as malformed JSON, a non-HTTPS URL, or a wrong type, produces a warning in the logs. Branding falls back to the environment-variable defaults for the whole value.
Example JSON
Section titled “Example JSON”{ "appName": "Acme AI", "logoUrl": "https://cdn.acme.example.com/branding/logo.svg", "faviconUrl": "https://cdn.acme.example.com/branding/favicon.png", "disclaimer": "Acme AI is for internal use only. Do not paste customer PII.", "disclaimerPolicyUrl": "https://acme.example.com/legal/ai-policy", "privacyUrl": "https://acme.example.com/legal/privacy", "termsOfUseUrl": "https://acme.example.com/legal/terms", "termsOfServiceUrl": "https://acme.example.com/legal/tos", "marketingWebsiteContactUrl": "https://acme.example.com/contact", "publicDocsUrl": "https://docs.acme.example.com"}Configure branding for an organization
Section titled “Configure branding for an organization”This applies once Kindo’s applications read their flags from Flagsmith.
-
Sign in to Flagsmith and open the project and environment your instance uses.
-
Open the
CUSTOM_WHITELABELfeature. Flagsmith may list it in lowercase. Create it if it is missing. Leave it off for the environment, so organizations without an override keep the environment-variable defaults. -
Create a segment for the organization, named after it. Add one rule: the trait
orgIdequals the organization’s ID. -
Add a segment override for that segment on the feature. Turn it on and paste the JSON from the example above into its Value field.
-
Verify the branding. Sign in to Kindo as a user of the organization. Check the app name, logo, favicon, and disclaimer. Sign in as a user of another organization and confirm the environment-variable defaults still apply there.
To brand another organization, create another segment and override with its own JSON.
Troubleshooting
Section titled “Troubleshooting”| Symptom | Likely cause | Fix |
|---|---|---|
| Branding shows Kindo defaults even with the flag enabled | Branding defaults are unset and the JSON value does not supply them | Set and apply the values using the config settings above |
| Logo or favicon does not load | Asset URL uses http:// | Re-host the asset over HTTPS |
| Flag value is ignored | Invalid JSON, URL, or field type | In the browser developer console, look for Feature flag CUSTOM_WHITELABEL JSON failed to parse; in the api and task-worker-ts pod logs, look for Failed to parse feature flag JSON |
| Wrong organization sees the branding | The feature is on for the whole environment, or the segment’s orgId rule is wrong | Turn the feature off for the environment, keep it on only in the segment override, and check the rule’s orgId |
| Branding flickers between defaults and the override | Branding can take a short time to appear after a JSON value change | Wait briefly and check again |
