Core · Using plugins

Using plugins overview

NocoBase provides plugins for users, authentication, permissions, files, notifications, Agents and other common application features. This section covers what each plugin does, how to configure it, and how to use its pages, components, APIs, services or Skills in your application.

Use the topics below to find the plugins you need. For shared installation, registration, update and removal procedures, see Manage plugins.

Find plugins by function

This section covers 21 plugins. Related features are grouped by topic, while other plugins have individual entries. Each guide covers capabilities, scenarios, implementation, and AI development constraints in four chapters.

FeatureUsage guidesMain uses
Users and authenticationUser management, Authentication, API keysManage users, sign in and authenticate API requests
Permissions and data accessPermission management, Default data access, Sharing rules, Restriction rulesControl permitted operations and access to records
Database explorerDatabase explorerInspect database connections, tables and fields
FilesFilesUpload, store and access files
NotificationsNotifications, Notification providers, In-app notifications, Web pushConfigure notification channels, deliver notifications and integrate inboxes and browser push
EmailEmailSend email, synchronize mailboxes and extend mail services
AgentsAgentsConfigure a model API or connect an Agent on a machine for conversations and task execution
Knowledge baseKnowledge baseManage document spaces, versions, search and change reviews
ApprovalsApprovalsConfigure approval policies and handle outcomes
Scheduled tasksScheduled tasksDeclare schedules, inspect execution records and enable or disable tasks
Template printingTemplate printingUse Skills to implement DOCX and PDF template printing
LocalizationLocalizationIntegrate localization and application language switching
Application foundationApplication foundationInspect the Core capabilities used by an application and their runtime information

Before integration

Check the application's actual registrations and installed versions. Installation does not enable a plugin. Some plugins also require configuration factories or application-owned data, pages and permissions.

Paths such as /client and /server in each guide refer to that package's public exports. Page and HTTP paths are relative to the application mount: an application at /main serves /api/users at /main/api/users. Consult the running application's /api/swagger/docs or /api/swagger for complete request, response and access contracts.

Read a plugin's usage guide

Each plugin guide follows four chapters:

  1. Capabilities: the problem, supplied pages, components, APIs, services or Skills, and application responsibilities.
  2. Scenarios and examples: a business need, development prompts for a Coding Agent, usage steps and completion criteria.
  3. Key principles and implementation: integration areas, code and configuration changes, interface changes and important mechanisms.
  4. AI development constraints and verification: plugin-specific boundaries, common mistakes and acceptance requirements.

Development prompts target a Coding Agent working in the current application directory. Have it read AGENTS.md, application rules and relevant Skills shipped with installed versions first. Where no development Skill exists, use public interfaces, types and documentation. Chapter four addresses reliable AI-assisted integration; it does not require the plugin itself to have AI features. See Continue developing your app and Testing for shared workflows.

Plugins provide different kinds of capabilities. Template printing supplies implementation guidance. User management supplies administration APIs and an invitation page, while the application owns its administration UI. Knowledge base and Application foundation provide registrable pages. Each guide explains ownership of pages, data and business logic.

These guides were checked against source on 2026-10-28, using main-repository revision 015404ecd and the commercial approval plugin's public contracts. Agents has a separately verified application baseline, screenshots and source download. Installed versions may differ. Verification steps describe checks for the consuming application; they do not claim that every plugin integration was executed while writing these guides.

  • Manage plugins: install, register, update and remove plugins.
  • Plugin index: look up full package names, repositories and inclusion in the default template.
  • Develop plugins: learn when and how to create your own plugin.

NocoBase docs assistant

Ask anything about NocoBase…

Each question is answered independently, without earlier questions or answers. Include all relevant context.