Download the PHP package pronomix-gmbh/bookstack-ai-sync without Composer

BookStack OpenWebUI Sync

A composer-installable BookStack package to sync BookStack books, pages, and attachments into OpenWebUI knowledge bases using only BookStack's Laravel runtime.

Install

Run migrations:

If auto-discovery is disabled, add the service provider to config/app.php:

Configuration

Copy the env keys you need:

Scheduler / Queue

This package stores tasks in the database and does not require a queue worker. The cron job is required: without it, tasks never run and no sync happens. To process tasks via cron:

If you already run php artisan schedule:run, you can also register that cron and call openwebui:process-queue manually as needed.

Optional queue workers can be enabled by setting:

To prevent overlapping runs (e.g., if a queue run takes longer than a minute), use flock in your cron:

Workspace (model) sync

OpenWebUI does not currently expose a dedicated workspace API, so this package optionally syncs all knowledge bases into a single OpenWebUI model entry. By default the model ID and name are taken from OPENWEBUI_INSTANCE_NAME. You can override with:

Commands

• openwebui:process-queue - Process pending sync tasks
• openwebui:list-queue - List open sync tasks
• openwebui:sync-all - Enqueue sync for all books
• openwebui:sync-book {bookId?} - Enqueue sync for a single book (prompts when omitted)
• openwebui:test-connection - Test OpenWebUI connectivity
• openwebui:clear-queue - Clear queued sync tasks (defaults to pending/failed)
• openwebui:install - Run only this package's migrations
• openwebui:uninstall - Roll back and remove package tables (with safety flags)

Behavior

• Each BookStack book becomes an OpenWebUI knowledge base named ${instance}:${bookname}.
• Pages and attachments are uploaded as files into the matching knowledge base.
• Identity is stable across page renames by using page_id and attachment_id in external keys.
• Deletes are propagated to OpenWebUI.
• Optional workspace sync attaches all known knowledge bases to a single OpenWebUI model (workspace) and removes stale ones.

Development

Run tests: