Skip to main content

Support portal subdomain and branding settings

After creating a support portal, you can customize its look and feel on the Support portal settings page. Manage your site's name, URL, favicon, banners and connect your KB with third party integrations.

In this article, you will learn:

  1. How to add the Support portal website's title and default language?
  2. How to connect Support portal to a custom subdomain?
  3. How to customize Support portal website's banner branding?

1. Set Support portal title and default language​

Follow the below steps to add the Support portal website's title and set the default language:

  1. Go to Settings > Inbox. Search and select Support portal settings.
  2. Enter the Site title. image

  1. Click Save. Open your URL on a new tab, on top of the browser, you can see the updated site title.

    drawing

  1. The Help site language (default language) can be selected from the dropdown based on the language that would support customers to browse for the documentation. All the static variables (for example, default text on the site like Search or Explore knowledgebase) will get updated to the selected language.

    Languages supported currently: English, Polish, Czech, Slovakian, Romanian.

2. Connect support portal to a subdomain​

Businesses generally host their support portal within their website to make access easier for their customers.

For example, docs.yellow.ai is the official support portal for all the Yellow.ai products.

To host the support portal in your custom domain, follow the steps below:

  1. Go to Settings. Search and select Support portal settings.

    image

note

Every Inbox account has a free autogenerated subdomain provided by Yellow.ai where the support portal articles will be hosted.
Support portal website format: https://<botname>.kb.botplatform.io

  1. To connect to an external subdomain, click Connect a custom domain.
    image
  2. Click Next.
    image
  3. Enter your company's URL.
    image
  4. Once the CNAME record is generated, copy and add this record to your domain configuration page on the domain registrar.
info

The place to add these records will vary based on your domain hosting service. Following are the links for the common domain registrars:

  1. If you are unable to configure this, click the Share with tech team button, copy the content shown and send it to your Tech team for support.
  2. After adding the record in your domain registrar, click Submit & verify. This will start the domain verification process.
  3. Once the domain is verified, yellow.ai will issue a free SSL certification for that subdomain to protect your customer information from malicious damage. You can return to the support portal settings page to check if your domain is secured.
  4. After the bot is live, you can choose to switch between the free domain provided by Inbox or your custom domain by enabling or disabling the custom domain toggle.

Unpublish support portal site​

  1. To unpublish your site or take the website down, click Disable on the top (site is published) banner. You can Enable it whenever required.
    image

3. Customize banner branding​

The support portal is an extension of the main website, the business or the customer can customize the support portal site by the business's primary design and theme. To customize the site’s banner, logo, and favicon, follow the steps below:

  1. Go to Settings > Support portal settings.
  2. Click Edit branding.
  3. You can customize the following:
    • Theme: Select Light theme or Dark theme from the dropdown. This will be the default theme for the site users even if their devices are set to a different theme.
    • Primary color: This color will be applied to primary header elements like the navigation and buttons.
    • Primary text color: This color will be applied to the text on the navigation and buttons.
    • Banner background: You can upload an image or select a solid color to be the banner background.
    • Help question and color. Enter a help question Ex: How can we help you, Search here, etc. Select the color of the help question text.
    • Link to your website: Enter your website that will be visible on the header to redirect users to it after they finish using the documentation.
    • Logo and Favicon: Upload square images (150x150) for Logo and Favicon. They will be visible on the site's title and website logo respectively.
    • Footer background: You can upload an image or select a solid color to be the footer background.
    • Footer text color: Select the color for the footer text.
    • Contact info: Footer text will contain info like: Still unsure about something? if you cannot find an answer to your question here, you can always reach out to us at < Contact >. The contact info updated in this field will allow the customers to directly contact you(Phone number, website, email ID, etc).

note

The minimum required image sizes for the given objects are as follows:

  • Banner background: 1400 pixels width by 400 pixels height.
  • Footer background: 1400 pixels width by 400 pixels height.
  • Logo: 30 pixels width by 30 pixels height.
  • Favicon: 16 pixels width by 16 pixels height.
    These are the minimum sizes, you can use larger dimensions if you prefer.

  1. Click Preview to test the look and feel of the site and Save the changes.

    drawing
  • 1. Set Support portal title and default language
  • 2. Connect support portal to a subdomain
  • 3. Customize banner branding