From 4c4b3d7337e974de65b9366248fa7185a275d7b6 Mon Sep 17 00:00:00 2001 From: Mauricio Siu Date: Tue, 10 Mar 2026 10:27:15 -0600 Subject: [PATCH] feat: add Whitelabeling documentation and update enterprise index - Introduced a new Whitelabeling documentation page detailing customization options for branding, appearance, metadata, and error pages. - Updated the enterprise index to include a description of the Whitelabeling feature. --- .../content/docs/core/enterprise/index.mdx | 2 +- .../docs/core/enterprise/whitelabeling.mdx | 76 +++++++++++++++++++ .../docs/core/enterprise/whitelabeling.txt | 37 --------- 3 files changed, 77 insertions(+), 38 deletions(-) create mode 100644 apps/docs/content/docs/core/enterprise/whitelabeling.mdx delete mode 100644 apps/docs/content/docs/core/enterprise/whitelabeling.txt diff --git a/apps/docs/content/docs/core/enterprise/index.mdx b/apps/docs/content/docs/core/enterprise/index.mdx index 5dc94ce..380e854 100644 --- a/apps/docs/content/docs/core/enterprise/index.mdx +++ b/apps/docs/content/docs/core/enterprise/index.mdx @@ -7,7 +7,7 @@ description: Enterprise features for SSO, whitelabeling, and audit logs ## What's included - **Single Sign-On (SSO)** — Integrate with Auth0, Keycloak, or other OIDC/SAML providers. -{/* - **Whitelabeling** — Rebrand the UI with your logo, colors, and domain (self-hosted only) (). */} +- **Whitelabeling** — Rebrand the UI with your logo, colors, and domain (self-hosted only). {/* - **Audit logs** — Track user actions and changes for compliance and security. */} More Enterprise features are on the way. [Contact us](https://dokploy.com/contact) if you want early access or have specific requirements. diff --git a/apps/docs/content/docs/core/enterprise/whitelabeling.mdx b/apps/docs/content/docs/core/enterprise/whitelabeling.mdx new file mode 100644 index 0000000..6f53fb7 --- /dev/null +++ b/apps/docs/content/docs/core/enterprise/whitelabeling.mdx @@ -0,0 +1,76 @@ +--- +title: Whitelabeling +description: Rebrand Dokploy with your application name, logos, colors, and custom links +--- + +Whitelabeling lets Enterprise users fully rebrand their Dokploy instance. You can customize the application name, logos, favicon, appearance, metadata, links, and error pages — all from **Settings → Whitelabel**. + +## Branding + +Customize the application name, logos, and favicon to match your brand identity. + +| Field | Description | +| --- | --- | +| **Application Name** | Replaces "Dokploy" across the entire interface. | +| **Application Description** | Tagline shown on the login/onboarding pages. Defaults to the standard Dokploy description if empty. | +| **Logo URL** | Main logo shown in the sidebar and header. Recommended size: 128×128px. | +| **Login Page Logo URL** | Logo displayed on the login page. If empty, the main logo is used. | +| **Favicon URL** | Browser tab icon. Supports `.ico`, `.png`, and `.svg` formats. | + +## Appearance + +Customize the look and feel of the application with custom CSS. + +The **Custom CSS** editor lets you inject custom CSS styles globally. Click **Load Default Styles** to get the base theme CSS variables as a starting point, then modify the values to match your brand. + +Example — changing background and foreground colors: + +```css +/* Light Mode */ +:root { + --background: 0 0% 100%; + --foreground: 240 10% 3.9%; + --card: 0 0% 100%; + --card-foreground: 240 10% 3.9%; + --popover: 0 0% 100%; + --popover-foreground: 240 10% 3.9%; +} +``` + +## Metadata & Links + +Customize the page title, footer text, and sidebar links. + +| Field | Description | +| --- | --- | +| **Page Title** | Browser tab title. Defaults to "Dokploy" if empty. | +| **Footer Text** | Custom text displayed in the footer area. | +| **Support URL** | Custom URL for the "Support" link in the sidebar. | +| **Documentation URL** | Custom URL for the "Documentation" link in the sidebar. | + +## Error Pages + +Customize the error page messages shown to users. + +| Field | Description | +| --- | --- | +| **Error Page Title** | Title shown on error pages. | +| **Error Page Description** | Description text shown on error pages. Defaults to "We're sorry, but an unexpected error occurred. Please try again later." | + +## Live Preview + +The whitelabel settings page includes a **Live Preview** section at the bottom. It shows a quick preview of how your branding changes will look — including the logo, application name, button styles, and footer text — before you save. + +## Actions + +- **Reset to Defaults** — Revert all whitelabel settings back to the default Dokploy branding. +- **Save Changes** — Apply your customizations. + +## Best practices + +- Use high-resolution logos (e.g. 2×) for sharp display on retina screens. SVG format is recommended for perfect scaling. +- Keep your custom CSS colors accessible with sufficient contrast for text and buttons. +- Test the login page, dashboard, and key workflows after applying changes to ensure nothing is broken or hard to read. +- Always preview your changes using the Live Preview section before saving. + +For help enabling or configuring whitelabeling, [contact us](https://dokploy.com/contact). diff --git a/apps/docs/content/docs/core/enterprise/whitelabeling.txt b/apps/docs/content/docs/core/enterprise/whitelabeling.txt deleted file mode 100644 index 64c69b7..0000000 --- a/apps/docs/content/docs/core/enterprise/whitelabeling.txt +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Whitelabeling -description: Rebrand Dokploy with your logo, colors, and domain ---- - - -## What you can customize - -- **Logo** — Header and login logo. -- **Favicon** — Browser tab icon. -- **Colors** — Primary color and accent (e.g. buttons, links). -- **Custom domain** — Serve the app from your own domain (e.g. `deploy.yourcompany.com`). - -## Configuration - -Whitelabel settings are managed in the Enterprise admin area (or via environment variables, depending on your deployment). - -1. Go to **Settings** → **Whitelabel** (or equivalent in your Enterprise setup). -2. Upload your **logo** (recommended: SVG or PNG, transparent background). -3. Upload your **favicon** (e.g. ICO or PNG). -4. Set **primary color** and **accent color** (hex codes). -5. If using a custom domain, configure your reverse proxy (e.g. Traefik, Nginx) and DNS to point to your Dokploy instance, and set the **base URL** in Dokploy to match. - -## Custom domain - -1. Create a CNAME (or A) record pointing your domain to the server or load balancer where Dokploy runs. -2. Configure TLS (e.g. Let's Encrypt) on your reverse proxy for that hostname. -3. In Dokploy, set the **Application URL** (or equivalent) to `https://your-domain.com`. -4. Restart or reload Dokploy so it uses the new base URL for redirects and links. - -## Best practices - -- Use high-resolution logos (e.g. 2x) for sharp display on retina screens. -- Keep primary and accent colors accessible (sufficient contrast for text and buttons). -- Test login and main flows after changing logo and colors to ensure nothing is broken or hard to read. - -For help enabling or configuring whitelabeling, [contact us](https://dokploy.com/contact).