Bookstack
Connect your Bookstack instance to SurfSense
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
API Token Required
You need to create an API token from your BookStack instance. The token requires "Access System API" permission.
Step 1: Create an API Token
- Log in to your BookStack instance
- Click on your profile icon → Edit Profile
- Navigate to the "API Tokens" tab
- Click "Create Token" and give it a name
- Copy both the Token ID and Token Secret
- 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.
Rate Limiting
BookStack API has a rate limit of 180 requests per minute. The connector automatically handles rate limiting to ensure reliable indexing.
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.
Connecting to SurfSense
- Navigate to the Connector Dashboard and select the BookStack Connector.
- 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 |
- Click Connect to establish the connection.
- 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 |