Skip to content

Commit

Permalink
Merge pull request #273 from captain-Akshay/master
Browse files Browse the repository at this point in the history
addition of more information in white labelling
  • Loading branch information
leecalcote authored Jun 7, 2024
2 parents 42811e9 + 8698f29 commit 196e93d
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 15 deletions.
107 changes: 92 additions & 15 deletions content/en/cloud/self-hosted/white-labeling/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,113 @@ You can change the logo, color scheme, domain name, and other aspects of the use

The Layer5 Cloud dashboard can be customized with your own branding, including your full-sized logo, logo mark, and color scheme.

Visit the Layer5 Cloud dashboard and navigate to the settings page to customize the theme.

{{< cardpane >}}
{{% card header="Dashboard Example" footer="<i>Example: CNCF branding on Dashboard</i>" %}}
This example includes a custom branding with colors and full-sized logo.
![white-label-dashboard-example.png](./images/white-label-dashboard-example.png)
{{% /card %}}
{{% card header="Responsive Dashboard Example" footer="<i>Example: CNCF branding on Dashboard</i>" %}}
This example includes a custom branding with colors and logo mark as would be displayed on a mobile device.
![white-label-dashboard-responsive-example.png
](./images/white-label-dashboard-responsive-example.png
)
{{% /card %}}
{{< /cardpane >}}

{{% card header="Catalog Example" footer="<i>Example: CNCF branding in Catalog</i>" %}}
This example includes a custom branding with colors and full-sized logo.
![white-label-catalog-example.png](./images/white-label-catalog-example.png)
{{% /card %}}
{{< /cardpane >}}

## Customizing Logos
### Organization Preference

Layer5 Cloud supports customizing themes on a per organization basis. This includes the ability to upload your own logo and define your own color scheme. Your logo will be displayed in the top left corner of the dashboard. Both a full-sized logo and a logo mark are supported.

{{< youtube id=hZuhmP7lenk title="Example: Replace the Layer5 logo with your own logo." >}}
As an [Organization Administrator](/cloud/security/roles/organization-roles/), you can add your organization's logo to the global navigation bar, which supports a large, horizontal logo for desktop users and a small, square logo for mobile users. The logo appears at the top of each user's window for all Layer5 Cloud pages within your organization.

{{% card header="Prefrence Example" footer="<i>Example: Selection of theme</i>" %}}
This example shows how to customize through different themes
![white-label-catalog-example.png](./images/pref-selection.gif)
{{% /card %}}

### Custom Logos

You can upload your own logo for your organization. Logo appears in upper left corner of all Layer5 Cloud pages. All teams, workspaces, and users in your organization will use these custom logos.

Your custom logos will optionally be visible to external users if you choose to customize your login screen. Otherwise, your custom logos will only be visible to users within your organization.

If you use a mobile device, the logo mark will be visible.

#### Logo Image Requirements

Logo images must be either in SVG, PNG or GIF format. GIF images can be animated, but are not recommended given their distraction to users. The maximum file size for each image is 500 KB.
<pre>
Horizontal logo: 389 width x 32 height pixels
</pre>
If you upload a smaller or larger image, the image is resized to exactly 389 x 32 pixels. If the aspect ratio does not match, then the image will be distorted. For example, a 132 x 132 pixel image expands to 389 x 32 pixels, causing distortion.

<!-- Insert example logo here -->
<pre>
Square logo (mark): 32 width x 32 height pixels
</pre>
{{% card header="Square Logo Example" footer="<i>Example: CNCF branding on Dashboard</i>" %}}
<p>
This example includes a custom branding with colors and logo mark as would be displayed on a mobile device.</p>
<div style="width: 500px; height: 200px; overflow: hidden;">
<img src="./images/white-label-dashboard-responsive-example.png"
width="100%"
style="margin-top:-.25rem;
margin-left:-.25rem;border-radius:.25rem;
object-fit: fill;" />
</div>
{{% /card %}}

### Uploading Your Logo

On the [Organizations page](https://meshery.layer5.io/identity/organizations), you can upload your custom logo for your organization.

_Example: Layer5 Cloud custom branding on login screen with CNCF branding._
1. Go to Menu and then [**Identity** > **Organization**].
1. To open the Edit window, click the pencil icon next to the organization name.
1. Click Select file to upload and select the logo image on your computer. You'll see a preview your logo.
1. Click Save, if satisfied. You may change your custom logo images at any time.

## Customizing Domain Name
## Custom Domain Name and Login Screen

Layer5 Cloud supports customizing the login screen based on custom domain name. Redirect your users to your own domain name. For example, if your domain name is `mycompany.com`, you can redirect users to `meshery.mycompany.com`.

Example: https://meshery.layer5.io/signup?program=cncf
<!-- {{< youtube id=hZuhmP7lenk title="Example: Replace the Layer5 logo with your own logo." >}} -->
<iframe width="560" height="315" src="https://www.youtube.com/embed/hZuhmP7lenk?si=1o8KLhk3K-HeJCcm" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

<p style="text-align:center; font-style: italic;">Example: Layer5 Cloud custom branding on login screen with CNCF branding. Live example: <a href="https://meshery.layer5.io/signup?program=cncf">https://meshery.layer5.io/signup?program=cncf</a></p>

A subdomain is the part of a URL before the root domain. You can configure your subdomain as www or as a distinct section of your site, like hub.cncf.io.

Subdomains are configured with a CNAME record through your DNS provider.

### Configuring a subdomain

To set up a www or custom subdomain, such as `www.example.com` or `meshery.example.com`, you must add your domain in the repository settings. After that, configure a CNAME record with your DNS provider.

In Layer5 Cloud, navigate to your Provider Organization.

Under your Organization name, click Edit. If you cannot click the "Edit" action, verify that you are a [Provider Administrator](/cloud/security/roles/provider-admin-roles/).

Under "Custom domain", type your custom domain, then click Save. This will create a server configuration will require a reboot in order to take affect.

*Note: If your custom domain is an internationalized domain name, you must enter the Punycode encoded version.*

Navigate to your DNS provider and create a CNAME record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `hub.cncf.io` for your user site, create a CNAME record that points `hub.cncf.io` to `meshery.layer5.io`. For more information about how to create the correct record, see your DNS provider's documentation.

{{< alert title="Warning" color="warning" >}}
Warning: We strongly recommend that you do not use wildcard DNS records, such as `*.example.com`. These records put you at an immediate risk of domain takeovers, even if you verify the domain. For example, if you verify example.com this prevents someone from using `a.example.com`, but they could still take over `b.a.example.com` (which is covered by the wildcard DNS record).
{{< /alert >}}

#### Verifying your custom domain

Open Terminal.

To confirm that your DNS record configured correctly, use the dig command, replacing `hub.cncf.io` with your subdomain.

<pre>
$ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd
> ;hub.cncf.io. IN A
> hub.cncf.io. 3592 IN CNAME .
> meshery.layer5.io. 43192 IN CNAME meshery.layer5.io .
> meshery.layer5.io . 22 IN A 192.0.2.1
</pre>

<!-- FUTURE: SUPPORT FOR HTTPS
Optionally, to enforce HTTPS encryption for your site, select Enforce HTTPS. It can take up to 24 hours before this option is available. -->
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 196e93d

Please sign in to comment.