diff --git a/connectors/bookstack.mdx b/connectors/bookstack.mdx new file mode 100644 index 0000000..a81494a --- /dev/null +++ b/connectors/bookstack.mdx @@ -0,0 +1,38 @@ +--- +title: BookStack Connector +description: '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: + + 1. 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. + 2. Edit that user using an admin account, and find the "API Tokens" section at the bottom of the view. + +![BookStack API Tokens List View](/images/connectors/bookstack/BookstackApiTokenList.png) + + 3. Click the "Create Token" button, then enter a name and (optionally) an expiry date for the token. Then press save. + 4. Copy the shown "Token ID" and "Token Secret" values for the "Indexing" section below. + +![BookStack API Token View](/images/connectors/bookstack/BookstackApiToken.png) + +### Indexing + 1. Navigate to the Admin Dashboard and select the **BookStack** connector. + 2. 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: + +![BookStack connector step 1 view](/images/connectors/bookstack/BookstackAuth.png) + + 3. Click the `Connect` button! Your content will then be pulled into Danswer every **10** minutes. + +![BookStack connector step 2 view](/images/connectors/bookstack/BookstackIndex.png) diff --git a/images/connectors/bookstack/BookstackApiToken.png b/images/connectors/bookstack/BookstackApiToken.png new file mode 100644 index 0000000..527ea6f Binary files /dev/null and b/images/connectors/bookstack/BookstackApiToken.png differ diff --git a/images/connectors/bookstack/BookstackApiTokenList.png b/images/connectors/bookstack/BookstackApiTokenList.png new file mode 100644 index 0000000..7e568a8 Binary files /dev/null and b/images/connectors/bookstack/BookstackApiTokenList.png differ diff --git a/images/connectors/bookstack/BookstackAuth.png b/images/connectors/bookstack/BookstackAuth.png new file mode 100644 index 0000000..3190dbf Binary files /dev/null and b/images/connectors/bookstack/BookstackAuth.png differ diff --git a/images/connectors/bookstack/BookstackIndex.png b/images/connectors/bookstack/BookstackIndex.png new file mode 100644 index 0000000..8d5ae4b Binary files /dev/null and b/images/connectors/bookstack/BookstackIndex.png differ diff --git a/introduction.mdx b/introduction.mdx index cda358f..8b08e05 100644 --- a/introduction.mdx +++ b/introduction.mdx @@ -39,7 +39,7 @@ description: 'Learn about Danswer' - Intelligent Document Retrieval (Semantic Search/Reranking pipeline) using the latest LLMs. - An AI Helper backed by a custom Deep Learning model to interpret user intent. - User authentication with document level access management. - - Connectors to Slack, GitHub, GoogleDrive, Confluence, local files, and web scrapping, with more to come. + - Connectors to Slack, GitHub, GoogleDrive, Confluence, BookStack, local files, and web scrapping, with more to come. - Management Dashboard to manage connectors and set up features such as live update fetching. - One line Docker Compose deployment of all services to host Danswer anywhere. diff --git a/mint.json b/mint.json index dc7e715..d4c871d 100644 --- a/mint.json +++ b/mint.json @@ -48,7 +48,8 @@ "connectors/google_drive", "connectors/confluence", "connectors/jira", - "connectors/file" + "connectors/file", + "connectors/bookstack" ] } ],