BookStack

The BookStack custom connector brings your organization's BookStack wiki into Glean. It indexes shelves, books, chapters, and pages so employees can search internal documentation directly from Glean.

note

The BookStack custom connector is set up by the Glean team. Contact Glean Support to get started.

Prerequisites

To set up the BookStack connector, you need the following ready before contacting Glean Support:

• BookStack API token: an API token ID and secret with read access to shelves, books, chapters, and pages.
• HTTPS network access: the connector must reach your BookStack instance's API endpoint over HTTPS.

Supported objects and content types

The connector indexes the following content from BookStack:

• Shelves: top-level collections that group related books.
• Books: collections of chapters and pages.
• Chapters: groupings of pages within a book.
• Pages: individual wiki pages.
• Users and roles: indexed for access-control resolution only. Each role is represented as a Glean group. They are not searchable as standalone objects.

How permissions work

The BookStack connector enforces access based on the role permissions configured in BookStack rather than exposing content to your entire Glean tenant.

Access control

• Each shelf, book, chapter, and page is visible to the roles granted access to it in BookStack.
• Permissions are inherited down the content hierarchy: a page inherits access from its chapter, which inherits from its book, which inherits from its shelf, unless overridden at a lower level.
• Content that BookStack marks as publicly viewable, with no role restrictions, sets allow_anonymous_access=True and becomes visible to every user in your Glean tenant. It is not public on the internet.

Permission sync

• Permission changes in BookStack take effect in Glean after the next scheduled crawl completes.
• There is no real-time permission sync. Plan for a delay between updating access in BookStack and seeing those changes reflected in Glean search results.

Sync behavior

The connector supports both full and incremental crawls to keep Glean's index current.

• Full crawl: indexes all shelves, books, chapters, and pages.
• Incremental crawl: picks up content created or updated within a configurable lookback window since the last crawl.

Both crawl types run on a schedule, and content removed from BookStack is removed from Glean's index on the next full crawl.

Next steps

Contact Glean Support with the prerequisites above to begin setting up the BookStack connector for your organization.

See also

• Custom connector overview: how custom connectors work in Glean.
• Set up a custom connector: the setup process and first-run checklist.
• Glean REST APIs: the Indexing and Client APIs, and the tokens each uses.