Skip to main content

Glean Settings

Integrate Glean settings into your internal app to allow users to connect certain datasources that require seperate authentication (for example, Slack RTS, GitHub) so Glean can access their private data on their behalf.

Glean Settings

warning

It is possible for browser security features to prevent the OAuth popup from informing the SDK that a user has successfully authenticated. For the highest reliability, use the Glean web app or the checkdatasourceauth API

Implementation Guide​

Adding the JavaScript Client​

First, include the JavaScript library in the <head> section of your page. Replace GLEAN_APP_DOMAIN with your company's Glean web app domain (typically app.glean.com or your-company.glean.com if you use a custom subdomain).

info

The Glean web app domain differs from your company's Glean backend domain (which typically follows the format your-company-be.glean.com).

<script
    defer
    src="https://{GLEAN_APP_DOMAIN}/embedded-search-latest.min.js"
  ></script>

Configuration and Setup​

  1. Create a container element with the following required CSS properties:

    • position: relative
    • display: block
    • Appropriate sizing and positioning

  2. Render Settings into your container:

window.GleanWebSDK.renderSettings(containerElement, { /** Options */ });

For detailed configuration options and customizations, refer to our renderSettings API documentation.