Skip to content

Commit 969cccc

Browse files
Openblocks-docsgitbook-bot
Openblocks-docs
authored andcommitted
GITBOOK-130: update doc: custom branding
1 parent 4069b60 commit 969cccc

File tree

4 files changed

+18
-10
lines changed

4 files changed

+18
-10
lines changed
1.33 MB
Loading

‎docs/SUMMARY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@
6868

6969
* [Members and groups](workspace-management/members-and-groups.md)
7070
* [Permissions for resources](workspace-management/permissions-for-resources.md)
71-
* [Customize branding](workspace-management/customize-branding.md)
71+
* [Custom branding](workspace-management/customize-branding.md)

‎docs/self-hosting/enterprise-edition.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The lack of License Key will not hinder the process of starting and maintaining
1414
## Premium features
1515

1616
* Enterprise ID providers: Google, GitHub, Azure AD, Okta, Keycloak, CAS, LDAP, JWT and more
17-
* White labeling ([Customize branding](../workspace-management/customize-branding.md))
17+
* White labeling ([Custom branding](../workspace-management/customize-branding.md))
1818
* Air-gapped deployment
1919
* Audit logs
2020
* Priority support

‎docs/workspace-management/customize-branding.md

+16-8
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,39 @@
1-
# Customize branding
1+
# Custom branding
22

33
Openblocks provides a white-labelling feature that allows you to customize your workspace's **branding**, including logo, favicon, brand name and color. You can easily configure branding to match your company's branding and benefit from consistent experiences with your company's existing internal tools.
44

55
{% hint style="info" %}
6-
Custom branding is a **premium** feature of self-hosted Enterprise Edition of Openblocks. Feel free to contact our team if needed.
6+
Custom branding is a **premium feature** of self-hosted [Enterprise Edition](../self-hosting/enterprise-edition.md) of Openblocks. Feel free to contact our team if needed.
77
{% endhint %}
88

9-
## Configure branding
9+
## Branding settings
1010

11-
Only **workspace admins** have the permission to configure branding. Navigate to [Openblocks homepage](https://cloud.openblocks.dev/), select ⚙️ **Settings** tab **** in **** the left pane and click **Branding**. You can edit the settings on the left and preview the actual effects on the right.
11+
Only **workspace admins** have the permission to customize branding. Navigate to [Openblocks homepage](https://cloud.openblocks.dev/), select ⚙️ **Settings** tab **** in **** the left pane and click **Branding**. You can edit the settings on the left and preview the actual effects on the right.
1212

1313
<figure><img src="../.gitbook/assets/custom-branding-1.png" alt=""><figcaption></figcaption></figure>
1414

15+
The customizable branding settings are listed as follows:
16+
1517
* Logo: click the **Logo** box to upload your logo, which is shown at the top bar. The file browser will pop up and you can select an image file. Openblocks supports `.jpg`, `.svg`, and `.png` files.
1618
* Head color: click the palette in the **Head Color** section to select the background color of the top bar. You can also directly type a CSS color into the box.
1719
* Brand name: enter your **Brand Name** in the input box and it will show on the **login page** and as the browser tab title.
1820
* Favicon: click the **Favicon** box to upload your website icon, which is shown in the browser tab.
1921

22+
{% hint style="success" %}
2023
Click the **Save** button and the settings will immediately take effect.
24+
{% endhint %}
25+
26+
### Example&#x20;
27+
28+
The following pictures show what workspace **members** and **end users** will see on the login page, homepage, and application pages after branding is successfully customized (take the brand name "My brand" for example).
2129

22-
The following pictures show what workspace end users will see on the homepage and application pages after branding is successfully customized.
30+
<figure><img src="../.gitbook/assets/custom-branding-5.png" alt=""><figcaption><p>the login page</p></figcaption></figure>
2331

24-
<figure><img src="../.gitbook/assets/custom-branding-2.png" alt=""><figcaption></figcaption></figure>
32+
<figure><img src="../.gitbook/assets/custom-branding-2.png" alt=""><figcaption><p>the homepage</p></figcaption></figure>
2533

26-
<figure><img src="../.gitbook/assets/custom-branding-3.png" alt=""><figcaption></figcaption></figure>
34+
<figure><img src="../.gitbook/assets/custom-branding-3.png" alt=""><figcaption><p>application pages</p></figcaption></figure>
2735

28-
Note that workspace developers and admins still see Openblocks branding on the homepage and the app editor.
36+
Note that workspace **developers** and **admins** still see "Openblocks" branding on the homepage and application pages.
2937

3038
<figure><img src="../.gitbook/assets/custom-branding-4.png" alt=""><figcaption></figcaption></figure>
3139

0 commit comments

Comments
 (0)