Skip to content

Commit 4c4b3d7

Browse files
committed
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.
1 parent eb380e6 commit 4c4b3d7

3 files changed

Lines changed: 77 additions & 38 deletions

File tree

apps/docs/content/docs/core/enterprise/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Enterprise features for SSO, whitelabeling, and audit logs
77
## What's included
88

99
- **Single Sign-On (SSO)** — Integrate with Auth0, Keycloak, or other OIDC/SAML providers.
10-
{/* - **Whitelabeling** — Rebrand the UI with your logo, colors, and domain (self-hosted only) (). */}
10+
- **Whitelabeling** — Rebrand the UI with your logo, colors, and domain (self-hosted only).
1111
{/* - **Audit logs** — Track user actions and changes for compliance and security. */}
1212

1313
More Enterprise features are on the way. [Contact us](https://dokploy.com/contact) if you want early access or have specific requirements.
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: Whitelabeling
3+
description: Rebrand Dokploy with your application name, logos, colors, and custom links
4+
---
5+
6+
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**.
7+
8+
## Branding
9+
10+
Customize the application name, logos, and favicon to match your brand identity.
11+
12+
| Field | Description |
13+
| --- | --- |
14+
| **Application Name** | Replaces "Dokploy" across the entire interface. |
15+
| **Application Description** | Tagline shown on the login/onboarding pages. Defaults to the standard Dokploy description if empty. |
16+
| **Logo URL** | Main logo shown in the sidebar and header. Recommended size: 128×128px. |
17+
| **Login Page Logo URL** | Logo displayed on the login page. If empty, the main logo is used. |
18+
| **Favicon URL** | Browser tab icon. Supports `.ico`, `.png`, and `.svg` formats. |
19+
20+
## Appearance
21+
22+
Customize the look and feel of the application with custom CSS.
23+
24+
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.
25+
26+
Example — changing background and foreground colors:
27+
28+
```css
29+
/* Light Mode */
30+
:root {
31+
--background: 0 0% 100%;
32+
--foreground: 240 10% 3.9%;
33+
--card: 0 0% 100%;
34+
--card-foreground: 240 10% 3.9%;
35+
--popover: 0 0% 100%;
36+
--popover-foreground: 240 10% 3.9%;
37+
}
38+
```
39+
40+
## Metadata & Links
41+
42+
Customize the page title, footer text, and sidebar links.
43+
44+
| Field | Description |
45+
| --- | --- |
46+
| **Page Title** | Browser tab title. Defaults to "Dokploy" if empty. |
47+
| **Footer Text** | Custom text displayed in the footer area. |
48+
| **Support URL** | Custom URL for the "Support" link in the sidebar. |
49+
| **Documentation URL** | Custom URL for the "Documentation" link in the sidebar. |
50+
51+
## Error Pages
52+
53+
Customize the error page messages shown to users.
54+
55+
| Field | Description |
56+
| --- | --- |
57+
| **Error Page Title** | Title shown on error pages. |
58+
| **Error Page Description** | Description text shown on error pages. Defaults to "We're sorry, but an unexpected error occurred. Please try again later." |
59+
60+
## Live Preview
61+
62+
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.
63+
64+
## Actions
65+
66+
- **Reset to Defaults** — Revert all whitelabel settings back to the default Dokploy branding.
67+
- **Save Changes** — Apply your customizations.
68+
69+
## Best practices
70+
71+
- Use high-resolution logos (e.g. 2×) for sharp display on retina screens. SVG format is recommended for perfect scaling.
72+
- Keep your custom CSS colors accessible with sufficient contrast for text and buttons.
73+
- Test the login page, dashboard, and key workflows after applying changes to ensure nothing is broken or hard to read.
74+
- Always preview your changes using the Live Preview section before saving.
75+
76+
For help enabling or configuring whitelabeling, [contact us](https://dokploy.com/contact).

apps/docs/content/docs/core/enterprise/whitelabeling.txt

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)