mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-09 03:09:38 +03:00
Native Plugin System to Enable Modular Extensions (e.g. AI Chatbot, RAG, Integrations) #5369
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @photoshop-painting on GitHub (Jul 20, 2025).
Describe the feature you'd like
I would like to propose the addition of a native Plugin System to BookStack. This system would allow BookStack to load, manage, and safely execute modular PHP extensions ("plugins") that enhance or customize platform functionality—such as AI-powered chatbots, semantic search, integrations, and other advanced features.
Key points for the proposed Plugin System:
Plugins are self-contained PHP/Laravel packages living within a /plugins directory (or similar), auto-discovered and manageable via the admin UI.
Plugin API exposes key BookStack events and objects (content creation, user access, permissions, etc.) so that plugins can cleanly extend or react to BookStack core behavior.
Safe plugin lifecycle handling: (install, enable/disable, update, remove), with strict scoping to prevent security or stability issues.
Plugins can define/administer configuration in BookStack’s settings and add UI elements (sidebar, modals, etc.) via well-documented hooks.
Describe the benefits this would bring to existing BookStack users
A plugin system would unlock a new era of extensibility and customization for the BookStack ecosystem, leading to tangible benefits:
Unprecedented Flexibility: Organizations can add or remove advanced features—such as AI-powered RAG chatbots, real-time integrations, custom authentication, translation, or analytics—without forking or modifying BookStack core.
Reduced Upgrade/Risk: Core updates are much less risky, since enhancements live outside the main codebase.
Encourages Community Innovation: Users and teams can share, maintain, and rapidly evolve plugins (similar to WordPress or Laravel/Eco-system), creating a more vibrant and functional ecosystem around BookStack.
Faster Feature Adoption: Frequently requested or specialized functionality (e.g. advanced search, workflow automation, knowledge bots) can be delivered as plugins, allowing BookStack to remain clean and focused.
Security & Permissions: Plugins can natively interface with BookStack's existing robust permission model. AI/chatbots, for instance, can respect user roles and access limitations, ensuring data security for both public and authenticated users.
Low Technical Barrier: Non-core developers can contribute major features and even experiment with AI/NLP or LLMs, dramatically accelerating BookStack's evolution.
Outcomes:
Accelerates BookStack's evolution and adaptability to new requirements (AI, integrations, custom tools)
Empower users and organizations to build the highly-specific knowledge experiences they need—all while enjoying official support and seamless upgrade paths
Can the goal of this request already be achieved via other means?
No, not entirely.
Currently BookStack supports API and basic "head scripts", but there is no official, safe, and consistent way to extend or inject deep functionality (event hooks, custom modules, sophisticated UI elements, or robust integrations) without either hacking the core or running unofficial, fragile forks. A native plugin system is the only scalable, future-proof solution for structured, community-driven enhancement.
Have you searched for an existing open/closed issue?
How long have you been using BookStack?
Under 3 months
Additional context
Well-designed plugin systems are a hallmark of all thriving, long-lived open source knowledge platforms.
Many high-value requests from the community (AI chatbots, advanced search, custom integrations, external auth, workflow tools, etc.) can be elegantly handled through a plugin system, rather than being merged into core or left unmaintained.
This change would allow BookStack to stay lightweight at the core, but infinitely adaptable and attractive to both enterprise and hobby users.
Sample reference:
[WordPress Plugins]
[Laravel Packages]
@ssddanbrown commented on GitHub (Jul 20, 2025):
Thanks @photoshop-painting for the request, but I'd consider this a duplicate of existing issue #127 which covers the same fundamental request.
There is the logical and visual theme systems as referenced in our docs:
https://www.bookstackapp.com/docs/admin/hacking-bookstack/#visual-theme-system
Note: if used, please avoid using LLMs to fill in issues here in the future. I'd prefer to just read the thoughts of a human rather than spend time understanding/responding-to/reading AI imaginings.