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

# BookStack

> Access knowledge from your own BookStack instance

## How it works

The BookStack connector fetches all shelves, books, chapters and pages from the connected instance upon connector setup.
From that point on, the connector will pull in everything updated since last sync every **10** minutes.

## Setting up

### Authorization

You will need API credentials for a user in your BookStack instance. To do this:

<Steps>
  <Step title="Create/select connection user">
    Find or create a user you'd want to use as the connection user.

    * Visibility of BookStack contents will depend on this user's permissions.
    * This user must have a role assigned that has the "Access system API" system permission.
  </Step>

  <Step title="Open API Tokens">
    Edit that user using an admin account, and find the "API Tokens" section at the bottom of the view.

    <img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/bookstack/BookstackApiTokenList.png?fit=max&auto=format&n=aj13v1mzLf028SWE&q=85&s=6c756bb988ac7bf09bc51b518d7c0ebc" alt="BookStack API Tokens List View" width="1511" height="406" data-path="assets/admins/connectors/bookstack/BookstackApiTokenList.png" />
  </Step>

  <Step title="Create and copy token">
    Click the "Create Token" button, then enter a name and (optionally) an expiry date for the token. Then press save.
    Copy the shown "Token ID" and "Token Secret" values for the "Indexing" section below.

    <img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/bookstack/BookstackApiToken.png?fit=max&auto=format&n=aj13v1mzLf028SWE&q=85&s=1e278d21026b6fe02d16e64c541d03ed" alt="BookStack API Token View" width="1511" height="1359" data-path="assets/admins/connectors/bookstack/BookstackApiToken.png" />
  </Step>
</Steps>

### Indexing

<Steps>
  <Step title="Open BookStack connector">
    Navigate to the Admin Panel and select the **BookStack** connector.
  </Step>

  <Step title="Enter URL and tokens">
    In **Step 1**, provide the base URL of your BookStack instance,
    along with the API **Token ID** and the API **Token Secret** you obtained in the "Authorization" steps above:

    <img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/bookstack/BookstackAuth.png?fit=max&auto=format&n=aj13v1mzLf028SWE&q=85&s=bd6435d4195068afb2d39bdb8b1f31e4" alt="BookStack connector step 1 view" width="1324" height="1177" data-path="assets/admins/connectors/bookstack/BookstackAuth.png" />
  </Step>

  <Step title="Start indexing">
    Click the `Connect` button! Your content will then be pulled into Onyx every **10** minutes.

    <img className="rounded-image" src="https://mintcdn.com/danswer/aj13v1mzLf028SWE/assets/admins/connectors/bookstack/BookstackIndex.png?fit=max&auto=format&n=aj13v1mzLf028SWE&q=85&s=069cb57350b84130fde189a1c8a92b01" alt="BookStack connector step 2 view" width="1324" height="660" data-path="assets/admins/connectors/bookstack/BookstackIndex.png" />
  </Step>
</Steps>
