Skip to content

Commit 04b6810

Browse files
committed
📝 Update docs
1 parent 3dcd354 commit 04b6810

File tree

3 files changed

+91
-0
lines changed

3 files changed

+91
-0
lines changed

apps/docs/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
]
6767
},
6868
"self-hosting/licensing",
69+
"self-hosting/white-labeling",
6970
"self-hosting/configuration"
7071
]
7172
},

apps/docs/self-hosting/configuration.mdx

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,4 +221,40 @@ For self-hosted deployments, [MinIO](https://min.io/) is the recommended S3-comp
221221

222222
<ParamField path="S3_ENDPOINT">
223223
The endpoint of your S3 server. Can be left empty if using AWS S3.
224+
</ParamField>
225+
226+
## Branding
227+
228+
These options allow you to customize the branding of your Rallly instance. See [White Labeling](/self-hosting/white-labeling) for more details.
229+
230+
<Note>
231+
These options are available from v4.6.0 and later and require an Enterprise license with a white-label add-on.
232+
</Note>
233+
234+
<ParamField path="APP_NAME" default="Rallly">
235+
The name of your application. Appears in page titles, navigation, and emails.
236+
</ParamField>
237+
238+
<ParamField path="PRIMARY_COLOR" default="#4f46e5">
239+
The primary brand color for light mode. Must be a valid hex color code.
240+
</ParamField>
241+
242+
<ParamField path="PRIMARY_COLOR_DARK">
243+
The primary brand color for dark mode. Auto-calculated from `PRIMARY_COLOR` if not set.
244+
</ParamField>
245+
246+
<ParamField path="LOGO_URL" default="/static/logo.svg">
247+
URL to your logo for light mode. SVG format recommended.
248+
</ParamField>
249+
250+
<ParamField path="LOGO_URL_DARK">
251+
URL to your logo for dark mode. Falls back to `LOGO_URL` if not set.
252+
</ParamField>
253+
254+
<ParamField path="LOGO_ICON_URL" default="/images/rallly-logo-mark.png">
255+
URL to your logo icon used in emails and as a favicon.
256+
</ParamField>
257+
258+
<ParamField path="HIDE_ATTRIBUTION" default="false">
259+
Set to `true` to hide "Powered by Rallly" attribution in polls and emails.
224260
</ParamField>
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
icon: "paintbrush"
3+
title: "White Labeling"
4+
description: "Customize the branding of your self-hosted Rallly instance"
5+
---
6+
7+
<Note>
8+
These options are available from v4.6.0 and later and require an Enterprise license with a white-label add-on.
9+
</Note>
10+
11+
White labeling allows you to customize the appearance of your Rallly instance to match your organization's branding. You can change the application name, primary colors, logos, and hide attribution text.
12+
13+
## What You Can Customize
14+
15+
- **Application Name** - Change the name displayed in page titles, navigation, and emails
16+
- **Primary Colors** - Set custom brand colors for both light and dark modes
17+
- **Logos** - Use your own logos for the application and emails
18+
- **Attribution** - Hide the "Powered by Rallly" text in polls and emails
19+
20+
## Configuration
21+
22+
All white labeling options are configured via environment variables. See the [Configuration Options](/self-hosting/configuration#branding) page for the full list of available settings.
23+
24+
## Example
25+
26+
Here's an example of a complete white labeling configuration in your `docker-compose.yml`:
27+
28+
```yaml
29+
services:
30+
rallly:
31+
image: lukevella/rallly:4
32+
environment:
33+
# ... other required environment variables ...
34+
35+
# White labeling
36+
APP_NAME: "Acme Scheduler"
37+
PRIMARY_COLOR: "#0066cc"
38+
PRIMARY_COLOR_DARK: "#3399ff"
39+
LOGO_URL: "https://example.com/logo.svg"
40+
LOGO_URL_DARK: "https://example.com/logo-dark.svg"
41+
LOGO_ICON_URL: "https://example.com/icon.png"
42+
HIDE_ATTRIBUTION: "true"
43+
```
44+
45+
## Viewing Current Settings
46+
47+
You can view the current branding configuration in the [Control Panel](/self-hosting/control-panel) under the **Branding** section. These settings are read-only in the UI and must be changed via environment variables.
48+
49+
## Requirements
50+
51+
- **Enterprise License with White Label Add-on**: White labeling features are only available with an active Enterprise license that includes the white label add-on.
52+
- Without the add-on, your instance will use the default Rallly branding regardless of environment variable settings.
53+
54+
To inquire about Enterprise licensing, please fill out our [Enterprise Requirements Survey](https://app.formbricks.com/s/cmebvnf2ohvjkt901eefxsonr).

0 commit comments

Comments
 (0)