> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onyx.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Linear

> Access issues and projects from Linear

## How it works

The Linear connector pulls in all the Linear issues and the associated comments.

Issues are updated every **10** minutes.

## Setup

### Configure your Linear Application + Onyx env variables

<Info>
  This is only necessary if self-hosting Onyx. If using [Onyx Cloud](https://cloud.onyx.app), you can skip this step.
</Info>

<Steps>
  <Step title="Create Linear application">
    [Create a Linear OAuth Application.](https://linear.app/settings/api)
    This step must be completed by an admin of the Linear workspace you wish to connect to Onyx.
    The application callback URLs should include `<your onyx host>/connector/oauth/callback/linear`. For example,
    for a local deployment with default configurations one of the lines should be
    `http://localhost:3000/connector/oauth/callback/linear`.
  </Step>

  <Step title="Set environment variables">
    Set the following environment variables on your Onyx instance using the Client ID and Signing Secret provided by
    Linear for your new app:

    ```bash theme={null}
    LINEAR_CLIENT_ID=
    LINEAR_CLIENT_SECRET=
    ```
  </Step>

  <Step title="Restart Onyx">
    Restart your Onyx instance as you normally would to apply the changes.
  </Step>
</Steps>

### Indexing

<Steps>
  <Step title="Open Linear connector">
    In the Onyx UI, navigate to the Admin Panel and select the **Linear** Connector
  </Step>

  <Step title="Authorize via OAuth">
    Click the `Create New` button to go through the OAuth flow.
  </Step>

  <Step title="Return to Onyx">
    Once you've authorized the application, you'll be redirected back to Onyx.
  </Step>

  <Step title="Select credential and configure">
    Select the new credential and click Continue. Enter connector name and permissions information.
  </Step>

  <Step title="Create connector">
    Click `Create Connector` to begin indexing Linear issues and comments!
  </Step>
</Steps>
