Enable white-label

Source: docs/guides/admin/white-label.md
On this page

When an organization is granted white-label, its customers see a sign-in page carrying that organization's own identity, and PDF reports print that organization's name in the footer instead of the platform's. White-label is beta (status).

For: the platform operator who grants the entitlement, and the organization admin who wants to know what it opens up. Before you start: a super admin account to enable it; the organization should already have its own domain if customers are meant to arrive on it.

Steps#

  1. A super admin opens Customers > Organizations ("Quản trị → Tổ chức") at /admin/orgs, opens the organization's panel, and finds White-label.
  2. Turn on Enable white-label for this organization. The switch is labeled with what it turns on: a dedicated sign-in page and the organization's name on the PDF footer.
  3. Once enabled, fill in PDF footer name (up to 120 characters). Leaving it blank falls back to the platform's own configured name, then its build default.
  4. The organization's own Settings > Sign-in page ("Cài đặt > Trang đăng nhập") tab appears only once the entitlement is on; opening it before that states plainly that the entitlement is not granted yet.

Verify#

  • The organization's dedicated sign-in page publishes and reaches customers at its own address.
  • A PDF export from that organization shows the configured name in the footer.

When something is wrong#

Symptom Likely cause Fix
The Sign-in page tab is missing The entitlement is not enabled for this organization A super admin enables it at /admin/orgs.
A published sign-in page still does not reach customers The entitlement was revoked after publishing The lookup itself checks the entitlement, not just the interface — content stays saved but stops being served until the entitlement is re-enabled.
An org admin cannot turn the entitlement on themselves This is only a super-admin action by design The sign-in page's own configuration schema does not accept that field, so a request to set it is rejected outright rather than silently ignored.
A custom domain shows the platform's own sign-in page The domain is configured but the white-label entitlement is not enabled These are independent: enable the entitlement separately from the domain.

What it does not cover#

Looks related Actually controlled by
The organization's own domain or subdomain Domain configuration, independent of this entitlement
In-app color palette and brand ink The organization's own theme, independent of this entitlement
OIDC or LDAP/AD login Each login method's own configuration

Limits#

  • An organization chooses only the name on the PDF footer, not surrounding text or layout — those belong to the platform build.
  • There is no partial grant: the sign-in page and the PDF footer branding turn on together.
  • The entitlement is re-checked on every page render and every PDF export, so revoking it takes effect immediately without deleting any saved content.