PHPackages                             pronomix-gmbh/bookstack-ai-sync - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. pronomix-gmbh/bookstack-ai-sync

ActiveLibrary[Utility & Helpers](/categories/utility)

pronomix-gmbh/bookstack-ai-sync
===============================

BookStack to OpenWebUI knowledge sync package

v1.0.29(5mo ago)126MITPHPPHP ^8.1

Since Jan 21Pushed 5mo agoCompare

[ Source](https://github.com/pronomix-gmbh/bookstack-ai-sync)[ Packagist](https://packagist.org/packages/pronomix-gmbh/bookstack-ai-sync)[ RSS](/packages/pronomix-gmbh-bookstack-ai-sync/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (8)Versions (31)Used By (0)

BookStack OpenWebUI Sync
========================

[](#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
-------

[](#install)

```
composer require pronomix-gmbh/bookstack-ai-sync
```

Run migrations:

```
php artisan migrate
```

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

```
Pronomix\BookStackOpenWebUISync\BookStackOpenWebUISyncServiceProvider::class,

```

Configuration
-------------

[](#configuration)

Copy the env keys you need:

```
OPENWEBUI_ENABLED=true
OPENWEBUI_INSTANCE_NAME=bookstack
OPENWEBUI_BASE_URL=https://openwebui.example.com
OPENWEBUI_API_KEY=your-api-key
OPENWEBUI_TIMEOUT=30
OPENWEBUI_VERIFY_TLS=true
OPENWEBUI_WORKSPACE_ENABLED=true
OPENWEBUI_WORKSPACE_MODEL_ID=
OPENWEBUI_WORKSPACE_MODEL_NAME=
```

Scheduler / Queue
-----------------

[](#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:

```
* * * * * php /path/to/bookstack/artisan openwebui:process-queue >> /dev/null 2>&1
```

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:

```
OPENWEBUI_QUEUE_DISPATCH=true
```

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

```
* * * * * flock -n /tmp/openwebui-queue.lock php /path/to/bookstack/artisan openwebui:process-queue >> /dev/null 2>&1
```

Workspace (model) sync
----------------------

[](#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:

```
OPENWEBUI_WORKSPACE_ENABLED=true
OPENWEBUI_WORKSPACE_MODEL_ID=bookstack
OPENWEBUI_WORKSPACE_MODEL_NAME=BookStack
```

Commands
--------

[](#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
--------

[](#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
-----------

[](#development)

Run tests:

```
vendor/bin/phpunit
```

###  Health Score

38

—

LowBetter than 83% of packages

Maintenance72

Regular maintenance activity

Popularity10

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

30

Last Release

160d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/55602317?v=4)[Dirk](/maintainers/dirkdrutschmann)[@dirkdrutschmann](https://github.com/dirkdrutschmann)

---

Top Contributors

[![dirkdrutschmann](https://avatars.githubusercontent.com/u/55602317?v=4)](https://github.com/dirkdrutschmann "dirkdrutschmann (26 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/pronomix-gmbh-bookstack-ai-sync/health.svg)

```
[![Health](https://phpackages.com/badges/pronomix-gmbh-bookstack-ai-sync/health.svg)](https://phpackages.com/packages/pronomix-gmbh-bookstack-ai-sync)
```

###  Alternatives

[roots/acorn

Framework for Roots WordPress projects built with Laravel components.

9762.4M131](/packages/roots-acorn)[psalm/plugin-laravel

Psalm plugin for Laravel

3355.3M346](/packages/psalm-plugin-laravel)[laravel/pulse

Laravel Pulse is a real-time application performance monitoring tool and dashboard for your Laravel application.

1.7k15.1M132](/packages/laravel-pulse)[spatie/laravel-export

Create a static site bundle from a Laravel app

674146.0k6](/packages/spatie-laravel-export)[mike-bronner/laravel-model-caching

Automatic caching for Eloquent models.

2.4k92.1k1](/packages/mike-bronner-laravel-model-caching)[flarum/core

Delightfully simple forum software.

201.4M2.3k](/packages/flarum-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)