Skip to content

Knowledge Base Module ​

Free Operations Marketplace module for internal team help articles, categories, and searchable FAQs. Catalog version 1.2.0. There is no public or customer portal in v1.

Guides ​

AudienceDocument
Operators / workspace usersknowledge-base.md
Engineersknowledge-base.md
Production / opsknowledge-base.md
Module Development Standardmodule-development.md
Tenant APItenant-v1-knowledge-base.md

Capabilities ​

  • Articles: title, slug, excerpt, TipTap HTML body, optional category, status (draft / published / archived), published_at
  • Flat categories (delete blocked while articles still use them)
  • Search across title, excerpt, and body; status and trash filters for editors
  • Soft Help Desk backlinks on article show when help-desk is entitled (help_desk_tickets on GET /knowledge-base/{id})
  • Optional article attachments on create/edit (counts toward Storage quota)
  • Notes + domain timeline; Spatie LogsActivity + platform audit events
  • Module licensing (module:knowledge-base) for install; Spatie permissions for all access
  • Internal workspace only — no public URLs or customer portal
  • Automation trigger knowledge_base.article_created when Automation is entitled

Permissions ​

knowledge-base.view · create · update · delete · restore · force.delete

Default roles: admin = all except force.delete; manager = view / create / update; staff = view.

View-only users see published articles only. Users with knowledge-base.update can open drafts, archived, and trash.

Catalog ​

  • Slug: knowledge-base
  • Category: Operations (operations, sort 40), module sort 60, icon book-open
  • is_default_included=false, is_billable=false, prices $0
  • Install from Marketplace (not auto-installed for new workspaces)
  • No hard module dependencies

Explicitly deferred ​

  • Public / customer-facing URLs
  • Nested categories
  • Dashboard widget
  • Publish notification fan-out

Official documentation for the EloSync SaaS Platform.