BookStack

​

What It Does

• fetches shelves, books, chapters, and pages from a BookStack instance via its REST API
• converts page content to Markdown for indexing, preferring BookStack’s native Markdown and falling back to converted HTML
• resolves each item’s owning shelf, even for books, chapters, and pages where the API doesn’t return shelf_id directly
• runs ingestion on configurable schedules

​

Required Environment Variables

• BOOKSTACK1_BASE_URL: base URL of your BookStack instance (example: https://wiki.example.com)
• BOOKSTACK1_TOKEN_ID: API token ID
• BOOKSTACK1_TOKEN_SECRET: API token secret
• BOOKSTACK1_SCHEDULES: ingestion interval in seconds (default: 3600)

​

config.yaml Example

sources:
  - type: "bookstack"
    name: "bookstack1"
    config:
      base_url: "${BOOKSTACK1_BASE_URL}"
      token_id: "${BOOKSTACK1_TOKEN_ID}"
      token_secret: "${BOOKSTACK1_TOKEN_SECRET}"
      item_types:              # optional, default: pages
        - "shelves"
        - "books"
        - "chapters"
        - "pages"
      schedules: "${BOOKSTACK1_SCHEDULES}"
      #request_delay: 0        # optional, delay in seconds between items (default: 0)

​

.env.rag Example

BOOKSTACK1_BASE_URL=https://wiki.example.com
BOOKSTACK1_TOKEN_ID=your-token-id
BOOKSTACK1_TOKEN_SECRET=your-token-secret
BOOKSTACK1_SCHEDULES=3600

​

Configuration Reference

​

Multiple BookStack Sources