> ## Documentation Index
> Fetch the complete documentation index at: https://danswer-docs-versions-opensearch-example.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Chrome Extension

> Use Onyx in Chrome from any page

The Onyx Chrome Extension allows users to access Onyx from anywhere in their browser.

Features include:

* An Onyx browser home page
* An Onyx sidebar in your browser
* Contextual search on selected text
* Deep Research capabilities

<Info>
  Coming soon: Full page context chat and indexing visited pages into your Onyx knowledge base!
</Info>

<img className="rounded-image" src="https://mintcdn.com/danswer-docs-versions-opensearch-example/mlEBE1n5ECoowrmk/assets/overview/onyx_anywhere/onyx_chrome_extension.png?fit=max&auto=format&n=mlEBE1n5ECoowrmk&q=85&s=83d1ff613f30253194e1204585841821" alt="Onyx Chrome Extension Home Page" width="3820" height="1706" data-path="assets/overview/onyx_anywhere/onyx_chrome_extension.png" />

## Installation Options

**Onyx Cloud users**: Install directly from the Chrome Web Store

**Self-hosted users**: Your administrator will provide installation instructions

## Manual Installation (Self-Hosted)

<Steps>
  <Step title="Get the extension files">
    Clone the [Onyx Chrome Extension](https://github.com/onyx-dot-app/onyx-chrome-extension) repo from GitHub.
  </Step>

  <Step title="Enable Developer Mode">
    * Visit `chrome://extensions/` in your Chrome browser
    * In the upper right corner, click **Developer mode** to enable it

    <img className="rounded-image" src="https://mintcdn.com/danswer-docs-versions-opensearch-example/Tulo5PmQYdHu2MY6/assets/deployment/chrome_extension.png?fit=max&auto=format&n=Tulo5PmQYdHu2MY6&q=85&s=97631408e08409b8020bd84d5bb00efa" alt="Chrome Extension Developer Mode" width="2128" height="840" data-path="assets/deployment/chrome_extension.png" />
  </Step>

  <Step title="Load the extension">
    * Click **Load unpacked**
    * Select the folder containing the Onyx Chrome Extension files
    * Click **Load**

    The extension is now installed and ready to configure.
  </Step>

  <Step title="Configure connection settings">
    * Click the three dots (...) next to the extension
    * Select **Options**
    * Set the **Root Domain** to your self-hosted Onyx instance's URL

    <img className="rounded-image" src="https://mintcdn.com/danswer-docs-versions-opensearch-example/Tulo5PmQYdHu2MY6/assets/deployment/extension_settings.png?fit=max&auto=format&n=Tulo5PmQYdHu2MY6&q=85&s=d8bcc9997a0fb9c472fd45afe78f5cd6" alt="Extension Settings Menu" width="1244" height="1258" data-path="assets/deployment/extension_settings.png" />

    <img className="rounded-image" src="https://mintcdn.com/danswer-docs-versions-opensearch-example/mlEBE1n5ECoowrmk/assets/deployment/root_domain.png?fit=max&auto=format&n=mlEBE1n5ECoowrmk&q=85&s=d4d1a3307bb1c1b74b686603faf25c60" alt="Root Domain Configuration" width="950" height="1122" data-path="assets/deployment/root_domain.png" />
  </Step>
</Steps>

<Note>
  The extension will now connect to your self-hosted Onyx instance and can be used from any page in Chrome.
</Note>

## Enterprise Deployment

For organizations deploying the extension at scale, use Google Admin Console for centralized management.

<Steps>
  <Step title="Access Chrome Management">
    * Log in to your Google Admin console
    * Navigate to **Devices → Chrome → Apps and extensions**
  </Step>

  <Step title="Add the extension">
    * Obtain the Chrome extension ID from an Onyx team member - Click the yellow
      plus icon to add the extension - Enter the Chrome extension ID and click **Add**
  </Step>

  <Step title="Configure deployment">
    Configure deployment options such as:

    * Force installation for specific organizational units
    * User access controls
    * Update policies and version management
    * Installation policies (allowed, forced, or blocked)
  </Step>

  <Step title="Save configuration">
    <Warning>
      Remember to save your changes after configuring the extension settings.
    </Warning>
  </Step>
</Steps>

### Pre-set the Onyx URL with a managed policy

Extension version 1.2 and later reads settings from Chrome managed storage.
Use it to set the Onyx URL and the new tab behavior for all users.
Settings set by policy are read-only in the extension UI and show a "managed by your organization" notice.

The Chrome Web Store extension ID is `dacfbnglakogghooelgjflkhjcdbemia`. The examples below use this ID.
If you self-host the extension, replace it with your own ID from `chrome://extensions`.

| Key | Type | Description |
| - | - | - |
| `onyxExtensionDomain` | string | Root URL of your Onyx instance (trailing `/` removed) |
| `onyxExtensionDefaultNewTab` | boolean | Force the "Use Onyx as new tab page" toggle on or off |

<Tabs>
  <Tab title="Google Admin Console">
    * Navigate to **Devices → Chrome → Apps and extensions**
    * Select the Onyx extension
    * Under **Policy for extensions**, paste the JSON below

    ```json theme={null}
    {
      "onyxExtensionDomain": {
        "Value": "https://onyx.example.com"
      },
      "onyxExtensionDefaultNewTab": {
        "Value": false
      }
    }
    ```
  </Tab>

  <Tab title="Windows / macOS / Linux policy">
    Set the `3rdparty.extensions.<extension-id>` policy.

    **Linux** – save as `/etc/opt/chrome/policies/managed/onyx.json`:

    ```json theme={null}
    {
      "3rdparty": {
        "extensions": {
          "dacfbnglakogghooelgjflkhjcdbemia": {
            "onyxExtensionDomain": "https://onyx.example.com",
            "onyxExtensionDefaultNewTab": false
          }
        }
      }
    }
    ```

    **Windows** – add string values via Group Policy, Intune, or a `.reg` file:

    ```text theme={null}
    HKLM\Software\Policies\Google\Chrome\3rdparty\extensions\dacfbnglakogghooelgjflkhjcdbemia\policy
      onyxExtensionDomain        = "https://onyx.example.com"
      onyxExtensionDefaultNewTab = "false"
    ```

    **macOS** – deploy a configuration profile (MDM or MCX)
    for the preference domain `com.google.Chrome.extensions.dacfbnglakogghooelgjflkhjcdbemia` with the same keys.
    Chrome reads extension policy only from managed preferences; `defaults write` is not enough.
  </Tab>
</Tabs>

Omit a key to let users set that value themselves.
Check `chrome://policy` on a client to confirm the policy was applied.

### Self-Hosting the Extension

For private distribution without the Chrome Web Store:

<Steps>
  <Step title="Package the extension">
    Use Chrome's developer tools to create a CRX file
  </Step>

  <Step title="Host the files">
    Place the CRX and update manifest on your server
  </Step>

  <Step title="Configure clients">
    Use Admin console or Group Policy to point to your hosted files
  </Step>
</Steps>

## Extension Management

### Update Policies

* **Enterprise deployments**: Chrome handles automatic updates every 5 hours
* **Version pinning**: Available for force-installed extensions, but avoid extended use due to
  security updates
* **Self-hosted updates**: Increment version in manifest.json and replace hosted files


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.