Documentation

How to use a whitelabel and what it means

‍Whitelabel allows you to customize the interface, remove references to Improvado and use your branding.

We can change your logo, favicon and the domain.

Contact our Support team to get instructions on whitelabel setup.

You should be ready to provide us with the following information:

• company logo;
• favicon image;
• color scheme;
• domain preferences;
• contact email.

Support team could request additional data or settings.

Logo requirements

• File formats: *.svg,*.png
• Transparent background
• Image size is 480 x 180px
• Image ratio is 16 x 6
• Name format: companyname-logo

Favicon requirements

• File formats: *.svg, *.png, *.jpg, *.gif
• Transparent background
• Width/height ratio equal to 1 or close to

Color scheme

Here you can choose a dark or light logo background to display in the interface.

Domain

You can use default or a custom domain name - this will define the set of instructions you will get.

• Domain name format: ```<companyname>.improvado.io```.

The <companyname> can contain only lower case characters (a-z), numbers (0-9) and hyphen (-). Dots will not work here.

‍

Setting Up Your Whitelabel Domain (optional step, required only if you want to use your own domain instead of Improvado sub-domain)

To configure your whitelabel domain, follow these steps to create a CNAME record in the Control panel of your DNS service provider.

Suppose you own the domain ```clientname.com``` and want to set up a whitelabel on the ```insights``` subdomain. Your whitelabel will be accessible at ```https://insights.clientname.com/```.

1. Access Your DNS Control Panel.
   Log in to the Control panel of your DNS service provider.
2. ‍Create a New DNS Record

• ~Record Type: ```CNAME```
• ~Host/Name: ```insights```
• ~Full Domain Name: ```insights.clientname.com```
• ~Value/Points to/Domain Name: ```<clientname>.white.improvado.io```.

‍
Note: Most DNS providers require a dot at the end of the URL, but some may not. Check your DNS provider.

‍

If your domain is on goDaddy:

Type: CNAME 
Host: *reports* (or another <subdomain>)
Points to: "*<clientname>*.white.improvado.io." (with the dot at the end)

‍

If your domain is on CloudFlare:

• Log in to the CloudFlare.com admin panel,
• Choose your domain,
• Open DNS (Manage your Domain Name System (DNS) settings page):

Type: CNAMEName: *<subdomain>*
Domain name: *<clientname>.white.improvado.io*
TTL: Automatic TTL
Status: the cloud icon should be gray (not orange)
(Traffic to this hostname will not go through Cloudflare.)

‍

3. Inform Us. Once the DNS record is ready, please inform us (include its address) so we can complete the setup on our end.

‍

{%docs-informer warning title="Important"%}

• ‍Subdomain Naming: You can use any name for the subdomain that consists of lowercase English letters (a-z), numbers (0-9), and dashes (-). Avoid using dots (.) or underscores (_).
• Field Names: The field names may vary across different DNS providers. Refer to your provider's documentation for accurate field names.
• DNS Record Population Time: DNS records typically take a few minutes to propagate, but in some cases, it can take up to a few hours depending on your DNS server.

{%docs-informer-end%}

‍

If you have any further questions or need assistance, feel free to contact our support team.

Wrong whitelabel error

If you see the error "Your account is valid for the another instance" during the authorization, please follow the link under the company logo and try to log in ag