mirror of
https://github.com/tiennm99/danswer-docs.git
synced 2026-06-17 08:52:00 +00:00
Added BookStack page to the docs
This commit is contained in:
@@ -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.
|
||||
|
||||

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

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

|
||||
|
||||
3. Click the `Connect` button! Your content will then be pulled into Danswer every **10** minutes.
|
||||
|
||||

|
||||
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 78 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
+1
-1
@@ -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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user