apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-05-02 04:12:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

feat: enhance documentation and fixed bug in loading.tsx

Browse source
This commit is contained in:
Anish Sarkar 2026-01-24 22:43:04 +05:30
parent de08f0644f
commit 9215118bab
23 changed files with 614 additions and 463 deletions
Download patch file Download diff file Expand all files Collapse all files

68
surfsense_web/content/docs/connectors/bookstack.mdx
View file

@ -3,4 +3,70 @@ title: Bookstack
description: Connect your Bookstack instance to SurfSense
---
# Documentation in progress
# BookStack Integration Setup Guide
This guide walks you through connecting your BookStack instance to SurfSense.
## How it works
The BookStack connector uses the BookStack REST API to fetch all pages from your BookStack instance that your account has access to.
- For follow up indexing runs, the connector retrieves pages that have been updated since the last indexing attempt.
- Indexing should be configured to run periodically, so updates should appear in your search results within minutes.
---
## Authorization
<Callout type="info" title="API Token Required">
You need to create an API token from your BookStack instance. The token requires "Access System API" permission.
</Callout>
### Step 1: Create an API Token
1. Log in to your BookStack instance
2. Click on your profile icon → Edit Profile
3. Navigate to the "API Tokens" tab
4. Click "Create Token" and give it a name
5. Copy both the **Token ID** and **Token Secret**
6. Paste them in the connector form
### Step 2: Grant necessary access
Your user account must have "Access System API" permission. The connector will only index content your account can view.
<Callout type="info" title="Rate Limiting">
BookStack API has a rate limit of 180 requests per minute. The connector automatically handles rate limiting to ensure reliable indexing.
</Callout>
<Callout type="info" title="Periodic Sync">
Enable periodic sync to automatically re-index pages when content changes. Available frequencies: Every 5 minutes, 15 minutes, hourly, every 6 hours, daily, or weekly.
</Callout>
---
## Connecting to SurfSense
1. Navigate to the Connector Dashboard and select the **BookStack** Connector.
2. Fill in the required fields:
| Field | Description | Example |
|-------|-------------|---------|
| **Connector Name** | A friendly name to identify this connector | `My BookStack Connector` |
| **BookStack Base URL** | The full URL of your BookStack instance | `https://docs.example.com` |
| **Token ID** | Your API Token ID from BookStack | |
| **Token Secret** | Your API Token Secret from BookStack | |
3. Click **Connect** to establish the connection.
4. Once connected, your BookStack pages will be indexed automatically.
### What Gets Indexed
The BookStack connector indexes the following data:
| Data Type | Description |
|-----------|-------------|
| Pages | All pages from your BookStack instance |
| Content | Page content in Markdown format |
| Metadata | Page titles and metadata |
| Structure | Book and chapter hierarchy information |