> ## 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.

# Discourse

> Access knowledge from your Discourse **Topics**

## How it works

The Discourse connector indexes documents from your Discourse **Topics**.

## Setting up

### Authorization

<Steps>
  <Step title="Log in to Discourse">
    Log into your Discourse account

    <Info>
      This Discourse user must have admin privileges
    </Info>
  </Step>

  <Step title="Open API keys">
    Click the **Admin** menu from the home page. Open the **Advanced** sub-menu and select **API keys**.

    <img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/discourse/discourse_1.gif?s=3105b4a1cded51997024133e258798a8" alt="Discourse admin navigation to the API keys page" width="1002" height="1388" data-path="assets/admins/connectors/discourse/discourse_1.gif" />
  </Step>

  <Step title="Create API key">
    Click **New API Key**, name it "Onyx". Select "All Users" for **User Level** and "Read-only" for **Scope**.

    <img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/discourse/discourse_2.gif?s=2a8eda36dc6d4b71371887c5b8ca26ad" alt="Create and fill out API key" width="2146" height="1388" data-path="assets/admins/connectors/discourse/discourse_2.gif" />
  </Step>

  <Step title="Save and copy key">
    Click **Save**. Copy the key and put it into Onyx.

    <img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/discourse/discourse_3.gif?s=b0be30a10ec98a20c3b338722c4475a6" alt="Create and copy API key" width="2560" height="1192" data-path="assets/admins/connectors/discourse/discourse_3.gif" />
  </Step>

  <Step title="Set API key username">
    For the API Key Username,
    enter the username of the Discourse account which has access to the information you'd like to index.
  </Step>
</Steps>

### Indexing

<Steps>
  <Step title="Name the connector">
    Input a name for a connector (if you plan on creating multiple Discourse connectors,
    this will be used by you to tell between them)
  </Step>

  <Step title="Provide base URL">
    Provide your Discourse's base url.

    <img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/discourse/discourse_4.gif?s=25e068d84324c236fa7e8508a3112f17" alt="Fill out Onyx connector" width="2560" height="1274" data-path="assets/admins/connectors/discourse/discourse_4.gif" />
  </Step>

  <Step title="Enter Topics to index">
    Enter the **Topics** you wish to index. If left blank, all topics available will be indexed.
  </Step>

  <Step title="Start indexing">
    Click connector to begin indexing the indicated **topics**.
  </Step>
</Steps>
